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:
- Title — a short, descriptive name.
- Status — Proposed, Accepted, Superseded, or Deprecated.
- Date — when the decision was made.
- Drivers — who proposed or championed the decision.
- Context — the problem and forces in play.
- Options Considered — alternatives and their trade-offs.
- Decision — what was chosen.
- 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.