bmad-method 4.31.0 → 4.33.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.
Files changed (92) hide show
  1. package/.vscode/settings.json +1 -7
  2. package/CHANGELOG.md +113 -173
  3. package/README.md +47 -0
  4. package/bmad-core/agents/analyst.md +1 -1
  5. package/bmad-core/agents/architect.md +2 -3
  6. package/bmad-core/agents/bmad-master.md +0 -1
  7. package/bmad-core/agents/bmad-orchestrator.md +9 -10
  8. package/bmad-core/agents/dev.md +1 -2
  9. package/bmad-core/agents/pm.md +3 -1
  10. package/bmad-core/agents/po.md +1 -1
  11. package/bmad-core/agents/qa.md +1 -1
  12. package/bmad-core/agents/sm.md +1 -1
  13. package/bmad-core/agents/ux-expert.md +1 -1
  14. package/bmad-core/bmad-core/user-guide.md +0 -0
  15. package/bmad-core/checklists/architect-checklist.md +0 -5
  16. package/bmad-core/checklists/pm-checklist.md +0 -5
  17. package/bmad-core/checklists/po-master-checklist.md +0 -9
  18. package/bmad-core/checklists/story-dod-checklist.md +0 -7
  19. package/bmad-core/checklists/story-draft-checklist.md +0 -3
  20. package/bmad-core/data/bmad-kb.md +5 -2
  21. package/bmad-core/data/elicitation-methods.md +20 -0
  22. package/bmad-core/enhanced-ide-development-workflow.md +43 -0
  23. package/bmad-core/tasks/create-brownfield-story.md +11 -3
  24. package/bmad-core/tasks/create-deep-research-prompt.md +0 -11
  25. package/bmad-core/tasks/document-project.md +15 -13
  26. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  27. package/bmad-core/tasks/index-docs.md +0 -6
  28. package/bmad-core/tasks/kb-mode-interaction.md +3 -3
  29. package/bmad-core/tasks/review-story.md +10 -1
  30. package/bmad-core/tasks/shard-doc.md +0 -2
  31. package/bmad-core/user-guide.md +7 -6
  32. package/bmad-core/working-in-the-brownfield.md +39 -36
  33. package/common/tasks/execute-checklist.md +0 -7
  34. package/dist/agents/analyst.txt +6 -6
  35. package/dist/agents/architect.txt +8 -3
  36. package/dist/agents/bmad-master.txt +2 -1
  37. package/dist/agents/pm.txt +9 -2
  38. package/dist/agents/po.txt +2 -318
  39. package/dist/agents/qa.txt +0 -1
  40. package/dist/agents/sm.txt +3 -3
  41. package/dist/agents/ux-expert.txt +2 -297
  42. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +6 -6
  43. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4047 -0
  44. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +1520 -185
  45. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +214 -1229
  46. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +537 -373
  47. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +6917 -2140
  48. package/dist/teams/team-all.txt +30 -25
  49. package/dist/teams/team-fullstack.txt +27 -21
  50. package/dist/teams/team-ide-minimal.txt +5 -322
  51. package/dist/teams/team-no-ui.txt +25 -16
  52. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  53. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -4
  54. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +3 -5
  55. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -1
  56. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -18
  57. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +1 -0
  58. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +80 -0
  59. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +21 -16
  60. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +25 -25
  61. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +15 -14
  62. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +391 -0
  63. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +203 -0
  64. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +1 -1
  65. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +103 -139
  66. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
  67. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +586 -68
  68. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -4
  69. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -1
  70. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +141 -0
  71. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +165 -198
  72. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -18
  73. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +200 -0
  74. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +938 -453
  75. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +3 -3
  76. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +517 -155
  77. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +12 -12
  78. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +11 -11
  79. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  80. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -3
  81. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -1
  82. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -1
  83. package/package.json +4 -1
  84. package/tools/bmad-npx-wrapper.js +5 -7
  85. package/tools/flattener/main.js +570 -0
  86. package/tools/installer/bin/bmad.js +14 -0
  87. package/tools/installer/lib/installer.js +29 -3
  88. package/tools/installer/package-lock.json +89 -89
  89. package/tools/installer/package.json +1 -1
  90. package/.husky/pre-commit +0 -2
  91. package/.prettierignore +0 -21
  92. package/.prettierrc +0 -23
