Skip to main content

ADR-0000: Template

Use this template to record an architectural decision. Copy this file, rename it to the next sequence (e.g., ADR-0003-some-decision.mdx), and update the metadata and content. Keep it concise and focused on a single decision. Link related ADRs when they supersede one another.

Status​

Proposed

Context​

Describe the background, constraints, and forces that led to this decision. Who are the stakeholders? What are the drivers and constraints (security, cost, time-to-value, integration)?

Decision​

State the decision clearly, including scope and any key parameters. If applicable, define non-goals.

Alternatives Considered​

  • Option A - pros/cons
  • Option B - pros/cons
  • Option C - pros/cons

Consequences​

  • Positive outcomes
  • Risks / trade-offs
  • Follow-ups

Rollout Plan​

How will this be introduced safely? Flags, migrations, or phased enablement?

Success Metrics​

How will we measure that this decision achieved its goals?

References​

  • Links to issues/PRs/RFCs
  • External docs