Skip to content

Commit 80f4188

Browse files
committed
docs: update README with comprehensive SDD workflow documentation
Updated README.md to reflect the complete Spec-Driven Development workflow with: - New directory structure: docs/specs/[NN]-spec-[feature-name]/ - Three-phase task generation process with parent task review - Proof artifacts structure and creation requirements - Enhanced four-stage workflow including validation stage with auto-discovery - Validation gates and coverage matrix details - Links to comprehensive SDD Playbook documentation - Updated mermaid diagram showing all workflow phases and interactions - Clarified checkpoint modes and structured execution patterns This commit captures the trimmed-to-prompts workflow with complete stage descriptions, artifact requirements, and validation processes.
1 parent 33daa1a commit 80f4188

File tree

1 file changed

+114
-48
lines changed

1 file changed

+114
-48
lines changed

README.md

Lines changed: 114 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ uvx --from git+https://github.com/liatrio-labs/slash-command-manager \
2828

2929
**Want to use the prompts directly?** Copy-paste them into your AI assistant:
3030

31-
1. **Generate a spec:** Copy `prompts/generate-spec.md` into your AI chat, provide your idea, answer clarifying questions → Spec created in `tasks/0001-spec-<feature>.md`
31+
1. **Generate a spec:** Copy `prompts/generate-spec.md` into your AI chat → AI assesses scope, asks structured questions (numbered/lettered options), optionally reviews codebase, generates spec, iterates with you → Spec saved to `docs/specs/01-spec-<feature-name>/01-spec-<feature-name>.md`
3232

33-
2. **Generate task list:** Point your AI to the spec and use `prompts/generate-task-list-from-spec.md`Task list created in `tasks/tasks-0001-spec-<feature>.md`
33+
2. **Generate task list:** Point AI to spec (or let it auto-discover) and use `prompts/generate-task-list-from-spec.md`AI analyzes spec, generates parent tasks for review, then after confirmation expands into sub-tasks with "Relevant Files" section → Saved to `docs/specs/01-spec-<feature-name>/01-tasks-<feature-name>.md`
3434

35-
3. **Manage tasks:** Use `prompts/manage-tasks.md` while implementing → Execute tasks one-by-one with proof artifacts
35+
3. **Manage tasks:** Use `prompts/manage-tasks.md` while implementing → Choose checkpoint mode (Continuous/Task/Batch), execute with verification checklists, create proof artifacts **before** commits → Proofs saved to `docs/specs/01-spec-<feature-name>/01-proofs/[NN]-task-[TT]-proofs.md`
3636

37-
4. **SHIP IT** 🚢💨
37+
4. **Validate:** Use `prompts/validate-spec-implementation.md` (or let it auto-discover) → AI verifies proof artifacts, applies validation gates, produces coverage matrix and validation report
38+
39+
5. **SHIP IT** 🚢💨
3840

3941
## Highlights
4042

@@ -58,103 +60,167 @@ Spec-Driven Development (SDD) keeps AI collaborators and human developers aligne
5860

5961
All prompts live in `prompts/` and are designed for use inside your preferred AI assistant.
6062

61-
1. **`generate-spec`** (`prompts/generate-spec.md`): Ask clarifying questions, then author a junior-friendly spec with demoable slices.
62-
2. **`generate-task-list-from-spec`** (`prompts/generate-task-list-from-spec.md`): Transform the approved spec into actionable parent tasks and sub-tasks with proof artifacts.
63-
3. **`manage-tasks`** (`prompts/manage-tasks.md`): Coordinate execution, update task status, and record outcomes as you deliver value.
64-
4. **`validate-spec-implementation`** (`prompts/validate-spec-implementation.md`): Validate that implementation matches the spec requirements.
63+
1. **`generate-spec`** (`prompts/generate-spec.md`): Assess scope appropriateness, ask structured clarifying questions with numbered/lettered options, optionally review codebase context, then author a junior-friendly spec with demoable slices. Includes review and refinement cycle.
64+
2. **`generate-task-list-from-spec`** (`prompts/generate-task-list-from-spec.md`): Three-phase process: (1) internal analysis and planning, (2) generate parent tasks for review, (3) after user confirmation, expand into sub-tasks with relevant files section. Auto-discovers spec if not provided.
65+
3. **`manage-tasks`** (`prompts/manage-tasks.md`): Coordinate execution with checkpoint modes (Continuous/Task/Batch), update task status, create proof artifacts before commits, follow structured verification checklists, and record outcomes as you deliver value.
66+
4. **`validate-spec-implementation`** (`prompts/validate-spec-implementation.md`): Auto-discovers spec if needed, validates implementation against spec using proof artifacts, applies validation gates, produces coverage matrix, and generates comprehensive validation report.
6567