@@ -128,7 +128,7 @@ Critical: For brownfield, ALWAYS include criteria about maintaining existing fun
128
128
  Standard structure:
129
129
 
130
130
  1. New functionality works as specified
131
- 2. Existing {{affected feature}} continues to work unchanged
131
+ 2. Existing {{affected feature}} continues to work unchanged
132
132
  3. Integration with {{existing system}} maintains current behavior
133
133
  4. No regression in {{related area}}
134
134
  5. Performance remains within acceptable bounds
@@ -139,16 +139,19 @@ Critical: This is where you'll need to be interactive with the user if informati
139
139
 
140
140
  Create Dev Technical Guidance section with available information:
141
141
 
142
- ```markdown
142
+ ````markdown
143
143
  ## Dev Technical Guidance
144
144
 
145
145
  ### Existing System Context
146
+
146
147
  [Extract from available documentation]
147
148
 
148
149
  ### Integration Approach
150
+
149
151
  [Based on patterns found or ask user]
150
152
 
151
153
  ### Technical Constraints
154
+
152
155
  [From documentation or user input]
153
156
 
154
157
  ### Missing Information
@@ -191,6 +194,7 @@ Example task structure for brownfield:
191
194
  - [ ] Integration test for {{integration point}}
192
195
  - [ ] Update existing tests if needed
193
196
  ```
197
+ ````
194
198
 
195
199
  ### 5. Risk Assessment and Mitigation
196
200
 
@@ -202,14 +206,17 @@ Add section for brownfield-specific risks:
202
206
  ## Risk Assessment
203
207
 
204
208
  ### Implementation Risks
209
+
205
210
  - **Primary Risk**: {{main risk to existing system}}
206
211
  - **Mitigation**: {{how to address}}
207
212
  - **Verification**: {{how to confirm safety}}
208
213
 
209
214
  ### Rollback Plan
215
+
210
216
  - {{Simple steps to undo changes if needed}}
211
217
 
212
218
  ### Safety Checks
219
+
213
220
  - [ ] Existing {{feature}} tested before changes
214
221
  - [ ] Changes can be feature-flagged or isolated
215
222
  - [ ] Rollback procedure documented
@@ -252,6 +259,7 @@ Include header noting documentation context:
252
259
  <!-- Context: Brownfield enhancement to {{existing system}} -->
253
260
 
254
261
  ## Status: Draft
262
+
255
263
  [Rest of story content...]
