Skip to main content

ADR Template

Use this template when creating new Architecture Decision Records.

ADR-XXX: [Title]​

Date: YYYY-MM-DD

Status: Proposed | Accepted | Deprecated | Superseded

Context​

Describe the issue motivating this decision, and any context that influences or constrains the decision.

Decision​

Describe the change being proposed or the decision that was made.

Consequences​

Describe the resulting context after applying the decision. Include both positive and negative consequences.

Positive​

  • Benefit 1
  • Benefit 2

Negative​

  • Drawback 1
  • Drawback 2

Alternatives Considered​

List alternative approaches that were considered and why they were not chosen.

  1. Alternative A - Why it was rejected
  2. Alternative B - Why it was rejected

How to Create a New ADR​

  1. Copy this template to a new file: XXX-descriptive-name.md
  2. Replace XXX with the next sequential number (e.g., 002)
  3. Fill in all sections
  4. Submit a PR for review
  5. Update status to "Accepted" once approved