bmad-method 4.28.0 → 4.29.1

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 (42) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/bmad-core/agents/bmad-master.md +0 -2
  3. package/bmad-core/agents/bmad-orchestrator.md +0 -3
  4. package/bmad-core/core-config.yaml +1 -5
  5. package/bmad-core/data/bmad-kb.md +2 -2
  6. package/bmad-core/tasks/correct-course.md +9 -12
  7. package/bmad-core/tasks/create-brownfield-story.md +10 -61
  8. package/bmad-core/tasks/create-deep-research-prompt.md +5 -17
  9. package/bmad-core/tasks/create-next-story.md +3 -4
  10. package/bmad-core/tasks/document-project.md +37 -13
  11. package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
  12. package/bmad-core/tasks/generate-ai-frontend-prompt.md +1 -1
  13. package/bmad-core/tasks/kb-mode-interaction.md +8 -3
  14. package/bmad-core/tasks/review-story.md +3 -3
  15. package/bmad-core/tasks/shard-doc.md +5 -9
  16. package/common/tasks/create-doc.md +4 -0
  17. package/dist/agents/analyst.txt +43 -31
  18. package/dist/agents/architect.txt +42 -30
  19. package/dist/agents/bmad-master.txt +61 -602
  20. package/dist/agents/bmad-orchestrator.txt +7 -548
  21. package/dist/agents/pm.txt +19 -38
  22. package/dist/agents/po.txt +14 -21
  23. package/dist/agents/qa.txt +3 -3
  24. package/dist/agents/sm.txt +11 -15
  25. package/dist/agents/ux-expert.txt +6 -18
  26. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +5 -17
  27. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +50 -579
  28. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +5 -17
  29. package/dist/teams/team-all.txt +70 -607
  30. package/dist/teams/team-fullstack.txt +65 -601
  31. package/dist/teams/team-ide-minimal.txt +26 -575
  32. package/dist/teams/team-no-ui.txt +64 -600
  33. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -0
  34. package/expansion-packs/bmad-creator-tools/config.yaml +1 -0
  35. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -0
  36. package/package.json +1 -1
  37. package/tools/installer/lib/ide-setup.js +325 -12
  38. package/tools/installer/package.json +1 -1
  39. package/bmad-core/tasks/create-workflow-plan.md +0 -289
  40. package/bmad-core/tasks/doc-migration-task.md +0 -143
  41. package/bmad-core/tasks/update-workflow-plan.md +0 -248
  42. package/docs/template-markup-references.md +0 -86
@@ -232,7 +232,6 @@ workflow-guidance:
232
232
  - Understand each workflow's purpose, options, and decision points
233
233
  - Ask clarifying questions based on the workflow's structure
234
234
  - Guide users through workflow selection when multiple options exist
235
- - For complex projects, offer to create a workflow plan using create-workflow-plan task
236
235
  - When appropriate, suggest: Would you like me to create a detailed workflow plan before starting?
237
236
  - For workflows with divergent paths, help users choose the right path
238
237
  - Adapt questions to the specific domain (e.g., game dev vs infrastructure vs web dev)
@@ -242,9 +241,7 @@ dependencies:
242
241
  tasks:
243
242
  - advanced-elicitation.md
244
243
  - create-doc.md
245
- - create-workflow-plan.md
246
244
  - kb-mode-interaction.md
247
- - update-workflow-plan.md
248
245
  data:
249
246
  - bmad-kb.md
250
247
  - elicitation-methods.md
@@ -431,7 +428,7 @@ dependencies:
431
428
  ==================== START: .bmad-2d-phaser-game-dev/tasks/facilitate-brainstorming-session.md ====================
432
429
  ---
433
430
  docOutputLocation: docs/brainstorming-session-results.md
434
- template: brainstorming-output-tmpl
431
+ template: ".bmad-2d-phaser-game-dev/templates/brainstorming-output-tmpl.md"
435
432
  ---
436
433
 
437
434
  # Facilitate Brainstorming Session Task
@@ -584,7 +581,7 @@ Generate well-structured research prompts that:
584
581
 
585
582
  ## Research Type Selection
586
583
 
587
- [[LLM: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.]]
584
+ CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
588
585
 
589
586
  ### 1. Research Focus Options
590
587
 
@@ -647,15 +644,13 @@ Present these numbered options to the user:
647
644
  - Consider regulatory and legal implications
648
645
 
649
646
  9. **Custom Research Focus**
650
- [[LLM: Allow user to define their own specific research focus.]]
647
+
651
648
  - User-defined research objectives
652
649
  - Specialized domain investigation
653
650
  - Cross-functional research needs
654
651
 
655
652
  ### 2. Input Processing
656
653
 
