Skip to content
MDDMDDMDD Does Docs
This document describes intent at the time it was written. It is part of the design record, not user documentation, and may not reflect the current behaviour of the code.

001 - Spec-Based Development

Purpose: Document new features in structured specs before implementation to ensure consistency and enable design review

Status: Implemented (2026-05-07)

Requirements

Section titled “Requirements”
  • Write specs before coding new features
  • Use sequential numbering (001, 002, 003…)
  • Include design rationale and key decisions
  • Keep specs focused on design, not implementation details
  • Reference spec numbers in commit messages during implementation

Design Approach

Section titled “Design Approach”
  • Files named XXX-{feature-name}.md in docs/spec/
  • Standard template focusing on purpose, requirements, design approach
  • Status tracking: Draft -> Approved -> Implemented
  • Update 000-specs.md when specs introduce new patterns

Implementation Notes

Section titled “Implementation Notes”
  • See 000-specs.md for code templates
  • Specs should be under 100 lines when possible
  • Extract shared patterns rather than repeating across specs
  • Focus on “why” decisions were made, not “how” to implement
Section titled “Related upstream specs”

Site built 2026-07-30.