Skip to content

template.md

Latest commit

 

History

History
72 lines (45 loc) · 1.63 KB

template.md

File metadata and controls

72 lines (45 loc) · 1.63 KB

ADR-NNNN: [Short Title of Decision]

Date: YYYY-MM-DD Deciders: [List of people involved] Technical Story: [Link to issue/PR if applicable]

Context and Problem Statement

[Describe the context and problem. What forces are at play? What constraints exist? What problem are we trying to solve?]

Decision Drivers

  • [Driver 1 - e.g., Performance requirements]
  • [Driver 2 - e.g., Security constraints]
  • [Driver 3 - e.g., Team expertise]
  • [Driver 4 - e.g., Cost considerations]

Considered Options

  • [Option 1]
  • [Option 2]
  • [Option 3]

Decision Outcome

Chosen option: "[Option X]", because [justification. Why this option over others? What were the decisive factors?]

Consequences

Positive:

  • [Positive consequence 1 - e.g., Improved performance]
  • [Positive consequence 2 - e.g., Better security]

Negative:

  • [Negative consequence 1 - e.g., Increased complexity]
  • [Negative consequence 2 - e.g., Higher learning curve]

Risks:

  • [Risk 1 - e.g., Third-party dependency risk]
  • [Risk 2 - e.g., Scaling limitations]

Implementation Notes

[How this was actually implemented. Gotchas discovered during implementation. Deviations from original plan.]

Key Files:

  • [file.go:123] - [What this implements]
  • [component.tsx:456] - [What this implements]

Patterns Established:

  • [Pattern 1]
  • [Pattern 2]

Validation

How do we know this decision was correct?

  • [Metric 1 - e.g., Response time improved by 40%]
  • [Metric 2 - e.g., Security audit passed]
  • [Outcome 1 - e.g., Team velocity increased]

Links

  • [Related ADR-XXXX]
  • [Related issue #XXX]
  • [Supersedes ADR-YYYY]
  • [External reference]