bmad-method 4.31.0 → 4.32.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 (72) hide show
  1. package/.vscode/settings.json +1 -7
  2. package/CHANGELOG.md +108 -173
  3. package/README.md +40 -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/data/bmad-kb.md +12 -2
  16. package/bmad-core/data/elicitation-methods.md +20 -0
  17. package/bmad-core/enhanced-ide-development-workflow.md +43 -0
  18. package/bmad-core/tasks/advanced-elicitation.md +2 -0
  19. package/bmad-core/tasks/create-brownfield-story.md +20 -3
  20. package/bmad-core/tasks/document-project.md +19 -13
  21. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  22. package/bmad-core/tasks/index-docs.md +0 -1
  23. package/bmad-core/tasks/kb-mode-interaction.md +3 -3
  24. package/bmad-core/tasks/review-story.md +18 -1
  25. package/bmad-core/user-guide.md +7 -6
  26. package/bmad-core/working-in-the-brownfield.md +39 -36
  27. package/dist/agents/analyst.txt +6 -6
  28. package/dist/agents/architect.txt +8 -3
  29. package/dist/agents/bmad-master.txt +2 -1
  30. package/dist/agents/pm.txt +9 -2
  31. package/dist/agents/po.txt +2 -318
  32. package/dist/agents/qa.txt +0 -1
  33. package/dist/agents/sm.txt +3 -3
  34. package/dist/agents/ux-expert.txt +2 -297
  35. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +6 -6
  36. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4047 -0
  37. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +1520 -185
  38. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +214 -1229
  39. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +537 -373
  40. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +6917 -2140
  41. package/dist/teams/team-all.txt +30 -25
  42. package/dist/teams/team-fullstack.txt +27 -21
  43. package/dist/teams/team-ide-minimal.txt +5 -322
  44. package/dist/teams/team-no-ui.txt +25 -16
  45. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +3 -1
  46. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +1 -0
  47. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +80 -0
  48. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +21 -16
  49. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +25 -25
  50. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +15 -14
  51. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +396 -0
  52. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +203 -0
  53. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +1 -1
  54. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +93 -121
  55. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
  56. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +593 -68
  57. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +151 -0
  58. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +165 -198
  59. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +200 -0
  60. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +938 -453
  61. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +3 -3
  62. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +517 -155
  63. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +12 -12
  64. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +11 -11
  65. package/package.json +79 -76
  66. package/tools/cli.js +9 -0
  67. package/tools/flattener/main.js +559 -0
  68. package/tools/installer/lib/installer.js +1 -1
  69. package/tools/installer/package.json +1 -1
  70. package/.husky/pre-commit +0 -2
  71. package/.prettierignore +0 -21
  72. package/.prettierrc +0 -23
@@ -27,6 +27,7 @@ Ask the user:
27
27
  2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
28
28
 
29
29
  3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
30
+
30
31
  - 'Adding payment processing to the user service'
31
32
  - 'Refactoring the authentication module'
32
33
  - 'Integrating with a new third-party API'
@@ -62,6 +63,7 @@ Ask the user these elicitation questions to better understand their needs:
62
63
  CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
63
64
 
64
65
  1. **Explore Key Areas**:
66
+
65
67
  - Entry points (main files, index files, app initializers)
66
68
  - Configuration files and environment setup
67
69
  - Package dependencies and versions
@@ -69,6 +71,7 @@ CRITICAL: Before generating documentation, conduct extensive analysis of the exi
69
71
  - Test suites and coverage
70
72
 
71
73
  2. **Ask Clarifying Questions**:
74
+
72
75
  - "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
73
76
  - "What are the most critical/complex parts of this system that developers struggle with?"
74
77
  - "Are there any undocumented 'tribal knowledge' areas I should capture?"
@@ -111,9 +114,9 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
111
114
 
112
115
  ### Change Log
113
116
 
114
- | Date | Version | Description | Author |
115
- |------|---------|-------------|--------|
116
- | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
117
+ | Date | Version | Description | Author |
118
+ | ------ | ------- | --------------------------- | --------- |
119
+ | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
117
120
 
118
121
  ## Quick Reference - Key Files and Entry Points
