Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

ADR-NNNN: Short kebab title

  • Status: Proposed | Accepted | Superseded by ADR-NNNN | Deprecated
  • Date: YYYY-MM-DD
  • Authors: name
  • Reviewers: name, name

Context

What is the problem we are facing? What constraints apply? What evidence do we have (benchmarks, incident postmortems, prior art)?

Decision

What did we decide? State it as a single declarative sentence at the top, then expand.

Consequences

Positive

  • Bullet list of what we gain.

Negative / risks

  • Bullet list of what we lose, and how we will detect each risk if it materializes.

Neutral

  • Things that change but are neither clearly positive nor negative.

Alternatives considered

For each alternative: one paragraph on what it would look like, and why we rejected it.

References

  • Links to research papers, prior ADRs, incident reports, benchmarks.