66-
Each prompt writes Markdown outputs into `tasks/`, giving you a lightweight backlog that is easy to review, share, and implement.
68+
Each prompt writes Markdown outputs into `docs/specs/[NN]-spec-[feature-name]/` (where `[NN]` is a zero-padded 2-digit number: 01, 02, 03, etc.), giving you a lightweight backlog that is easy to review, share, and implement.
6769

6870
## How does it work?
6971

7072
The workflow is driven by Markdown prompts that function as reusable playbooks for the AI agent. Reference the prompts directly, or install them as slash commands using the [slash-command-manager](https://github.com/liatrio-labs/slash-command-manager), to keep the AI focused on structured outcomes.
7173

74+
**📚 For comprehensive documentation, examples, and detailed guides, visit the [SDD Playbook on GitHub Pages](https://liatrio-labs.github.io/spec-driven-workflow/):**
75+
76+
- **[SDD Playbook](https://liatrio-labs.github.io/spec-driven-workflow/)** — Complete overview and workflow guide
77+
- **[Comparison](https://liatrio-labs.github.io/spec-driven-workflow/comparison.html)** — How SDD compares to other structured development tools
78+
- **[Developer Experience](https://liatrio-labs.github.io/spec-driven-workflow/developer-experience.html)** — Real-world usage examples and patterns
79+
- **[Common Questions](https://liatrio-labs.github.io/spec-driven-workflow/common-questions.html)** — FAQ and troubleshooting
80+
- **[Video Overview](https://liatrio-labs.github.io/spec-driven-workflow/video-overview.html)** — Visual walkthrough of the workflow
81+
- **[Reference Materials](https://liatrio-labs.github.io/spec-driven-workflow/reference-materials.html)** — Additional resources and examples
82+
7283
## Workflow Overview
7384

7485
Four prompts in `/prompts` define the full lifecycle. Use them sequentially to move from concept to completed work.
7586

7687
### Stage 1 — Generate the Spec ([prompts/generate-spec.md](./prompts/generate-spec.md))
7788

78-
- Directs the AI assistant to use clarifying questions with the user before writing a Markdown spec.
79-
- Produces `/tasks/000X-spec-<feature>.md` with goals, demoable units of work, functional/non-goals, metrics, and open questions.
89+
- **Initial Scope Assessment**: Evaluates if the feature is appropriately sized for this workflow (not too large or too small).
90+
- **Clarifying Questions**: Asks structured questions with numbered/lettered options to gather detailed requirements, focusing on "what" and "why" rather than "how."
91+
- **Context Assessment** (optional): Reviews existing codebase for relevant patterns, constraints, and repository standards.
92+
- **Spec Generation**: Creates a comprehensive specification document with goals, user stories, demoable units, functional requirements, non-goals, design considerations, repository standards, technical considerations, success metrics, and open questions.
93+
- **Review and Refinement**: Validates completeness and clarity with the user, iterating based on feedback.
94+
- Produces `docs/specs/[NN]-spec-[feature-name]/[NN]-spec-[feature-name].md` (where `[NN]` is a zero-padded 2-digit number: 01, 02, 03, etc.).
8095

8196
### Stage 2 — Generate the Task List ([prompts/generate-task-list-from-spec.md](./prompts/generate-task-list-from-spec.md))
8297

83-
- Reads the approved spec, inspects the repo for context, and drafts parent tasks first.
84-
- On confirmation from the user, expands each parent task into sequenced subtasks with demo criteria, proof artifacts, and relevant files.
85-
- Outputs `/tasks/tasks-000X-spec-<feature>.md` ready for implementation.
98+
- **Phase 1: Analysis and Planning** (internal): Receives spec reference (or auto-discovers oldest spec without tasks), analyzes requirements, assesses current codebase state, defines demoable units, and evaluates scope.
99+
- **Phase 2: Parent Task Generation**: Creates high-level parent tasks (typically 4-6) representing demoable units of work, each with demo criteria and proof artifacts. Saves to task file and presents for user review.
100+
- **Phase 3: Sub-Task Generation** (after user confirmation): Identifies relevant files, breaks down each parent task into actionable sub-tasks, and updates the task file with complete structure including "Relevant Files" section.
101+
- Outputs `docs/specs/[NN]-spec-[feature-name]/[NN]-tasks-[feature-name].md` ready for implementation.
86102

87103
### Stage 3 — Manage Tasks ([prompts/manage-tasks.md](./prompts/manage-tasks.md))
88104

89-
- Enforces disciplined execution: mark in-progress immediately, finish one subtask before starting the next, and log artifacts as you go.
90-
- Bakes in commit hygiene, validation steps, and communication rituals so handoffs stay tight.
105+
- **Checkpoint Modes**: Presents three execution modes (Continuous/Task/Batch) for user preference, defaulting to Task Mode.
106+
- **Structured Execution**: Follows a workflow with verification checkpoints:
107+
- Sub-task execution: Mark in-progress → Implement → Test → Quality check → Mark complete
108+
- Parent task completion: Run test suite → Quality gates → Create proof artifacts → Verify demo criteria → Git commit → Mark complete
109+
- **Proof Artifacts**: Creates a single markdown file per parent task in `docs/specs/[NN]-spec-[feature-name]/[NN]-proofs/[NN]-task-[TT]-proofs.md` **before** the commit, containing CLI output, test results, screenshots, configuration examples, and demo validation.
110+
- **Git Workflow**: One commit per parent task with conventional commit format including task and spec references. Includes blocking verification before proceeding to next task.
111+
- Enforces disciplined execution with built-in verification checklists and progress tracking.
91112

92113
### Stage 4 — Validate Implementation ([prompts/validate-spec-implementation.md](./prompts/validate-spec-implementation.md))
93114

94-
- Validates that the implementation matches the spec requirements.
95-
- Checks for completeness, correctness, and adherence to the original specification.
115+
- **Auto-Discovery**: If no spec is provided, automatically discovers the most recent spec with incomplete tasks by scanning `docs/specs/` directory.
116+
- **Validation Process**:
117+
- Maps git commits to requirements and tasks
118+
- Analyzes changed files against "Relevant Files" list
119+
- Verifies proof artifacts (URLs, CLI commands, tests, screenshots)
120+
- Checks repository standards compliance
121+
- **Validation Gates**: Applies mandatory gates (GATE A-E) including critical/high issue blocking, coverage matrix completeness, proof artifact accessibility, file integrity, and repository compliance.
122+
- **Coverage Matrix**: Produces evidence-based coverage tables for Functional Requirements, Repository Standards, and Proof Artifacts with Verified/Failed/Unknown status.
123+
- **Output**: Generates a single human-readable Markdown validation report with executive summary, coverage matrix, issues with severity ratings, and evidence appendix.
124+
- Validates completeness, correctness, and adherence to the original specification.
96125

97126
### Detailed SDD Workflow Diagram
98127

99128
```mermaid
100129
sequenceDiagram
101130
participant U as User
102131
participant GS as 1. generate-spec
103-
participant SPEC as 0001-spec-<feature>.md
132+
participant SPEC as docs/specs/[NN]-spec-[feature]/[NN]-spec-[feature].md
104133
participant GT as 2. generate-task-list-from-spec
105-
participant TL as tasks-0001-spec-<feature>.md
134+
participant TL as docs/specs/[NN]-spec-[feature]/[NN]-tasks-[feature].md
106135
participant MT as 3. manage-tasks
136+
participant PROOFS as docs/specs/[NN]-spec-[feature]/[NN]-proofs/
107137
participant CODE as Code / Docs / Tests
138+
participant VAL as 4. validate-spec-implementation
108139
140+
Note over U,GS: Stage 1: Generate Spec
109141
U->>GS: Provide Feature/Task
110-
GS->>CODE: Analyze codebase
142+
GS->>GS: Assess Scope Appropriateness
143+
GS->>U: Scope Validation
144+
U-->>GS: Confirm Scope
145+
GS->>CODE: Analyze codebase (optional)
111146
CODE-->>GS: Context findings
112-
GS->>U: Clarifications
113-
U-->>GS: Incorporate Clarifications
114-
GS->>SPEC: Write Spec (tasks/)
115-
SPEC-->>U: Review
116-
U-->>GS: Incorporate Review
147+
GS->>U: Structured Clarifying Questions<br/>(numbered/lettered options)
148+
U-->>GS: Answer Questions
149+
GS->>SPEC: Generate Spec (docs/specs/)
150+
SPEC-->>U: Review Spec
151+
U-->>GS: Feedback/Refinement
117152
GS->>SPEC: Finalize Spec
118153
119-
U->>GT: Provide Spec reference
154+
Note over U,GT: Stage 2: Generate Task List
155+
U->>GT: Provide Spec reference<br/>(or auto-discover)
120156
GT->>SPEC: Read Spec
121-
GT->>CODE: Analyze codebase
122-
CODE-->>GT: Context findings
123-
GT-->>U: Phase 1: parent tasks
124-
U-->>GT: Generate sub tasks
125-
GT-->>CODE: Identify Relevant Files
126-
GT->>TL: Phase 2: sub-tasks (write) (tasks/)
127-
128-
U->>MT: Work tasks
129-
MT->>TL: Update statuses
130-
MT->>CODE: Implement changes
131-
CODE-->>U: Demo/changes for review
132-
U-->>MT: Feedback on changes
133-
MT->>CODE: Iterate changes
157+
GT->>GT: Phase 1: Analysis & Planning<br/>(internal)
158+
GT->>CODE: Assess Current State
159+
CODE-->>GT: Patterns & Context
160+
GT->>TL: Phase 2: Generate Parent Tasks<br/>(save to file)
161+
TL-->>U: Review Parent Tasks
162+
U-->>GT: "Generate sub tasks"
163+
GT->>GT: Phase 3: Identify Relevant Files<br/>& Generate Sub-Tasks
164+
GT->>TL: Update with Sub-Tasks<br/>& Relevant Files Section
165+
166+
Note over U,MT: Stage 3: Manage Tasks
167+
U->>MT: Start Implementation
168+
MT->>U: Choose Checkpoint Mode<br/>(Continuous/Task/Batch)
169+
U-->>MT: Mode Selection
170+
loop For Each Parent Task
171+
loop For Each Sub-Task
172+
MT->>TL: Mark [~] In Progress
173+
MT->>CODE: Implement Sub-Task
174+
MT->>CODE: Test & Quality Check
175+
MT->>TL: Mark [x] Complete
176+
end
177+
MT->>CODE: Run Test Suite
178+
MT->>CODE: Quality Gates
179+
MT->>PROOFS: Create Proof Artifacts<br/>[NN]-task-[TT]-proofs.md
180+
MT->>CODE: Git Commit<br/>(with task/spec refs)
181+
MT->>TL: Mark Parent [x] Complete
182+
MT->>MT: Blocking Verification
183+
end
184+
185+
Note over U,VAL: Stage 4: Validate Implementation
186+
U->>VAL: Run Validation<br/>(or auto-discover spec)
187+
VAL->>SPEC: Read Spec
188+
VAL->>TL: Read Task List
189+
VAL->>CODE: Analyze Git Commits
190+
VAL->>PROOFS: Verify Proof Artifacts
191+
VAL->>CODE: Check Repository Standards
192+
VAL->>VAL: Apply Validation Gates<br/>(GATE A-E)
193+
VAL->>VAL: Generate Coverage Matrix
194+
VAL->>U: Validation Report<br/>(PASS/FAIL with evidence)
134195
```
135196

136197
## Core Artifacts
137198

138-
- **Specs:** `000X-spec-<feature>.md` — canonical requirements, demo slices, and success metrics.
139-
- **Task Lists:** `tasks-000X-spec-<feature>.md` — parent/subtask checklist with relevant files and proof artifacts.
199+
- **Specs:** `docs/specs/[NN]-spec-[feature-name]/[NN]-spec-[feature-name].md` — canonical requirements including goals, user stories, demoable units, functional requirements, non-goals, design considerations, repository standards, technical considerations, success metrics, and open questions (where `[NN]` is a zero-padded 2-digit number: 01, 02, 03, etc.).
200+
- **Task Lists:** `docs/specs/[NN]-spec-[feature-name]/[NN]-tasks-[feature-name].md` — parent/subtask checklist with demo criteria, proof artifacts, and "Relevant Files" section listing all files that will be created or modified.
201+
- **Proof Artifacts:** `docs/specs/[NN]-spec-[feature-name]/[NN]-proofs/[NN]-task-[TT]-proofs.md` — single markdown file per parent task (created before commit) containing CLI output, test results, screenshots, configuration examples, and demo validation evidence (where `[NN]` is spec number and `[TT]` is task number).
140202
- **Status Keys:** `[ ]` not started, `[~]` in progress, `[x]` complete, mirroring the manage-tasks guidance.
141-
- **Proof Artifacts:** URLs, CLI commands, screenshots, or tests captured per task to demonstrate working software.
203+
- **Validation Reports:** Generated by the validation prompt, includes coverage matrix, validation gates status, and evidence-based verification results.
142204

143205
## Usage Options
144206

145207
### Option 1: Manual Copy-Paste (No Tooling Required)
146208

147-
1. **Kick off a spec:** Copy or reference `prompts/generate-spec.md` inside your preferred AI chat. Provide the feature idea, answer the clarifying questions, and review the generated spec before saving it under `/tasks`.
148-
2. **Plan the work:** Point the assistant to the new spec and walk through `prompts/generate-task-list-from-spec.md`. Approve parent tasks first, then request the detailed subtasks and relevant files. Commit the result to `/tasks`.
149-
3. **Execute with discipline:** Follow `prompts/manage-tasks.md` while implementing. Update statuses as you work, attach proof artifacts, and pause for reviews at each demoable slice.
150-
4. **Validate:** Use `prompts/validate-spec-implementation.md` to ensure the implementation matches the spec.
209+
1. **Kick off a spec:** Copy or reference `prompts/generate-spec.md` inside your preferred AI chat. The AI will assess scope appropriateness, ask structured clarifying questions (with numbered/lettered options), optionally review your codebase, generate the spec, and iterate with you until it's complete. The spec is saved to `docs/specs/[NN]-spec-[feature-name]/[NN]-spec-[feature-name].md`.
210+
2. **Plan the work:** Point the assistant to the new spec (or let it auto-discover) and walk through `prompts/generate-task-list-from-spec.md`. The AI will analyze the spec, generate parent tasks for your review (Phase 2), then after you confirm, expand into detailed subtasks with a "Relevant Files" section (Phase 3). The result is saved to `docs/specs/[NN]-spec-[feature-name]/[NN]-tasks-[feature-name].md`.
211+
3. **Execute with discipline:** Follow `prompts/manage-tasks.md` while implementing. Choose your checkpoint mode (Continuous/Task/Batch), update statuses as you work, create proof artifacts in `docs/specs/[NN]-spec-[feature-name]/[NN]-proofs/[NN]-task-[TT]-proofs.md` **before** each commit, and follow the verification checklists at each step.
212+
4. **Validate:** Use `prompts/validate-spec-implementation.md` (or let it auto-discover the spec) to ensure the implementation matches the spec. The AI will verify proof artifacts, check coverage, apply validation gates, and produce a comprehensive validation report.
151213

152214
### Option 2: Native Slash Commands (Recommended)
153215

154216
Install the prompts as native slash commands in your AI assistant using the [slash-command-manager](https://github.com/liatrio-labs/slash-command-manager):
155217

156218
```bash
157-
uvx --from git+https://github.com/liatrio-labs/slash-command-manager sdd-install --yes
219+
uvx --from git+https://github.com/liatrio-labs/slash-command-manager \
220+
slash-man generate \
221+
--github-repo liatrio-labs/spec-driven-workflow \
222+
--github-branch main \
223+
--github-path prompts/
158224
```
159225

160226
This will auto-detect your configured AI assistants (Claude Code, Cursor, Windsurf, etc.) and install the prompts as slash commands.

0 commit comments

Comments
 (0)