bmad-method 4.12.0 → 4.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/CONTRIBUTING.md +128 -1
- package/GUIDING-PRINCIPLES.md +85 -0
- package/README.md +56 -6
- package/bmad-core/agents/analyst.md +3 -1
- package/bmad-core/agents/dev.md +3 -2
- package/bmad-core/agents/qa.md +15 -14
- package/bmad-core/data/bmad-kb.md +280 -19
- package/bmad-core/tasks/document-project.md +250 -322
- package/bmad-core/tasks/review-story.md +135 -0
- package/bmad-core/templates/story-tmpl.md +8 -0
- package/bmad-core/workflows/brownfield-fullstack.yml +36 -1
- package/bmad-core/workflows/brownfield-service.yml +36 -1
- package/bmad-core/workflows/brownfield-ui.yml +36 -1
- package/bmad-core/workflows/greenfield-fullstack.yml +36 -1
- package/bmad-core/workflows/greenfield-service.yml +36 -1
- package/bmad-core/workflows/greenfield-ui.yml +36 -1
- package/dist/agents/analyst.txt +227 -17
- package/dist/agents/bmad-master.txt +260 -24
- package/dist/agents/bmad-orchestrator.txt +227 -17
- package/dist/agents/dev.txt +6 -4
- package/dist/agents/pm.txt +25 -7
- package/dist/agents/po.txt +33 -7
- package/dist/agents/qa.txt +153 -14
- package/dist/agents/sm.txt +8 -0
- package/dist/expansion-packs/expansion-creator/agents/bmad-the-creator.txt +4 -12
- package/dist/teams/team-all.txt +635 -48
- package/dist/teams/team-fullstack.txt +476 -30
- package/dist/teams/team-ide-minimal.txt +419 -42
- package/dist/teams/team-no-ui.txt +332 -26
- package/docs/expansion-pack-ideas.md +121 -0
- package/docs/expansion-packs.md +265 -0
- package/docs/working-in-the-brownfield.md +362 -0
- package/expansion-packs/expansion-creator/tasks/create-agent.md +1 -1
- package/expansion-packs/expansion-creator/tasks/generate-expansion-pack.md +3 -11
- package/package.json +1 -1
- package/tools/installer/bin/bmad.js +12 -11
- package/tools/installer/config/install.config.yml +8 -3
- package/tools/installer/lib/ide-setup.js +71 -0
- package/tools/installer/package.json +1 -1
- package/tools/upgraders/v3-to-v4-upgrader.js +1 -0
|
@@ -765,6 +765,50 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
765
765
|
- **Quality Assurance**: Structured testing and validation
|
|
766
766
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
767
767
|
|
|
768
|
+
## How BMAD Works
|
|
769
|
+
|
|
770
|
+
### The Core Method
|
|
771
|
+
|
|
772
|
+
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
773
|
+
|
|
774
|
+
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
775
|
+
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
776
|
+
3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
|
|
777
|
+
4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
|
|
778
|
+
|
|
779
|
+
### The Two-Phase Approach
|
|
780
|
+
|
|
781
|
+
**Phase 1: Planning (Web UI - Cost Effective)**
|
|
782
|
+
- Use large context windows (Gemini's 1M tokens)
|
|
783
|
+
- Generate comprehensive documents (PRD, Architecture)
|
|
784
|
+
- Leverage multiple agents for brainstorming
|
|
785
|
+
- Create once, use throughout development
|
|
786
|
+
|
|
787
|
+
**Phase 2: Development (IDE - Implementation)**
|
|
788
|
+
- Shard documents into manageable pieces
|
|
789
|
+
- Execute focused SM → Dev cycles
|
|
790
|
+
- One story at a time, sequential progress
|
|
791
|
+
- Real-time file operations and testing
|
|
792
|
+
|
|
793
|
+
### The Development Loop
|
|
794
|
+
|
|
795
|
+
```text
|
|
796
|
+
1. SM Agent (New Chat) → Creates next story from sharded docs
|
|
797
|
+
2. You → Review and approve story
|
|
798
|
+
3. Dev Agent (New Chat) → Implements approved story
|
|
799
|
+
4. QA Agent (New Chat) → Reviews and refactors code
|
|
800
|
+
5. You → Verify completion
|
|
801
|
+
6. Repeat until epic complete
|
|
802
|
+
```
|
|
803
|
+
|
|
804
|
+
### Why This Works
|
|
805
|
+
|
|
806
|
+
- **Context Optimization**: Clean chats = better AI performance
|
|
807
|
+
- **Role Clarity**: Agents don't context-switch = higher quality
|
|
808
|
+
- **Incremental Progress**: Small stories = manageable complexity
|
|
809
|
+
- **Human Oversight**: You validate each step = quality control
|
|
810
|
+
- **Document-Driven**: Specs guide everything = consistency
|
|
811
|
+
|
|
768
812
|
## Getting Started
|
|
769
813
|
|
|
770
814
|
### Quick Start Options
|
|
@@ -779,7 +823,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
779
823
|
5. Type `/help` to see available commands
|
|
780
824
|
|
|
781
825
|
#### Option 2: IDE Integration
|
|
782
|
-
**Best for**: Cursor, Claude Code, Windsurf,
|
|
826
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code users
|
|
783
827
|
|
|
784
828
|
```bash
|
|
785
829
|
# Interactive installation (recommended)
|
|
@@ -788,13 +832,22 @@ npx bmad-method install
|
|
|
788
832
|
|
|
789
833
|
**Installation Steps**:
|
|
790
834
|
- Choose "Complete installation"
|
|
791
|
-
- Select your IDE
|
|
835
|
+
- Select your IDE from supported options:
|
|
836
|
+
- **Cursor**: Native AI integration
|
|
837
|
+
- **Claude Code**: Anthropic's official IDE
|
|
838
|
+
- **Windsurf**: Built-in AI capabilities
|
|
839
|
+
- **Cline**: VS Code extension with AI features
|
|
840
|
+
- **Roo Code**: Web-based IDE with agent support
|
|
841
|
+
|
|
842
|
+
**Note for VS Code Users**: BMAD-METHOD assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMAD agents. The installer includes built-in support for Cline and Roo.
|
|
792
843
|
|
|
793
844
|
**Verify Installation**:
|
|
794
845
|
- `.bmad-core/` folder created with all agents
|
|
795
846
|
- IDE-specific integration files created
|
|
796
847
|
- All agent commands/rules/modes available
|
|
797
848
|
|
|
849
|
+
**Remember**: At its core, BMAD-METHOD is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMAD - the framework provides the structured prompts and workflows that make AI development effective
|
|
850
|
+
|
|
798
851
|
### Environment Selection Guide
|
|
799
852
|
|
|
800
853
|
**Use Web UI for**:
|
|
@@ -811,6 +864,47 @@ npx bmad-method install
|
|
|
811
864
|
|
|
812
865
|
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
|
|
813
866
|
|
|
867
|
+
### IDE-Only Workflow Considerations
|
|
868
|
+
|
|
869
|
+
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
|
870
|
+
|
|
871
|
+
**Pros of IDE-Only**:
|
|
872
|
+
- Single environment workflow
|
|
873
|
+
- Direct file operations from start
|
|
874
|
+
- No copy/paste between environments
|
|
875
|
+
- Immediate project integration
|
|
876
|
+
|
|
877
|
+
**Cons of IDE-Only**:
|
|
878
|
+
- Higher token costs for large document creation
|
|
879
|
+
- Smaller context windows (varies by IDE/model)
|
|
880
|
+
- May hit limits during planning phases
|
|
881
|
+
- Less cost-effective for brainstorming
|
|
882
|
+
|
|
883
|
+
**Using Web Agents in IDE**:
|
|
884
|
+
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
|
885
|
+
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
|
886
|
+
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
|
887
|
+
|
|
888
|
+
**About bmad-master and bmad-orchestrator**:
|
|
889
|
+
- **bmad-master**: CAN do any task without switching agents, BUT...
|
|
890
|
+
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
|
891
|
+
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
|
892
|
+
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
|
893
|
+
|
|
894
|
+
**CRITICAL RULE for Development**:
|
|
895
|
+
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
|
896
|
+
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
|
897
|
+
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
|
898
|
+
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
|
899
|
+
|
|
900
|
+
**Best Practice for IDE-Only**:
|
|
901
|
+
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
|
902
|
+
2. Create documents directly in project
|
|
903
|
+
3. Shard immediately after creation
|
|
904
|
+
4. **MUST switch to SM agent** for story creation
|
|
905
|
+
5. **MUST switch to Dev agent** for implementation
|
|
906
|
+
6. Keep planning and coding in separate chat sessions
|
|
907
|
+
|
|
814
908
|
## Core Configuration (core-config.yml)
|
|
815
909
|
|
|
816
910
|
**New in V4**: The `bmad-core/core-config.yml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
@@ -1088,10 +1182,14 @@ that can handle [specific requirements]."
|
|
|
1088
1182
|
|
|
1089
1183
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
1090
1184
|
|
|
1091
|
-
1. **Document Sharding
|
|
1092
|
-
-
|
|
1093
|
-
-
|
|
1094
|
-
|
|
1185
|
+
1. **Document Sharding** (CRITICAL STEP):
|
|
1186
|
+
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
|
1187
|
+
- Two methods to shard:
|
|
1188
|
+
a) **Manual**: Drag `shard-doc` task + document file into chat
|
|
1189
|
+
b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
|
|
1190
|
+
- Shards `docs/prd.md` → `docs/prd/` folder
|
|
1191
|
+
- Shards `docs/architecture.md` → `docs/architecture/` folder
|
|
1192
|
+
- **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
|
|
1095
1193
|
|
|
1096
1194
|
2. **Verify Sharded Content**:
|
|
1097
1195
|
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
|
@@ -1105,19 +1203,34 @@ that can handle [specific requirements]."
|
|
|
1105
1203
|
|
|
1106
1204
|
3. **Development Cycle** (Sequential, one story at a time):
|
|
1107
1205
|
|
|
1108
|
-
**
|
|
1206
|
+
**CRITICAL CONTEXT MANAGEMENT**:
|
|
1207
|
+
- **Context windows matter!** Always use fresh, clean context windows
|
|
1208
|
+
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
|
1209
|
+
- **ALWAYS start new chat between SM, Dev, and QA work**
|
|
1210
|
+
|
|
1211
|
+
**Step 1 - Story Creation**:
|
|
1212
|
+
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
|
1109
1213
|
- SM executes create-next-story task
|
|
1110
1214
|
- Review generated story in `docs/stories/`
|
|
1111
1215
|
- Update status from "Draft" to "Approved"
|
|
1112
1216
|
|
|
1113
|
-
**Step 2 - Story Implementation**:
|
|
1217
|
+
**Step 2 - Story Implementation**:
|
|
1218
|
+
- **NEW CLEAN CHAT** → `@dev`
|
|
1114
1219
|
- Agent asks which story to implement
|
|
1115
1220
|
- Include story file content to save dev agent lookup time
|
|
1116
1221
|
- Dev follows tasks/subtasks, marking completion
|
|
1117
|
-
- Dev
|
|
1118
|
-
-
|
|
1222
|
+
- Dev maintains File List of all changes
|
|
1223
|
+
- Dev marks story as "Review" when complete with all tests passing
|
|
1119
1224
|
|
|
1120
|
-
**Step 3 -
|
|
1225
|
+
**Step 3 - Senior QA Review**:
|
|
1226
|
+
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
|
1227
|
+
- QA performs senior developer code review
|
|
1228
|
+
- QA can refactor and improve code directly
|
|
1229
|
+
- QA appends results to story's QA Results section
|
|
1230
|
+
- If approved: Status → "Done"
|
|
1231
|
+
- If changes needed: Status stays "Review" with unchecked items for dev
|
|
1232
|
+
|
|
1233
|
+
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
|
1121
1234
|
|
|
1122
1235
|
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
|
1123
1236
|
|
|
@@ -1137,12 +1250,27 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1137
1250
|
- Development execution
|
|
1138
1251
|
- Testing and deployment
|
|
1139
1252
|
|
|
1140
|
-
#### Brownfield Enhancement
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1253
|
+
#### Brownfield Enhancement (Existing Projects)
|
|
1254
|
+
|
|
1255
|
+
**Key Concept**: Brownfield development requires generating good documentation for agents to understand your existing project.
|
|
1256
|
+
|
|
1257
|
+
**Recommended Approach**:
|
|
1258
|
+
1. **Analysis Phase**: Use Gemini Web or AI Studio with their 1M+ context windows
|
|
1259
|
+
2. **Document Generation**: Ask Architect agent to analyze your project and run `document-project` task
|
|
1260
|
+
3. **PRD Creation**: Even brownfield projects typically need a PRD unless:
|
|
1261
|
+
- Very small, focused changes
|
|
1262
|
+
- Using `brownfield-create-epic` for single epic without full PRD
|
|
1263
|
+
4. **Architecture Assessment**: Use brownfield-specific templates for complex enhancements
|
|
1264
|
+
|
|
1265
|
+
**Brownfield Templates Available**:
|
|
1266
|
+
- `brownfield-prd-tmpl.md`: For substantial enhancements requiring multiple stories
|
|
1267
|
+
- `brownfield-architecture-tmpl.md`: For complex changes impacting system architecture
|
|
1268
|
+
- Both templates emphasize compatibility and integration with existing systems
|
|
1269
|
+
|
|
1270
|
+
**When to Skip PRD**:
|
|
1271
|
+
- For focused, single-epic work, use `brownfield-create-epic` task with detailed guidance
|
|
1272
|
+
- For one-off stories without larger context
|
|
1273
|
+
- Note: These tasks will evolve to require some documentation (potentially from `document-project`)
|
|
1146
1274
|
|
|
1147
1275
|
## Document Creation Best Practices
|
|
1148
1276
|
|
|
@@ -1223,12 +1351,94 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
1223
1351
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
1224
1352
|
- **Review everything** - Always review and approve before marking complete
|
|
1225
1353
|
|
|
1354
|
+
## Contributing to BMAD-METHOD
|
|
1355
|
+
|
|
1356
|
+
### Quick Contribution Guidelines
|
|
1357
|
+
|
|
1358
|
+
For full details, see `CONTRIBUTING.md`. Key points:
|
|
1359
|
+
|
|
1360
|
+
**Fork Workflow**:
|
|
1361
|
+
1. Fork the repository
|
|
1362
|
+
2. Create feature branches
|
|
1363
|
+
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
|
1364
|
+
4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
|
|
1365
|
+
5. One feature/fix per PR
|
|
1366
|
+
|
|
1367
|
+
**PR Requirements**:
|
|
1368
|
+
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
|
1369
|
+
- Use conventional commits (feat:, fix:, docs:)
|
|
1370
|
+
- Atomic commits - one logical change per commit
|
|
1371
|
+
- Must align with guiding principles
|
|
1372
|
+
|
|
1373
|
+
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
|
1374
|
+
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
|
1375
|
+
- **Natural Language First**: Everything in markdown, no code in core
|
|
1376
|
+
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
|
1377
|
+
- **Design Philosophy**: "Dev agents code, planning agents plan"
|
|
1378
|
+
|
|
1379
|
+
## Expansion Packs
|
|
1380
|
+
|
|
1381
|
+
### What Are Expansion Packs?
|
|
1382
|
+
|
|
1383
|
+
Expansion packs extend BMAD-METHOD beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
|
1384
|
+
|
|
1385
|
+
### Why Use Expansion Packs?
|
|
1386
|
+
|
|
1387
|
+
1. **Keep Core Lean**: Dev agents maintain maximum context for coding
|
|
1388
|
+
2. **Domain Expertise**: Deep, specialized knowledge without bloating core
|
|
1389
|
+
3. **Community Innovation**: Anyone can create and share packs
|
|
1390
|
+
4. **Modular Design**: Install only what you need
|
|
1391
|
+
|
|
1392
|
+
### Available Expansion Packs
|
|
1393
|
+
|
|
1394
|
+
**Technical Packs**:
|
|
1395
|
+
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
|
1396
|
+
- **Game Development**: Game designers, level designers, narrative writers
|
|
1397
|
+
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
|
1398
|
+
- **Data Science**: ML engineers, data scientists, visualization experts
|
|
1399
|
+
|
|
1400
|
+
**Non-Technical Packs**:
|
|
1401
|
+
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
|
1402
|
+
- **Creative Writing**: Plot architects, character developers, world builders
|
|
1403
|
+
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
|
1404
|
+
- **Education**: Curriculum designers, assessment specialists
|
|
1405
|
+
- **Legal Support**: Contract analysts, compliance checkers
|
|
1406
|
+
|
|
1407
|
+
**Specialty Packs**:
|
|
1408
|
+
- **Expansion Creator**: Tools to build your own expansion packs
|
|
1409
|
+
- **RPG Game Master**: Tabletop gaming assistance
|
|
1410
|
+
- **Life Event Planning**: Wedding planners, event coordinators
|
|
1411
|
+
- **Scientific Research**: Literature reviewers, methodology designers
|
|
1412
|
+
|
|
1413
|
+
### Using Expansion Packs
|
|
1414
|
+
|
|
1415
|
+
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
1416
|
+
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
|
1417
|
+
3. **Install via CLI**:
|
|
1418
|
+
```bash
|
|
1419
|
+
npx bmad-method install
|
|
1420
|
+
# Select "Install expansion pack" option
|
|
1421
|
+
```
|
|
1422
|
+
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
|
1423
|
+
|
|
1424
|
+
### Creating Custom Expansion Packs
|
|
1425
|
+
|
|
1426
|
+
Use the **expansion-creator** pack to build your own:
|
|
1427
|
+
|
|
1428
|
+
1. **Define Domain**: What expertise are you capturing?
|
|
1429
|
+
2. **Design Agents**: Create specialized roles with clear boundaries
|
|
1430
|
+
3. **Build Resources**: Tasks, templates, checklists for your domain
|
|
1431
|
+
4. **Test & Share**: Validate with real use cases, share with community
|
|
1432
|
+
|
|
1433
|
+
**Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
|
|
1434
|
+
|
|
1226
1435
|
## Getting Help
|
|
1227
1436
|
|
|
1228
1437
|
- **Commands**: Use `/help` in any environment to see available commands
|
|
1229
1438
|
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
|
1230
1439
|
- **Documentation**: Check `docs/` folder for project-specific context
|
|
1231
1440
|
- **Community**: Discord and GitHub resources available for support
|
|
1441
|
+
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
|
1232
1442
|
==================== END: data#bmad-kb ====================
|
|
1233
1443
|
|
|
1234
1444
|
==================== START: utils#workflow-management ====================
|
|
@@ -3322,9 +3532,27 @@ The LLM will:
|
|
|
3322
3532
|
- Create a folder structure to organize the sharded documents
|
|
3323
3533
|
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
|
3324
3534
|
|
|
3325
|
-
##
|
|
3535
|
+
## Primary Method: Automatic with markdown-tree
|
|
3536
|
+
|
|
3537
|
+
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
3538
|
+
|
|
3539
|
+
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
3540
|
+
|
|
3541
|
+
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
|
3542
|
+
|
|
3543
|
+
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
3544
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
|
3545
|
+
|
|
3546
|
+
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
3326
3547
|
|
|
3327
|
-
|
|
3548
|
+
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
3549
|
+
|
|
3550
|
+
1. Set markdownExploder to true in bmad-core/core-config.yml
|
|
3551
|
+
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
3552
|
+
|
|
3553
|
+
I will now proceed with the manual sharding process."
|
|
3554
|
+
|
|
3555
|
+
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
|
3328
3556
|
|
|
3329
3557
|
### Installation and Usage
|
|
3330
3558
|
|
|
@@ -3357,19 +3585,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
3357
3585
|
|
|
3358
3586
|
---
|
|
3359
3587
|
|
|
3360
|
-
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
|
3588
|
+
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
3361
3589
|
|
|
3362
3590
|
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
3363
3591
|
|
|
3364
3592
|
### Task Instructions
|
|
3365
3593
|
|
|
3366
|
-
|
|
3594
|
+
1. Identify Document and Target Location
|
|
3367
3595
|
|
|
3368
3596
|
- Determine which document to shard (user-provided path)
|
|
3369
3597
|
- Create a new folder under `docs/` with the same name as the document (without extension)
|
|
3370
3598
|
- Example: `docs/prd.md` → create folder `docs/prd/`
|
|
3371
3599
|
|
|
3372
|
-
|
|
3600
|
+
2. Parse and Extract Sections
|
|
3373
3601
|
|
|
3374
3602
|
[[LLM: When sharding the document:
|
|
3375
3603
|
|
|
@@ -3379,7 +3607,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
3379
3607
|
- Extract the section heading and ALL content until the next level 2 section
|
|
3380
3608
|
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
|
3381
3609
|
- Be extremely careful with:
|
|
3382
|
-
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
|
3610
|
+
- Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
|
|
3383
3611
|
- Mermaid diagrams - preserve the complete diagram syntax
|
|
3384
3612
|
- Nested markdown elements
|
|
3385
3613
|
- Multi-line content that might contain ## inside code blocks
|
|
@@ -3398,7 +3626,7 @@ For each extracted section:
|
|
|
3398
3626
|
|
|
3399
3627
|
2. **Adjust heading levels**:
|
|
3400
3628
|
|
|
3401
|
-
- The level 2 heading becomes level 1 (# instead of ##)
|
|
3629
|
+
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
3402
3630
|
- All subsection levels decrease by 1:
|
|
3403
3631
|
|
|
3404
3632
|
```txt
|
|
@@ -8396,6 +8624,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
8396
8624
|
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
8397
8625
|
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
8398
8626
|
|
|
8627
|
+
### File List
|
|
8628
|
+
|
|
8629
|
+
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
|
8630
|
+
|
|
8399
8631
|
### Change Log
|
|
8400
8632
|
|
|
8401
8633
|
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
@@ -8403,6 +8635,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
8403
8635
|
|
|
8404
8636
|
| Date | Version | Description | Author |
|
|
8405
8637
|
| :--- | :------ | :---------- | :----- |
|
|
8638
|
+
|
|
8639
|
+
## QA Results
|
|
8640
|
+
|
|
8641
|
+
[[LLM: QA Agent Results]]
|
|
8406
8642
|
==================== END: templates#story-tmpl ====================
|
|
8407
8643
|
|
|
8408
8644
|
==================== START: checklists#po-master-checklist ====================
|
|
@@ -8894,7 +9130,42 @@ workflow:
|
|
|
8894
9130
|
|
|
8895
9131
|
- workflow_end:
|
|
8896
9132
|
action: move_to_ide
|
|
8897
|
-
notes:
|
|
9133
|
+
notes: |
|
|
9134
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9135
|
+
|
|
9136
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9137
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9138
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9139
|
+
- All documents must be in the project before proceeding
|
|
9140
|
+
|
|
9141
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9142
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9143
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9144
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9145
|
+
|
|
9146
|
+
3. START DEVELOPMENT CYCLE:
|
|
9147
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9148
|
+
- Creates next story from sharded docs
|
|
9149
|
+
- Review and approve story (Draft → Approved)
|
|
9150
|
+
|
|
9151
|
+
b. Dev Agent (New Chat): @dev
|
|
9152
|
+
- Implements approved story
|
|
9153
|
+
- Updates File List with all changes
|
|
9154
|
+
- Marks story as "Review" when complete
|
|
9155
|
+
|
|
9156
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9157
|
+
- Senior dev review with refactoring ability
|
|
9158
|
+
- Fixes small issues directly
|
|
9159
|
+
- Leaves checklist for remaining items
|
|
9160
|
+
- Updates story status (Review → Done or stays Review)
|
|
9161
|
+
|
|
9162
|
+
d. If QA left unchecked items:
|
|
9163
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9164
|
+
- Return to QA for final approval
|
|
9165
|
+
|
|
9166
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9167
|
+
|
|
9168
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
8898
9169
|
|
|
8899
9170
|
flow_diagram: |
|
|
8900
9171
|
```mermaid
|
|
@@ -8975,7 +9246,42 @@ workflow:
|
|
|
8975
9246
|
|
|
8976
9247
|
- workflow_end:
|
|
8977
9248
|
action: move_to_ide
|
|
8978
|
-
notes:
|
|
9249
|
+
notes: |
|
|
9250
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9251
|
+
|
|
9252
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9253
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9254
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9255
|
+
- All documents must be in the project before proceeding
|
|
9256
|
+
|
|
9257
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9258
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9259
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9260
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9261
|
+
|
|
9262
|
+
3. START DEVELOPMENT CYCLE:
|
|
9263
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9264
|
+
- Creates next story from sharded docs
|
|
9265
|
+
- Review and approve story (Draft → Approved)
|
|
9266
|
+
|
|
9267
|
+
b. Dev Agent (New Chat): @dev
|
|
9268
|
+
- Implements approved story
|
|
9269
|
+
- Updates File List with all changes
|
|
9270
|
+
- Marks story as "Review" when complete
|
|
9271
|
+
|
|
9272
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9273
|
+
- Senior dev review with refactoring ability
|
|
9274
|
+
- Fixes small issues directly
|
|
9275
|
+
- Leaves checklist for remaining items
|
|
9276
|
+
- Updates story status (Review → Done or stays Review)
|
|
9277
|
+
|
|
9278
|
+
d. If QA left unchecked items:
|
|
9279
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9280
|
+
- Return to QA for final approval
|
|
9281
|
+
|
|
9282
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9283
|
+
|
|
9284
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
8979
9285
|
|
|
8980
9286
|
flow_diagram: |
|
|
8981
9287
|
```mermaid
|
|
@@ -9063,7 +9369,42 @@ workflow:
|
|
|
9063
9369
|
|
|
9064
9370
|
- workflow_end:
|
|
9065
9371
|
action: move_to_ide
|
|
9066
|
-
notes:
|
|
9372
|
+
notes: |
|
|
9373
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9374
|
+
|
|
9375
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9376
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9377
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9378
|
+
- All documents must be in the project before proceeding
|
|
9379
|
+
|
|
9380
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9381
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9382
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9383
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9384
|
+
|
|
9385
|
+
3. START DEVELOPMENT CYCLE:
|
|
9386
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9387
|
+
- Creates next story from sharded docs
|
|
9388
|
+
- Review and approve story (Draft → Approved)
|
|
9389
|
+
|
|
9390
|
+
b. Dev Agent (New Chat): @dev
|
|
9391
|
+
- Implements approved story
|
|
9392
|
+
- Updates File List with all changes
|
|
9393
|
+
- Marks story as "Review" when complete
|
|
9394
|
+
|
|
9395
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9396
|
+
- Senior dev review with refactoring ability
|
|
9397
|
+
- Fixes small issues directly
|
|
9398
|
+
- Leaves checklist for remaining items
|
|
9399
|
+
- Updates story status (Review → Done or stays Review)
|
|
9400
|
+
|
|
9401
|
+
d. If QA left unchecked items:
|
|
9402
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9403
|
+
- Return to QA for final approval
|
|
9404
|
+
|
|
9405
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9406
|
+
|
|
9407
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
9067
9408
|
|
|
9068
9409
|
flow_diagram: |
|
|
9069
9410
|
```mermaid
|
|
@@ -9179,7 +9520,42 @@ workflow:
|
|
|
9179
9520
|
|
|
9180
9521
|
- workflow_end:
|
|
9181
9522
|
action: move_to_ide
|
|
9182
|
-
notes:
|
|
9523
|
+
notes: |
|
|
9524
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9525
|
+
|
|
9526
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9527
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9528
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9529
|
+
- All documents must be in the project before proceeding
|
|
9530
|
+
|
|
9531
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9532
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9533
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9534
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9535
|
+
|
|
9536
|
+
3. START DEVELOPMENT CYCLE:
|
|
9537
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9538
|
+
- Creates next story from sharded docs
|
|
9539
|
+
- Review and approve story (Draft → Approved)
|
|
9540
|
+
|
|
9541
|
+
b. Dev Agent (New Chat): @dev
|
|
9542
|
+
- Implements approved story
|
|
9543
|
+
- Updates File List with all changes
|
|
9544
|
+
- Marks story as "Review" when complete
|
|
9545
|
+
|
|
9546
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9547
|
+
- Senior dev review with refactoring ability
|
|
9548
|
+
- Fixes small issues directly
|
|
9549
|
+
- Leaves checklist for remaining items
|
|
9550
|
+
- Updates story status (Review → Done or stays Review)
|
|
9551
|
+
|
|
9552
|
+
d. If QA left unchecked items:
|
|
9553
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9554
|
+
- Return to QA for final approval
|
|
9555
|
+
|
|
9556
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9557
|
+
|
|
9558
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
9183
9559
|
|
|
9184
9560
|
flow_diagram: |
|
|
9185
9561
|
```mermaid
|
|
@@ -9289,7 +9665,42 @@ workflow:
|
|
|
9289
9665
|
|
|
9290
9666
|
- workflow_end:
|
|
9291
9667
|
action: move_to_ide
|
|
9292
|
-
notes:
|
|
9668
|
+
notes: |
|
|
9669
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9670
|
+
|
|
9671
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9672
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9673
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9674
|
+
- All documents must be in the project before proceeding
|
|
9675
|
+
|
|
9676
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9677
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9678
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9679
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9680
|
+
|
|
9681
|
+
3. START DEVELOPMENT CYCLE:
|
|
9682
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9683
|
+
- Creates next story from sharded docs
|
|
9684
|
+
- Review and approve story (Draft → Approved)
|
|
9685
|
+
|
|
9686
|
+
b. Dev Agent (New Chat): @dev
|
|
9687
|
+
- Implements approved story
|
|
9688
|
+
- Updates File List with all changes
|
|
9689
|
+
- Marks story as "Review" when complete
|
|
9690
|
+
|
|
9691
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9692
|
+
- Senior dev review with refactoring ability
|
|
9693
|
+
- Fixes small issues directly
|
|
9694
|
+
- Leaves checklist for remaining items
|
|
9695
|
+
- Updates story status (Review → Done or stays Review)
|
|
9696
|
+
|
|
9697
|
+
d. If QA left unchecked items:
|
|
9698
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9699
|
+
- Return to QA for final approval
|
|
9700
|
+
|
|
9701
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9702
|
+
|
|
9703
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
9293
9704
|
|
|
9294
9705
|
flow_diagram: |
|
|
9295
9706
|
```mermaid
|
|
@@ -9408,7 +9819,42 @@ workflow:
|
|
|
9408
9819
|
|
|
9409
9820
|
- workflow_end:
|
|
9410
9821
|
action: move_to_ide
|
|
9411
|
-
notes:
|
|
9822
|
+
notes: |
|
|
9823
|
+
Planning phase complete! Now transition to IDE Development:
|
|
9824
|
+
|
|
9825
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
9826
|
+
- Copy final prd.md to project's docs/prd.md
|
|
9827
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
9828
|
+
- All documents must be in the project before proceeding
|
|
9829
|
+
|
|
9830
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
9831
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
9832
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
9833
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
9834
|
+
|
|
9835
|
+
3. START DEVELOPMENT CYCLE:
|
|
9836
|
+
a. SM Agent (New Chat): @sm → *create
|
|
9837
|
+
- Creates next story from sharded docs
|
|
9838
|
+
- Review and approve story (Draft → Approved)
|
|
9839
|
+
|
|
9840
|
+
b. Dev Agent (New Chat): @dev
|
|
9841
|
+
- Implements approved story
|
|
9842
|
+
- Updates File List with all changes
|
|
9843
|
+
- Marks story as "Review" when complete
|
|
9844
|
+
|
|
9845
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
9846
|
+
- Senior dev review with refactoring ability
|
|
9847
|
+
- Fixes small issues directly
|
|
9848
|
+
- Leaves checklist for remaining items
|
|
9849
|
+
- Updates story status (Review → Done or stays Review)
|
|
9850
|
+
|
|
9851
|
+
d. If QA left unchecked items:
|
|
9852
|
+
- Dev Agent (New Chat): Address remaining items
|
|
9853
|
+
- Return to QA for final approval
|
|
9854
|
+
|
|
9855
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
9856
|
+
|
|
9857
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
9412
9858
|
|
|
9413
9859
|
flow_diagram: |
|
|
9414
9860
|
```mermaid
|