Architectural Decision Records (ADRs)
What is an ADR?
An architectural decision record (ADR) is a document that captures an important architectural decision made, along with its context and consequences.
They don't have to be complicated. The most important thing™ is recording the decision and who made it. The next most important thing is to capture something to help us remember the reason(s) for making the decision. Resist the temptation to let perfect be the enemy of good: shorthand notes which jog the memory of the decision-makers are better than nothing.
When do we write an ADR?
We will publish an ADR any time we make a technical or architectural decision which meets any of the following criteria:
- it introduces consequences or side-effects
- it is difficult or time-consuming to reverse
- we don't want it reversed without due consideration (for whatever reason)
- we want to remember why we made the decision
- we want to share with others
How do we write an ADR
- Install adr-tools.
cdto the local git checkout of the project code.
adr new summarize the decision.
- Edit the file created by the above command, commit it to a branch, and submit a PR.
Example ADR templates
- Michael Nygard's simple ADR template. Widely-used, easy, short.
- A simple ADR template for the Alexandrian pattern. Also short and easy, but more structured than Nygard's.
- MADR format template. Medium-length, structured, with thorough prompts for alternatives & other considerations.