Skip to main content

Architecture Decision Record Template

Use this template when a change impacts architecture, contracts, or cross-repo workflows.

ADR Metadata​

  • ADR ID: ADR-XXXX
  • Title: Short decision title
  • Status: Proposed | Accepted | Superseded | Deprecated
  • Date: YYYY-MM-DD
  • Owners: Team or named owners
  • Related Repos: api | mobile | service | docs

Context​

Describe the current state, problem, and constraints.

Decision​

State the final decision in clear, testable terms.

Consequences​

  • Positive outcomes
  • Trade-offs
  • Risks and mitigations

Alternatives considered​

  1. Option A and why not selected
  2. Option B and why not selected

Contract impact​

  • API request/response changes
  • Status or stage lifecycle impact
  • Tenant configuration impact
  • Backward compatibility plan

Rollout plan​

  1. Implementation sequence by repository
  2. Migration or fallback strategy
  3. Monitoring and rollback criteria

Validation​

  • Tests updated or added
  • Manual verification steps
  • Release checklist reference