119
122
 
@@ -136,11 +139,11 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
136
139
 
137
140
  ### Actual Tech Stack (from package.json/requirements.txt)
138
141
 
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] |
142
+ | Category | Technology | Version | Notes |
143
+ | --------- | ---------- | ------- | -------------------------- |
144
+ | Runtime | Node.js | 16.x | [Any constraints] |
145
+ | Framework | Express | 4.18.2 | [Custom middleware?] |
146
+ | Database | PostgreSQL | 13 | [Connection pooling setup] |
144
147
 
145
148
  etc...
146
149
 
@@ -179,6 +182,7 @@ project-root/
179
182
  ### Data Models
180
183
 
181
184
  Instead of duplicating, reference actual model files:
185
+
182
186
  - **User Model**: See `src/models/User.js`
183
187
  - **Order Model**: See `src/models/Order.js`
184
188
  - **Related Types**: TypeScript definitions in `src/types/`
@@ -208,10 +212,10 @@ Instead of duplicating, reference actual model files:
208
212
 
209
213
  ### External Services
210
214
 
211
- | Service | Purpose | Integration Type | Key Files |
212
- |---------|---------|------------------|-----------|
213
- | Stripe | Payments | REST API | `src/integrations/stripe/` |
214
- | SendGrid | Emails | SDK | `src/services/emailService.js` |
215
+ | Service | Purpose | Integration Type | Key Files |
216
+ | -------- | -------- | ---------------- | ------------------------------ |
217
+ | Stripe | Payments | REST API | `src/integrations/stripe/` |
218
+ | SendGrid | Emails | SDK | `src/services/emailService.js` |
215
219
 
216
220
  etc...
217
221
 
@@ -256,6 +260,7 @@ npm run test:integration # Runs integration tests (requires local DB)
256
260
  ### Files That Will Need Modification
257
261
 
258
262
  Based on the enhancement requirements, these files will be affected:
263
+
259
264
  - `src/services/userService.js` - Add new user fields
260
265
  - `src/models/User.js` - Update schema
261
266
  - `src/routes/userRoutes.js` - New endpoints
@@ -293,6 +298,7 @@ npm run seed # Seed test data
293
298
  ### 4. Document Delivery
294
299
 
295
300
  1. **In Web UI (Gemini, ChatGPT, Claude)**:
301
+
296
302
  - Present the entire document in one response (or multiple if too long)
297
303
  - Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
298
304
  - Mention it can be sharded later in IDE if needed
@@ -338,4 +344,4 @@ Apply the advanced elicitation task after major sections to refine based on user
338
344
  - References actual files rather than duplicating content when possible
339
345
  - Documents technical debt, workarounds, and constraints honestly
340
346
  - For brownfield projects with PRD: Provides clear enhancement impact analysis
341
- - The goal is PRACTICAL documentation for AI agents doing real work
347
+ - 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
 
@@ -88,7 +88,6 @@ Documents within the `another-folder/` directory:
88
88
  ### [Nested Document](./another-folder/document.md)
89
89
 
90
90
  Description of nested document.
