121 lines
3.2 KiB
Markdown
121 lines
3.2 KiB
Markdown
# [ADR-NNNN] [Title of Decision]
|
|
|
|
**Status:** [Proposed | Accepted | Deprecated | Superseded by ADR-XXXX]
|
|
**Date:** [YYYY-MM-DD]
|
|
**Decision Makers:** [List key stakeholders involved]
|
|
|
|
## Context
|
|
|
|
[Describe the issue motivating this decision, and any context that influences or constrains the decision. This should be value-neutral, explaining forces at play without judging them.]
|
|
|
|
### Problem Statement
|
|
[Clearly articulate the specific problem we're trying to solve in 1-2 sentences]
|
|
|
|
### Current Situation
|
|
[Describe how things work today, if applicable]
|
|
|
|
### Technical Context
|
|
[Any technical constraints, existing systems, or technical factors]
|
|
|
|
### Business Context
|
|
[Business requirements, constraints, or goals that influence this decision]
|
|
|
|
## Decision
|
|
|
|
[State the decision that was made, starting with "We will..." Use active voice and be explicit about what is being decided]
|
|
|
|
## Considered Alternatives
|
|
|
|
### Option 1: [Name of Alternative]
|
|
**Description:** [Brief description of this approach]
|
|
|
|
**Pros:**
|
|
- [Positive aspect]
|
|
- [Another positive aspect]
|
|
|
|
**Cons:**
|
|
- [Negative aspect]
|
|
- [Another negative aspect]
|
|
|
|
**Estimated Effort:** [High/Medium/Low or specific estimate]
|
|
|
|
### Option 2: [Name of Alternative]
|
|
**Description:** [Brief description of this approach]
|
|
|
|
**Pros:**
|
|
- [Positive aspect]
|
|
- [Another positive aspect]
|
|
|
|
**Cons:**
|
|
- [Negative aspect]
|
|
- [Another negative aspect]
|
|
|
|
**Estimated Effort:** [High/Medium/Low or specific estimate]
|
|
|
|
### Option 3: [Name of Alternative]
|
|
**Description:** [Brief description of this approach]
|
|
|
|
**Pros:**
|
|
- [Positive aspect]
|
|
- [Another positive aspect]
|
|
|
|
**Cons:**
|
|
- [Negative aspect]
|
|
- [Another negative aspect]
|
|
|
|
**Estimated Effort:** [High/Medium/Low or specific estimate]
|
|
|
|
## Consequences
|
|
|
|
### Positive Consequences
|
|
- [Good thing that will happen as a result]
|
|
- [Another good thing]
|
|
- [Performance/scalability/maintainability improvements]
|
|
|
|
### Negative Consequences
|
|
- [Drawback or trade-off we're accepting]
|
|
- [Additional complexity or cost]
|
|
- [Things that will become more difficult]
|
|
|
|
### Risks and Mitigations
|
|
| Risk | Probability | Impact | Mitigation Strategy |
|
|
|------|-------------|---------|-------------------|
|
|
| [Description of risk] | [High/Medium/Low] | [High/Medium/Low] | [How we'll address it] |
|
|
| [Another risk] | [High/Medium/Low] | [High/Medium/Low] | [How we'll address it] |
|
|
|
|
## Implementation
|
|
|
|
### Action Items
|
|
- [ ] [Specific action needed to implement this decision]
|
|
- [ ] [Another action item]
|
|
- [ ] [Documentation to update]
|
|
|
|
### Timeline
|
|
[When will this be implemented? Any phases or milestones?]
|
|
|
|
### Success Metrics
|
|
- [How will we know if this decision was successful?]
|
|
- [What metrics will we track?]
|
|
- [When will we evaluate the outcome?]
|
|
|
|
## References
|
|
|
|
### Related ADRs
|
|
- [ADR-XXXX] - [Title and how it relates]
|
|
- [ADR-YYYY] - [Title and how it relates]
|
|
|
|
### External References
|
|
- [Link to relevant documentation, articles, or resources]
|
|
- [Link to architectural diagrams or models]
|
|
|
|
## Notes
|
|
|
|
[Any additional context, dissenting opinions, or information that doesn't fit elsewhere]
|
|
|
|
---
|
|
|
|
### Metadata
|
|
- **Review Date:** [When should this decision be reviewed?]
|
|
- **Tags:** [architecture, security, performance, etc.]
|
|
- **Supersedes:** [ADR-XXXX if applicable]
|
|
- **Superseded By:** [ADR-YYYY if applicable] |