spec-best-practices

Naming

Always SPEC.md. No exceptions for the primary spec file. Not feature.spec.md, not SPEC-feature.md.

Supporting documents linked from a SPEC.md TOC may use descriptive names (e.g., commands.spec.md), but only when a root SPEC.md exists and links to them.

Placement

Specs are colocated with the code they describe: root SPEC.md for project scope, apps/foo/SPEC.md for app scope, packages/bar/SPEC.md for package scope.

• Avoid spec/, docs/specs/, and docs/plans/ directories. Prefer colocated SPEC.md files.
• Plan documents are ephemeral. Absorb durable decisions into the relevant SPEC.md and delete the plan doc.
• When a spec gets long, add a TOC linking to adjacent supporting files (./commands.spec.md, etc.). Supporting files live alongside the SPEC.md, not in a subdirectory.

Content

Specs are freeform markdown. No rigid template, no YAML frontmatter, no required section ordering. These elements must be present:

Problem and solution -- narrative context for why this system/feature exists. Lead with the problem.

Domain model -- types, relationships, data flow. For retroactive specs, derive from inspected code.

Requirements with REQ-* IDs -- every behavioral requirement gets a stable identifier. Format: REQ-{DOMAIN}-{NNN} (e.g., REQ-AUTH-001). Append-only; never renumber. Each requirement is testable and traceable.

Invariants -- conditions that must always hold.

Non-goals -- explicit scope boundary. What this spec intentionally does not cover.

Acceptance criteria -- markdown checklist, not prose:

- [ ] Auth endpoint returns JWT with tier claim
- [ ] Rate limiter rejects >100 req/min per IP

Risk tags (conditional) -- flag high-risk items (schema migrations, auth changes, public API contracts, infra changes) when those risks exist or the ADF PLAN gate requires approval.

Test traceability (conditional) -- REQ-* to test file:line mapping. Added during/after TDD, not at initial authoring.

Authoring rules

Evidence-based: read code before writing spec content. Do not invent behavior, signatures, or file paths. For retroactive specs, derive requirements from the actual implementation.

Retroactive specs are first-class: documenting existing behavior is valid and encouraged. Read the implementation, extract requirements from actual behavior, note inconsistencies as open items (not silent omissions), map traceability to existing tests.

Mutation policy: do not edit a spec without explicit user direction. When drift is found, surface it immediately using specalign patterns. Never silently tolerate or fix drift — the user decides whether to update spec or code.

Spec vs. plan: specs describe what and why; plans describe how and when. Plans are ephemeral. Absorb durable decisions into the spec; delete the plan doc.

Lifecycle

Creation (SPEC gate): see ADF SPEC gate in CLAUDE.md for gate requirements. Determine placement, read existing file and identify gaps (or create at the correct colocated path), ensure all required elements are present.

Maintenance: update spec when behavior changes; append new REQ-* IDs, never renumber; add test traceability as tests are written; run specalign when spec and implementation are both in context.

Retirement: when a feature is removed, remove or archive its SPEC.md. Do not leave stale specs describing deleted behavior.