cyberneticlibrary
← library

Write architecture decision record

arch-adrcommandsetup L1★3
phamlongh230-lgtm/yamtam-engine ↗
What it does

Write Architecture Decision Record documenting significant technical choices

Best for

Recording and justifying a major technical decision (framework, database, architecture) for future maintainers

Inputs
  • · Decision topic (inferred from argument or current codebase)
  • · Existing ADRs for numbering and format reference
Outputs
  • · ADR file created at docs/adr/NNNN-<slug>.md
  • · Entry added to docs/adr/README.md index if it exists
Requires
  • · Read (existing ADRs for format and numbering)
  • · Write (new ADR file, updated README.md)
Preconditions
  • · docs/adr/ directory must exist
  • · Existing ADRs present to infer numbering and format
Failure modes
  • · docs/adr/ directory does not exist
  • · No existing ADRs to infer format from
  • · ADR number collision detected
Trust signals
  • · Enforces immutability (once accepted, must supersede with new ADR)
  • · Requires all consequence sections (positive, negative, risks)
  • · Scans codebase to gather constraints (team size, performance requirements)
  • · Updates index automatically