ADR-{{NUMBER}}: {{TITLE}}
<!-- MADR 3.0 Template - Markdown Any Decision Records --> <!-- Reference: https://adr.github.io/madr/ -->
Status
{{Proposed | Accepted | Deprecated | Superseded by ADR-XXX}}
Date
{{YYYY-MM-DD}}
Deciders
{{List of people involved in the decision}}
Context and Problem Statement
{{Describe the context and problem statement in 2-5 sentences. You may include relevant background information, but avoid specifying solution options here.}}
Decision Drivers
<!-- Recommended section -->
- {{Driver 1: e.g., Security requirement}}
- {{Driver 2: e.g., Performance constraint}}
- {{Driver 3: e.g., Cost consideration}}
- {{Driver 4: e.g., Maintainability}}
Considered Options
<!-- Required section -->
- {{Option 1}}
- {{Option 2}}
- {{Option 3}}
Decision Outcome
<!-- Required section -->
Chosen option: "{{Option X}}", because {{justification. e.g., it best meets the decision drivers and has acceptable trade-offs}}.
Confirmation
<!-- Required section - how to verify the decision was implemented correctly -->
{{Describe how to confirm that the decision has been successfully implemented. Include:
- Automated tests or checks
- Manual verification steps
- Metrics to monitor}}
Pros and Cons of the Options
<!-- Recommended section -->
{{Option 1}}
{{Brief description}}
- Good, because {{argument}}
- Good, because {{argument}}
- Neutral, because {{argument}}
- Bad, because {{argument}}
{{Option 2}}
{{Brief description}}
- Good, because {{argument}}
- Bad, because {{argument}}
{{Option 3}}
{{Brief description}}
- Good, because {{argument}}
- Bad, because {{argument}}
More Information
<!-- Optional section -->
{{Any additional context, diagrams, or links that provide more detail.}}
Implementation Notes
{{Technical details, code examples, or architecture diagrams}}
Related ADRs
- ADR-XXX - {{Relationship description}}
References
<!-- MADR 3.0 Guidelines:
- Required sections: Context and Problem Statement, Considered Options, Decision Outcome
- Recommended sections: Decision Drivers, Pros/Cons of Options, Confirmation
- Status values: Proposed, Accepted, Deprecated, Superseded
- ADRs are immutable - create new ADR to supersede, never edit existing
- Include diagrams where helpful (architecture, sequence, flow)
References:
- MADR 3.0 Official: https://adr.github.io/madr/
- ADR Templates: https://adr.github.io/adr-templates/
- Joel Parker Henderson ADR Guide: https://github.com/joelparkerhenderson/architecture-decision-record
- AWS ADR Process: https://docs.aws.amazon.com/prescriptive-guidance/latest/architectural-decision-records/ -->