Architecture Decision Records
ADRs capture why we chose one option over others for a decision we expect to live with for years. Keep them short. Date them. When superseding, link back and mark the old one deprecated.
Template
# ADR-NNNN: <short title>
- Status: Proposed | Accepted | Deprecated | Superseded by ADR-XXXX
- Date: YYYY-MM-DD
- Deciders: @alice, @bob
## Context
What is the problem? What constraints are we working under? What did we try before?
## Decision
What did we pick? State it as a sentence; avoid hedging.
## Alternatives considered
Brief list with why each was rejected.
## Consequences
Positive, negative, and neutral outcomes. What this locks us into. What this frees us up for.