ADR Template
Use this template for documenting significant architecture decisions.
ADR-XXX: [Title]
Status: Proposed | Accepted | Deprecated | Superseded
Date: YYYY-MM-DD
Decision Makers: [Names/Roles]
Related Issues: [Linear issue IDs]
Context
What is the issue that we're seeing that is motivating this decision or change?
Describe the forces at play:
- Technical constraints
- Business requirements
- Team capabilities
- Timeline pressures
Decision
What is the change that we're proposing and/or doing?
State the decision clearly and concisely.
Rationale
Why did we choose this option over the alternatives?
Explain the reasoning behind the decision:
- What factors were most important?
- What tradeoffs did we accept?
- What assumptions are we making?
Alternatives Considered
Alternative A: [Name]
Description: Brief description of the alternative
Pros:
- Pro 1
- Pro 2
Cons:
- Con 1
- Con 2
Why not chosen: Explanation
Alternative B: [Name]
Description: Brief description of the alternative
Pros:
- Pro 1
Cons:
- Con 1
- Con 2
Why not chosen: Explanation
Consequences
What becomes easier or more difficult to do because of this change?
Positive
- Benefit 1
- Benefit 2
Negative
- Drawback 1 (and how we'll mitigate)
- Drawback 2
Neutral
- Change that's neither good nor bad
Implementation
High-level implementation plan:
- Step 1
- Step 2
- Step 3
References
- Link to relevant documentation
- Link to similar decisions elsewhere
- External resources consulted
Revision History
| Date | Author | Description |
|---|---|---|
| YYYY-MM-DD | Name | Initial draft |