Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 2.6 KB

000-template.md

File metadata and controls

145 lines (94 loc) · 2.6 KB

ADR-XXX: [Short Title]

Status: [Proposed | Accepted | Deprecated | Superseded] Date: YYYY-MM-DD Issue: [Linear issue ID or "N/A"] Deciders: [List of people involved]

Context

Describe the forces at play, including technological, political, social, and project-specific considerations. This section describes the problem space and why a decision needs to be made.

Background

  • What is the current situation?
  • What problem are we trying to solve?
  • What constraints do we face?

Requirements

  • What must the solution achieve?
  • What are the non-functional requirements?

Decision Drivers

  • Driver 1: [e.g., Performance requirements]
  • Driver 2: [e.g., Maintainability]
  • Driver 3: [e.g., Cost constraints]
  • Driver 4: [e.g., Team expertise]

Considered Options

Option 1: [Name]

Description: Brief description of this option.

Pros:

  • Advantage 1
  • Advantage 2

Cons:

  • Disadvantage 1
  • Disadvantage 2

Cost/Effort: [Low | Medium | High]

Option 2: [Name]

Description: Brief description of this option.

Pros:

  • Advantage 1
  • Advantage 2

Cons:

  • Disadvantage 1
  • Disadvantage 2

Cost/Effort: [Low | Medium | High]

Option 3: [Name]

Description: Brief description of this option.

Pros:

  • Advantage 1
  • Advantage 2

Cons:

  • Disadvantage 1
  • Disadvantage 2

Cost/Effort: [Low | Medium | High]

Decision

We will pursue Option X: [Name] because [brief justification].

Rationale

Detailed explanation of why this option was chosen:

  • How does it address the decision drivers?
  • Why is it better than the alternatives?
  • What trade-offs are we accepting?

Consequences

Positive

  • Benefit 1
  • Benefit 2
  • Benefit 3

Negative

  • Trade-off 1
  • Trade-off 2
  • Risk 1 (and mitigation strategy)

Neutral

  • Change 1 that is neither positive nor negative
  • Change 2

Implementation

Tasks

  • Task 1
  • Task 2
  • Task 3

Timeline

  • Phase 1: [Description] - [Timeline]
  • Phase 2: [Description] - [Timeline]

Dependencies

  • Dependency 1: [Description]
  • Dependency 2: [Description]

Risks

Risk Impact Probability Mitigation
Risk 1 High Low Mitigation strategy
Risk 2 Medium Medium Mitigation strategy

Related

  • Supersedes: [ADR-XXX] (if applicable)
  • Superseded by: [ADR-XXX] (if applicable)
  • Related to: [ADR-XXX, ADR-YYY]
  • Linear Issue: CLD-XXXX

References

  • [Reference 1]
  • [Reference 2]
  • [Documentation link]

Last Updated: YYYY-MM-DD Review Date: YYYY-MM-DD (6 months from decision date)