Scope some workflow steps to individual features
This commit is contained in:
parent
53e83a666b
commit
77b25c461e
5 changed files with 77 additions and 53 deletions
|
|
@ -14,8 +14,8 @@ You are generating user-facing documentation derived from the system's design do
|
|||
Read:
|
||||
- `spec/system.md`
|
||||
- All feature design docs: Glob for `spec/features/*/design.md`
|
||||
- All feature plans: Glob for `spec/features/*/plan.md`
|
||||
- `spec/formal/traceability.md`
|
||||
- `spec/plan.md`
|
||||
- Existing documentation in the project root and `docs/` directory (Glob for `*.md`, `docs/**/*.md`, excluding `spec/`)
|
||||
|
||||
All spec artifacts must exist. If `spec/system.md` or feature design docs are missing, direct the user to the prerequisite commands (`/formspec.init.0`, `/formspec.design.1`) and stop.
|
||||
|
|
@ -25,7 +25,7 @@ All spec artifacts must exist. If `spec/system.md` or feature design docs are mi
|
|||
From the design artifacts, identify what needs to be documented:
|
||||
- System-level overview and purpose (from `spec/system.md`)
|
||||
- Per-feature user-facing behavior (from feature design docs — user stories, success criteria)
|
||||
- Configuration, setup, and usage (from plan.md — technology choices, architecture)
|
||||
- Configuration, setup, and usage (from feature plans — technology choices, architecture)
|
||||
- API contracts and interfaces (from design docs — Interface Contract sections are the primary source; user stories describe the behavior behind those interfaces)
|
||||
- Behavioral guarantees the system makes (from traceability — which formal properties translate to user-visible promises)
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ Create or update documentation files. The exact structure depends on the project
|
|||
|
||||
**README.md** (if it doesn't exist or needs updating):
|
||||
- Project description derived from `spec/system.md` System Overview
|
||||
- Setup and usage instructions derived from `spec/plan.md` technology choices
|
||||
- Setup and usage instructions derived from feature plans' technology choices
|
||||
- Feature descriptions derived from feature design docs
|
||||
|
||||
**docs/** (for projects complex enough to warrant separate pages):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue