Skip to content

ADR-XXX: [Short Title]

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

Date: YYYY-MM-DD

Authors: [Names or team]

Reviewers: [Names or team]

Context

What is the situation, problem, or opportunity that requires a decision? Describe the forces at play — technical, business, team, constraints. Be specific.

Decision

What was decided? State the decision clearly and concisely.

We will use [technology/pattern/approach] for [purpose].

Options Considered

Option A: [Name]

Description: [What is this option?]

Pros: - [Advantage 1] - [Advantage 2]

Cons: - [Disadvantage 1] - [Disadvantage 2]

Option B: [Name]

Description: [What is this option?]

Pros: - [Advantage 1] - [Advantage 2]

Cons: - [Disadvantage 1] - [Disadvantage 2]

Option C: [Name] (if applicable)

Description: [What is this option?]

Pros: - [Advantage 1]

Cons: - [Disadvantage 1]

Rationale

Why was this option chosen over the alternatives? What factors were most important? If there were strong objections, how were they addressed?

Consequences

Positive

  • [What becomes easier or better?]
  • [What new capability does this enable?]

Negative

  • [What becomes harder?]
  • [What do we give up?]
  • [What new risks are introduced?]

Neutral

  • [Things that change but are neither positive nor negative]

Implementation Notes

Any specific details about how this decision is implemented in the codebase. Include file paths.

  • Implemented in: [file path]
  • Related configuration: [file path]

Review Date

When should this decision be reviewed? Decisions should be periodically reconsidered as technology and requirements evolve.

Next review: [YYYY-MM-DD or "when X happens"]

See Also