657
- [[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
658
-
659
654
  **If Project Brief provided:**
660
655
 
661
656
  - Extract key product concepts and goals
@@ -688,11 +683,11 @@ Present these numbered options to the user:
688
683
 
689
684
  ### 3. Research Prompt Structure
690
685
 
691
- [[LLM: Based on the selected research type and context, collaboratively develop a comprehensive research prompt with these components.]]
686
+ CRITICAL: collaboratively develop a comprehensive research prompt with these components.
692
687
 
693
688
  #### A. Research Objectives
694
689
 
695
- [[LLM: Work with the user to articulate clear, specific objectives for the research.]]
690
+ CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
696
691
 
697
692
  - Primary research goal and purpose
698
693
  - Key decisions the research will inform
@@ -701,7 +696,7 @@ Present these numbered options to the user:
701
696
 
702
697
  #### B. Research Questions
703
698
 
704
- [[LLM: Develop specific, actionable research questions organized by theme.]]
699
+ CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
705
700
 
706
701
  **Core Questions:**
707
702
 
@@ -717,8 +712,6 @@ Present these numbered options to the user:
717
712
 
718
713
  #### C. Research Methodology
719
714
 
720
- [[LLM: Specify appropriate research methods based on the type and objectives.]]
721
-
722
715
  **Data Collection Methods:**
723
716
 
724
717
  - Secondary research sources
@@ -735,8 +728,6 @@ Present these numbered options to the user:
735
728
 
736
729
  #### D. Output Requirements
737
730
 
738
- [[LLM: Define how research findings should be structured and presented.]]
739
-
740
731
  **Format Specifications:**
741
732
 
742
733
  - Executive summary requirements
@@ -753,8 +744,6 @@ Present these numbered options to the user:
753
744
 
754
745
  ### 4. Prompt Generation
755
746
 
756
- [[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
757
-
758
747
  **Research Prompt Template:**
759
748
 
760
749
  ```markdown
@@ -823,8 +812,6 @@ Present these numbered options to the user:
823
812
 
824
813
  ### 5. Review and Refinement
825
814
 
826
- [[LLM: Present the draft research prompt for user review and refinement.]]
827
-
828
815
  1. **Present Complete Prompt**
829
816
 
830
817
  - Show the full research prompt
@@ -846,8 +833,6 @@ Present these numbered options to the user:
846
833
 
847
834
  ### 6. Next Steps Guidance
848
835
 
849
- [[LLM: Provide clear guidance on how to use the research prompt.]]
850
-
851
836
  **Execution Options:**
852
837
 
853
838
  1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
@@ -1078,9 +1063,9 @@ Generate comprehensive documentation for existing projects optimized for AI deve
1078
1063
 
1079
1064
  ### 1. Initial Project Analysis
1080
1065
 
1081
- [[LLM: First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
1066
+ **CRITICAL:** First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
1082
1067
 
1083
- **IF PRD EXISTS**:
1068
+ **IF PRD EXISTS**:
1084
1069
 
1085
1070
  - Review the PRD to understand what enhancement/feature is planned
1086
1071
  - Identify which modules, services, or areas will be affected
@@ -1126,11 +1111,10 @@ Ask the user these elicitation questions to better understand their needs:
1126
1111
  - Are there any existing documentation standards or formats you prefer?
1127
1112
  - What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
1128
1113
  - Is there a specific feature or enhancement you're planning? (This helps focus documentation)
1129
- ]]
1130
1114
 
1131
1115
  ### 2. Deep Codebase Analysis
1132
1116
 
1133
- [[LLM: Before generating documentation, conduct extensive analysis of the existing codebase:
1117
+ CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
1134
1118
 
1135
1119
  1. **Explore Key Areas**:
1136
1120
  - Entry points (main files, index files, app initializers)
@@ -1153,13 +1137,14 @@ Ask the user these elicitation questions to better understand their needs:
1153
1137
  - Document workarounds and technical debt
1154
1138
  - Note areas that differ from standard patterns
1155
1139
 
1156
- **IF PRD PROVIDED**: Also analyze what would need to change for the enhancement]]
1140
+ **IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
1157
1141
 
1158
1142
  ### 3. Core Documentation Generation
1159
1143
 
1160
1144
  [[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
1161
1145
 
1162
1146
  **CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
1147
+
1163
1148
  - Technical debt and workarounds
1164
1149
  - Inconsistent patterns between different parts
1165
1150
  - Legacy code that can't be changed
@@ -1171,13 +1156,16 @@ Ask the user these elicitation questions to better understand their needs:
1171
1156
  # [Project Name] Brownfield Architecture Document
1172
1157
 
1173
1158
  ## Introduction
1159
+
1174
1160
  This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
1175
1161
 
1176
1162
  ### Document Scope
1163
+
1177
1164
  [If PRD provided: "Focused on areas relevant to: {enhancement description}"]
1178
1165
  [If no PRD: "Comprehensive documentation of entire system"]
1179
1166
 
1180
1167
  ### Change Log
1168
+
1181
1169
  | Date | Version | Description | Author |
1182
1170
  |------|---------|-------------|--------|
1183
1171
  | [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
@@ -1185,6 +1173,7 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
1185
1173
  ## Quick Reference - Key Files and Entry Points
1186
1174
 
1187
1175
  ### Critical Files for Understanding the System
1176
+
1188
1177
  - **Main Entry**: `src/index.js` (or actual entry point)
1189
1178
  - **Configuration**: `config/app.config.js`, `.env.example`
1190
1179
  - **Core Business Logic**: `src/services/`, `src/domain/`
@@ -1193,22 +1182,25 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
1193
1182
  - **Key Algorithms**: [List specific files with complex logic]
1194
1183
 
1195
1184
  ### If PRD Provided - Enhancement Impact Areas
1185
+
1196
1186
  [Highlight which files/modules will be affected by the planned enhancement]
1197
1187
 
1198
1188
  ## High Level Architecture
1199
1189
 
1200
1190
  ### Technical Summary
1201
- [Real assessment of architecture - mention if it's well-structured or has issues]
1202
1191
 
1203
1192
  ### Actual Tech Stack (from package.json/requirements.txt)
1193
+
1204
1194
  | Category | Technology | Version | Notes |
1205
1195
  |----------|------------|---------|--------|
1206
1196
  | Runtime | Node.js | 16.x | [Any constraints] |
1207
1197
  | Framework | Express | 4.18.2 | [Custom middleware?] |
1208
1198
  | Database | PostgreSQL | 13 | [Connection pooling setup] |
1209
- | [etc...] |
1199
+
1200
+ etc...
1210
1201
 
1211
1202
  ### Repository Structure Reality Check
1203
+
1212
1204
  - Type: [Monorepo/Polyrepo/Hybrid]
1213
1205
  - Package Manager: [npm/yarn/pnpm]
1214
1206
  - Notable: [Any unusual structure decisions]
@@ -1216,7 +1208,8 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
1216
1208
  ## Source Tree and Module Organization
1217
1209
 
1218
1210
  ### Project Structure (Actual)
1219
- ```
1211
+
1212
+ ```text
1220
1213
  project-root/
1221
1214
  ├── src/
1222
1215
  │ ├── controllers/ # HTTP request handlers
@@ -1230,6 +1223,7 @@ project-root/
1230
1223
  ```
1231
1224
 
1232
1225
  ### Key Modules and Their Purpose
1226
+
1233
1227
  - **User Management**: `src/services/userService.js` - Handles all user operations
1234
1228
  - **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
1235
1229
  - **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
@@ -1238,12 +1232,14 @@ project-root/
1238
1232
  ## Data Models and APIs
1239
1233
 
1240
1234
  ### Data Models
1235
+
1241
1236
  Instead of duplicating, reference actual model files:
1242
1237
  - **User Model**: See `src/models/User.js`
1243
1238
  - **Order Model**: See `src/models/Order.js`
1244
1239
  - **Related Types**: TypeScript definitions in `src/types/`
1245
1240
 
1246
1241
  ### API Specifications
1242
+
1247
1243
  - **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
1248
1244
  - **Postman Collection**: `docs/api/postman-collection.json`
1249
1245
  - **Manual Endpoints**: [List any undocumented endpoints discovered]
@@ -1251,12 +1247,14 @@ Instead of duplicating, reference actual model files:
1251
1247
  ## Technical Debt and Known Issues
1252
1248
 
1253
1249
  ### Critical Technical Debt
1250
+
1254
1251
  1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
1255
1252
  2. **User Service**: Different pattern than other services, uses callbacks instead of promises
1256
1253
  3. **Database Migrations**: Manually tracked, no proper migration tool
1257
1254
  4. **[Other significant debt]**
1258
1255
 
1259
1256
  ### Workarounds and Gotchas
1257
+
1260
1258
  - **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
1261
1259
  - **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
1262
1260
  - **[Other workarounds developers need to know]**
@@ -1264,13 +1262,16 @@ Instead of duplicating, reference actual model files:
1264
1262
  ## Integration Points and External Dependencies
1265
1263
 
1266
1264
  ### External Services
1265
+
1267
1266
  | Service | Purpose | Integration Type | Key Files |
1268
1267
  |---------|---------|------------------|-----------|
1269
1268
  | Stripe | Payments | REST API | `src/integrations/stripe/` |
1270
1269
  | SendGrid | Emails | SDK | `src/services/emailService.js` |
1271
- | [etc...] |
1270
+
1271
+ etc...
1272
1272
 
1273
1273
  ### Internal Integration Points
1274
+
1274
1275
  - **Frontend Communication**: REST API on port 3000, expects specific headers
1275
1276
  - **Background Jobs**: Redis queue, see `src/workers/`
1276
1277
  - **[Other integrations]**
@@ -1278,11 +1279,13 @@ Instead of duplicating, reference actual model files:
1278
1279
  ## Development and Deployment
1279
1280
 
1280
1281
  ### Local Development Setup
1282
+
1281
1283
  1. Actual steps that work (not ideal steps)
1282
1284
  2. Known issues with setup
1283
1285
  3. Required environment variables (see `.env.example`)
1284
1286
 
1285
1287
  ### Build and Deployment Process
1288
+
1286
1289
  - **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
1287
1290
  - **Deployment**: Manual deployment via `scripts/deploy.sh`
1288
1291
  - **Environments**: Dev, Staging, Prod (see `config/environments/`)
@@ -1290,12 +1293,14 @@ Instead of duplicating, reference actual model files:
1290
1293
  ## Testing Reality
1291
1294
 
1292
1295
  ### Current Test Coverage
1296
+
1293
1297
  - Unit Tests: 60% coverage (Jest)
1294
1298
  - Integration Tests: Minimal, in `tests/integration/`
1295
1299
  - E2E Tests: None
1296
1300
  - Manual Testing: Primary QA method
1297
1301
 
1298
1302
  ### Running Tests
1303
+
1299
1304
  ```bash
1300
1305
  npm test # Runs unit tests
1301
1306
  npm run test:integration # Runs integration tests (requires local DB)
@@ -1304,6 +1309,7 @@ npm run test:integration # Runs integration tests (requires local DB)
1304
1309
  ## If Enhancement PRD Provided - Impact Analysis
1305
1310
 
1306
1311
  ### Files That Will Need Modification
1312
+
1307
1313
  Based on the enhancement requirements, these files will be affected:
1308
1314
  - `src/services/userService.js` - Add new user fields
1309
1315
  - `src/models/User.js` - Update schema
@@ -1311,11 +1317,13 @@ Based on the enhancement requirements, these files will be affected:
1311
1317
  - [etc...]
1312
1318
 
1313
1319
  ### New Files/Modules Needed
1320
+
1314
1321
  - `src/services/newFeatureService.js` - New business logic
1315
1322
  - `src/models/NewFeature.js` - New data model
1316
1323
  - [etc...]
1317
1324
 
1318
1325
  ### Integration Considerations
1326
+
1319
1327
  - Will need to integrate with existing auth middleware
1320
1328
  - Must follow existing response format in `src/utils/responseFormatter.js`
1321
1329
  - [Other integration points]
@@ -1323,6 +1331,7 @@ Based on the enhancement requirements, these files will be affected:
1323
1331
  ## Appendix - Useful Commands and Scripts
1324
1332
 
1325
1333
  ### Frequently Used Commands
1334
+
1326
1335
  ```bash
1327
1336
  npm run dev # Start development server
1328
1337
  npm run build # Production build
@@ -1331,14 +1340,13 @@ npm run seed # Seed test data
1331
1340
  ```
1332
1341
 
1333
1342
  ### Debugging and Troubleshooting
1343
+
1334
1344
  - **Logs**: Check `logs/app.log` for application logs
1335
1345
  - **Debug Mode**: Set `DEBUG=app:*` for verbose logging
1336
1346
  - **Common Issues**: See `docs/troubleshooting.md`]]
1337
1347
 
1338
1348
  ### 4. Document Delivery
1339
1349
 
1340
- [[LLM: After generating the complete architecture document:
1341
-
1342
1350
  1. **In Web UI (Gemini, ChatGPT, Claude)**:
1343
1351
  - Present the entire document in one response (or multiple if too long)
1344
1352
  - Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
@@ -1350,6 +1358,7 @@ npm run seed # Seed test data
1350
1358
  - Can be sharded later using PO agent if desired
1351
1359
 
1352
1360
  The document should be comprehensive enough that future agents can understand:
1361
+
1353
1362
  - The actual state of the system (not idealized)
1354
1363
  - Where to find key files and logic
1355
1364
  - What technical debt exists
@@ -1358,7 +1367,7 @@ The document should be comprehensive enough that future agents can understand:
1358
1367
 
1359
1368
  ### 5. Quality Assurance
1360
1369
 
1361
- [[LLM: Before finalizing the document:
1370
+ CRITICAL: Before finalizing the document:
1362
1371
 
1363
1372
  1. **Accuracy Check**: Verify all technical details match the actual codebase
1364
1373
  2. **Completeness Review**: Ensure all major system components are documented
@@ -1366,7 +1375,7 @@ The document should be comprehensive enough that future agents can understand:
1366
1375
  4. **Clarity Assessment**: Check that explanations are clear for AI agents
1367
1376
  5. **Navigation**: Ensure document has clear section structure for easy reference
1368
1377
 
1369
- Apply the advanced elicitation task after major sections to refine based on user feedback.]]
1378
+ Apply the advanced elicitation task after major sections to refine based on user feedback.
1370
1379
 
1371
1380
  ## Success Criteria
1372
1381
 
@@ -2617,302 +2626,11 @@ This knowledge base provides the foundation for effective game development using
2617
2626
  20. **Question Storming**: Generate questions instead of answers first
2618
2627
  ==================== END: .bmad-2d-phaser-game-dev/data/brainstorming-techniques.md ====================
2619
2628
 
2620
- ==================== START: .bmad-2d-phaser-game-dev/tasks/create-workflow-plan.md ====================
2621
- # Create Workflow Plan Task
2622
-
2623
- ## Purpose
2624
-
2625
- Guide users through workflow selection and create a detailed plan document that outlines the selected workflow steps, decision points, and expected outputs. This task helps users understand what will happen before starting a complex workflow and provides a checklist to track progress.
2626
-
2627
- ## Task Instructions
2628
-
2629
- ### 1. Understand User's Goal
2630
-
2631
- [[LLM: Start with discovery questions to understand what the user wants to accomplish]]
2632
-
2633
- Ask the user:
2634
-
2635
- 1. **Project Type**:
2636
- - Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
2637
- - What type of application? (web app, service/API, UI only, full-stack)
2638
-
2639
- 2. **For Greenfield**:
2640
- - Do you need a quick prototype or production-ready application?
2641
- - Will this have a UI component?
2642
- - Single service or multiple services?
2643
-
2644
- 3. **For Brownfield**:
2645
- - What's the scope of the enhancement?
2646
- - Single bug fix or small feature (few hours)
2647
- - Small enhancement (1-3 stories)
2648
- - Major feature requiring coordination
2649
- - Architectural changes or modernization
2650
- - Do you have existing documentation?
2651
- - Are you following existing patterns or introducing new ones?
2652
-
2653
- ### 2. Recommend Appropriate Workflow
2654
-
2655
- Based on the answers, recommend:
2656
-
2657
- **Greenfield Options:**
2658
-
2659
- - `greenfield-fullstack` - Complete web application
2660
- - `greenfield-service` - Backend API/service only
2661
- - `greenfield-ui` - Frontend only
2662
-
2663
- **Brownfield Options:**
2664
-
2665
- - `brownfield-create-story` - Single small change
2666
- - `brownfield-create-epic` - Small feature (1-3 stories)
2667
- - `brownfield-fullstack` - Major enhancement
2668
-
2669
- **Simplified Option:**
2670
-
2671
- - For users unsure or wanting flexibility, suggest starting with individual agent tasks
2672
-
2673
- ### 3. Explain Selected Workflow
2674
-
2675
- [[LLM: Once workflow is selected, provide clear explanation]]
2676
-
2677
- For the selected workflow, explain:
2678
-
2679
- 1. **Overview**: What this workflow accomplishes
2680
- 2. **Duration**: Estimated time for planning phase
2681
- 3. **Outputs**: What documents will be created
2682
- 4. **Decision Points**: Where user input will be needed
2683
- 5. **Requirements**: What information should be ready
2684
-
2685
- ### 4. Create Workflow Plan Document
2686
-
2687
- [[LLM: Generate a comprehensive plan document with the following structure]]
2688
-
2689
- ```markdown
2690
- # Workflow Plan: {{Workflow Name}}
2691
-
2692
- <!-- WORKFLOW-PLAN-META
2693
- workflow-id: {{workflow-id}}
2694
- status: active
2695
- created: {{ISO-8601 timestamp}}
2696
- updated: {{ISO-8601 timestamp}}
2697
- version: 1.0
2698
- -->
2699
-
2700
- **Created Date**: {{current date}}
2701
- **Project**: {{project name}}
2702
- **Type**: {{greenfield/brownfield}}
2703
- **Status**: Active
2704
- **Estimated Planning Duration**: {{time estimate}}
2705
-
2706
- ## Objective
2707
-
2708
- {{Clear description of what will be accomplished}}
2709
-
2710
- ## Selected Workflow
2711
-
2712
- **Workflow**: `{{workflow-id}}`
2713
- **Reason**: {{Why this workflow fits the user's needs}}
2714
-
2715
- ## Workflow Steps
2716
-
2717
- ### Planning Phase
2718
-
2719
- - [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
2720
- - **Agent**: {{agent name}}
2721
- - **Action**: {{what happens}}
2722
- - **Output**: {{what's created}}
2723
- - **User Input**: {{if any}}
2724
-
2725
- - [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
2726
- - **Agent**: {{agent name}}
2727
- - **Action**: {{what happens}}
2728
- - **Output**: {{what's created}}
2729
- - **Decision Point**: {{if any}} <!-- decision-id: D1 -->
2730
-
2731
- {{Continue for all planning steps}}
2732
-
2733
- ### Development Phase (IDE)
2734
-
2735
- - [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
2736
- - Prepare documents for story creation
2737
-
2738
- - [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
2739
- - [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
2740
- - [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
2741
- - [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
2742
- - [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
2743
- - [ ] Repeat for all stories
2744
-
2745
- - [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
2746
-
2747
- ## Key Decision Points
2748
-
2749
- 1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
2750
- - Trigger: {{what causes this decision}}
2751
- - Options: {{available choices}}
2752
- - Impact: {{how it affects the workflow}}
2753
- - Decision Made: _Pending_
2754
-
2755
- {{List all decision points}}
2756
-
2757
- ## Expected Outputs
2758
-
2759
- ### Planning Documents
2760
- - [ ] {{document 1}} - {{description}}
2761
- - [ ] {{document 2}} - {{description}}
2762
- {{etc...}}
2763
-
2764
- ### Development Artifacts
2765
- - [ ] Stories in `docs/stories/`
2766
- - [ ] Implementation code
2767
- - [ ] Tests
2768
- - [ ] Updated documentation
2769
-
2770
- ## Prerequisites Checklist
2771
-
2772
- Before starting this workflow, ensure you have:
2773
-
2774
- - [ ] {{prerequisite 1}}
2775
- - [ ] {{prerequisite 2}}
2776
- - [ ] {{prerequisite 3}}
2777
- {{etc...}}
2778
-
2779
- ## Customization Options
2780
-
2781
- Based on your project needs, you may:
2782
- - Skip {{optional step}} if {{condition}}
2783
- - Add {{additional step}} if {{condition}}
2784
- - Choose {{alternative}} instead of {{default}}
2785
-
2786
- ## Risk Considerations
2787
-
2788
- {{For brownfield only}}
2789
- - Integration complexity: {{assessment}}
2790
- - Rollback strategy: {{approach}}
2791
- - Testing requirements: {{special needs}}
2792
-
2793
- ## Next Steps
2794
-
2795
- 1. Review this plan and confirm it matches your expectations
2796
- 2. Gather any missing prerequisites
2797
- 3. Start workflow with: `*task workflow {{workflow-id}}`
2798
- 4. Or begin with first agent: `@{{first-agent}}`
2799
-
2800
- ## Notes
2801
-
2802
- {{Any additional context or warnings}}
2803
-
2804
- ---
2805
- *This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
2806
- ```
2807
-
2808
- ### 5. Save and Present Plan
2809
-
2810
- 1. Save the plan as `docs/workflow-plan.md`
2811
- 2. Inform user: "Workflow plan created at docs/workflow-plan.md"
2812
- 3. Offer options:
2813
- - Review the plan together
2814
- - Start the workflow now
2815
- - Gather prerequisites first
2816
- - Modify the plan
2817
-
2818
- ### 6. Plan Variations
2819
-
2820
- [[LLM: Adjust plan detail based on workflow complexity]]
2821
-
2822
- **For Simple Workflows** (create-story, create-epic):
2823
-
2824
- - Simpler checklist format
2825
- - Focus on immediate next steps
2826
- - Less detailed explanations
2827
-
2828
- **For Complex Workflows** (full greenfield/brownfield):
2829
-
2830
- - Detailed step breakdowns
2831
- - All decision points documented
2832
- - Comprehensive output descriptions
2833
- - Risk mitigation sections
2834
-
2835
- **For Brownfield Workflows**:
2836
-
2837
- - Include existing system impact analysis
2838
- - Document integration checkpoints
2839
- - Add rollback considerations
2840
- - Note documentation dependencies
2841
-
2842
- ### 7. Interactive Planning Mode
2843
-
2844
- [[LLM: If user wants to customize the workflow]]
2845
-
2846
- If user wants to modify the standard workflow:
2847
-
2848
- 1. Present workflow steps as options
2849
- 2. Allow skipping optional steps
2850
- 3. Let user reorder certain steps
2851
- 4. Document customizations in plan
2852
- 5. Warn about dependencies if steps are skipped
2853
-
2854
- ### 8. Execution Guidance
2855
-
2856
- After plan is created, provide clear guidance:
2857
-
2858
- ```text
2859
- Your workflow plan is ready! Here's how to proceed:
2860
-
2861
- 1. **Review the plan**: Check that all steps align with your goals
2862
- 2. **Gather prerequisites**: Use the checklist to ensure you're ready
2863
- 3. **Start execution**:
2864
- - Full workflow: `*task workflow {{workflow-id}}`
2865
- - Step by step: Start with `@{{first-agent}}`
2866
- 4. **Track progress**: Check off steps in the plan as completed
2867
-
2868
- Would you like to:
2869
- a) Review the plan together
2870
- b) Start the workflow now
2871
- c) Gather prerequisites first
2872
- d) Modify the plan
2873
- ```
2874
-
2875
- ## Success Criteria
2876
-
2877
- The workflow plan is successful when:
2878
-
2879
- 1. User clearly understands what will happen
2880
- 2. All decision points are documented
2881
- 3. Prerequisites are identified
2882
- 4. Expected outputs are clear
2883
- 5. User feels confident to proceed
2884
- 6. Plan serves as useful progress tracker
2885
-
2886
- ## Integration with BMad Master and Orchestrator
2887
-
2888
- When used by BMad Master or BMad Orchestrator, this task should:
2889
-
2890
- 1. Be offered when user asks about workflows
2891
- 2. Be suggested before starting complex workflows
2892
- 3. Create a plan that the agent can reference during execution
2893
- 4. Allow the agent to track progress against the plan
2894
-
2895
- ## Example Usage
2896
-
2897
- ```text
2898
- User: "I need to add a payment system to my existing app"
2899
-
2900
- BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
2901
-
2902
- [Runs through discovery questions]
2903
-
2904
- BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
2905
-
2906
- [Creates and saves plan]
2907
-
2908
- 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?"
2909
- ```
2910
- ==================== END: .bmad-2d-phaser-game-dev/tasks/create-workflow-plan.md ====================
2911
-
2912
2629
  ==================== START: .bmad-2d-phaser-game-dev/tasks/kb-mode-interaction.md ====================
2913
2630
  # KB Mode Interaction Task
2914
2631
 
2915
2632
  ## Purpose
2633
+
2916
2634
  Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
2917
2635
 
2918
2636
  ## Instructions
@@ -2920,11 +2638,11 @@ Provide a user-friendly interface to the BMad knowledge base without overwhelmin
2920
2638
  When entering KB mode (*kb-mode), follow these steps:
2921
2639
 
2922
2640
  ### 1. Welcome and Guide
2923
- Announce entering KB mode with a brief, friendly introduction:
2924
2641
 
2925
- "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."
2642
+ Announce entering KB mode with a brief, friendly introduction.
2926
2643
 
2927
2644
  ### 2. Present Topic Areas
2645
+
2928
2646
  Offer a concise list of main topic areas the user might want to explore:
2929
2647
 
2930
2648
  **What would you like to know more about?**
@@ -2941,19 +2659,23 @@ Offer a concise list of main topic areas the user might want to explore:
2941
2659
  Or ask me about anything else related to BMad-Method!
2942
2660
 
2943
2661
  ### 3. Respond Contextually
2662
+
2944
2663
  - Wait for user's specific question or topic selection
2945
2664
  - Provide focused, relevant information from the knowledge base
2946
2665
  - Offer to dive deeper or explore related topics
2947
2666
  - Keep responses concise unless user asks for detailed explanations
2948
2667
 
2949
2668
  ### 4. Interactive Exploration
2669
+
2950
2670
  - After answering, suggest related topics they might find helpful
2951
2671
  - Maintain conversational flow rather than data dumping
2952
2672
  - Use examples when appropriate
2953
2673
  - Reference specific documentation sections when relevant
2954
2674
 
2955
2675
  ### 5. Exit Gracefully
2676
+
2956
2677
  When user is done or wants to exit KB mode:
2678
+
2957
2679
  - Summarize key points discussed if helpful
2958
2680
  - Remind them they can return to KB mode anytime with *kb-mode
2959
2681
  - Suggest next steps based on what was discussed
@@ -2982,257 +2704,6 @@ Or ask me about anything else related to BMad-Method!
2982
2704
  **Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
2983
2705
  ==================== END: .bmad-2d-phaser-game-dev/tasks/kb-mode-interaction.md ====================
2984
2706
 
2985
- ==================== START: .bmad-2d-phaser-game-dev/tasks/update-workflow-plan.md ====================
2986
- # Update Workflow Plan Task
2987
-
2988
- ## Purpose
2989
-
2990
- Update the status of steps in an active workflow plan, mark completions, add notes about deviations, and maintain an accurate record of workflow progress. This task can be called directly by users or automatically by other tasks upon completion.
2991
-
2992
- ## Task Instructions
2993
-
2994
- ### 0. Load Plan Configuration
2995
-
2996
- [[LLM: First load core-config.yaml to get plan settings]]
2997
-
2998
- Check workflow configuration:
2999
-
3000
- - `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
3001
- - `workflow.trackProgress` - Whether tracking is enabled
3002
- - `workflow.updateOnCompletion` - Whether to auto-update on task completion
3003
-
3004
- If tracking is disabled, inform user and exit.
3005
-
3006
- ### 1. Verify Plan Exists
3007
-
3008
- [[LLM: Check if workflow plan exists at configured location]]
3009
-
3010
- If no plan exists:
3011
-
3012
- ```
3013
- No active workflow plan found at {location}.
3014
- Would you like to create one? Use *plan command.
3015
- ```
3016
-
3017
- ### 2. Determine Update Type
3018
-
3019
- [[LLM: Ask user what type of update they want to make]]
3020
-
3021
- Present options:
3022
-
3023
- ```
3024
- What would you like to update in the workflow plan?
3025
-
3026
- 1. Mark step as complete
3027
- 2. Update current step
3028
- 3. Add deviation note
3029
- 4. Mark decision point resolution
3030
- 5. Update overall status
3031
- 6. View current plan status only
3032
-
3033
- Please select an option (1-6):
3034
- ```
3035
-
3036
- ### 3. Parse Current Plan
3037
-
3038
- [[LLM: Read and parse the plan to understand current state]]
3039
-
3040
- Extract:
3041
-
3042
- - All steps with their checkbox status
3043
- - Step IDs from comments (if present)
3044
- - Current completion percentage
3045
- - Any existing deviation notes
3046
- - Decision points and their status
3047
-
3048
- ### 4. Execute Updates
3049
-
3050
- #### 4.1 Mark Step Complete
3051
-
3052
- If user selected option 1:
3053
-
3054
- 1. Show numbered list of incomplete steps
3055
- 2. Ask which step to mark complete
3056
- 3. Update the checkbox from `[ ]` to `[x]`
3057
- 4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
3058
- 5. If this was the current step, identify next step
3059
-
3060
- #### 4.2 Update Current Step
3061
-
3062
- If user selected option 2:
3063
-
3064
- 1. Show all steps with current status
3065
- 2. Ask which step is now current
3066
- 3. Add/move `<!-- current-step -->` marker
3067
- 4. Optionally add note about why sequence changed
3068
-
3069
- #### 4.3 Add Deviation Note
3070
-
3071
- If user selected option 3:
3072
-
3073
- 1. Ask for deviation description
3074
- 2. Ask which step this relates to (or general)
3075
- 3. Insert note in appropriate location:
3076
-
3077
- ```markdown
3078
- > **Deviation Note** (YYYY-MM-DD): {user_note}
3079
- > Related to: Step X.Y or General workflow
3080
- ```
3081
-
3082
- #### 4.4 Mark Decision Resolution
3083
-
3084
- If user selected option 4:
3085
-
3086
- 1. Show pending decision points
3087
- 2. Ask which decision was made
3088
- 3. Record the decision and chosen path
3089
- 4. Update related steps based on decision
3090
-
3091
- #### 4.5 Update Overall Status
3092
-
3093
- If user selected option 5:
3094
-
3095
- 1. Show current overall status
3096
- 2. Provide options:
3097
- - Active (continuing with plan)
3098
- - Paused (temporarily stopped)
3099
- - Abandoned (no longer following)
3100
- - Complete (all steps done)
3101
- 3. Update plan header with new status
3102
-
3103
- ### 5. Automatic Updates (When Called by Tasks)
3104
-
3105
- [[LLM: When called automatically by another task]]
3106
-
3107
- If called with parameters:
3108
-
3109
- ```
3110
- task: {task_name}
3111
- step_id: {step_identifier}
3112
- status: complete|skipped|failed
3113
- note: {optional_note}
3114
- ```
3115
-
3116
- Automatically:
3117
-
3118
- 1. Find the corresponding step
3119
- 2. Update its status
3120
- 3. Add completion metadata
3121
- 4. Add note if provided
3122
- 5. Calculate new progress percentage
3123
-
3124
- ### 6. Generate Update Summary
3125
-
3126
- After updates, show summary:
3127
-
3128
- ```
3129
- ✅ Workflow Plan Updated
3130
-
3131
- Changes made:
3132
- - {change_1}
3133
- - {change_2}
3134
-
3135
- New Status:
3136
- - Progress: {X}% complete ({completed}/{total} steps)
3137
- - Current Step: {current_step}
3138
- - Next Recommended: {next_step}
3139
-
3140
- Plan location: {file_path}
3141
- ```
3142
-
3143
- ### 7. Integration with Other Tasks
3144
-
3145
- [[LLM: How other tasks should call this]]
3146
-
3147
- Other tasks can integrate by:
3148
-
3149
- 1. **After Task Completion**:
3150
-
3151
- ```
3152
- At end of task execution:
3153
- - Check if task corresponds to a plan step
3154
- - If yes, call update-workflow-plan with:
3155
- - task: {current_task_name}
3156
- - step_id: {matching_step}
3157
- - status: complete
3158
- ```
3159
-
3160
- 2. **On Task Failure**:
3161
-
3162
- ```
3163
- If task fails:
3164
- - Call update-workflow-plan with:
3165
- - task: {current_task_name}
3166
- - status: failed
3167
- - note: {failure_reason}
3168
- ```
3169
-
3170
- ### 8. Plan Status Display
3171
-
3172
- [[LLM: When user selects view status only]]
3173
-
3174
- Display comprehensive status:
3175
-
3176
- ```markdown
3177
- 📋 Workflow Plan Status
3178
- ━━━━━━━━━━━━━━━━━━━━
3179
- Workflow: {workflow_name}
3180
- Status: {Active|Paused|Complete}
3181
- Progress: {X}% complete ({completed}/{total} steps)
3182
- Last Updated: {timestamp}
3183
-
3184
- ✅ Completed Steps:
3185
- - [x] Step 1.1: {description} (completed: {date})
3186
- - [x] Step 1.2: {description} (completed: {date})
3187
-
3188
- 🔄 Current Step:
3189
- - [ ] Step 2.1: {description} <!-- current-step -->
3190
- Agent: {agent_name}
3191
- Task: {task_name}
3192
-
3193
- 📌 Upcoming Steps:
3194
- - [ ] Step 2.2: {description}
3195
- - [ ] Step 3.1: {description}
3196
-
3197
- ⚠️ Deviations/Notes:
3198
- {any_deviation_notes}
3199
-
3200
- 📊 Decision Points:
3201
- - Decision 1: {status} - {choice_made}
3202
- - Decision 2: Pending
3203
-
3204
- 💡 Next Action:
3205
- Based on the plan, you should {recommended_action}
3206
- ```
3207
-
3208
- ## Success Criteria
3209
-
3210
- The update is successful when:
3211
-
3212
- 1. Plan accurately reflects current workflow state
3213
- 2. All updates are clearly timestamped
3214
- 3. Deviations are documented with reasons
3215
- 4. Progress calculation is correct
3216
- 5. Next steps are clear to user
3217
- 6. Plan remains readable and well-formatted
3218
-
3219
- ## Error Handling
3220
-
3221
- - **Plan file not found**: Offer to create new plan
3222
- - **Malformed plan**: Attempt basic updates, warn user
3223
- - **Write permission error**: Show changes that would be made
3224
- - **Step not found**: Show available steps, ask for clarification
3225
- - **Concurrent updates**: Implement simple locking or warn about conflicts
3226
-
3227
- ## Notes
3228
-
3229
- - Always preserve plan history (don't delete old information)
3230
- - Keep updates atomic to prevent corruption
3231
- - Consider creating backup before major updates
3232
- - Updates should enhance, not complicate, the workflow experience
3233
- - If plan becomes too cluttered, suggest creating fresh plan for next phase
3234
- ==================== END: .bmad-2d-phaser-game-dev/tasks/update-workflow-plan.md ====================
3235
-
3236
2707
  ==================== START: .bmad-2d-phaser-game-dev/data/elicitation-methods.md ====================
3237
2708
  # Elicitation Methods Data
3238
2709