Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Use Markdown Architectural Decision Records

Context and Problem Statement

We want to record architectural decisions made in this project independent whether decisions concern the architecture (“architectural decision record”), the code, or other fields. Which format and structure should these records follow?

Considered Options

Decision Outcome

Chosen option: “MADR 4.0.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”.
  • MADR allows for structured capturing of any decision.
  • The MADR format is lean and fits our development style.
  • The MADR structure is comprehensible and facilitates usage & maintenance.
  • The MADR project is vivid.