ADR Template

Use this template for Architectural Decision Records.

ADR-XXX: [Short Title]

Status: [Proposed | Accepted | Deprecated | Superseded by ADR-XXX]

Date: YYYY-MM-DD

Authors: [Names or roles]

Context

[What is the issue that we're seeing that is motivating this decision or change?]

Problem Statement

[Clearly state the specific problem to be solved]

Decision Drivers

  • [Driver 1]
  • [Driver 2]
  • [Driver 3]

Considered Alternatives

Option 1: [Name]

Description: [Brief description]

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Option 2: [Name]

Description: [Brief description]

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Option 3: [Name]

Description: [Brief description]

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Decision

[What is the change that we're proposing and/or doing?]

Rationale

[Why did we choose this option over the alternatives?]

Consequences

Positive

  • [Benefit 1]
  • [Benefit 2]

Negative

  • [Drawback 1]
  • [Drawback 2]

Neutral

  • [Side effect or consideration]

Implementation Notes

[Technical details about how to implement this decision]

Related Decisions

  • [Link to related ADRs]

References

  • [Link to relevant documentation, articles, or discussions]