Architecture decision records
Format: MADR 4.0.0. The files adr-template.md, adr-template-minimal.md, and 0000-use-markdown-architectural-decision-records.md are the upstream templates. Do not edit those three except to record a real decision in 0000 if this project ever stops using MADR.
Which template
Section titled “Which template”| File | Use it when |
|---|---|
| adr-template-minimal.md | Most decisions. Context, options, outcome, consequences. |
| adr-template.md | The trade-off needs drivers, a per-option pros/cons list, and links. |
Add a decision
Section titled “Add a decision”- Copy the template to
NNNN-short-title.md.NNNNis the next number, starting at0001. - Status starts as
proposed. - Open a pull request. Review the decision there.
- On acceptance, set status to
acceptedand link the ADR from section 9. - If the decision changes the structure, update the building block view and the C4 diagrams in the same change.
Change a decision
Section titled “Change a decision”Do not rewrite an accepted ADR. Add a new one and set the old status to superseded by ADR-NNNN.
An ADR is one decision. If you are still comparing designs, describing APIs, and planning a rollout, that is an RFC. The RFC can produce one or more ADRs once the choice is made.
| ID | Title | Status |
|---|---|---|
| 0000 | Use Markdown Architectural Decision Records | accepted |