ADR Guide
ADR Guide
Section titled “ADR Guide”Why ADRs are required in this project
Section titled “Why ADRs are required in this project”Architecture Decision Records capture irreversible or high-impact technical decisions with explicit rationale. They reduce context loss when roadmap priorities, owners, or implementation details change.
Naming convention
Section titled “Naming convention”Create ADR files using incremental numeric prefixes:
0001-short-title.md0002-short-title.md
Required ADR structure
Section titled “Required ADR structure”Each ADR should contain:
- Context
- Decision
- Alternatives considered
- Consequences
Status model
Section titled “Status model”Recommended status values:
- Proposed
- Accepted
- Superseded
- Rejected
Update policy
Section titled “Update policy”When a decision changes:
- do not rewrite history in-place;
- create a new ADR that supersedes the old one;
- cross-link both files.