0000-use-markdown-architectural-decision-records.md

[ADR-0000] Use Markdown Architectural Decision Records

Status: accepted

Deciders: @redeboer, @spflueger

Technical story: A large number of issues in the expertsystem are to be correlated (e.g. #40, #44, #22) so that resulting PRs (in this case, #42) lacked direction. This led us to consider ADRs.

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.2 – 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 github.com/joelparkerhenderson/architecture_decision_record.
• Formless – No conventions for file format and structure

Decision Outcome

Chosen option: "MADR 2.1.2", 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.2 is the latest one available when starting to document ADRs.