256
264
  ```
257
265
 
@@ -272,7 +280,7 @@ Key Integration Points Identified:
272
280
  Risks Noted:
273
281
  - {{primary risk}}
274
282
 
275
- {{If missing info}}:
283
+ {{If missing info}}:
276
284
  Note: Some technical details were unclear. The story includes exploration tasks to gather needed information during implementation.
277
285
 
278
286
  Next Steps:
@@ -21,63 +21,54 @@ CRITICAL: First, help the user select the most appropriate research focus based
21
21
  Present these numbered options to the user:
22
22
 
23
23
  1. **Product Validation Research**
24
-
25
24
  - Validate product hypotheses and market fit
26
25
  - Test assumptions about user needs and solutions
27
26
  - Assess technical and business feasibility
28
27
  - Identify risks and mitigation strategies
29
28
 
30
29
  2. **Market Opportunity Research**
31
-
32
30
  - Analyze market size and growth potential
33
31
  - Identify market segments and dynamics
34
32
  - Assess market entry strategies
35
33
  - Evaluate timing and market readiness
36
34
 
37
35
  3. **User & Customer Research**
38
-
39
36
  - Deep dive into user personas and behaviors
40
37
  - Understand jobs-to-be-done and pain points
41
38
  - Map customer journeys and touchpoints
42
39
  - Analyze willingness to pay and value perception
43
40
 
44
41
  4. **Competitive Intelligence Research**
45
-
46
42
  - Detailed competitor analysis and positioning
47
43
  - Feature and capability comparisons
48
44
  - Business model and strategy analysis
49
45
  - Identify competitive advantages and gaps
50
46
 
51
47
  5. **Technology & Innovation Research**
52
-
53
48
  - Assess technology trends and possibilities
54
49
  - Evaluate technical approaches and architectures
55
50
  - Identify emerging technologies and disruptions
56
51
  - Analyze build vs. buy vs. partner options
57
52
 
58
53
  6. **Industry & Ecosystem Research**
59
-
60
54
  - Map industry value chains and dynamics
61
55
  - Identify key players and relationships
62
56
  - Analyze regulatory and compliance factors
63
57
  - Understand partnership opportunities
64
58
 
65
59
  7. **Strategic Options Research**
66
-
67
60
  - Evaluate different strategic directions
68
61
  - Assess business model alternatives
69
62
  - Analyze go-to-market strategies
70
63
  - Consider expansion and scaling paths
71
64
 
72
65
  8. **Risk & Feasibility Research**
73
-
74
66
  - Identify and assess various risk factors
75
67
  - Evaluate implementation challenges
76
68
  - Analyze resource requirements
77
69
  - Consider regulatory and legal implications
78
70
 
79
71
  9. **Custom Research Focus**
80
-
81
72
  - User-defined research objectives
82
73
  - Specialized domain investigation
83
74
  - Cross-functional research needs
@@ -246,13 +237,11 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
246
237
  ### 5. Review and Refinement
247
238
 
248
239
  1. **Present Complete Prompt**
249
-
250
240
  - Show the full research prompt
251
241
  - Explain key elements and rationale
252
242
  - Highlight any assumptions made
253
243
 
254
244
  2. **Gather Feedback**
255
-
256
245
  - Are the objectives clear and correct?
257
246
  - Do the questions address all concerns?
258
247
  - Is the scope appropriate?
@@ -111,9 +111,9 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
111
111
 
112
112
  ### Change Log
113
113
 
114
- | Date | Version | Description | Author |
115
- |------|---------|-------------|--------|
116
- | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
114
+ | Date | Version | Description | Author |
115
+ | ------ | ------- | --------------------------- | --------- |
116
+ | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
117
117
 
118
118
  ## Quick Reference - Key Files and Entry Points
119
119
 
@@ -136,11 +136,11 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
136
136
 
137
137
  ### Actual Tech Stack (from package.json/requirements.txt)
138
138
 
139
- | Category | Technology | Version | Notes |
140
- |----------|------------|---------|--------|
141
- | Runtime | Node.js | 16.x | [Any constraints] |
142
- | Framework | Express | 4.18.2 | [Custom middleware?] |
143
- | Database | PostgreSQL | 13 | [Connection pooling setup] |
139
+ | Category | Technology | Version | Notes |
140
+ | --------- | ---------- | ------- | -------------------------- |
141
+ | Runtime | Node.js | 16.x | [Any constraints] |
142
+ | Framework | Express | 4.18.2 | [Custom middleware?] |
143
+ | Database | PostgreSQL | 13 | [Connection pooling setup] |
144
144
 
145
145
  etc...
146
146
 
@@ -179,6 +179,7 @@ project-root/
179
179
  ### Data Models
180
180
 
181
181
  Instead of duplicating, reference actual model files:
182
+
182
183
  - **User Model**: See `src/models/User.js`
183
184
  - **Order Model**: See `src/models/Order.js`
184
185
  - **Related Types**: TypeScript definitions in `src/types/`
@@ -208,10 +209,10 @@ Instead of duplicating, reference actual model files:
208
209
 
209
210
  ### External Services
210
211
 
211
- | Service | Purpose | Integration Type | Key Files |
212
- |---------|---------|------------------|-----------|
213
- | Stripe | Payments | REST API | `src/integrations/stripe/` |
214
- | SendGrid | Emails | SDK | `src/services/emailService.js` |
212
+ | Service | Purpose | Integration Type | Key Files |
213
+ | -------- | -------- | ---------------- | ------------------------------ |
214
+ | Stripe | Payments | REST API | `src/integrations/stripe/` |
215
+ | SendGrid | Emails | SDK | `src/services/emailService.js` |
215
216
 
216
217
  etc...
217
218
 
@@ -256,6 +257,7 @@ npm run test:integration # Runs integration tests (requires local DB)
256
257
  ### Files That Will Need Modification
257
258
 
258
259
  Based on the enhancement requirements, these files will be affected:
260
+
259
261
  - `src/services/userService.js` - Add new user fields
260
262
  - `src/models/User.js` - Update schema
261
263
  - `src/routes/userRoutes.js` - New endpoints
@@ -338,4 +340,4 @@ Apply the advanced elicitation task after major sections to refine based on user
338
340
  - References actual files rather than duplicating content when possible
339
341
  - Documents technical debt, workarounds, and constraints honestly
340
342
  - For brownfield projects with PRD: Provides clear enhancement impact analysis
341
- - The goal is PRACTICAL documentation for AI agents doing real work
343
+ - The goal is PRACTICAL documentation for AI agents doing real work
@@ -43,7 +43,7 @@ If user selects Option 1, present numbered list of techniques from the brainstor
43
43
  1. Apply selected technique according to data file description
44
44
  2. Keep engaging with technique until user indicates they want to:
45
45
  - Choose a different technique
46
- - Apply current ideas to a new technique
46
+ - Apply current ideas to a new technique
47
47
  - Move to convergent phase
48
48
  - End session
49
49
 
@@ -11,14 +11,12 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
11
11
  ### Required Steps
12
12
 
13
13
  1. First, locate and scan:
14
-
15
14
  - The `docs/` directory and all subdirectories
16
15
  - The existing `docs/index.md` file (create if absent)
17
16
  - All markdown (`.md`) and text (`.txt`) files in the documentation structure
18
17
  - Note the folder structure for hierarchical organization
19
18
 
20
19
  2. For the existing `docs/index.md`:
21
-
22
20
  - Parse current entries
23
21
  - Note existing file references and descriptions
24
22
  - Identify any broken links or missing files
@@ -26,7 +24,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
26
24
  - Preserve existing folder sections
27
25
 
28
26
  3. For each documentation file found:
29
-
30
27
  - Extract the title (from first heading or filename)
31
28
  - Generate a brief description by analyzing the content
32
29
  - Create a relative markdown link to the file
@@ -35,7 +32,6 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
35
32
  - If missing or outdated, prepare an update
36
33
 
37
34
  4. For any missing or non-existent files found in index:
38
-
39
35
  - Present a list of all entries that reference non-existent files
40
36
  - For each entry:
41
37
  - Show the full entry details (title, path, description)
@@ -88,7 +84,6 @@ Documents within the `another-folder/` directory:
88
84
  ### [Nested Document](./another-folder/document.md)
89
85
 
90
86
  Description of nested document.
91
-
92
87
  ```