91
-
92
91
  ```
93
92
 
94
93
  ### Index Entry Format
@@ -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
 
@@ -11,11 +11,13 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
11
11
  ## Review Process
12
12
 
13
13
  1. **Read the Complete Story**
14
+
14
15
  - Review all acceptance criteria
15
16
  - Understand the dev notes and requirements
16
17
  - Note any completion notes from the developer
17
18
 
18
19
  2. **Verify Implementation Against Dev Notes Guidance**
20
+
19
21
  - Review the "Dev Notes" section for specific technical guidance provided to the developer
20
22
  - Verify the developer's implementation follows the architectural patterns specified in Dev Notes
21
23
  - Check that file locations match the project structure guidance in Dev Notes
@@ -23,11 +25,13 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
23
25
  - Validate that security considerations mentioned in Dev Notes were implemented
24
26
 
25
27
  3. **Focus on the File List**
28
+
26
29
  - Verify all files listed were actually created/modified
27
30
  - Check for any missing files that should have been updated
28
31
  - Ensure file locations align with the project structure guidance from Dev Notes
29
32
 
30
33
  4. **Senior Developer Code Review**
34
+
31
35
  - Review code with the eye of a senior developer
32
36
  - If changes form a cohesive whole, review them together
33
37
  - If changes are independent, review incrementally file by file
@@ -40,6 +44,7 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
40
44
  - Best practices and patterns
41
45
 
42
46
  5. **Active Refactoring**
47
+
43
48
  - As a senior developer, you CAN and SHOULD refactor code where improvements are needed
44
49
  - When refactoring:
45
50
  - Make the changes directly in the files
@@ -49,17 +54,20 @@ When a developer agent marks a story as "Ready for Review", perform a comprehens
49
54
  - Update the File List if you modify additional files
50
55
 
51
56
  6. **Standards Compliance Check**
57
+
52
58
  - Verify adherence to `docs/coding-standards.md`
53
59
  - Check compliance with `docs/unified-project-structure.md`
54
60
  - Validate testing approach against `docs/testing-strategy.md`
55
61
  - Ensure all guidelines mentioned in the story are followed
56
62
 
57
63
  7. **Acceptance Criteria Validation**
64
+
58
65
  - Verify each AC is fully implemented
59
66
  - Check for any missing functionality
60
67
  - Validate edge cases are handled
61
68
 
62
69
  8. **Test Coverage Review**
70
+
63
71
  - Ensure unit tests cover edge cases
64
72
  - Add missing tests if critical coverage is lacking
65
73
  - Verify integration tests (if required) are comprehensive
@@ -81,25 +89,31 @@ After review and any refactoring, append your results to the story file in the Q
81
89
  ## QA Results
82
90
 
83
91
  ### Review Date: [Date]
92
+
84
93
  ### Reviewed By: Quinn (Senior Developer QA)
85
94
 
86
95
  ### Code Quality Assessment
96
+
87
97
  [Overall assessment of implementation quality]
88
98
 
89
99
  ### Refactoring Performed
100
+
90
101
  [List any refactoring you performed with explanations]
102
+
91
103
  - **File**: [filename]
92
104
  - **Change**: [what was changed]
93
105
  - **Why**: [reason for change]
94
106
  - **How**: [how it improves the code]
95
107
 
96
108
  ### Compliance Check
109
+
97
110
  - Coding Standards: [✓/✗] [notes if any]
98
111
  - Project Structure: [✓/✗] [notes if any]
99
112
  - Testing Strategy: [✓/✗] [notes if any]
100
113
  - All ACs Met: [✓/✗] [notes if any]
101
114
 
102
115
  ### Improvements Checklist
116
+
103
117
  [Check off items you handled yourself, leave unchecked for dev to address]
104
118
 
105
119
  - [x] Refactored user service for better error handling (services/user.service.ts)
@@ -109,12 +123,15 @@ After review and any refactoring, append your results to the story file in the Q
109
123
  - [ ] Update API documentation for new error codes
110
124
 
111
125
  ### Security Review
126
+
112
127
  [Any security concerns found and whether addressed]
113
128
 
114
129
  ### Performance Considerations
130
+
115
131
  [Any performance issues found and whether addressed]
116
132
 
117
133
  ### Final Status
134
+
118
135
  [✓ Approved - Ready for Done] / [✗ Changes Required - See unchecked items above]
119
136
  ```
120
137
 
@@ -142,4 +159,4 @@ After review:
142
159
 
143
160
  1. If all items are checked and approved: Update story status to "Done"
144
161
  2. If unchecked items remain: Keep status as "Review" for dev to address
