19 lines
1.1 KiB
Markdown
19 lines
1.1 KiB
Markdown
# /speckit.specify — create a feature specification
|
|
|
|
The user gives you a feature description. Turn it into a reviewable spec:
|
|
|
|
1. Run `python3 speckit.py specify "<the description>"` from the project —
|
|
or, when the user provides the brief as a file, pass its path instead
|
|
(add `--name "<short feature name>"` when the file starts with metadata).
|
|
This creates `specs/NNN-slug/spec.md` and makes it the current feature.
|
|
2. Open that spec.md and replace every placeholder section with real content:
|
|
prioritized user stories with acceptance scenarios (## User Stories),
|
|
verifiable numbered requirements and key entities (## Requirements),
|
|
measurable technology-agnostic outcomes (## Success Criteria), and the
|
|
defaults you chose for open points (## Assumptions).
|
|
3. Where you truly cannot decide without the user, leave a marker of the form
|
|
NEEDS CLARIFICATION plus the question in square brackets — at most 3.
|
|
4. Finish by running `python3 speckit.py check` and resolving any findings.
|
|
|
|
Do not make technology choices here — the spec says what and why, never how.
|