Skip to main content

Architecture decisions

An Architecture Decision Record (ADR) captures a significant decision, the context behind it, and its consequences. Change a handbook standard by adding or superseding an ADR.

Decision log​

ADRTitleStatus
ADR-001Handbook as source of truthAccepted
ADR-002Git branching modelSuperseded by ADR-007
ADR-003Alembic for database migrationsAccepted
ADR-004Enforced 80% coverage gateAccepted
ADR-005Lambda container image for the lean profile APIAccepted
ADR-006Cloudflare static hosting for the engineering handbookAccepted; CI branch targets amended by ADR-007
ADR-007Main-only Git workflow and project-specific releasesAccepted
ADR-008Modular monolith by defaultProposed

Process​

  • Name files adr-NNN-short-slug.md, numbered sequentially.
  • Use the template.
  • Status lifecycle: Proposed → Accepted → Superseded by ADR-NNN or Deprecated.
  • Never rewrite an accepted ADR's decision. Add a new ADR that supersedes it.