Search…
Getting Started
Technical overview
Overview
Architectural Decision Records
Use Markdown Architectural Decision Records
Use NX
Continuous Integration
CSS
Branching and Release Strategy
Error Tracking and Monitoring
What API Management Tool to Consider
Viskuausan Static Site Generator
Use OAuth 2.0 and OpenID Connect As Protocols for Authentication and Authorization
Unified Naming Strategy for Files and Directories
CMS
Open Source License
What Chart Library Should We Use Across Island.is?
What Feature Flag Service/application Should We Use at Island.is?
Logging, Monitoring and APM Platform
ADR Template
API Design Guide
Island.is Authentication Service
Code Reviews
Code Standards
Devops
Feature Flags
Monorepo
Personas
Pósthólfið
Teamwork
Technical Direction
X-Road / Straumurinn
Repository
AWS Secrets
External Contributions
Generating a New Project
GitBook Contributions
OpenAPI
Auto Generated Schemas
Workspace Settings
Apps
Air Discount Scheme
API
Application System
Financial Aid System for Samband Sveitarfélaga
Judicial System
Reference Backend
Reference Next App
Service Portal
Services
Car Recycling - Skilavottorð
Web
Libs
API
API Catalogue
Application
Auth
Auth API Lib
Auth Nest Tools
Clients
CMS
CMS Translations
Content Search Index Manager
Content Search Indexer
Content Search Metrics
Content Search Toolkit
Contentful Extensions Overview
Dokobit Signing
Email Service
Feature Flags
Health Insurance
Island UI
Localization
Message Queue
Nest Modules
Next Ids Auth Lib
NOVA SMS
Plausible
React Libraries
Regulations
Residence History
Service Portal
Shared
Testing
User Monitoring
Reference
Problems
Misc
Guide: Adding a Payment Step to an Application
Guide: Enable Organisations to Make Requests to an Application
GitBook Template
Glossary
Powered By
GitBook
Use Markdown Architectural Decision Records
Status: accepted
Deciders: devs, devops
Date: 01.06.2020
Context and Problem Statement
We want to record architectural decisions made in this project. Which format and structure should these records follow?
Considered Options
MADR
2.1.0 - The Markdown Architectural Decision Records
Michael Nygard's template
- The first incarnation of the term "ADR"
Sustainable Architectural Decisions
- The Y-Statements
Other templates listed at
https://github.com/joelparkerhenderson/architecture_decision_record
Formless - No conventions for file format and structure
Decision Outcome
Chosen option: "MADR 2.1.0", because
Implicit assumptions should be made explicit.
Design documentation is important to enable people understanding the decisions later on.
See also
A rational design process: How and why to fake it
.
The MADR format is lean and fits our development style.
The MADR structure is comprehensible and facilitates usage & maintenance.
The MADR project is vivid.
Version 2.1.0 is the latest one available when starting to document ADRs.
Technical overview - Previous
Architectural Decision Records
Next
Use NX
Last modified
1yr ago
Copy link
Contents
Context and Problem Statement
Considered Options
Decision Outcome