Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
213053c
Remove title field from generate-spec prompt
iaminawe Oct 17, 2025
a645aa6
Remove title field from prompts and parser
iaminawe Oct 17, 2025
b285a82
Remove title field from test fixtures
iaminawe Oct 17, 2025
e795fe8
feat: add reverse-engineer-codebase prompt for contextual analysis
iaminawe Oct 21, 2025
e0471a5
refactor: rename reverse-engineer-codebase to generate-codebase-context
iaminawe Oct 21, 2025
5f071b6
docs: add comprehensive research analysis for prompt improvements
iaminawe Oct 21, 2025
e8c27f6
feat: enhance generate-codebase-context with evidence citations and c…
iaminawe Oct 21, 2025
754c5ea
docs: add comprehensive progress tracking and future roadmap
iaminawe Oct 21, 2025
5a8cedf
docs: add research directory README with complete overview
iaminawe Oct 21, 2025
f5ce583
docs: add accurate PR description for new prompt creation
iaminawe Oct 21, 2025
9fe9884
docs: emphasize NEW prompt creation in PR description
iaminawe Oct 21, 2025
1ec8b01
refactor: reorganize documentation structure
iaminawe Oct 21, 2025
c19cfe2
fix: resolve pre-commit markdownlint issues
iaminawe Oct 21, 2025
6fc25c6
chore: remove accidentally committed WARP.md session notes
iaminawe Oct 21, 2025
27b548e
Merge branch 'main' into add-reverse-engineer-codebase-prompt
iaminawe Oct 21, 2025
50061d7
fix: resolve pre-commit markdownlint issues
github-actions[bot] Oct 21, 2025
f387337
fix: resolve pre-commit issues after merge from main
iaminawe Oct 21, 2025
f3c2b1e
fix: convert emphasis to headings to resolve MD036 linting issues
github-actions[bot] Oct 21, 2025
705f76d
feat: enhance generate-spec prompt with evidence-based approach
iaminawe Oct 21, 2025
02ff6fb
feat: enhance generate-codebase-context with advanced analysis features
iaminawe Oct 21, 2025
f93790c
feat: add explicit 'What NOT to Do' section to generate-spec
iaminawe Oct 21, 2025
098785a
refactor: condense generate-codebase-context prompt from 1264 to 930 …
iaminawe Oct 21, 2025
e432810
fix: add blank lines in code blocks for markdownlint compliance
iaminawe Oct 21, 2025
b6535ee
Merge branch 'main' into add-reverse-engineer-codebase-prompt
iaminawe Oct 23, 2025
d1274aa
feat: add comprehensive codebase context analysis for mcp-spec-driven
iaminawe Oct 23, 2025
78db745
chore: update repository URLs to spec-driven-workflow
iaminawe Oct 23, 2025
98ea2db
fix: update research doc paths and restore Phase 4 checkpoint
github-actions[bot] Oct 23, 2025
e0a8fda
fix: resolve markdown linting issues in claude-code-feature-dev-compa…
github-actions[bot] Oct 23, 2025
ba6f472
fix: add blank line and language specifier to code block in claude-co…
github-actions[bot] Oct 23, 2025
059d75d
fix: apply markdownlint formatting fixes
iaminawe Oct 23, 2025
1f8152d
fix: add Phase 5.5 to execution rules in generate-context prompt
github-actions[bot] Oct 24, 2025
f1119ae
docs: resolve CodeRabbit nitpick comments
github-actions[bot] Oct 24, 2025
a1c31ba
Merge branch 'main' into add-reverse-engineer-codebase-prompt
iaminawe Oct 24, 2025
c265968
fix: add blank line before list in research-synthesis.md
iaminawe Oct 24, 2025
9565791
fix: convert emphasis to headings in generate-spec.md (MD036)
iaminawe Oct 24, 2025
789bcd9
Merge branch 'main' into add-reverse-engineer-codebase-prompt
iaminawe Oct 24, 2025
1b75ddd
chore: revert generate-spec to default from main
iaminawe Oct 27, 2025
760ad8b
chore: remove progress.md for now
iaminawe Oct 27, 2025
7995397
chore: remove reference to progress.md
iaminawe Oct 27, 2025
c45c7e0
Merge branch 'main' into generate-context-prompt
iaminawe Nov 10, 2025
ba75202
refactor: enhance generate-spec context assessment and remove researc…
iaminawe Nov 10, 2025
2039200
docs: add generate-context prompt to workflow documentation
iaminawe Nov 10, 2025
61b094b
fix: add blank line before list in README.md (markdownlint MD032)
iaminawe Nov 10, 2025
9dbb526
chore: revert unrelated task file URL changes
iaminawe Nov 10, 2025
42115f4
docs: clarify 00N-SYSTEM.md naming pattern with examples
iaminawe Nov 10, 2025
9217cfd
docs: fix step numbering and artifact naming consistency in README
github-actions[bot] Nov 10, 2025
4c1eb4d
fix: correct ordered list numbering for markdownlint compliance
iaminawe Nov 10, 2025
332589f
fix: complete ordered list numbering fix in TLDR section
iaminawe Nov 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 46 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,28 @@
uvx --from git+https://github.com/liatrio-labs/spec-driven-workflow sdd-generate-commands generate --yes
```

2. In your AI tool of choice, use `/generate-spec` with your idea:
2. *(Optional, first time)* Run `/generate-context` to analyze your existing codebase:

```text
/generate-context
```

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

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

```text
/generate-spec I want to add user authentication to my app
```

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

3. Continue the flow:
4. Continue the flow:

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

4. **SHIP IT** 🚢💨
5. **SHIP IT** 🚢💨

## Highlights

Expand All @@ -62,19 +70,39 @@ MCP technology remains available as an optional integration, but the heart of th

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

### Optional Pre-Setup

**`generate-context`** (`prompts/generate-context.md`): **Optional first step** for analyzing existing codebases before starting spec development. Use this when:

- Working with an existing codebase the AI hasn't seen before
- Need to understand repository architecture, patterns, and conventions
- Want to document technical decisions and design rationale
- Setting up context for multiple specs in the same project

This prompt performs comprehensive codebase analysis and generates a `docs/00N-SYSTEM.md` file (where N is a sequential number: 001, 002, etc.) documenting architecture, tech stack, patterns, and conventions that inform all subsequent spec development.

### Core SDD Workflow

1. **`generate-spec`** (`prompts/generate-spec.md`): Ask clarifying questions, then author a junior-friendly spec with demoable slices.
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.
3. **`manage-tasks`** (`prompts/manage-tasks.md`): Coordinate execution, update task status, and record outcomes as you deliver value.

Each prompt writes Markdown outputs into `tasks/`, giving you a lightweight backlog that is easy to review, share, and implement.
Each prompt writes Markdown outputs into `tasks/` or `docs/`, giving you a lightweight backlog that is easy to review, share, and implement.

## How does it work?

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.

## Workflow Overview

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

### Optional Pre-Setup — Generate Codebase Context ([prompts/generate-context.md](./prompts/generate-context.md))

- **When to use:** Working with an existing codebase or starting multiple specs in the same project
- **What it does:** Analyzes existing codebase architecture, extracts patterns and conventions, and documents technical decisions
- **Output:** Creates `docs/00N-SYSTEM.md` (e.g., `001-SYSTEM.md`) with comprehensive codebase context that informs all subsequent spec generation
- **Skip when:** Starting a greenfield project or the AI already has sufficient context about your codebase

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

Expand All @@ -94,6 +122,8 @@ Three prompts in `/prompts` define the full lifecycle. Use them sequentially to

### Detailed SDD Workflow Diagram

> **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.

```mermaid
sequenceDiagram
participant U as User
Expand Down Expand Up @@ -133,8 +163,9 @@ sequenceDiagram

