Browse documentation
DocumentationDecisions

Decisions

Architecture Decision Records (ADRs) capture the why behind significant design choices. Each ADR is a short, dated document that explains the context, options, decision, and consequences.

Index

Number Title Status
ADR-002 OKF v0.1 bundle format Accepted
ADR-001 KMD flat format Superseded by ADR-002

Conventions

Each ADR follows this structure:

  1. Title — a short, descriptive name.
  2. Status — Proposed, Accepted, Superseded, or Deprecated.
  3. Date — when the decision was made.
  4. Drivers — who proposed or championed the decision.
  5. Context — the problem and forces in play.
  6. Options Considered — alternatives and their trade-offs.
  7. Decision — what was chosen.
  8. Consequences — what becomes easier and what becomes harder.

When an ADR is superseded, the new ADR is linked from the Supersedes field of the old one.