93
88
 
94
89
  ### Index Entry Format
@@ -157,7 +152,6 @@ For each file referenced in the index but not found in the filesystem:
157
152
  ### Special Cases
158
153
 
159
154
  1. **Sharded Documents**: If a folder contains an `index.md` file, treat it as a sharded document:
160
-
161
155
  - Use the folder's `index.md` title as the section title
162
156
  - List the folder's documents as subsections
163
157
  - Note in the description that this is a multi-part document
@@ -6,7 +6,7 @@ Provide a user-friendly interface to the BMad knowledge base without overwhelmin
6
6
 
7
7
  ## Instructions
8
8
 
9
- When entering KB mode (*kb-mode), follow these steps:
9
+ When entering KB mode (\*kb-mode), follow these steps:
10
10
 
11
11
  ### 1. Welcome and Guide
12
12
 
@@ -48,12 +48,12 @@ Or ask me about anything else related to BMad-Method!
48
48
  When user is done or wants to exit KB mode:
49
49
 
50
50
  - Summarize key points discussed if helpful
51
- - Remind them they can return to KB mode anytime with *kb-mode
51
+ - Remind them they can return to KB mode anytime with \*kb-mode
52
52
  - Suggest next steps based on what was discussed
53
53
 
54
54
  ## Example Interaction
55
55
 
56
- **User**: *kb-mode
56
+ **User**: \*kb-mode
57
57
 
58
58
  **Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
59
59
 
@@ -81,25 +81,31 @@ After review and any refactoring, append your results to the story file in the Q
81
81
  ## QA Results
82
82
 
83
83
  ### Review Date: [Date]
84
+
84
85
  ### Reviewed By: Quinn (Senior Developer QA)
85
86
 
86
87
  ### Code Quality Assessment
88
+
87
89
  [Overall assessment of implementation quality]
88
90
 
89
91
  ### Refactoring Performed
92
+
90
93
  [List any refactoring you performed with explanations]
