Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 3.19 KB

ADR.md

File metadata and controls

56 lines (44 loc) · 3.19 KB

Architectural Decision Records

This document is the index and governance entrypoint for Architectural Decision Records (ADRs). An ADR records a durable architectural choice, its context, rationale, consequences, and status.

Product direction, scope, priorities, roadmaps, and their rationale are product-management decisions and belong in project memory, not in ADRs. An ADR must not be used to turn a product preference or roadmap item into an architectural contract. Architecturally Significant Requirements are recorded in ASR.md; an ASR states what the architecture must satisfy, while an ADR records why an architectural choice was made.

Record convention

Future records use:

docs/adr/ADR-NNN-<slug>.md

NNN is a zero-padded, immutable sequence number. A record has one of these statuses:

  • Proposed — under review; not an accepted architectural commitment.
  • Accepted — approved and currently authoritative.
  • Superseded — replaced by a later ADR; retained for history.

Accepted ADRs should identify affected ASRs and the relevant overview or implementation evidence. Superseding an ADR requires a link from the older record to its replacement. Product-management decisions remain in the tfmx project-memory decisions collection.

Records

Related documentation

  • ARCHITECTURE.md — concise current-system overview and architecture entrypoint.
  • ASR.md — architecturally significant requirement register.
  • AUDIO_RENDERING_DESIGN.md — callback-driven audio rendering design direction.
  • VISION.md — product intent and future direction.
  • ../MEMORY.md — product-management decisions and roadmap context.