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 0001: Record architecture decisions

  • Status: Accepted (2026-11-10)
  • Date: 2026-11-10
  • Deciders: Vincent Mader
  • Related: doc/README.md

Context

The project will run for months or years, with gaps, several AI agents, and later co-authors who need to understand why the code looks the way it does. Method choices (estimators, integrators, units) are research decisions whose reasons must survive.

Decision

Record every significant architecture or method decision as an ADR in doc/adr/, numbered sequentially, using 0000-template.md (a light MADR variant). Statuses: Proposed, Accepted, Superseded, Rejected. ADRs are never edited in substance after acceptance; a new ADR supersedes an old one and both link to each other. The index is README.md.

Alternatives considered

  • Decisions only in commit messages: not discoverable.
  • A single design document: loses the history of alternatives.

Consequences

  • Small overhead per decision.
  • Agents and co-authors can read the reasons before changing code (project AGENTS.md will point here).