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: update all docs for markdown-only PRD format
Remove all references to prd.json and the two-file model. The prd.md
file is now the single source of truth with structured markdown
headings, status fields, and checkbox acceptance criteria. Replace
<chief-complete/> with <chief-done/> signal. Remove --merge and
--force CLI flags.
│ ├── progress.md # Progress log (Chief appends after each story)
24
23
│ └── claude.log # Raw agent output (for debugging)
25
24
└── worktrees/ # Isolated checkouts for parallel PRDs
@@ -45,42 +44,21 @@ Chief uses this folder as the working context for the entire run. All reads and
45
44
46
45
### `prd.md`
47
46
48
-
The human-readable product requirements document. You write this file (or generate it with `chief new`). It contains context, background, technical notes, and anything else that helps the agent understand what to build.
47
+
The structured product requirements document. You write this file (or generate it with `chief new`). It contains freeform context at the top (background, technical notes, design guidance) and structured user stories that Chief parses and updates.
49
48
50
-
This file is included in the prompt sent to the agent at the start of each iteration. Write it as if you're briefing a senior developer who's new to the project — the more context you provide, the better the output.
49
+
Chief reads this file at the start of each iteration to determine which story to work on, and updates status fields after completing a story. The agent also reads the freeform context to understand what you're building and how.
51
50
52
-
```markdown
53
-
# My Feature
54
-
55
-
## Background
56
-
We need to add user authentication to our API...
57
-
58
-
## Technical Notes
59
-
- We use Express.js with TypeScript
60
-
- Database is PostgreSQL with Prisma ORM
61
-
- Follow existing middleware patterns in `src/middleware/`
62
-
```
63
-
64
-
### `prd.json`
65
-
66
-
The structured, machine-readable PRD. This is where user stories, their priorities, and their completion status live. Chief reads this file at the start of each iteration to determine which story to work on, and writes to it after completing a story.
Chief selects the next story by finding the highest-priority story (lowest `priority` number) where `passes` is `false`. See the [PRD Format](/concepts/prd-format) reference for full details.
61
+
Chief selects the next story by finding the highest-priority story (lowest `**Priority:**` number) without `**Status:** done`. See the [PRD Format](/concepts/prd-format) reference for full details.
84
62
85
63
### `progress.md`
86
64
@@ -184,15 +162,12 @@ A single project can have multiple PRDs, each tracking a separate feature or ini
184
162
├── prds/
185
163
│ ├── auth-system/
186
164
│ │ ├── prd.md
187
-
│ │ ├── prd.json
188
165
│ │ └── progress.md
189
166
│ ├── payment-integration/
190
167
│ │ ├── prd.md
191
-
│ │ ├── prd.json
192
168
│ │ └── progress.md
193
169
│ └── admin-dashboard/
194
170
│ ├── prd.md
195
-
│ ├── prd.json
196
171
│ └── progress.md
197
172
└── worktrees/
198
173
├── auth-system/
@@ -244,8 +219,7 @@ If you want collaborators to see progress and continue where you left off, commi
244
219
```
245
220
246
221
This shares:
247
-
- `prd.md`: Your requirements, the source of truth for what to build
248
-
- `prd.json`: Story state and progress, so collaborators see what's done
222
+
- `prd.md`: Your requirements and story state — the source of truth for what to build and what's done
249
223
- `progress.md`: Implementation history and learnings, valuable project context
250
224
251
225
The `claude.log` files are large, regenerated each run, and only useful for debugging.
0 commit comments