Skip to content

Commit 8bdf21f

Browse files
alexeyvclaudebmadcode
authored
doc: standardize quick-flow menu patterns to newer format (bmad-code-org#1388)
Update quick-spec and quick-dev workflow menus to match established standards: - Uppercase all menu option letters ([A], [P], [C], [T], [E], [W], etc.) - Add "Menu Handling Logic:" sections with IF/THEN structure - Add "EXECUTION RULES:" sections with halt/wait behavior - Add chat handling for checkpoint menus (A/P/C) - Remove code blocks from Display patterns, use standard format - Add header for adversarial review process block Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Brian <bmadcode@gmail.com>
1 parent 7d63dcd commit 8bdf21f

File tree

9 files changed

+131
-88
lines changed

9 files changed

+131
-88
lines changed

src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md

Lines changed: 49 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Analyze the user's input to determine mode:
5252
- Load the spec, extract tasks/context/AC
5353
- Set `{execution_mode}` = "tech-spec"
5454
- Set `{tech_spec_path}` = provided path
55-
- **NEXT:** Load `step-03-execute.md`
55+
- **NEXT:** Read fully and follow: `step-03-execute.md`
5656

5757
**Mode B: Direct Instructions**
5858

@@ -88,53 +88,73 @@ Use holistic judgment, not mechanical keyword matching.
8888

8989
### No Escalation (simple request)
9090

91-
Present choice:
91+
Display: "**Select:** [T] Plan first (tech-spec) [E] Execute directly"
9292

93-
```
94-
**[t] Plan first** - Create tech-spec then implement
95-
**[e] Execute directly** - Start now
96-
```
93+
#### Menu Handling Logic:
9794

98-
- **[t]:** Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.**
99-
- **[e]:** Ask for any additional guidance, then **NEXT:** Load `step-02-context-gathering.md`
95+
- IF T: Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.**
96+
- IF E: Ask for any additional guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
97+
98+
#### EXECUTION RULES:
99+
100+
- ALWAYS halt and wait for user input after presenting menu
101+
- ONLY proceed when user makes a selection
102+
103+
---
100104

101105
### Escalation Triggered - Level 0-2
102106

103-
```
104-
This looks like a focused feature with multiple components.
107+
Present: "This looks like a focused feature with multiple components."
108+
109+
Display:
110+
111+
**[T] Create tech-spec first** (recommended)
112+
**[W] Seems bigger than quick-dev** - Recommend the Full BMad Flow PRD Process
113+
**[E] Execute directly**
114+
115+
#### Menu Handling Logic:
105116

106-
**[t] Create tech-spec first** (recommended)
107-
**[w] Seems bigger than quick-dev** - Recommend the Full BMad Flow PRD Process
108-
**[e] Execute directly**
109-
```
117+
- IF T: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
118+
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
119+
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
110120

111-
- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
112-
- **[w]:** Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
113-
- **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md`
121+
#### EXECUTION RULES:
122+
123+
- ALWAYS halt and wait for user input after presenting menu
124+
- ONLY proceed when user makes a selection
125+
126+
---
114127

115128
### Escalation Triggered - Level 3+
116129

117-
```
118-
This sounds like platform/system work.
130+
Present: "This sounds like platform/system work."
131+
132+
Display:
133+
134+
**[W] Start BMad Method** (recommended)
135+
**[T] Create tech-spec** (lighter planning)
136+
**[E] Execute directly** - feeling lucky
137+
138+
#### Menu Handling Logic:
139+
140+
- IF T: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
141+
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
142+
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
119143

120-
**[w] Start BMad Method** (recommended)
121-
**[t] Create tech-spec** (lighter planning)
122-
**[e] Execute directly** - feeling lucky
123-
```
144+
#### EXECUTION RULES:
124145

125-
- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
126-
- **[w]:** Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
127-
- **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md`
146+
- ALWAYS halt and wait for user input after presenting menu
147+
- ONLY proceed when user makes a selection
128148

129149
---
130150

131151
## NEXT STEP DIRECTIVE
132152

133153
**CRITICAL:** When this step completes, explicitly state which step to load:
134154

135-
- Mode A (tech-spec): "**NEXT:** Loading `step-03-execute.md`"
136-
- Mode B (direct, [e] selected): "**NEXT:** Loading `step-02-context-gathering.md`"
137-
- Escalation ([t] or [w]): "**EXITING Quick Dev.** Follow the directed workflow."
155+
- Mode A (tech-spec): "**NEXT:** read fully and follow: `step-03-execute.md`"
156+
- Mode B (direct, [E] selected): "**NEXT:** Read fully and follow: `step-02-context-gathering.md`"
157+
- Escalation ([T] or [W]): "**EXITING Quick Dev.** Follow the directed workflow."
138158

139159
---
140160

src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Ready to execute? (y/n/adjust)
9999

100100
**CRITICAL:** When user confirms ready, explicitly state:
101101

102-
- **y:** "**NEXT:** Loading `step-03-execute.md`"
102+
- **y:** "**NEXT:** Read fully and follow: `step-03-execute.md`"
103103
- **n/adjust:** Continue gathering context, then re-present plan
104104

105105
---

src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For each task:
9191

9292
## NEXT STEP
9393

94-
When ALL tasks are complete (or halted on blocker), load `step-04-self-check.md`.
94+
When ALL tasks are complete (or halted on blocker), read fully and follow: `step-04-self-check.md`.
9595

9696
---
9797

src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ If TodoWrite or similar tool is available, turn each finding into a TODO, includ
8585

8686
## NEXT STEP
8787

88-
With findings in hand, load `step-06-resolve-findings.md` for user to choose resolution approach.
88+
With findings in hand, read fully and follow: `step-06-resolve-findings.md` for user to choose resolution approach.
8989

9090
---
9191

src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,24 @@ From previous steps:
2525

2626
## RESOLUTION OPTIONS
2727

28-
Present choice to user:
28+
Present: "How would you like to handle these findings?"
2929

30-
```
31-
How would you like to handle these findings?
30+
Display:
3231

3332
**[1] Walk through** - Discuss each finding individually
3433
**[2] Auto-fix** - Automatically fix issues classified as "real"
3534
**[3] Skip** - Acknowledge and proceed to commit
36-
```
35+
36+
### Menu Handling Logic:
37+
38+
- IF 1: Execute OPTION 1 (Walk Through) below
39+
- IF 2: Execute OPTION 2 (Auto-fix) below
40+
- IF 3: Execute OPTION 3 (Skip) below
41+
42+
### EXECUTION RULES:
43+
44+
- ALWAYS halt and wait for user input after presenting menu
45+
- ONLY proceed when user makes a selection
3746

3847
---
3948

src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,20 @@ Hey {user_name}! Found a tech-spec in progress:
4747
4848
Is this what you're here to continue?
4949
50-
[y] Yes, pick up where I left off
51-
[n] No, archive it and start something new
50+
[Y] Yes, pick up where I left off
51+
[N] No, archive it and start something new
5252
```
5353

5454
4. **HALT and wait for user selection.**
5555

5656
a) **Menu Handling:**
5757

58-
- **[y] Continue existing:**
58+
- **[Y] Continue existing:**
5959
- Jump directly to the appropriate step based on `stepsCompleted`:
6060
- `[1]` → Load `{nextStepFile}` (Step 2)
6161
- `[1, 2]` → Load `{skipToStepFile}` (Step 3)
6262
- `[1, 2, 3]` → Load `./step-04-review.md` (Step 4)
63-
- **[n] Archive and start fresh:**
63+
- **[N] Archive and start fresh:**
6464
- Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md`
6565

6666
### 1. Greet and Ask for Initial Request
@@ -162,19 +162,22 @@ b) **Report to user:**
162162

