ADR-NNN: [Short Title]¶
Status: Proposed | Accepted | Deprecated | Superseded Date: YYYY-MM-DD Authors: [Name(s)] Supersedes: ADR-XXX (if applicable) Superseded By: ADR-YYY (if applicable)
Context¶
What problem are we solving?
Describe the issue, opportunity, or situation that prompted this decision. Include: - Background information - Current limitations or pain points - Why this decision is needed now - Relevant stakeholders
Decision¶
What did we decide to do?
State the decision clearly and concisely. Be specific about: - What we're building/changing - How it will work (high-level) - Key design principles - Scope boundaries (what's in/out)
Consequences¶
Positive Outcomes ✅¶
What benefits do we gain from this decision? - Improved performance, security, usability, etc. - Technical advantages - Business/user value
Negative Outcomes / Trade-offs ⚠️¶
What costs or limitations does this decision introduce? - Performance penalties - Increased complexity - Technical debt - Migration challenges
Neutral Impacts 🔄¶
What changes that are neither clearly positive nor negative? - Changes to workflow - New dependencies - Learning curve
Alternatives Considered¶
Alternative 1: [Name]¶
Description: Brief explanation Pros: Why this could work Cons: Why we didn't choose it
Alternative 2: [Name]¶
Description: Brief explanation Pros: Why this could work Cons: Why we didn't choose it
Alternative 3: Do Nothing¶
Description: What happens if we don't make a decision? Pros: No change, no risk Cons: Problems remain unsolved
Implementation Notes¶
How will we implement this decision?
- Key steps or phases
- Technical requirements
- Migration path (if applicable)
- Timeline estimates
Success Metrics¶
How will we know this decision was successful?
- Quantitative metrics (performance, adoption, etc.)
- Qualitative goals (developer experience, clarity, etc.)
- Timeline for evaluation
References¶
Related documents, discussions, and resources:
Revision History¶
| Date | Author | Change |
|---|---|---|
| YYYY-MM-DD | Name | Initial draft |
| YYYY-MM-DD | Name | Accepted |
📍 Navigation: ← ADR Index | ↑ Docs Home