145
- 3. Always provide constructive feedback and explanations for learning
162
+ 3. Always provide constructive feedback and explanations for learning
@@ -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 the flattener-tool 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: `npm run 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
@@ -76,14 +76,14 @@ persona:
76
76
  - Numbered Options Protocol - Always use numbered lists for selections
77
77
  commands:
78
78
  - help: Show numbered list of the following commands to allow selection
79
- - create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
79
+ - create-project-brief: use task create-doc with project-brief-tmpl.yaml
80
+ - perform-market-research: use task create-doc with market-research-tmpl.yaml
81
+ - create-competitor-analysis: use task create-doc with competitor-analysis-tmpl.yaml
80
82
  - yolo: Toggle Yolo Mode
81
- - doc-out: Output full document to current destination file
82
- - execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
83
- - research-prompt {topic}: execute task create-deep-research-prompt for architectural decisions
84
- - brainstorm {topic}: Facilitate structured brainstorming session
83
+ - doc-out: Output full document in progress to current destination file
84
+ - research-prompt {topic}: execute task create-deep-research-prompt.md
85
+ - brainstorm {topic}: Facilitate structured brainstorming session (run task facilitate-brainstorming-session.md with template brainstorming-output-tmpl.yaml)
85
86
  - elicit: run the task advanced-elicitation
86
- - document-project: Analyze and document existing project structure comprehensively
87
87
  - exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
88
88
  dependencies:
89
89
  tasks:
@@ -76,11 +76,16 @@ persona:
76
76
  - Living Architecture - Design for change and adaptation
77
77
  commands:
78
78
  - help: Show numbered list of the following commands to allow selection
79
- - create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
80
- - yolo: Toggle Yolo Mode
79
+ - create-full-stack-architecture: use create-doc with fullstack-architecture-tmpl.yaml
80
+ - create-backend-architecture: use create-doc with architecture-tmpl.yaml
81
+ - create-front-end-architecture: use create-doc with front-end-architecture-tmpl.yaml
82
+ - create-brownfield-architecture: use create-doc with brownfield-architecture-tmpl.yaml
81
83
  - doc-out: Output full document to current destination file
84
+ - document-project: execute the task document-project.md
82
85
  - execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
83
- - research {topic}: execute task create-deep-research-prompt for architectural decisions
86
+ - research {topic}: execute task create-deep-research-prompt
87
+ - shard-prd: run the task shard-doc.md for the provided architecture.md (ask if not found)
88
+ - yolo: Toggle Yolo Mode
84
89
  - exit: Say goodbye as the Architect, and then abandon inhabiting this persona
85
90
  dependencies:
86
91
  tasks:
@@ -70,10 +70,11 @@ commands:
70
70
  - kb: Toggle KB mode off (default) or on, when on will load and reference the .bmad-core/data/bmad-kb.md and converse with the user answering his questions with this informational resource
71
71
  - task {task}: Execute task, if not found or none specified, ONLY list available dependencies/tasks listed below
72
72
  - create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
73
+ - doc-out: Output full document to current destination file
74
+ - document-project: execute the task document-project.md
73
75
  - execute-checklist {checklist}: Run task execute-checklist (no checklist = ONLY show available checklists listed under dependencies/checklist below)
74
76
  - shard-doc {document} {destination}: run the task shard-doc against the optionally provided document to the specified destination
75
77
  - yolo: Toggle Yolo Mode
76
- - doc-out: Output full document to current destination file
77
78
  - exit: Exit (confirm)
78
79
  dependencies:
79
80
  tasks:
@@ -72,9 +72,16 @@ persona:
72
72
  - Strategic thinking & outcome-oriented
73
73
  commands:
74
74
  - help: Show numbered list of the following commands to allow selection
75
- - create-doc {template}: execute task create-doc for template provided, if no template then ONLY list dependencies.templates
76
- - yolo: Toggle Yolo Mode
75
+ - create-prd: run task create-doc.md with template prd-tmpl.yaml
76
+ - create-brownfield-prd: run task create-doc.md with template brownfield-prd-tmpl.yaml
77
+ - create-brownfield-epic: run task brownfield-create-epic.md
78
+ - create-brownfield-story: run task brownfield-create-story.md
79
+ - create-epic: Create epic for brownfield projects (task brownfield-create-epic)
80
+ - create-story: Create user story from requirements (task brownfield-create-story)
77
81
  - doc-out: Output full document to current destination file
82
+ - shard-prd: run the task shard-doc.md for the provided prd.md (ask if not found)
83
+ - correct-course: execute the correct-course task
84
+ - yolo: Toggle Yolo Mode
78
85
  - exit: Exit (confirm)
79
86
  dependencies:
80
87
  tasks: