Appendix A. ADR Templates
Use these templates to structure your architecture decision records (ADRs). They are also available on the companion website.
ADR Structure
See “ADR Structure” for instructions on how to use each section. See Figures 12-3, 12-4, and 12-5 for examples of how to use this template.
Identifier and Title: A Statement of the Decision Made
Status
Draft/Decided/Superseded by ADR-XXX
Context
Why you need to make the decision. Assumptions, constraints, and decision drivers.
Evaluation Criteria
What is important to you in making this decision? Which of your architectural characteristics apply to making this decision? Should any constraints or decision drivers become a criterion?
Options
Outlines of the options considered against the evaluation criteria (usually using a score or rating), and trade-offs outside of the evaluation criteria. See “ADR Options” for a template.
Decision
The choice that was made and why.
Implications
The positive and negative consequences of the decision made.
Consultation
If taking input from others, document it here. Although consultation takes place before a decision is made, it is documented at the end because it can become long and obscure the decision itself.
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access