Skip to content

adr-template.md

Latest commit

 

History

History
138 lines (94 loc) · 3.11 KB

adr-template.md

File metadata and controls

138 lines (94 loc) · 3.11 KB
Raw

ADR-XXX: [Short Decision Title]

Status

Proposed

Date

YYYY-MM-DD

Context

[Describe the situation, constraints, and forces at play. Explain why a decision is needed now.]

Decision

[State the decision clearly. Use active voice: "We use X because Y."]

Alternatives Considered

Alternative A: [Name]

[Brief description]

Rejected because: [Specific reason]

Alternative B: [Name]

[Brief description]

Rejected because: [Specific reason]

Alternative C: [Name]

[Brief description]

Rejected because: [Specific reason]

Consequences

Positive

  • [What gets better as a result of this decision]
  • [Another positive consequence]
  • [Another positive consequence]

Negative

  • [What gets worse or harder as a result]
  • [Another negative consequence]
  • [Another negative consequence]

Neutral

  • [Things that change but are neither clearly good nor bad]
  • [Another neutral consequence]

Implementation Notes

[Optional: implementation guidance, edge cases to watch for, related code modules, migration path from previous approach]

References

Revision History

Version Date Author Changes
0.1 YYYY-MM-DD [Name] Initial draft
1.0 YYYY-MM-DD [Name] Approved