Skip to main content

ADR-0000: [Decision Title]

Template

This is a template for creating new Architecture Decision Records (ADRs). Copy this file and rename it to NNNN-short-title.mdx where NNNN is the next sequential number.

Status: [Proposed | Accepted | Deprecated | Superseded]

Date: YYYY-MM-DD

Decision makers: [list names or roles of people involved in the decision]

Context​

What is the issue or problem being addressed? Describe the forces at play, including technological, political, social, and project-specific constraints. This section should be written in a neutral tone and provide enough background for future readers to understand the decision.

Decision​

What is the change being proposed or made? State the decision clearly and concisely. Use active voice and be specific about what will be done.

Alternatives Considered​

Alternative 1: [Name]​

Description: Brief description of this alternative.

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Alternative 2: [Name]​

Description: Brief description of this alternative.

Pros:

  • Pro 1
  • Pro 2

Cons:

  • Con 1
  • Con 2

Consequences​

What are the results of this decision? Describe both positive and negative consequences.

Positive​

  • Positive consequence 1
  • Positive consequence 2

Negative​

  • Negative consequence 1
  • Negative consequence 2

Neutral​

  • Any neutral observations or follow-up actions required