Skip to main content

ADR 0000 — Short title of the decision, in one sentence

How to use this template

Copy this file under the next free number (NNNN-title-in-kebab.mdx), replace the portions between back-ticks, update the frontmatter, then delete this note. The Context, Options, and Decision sections are required; the others are optional — drop whatever doesn't apply.

  • Status: proposed | accepted | rejected | deprecated | superseded by ADR-NNNN
  • Date: YYYY-MM-DD (last updated)
  • Deciders: list of people who made the call

Context and problem statement​

Describe the context and the architecture problem in two or three sentences. It can be phrased as a question: "How do we do X given Y?"

Decision drivers​

  • Driver 1, e.g. a constraint, a non-functional requirement
  • Driver 2, e.g. a force at play, a concern
  • …

Considered options​

  • Option 1 — title
  • Option 2 — title
  • Option 3 — title

Decision outcome​

Chosen option: "Option 1", because justification — the decisive driver(s) that tip the balance.

Consequences​

  • Positive — e.g. improves a quality attribute, unblocks a scenario.
  • Negative — e.g. debt introduced, new constraint, cost.

Confirmation​

How will we verify the decision is actually applied? e.g. code review, architecture test, a CI check.

Pros and cons of the options (optional)​

Option 1 — title​

Description, example, detailed pros and cons.

  • Good, because argument.
  • Bad, because argument.

Option 2 — title​

  • Good, because argument.
  • Bad, because argument.

More information (optional)​

Evidence, links to other ADRs, implementation notes, a review date.