Skip to content

ADR-template.md

Latest commit

 

History

History
100 lines (67 loc) · 1.33 KB

ADR-template.md

File metadata and controls

100 lines (67 loc) · 1.33 KB

ADR- – <Title>

Status: Proposed | Accepted | Rejected | Deprecated | Superseded
Date: YYYY-MM-DD
Authors: <Author Name(s)>

1. Context

Describe the background and problem that led to this decision.

Include:

  • Business or technical drivers
  • Constraints (technical, budget, time, compliance, etc.)
  • Assumptions
  • Relevant system architecture details
  • Why this decision is needed now

2. Decision

Clearly state the decision.

Be concise and explicit.
Example:

We will use X technology for Y purpose in Z service.

3. Rationale (Why)

Explain the reasoning behind this decision.

  • Why this option was chosen
  • Key evaluation criteria
  • Trade-offs made
  • Alignment with system goals

4. Consequences

Positive

  • Benefit 1
  • Benefit 2
  • Benefit 3

Negative / Risks

  • Risk 1
  • Risk 2
  • Operational cost
  • Migration effort (if applicable)

5. Alternatives Considered

Option A –

  • Pros:
    • ...
  • Cons:
    • ...

Option B –

  • Pros:
    • ...
  • Cons:
    • ...

6. Related Decisions

  • ADR-XXX – <Title>
  • ADR-YYY – <Title>

7. References

  • Documentation link
  • Design document
  • RFC
  • External article

8. Status Notes

Optional notes on:

  • Rollout plan
  • Migration steps
  • Future review date
  • Sunset plan (if applicable)