## Core Artifacts

- **Specs:** `000X-spec-<feature>.md` — canonical requirements, demo slices, and success metrics.
- **Task Lists:** `tasks-000X-spec-<feature>.md` — parent/subtask checklist with relevant files and proof artifacts.
- **Codebase Context (Optional):** `docs/00N-SYSTEM.md` (e.g., `001-SYSTEM.md`, `002-SYSTEM.md`) — comprehensive codebase analysis documenting architecture, patterns, conventions, and technical decisions that inform spec development.
- **Specs:** `tasks/000X-spec-<feature>.md` — canonical requirements, demo slices, and success metrics.
- **Task Lists:** `tasks/tasks-000X-spec-<feature>.md` — parent/subtask checklist with relevant files and proof artifacts.
- **Status Keys:** `[ ]` not started, `[~]` in progress, `[x]` complete, mirroring the manage-tasks guidance.
- **Proof Artifacts:** URLs, CLI commands, screenshots, or tests captured per task to demonstrate working software.

Expand All @@ -144,9 +175,10 @@ The SDD workflow can be used in three ways, from simplest to most automated:

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

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`.
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`.
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.
1. **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.
2. **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`.
3. **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`.
4. **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.

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

Expand Down Expand Up @@ -194,9 +226,10 @@ Run the prompts as an MCP server for programmatic access. This option is most us

### Workflow Essentials

1. Open `prompts/generate-spec.md` inside your AI assistant and follow the instructions to produce a new spec in `tasks/`.
2. Point the assistant at the generated spec and run `prompts/generate-task-list-from-spec.md` to create the implementation backlog.
3. Use `prompts/manage-tasks.md` while executing work to keep status, demo criteria, and proof artifacts up to date.
1. **(Optional, first time)** Run `/generate-context` or open `prompts/generate-context.md` to analyze your codebase and generate architecture documentation in `docs/`.
2. Open `prompts/generate-spec.md` inside your AI assistant and follow the instructions to produce a new spec in `tasks/`.
3. Point the assistant at the generated spec and run `prompts/generate-task-list-from-spec.md` to create the implementation backlog.
4. Use `prompts/manage-tasks.md` while executing work to keep status, demo criteria, and proof artifacts up to date.

### Installation

Expand Down
Loading