You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add generate-context prompt to workflow documentation
Update README.md to include the generate-context prompt as an optional
pre-setup step in the SDD workflow:
- Add "Optional Pre-Setup" section explaining when and why to use generate-context
- Update workflow overview from 3 to 4 prompts
- Include generate-context in TLDR, Workflow Essentials, and usage examples
- Add SYSTEM.md to Core Artifacts section
- Position generate-context as first-time/existing codebase analysis tool
This aligns documentation with the workflow diagram showing optional
pre-setup for reverse-engineering existing context.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
2. In your AI tool of choice, use `/generate-spec` with your idea:
26
+
2. *(Optional, first time)* Run `/generate-context` to analyze your existing codebase:
27
+
28
+
```text
29
+
/generate-context
30
+
```
31
+
32
+
→ AI analyzes your codebase → Context document created in`docs/001-SYSTEM.md`
33
+
34
+
3. In your AI tool of choice, use `/generate-spec` with your idea:
27
35
28
36
```text
29
37
/generate-spec I want to add user authentication to my app
30
38
```
31
39
32
40
→ AI asks clarifying questions → You provide answers → Spec created in`tasks/0001-spec-user-auth.md`
33
41
34
-
3. Continue the flow:
42
+
4. Continue the flow:
35
43
36
44
- Run `/generate-task-list-from-spec` → Task list created in`tasks/tasks-0001-spec-user-auth.md`
37
45
- Use `/manage-tasks` → Execute tasks one-by-one with proof artifacts
38
46
39
-
4. **SHIP IT** 🚢💨
47
+
5. **SHIP IT** 🚢💨
40
48
41
49
## Highlights
42
50
@@ -62,19 +70,38 @@ MCP technology remains available as an optional integration, but the heart of th
62
70
63
71
All prompts live in`prompts/` and are designed for use inside your preferred AI assistant.
64
72
73
+
### Optional Pre-Setup
74
+
75
+
**`generate-context`** (`prompts/generate-context.md`): **Optional first step**for analyzing existing codebases before starting spec development. Use this when:
76
+
- Working with an existing codebase the AI hasn't seen before
77
+
- Need to understand repository architecture, patterns, and conventions
78
+
- Want to document technical decisions and design rationale
79
+
- Setting up context for multiple specs in the same project
80
+
81
+
This prompt performs comprehensive codebase analysis and generates a `docs/00N-SYSTEM.md` file documenting architecture, tech stack, patterns, and conventions that inform all subsequent spec development.
82
+
83
+
### Core SDD Workflow
84
+
65
85
1. **`generate-spec`** (`prompts/generate-spec.md`): Ask clarifying questions, then author a junior-friendly spec with demoable slices.
66
86
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.
67
87
3. **`manage-tasks`** (`prompts/manage-tasks.md`): Coordinate execution, update task status, and record outcomes as you deliver value.
68
88
69
-
Each prompt writes Markdown outputs into `tasks/`, giving you a lightweight backlog that is easy to review, share, and implement.
89
+
Each prompt writes Markdown outputs into `tasks/` or `docs/`, giving you a lightweight backlog that is easy to review, share, and implement.
70
90
71
91
## How does it work?
72
92
73
93
The workflow is driven by Markdown prompts that function as reusable playbooks for the AI agent. Reference the prompts directly, or invoke them via supported tooling, to keep the AI focused on structured outcomes. Users can manage context with their existing workflows (GitHub CLI, Atlassian MCP, etc.), and optionally let the MCP server automate portions of the process.
74
94
75
95
## Workflow Overview
76
96
77
-
Three prompts in`/prompts` define the full lifecycle. Use them sequentially to move from concept to completed work.
97
+
Four prompts in `/prompts` define the full lifecycle. Use them sequentially to move from concept to completed work.
- **Task Lists:** `tasks/tasks-000X-spec-<feature>.md` — parent/subtask checklist with relevant files and proof artifacts.
138
166
- **Status Keys:** `[ ]` not started, `[~]` in progress, `[x]` complete, mirroring the manage-tasks guidance.
139
167
- **Proof Artifacts:** URLs, CLI commands, screenshots, or tests captured per task to demonstrate working software.
140
168
@@ -144,6 +172,7 @@ The SDD workflow can be used in three ways, from simplest to most automated:
144
172
145
173
### Option 1: Manual Copy-Paste (No Tooling Required)
146
174
175
+
0. **Optional: Generate codebase context (first time only):** If working with an existing codebase, copy or reference `prompts/generate-context.md` to analyze the repository and generate a comprehensive context document in `/docs`. This step helps the AI understand your codebase architecture and patterns for all subsequent specs.
147
176
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
177
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
178
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.
@@ -194,6 +223,7 @@ Run the prompts as an MCP server for programmatic access. This option is most us
194
223
195
224
### Workflow Essentials
196
225
226
+
0. **(Optional, first time)** Run `/generate-context` or open `prompts/generate-context.md` to analyze your codebase and generate architecture documentation in`docs/`.
197
227
1. Open `prompts/generate-spec.md` inside your AI assistant and follow the instructions to produce a new spec in`tasks/`.
198
228
2. Point the assistant at the generated spec and run `prompts/generate-task-list-from-spec.md` to create the implementation backlog.
199
229
3. Use `prompts/manage-tasks.md`while executing work to keep status, demo criteria, and proof artifacts up to date.
0 commit comments