163163
a) **Display menu:**
164164

165-
```
166-
[a] Advanced Elicitation - dig deeper into requirements
167-
[c] Continue - proceed to next step
168-
[p] Party Mode - bring in other experts
169-
```
165+
Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Deep Investigation (Step 2 of 4)"
170166

171167
b) **HALT and wait for user selection.**
172168

173-
#### Menu Handling:
169+
#### Menu Handling Logic:
170+
171+
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
172+
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
173+
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{nextStepFile}`
174+
- IF Any other comments or queries: respond helpfully then redisplay menu
175+
176+
#### EXECUTION RULES:
174177

175-
- **[a]**: Read fully and follow: `{advanced_elicitation}`, then return here and redisplay menu
176-
- **[c]**: Read fully and follow: `{nextStepFile}` (Map Technical Constraints)
177-
- **[p]**: Read fully and follow: `{party_mode_exec}`, then return here and redisplay menu
178+
- ALWAYS halt and wait for user input after presenting menu
179+
- ONLY proceed to next step when user selects 'C'
180+
- After A or P execution, return to this menu
178181

179182
---
180183

@@ -186,4 +189,4 @@ b) **HALT and wait for user selection.**
186189

187190
- [ ] WIP check performed FIRST before any greeting.
188191
- [ ] `{wipFile}` created with correct frontmatter, Overview, Context for Development, and `stepsCompleted: [1]`.
189-
- [ ] User selected [c] to continue.
192+
- [ ] User selected [C] to continue.

src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,22 @@ Fill in:
115115

116116
### 4. Present Checkpoint Menu
117117

118-
**Display menu:**
119-
120-
```
121-
[a] Advanced Elicitation - explore more context
122-
[c] Continue - proceed to Generate Spec
123-
[p] Party Mode - bring in other experts
124-
```
118+
Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Generate Spec (Step 3 of 4)"
125119

126120
**HALT and wait for user selection.**
127121

128-
#### Menu Handling:
122+
#### Menu Handling Logic:
123+
124+
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
125+
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
126+
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{nextStepFile}`
127+
- IF Any other comments or queries: respond helpfully then redisplay menu
128+
129+
#### EXECUTION RULES:
129130