94
+
91
95
  - **File**: [filename]
92
96
  - **Change**: [what was changed]
93
97
  - **Why**: [reason for change]
94
98
  - **How**: [how it improves the code]
95
99
 
96
100
  ### Compliance Check
101
+
97
102
  - Coding Standards: [✓/✗] [notes if any]
98
103
  - Project Structure: [✓/✗] [notes if any]
99
104
  - Testing Strategy: [✓/✗] [notes if any]
100
105
  - All ACs Met: [✓/✗] [notes if any]
101
106
 
102
107
  ### Improvements Checklist
108
+
103
109
  [Check off items you handled yourself, leave unchecked for dev to address]
104
110
 
105
111
  - [x] Refactored user service for better error handling (services/user.service.ts)
@@ -109,12 +115,15 @@ After review and any refactoring, append your results to the story file in the Q
109
115
  - [ ] Update API documentation for new error codes
110
116
 
111
117
  ### Security Review
118
+
112
119
  [Any security concerns found and whether addressed]
113
120
 
114
121
  ### Performance Considerations
122
+
115
123
  [Any performance issues found and whether addressed]
116
124
 
117
125
  ### Final Status
126
+
118
127
  [✓ Approved - Ready for Done] / [✗ Changes Required - See unchecked items above]
119
128
  ```
120
129
 
@@ -142,4 +151,4 @@ After review:
142
151
 
143
152
  1. If all items are checked and approved: Update story status to "Done"
144
153
  2. If unchecked items remain: Keep status as "Review" for dev to address
145
- 3. Always provide constructive feedback and explanations for learning
154
+ 3. Always provide constructive feedback and explanations for learning
@@ -91,13 +91,11 @@ CRITICAL: Use proper parsing that understands markdown context. A ## inside a co
91
91
  For each extracted section:
92
92
 
93
93
  1. **Generate filename**: Convert the section heading to lowercase-dash-case
94
-
95
94
  - Remove special characters
96
95
  - Replace spaces with dashes
97
96
  - Example: "## Tech Stack" → `tech-stack.md`
98
97
 
99
98
  2. **Adjust heading levels**:
100
-
101
99
  - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
102
100
  - All subsection levels decrease by 1:
103
101
 
@@ -1,12 +1,12 @@
1
1
  # BMad-Method BMAd Code User Guide
2
2
 
3
- This guide will help you understand and effectively use the BMad Method for agile ai driven planning and development.
3
+ This guide will help you understand and effectively use the BMad Method for agile AI driven planning and development.
4
4
 
5
5
  ## The BMad Plan and Execute Workflow
6
6
 
7
- First, here is the full standard Greenfield Planning + Execution Workflow. Brownfield is very similar, but its suggested to understand this greenfield first, even if on a simple project before tackling a brownfield project. The BMad Method needs to be installed to the root of your new project folder. For the planning phase, you can optionally perform it with powerful web agents, potentially resulting in higher quality results at a fraction of the cost it would take to complete if providing your own API key or credits in some Agentic tools. For planning, powerful thinking models and larger context - along with working as a partner with the agents will net the best results.
7
+ First, here is the full standard Greenfield Planning + Execution Workflow. Brownfield is very similar, but it's suggested to understand this greenfield first, even if on a simple project before tackling a brownfield project. The BMad Method needs to be installed to the root of your new project folder. For the planning phase, you can optionally perform it with powerful web agents, potentially resulting in higher quality results at a fraction of the cost it would take to complete if providing your own API key or credits in some Agentic tools. For planning, powerful thinking models and larger context - along with working as a partner with the agents will net the best results.
8
8
 
9
- If you are going to use the BMad Method with a Brownfield project (an existing project), review [Working in the Brownfield](./working-in-the-brownfield.md)
9
+ If you are going to use the BMad Method with a Brownfield project (an existing project), review **[Working in the Brownfield](./working-in-the-brownfield.md)**.
10
10
 
11
11
  If you do not see the diagrams that following rendering, you can install Markdown All in One along with the Markdown Preview Mermaid Support plugins to VSCode (or one of the forked clones). With these plugin's, if you right click on the tab when open, there should be a Open Preview option, or check the IDE documentation.
12
12
 
@@ -132,7 +132,7 @@ graph TD
132
132
  If you want to do the planning in the Web with Claude (Sonnet 4 or Opus), Gemini Gem (2.5 Pro), or Custom GPT's:
133
133
 
134
134
  1. Navigate to `dist/teams/`
135
- 2. Copy `team-fullstack.txt` content
135
+ 2. Copy `team-fullstack.txt`
136
136
  3. Create new Gemini Gem or CustomGPT
137
137
  4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
138
138
  5. Type `/help` to see available commands
@@ -152,7 +152,7 @@ There are two bmad agents - in the future they will be consolidated into the sin
152
152
 
153
153
  This agent can do any task or command that all other agents can do, aside from actual story implementation. Additionally, this agent can help explain the BMad Method when in the web by accessing the knowledge base and explaining anything to you about the process.
154
154
 
155
- If you dont want to bother switching between different agents aside from the dev, this is the agent for you.
155
+ If you don't want to bother switching between different agents aside from the dev, this is the agent for you. Just remember that as the context grows, the performance of the agent degrades, therefore it is important to instruct the agent to compact the conversation and start a new conversation with the compacted conversation as the initial message. Do this often, preferably after each story is implemented.
156
156
 
157
157
  ### BMad-Orchestrator
158
158
 
@@ -210,6 +210,7 @@ dependencies:
210
210
  - **Agent Selection**: Use appropriate agent for task
211
211
  - **Iterative Development**: Work in small, focused tasks
212
212
  - **File Organization**: Maintain clean project structure
213
+ - **Commit Regularly**: Save your work frequently
213
214
 
214
215
  ## Technical Preferences System
215
216
 
@@ -236,7 +237,7 @@ devLoadAlwaysFiles:
236
237
 
237
238
  You will want to verify from sharding your architecture that these documents exist, that they are as lean as possible, and contain exactly the information you want your dev agent to ALWAYS load into it's context. These are the rules the agent will follow.
238
239
 
239
- As your project grows and the code starts to build consistent patterns, coding standards should be reduced to just the items that the agent makes mistakes at still - must with the better models, they will look at surrounding code in files and not need a rule from that file to guide them.
240
+ As your project grows and the code starts to build consistent patterns, coding standards should be reduced to include only the standards that the agent still makes with. The agent will look at surrounding code in files to infer the coding standards that are relevant to the current task.
240
241
 
241
242
  ## Getting Help
242
243
 
@@ -2,10 +2,10 @@
2
2
 
3
3
  > **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation Generation!**
4
4
  >
5
- > Gemini Web's 1M+ token context window or Gemini CLI (when its working) can analyze your ENTIRE codebase or critical sections of it all at once (obviously within reason):
5
+ > Gemini Web's 1M+ token context window or Gemini CLI (when it's working) can analyze your ENTIRE codebase, or critical sections of it, all at once (obviously within reason):
6
6
  >
7
7
  > - Upload via GitHub URL or use gemini cli in the project folder
8
- > - If in the web: Upload up to 1000 files or the zipped project or just give it the github url
8
+ > - If working in the web: use `npx bmad-method flatten` to flatten your project into a single file, then upload that file to your web agent.
9
9
 
10
10
  ## What is Brownfield Development?
11
11
 
@@ -22,10 +22,13 @@ Brownfield development refers to adding features, fixing bugs, or modernizing ex
22
22
 
23
23
  ## When NOT to use a Brownfield Flow
24
24
 
25
- If you have just completed an MVP with BMad, and you want to continue with post-MVP, its easier to just talk to the PM and ask him to work with you to create a new epic to add into the PRD, shard out the epic, update any architecture documents with the architect, and just go from there.
25
+ If you have just completed an MVP with BMad, and you want to continue with post-MVP, its easier to just talk to the PM and ask it to work with you to create a new epic to add into the PRD, shard out the epic, update any architecture documents with the architect, and just go from there.
26
26
 
27
27
  ## The Complete Brownfield Workflow
28
28
 
29
+ 1. **Follow the [<ins>User Guide - Installation</ins>](user-guide.md#installation) steps to setup your agent in the web.**
30
+ 2. **Generate a 'flattened' single file of your entire codebase** run: `npx bmad-method flatten`
31
+
29
32
  ### Choose Your Approach
30
33
 
31
34
  #### Approach A: PRD-First (Recommended if adding very large and complex new features, single or multiple epics or massive changes)
@@ -48,11 +51,11 @@ If you have just completed an MVP with BMad, and you want to continue with post-
48
51
 
49
52
  #### Phase 1: Define Requirements First
50
53
 
51
- **In Gemini Web (with your codebase uploaded):**
54
+ **In Gemini Web (with your flattened-codebase.xml uploaded):**
52
55
 
53
56
  ```bash
