bmad-method 4.26.0 → 4.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +2 -0
- package/CHANGELOG.md +15 -0
- package/README.md +29 -282
- package/bmad-core/agents/analyst.md +3 -1
- package/bmad-core/agents/bmad-master.md +5 -1
- package/bmad-core/agents/bmad-orchestrator.md +1 -1
- package/bmad-core/core-config.yaml +1 -1
- package/bmad-core/data/bmad-kb.md +74 -15
- package/bmad-core/data/brainstorming-techniques.md +36 -0
- package/bmad-core/data/elicitation-methods.md +134 -0
- package/bmad-core/tasks/advanced-elicitation.md +82 -57
- package/bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
- package/bmad-core/templates/architecture-tmpl.md +23 -23
- package/bmad-core/templates/brainstorming-output-tmpl.md +149 -0
- package/bmad-core/templates/prd-tmpl.md +6 -6
- package/bmad-core/templates/prd-tmpl2.yaml +202 -0
- package/bmad-core/utils/plan-management.md +9 -13
- package/bmad-core/workflows/greenfield-service.yaml +1 -1
- package/common/tasks/create-doc.md +4 -4
- package/common/tasks/create-doc2.md +65 -0
- package/common/utils/bmad-doc-template.md +296 -0
- package/dist/agents/analyst.txt +481 -305
- package/dist/agents/architect.txt +60 -59
- package/dist/agents/bmad-master.txt +694 -399
- package/dist/agents/bmad-orchestrator.txt +197 -116
- package/dist/agents/dev.txt +18 -17
- package/dist/agents/pm.txt +47 -46
- package/dist/agents/po.txt +31 -30
- package/dist/agents/qa.txt +15 -14
- package/dist/agents/sm.txt +23 -22
- package/dist/agents/ux-expert.txt +29 -28
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +33 -32
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +19 -18
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +21 -20
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +385 -297
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +103 -77
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +29 -28
- package/dist/teams/team-all.txt +610 -438
- package/dist/teams/team-fullstack.txt +597 -425
- package/dist/teams/team-ide-minimal.txt +238 -157
- package/dist/teams/team-no-ui.txt +583 -411
- package/docs/agentic-tools/github-copilot-guide.md +29 -9
- package/docs/bmad-workflow-guide.md +2 -2
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +2 -2
- package/expansion-packs/bmad-creator-tools/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/package.json +1 -1
- package/tools/builders/web-builder.js +117 -22
- package/tools/installer/config/install.config.yaml +2 -2
- package/tools/installer/lib/ide-setup.js +2 -2
- package/tools/installer/package.json +1 -1
- package/tools/lib/dependency-resolver.js +3 -3
- package/tools/md-assets/web-agent-startup-instructions.md +10 -10
- package/bmad-core/tasks/brainstorming-techniques.md +0 -238
|
@@ -8,14 +8,14 @@ You are now operating as a specialized AI agent from the BMad-Method framework.
|
|
|
8
8
|
|
|
9
9
|
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
|
|
10
10
|
|
|
11
|
-
- `==================== START: folder
|
|
12
|
-
- `==================== END: folder
|
|
11
|
+
- `==================== START: .bmad-core/folder/filename.md ====================`
|
|
12
|
+
- `==================== END: .bmad-core/folder/filename.md ====================`
|
|
13
13
|
|
|
14
14
|
When you need to reference a resource mentioned in your instructions:
|
|
15
15
|
|
|
16
16
|
- Look for the corresponding START/END tags
|
|
17
|
-
- The format is always
|
|
18
|
-
- If a section is specified (e.g., `tasks
|
|
17
|
+
- The format is always the full path with dot prefix (e.g., `.bmad-core/personas/analyst.md`, `.bmad-core/tasks/create-story.md`)
|
|
18
|
+
- If a section is specified (e.g., `{root}/tasks/create-story.md#section-name`), navigate to that section within the file
|
|
19
19
|
|
|
20
20
|
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
|
|
21
21
|
|
|
@@ -29,8 +29,8 @@ dependencies:
|
|
|
29
29
|
|
|
30
30
|
These references map directly to bundle sections:
|
|
31
31
|
|
|
32
|
-
- `utils: template-format` → Look for `==================== START: utils
|
|
33
|
-
- `tasks: create-story` → Look for `==================== START: tasks
|
|
32
|
+
- `utils: template-format` → Look for `==================== START: .bmad-core/utils/template-format.md ====================`
|
|
33
|
+
- `tasks: create-story` → Look for `==================== START: .bmad-core/tasks/create-story.md ====================`
|
|
34
34
|
|
|
35
35
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
|
36
36
|
|
|
@@ -38,7 +38,8 @@ These references map directly to bundle sections:
|
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
|
|
42
|
+
==================== START: .bmad-core/agents/bmad-orchestrator.md ====================
|
|
42
43
|
# bmad-orchestrator
|
|
43
44
|
|
|
44
45
|
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
@@ -69,7 +70,7 @@ startup:
|
|
|
69
70
|
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
|
70
71
|
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
|
71
72
|
- Mention *help shows all available commands and options
|
|
72
|
-
- Check for active workflow plan using utils
|
|
73
|
+
- Check for active workflow plan using .bmad-core/utils/plan-management.md
|
|
73
74
|
- 'If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details.'
|
|
74
75
|
- 'If plan exists: Suggest next action based on plan progress'
|
|
75
76
|
- Assess user goal against available agents and workflows in this bundle
|
|
@@ -175,9 +176,9 @@ dependencies:
|
|
|
175
176
|
- workflow-management
|
|
176
177
|
- template-format
|
|
177
178
|
```
|
|
178
|
-
==================== END: agents
|
|
179
|
+
==================== END: .bmad-core/agents/bmad-orchestrator.md ====================
|
|
179
180
|
|
|
180
|
-
==================== START: tasks
|
|
181
|
+
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
|
|
181
182
|
# Advanced Elicitation Task
|
|
182
183
|
|
|
183
184
|
## Purpose
|
|
@@ -185,94 +186,119 @@ dependencies:
|
|
|
185
186
|
- Provide optional reflective and brainstorming actions to enhance content quality
|
|
186
187
|
- Enable deeper exploration of ideas through structured elicitation techniques
|
|
187
188
|
- Support iterative refinement through multiple analytical perspectives
|
|
189
|
+
- Usable during template-driven document creation or any chat conversation
|
|
188
190
|
|
|
189
|
-
##
|
|
191
|
+
## Usage Scenarios
|
|
190
192
|
|
|
191
|
-
### 1
|
|
193
|
+
### Scenario 1: Template Document Creation
|
|
192
194
|
|
|
193
|
-
|
|
195
|
+
After outputting a section during document creation:
|
|
194
196
|
|
|
195
|
-
1.
|
|
197
|
+
1. **Section Review**: Ask user to review the drafted section
|
|
198
|
+
2. **Offer Elicitation**: Present 9 carefully selected elicitation methods
|
|
199
|
+
3. **Simple Selection**: User types a number (0-8) to engage method, or 9 to proceed
|
|
200
|
+
4. **Execute & Loop**: Apply selected method, then re-offer choices until user proceeds
|
|
196
201
|
|
|
197
|
-
|
|
202
|
+
### Scenario 2: General Chat Elicitation
|
|
198
203
|
|
|
199
|
-
|
|
204
|
+
User can request advanced elicitation on any agent output:
|
|
200
205
|
|
|
201
|
-
|
|
202
|
-
|
|
206
|
+
- User says "do advanced elicitation" or similar
|
|
207
|
+
- Agent selects 9 relevant methods for the context
|
|
208
|
+
- Same simple 0-9 selection process
|
|
203
209
|
|
|
204
|
-
|
|
210
|
+
## Task Instructions
|
|
205
211
|
|
|
206
|
-
###
|
|
212
|
+
### 1. Intelligent Method Selection
|
|
207
213
|
|
|
208
|
-
|
|
214
|
+
**Context Analysis**: Before presenting options, analyze:
|
|
209
215
|
|
|
210
|
-
**
|
|
216
|
+
- **Content Type**: Technical specs, user stories, architecture, requirements, etc.
|
|
217
|
+
- **Complexity Level**: Simple, moderate, or complex content
|
|
218
|
+
- **Stakeholder Needs**: Who will use this information
|
|
219
|
+
- **Risk Level**: High-impact decisions vs routine items
|
|
220
|
+
- **Creative Potential**: Opportunities for innovation or alternatives
|
|
211
221
|
|
|
212
|
-
|
|
213
|
-
**Advanced Reflective, Elicitation & Brainstorming Actions**
|
|
214
|
-
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
|
215
|
-
|
|
216
|
-
0. Expand or Contract for Audience
|
|
217
|
-
1. Explain Reasoning (CoT Step-by-Step)
|
|
218
|
-
2. Critique and Refine
|
|
219
|
-
3. Analyze Logical Flow and Dependencies
|
|
220
|
-
4. Assess Alignment with Overall Goals
|
|
221
|
-
5. Identify Potential Risks and Unforeseen Issues
|
|
222
|
-
6. Challenge from Critical Perspective (Self or Other Persona)
|
|
223
|
-
7. Explore Diverse Alternatives (ToT-Inspired)
|
|
224
|
-
8. Hindsight is 20/20: The 'If Only...' Reflection
|
|
225
|
-
9. Proceed / No Further Actions
|
|
226
|
-
```
|
|
222
|
+
**Method Selection Strategy**:
|
|
227
223
|
|
|
228
|
-
|
|
224
|
+
1. **Always Include Core Methods** (choose 3-4):
|
|
225
|
+
- Expand or Contract for Audience
|
|
226
|
+
- Critique and Refine
|
|
227
|
+
- Identify Potential Risks
|
|
228
|
+
- Assess Alignment with Goals
|
|
229
229
|
|
|
230
|
-
**
|
|
230
|
+
2. **Context-Specific Methods** (choose 4-5):
|
|
231
|
+
- **Technical Content**: Tree of Thoughts, ReWOO, Meta-Prompting
|
|
232
|
+
- **User-Facing Content**: Agile Team Perspective, Stakeholder Roundtable
|
|
233
|
+
- **Creative Content**: Innovation Tournament, Escape Room Challenge
|
|
234
|
+
- **Strategic Content**: Red Team vs Blue Team, Hindsight Reflection
|
|
231
235
|
|
|
232
|
-
|
|
233
|
-
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
|
|
234
|
-
- Any internal template markup
|
|
236
|
+
3. **Always Include**: "Proceed / No Further Actions" as option 9
|
|
235
237
|
|
|
236
|
-
|
|
238
|
+
### 2. Section Context and Review
|
|
237
239
|
|
|
238
|
-
|
|
239
|
-
- Ask if they want to select another action or proceed with option 9 once complete
|
|
240
|
-
- Continue until user selects option 9 or indicates completion
|
|
240
|
+
When invoked after outputting a section:
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
1. **Provide Context Summary**: Give a brief 1-2 sentence summary of what the user should look for in the section just presented
|
|
243
243
|
|
|
244
|
-
|
|
245
|
-
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
|
|
244
|
+
2. **Explain Visual Elements**: If the section contains diagrams, explain them briefly before offering elicitation options
|
|
246
245
|
|
|
247
|
-
|
|
248
|
-
|
|
246
|
+
3. **Clarify Scope Options**: If the section contains multiple distinct items, inform the user they can apply elicitation actions to:
|
|
247
|
+
- The entire section as a whole
|
|
248
|
+
- Individual items within the section (specify which item when selecting an action)
|
|
249
249
|
|
|
250
|
-
|
|
251
|
-
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
|
|
250
|
+
### 3. Present Elicitation Options
|
|
252
251
|
|
|
253
|
-
|
|
254
|
-
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
|
|
252
|
+
**Review Request Process:**
|
|
255
253
|
|
|
256
|
-
|
|
257
|
-
|
|
254
|
+
- Ask the user to review the drafted section
|
|
255
|
+
- In the SAME message, inform them they can suggest direct changes OR select an elicitation method
|
|
256
|
+
- Present 9 intelligently selected methods (0-8) plus "Proceed" (9)
|
|
257
|
+
- Keep descriptions short - just the method name
|
|
258
|
+
- Await simple numeric selection
|
|
258
259
|
|
|
259
|
-
|
|
260
|
-
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
|
|
260
|
+
**Action List Presentation Format:**
|
|
261
261
|
|
|
262
|
-
|
|
263
|
-
|
|
262
|
+
```text
|
|
263
|
+
**Advanced Elicitation Options**
|
|
264
|
+
Choose a number (0-8) or 9 to proceed:
|
|
265
|
+
|
|
266
|
+
0. [Method Name]
|
|
267
|
+
1. [Method Name]
|
|
268
|
+
2. [Method Name]
|
|
269
|
+
3. [Method Name]
|
|
270
|
+
4. [Method Name]
|
|
271
|
+
5. [Method Name]
|
|
272
|
+
6. [Method Name]
|
|
273
|
+
7. [Method Name]
|
|
274
|
+
8. [Method Name]
|
|
275
|
+
9. Proceed / No Further Actions
|
|
276
|
+
```
|
|
264
277
|
|
|
265
|
-
|
|
266
|
-
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
|
|
278
|
+
**Response Handling:**
|
|
267
279
|
|
|
268
|
-
8
|
|
269
|
-
|
|
280
|
+
- **Numbers 0-8**: Execute the selected method, then re-offer the choice
|
|
281
|
+
- **Number 9**: Proceed to next section or continue conversation
|
|
282
|
+
- **Direct Feedback**: Apply user's suggested changes and continue
|
|
270
283
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
284
|
+
### 4. Method Execution Framework
|
|
285
|
+
|
|
286
|
+
**Execution Process:**
|
|
287
|
+
|
|
288
|
+
1. **Retrieve Method**: Access the specific elicitation method from the elicitation-methods data file
|
|
289
|
+
2. **Apply Context**: Execute the method from your current role's perspective
|
|
290
|
+
3. **Provide Results**: Deliver insights, critiques, or alternatives relevant to the content
|
|
291
|
+
4. **Re-offer Choice**: Present the same 9 options again until user selects 9 or gives direct feedback
|
|
274
292
|
|
|
275
|
-
|
|
293
|
+
**Execution Guidelines:**
|
|
294
|
+
|
|
295
|
+
- **Be Concise**: Focus on actionable insights, not lengthy explanations
|
|
296
|
+
- **Stay Relevant**: Tie all elicitation back to the specific content being analyzed
|
|
297
|
+
- **Identify Personas**: For multi-persona methods, clearly identify which viewpoint is speaking
|
|
298
|
+
- **Maintain Flow**: Keep the process moving efficiently
|
|
299
|
+
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
|
|
300
|
+
|
|
301
|
+
==================== START: .bmad-core/tasks/create-doc.md ====================
|
|
276
302
|
# Create Document from Template Task
|
|
277
303
|
|
|
278
304
|
## Purpose
|
|
@@ -292,7 +318,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
292
318
|
|
|
293
319
|
[[LLM: Check if plan tracking is enabled in core-config.yaml]]
|
|
294
320
|
|
|
295
|
-
- If `workflow.trackProgress: true`, check for active plan using utils
|
|
321
|
+
- If `workflow.trackProgress: true`, check for active plan using .bmad-core/utils/plan-management.md
|
|
296
322
|
- If plan exists and this document creation is part of the plan:
|
|
297
323
|
- Verify this is the expected next step
|
|
298
324
|
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
|
@@ -301,7 +327,7 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
301
327
|
|
|
302
328
|
### 1. Identify Template
|
|
303
329
|
|
|
304
|
-
- Load from `
|
|
330
|
+
- Load from `.bmad-core/templates/*.md` or `.bmad-core/templates directory`
|
|
305
331
|
- Agent-specific templates are listed in agent's dependencies
|
|
306
332
|
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
|
307
333
|
|
|
@@ -319,14 +345,14 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
319
345
|
|
|
320
346
|
### 4. Key Execution Patterns
|
|
321
347
|
|
|
322
|
-
**When you see:** `[[LLM: Draft X and immediately execute tasks
|
|
348
|
+
**When you see:** `[[LLM: Draft X and immediately execute .bmad-core/tasks/advanced-elicitation.md]]`
|
|
323
349
|
|
|
324
350
|
- Draft the content
|
|
325
351
|
- Present it to user
|
|
326
352
|
- IMMEDIATELY execute the task
|
|
327
353
|
- Wait for completion before continuing
|
|
328
354
|
|
|
329
|
-
**When you see:** `[[LLM: After section completion, apply tasks
|
|
355
|
+
**When you see:** `[[LLM: After section completion, apply .bmad-core/tasks/Y.md]]`
|
|
330
356
|
|
|
331
357
|
- Finish the section
|
|
332
358
|
- STOP and execute the task
|
|
@@ -364,9 +390,9 @@ Generate documents from templates by EXECUTING (not just reading) embedded instr
|
|
|
364
390
|
## Remember
|
|
365
391
|
|
|
366
392
|
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
|
367
|
-
==================== END: tasks
|
|
393
|
+
==================== END: .bmad-core/tasks/create-doc.md ====================
|
|
368
394
|
|
|
369
|
-
==================== START: tasks
|
|
395
|
+
==================== START: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
370
396
|
# Create Workflow Plan Task
|
|
371
397
|
|
|
372
398
|
## Purpose
|
|
@@ -656,9 +682,9 @@ BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack
|
|
|
656
682
|
|
|
657
683
|
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
|
658
684
|
```
|
|
659
|
-
==================== END: tasks
|
|
685
|
+
==================== END: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
660
686
|
|
|
661
|
-
==================== START: tasks
|
|
687
|
+
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
662
688
|
# KB Mode Interaction Task
|
|
663
689
|
|
|
664
690
|
## Purpose
|
|
@@ -729,9 +755,9 @@ Or ask me about anything else related to BMad-Method!
|
|
|
729
755
|
**User**: Tell me about workflows
|
|
730
756
|
|
|
731
757
|
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
|
732
|
-
==================== END: tasks
|
|
758
|
+
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
733
759
|
|
|
734
|
-
==================== START: tasks
|
|
760
|
+
==================== START: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
735
761
|
# Update Workflow Plan Task
|
|
736
762
|
|
|
737
763
|
## Purpose
|
|
@@ -980,9 +1006,9 @@ The update is successful when:
|
|
|
980
1006
|
- Consider creating backup before major updates
|
|
981
1007
|
- Updates should enhance, not complicate, the workflow experience
|
|
982
1008
|
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
|
983
|
-
==================== END: tasks
|
|
1009
|
+
==================== END: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
984
1010
|
|
|
985
|
-
==================== START: data
|
|
1011
|
+
==================== START: .bmad-core/data/bmad-kb.md ====================
|
|
986
1012
|
# BMad Knowledge Base
|
|
987
1013
|
|
|
988
1014
|
## Overview
|
|
@@ -1018,13 +1044,15 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
1018
1044
|
|
|
1019
1045
|
### The Two-Phase Approach
|
|
1020
1046
|
|
|
1021
|
-
|
|
1047
|
+
#### Phase 1: Planning (Web UI - Cost Effective)
|
|
1048
|
+
|
|
1022
1049
|
- Use large context windows (Gemini's 1M tokens)
|
|
1023
1050
|
- Generate comprehensive documents (PRD, Architecture)
|
|
1024
1051
|
- Leverage multiple agents for brainstorming
|
|
1025
1052
|
- Create once, use throughout development
|
|
1026
1053
|
|
|
1027
|
-
|
|
1054
|
+
#### Phase 2: Development (IDE - Implementation)
|
|
1055
|
+
|
|
1028
1056
|
- Shard documents into manageable pieces
|
|
1029
1057
|
- Execute focused SM → Dev cycles
|
|
1030
1058
|
- One story at a time, sequential progress
|
|
@@ -1054,6 +1082,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
1054
1082
|
### Quick Start Options
|
|
1055
1083
|
|
|
1056
1084
|
#### Option 1: Web UI
|
|
1085
|
+
|
|
1057
1086
|
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
|
|
1058
1087
|
|
|
1059
1088
|
1. Navigate to `dist/teams/`
|
|
@@ -1063,6 +1092,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
1063
1092
|
5. Type `/help` to see available commands
|
|
1064
1093
|
|
|
1065
1094
|
#### Option 2: IDE Integration
|
|
1095
|
+
|
|
1066
1096
|
**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users
|
|
1067
1097
|
|
|
1068
1098
|
```bash
|
|
@@ -1071,6 +1101,7 @@ npx bmad-method install
|
|
|
1071
1101
|
```
|
|
1072
1102
|
|
|
1073
1103
|
**Installation Steps**:
|
|
1104
|
+
|
|
1074
1105
|
- Choose "Complete installation"
|
|
1075
1106
|
- Select your IDE from supported options:
|
|
1076
1107
|
- **Cursor**: Native AI integration
|
|
@@ -1079,11 +1110,12 @@ npx bmad-method install
|
|
|
1079
1110
|
- **Trae**: Built-in AI capabilities
|
|
1080
1111
|
- **Cline**: VS Code extension with AI features
|
|
1081
1112
|
- **Roo Code**: Web-based IDE with agent support
|
|
1082
|
-
- **
|
|
1113
|
+
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
|
1083
1114
|
|
|
1084
1115
|
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
|
1085
1116
|
|
|
1086
1117
|
**Verify Installation**:
|
|
1118
|
+
|
|
1087
1119
|
- `.bmad-core/` folder created with all agents
|
|
1088
1120
|
- IDE-specific integration files created
|
|
1089
1121
|
- All agent commands/rules/modes available
|
|
@@ -1093,12 +1125,14 @@ npx bmad-method install
|
|
|
1093
1125
|
### Environment Selection Guide
|
|
1094
1126
|
|
|
1095
1127
|
**Use Web UI for**:
|
|
1128
|
+
|
|
1096
1129
|
- Initial planning and documentation (PRD, architecture)
|
|
1097
1130
|
- Cost-effective document creation (especially with Gemini)
|
|
1098
1131
|
- Brainstorming and analysis phases
|
|
1099
1132
|
- Multi-agent consultation and planning
|
|
1100
1133
|
|
|
1101
1134
|
**Use IDE for**:
|
|
1135
|
+
|
|
1102
1136
|
- Active development and coding
|
|
1103
1137
|
- File operations and project integration
|
|
1104
1138
|
- Document sharding and story management
|
|
@@ -1111,35 +1145,41 @@ npx bmad-method install
|
|
|
1111
1145
|
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
|
1112
1146
|
|
|
1113
1147
|
**Pros of IDE-Only**:
|
|
1148
|
+
|
|
1114
1149
|
- Single environment workflow
|
|
1115
1150
|
- Direct file operations from start
|
|
1116
1151
|
- No copy/paste between environments
|
|
1117
1152
|
- Immediate project integration
|
|
1118
1153
|
|
|
1119
1154
|
**Cons of IDE-Only**:
|
|
1155
|
+
|
|
1120
1156
|
- Higher token costs for large document creation
|
|
1121
1157
|
- Smaller context windows (varies by IDE/model)
|
|
1122
1158
|
- May hit limits during planning phases
|
|
1123
1159
|
- Less cost-effective for brainstorming
|
|
1124
1160
|
|
|
1125
1161
|
**Using Web Agents in IDE**:
|
|
1162
|
+
|
|
1126
1163
|
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
|
1127
1164
|
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
|
1128
1165
|
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
|
1129
1166
|
|
|
1130
1167
|
**About bmad-master and bmad-orchestrator**:
|
|
1168
|
+
|
|
1131
1169
|
- **bmad-master**: CAN do any task without switching agents, BUT...
|
|
1132
1170
|
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
|
1133
1171
|
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
|
1134
1172
|
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
|
1135
1173
|
|
|
1136
1174
|
**CRITICAL RULE for Development**:
|
|
1175
|
+
|
|
1137
1176
|
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
|
1138
1177
|
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
|
1139
1178
|
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
|
1140
1179
|
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
|
1141
1180
|
|
|
1142
1181
|
**Best Practice for IDE-Only**:
|
|
1182
|
+
|
|
1143
1183
|
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
|
1144
1184
|
2. Create documents directly in project
|
|
1145
1185
|
3. Shard immediately after creation
|
|
@@ -1163,17 +1203,20 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|
|
1163
1203
|
### Key Configuration Areas
|
|
1164
1204
|
|
|
1165
1205
|
#### PRD Configuration
|
|
1206
|
+
|
|
1166
1207
|
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
|
1167
1208
|
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
|
1168
1209
|
- **prdShardedLocation**: Where to find sharded epic files
|
|
1169
1210
|
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
|
1170
1211
|
|
|
1171
1212
|
#### Architecture Configuration
|
|
1213
|
+
|
|
1172
1214
|
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
|
1173
1215
|
- **architectureSharded**: Whether architecture is split into components
|
|
1174
1216
|
- **architectureShardedLocation**: Where sharded architecture files live
|
|
1175
1217
|
|
|
1176
1218
|
#### Developer Files
|
|
1219
|
+
|
|
1177
1220
|
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
|
1178
1221
|
- **devDebugLog**: Where dev agent logs repeated failures
|
|
1179
1222
|
- **agentCoreDump**: Export location for chat conversations
|
|
@@ -1188,6 +1231,7 @@ This configuration file acts as a map for BMad agents, telling them exactly wher
|
|
|
1188
1231
|
### Common Configurations
|
|
1189
1232
|
|
|
1190
1233
|
**Legacy V3 Project**:
|
|
1234
|
+
|
|
1191
1235
|
```yaml
|
|
1192
1236
|
prdVersion: v3
|
|
1193
1237
|
prdSharded: false
|
|
@@ -1196,6 +1240,7 @@ architectureSharded: false
|
|
|
1196
1240
|
```
|
|
1197
1241
|
|
|
1198
1242
|
**V4 Optimized Project**:
|
|
1243
|
+
|
|
1199
1244
|
```yaml
|
|
1200
1245
|
prdVersion: v4
|
|
1201
1246
|
prdSharded: true
|
|
@@ -1261,18 +1306,21 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1261
1306
|
#### IDE-Specific Syntax
|
|
1262
1307
|
|
|
1263
1308
|
**Agent Loading by IDE**:
|
|
1309
|
+
|
|
1264
1310
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
1265
1311
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
1266
1312
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
1267
1313
|
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
|
1268
1314
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
1269
|
-
- **
|
|
1315
|
+
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
1270
1316
|
|
|
1271
1317
|
**Chat Management Guidelines**:
|
|
1318
|
+
|
|
1272
1319
|
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
|
1273
1320
|
- **Roo Code**: Switch modes within the same conversation
|
|
1274
1321
|
|
|
1275
1322
|
**Common Task Commands**:
|
|
1323
|
+
|
|
1276
1324
|
- `*help` - Show available commands
|
|
1277
1325
|
- `*status` - Show current context/progress
|
|
1278
1326
|
- `*exit` - Exit the agent mode
|
|
@@ -1281,6 +1329,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1281
1329
|
- `*create` - Run create-next-story task (SM agent)
|
|
1282
1330
|
|
|
1283
1331
|
**In Web UI**:
|
|
1332
|
+
|
|
1284
1333
|
```text
|
|
1285
1334
|
/pm create-doc prd
|
|
1286
1335
|
/architect review system design
|
|
@@ -1294,16 +1343,19 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1294
1343
|
### Pre-Built Teams
|
|
1295
1344
|
|
|
1296
1345
|
#### Team All
|
|
1346
|
+
|
|
1297
1347
|
- **Includes**: All 10 agents + orchestrator
|
|
1298
1348
|
- **Use Case**: Complete projects requiring all roles
|
|
1299
1349
|
- **Bundle**: `team-all.txt`
|
|
1300
1350
|
|
|
1301
1351
|
#### Team Fullstack
|
|
1352
|
+
|
|
1302
1353
|
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
|
1303
1354
|
- **Use Case**: End-to-end web/mobile development
|
|
1304
1355
|
- **Bundle**: `team-fullstack.txt`
|
|
1305
1356
|
|
|
1306
1357
|
#### Team No-UI
|
|
1358
|
+
|
|
1307
1359
|
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
|
1308
1360
|
- **Use Case**: Backend services, APIs, system development
|
|
1309
1361
|
- **Bundle**: `team-no-ui.txt`
|
|
@@ -1317,22 +1369,26 @@ The BMad-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1317
1369
|
### Key Architectural Components
|
|
1318
1370
|
|
|
1319
1371
|
#### 1. Agents (`bmad-core/agents/`)
|
|
1372
|
+
|
|
1320
1373
|
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
|
1321
1374
|
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
|
1322
1375
|
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
|
1323
1376
|
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
|
1324
1377
|
|
|
1325
1378
|
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
1379
|
+
|
|
1326
1380
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
1327
1381
|
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
1328
1382
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
1329
1383
|
|
|
1330
1384
|
#### 3. Workflows (`bmad-core/workflows/`)
|
|
1385
|
+
|
|
1331
1386
|
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
|
1332
1387
|
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
|
1333
1388
|
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
|
|
1334
1389
|
|
|
1335
1390
|
#### 4. Reusable Resources
|
|
1391
|
+
|
|
1336
1392
|
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
|
1337
1393
|
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
|
1338
1394
|
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
|
@@ -1372,6 +1428,7 @@ BMad employs a sophisticated template system with three key components:
|
|
|
1372
1428
|
### Technical Preferences Integration
|
|
1373
1429
|
|
|
1374
1430
|
The `technical-preferences.md` file serves as a persistent technical profile that:
|
|
1431
|
+
|
|
1375
1432
|
- Ensures consistency across all agents and projects
|
|
1376
1433
|
- Eliminates repetitive technology specification
|
|
1377
1434
|
- Provides personalized recommendations aligned with user preferences
|
|
@@ -1380,6 +1437,7 @@ The `technical-preferences.md` file serves as a persistent technical profile tha
|
|
|
1380
1437
|
### Build and Delivery Process
|
|
1381
1438
|
|
|
1382
1439
|
The `web-builder.js` tool creates web-ready bundles by:
|
|
1440
|
+
|
|
1383
1441
|
1. Reading agent or team definition files
|
|
1384
1442
|
2. Recursively resolving all dependencies
|
|
1385
1443
|
3. Concatenating content into single text files with clear separators
|
|
@@ -1394,11 +1452,13 @@ This architecture enables seamless operation across environments while maintaini
|
|
|
1394
1452
|
**Ideal for cost efficiency with Gemini's massive context:**
|
|
1395
1453
|
|
|
1396
1454
|
**For Brownfield Projects - Start Here!**:
|
|
1455
|
+
|
|
1397
1456
|
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
|
1398
1457
|
2. **Document existing system**: `/analyst` → `*document-project`
|
|
1399
1458
|
3. **Creates comprehensive docs** from entire codebase analysis
|
|
1400
1459
|
|
|
1401
1460
|
**For All Projects**:
|
|
1461
|
+
|
|
1402
1462
|
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
|
1403
1463
|
2. **Project Brief**: Create foundation document (Analyst or user)
|
|
1404
1464
|
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
|
@@ -1409,12 +1469,14 @@ This architecture enables seamless operation across environments while maintaini
|
|
|
1409
1469
|
#### Example Planning Prompts
|
|
1410
1470
|
|
|
1411
1471
|
**For PRD Creation**:
|
|
1472
|
+
|
|
1412
1473
|
```text
|
|
1413
1474
|
"I want to build a [type] application that [core purpose].
|
|
1414
1475
|
Help me brainstorm features and create a comprehensive PRD."
|
|
1415
1476
|
```
|
|
1416
1477
|
|
|
1417
1478
|
**For Architecture Design**:
|
|
1479
|
+
|
|
1418
1480
|
```text
|
|
1419
1481
|
"Based on this PRD, design a scalable technical architecture
|
|
1420
1482
|
that can handle [specific requirements]."
|
|
@@ -1432,7 +1494,7 @@ that can handle [specific requirements]."
|
|
|
1432
1494
|
|
|
1433
1495
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
1434
1496
|
|
|
1435
|
-
1. **Document Sharding** (CRITICAL STEP):
|
|
1497
|
+
1. **Document Sharding** (CRITICAL STEP):
|
|
1436
1498
|
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
|
1437
1499
|
- Two methods to shard:
|
|
1438
1500
|
a) **Manual**: Drag `shard-doc` task + document file into chat
|
|
@@ -1446,32 +1508,33 @@ that can handle [specific requirements]."
|
|
|
1446
1508
|
- Source tree document and coding standards for dev agent reference
|
|
1447
1509
|
- Sharded docs for SM agent story creation
|
|
1448
1510
|
|
|
1449
|
-
|
|
1511
|
+
Resulting Folder Structure:
|
|
1512
|
+
|
|
1450
1513
|
- `docs/prd/` - Broken down PRD sections
|
|
1451
1514
|
- `docs/architecture/` - Broken down architecture sections
|
|
1452
1515
|
- `docs/stories/` - Generated user stories
|
|
1453
1516
|
|
|
1454
|
-
|
|
1517
|
+
1. **Development Cycle** (Sequential, one story at a time):
|
|
1455
1518
|
|
|
1456
1519
|
**CRITICAL CONTEXT MANAGEMENT**:
|
|
1457
1520
|
- **Context windows matter!** Always use fresh, clean context windows
|
|
1458
1521
|
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
|
1459
1522
|
- **ALWAYS start new chat between SM, Dev, and QA work**
|
|
1460
1523
|
|
|
1461
|
-
**Step 1 - Story Creation**:
|
|
1524
|
+
**Step 1 - Story Creation**:
|
|
1462
1525
|
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
|
1463
1526
|
- SM executes create-next-story task
|
|
1464
1527
|
- Review generated story in `docs/stories/`
|
|
1465
1528
|
- Update status from "Draft" to "Approved"
|
|
1466
|
-
|
|
1467
|
-
**Step 2 - Story Implementation**:
|
|
1529
|
+
|
|
1530
|
+
**Step 2 - Story Implementation**:
|
|
1468
1531
|
- **NEW CLEAN CHAT** → `@dev`
|
|
1469
1532
|
- Agent asks which story to implement
|
|
1470
1533
|
- Include story file content to save dev agent lookup time
|
|
1471
1534
|
- Dev follows tasks/subtasks, marking completion
|
|
1472
1535
|
- Dev maintains File List of all changes
|
|
1473
1536
|
- Dev marks story as "Review" when complete with all tests passing
|
|
1474
|
-
|
|
1537
|
+
|
|
1475
1538
|
**Step 3 - Senior QA Review**:
|
|
1476
1539
|
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
|
1477
1540
|
- QA performs senior developer code review
|
|
@@ -1479,7 +1542,7 @@ that can handle [specific requirements]."
|
|
|
1479
1542
|
- QA appends results to story's QA Results section
|
|
1480
1543
|
- If approved: Status → "Done"
|
|
1481
1544
|
- If changes needed: Status stays "Review" with unchecked items for dev
|
|
1482
|
-
|
|
1545
|
+
|
|
1483
1546
|
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
|
1484
1547
|
|
|
1485
1548
|
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
|
@@ -1487,6 +1550,7 @@ that can handle [specific requirements]."
|
|
|
1487
1550
|
### Status Tracking Workflow
|
|
1488
1551
|
|
|
1489
1552
|
Stories progress through defined statuses:
|
|
1553
|
+
|
|
1490
1554
|
- **Draft** → **Approved** → **InProgress** → **Done**
|
|
1491
1555
|
|
|
1492
1556
|
Each status change requires user verification and approval before proceeding.
|
|
@@ -1494,6 +1558,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1494
1558
|
### Workflow Types
|
|
1495
1559
|
|
|
1496
1560
|
#### Greenfield Development
|
|
1561
|
+
|
|
1497
1562
|
- Business analysis and market research
|
|
1498
1563
|
- Product requirements and feature definition
|
|
1499
1564
|
- System architecture and design
|
|
@@ -1507,6 +1572,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1507
1572
|
**Complete Brownfield Workflow Options**:
|
|
1508
1573
|
|
|
1509
1574
|
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
|
1575
|
+
|
|
1510
1576
|
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
|
1511
1577
|
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
|
1512
1578
|
3. **Focused documentation**: `@analyst` → `*document-project`
|
|
@@ -1517,18 +1583,19 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1517
1583
|
- Avoids bloating docs with unused code
|
|
1518
1584
|
|
|
1519
1585
|
**Option 2: Document-First (Good for Smaller Projects)**:
|
|
1586
|
+
|
|
1520
1587
|
1. **Upload project to Gemini Web**
|
|
1521
1588
|
2. **Document everything**: `@analyst` → `*document-project`
|
|
1522
1589
|
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
|
1523
1590
|
- More thorough but can create excessive documentation
|
|
1524
1591
|
|
|
1525
|
-
|
|
1592
|
+
4. **Requirements Gathering**:
|
|
1526
1593
|
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
|
1527
1594
|
- **Analyzes**: Existing system, constraints, integration points
|
|
1528
1595
|
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
|
1529
1596
|
- **Creates**: Epic and story structure for changes
|
|
1530
1597
|
|
|
1531
|
-
|
|
1598
|
+
5. **Architecture Planning**:
|
|
1532
1599
|
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
|
1533
1600
|
- **Integration Strategy**: How new features integrate with existing system
|
|
1534
1601
|
- **Migration Planning**: Gradual rollout and backwards compatibility
|
|
@@ -1537,10 +1604,12 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1537
1604
|
**Brownfield-Specific Resources**:
|
|
1538
1605
|
|
|
1539
1606
|
**Templates**:
|
|
1607
|
+
|
|
1540
1608
|
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
|
1541
1609
|
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
|
1542
1610
|
|
|
1543
1611
|
**Tasks**:
|
|
1612
|
+
|
|
1544
1613
|
- `document-project`: Generates comprehensive documentation from existing codebase
|
|
1545
1614
|
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
|
1546
1615
|
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
|
@@ -1548,18 +1617,21 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1548
1617
|
**When to Use Each Approach**:
|
|
1549
1618
|
|
|
1550
1619
|
**Full Brownfield Workflow** (Recommended for):
|
|
1620
|
+
|
|
1551
1621
|
- Major feature additions
|
|
1552
1622
|
- System modernization
|
|
1553
1623
|
- Complex integrations
|
|
1554
1624
|
- Multiple related changes
|
|
1555
1625
|
|
|
1556
1626
|
**Quick Epic/Story Creation** (Use when):
|
|
1627
|
+
|
|
1557
1628
|
- Single, focused enhancement
|
|
1558
1629
|
- Isolated bug fixes
|
|
1559
1630
|
- Small feature additions
|
|
1560
1631
|
- Well-documented existing system
|
|
1561
1632
|
|
|
1562
1633
|
**Critical Success Factors**:
|
|
1634
|
+
|
|
1563
1635
|
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
|
1564
1636
|
2. **Context Matters**: Provide agents access to relevant code sections
|
|
1565
1637
|
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
|
@@ -1575,6 +1647,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1575
1647
|
- `docs/architecture.md` - System Architecture Document
|
|
1576
1648
|
|
|
1577
1649
|
**Why These Names Matter**:
|
|
1650
|
+
|
|
1578
1651
|
- Agents automatically reference these files during development
|
|
1579
1652
|
- Sharding tasks expect these specific filenames
|
|
1580
1653
|
- Workflow automation depends on standard naming
|
|
@@ -1593,6 +1666,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1593
1666
|
Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
1594
1667
|
|
|
1595
1668
|
**Original PRD**:
|
|
1669
|
+
|
|
1596
1670
|
```markdown
|
|
1597
1671
|
## Goals and Background Context
|
|
1598
1672
|
## Requirements
|
|
@@ -1601,6 +1675,7 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
|
1601
1675
|
```
|
|
1602
1676
|
|
|
1603
1677
|
**After Sharding**:
|
|
1678
|
+
|
|
1604
1679
|
- `docs/prd/goals-and-background-context.md`
|
|
1605
1680
|
- `docs/prd/requirements.md`
|
|
1606
1681
|
- `docs/prd/user-interface-design-goals.md`
|
|
@@ -1613,12 +1688,14 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
1613
1688
|
### Environment-Specific Usage
|
|
1614
1689
|
|
|
1615
1690
|
**Web UI Best For**:
|
|
1691
|
+
|
|
1616
1692
|
- Initial planning and documentation phases
|
|
1617
1693
|
- Cost-effective large document creation
|
|
1618
1694
|
- Agent consultation and brainstorming
|
|
1619
1695
|
- Multi-agent workflows with orchestrator
|
|
1620
1696
|
|
|
1621
1697
|
**IDE Best For**:
|
|
1698
|
+
|
|
1622
1699
|
- Active development and implementation
|
|
1623
1700
|
- File operations and project integration
|
|
1624
1701
|
- Story management and development cycles
|
|
@@ -1653,6 +1730,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
1653
1730
|
For full details, see `CONTRIBUTING.md`. Key points:
|
|
1654
1731
|
|
|
1655
1732
|
**Fork Workflow**:
|
|
1733
|
+
|
|
1656
1734
|
1. Fork the repository
|
|
1657
1735
|
2. Create feature branches
|
|
1658
1736
|
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
|
@@ -1660,12 +1738,14 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
1660
1738
|
5. One feature/fix per PR
|
|
1661
1739
|
|
|
1662
1740
|
**PR Requirements**:
|
|
1741
|
+
|
|
1663
1742
|
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
|
1664
1743
|
- Use conventional commits (feat:, fix:, docs:)
|
|
1665
1744
|
- Atomic commits - one logical change per commit
|
|
1666
1745
|
- Must align with guiding principles
|
|
1667
1746
|
|
|
1668
1747
|
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
|
1748
|
+
|
|
1669
1749
|
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
|
1670
1750
|
- **Natural Language First**: Everything in markdown, no code in core
|
|
1671
1751
|
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
|
@@ -1687,12 +1767,14 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|
|
1687
1767
|
### Available Expansion Packs
|
|
1688
1768
|
|
|
1689
1769
|
**Technical Packs**:
|
|
1770
|
+
|
|
1690
1771
|
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
|
1691
1772
|
- **Game Development**: Game designers, level designers, narrative writers
|
|
1692
1773
|
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
|
1693
1774
|
- **Data Science**: ML engineers, data scientists, visualization experts
|
|
1694
1775
|
|
|
1695
1776
|
**Non-Technical Packs**:
|
|
1777
|
+
|
|
1696
1778
|
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
|
1697
1779
|
- **Creative Writing**: Plot architects, character developers, world builders
|
|
1698
1780
|
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
|
@@ -1700,6 +1782,7 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|
|
1700
1782
|
- **Legal Support**: Contract analysts, compliance checkers
|
|
1701
1783
|
|
|
1702
1784
|
**Specialty Packs**:
|
|
1785
|
+
|
|
1703
1786
|
- **Expansion Creator**: Tools to build your own expansion packs
|
|
1704
1787
|
- **RPG Game Master**: Tabletop gaming assistance
|
|
1705
1788
|
- **Life Event Planning**: Wedding planners, event coordinators
|
|
@@ -1709,11 +1792,13 @@ Expansion packs extend BMad-Method beyond traditional software development into
|
|
|
1709
1792
|
|
|
1710
1793
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
1711
1794
|
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
|
1712
|
-
3. **Install via CLI**:
|
|
1795
|
+
3. **Install via CLI**:
|
|
1796
|
+
|
|
1713
1797
|
```bash
|
|
1714
1798
|
npx bmad-method install
|
|
1715
1799
|
# Select "Install expansion pack" option
|
|
1716
1800
|
```
|
|
1801
|
+
|
|
1717
1802
|
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
|
1718
1803
|
|
|
1719
1804
|
### Creating Custom Expansion Packs
|
|
@@ -1734,9 +1819,9 @@ Use the **expansion-creator** pack to build your own:
|
|
|
1734
1819
|
- **Documentation**: Check `docs/` folder for project-specific context
|
|
1735
1820
|
- **Community**: Discord and GitHub resources available for support
|
|
1736
1821
|
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
|
1737
|
-
==================== END: data
|
|
1822
|
+
==================== END: .bmad-core/data/bmad-kb.md ====================
|
|
1738
1823
|
|
|
1739
|
-
==================== START: utils
|
|
1824
|
+
==================== START: .bmad-core/utils/plan-management.md ====================
|
|
1740
1825
|
# Plan Management Utility
|
|
1741
1826
|
|
|
1742
1827
|
## Purpose
|
|
@@ -1747,14 +1832,10 @@ Provides utilities for agents and tasks to interact with workflow plans, check p
|
|
|
1747
1832
|
|
|
1748
1833
|
### 1. Check Plan Existence
|
|
1749
1834
|
|
|
1750
|
-
[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
|
|
1751
|
-
|
|
1752
|
-
```
|
|
1753
1835
|
Check for workflow plan:
|
|
1836
|
+
|
|
1754
1837
|
1. Look for docs/workflow-plan.md (default location)
|
|
1755
|
-
2.
|
|
1756
|
-
3. Return plan status (exists/not exists)
|
|
1757
|
-
```
|
|
1838
|
+
2. Return plan status to user (exists/not exists) - if not exists then HALT.
|
|
1758
1839
|
|
|
1759
1840
|
### 2. Parse Plan Status
|
|
1760
1841
|
|
|
@@ -1795,7 +1876,7 @@ Check for workflow plan:
|
|
|
1795
1876
|
|
|
1796
1877
|
**Warning Templates:**
|
|
1797
1878
|
|
|
1798
|
-
```
|
|
1879
|
+
```text
|
|
1799
1880
|
SEQUENCE WARNING:
|
|
1800
1881
|
The workflow plan shows you should complete "{expected_step}" next.
|
|
1801
1882
|
You're attempting to: "{requested_action}"
|
|
@@ -1829,7 +1910,7 @@ In flexible mode: Allow with confirmation
|
|
|
1829
1910
|
|
|
1830
1911
|
**For Agents (startup sequence)**:
|
|
1831
1912
|
|
|
1832
|
-
```
|
|
1913
|
+
```text
|
|
1833
1914
|
1. Check if plan exists using this utility
|
|
1834
1915
|
2. If exists:
|
|
1835
1916
|
- Parse current status
|
|
@@ -1840,7 +1921,7 @@ In flexible mode: Allow with confirmation
|
|
|
1840
1921
|
|
|
1841
1922
|
**For Tasks (pre-execution)**:
|
|
1842
1923
|
|
|
1843
|
-
```
|
|
1924
|
+
```text
|
|
1844
1925
|
1. Check if plan exists
|
|
1845
1926
|
2. If exists:
|
|
1846
1927
|
- Verify this task aligns with plan
|
|
@@ -1856,7 +1937,7 @@ In flexible mode: Allow with confirmation
|
|
|
1856
1937
|
|
|
1857
1938
|
[[LLM: Standard format for showing plan status]]
|
|
1858
1939
|
|
|
1859
|
-
```
|
|
1940
|
+
```text
|
|
1860
1941
|
📋 Workflow Plan Status
|
|
1861
1942
|
━━━━━━━━━━━━━━━━━━━━
|
|
1862
1943
|
Workflow: {workflow_name}
|
|
@@ -1909,7 +1990,7 @@ If user wants to abandon plan:
|
|
|
1909
1990
|
|
|
1910
1991
|
### Example 1: Agent Startup Check
|
|
1911
1992
|
|
|
1912
|
-
```
|
|
1993
|
+
```text
|
|
1913
1994
|
BMad Master starting...
|
|
1914
1995
|
|
|
1915
1996
|
[Check for plan]
|
|
@@ -1923,7 +2004,7 @@ Use *agent pm to switch, or *plan-status to see full progress.
|
|
|
1923
2004
|
|
|
1924
2005
|
### Example 2: Task Sequence Warning
|
|
1925
2006
|
|
|
1926
|
-
```
|
|
2007
|
+
```text
|
|
1927
2008
|
User: *task create-next-story
|
|
1928
2009
|
|
|
1929
2010
|
[Plan check triggered]
|
|
@@ -1939,7 +2020,7 @@ Would you like to:
|
|
|
1939
2020
|
|
|
1940
2021
|
### Example 3: Automatic Plan Update
|
|
1941
2022
|
|
|
1942
|
-
```
|
|
2023
|
+
```text
|
|
1943
2024
|
[After completing create-doc task for PRD]
|
|
1944
2025
|
|
|
1945
2026
|
✅ Plan Updated: Marked "Create PRD" as complete
|
|
@@ -1960,9 +2041,9 @@ Would you like to:
|
|
|
1960
2041
|
- Malformed plan: Warn but continue, treat as no plan
|
|
1961
2042
|
- Update failures: Log but don't block task completion
|
|
1962
2043
|
- Parse errors: Fallback to basic text search
|
|
1963
|
-
==================== END: utils
|
|
2044
|
+
==================== END: .bmad-core/utils/plan-management.md ====================
|
|
1964
2045
|
|
|
1965
|
-
==================== START: utils
|
|
2046
|
+
==================== START: .bmad-core/utils/workflow-management.md ====================
|
|
1966
2047
|
# Workflow Management
|
|
1967
2048
|
|
|
1968
2049
|
Enables BMad orchestrator to manage and execute team workflows.
|
|
@@ -2032,9 +2113,9 @@ Handle conditional paths by asking clarifying questions when needed.
|
|
|
2032
2113
|
## Agent Integration
|
|
2033
2114
|
|
|
2034
2115
|
Agents should be workflow-aware: know active workflow, their role, access artifacts, understand expected outputs.
|
|
2035
|
-
==================== END: utils
|
|
2116
|
+
==================== END: .bmad-core/utils/workflow-management.md ====================
|
|
2036
2117
|
|
|
2037
|
-
==================== START: utils
|
|
2118
|
+
==================== START: .bmad-core/utils/template-format.md ====================
|
|
2038
2119
|
# Template Format Conventions
|
|
2039
2120
|
|
|
2040
2121
|
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
@@ -2061,4 +2142,4 @@ Templates in the BMad method use standardized markup for AI processing. These co
|
|
|
2061
2142
|
- Template elements are for AI processing only
|
|
2062
2143
|
- Focus on faithful template execution and clean output
|
|
2063
2144
|
- All template-specific instructions are embedded within templates
|
|
2064
|
-
==================== END: utils
|
|
2145
|
+
==================== END: .bmad-core/utils/template-format.md ====================
|