Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
137 changes: 43 additions & 94 deletions docs/src/content/docs/features/prd-mode.md
Original file line number Diff line number Diff line change
@@ -1,124 +1,73 @@
# PRD Mode

> ⚠️ **Experimental** — Squad is alpha software. APIs, commands, and behavior may change between releases.


**Try this to generate a requirements document:**
**Try this to ingest an existing PRD:**
```
Write a PRD for a user authentication system with OAuth support
Read the PRD at docs/product-spec.md and summarize the key requirements
```

**Try this to break down product specs into work items:**
**Try this to turn an existing spec into next steps:**
```
Read the PRD at docs/product-spec.md and break it into work items
Read docs/product-spec.md and suggest implementation slices or GitHub issues
```

Give Squad a product requirements document and the Lead breaks it into prioritized work items, assigns them to the team, and tracks progress with dependency management.
Squad can **read an existing PRD or spec** and help you reason about it in chat. Today, this is an ingestion workflow — not a dedicated PRD authoring system or a built-in persistent work-item tracker.

---

## How to Use

Give Squad a product requirements document. The Lead agent breaks it into work items, assigns them to the team, and tracks progress.
## What works today
Squad can:
- Read a PRD you paste into chat
- Read a PRD from a file path you provide
- Summarize requirements, risks, and open questions
- Suggest implementation slices, milestones, or issue breakdowns
There is **no special CLI command or router for PRD mode** in the current implementation. The feature works because you can point Squad at an existing document and ask for analysis.

---

## How to Use

Paste a PRD directly into the chat:

## How to use it
Paste the PRD directly into chat:
```
> Here's what we're building:
> Here's the PRD for the new onboarding flow:
>
> [paste your PRD or spec]
> [paste the document]
```

Or reference a file:

Or reference a file that already exists in the repo:
```
> Read the PRD at docs/product-spec.md and break it into work items
> Read the PRD at docs/product-spec.md and call out the main requirements
```

---

## How It Works

1. **Lead decomposes the spec** into discrete work items (WI-1, WI-2, WI-3, etc.)
2. **Each work item gets a priority**: P0 (must-have), P1 (important), P2 (nice-to-have)
3. **Work items are assigned** to agents based on domain expertise
4. **Dependencies are tracked** — Squad won't start WI-4 if it depends on WI-2 finishing first
5. **Parallel work** happens where possible — independent work items run simultaneously

### Example output

```
📋 PRD decomposed into 8 work items:

WI-1 [P0] Set up project structure → Kane (Backend)
WI-2 [P0] Design database schema → Kane (Backend)
WI-3 [P0] Build component library → Dallas (Frontend)
WI-4 [P1] Implement auth endpoints → Kane (Backend) [depends: WI-2]
WI-5 [P1] Build login/signup UI → Dallas (Frontend) [depends: WI-3]
WI-6 [P1] Write auth integration tests → Lambert (Tester) [depends: WI-4]
WI-7 [P2] Add social login → Kane (Backend) [depends: WI-4]
WI-8 [P2] Build user profile page → Dallas (Frontend) [depends: WI-5]
```
## What to expect
A good PRD-ingestion session usually produces:
1. A summary of the product goals and constraints
2. A list of ambiguities or missing decisions
3. A suggested implementation breakdown you can turn into issues or milestones
4. Follow-up prompts for the lead, reviewers, or implementers
This is best thought of as **spec reading and decomposition assistance**.

---

## Mid-Project PRD Updates

Requirements change. When they do, give Squad the updated PRD:

```
> The PRD has been updated — re-read docs/product-spec.md
```

The Lead agent:

1. Re-reads the PRD
2. Diffs against the existing work items
3. Adjusts the backlog — adds new items, re-prioritizes, or marks items as obsolete

Work already completed isn't undone. Only the remaining backlog changes.
## What it does not do today
Be careful not to over-read the feature:
- It does **not** provide a dedicated “write a PRD for me” product mode
- It does **not** maintain a first-class backlog with stored WI-1 / WI-2 style identifiers
- It does **not** persist dependency graphs or a PRD-specific board you can query later with commands like “show me the work items”
If you want durable tracking, use the decomposition output to create GitHub issues, project-board items, or other repo artifacts explicitly.

---

## Tips

- P0 work items are tackled first. Use priority levels to control sequencing.
- The Lead handles decomposition — you don't need to break down the spec yourself.
- Dependencies are respected automatically. You won't see an agent start on a dependent task before its prerequisite is done.
- Combine with [GitHub Issues Mode](github-issues.md) to create GitHub issues from work items.

- Start from a real document — a PRD, spec, RFC, or issue write-up already in the repo.
- Ask for gaps and risks, not just summaries.
- After Squad suggests slices, promote the useful ones into GitHub issues or project-board items.
- Combine with [GitHub Issues Mode](github-issues.md) when you want the decomposition turned into tracked work.
## Sample Prompts

```
read the PRD at docs/product-spec.md and break it into work items
read the PRD at docs/product-spec.md and summarize the key requirements
```

Ingests a product requirements document and creates a prioritized, dependency-tracked backlog.

```
show me the work items
```

Displays the current backlog with priorities, assignments, and dependencies.

Ingests an existing PRD and produces a concise requirements summary.
```
the PRD has been updated — re-read docs/product-spec.md
read docs/product-spec.md and list open questions, risks, and assumptions
```

Re-ingests the PRD and adjusts the backlog based on changes without undoing completed work.

Finds the places where the spec is incomplete or needs decisions.
```
start working on approved P0 items
read docs/product-spec.md and suggest an implementation breakdown
```

Begins parallel execution of all high-priority work items with no blockers.

Proposes slices you can convert into issues, milestones, or workstreams.
```
which work items are blocked right now?
the PRD changed — re-read docs/product-spec.md and tell me what changed materially
```

Shows which tasks are waiting on dependencies or other blocking conditions.
Re-ingests the updated document and highlights changes in the requirements.
Loading
Loading