54
57
  @pm
55
- *create-doc brownfield-prd
58
+ *create-brownfield-prd
56
59
  ```
57
60
 
58
61
  The PM will:
@@ -69,7 +72,7 @@ The PM will:
69
72
  **Still in Gemini Web, now with PRD context:**
70
73
 
71
74
  ```bash
72
- @analyst
75
+ @architect
73
76
  *document-project
74
77
  ```
75
78
 
@@ -104,22 +107,21 @@ For example, if you say "Add payment processing to user service":
104
107
  1. **Go to Gemini Web** (gemini.google.com)
105
108
  2. **Upload your project**:
106
109
  - **Option A**: Paste your GitHub repository URL directly
107
- - **Option B**: Upload up to 1000 files from your src/project folder
108
- - **Option C**: Zip your project and upload the archive
109
- 3. **Load the analyst agent**: Upload `dist/agents/analyst.txt`
110
+ - **Option B**: Upload your flattened-codebase.xml file
111
+ 3. **Load the analyst agent**: Upload `dist/agents/architect.txt`
110
112
  4. **Run documentation**: Type `*document-project`
111
113
 
112
114
  The analyst will generate comprehensive documentation of everything.
113
115
 
114
116
  #### Phase 2: Plan Your Enhancement
115
117
 
116
- #### Option A: Full Brownfield Workflow (Recommended for Major Changes)
118
+ ##### Option A: Full Brownfield Workflow (Recommended for Major Changes)
117
119
 
118
120
  **1. Create Brownfield PRD**:
119
121
 
120
122
  ```bash
