Skip to content

TEMPLATE — do not treat as a decision record

This file is a starting structure for a new Architecture Decision Record. Copy it to docs/decisions/ADR-NNNN-kebab-case-title.md, fill in every section, assign the next unused ADR number, and set real front matter (document_type: record, document_id: DD-ADR-NNNN, status: proposed). This template itself is never a decision and should never be linked to as though it recorded one.


ADR-NNNN: [Title]

Status

proposed — decided during initial drafting; not yet formally ratified by a human review checkpoint. (Update this line if status ever changes to approved, deprecated, or superseded, and note the corresponding date.)

Date

YYYY-MM-DD

Context

What situation or problem prompted this decision? What constraints, forces, or prior state made a decision necessary here? Be concrete — a future reader should understand the problem without needing outside context.

Decision

State the decision plainly, in one or two sentences if possible, followed by any necessary elaboration. Use direct language ("We will..." / "This repository does...") rather than hedged language.

Consequences

What follows from this decision — both benefits and costs/trade-offs? Include consequences that are inconvenient, not just favorable ones.

Alternatives Considered

List the realistic alternatives that were considered, and why each was not chosen. This section is what lets a future reader know the decision wasn't made in a vacuum.

Follow-up Actions

Concrete next steps this decision implies (documents to write, standards to update, decisions still needed). If there are none beyond the decision itself, say so explicitly rather than omitting the section.

  • Links to related ADRs, standards, governance documents, or architecture documents.

Report an issue about this page