Skip to content

Commit 9217cfd

Browse files
docs: fix step numbering and artifact naming consistency in README
- Change TLDR step numbering from 2,3,4,5 to 0,1,2,3 to match detailed sections - Update artifact naming from concrete example to pattern notation (00N-SYSTEM.md) - Add clarifying note to workflow diagram about optional context generation phase Resolves CodeRabbit review comments (1 duplicate + 2 nitpicks) Co-authored-by: Gregg Coppen <[email protected]>
1 parent 42115f4 commit 9217cfd

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,28 @@
2323
uvx --from git+https://github.com/liatrio-labs/spec-driven-workflow sdd-generate-commands generate --yes
2424
```
2525

26-
2. *(Optional, first time)* Run `/generate-context` to analyze your existing codebase:
26+
0. *(Optional, first time)* Run `/generate-context` to analyze your existing codebase:
2727

2828
```text
2929
/generate-context
3030
```
3131

32-
→ AI analyzes your codebase → Context document created in `docs/001-SYSTEM.md` (or `002-SYSTEM.md`, etc.)
32+
→ AI analyzes your codebase → Context document created in `docs/00N-SYSTEM.md` (e.g., `001-SYSTEM.md`, `002-SYSTEM.md`, etc.)
3333

34-
3. In your AI tool of choice, use `/generate-spec` with your idea:
34+
1. In your AI tool of choice, use `/generate-spec` with your idea:
3535

3636
```text
3737
/generate-spec I want to add user authentication to my app
3838
```
3939

4040
→ AI asks clarifying questions → You provide answers → Spec created in `tasks/0001-spec-user-auth.md`
4141

42-
4. Continue the flow:
42+
2. Continue the flow:
4343

4444
- Run `/generate-task-list-from-spec` → Task list created in `tasks/tasks-0001-spec-user-auth.md`
4545
- Use `/manage-tasks` → Execute tasks one-by-one with proof artifacts
4646

47-
5. **SHIP IT** 🚢💨
47+
3. **SHIP IT** 🚢💨
4848

4949
## Highlights
5050

@@ -122,6 +122,8 @@ Four prompts in `/prompts` define the full lifecycle. Use them sequentially to m
122122
123123
### Detailed SDD Workflow Diagram
124124
125+
> **Note:** This diagram shows the core workflow (stages 1-3). The optional context generation phase (stage 0: `/generate-context`) precedes this flow when analyzing an existing codebase.
126+
125127
```mermaid
126128
sequenceDiagram
127129
participant U as User

0 commit comments

Comments
 (0)