121
123
  @pm
122
- *create-doc brownfield-prd
124
+ *create-brownfield-prd
123
125
  ```
124
126
 
125
127
  The PM agent will:
@@ -146,7 +148,7 @@ The PM agent will:
146
148
 
147
149
  ```bash
148
150
  @architect
149
- *create-doc brownfield-architecture
151
+ *create-brownfield-architecture
150
152
  ```
151
153
 
152
154
  The architect will:
@@ -157,13 +159,13 @@ The architect will:
157
159
  - **Identify technical risks**
158
160
  - **Define compatibility requirements**
159
161
 
160
- #### Option B: Quick Enhancement (For Focused Changes)
162
+ ##### Option B: Quick Enhancement (For Focused Changes)
161
163
 
162
164
  **For Single Epic Without Full PRD**:
163
165
 
164
166
  ```bash
165
167
  @pm
166
- *brownfield-create-epic
168
+ *create-brownfield-epic
167
169
  ```
168
170
 
169
171
  Use when:
@@ -177,7 +179,7 @@ Use when:
177
179
 
178
180
  ```bash
179
181
  @pm
180
- *brownfield-create-story
182
+ *create-brownfield-story
181
183
  ```
182
184
 
183
185
  Use when:
@@ -191,7 +193,7 @@ Use when:
191
193
 
192
194
  ```bash
193
195
  @po
194
- *execute-checklist po-master-checklist
196
+ *execute-checklist-po
195
197
  ```
196
198
 
197
199
  The PO ensures:
@@ -201,26 +203,27 @@ The PO ensures:
201
203
  - Risk mitigation strategies in place
202
204
  - Clear integration approach
203
205
 
204
- ### Phase 4: Transition to Development
205
-
206
- Follow the enhanced IDE Development Workflow:
207
-
208
- 1. **Ensure documents are in project**:
206
+ ### Phase 4: Save and Shard Documents
209
207
 
210
- - Copy `docs/prd.md` (or brownfield-prd.md)
211
- - Copy `docs/architecture.md` (or brownfield-architecture.md)
208
+ 1. Save your PRD and Architecture as:
209
+ docs/brownfield-prd.md
210
+ docs/brownfield-architecture.md
211
+ 2. Shard your docs:
212
+ In your IDE
212
213
 
213
- 2. **Shard documents**:
214
+ ```bash
215
+ @po
216
+ shard docs/brownfield-prd.md
217
+ ```
214
218
 
215
219
  ```bash
