Skip to main content
architectureexample-tag
Status: ProposedAuthor: Your NameDeciders: Your NameCreated: Invalid DateUpdated: Invalid Date

ADR-XXX: Title Here

Status​

Status: Proposed Created: YYYY-MM-DD Updated: YYYY-MM-DD Author: Your Name Deciders: Your Name

Context​

What is the issue we're trying to solve? What is the background context?

Include:

  • Problem statement
  • Current situation
  • Requirements/constraints
  • Stakeholders
  • Why this decision is necessary now

Decision​

What did we decide to do? Be specific and concrete.

Include:

  • What we will do
  • How we will implement it
  • Key technical choices

Rationale​

Why did we choose this approach? What makes this the best solution?

Evaluation Criteria​

What factors did we consider? (Optional: use weighted scoring)

  • Performance (weight: X%): Description
  • Developer Experience (weight: Y%): Description
  • Cost/Maintenance (weight: Z%): Description

Alternatives Considered​

  1. Alternative 1: Description

    • Pros:
      • Benefit 1
      • Benefit 2
    • Cons:
      • Limitation 1
      • Limitation 2
    • Rejected because: Specific reason tied to evaluation criteria

  2. Alternative 2: Description

    • Pros:
      • Benefit 1
      • Benefit 2
    • Cons:
      • Limitation 1
      • Limitation 2
    • Rejected because: Specific reason tied to evaluation criteria

Consequences​

What are the implications of this decision?

Positive Consequences​

  • Benefit 1: What becomes easier or what capability we gain
  • Benefit 2: Additional positive outcome

Negative Consequences​

  • Trade-off 1: What becomes harder or what we're giving up
    • Mitigation: How we'll address this limitation
  • Trade-off 2: Additional constraint or limitation
    • Mitigation: How we'll handle this

Neutral Consequences​

  • What stays the same
  • New considerations that emerge
  • Operational changes that are neither positive nor negative

Implementation Notes​

Optional section for implementation details, milestones, or technical specifics.

Key technical details, gotchas, or migration steps:

// Example code if relevant

Migration Steps (if applicable):

  1. Step one
  2. Step two
  3. Step three

Revision History​

  • YYYY-MM-DD: Initial draft (Author Name)
  • YYYY-MM-DD: Accepted after review (Deciders)
  • YYYY-MM-DD: Amended with clarification (Author Name)