spec-template.md 4.0 KB
title: '{title}'
type: 'feature' # feature | bugfix | refactor | chore
created: '{date}'
status: 'draft' # draft | ready-for-dev | in-progress | in-review | done | blocked
review_loop_iteration: 0 # incremented by step-04 before each review loopback
followup_review_recommended: false # set by step-04 on status: done from the final review pass significance judgment
context: [] # optional: {project-root}/-prefixed paths to project-wide standards/docs the implementation agent should load. Keep short — only what isn't already distilled into the spec body.
warnings: [] # optional: machine-readable warnings for orchestration, e.g. oversized, multiple-goals
Intent
Problem: ONE_TO_TWO_SENTENCES
Approach: ONE_TO_TWO_SENTENCES
Boundaries & Constraints
Always: INVARIANT_RULES
Block If: DECISIONS_REQUIRING_HUMAN_INPUT
Never: NON_GOALS_AND_FORBIDDEN_APPROACHES
I/O & Edge-Case Matrix
| Scenario | Input / State | Expected Output / Behavior | Error Handling |
|---|---|---|---|
| HAPPY_PATH | INPUT | OUTCOME | No error expected |
| ERROR_CASE | INPUT | OUTCOME | ERROR_HANDLING |
Code Map
FILE-- ROLE_OR_RELEVANCEFILE-- ROLE_OR_RELEVANCE
Tasks & Acceptance
Execution:
-
FILE-- ACTION -- RATIONALE
Acceptance Criteria:
- Given PRECONDITION, when ACTION, then EXPECTED_RESULT
Spec Change Log
Review Triage Log
Design Notes
DESIGN_RATIONALE_AND_EXAMPLES
Verification
Commands:
COMMAND-- expected: SUCCESS_CRITERIA
Manual checks (if no CLI):
- WHAT_TO_INSPECT_AND_EXPECTED_STATE