130-
- **[a]**: Read fully and follow: `{advanced_elicitation}`, then return here and redisplay menu
131-
- **[c]**: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{nextStepFile}`
132-
- **[p]**: Read fully and follow: `{party_mode_exec}`, then return here and redisplay menu
131+
- ALWAYS halt and wait for user input after presenting menu
132+
- ONLY proceed to next step when user selects 'C'
133+
- After A or P execution, return to this menu
133134

134135
---
135136

src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,24 @@ wipFile: '{implementation_artifacts}/tech-spec-wip.md'
4343

4444
**Present review menu:**
4545

46-
```
47-
[y] Approve - finalize the spec
48-
[c] Changes - request modifications
49-
[q] Questions - ask about any section
50-
[a] Advanced Elicitation - dig deeper before approving
51-
[p] Party Mode - get expert feedback before approving
52-
```
46+
Display: "**Select:** [Y] Approve [C] Changes [Q] Questions [A] Advanced Elicitation [P] Party Mode"
5347

5448
**HALT and wait for user selection.**
5549

56-
#### Menu Handling:
50+
#### Menu Handling Logic:
51+
52+
- IF Y: Proceed to Section 3 (Finalize the Spec)
53+
- IF C: Proceed to Section 2 (Handle Review Feedback), then return here and redisplay menu
54+
- IF Q: Answer questions, then redisplay this menu
55+
- IF A: Read fully and follow: `{advanced_elicitation}` with current spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
56+
- IF P: Read fully and follow: `{party_mode_exec}` with current spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
57+
- IF Any other comments or queries: respond helpfully then redisplay menu
58+
59+
#### EXECUTION RULES:
5760

58-
- **[y]**: Proceed to Section 3 (Finalize the Spec)
59-
- **[c]**: Proceed to Section 2 (Handle Review Feedback), then return here and redisplay menu
60-
- **[q]**: Answer questions, then redisplay this menu
61-
- **[a]**: Read fully and follow: `{advanced_elicitation}`, then return here and redisplay menu
62-
- **[p]**: Read fully and follow: `{party_mode_exec}`, then return here and redisplay menu
61+
- ALWAYS halt and wait for user input after presenting menu
62+
- ONLY proceed to finalize when user selects 'Y'
63+
- After other menu items execution, return to this menu
6364

6465
### 2. Handle Review Feedback
6566

@@ -114,11 +115,11 @@ Saved to: {finalFile}
114115
115116
**Next Steps:**
116117
117-
[a] Advanced Elicitation - refine further
118-
[r] Adversarial Review - critique of the spec (highly recommended)
119-
[b] Begin Development - start implementing now (not recommended)
120-
[d] Done - exit workflow
121-
[p] Party Mode - get expert feedback before dev
118+
[A] Advanced Elicitation - refine further
119+
[R] Adversarial Review - critique of the spec (highly recommended)
120+
[B] Begin Development - start implementing now (not recommended)
121+
[D] Done - exit workflow
122+
[P] Party Mode - get expert feedback before dev
122123
123124
---
124125
@@ -135,14 +136,23 @@ This ensures the dev agent has clean context focused solely on implementation.
135136

136137
b) **HALT and wait for user selection.**
137138

138-
#### Menu Handling:
139+
#### Menu Handling Logic:
140+
141+
- IF A: Read fully and follow: `{advanced_elicitation}` with current spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
142+
- IF B: Load and execute `{quick_dev_workflow}` with the final spec file (warn: fresh context is better)
143+
- IF D: Exit workflow - display final confirmation and path to spec
144+
- IF P: Read fully and follow: `{party_mode_exec}` with current spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update spec then redisplay menu, if no keep original then redisplay menu
145+
- IF R: Execute Adversarial Review (see below)
146+
- IF Any other comments or queries: respond helpfully then redisplay menu
147+
148+
#### EXECUTION RULES:
149+
150+
- ALWAYS halt and wait for user input after presenting menu
151+
- After A, P, or R execution, return to this menu
152+
153+
#### Adversarial Review [R] Process:
139154

140-
- **[a]**: Read fully and follow: `{advanced_elicitation}`, then return here and redisplay menu
141-
- **[b]**: Read fully and follow: `{quick_dev_workflow}` with the final spec file (warn: fresh context is better)
142-
- **[d]**: Exit workflow - display final confirmation and path to spec
143-
- **[p]**: Read fully and follow: `{party_mode_exec}`, then return here and redisplay menu
144-
- **[r]**: Execute Adversarial Review:
145-
1. **Invoke Adversarial Review Task**:
155+
1. **Invoke Adversarial Review Task**:
146156
> With `{finalFile}` constructed, invoke the review task. If possible, use information asymmetry: run this task, and only it, in a separate subagent or process with read access to the project, but no context except the `{finalFile}`.
147157
<invoke-task>Review {finalFile} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml</invoke-task>
148158
> **Platform fallback:** If task invocation not available, load the task file and follow its instructions inline, passing `{finalFile}` as the content.
@@ -161,7 +171,7 @@ b) **HALT and wait for user selection.**
161171

162172
### 5. Exit Workflow
163173

164-
**When user selects [d]:**
174+
**When user selects [D]:**
165175

166176
"**All done!** Your tech-spec is ready at:
167177

src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This uses **step-file architecture** for disciplined execution:
4747
1. **READ COMPLETELY**: Always read the entire step file before taking any action
4848
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
4949
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
50-
4. **CHECK CONTINUATION**: Only proceed to next step when user selects [c] (Continue)
50+
4. **CHECK CONTINUATION**: Only proceed to next step when user selects [C] (Continue)
5151
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
5252
6. **LOAD NEXT**: When directed, read fully and follow the next step file
5353

0 commit comments

Comments
 (0)