216
220
  @po
217
- # Ask to shard docs/prd.md
221
+ shard docs/brownfield-architecture.md
218
222
  ```
219
223
 
220
- 3. **Development cycle**:
221
- - **SM** creates stories with integration awareness
222
- - **Dev** implements with existing code respect
223
- - **QA** reviews for compatibility and improvements
224
+ ### Phase 5: Transition to Development
225
+
226
+ **Follow the [<ins>Enhanced IDE Development Workflow</ins>](enhanced-ide-development-workflow.md)**
224
227
 
225
228
  ## Brownfield Best Practices
226
229
 
@@ -287,7 +290,7 @@ Document:
287
290
  ### Scenario 3: Bug Fix in Complex System
288
291
 
289
292
  1. Document relevant subsystems
290
- 2. Use `brownfield-create-story` for focused fix
293
+ 2. Use `create-brownfield-story` for focused fix
291
294
  3. Include regression test requirements
292
295
  4. QA validates no side effects
293
296
 
@@ -310,7 +313,7 @@ Document:
310
313
 
311
314
  ### "Too much boilerplate for small changes"
312
315
 
313
- **Solution**: Use `brownfield-create-story` instead of full workflow
316
+ **Solution**: Use `create-brownfield-story` instead of full workflow
314
317
 
315
318
  ### "Integration points unclear"
316
319
 
@@ -322,19 +325,19 @@ Document:
322
325
 
323
326
  ```bash
324
327
  # Document existing project
325
- @analyst → *document-project
328
+ @architect → *document-project
326
329
 
327
330
  # Create enhancement PRD
328
- @pm → *create-doc brownfield-prd
331
+ @pm → *create-brownfield-prd
329
332
 
330
333
  # Create architecture with integration focus
331
- @architect → *create-doc brownfield-architecture
334
+ @architect → *create-brownfield-architecture
332
335
 
333
336
  # Quick epic creation
334
- @pm → *brownfield-create-epic
337
+ @pm → *create-brownfield-epic
335
338
 
336
339
  # Single story creation
337
- @pm → *brownfield-create-story
340
+ @pm → *create-brownfield-story
338
341
  ```
339
342
 
340
343
  ### Decision Tree
@@ -9,7 +9,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
9
9
  ## Instructions
10
10
 
11
11
  1. **Initial Assessment**
12
-
13
12
  - If user or the task being run provides a checklist name:
14
13
  - Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
15
14
  - If multiple matches found, ask user to clarify
@@ -22,14 +21,12 @@ If the user asks or does not specify a specific checklist, list the checklists a
22
21
  - All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
23
22
 
24
23
  2. **Document and Artifact Gathering**
25
-
26
24
  - Each checklist will specify its required documents/artifacts at the beginning
27
25
  - Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
28
26
 
29
27
  3. **Checklist Processing**
30
28
 
31
29
  If in interactive mode:
32
-
33
30
  - Work through each section of the checklist one at a time
34
31
  - For each section:
35
32
  - Review all items in the section following instructions for that section embedded in the checklist
@@ -38,7 +35,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
38
35
  - Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
39
36
 
40
37
  If in YOLO mode:
41
-
42
38
  - Process all sections at once
43
39
  - Create a comprehensive report of all findings
44
40
  - Present the complete analysis to the user
@@ -46,7 +42,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
46
42
  4. **Validation Approach**
47
43
 
48
44
  For each checklist item:
49
-
50
45
  - Read and understand the requirement
51
46
  - Look for evidence in the documentation that satisfies the requirement
52
47
  - Consider both explicit mentions and implicit coverage
@@ -60,7 +55,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
60
55
  5. **Section Analysis**
61
56
 
62
57
  For each section:
63
-
64
58
  - think step by step to calculate pass rate
65
59
  - Identify common themes in failed items
66
60
  - Provide specific recommendations for improvement
@@ -70,7 +64,6 @@ If the user asks or does not specify a specific checklist, list the checklists a
70
64
  6. **Final Report**
71
65
 
72
66
  Prepare a summary that includes:
73
-
74
67
  - Overall checklist completion status
75
68
  - Pass rates by section
76
69
  - List of failed items with context