Use when writing, updating, or reviewing a spec in docs/specs. Defines the file layout and the requirement ID format.
Spec format¶
Specs live in docs/specs/, one file per package or app feature.
Layout¶
# <Name> spec
Prefix: <PREFIX>
## Overview
## Requirements
- <PREFIX>-001 [test] The system does X when Y.
## Differences from the reference
## Out of scope
## Open questions
Requirements¶
- ID format:
<PREFIX>-NNN, unique, never reused or renumbered. - One behaviour per requirement, small and testable. Describe behaviour, not implementation.
- App specs tag each requirement:
[test](automated test),[ux](test through the rendered UI),[manual](acceptance checklist). - Anything the target does not need goes under "Out of scope".
- Do not invent library APIs. Verify them first.