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
|
@@ -697,6 +697,50 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
697
697
|
- **Quality Assurance**: Structured testing and validation
|
|
698
698
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
699
699
|
|
|
700
|
+
## How BMAD Works
|
|
701
|
+
|
|
702
|
+
### The Core Method
|
|
703
|
+
|
|
704
|
+
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
705
|
+
|
|
706
|
+
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
707
|
+
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
708
|
+
3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
|
|
709
|
+
4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
|
|
710
|
+
|
|
711
|
+
### The Two-Phase Approach
|
|
712
|
+
|
|
713
|
+
**Phase 1: Planning (Web UI - Cost Effective)**
|
|
714
|
+
- Use large context windows (Gemini's 1M tokens)
|
|
715
|
+
- Generate comprehensive documents (PRD, Architecture)
|
|
716
|
+
- Leverage multiple agents for brainstorming
|
|
717
|
+
- Create once, use throughout development
|
|
718
|
+
|
|
719
|
+
**Phase 2: Development (IDE - Implementation)**
|
|
720
|
+
- Shard documents into manageable pieces
|
|
721
|
+
- Execute focused SM → Dev cycles
|
|
722
|
+
- One story at a time, sequential progress
|
|
723
|
+
- Real-time file operations and testing
|
|
724
|
+
|
|
725
|
+
### The Development Loop
|
|
726
|
+
|
|
727
|
+
```text
|
|
728
|
+
1. SM Agent (New Chat) → Creates next story from sharded docs
|
|
729
|
+
2. You → Review and approve story
|
|
730
|
+
3. Dev Agent (New Chat) → Implements approved story
|
|
731
|
+
4. QA Agent (New Chat) → Reviews and refactors code
|
|
732
|
+
5. You → Verify completion
|
|
733
|
+
6. Repeat until epic complete
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### Why This Works
|
|
737
|
+
|
|
738
|
+
- **Context Optimization**: Clean chats = better AI performance
|
|
739
|
+
- **Role Clarity**: Agents don't context-switch = higher quality
|
|
740
|
+
- **Incremental Progress**: Small stories = manageable complexity
|
|
741
|
+
- **Human Oversight**: You validate each step = quality control
|
|
742
|
+
- **Document-Driven**: Specs guide everything = consistency
|
|
743
|
+
|
|
700
744
|
## Getting Started
|
|
701
745
|
|
|
702
746
|
### Quick Start Options
|
|
@@ -711,7 +755,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
711
755
|
5. Type `/help` to see available commands
|
|
712
756
|
|
|
713
757
|
#### Option 2: IDE Integration
|
|
714
|
-
**Best for**: Cursor, Claude Code, Windsurf,
|
|
758
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code users
|
|
715
759
|
|
|
716
760
|
```bash
|
|
717
761
|
# Interactive installation (recommended)
|
|
@@ -720,13 +764,22 @@ npx bmad-method install
|
|
|
720
764
|
|
|
721
765
|
**Installation Steps**:
|
|
722
766
|
- Choose "Complete installation"
|
|
723
|
-
- Select your IDE
|
|
767
|
+
- Select your IDE from supported options:
|
|
768
|
+
- **Cursor**: Native AI integration
|
|
769
|
+
- **Claude Code**: Anthropic's official IDE
|
|
770
|
+
- **Windsurf**: Built-in AI capabilities
|
|
771
|
+
- **Cline**: VS Code extension with AI features
|
|
772
|
+
- **Roo Code**: Web-based IDE with agent support
|
|
773
|
+
|
|
774
|
+
**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.
|
|
724
775
|
|
|
725
776
|
**Verify Installation**:
|
|
726
777
|
- `.bmad-core/` folder created with all agents
|
|
727
778
|
- IDE-specific integration files created
|
|
728
779
|
- All agent commands/rules/modes available
|
|
729
780
|
|
|
781
|
+
**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
|
|
782
|
+
|
|
730
783
|
### Environment Selection Guide
|
|
731
784
|
|
|
732
785
|
**Use Web UI for**:
|
|
@@ -743,6 +796,47 @@ npx bmad-method install
|
|
|
743
796
|
|
|
744
797
|
**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.
|
|
745
798
|
|
|
799
|
+
### IDE-Only Workflow Considerations
|
|
800
|
+
|
|
801
|
+
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
|
802
|
+
|
|
803
|
+
**Pros of IDE-Only**:
|
|
804
|
+
- Single environment workflow
|
|
805
|
+
- Direct file operations from start
|
|
806
|
+
- No copy/paste between environments
|
|
807
|
+
- Immediate project integration
|
|
808
|
+
|
|
809
|
+
**Cons of IDE-Only**:
|
|
810
|
+
- Higher token costs for large document creation
|
|
811
|
+
- Smaller context windows (varies by IDE/model)
|
|
812
|
+
- May hit limits during planning phases
|
|
813
|
+
- Less cost-effective for brainstorming
|
|
814
|
+
|
|
815
|
+
**Using Web Agents in IDE**:
|
|
816
|
+
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
|
817
|
+
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
|
818
|
+
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
|
819
|
+
|
|
820
|
+
**About bmad-master and bmad-orchestrator**:
|
|
821
|
+
- **bmad-master**: CAN do any task without switching agents, BUT...
|
|
822
|
+
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
|
823
|
+
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
|
824
|
+
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
|
825
|
+
|
|
826
|
+
**CRITICAL RULE for Development**:
|
|
827
|
+
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
|
828
|
+
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
|
829
|
+
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
|
830
|
+
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
|
831
|
+
|
|
832
|
+
**Best Practice for IDE-Only**:
|
|
833
|
+
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
|
834
|
+
2. Create documents directly in project
|
|
835
|
+
3. Shard immediately after creation
|
|
836
|
+
4. **MUST switch to SM agent** for story creation
|
|
837
|
+
5. **MUST switch to Dev agent** for implementation
|
|
838
|
+
6. Keep planning and coding in separate chat sessions
|
|
839
|
+
|
|
746
840
|
## Core Configuration (core-config.yml)
|
|
747
841
|
|
|
748
842
|
**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.
|
|
@@ -1020,10 +1114,14 @@ that can handle [specific requirements]."
|
|
|
1020
1114
|
|
|
1021
1115
|
**Prerequisites**: Planning documents must exist in `docs/` folder
|
|
1022
1116
|
|
|
1023
|
-
1. **Document Sharding
|
|
1024
|
-
-
|
|
1025
|
-
-
|
|
1026
|
-
|
|
1117
|
+
1. **Document Sharding** (CRITICAL STEP):
|
|
1118
|
+
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
|
1119
|
+
- Two methods to shard:
|
|
1120
|
+
a) **Manual**: Drag `shard-doc` task + document file into chat
|
|
1121
|
+
b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
|
|
1122
|
+
- Shards `docs/prd.md` → `docs/prd/` folder
|
|
1123
|
+
- Shards `docs/architecture.md` → `docs/architecture/` folder
|
|
1124
|
+
- **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
|
|
1027
1125
|
|
|
1028
1126
|
2. **Verify Sharded Content**:
|
|
1029
1127
|
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
|
@@ -1037,19 +1135,34 @@ that can handle [specific requirements]."
|
|
|
1037
1135
|
|
|
1038
1136
|
3. **Development Cycle** (Sequential, one story at a time):
|
|
1039
1137
|
|
|
1040
|
-
**
|
|
1138
|
+
**CRITICAL CONTEXT MANAGEMENT**:
|
|
1139
|
+
- **Context windows matter!** Always use fresh, clean context windows
|
|
1140
|
+
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
|
1141
|
+
- **ALWAYS start new chat between SM, Dev, and QA work**
|
|
1142
|
+
|
|
1143
|
+
**Step 1 - Story Creation**:
|
|
1144
|
+
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
|
1041
1145
|
- SM executes create-next-story task
|
|
1042
1146
|
- Review generated story in `docs/stories/`
|
|
1043
1147
|
- Update status from "Draft" to "Approved"
|
|
1044
1148
|
|
|
1045
|
-
**Step 2 - Story Implementation**:
|
|
1149
|
+
**Step 2 - Story Implementation**:
|
|
1150
|
+
- **NEW CLEAN CHAT** → `@dev`
|
|
1046
1151
|
- Agent asks which story to implement
|
|
1047
1152
|
- Include story file content to save dev agent lookup time
|
|
1048
1153
|
- Dev follows tasks/subtasks, marking completion
|
|
1049
|
-
- Dev
|
|
1050
|
-
-
|
|
1154
|
+
- Dev maintains File List of all changes
|
|
1155
|
+
- Dev marks story as "Review" when complete with all tests passing
|
|
1051
1156
|
|
|
1052
|
-
**Step 3 -
|
|
1157
|
+
**Step 3 - Senior QA Review**:
|
|
1158
|
+
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
|
1159
|
+
- QA performs senior developer code review
|
|
1160
|
+
- QA can refactor and improve code directly
|
|
1161
|
+
- QA appends results to story's QA Results section
|
|
1162
|
+
- If approved: Status → "Done"
|
|
1163
|
+
- If changes needed: Status stays "Review" with unchecked items for dev
|
|
1164
|
+
|
|
1165
|
+
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
|
1053
1166
|
|
|
1054
1167
|
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
|
1055
1168
|
|
|
@@ -1069,12 +1182,27 @@ Each status change requires user verification and approval before proceeding.
|
|
|
1069
1182
|
- Development execution
|
|
1070
1183
|
- Testing and deployment
|
|
1071
1184
|
|
|
1072
|
-
#### Brownfield Enhancement
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1185
|
+
#### Brownfield Enhancement (Existing Projects)
|
|
1186
|
+
|
|
1187
|
+
**Key Concept**: Brownfield development requires generating good documentation for agents to understand your existing project.
|
|
1188
|
+
|
|
1189
|
+
**Recommended Approach**:
|
|
1190
|
+
1. **Analysis Phase**: Use Gemini Web or AI Studio with their 1M+ context windows
|
|
1191
|
+
2. **Document Generation**: Ask Architect agent to analyze your project and run `document-project` task
|
|
1192
|
+
3. **PRD Creation**: Even brownfield projects typically need a PRD unless:
|
|
1193
|
+
- Very small, focused changes
|
|
1194
|
+
- Using `brownfield-create-epic` for single epic without full PRD
|
|
1195
|
+
4. **Architecture Assessment**: Use brownfield-specific templates for complex enhancements
|
|
1196
|
+
|
|
1197
|
+
**Brownfield Templates Available**:
|
|
1198
|
+
- `brownfield-prd-tmpl.md`: For substantial enhancements requiring multiple stories
|
|
1199
|
+
- `brownfield-architecture-tmpl.md`: For complex changes impacting system architecture
|
|
1200
|
+
- Both templates emphasize compatibility and integration with existing systems
|
|
1201
|
+
|
|
1202
|
+
**When to Skip PRD**:
|
|
1203
|
+
- For focused, single-epic work, use `brownfield-create-epic` task with detailed guidance
|
|
1204
|
+
- For one-off stories without larger context
|
|
1205
|
+
- Note: These tasks will evolve to require some documentation (potentially from `document-project`)
|
|
1078
1206
|
|
|
1079
1207
|
## Document Creation Best Practices
|
|
1080
1208
|
|
|
@@ -1155,12 +1283,94 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
1155
1283
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
1156
1284
|
- **Review everything** - Always review and approve before marking complete
|
|
1157
1285
|
|
|
1286
|
+
## Contributing to BMAD-METHOD
|
|
1287
|
+
|
|
1288
|
+
### Quick Contribution Guidelines
|
|
1289
|
+
|
|
1290
|
+
For full details, see `CONTRIBUTING.md`. Key points:
|
|
1291
|
+
|
|
1292
|
+
**Fork Workflow**:
|
|
1293
|
+
1. Fork the repository
|
|
1294
|
+
2. Create feature branches
|
|
1295
|
+
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
|
1296
|
+
4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
|
|
1297
|
+
5. One feature/fix per PR
|
|
1298
|
+
|
|
1299
|
+
**PR Requirements**:
|
|
1300
|
+
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
|
1301
|
+
- Use conventional commits (feat:, fix:, docs:)
|
|
1302
|
+
- Atomic commits - one logical change per commit
|
|
1303
|
+
- Must align with guiding principles
|
|
1304
|
+
|
|
1305
|
+
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
|
1306
|
+
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
|
1307
|
+
- **Natural Language First**: Everything in markdown, no code in core
|
|
1308
|
+
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
|
1309
|
+
- **Design Philosophy**: "Dev agents code, planning agents plan"
|
|
1310
|
+
|
|
1311
|
+
## Expansion Packs
|
|
1312
|
+
|
|
1313
|
+
### What Are Expansion Packs?
|
|
1314
|
+
|
|
1315
|
+
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.
|
|
1316
|
+
|
|
1317
|
+
### Why Use Expansion Packs?
|
|
1318
|
+
|
|
1319
|
+
1. **Keep Core Lean**: Dev agents maintain maximum context for coding
|
|
1320
|
+
2. **Domain Expertise**: Deep, specialized knowledge without bloating core
|
|
1321
|
+
3. **Community Innovation**: Anyone can create and share packs
|
|
1322
|
+
4. **Modular Design**: Install only what you need
|
|
1323
|
+
|
|
1324
|
+
### Available Expansion Packs
|
|
1325
|
+
|
|
1326
|
+
**Technical Packs**:
|
|
1327
|
+
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
|
1328
|
+
- **Game Development**: Game designers, level designers, narrative writers
|
|
1329
|
+
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
|
1330
|
+
- **Data Science**: ML engineers, data scientists, visualization experts
|
|
1331
|
+
|
|
1332
|
+
**Non-Technical Packs**:
|
|
1333
|
+
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
|
1334
|
+
- **Creative Writing**: Plot architects, character developers, world builders
|
|
1335
|
+
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
|
1336
|
+
- **Education**: Curriculum designers, assessment specialists
|
|
1337
|
+
- **Legal Support**: Contract analysts, compliance checkers
|
|
1338
|
+
|
|
1339
|
+
**Specialty Packs**:
|
|
1340
|
+
- **Expansion Creator**: Tools to build your own expansion packs
|
|
1341
|
+
- **RPG Game Master**: Tabletop gaming assistance
|
|
1342
|
+
- **Life Event Planning**: Wedding planners, event coordinators
|
|
1343
|
+
- **Scientific Research**: Literature reviewers, methodology designers
|
|
1344
|
+
|
|
1345
|
+
### Using Expansion Packs
|
|
1346
|
+
|
|
1347
|
+
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
1348
|
+
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
|
1349
|
+
3. **Install via CLI**:
|
|
1350
|
+
```bash
|
|
1351
|
+
npx bmad-method install
|
|
1352
|
+
# Select "Install expansion pack" option
|
|
1353
|
+
```
|
|
1354
|
+
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
|
1355
|
+
|
|
1356
|
+
### Creating Custom Expansion Packs
|
|
1357
|
+
|
|
1358
|
+
Use the **expansion-creator** pack to build your own:
|
|
1359
|
+
|
|
1360
|
+
1. **Define Domain**: What expertise are you capturing?
|
|
1361
|
+
2. **Design Agents**: Create specialized roles with clear boundaries
|
|
1362
|
+
3. **Build Resources**: Tasks, templates, checklists for your domain
|
|
1363
|
+
4. **Test & Share**: Validate with real use cases, share with community
|
|
1364
|
+
|
|
1365
|
+
**Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
|
|
1366
|
+
|
|
1158
1367
|
## Getting Help
|
|
1159
1368
|
|
|
1160
1369
|
- **Commands**: Use `/help` in any environment to see available commands
|
|
1161
1370
|
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
|
1162
1371
|
- **Documentation**: Check `docs/` folder for project-specific context
|
|
1163
1372
|
- **Community**: Discord and GitHub resources available for support
|
|
1373
|
+
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
|
1164
1374
|
==================== END: data#bmad-kb ====================
|
|
1165
1375
|
|
|
1166
1376
|
==================== START: utils#workflow-management ====================
|
|
@@ -3254,9 +3464,27 @@ The LLM will:
|
|
|
3254
3464
|
- Create a folder structure to organize the sharded documents
|
|
3255
3465
|
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
|
3256
3466
|
|
|
3257
|
-
##
|
|
3467
|
+
## Primary Method: Automatic with markdown-tree
|
|
3468
|
+
|
|
3469
|
+
[[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}`.
|
|
3470
|
+
|
|
3471
|
+
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
3472
|
+
|
|
3473
|
+
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:
|
|
3474
|
+
|
|
3475
|
+
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
3476
|
+
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
|
3477
|
+
|
|
3478
|
+
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
3258
3479
|
|
|
3259
|
-
|
|
3480
|
+
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
3481
|
+
|
|
3482
|
+
1. Set markdownExploder to true in bmad-core/core-config.yml
|
|
3483
|
+
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
3484
|
+
|
|
3485
|
+
I will now proceed with the manual sharding process."
|
|
3486
|
+
|
|
3487
|
+
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
|
3260
3488
|
|
|
3261
3489
|
### Installation and Usage
|
|
3262
3490
|
|
|
@@ -3289,19 +3517,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
3289
3517
|
|
|
3290
3518
|
---
|
|
3291
3519
|
|
|
3292
|
-
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
|
3520
|
+
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
3293
3521
|
|
|
3294
3522
|
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
3295
3523
|
|
|
3296
3524
|
### Task Instructions
|
|
3297
3525
|
|
|
3298
|
-
|
|
3526
|
+
1. Identify Document and Target Location
|
|
3299
3527
|
|
|
3300
3528
|
- Determine which document to shard (user-provided path)
|
|
3301
3529
|
- Create a new folder under `docs/` with the same name as the document (without extension)
|
|
3302
3530
|
- Example: `docs/prd.md` → create folder `docs/prd/`
|
|
3303
3531
|
|
|
3304
|
-
|
|
3532
|
+
2. Parse and Extract Sections
|
|
3305
3533
|
|
|
3306
3534
|
[[LLM: When sharding the document:
|
|
3307
3535
|
|
|
@@ -3311,7 +3539,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
3311
3539
|
- Extract the section heading and ALL content until the next level 2 section
|
|
3312
3540
|
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
|
3313
3541
|
- Be extremely careful with:
|
|
3314
|
-
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
|
3542
|
+
- 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
|
|
3315
3543
|
- Mermaid diagrams - preserve the complete diagram syntax
|
|
3316
3544
|
- Nested markdown elements
|
|
3317
3545
|
- Multi-line content that might contain ## inside code blocks
|
|
@@ -3330,7 +3558,7 @@ For each extracted section:
|
|
|
3330
3558
|
|
|
3331
3559
|
2. **Adjust heading levels**:
|
|
3332
3560
|
|
|
3333
|
-
- The level 2 heading becomes level 1 (# instead of ##)
|
|
3561
|
+
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
|
3334
3562
|
- All subsection levels decrease by 1:
|
|
3335
3563
|
|
|
3336
3564
|
```txt
|
|
@@ -7858,6 +8086,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
7858
8086
|
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
|
7859
8087
|
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
|
7860
8088
|
|
|
8089
|
+
### File List
|
|
8090
|
+
|
|
8091
|
+
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
|
8092
|
+
|
|
7861
8093
|
### Change Log
|
|
7862
8094
|
|
|
7863
8095
|
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
|
@@ -7865,6 +8097,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
|
|
7865
8097
|
|
|
7866
8098
|
| Date | Version | Description | Author |
|
|
7867
8099
|
| :--- | :------ | :---------- | :----- |
|
|
8100
|
+
|
|
8101
|
+
## QA Results
|
|
8102
|
+
|
|
8103
|
+
[[LLM: QA Agent Results]]
|
|
7868
8104
|
==================== END: templates#story-tmpl ====================
|
|
7869
8105
|
|
|
7870
8106
|
==================== START: checklists#po-master-checklist ====================
|
|
@@ -8365,7 +8601,42 @@ workflow:
|
|
|
8365
8601
|
|
|
8366
8602
|
- workflow_end:
|
|
8367
8603
|
action: move_to_ide
|
|
8368
|
-
notes:
|
|
8604
|
+
notes: |
|
|
8605
|
+
Planning phase complete! Now transition to IDE Development:
|
|
8606
|
+
|
|
8607
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
8608
|
+
- Copy final prd.md to project's docs/prd.md
|
|
8609
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
8610
|
+
- All documents must be in the project before proceeding
|
|
8611
|
+
|
|
8612
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
8613
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
8614
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
8615
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
8616
|
+
|
|
8617
|
+
3. START DEVELOPMENT CYCLE:
|
|
8618
|
+
a. SM Agent (New Chat): @sm → *create
|
|
8619
|
+
- Creates next story from sharded docs
|
|
8620
|
+
- Review and approve story (Draft → Approved)
|
|
8621
|
+
|
|
8622
|
+
b. Dev Agent (New Chat): @dev
|
|
8623
|
+
- Implements approved story
|
|
8624
|
+
- Updates File List with all changes
|
|
8625
|
+
- Marks story as "Review" when complete
|
|
8626
|
+
|
|
8627
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
8628
|
+
- Senior dev review with refactoring ability
|
|
8629
|
+
- Fixes small issues directly
|
|
8630
|
+
- Leaves checklist for remaining items
|
|
8631
|
+
- Updates story status (Review → Done or stays Review)
|
|
8632
|
+
|
|
8633
|
+
d. If QA left unchecked items:
|
|
8634
|
+
- Dev Agent (New Chat): Address remaining items
|
|
8635
|
+
- Return to QA for final approval
|
|
8636
|
+
|
|
8637
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
8638
|
+
|
|
8639
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
8369
8640
|
|
|
8370
8641
|
flow_diagram: |
|
|
8371
8642
|
```mermaid
|
|
@@ -8457,7 +8728,42 @@ workflow:
|
|
|
8457
8728
|
|
|
8458
8729
|
- workflow_end:
|
|
8459
8730
|
action: move_to_ide
|
|
8460
|
-
notes:
|
|
8731
|
+
notes: |
|
|
8732
|
+
Planning phase complete! Now transition to IDE Development:
|
|
8733
|
+
|
|
8734
|
+
1. ENSURE DOCUMENTS ARE IN PROJECT:
|
|
8735
|
+
- Copy final prd.md to project's docs/prd.md
|
|
8736
|
+
- Copy final architecture.md to project's docs/architecture.md
|
|
8737
|
+
- All documents must be in the project before proceeding
|
|
8738
|
+
|
|
8739
|
+
2. SHARD DOCUMENTS (in IDE):
|
|
8740
|
+
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
|
8741
|
+
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
|
8742
|
+
- This creates docs/prd/ and docs/architecture/ folders with sharded content
|
|
8743
|
+
|
|
8744
|
+
3. START DEVELOPMENT CYCLE:
|
|
8745
|
+
a. SM Agent (New Chat): @sm → *create
|
|
8746
|
+
- Creates next story from sharded docs
|
|
8747
|
+
- Review and approve story (Draft → Approved)
|
|
8748
|
+
|
|
8749
|
+
b. Dev Agent (New Chat): @dev
|
|
8750
|
+
- Implements approved story
|
|
8751
|
+
- Updates File List with all changes
|
|
8752
|
+
- Marks story as "Review" when complete
|
|
8753
|
+
|
|
8754
|
+
c. QA Agent (New Chat): @qa → review-story
|
|
8755
|
+
- Senior dev review with refactoring ability
|
|
8756
|
+
- Fixes small issues directly
|
|
8757
|
+
- Leaves checklist for remaining items
|
|
8758
|
+
- Updates story status (Review → Done or stays Review)
|
|
8759
|
+
|
|
8760
|
+
d. If QA left unchecked items:
|
|
8761
|
+
- Dev Agent (New Chat): Address remaining items
|
|
8762
|
+
- Return to QA for final approval
|
|
8763
|
+
|
|
8764
|
+
4. REPEAT: Continue cycle for all epic stories
|
|
8765
|
+
|
|
8766
|
+
Reference: data#bmad-kb:IDE Development Workflow
|
|
8461
8767
|
|
|
8462
8768
|
flow_diagram: |
|
|
8463
8769
|
```mermaid
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# Expansion Pack Ideas
|
|
2
|
+
|
|
3
|
+
The BMAD Method's natural language framework can be applied to any domain. Here are ideas to inspire your own expansion packs:
|
|
4
|
+
|
|
5
|
+
## Health & Wellness Pack
|
|
6
|
+
|
|
7
|
+
### Agents
|
|
8
|
+
|
|
9
|
+
- **Fitness Coach** - Creates personalized workout plans
|
|
10
|
+
- **Nutrition Advisor** - Designs meal plans and tracks nutrition
|
|
11
|
+
- **Meditation Guide** - Leads mindfulness sessions
|
|
12
|
+
- **Sleep Optimizer** - Improves sleep habits
|
|
13
|
+
|
|
14
|
+
### Tasks
|
|
15
|
+
|
|
16
|
+
- `create-workout-plan` - Generates weekly exercise routines
|
|
17
|
+
- `analyze-nutrition` - Reviews dietary habits
|
|
18
|
+
- `design-meditation` - Creates guided meditation scripts
|
|
19
|
+
|
|
20
|
+
### Templates
|
|
21
|
+
|
|
22
|
+
- `workout-plan-tmpl` - Structured exercise program
|
|
23
|
+
- `meal-plan-tmpl` - Weekly nutrition guide
|
|
24
|
+
- `wellness-journal-tmpl` - Progress tracking
|
|
25
|
+
|
|
26
|
+
## Creative Writing Pack
|
|
27
|
+
|
|
28
|
+
### Agents
|
|
29
|
+
|
|
30
|
+
- **Story Architect** - Plots narratives and story structures
|
|
31
|
+
- **Character Developer** - Creates deep, complex characters
|
|
32
|
+
- **World Builder** - Designs fictional universes
|
|
33
|
+
- **Dialog Master** - Crafts authentic conversations
|
|
34
|
+
|
|
35
|
+
### Tasks
|
|
36
|
+
|
|
37
|
+
- `develop-plot` - Creates story outlines
|
|
38
|
+
- `build-character` - Develops character profiles
|
|
39
|
+
- `create-world` - Designs settings and cultures
|
|
40
|
+
|
|
41
|
+
### Templates
|
|
42
|
+
|
|
43
|
+
- `story-outline-tmpl` - Three-act structure
|
|
44
|
+
- `character-sheet-tmpl` - Detailed character profile
|
|
45
|
+
- `world-bible-tmpl` - Universe documentation
|
|
46
|
+
|
|
47
|
+
## Business Strategy Pack
|
|
48
|
+
|
|
49
|
+
### Agents
|
|
50
|
+
|
|
51
|
+
- **Strategy Consultant** - Develops business strategies
|
|
52
|
+
- **Market Analyst** - Researches market opportunities
|
|
53
|
+
- **Financial Advisor** - Creates financial projections
|
|
54
|
+
- **Operations Expert** - Optimizes business processes
|
|
55
|
+
|
|
56
|
+
### Tasks
|
|
57
|
+
|
|
58
|
+
- `swot-analysis` - Conducts SWOT analysis
|
|
59
|
+
- `market-research` - Analyzes market conditions
|
|
60
|
+
- `financial-forecast` - Projects revenue/costs
|
|
61
|
+
|
|
62
|
+
### Templates
|
|
63
|
+
|
|
64
|
+
- `business-plan-tmpl` - Complete business plan
|
|
65
|
+
- `market-analysis-tmpl` - Market research report
|
|
66
|
+
- `pitch-deck-tmpl` - Investor presentation
|
|
67
|
+
|
|
68
|
+
## Education Pack
|
|
69
|
+
|
|
70
|
+
### Agents
|
|
71
|
+
|
|
72
|
+
- **Curriculum Designer** - Creates learning pathways
|
|
73
|
+
- **Lesson Planner** - Develops engaging lessons
|
|
74
|
+
- **Assessment Creator** - Designs fair evaluations
|
|
75
|
+
- **Learning Coach** - Provides personalized guidance
|
|
76
|
+
|
|
77
|
+
### Tasks
|
|
78
|
+
|
|
79
|
+
- `design-curriculum` - Creates course structure
|
|
80
|
+
- `plan-lesson` - Develops lesson content
|
|
81
|
+
- `create-assessment` - Builds tests/quizzes
|
|
82
|
+
|
|
83
|
+
### Templates
|
|
84
|
+
|
|
85
|
+
- `course-outline-tmpl` - Semester plan
|
|
86
|
+
- `lesson-plan-tmpl` - Daily lesson structure
|
|
87
|
+
- `rubric-tmpl` - Assessment criteria
|
|
88
|
+
|
|
89
|
+
## Personal Development Pack
|
|
90
|
+
|
|
91
|
+
### Agents
|
|
92
|
+
|
|
93
|
+
- **Life Coach** - Guides personal growth
|
|
94
|
+
- **Goal Strategist** - Helps achieve objectives
|
|
95
|
+
- **Habit Builder** - Creates lasting habits
|
|
96
|
+
- **Mindset Mentor** - Develops positive thinking
|
|
97
|
+
|
|
98
|
+
### Tasks
|
|
99
|
+
|
|
100
|
+
- `goal-setting` - Defines SMART goals
|
|
101
|
+
- `habit-tracking` - Monitors habit formation
|
|
102
|
+
- `reflection-exercise` - Facilitates self-reflection
|
|
103
|
+
|
|
104
|
+
### Templates
|
|
105
|
+
|
|
106
|
+
- `goal-plan-tmpl` - Goal achievement roadmap
|
|
107
|
+
- `habit-tracker-tmpl` - Daily habit log
|
|
108
|
+
- `journal-prompts-tmpl` - Reflection questions
|
|
109
|
+
|
|
110
|
+
## Creating Your Own
|
|
111
|
+
|
|
112
|
+
To create an expansion pack:
|
|
113
|
+
|
|
114
|
+
1. **Identify the domain** - What area of expertise?
|
|
115
|
+
2. **Define agent roles** - Who are the experts?
|
|
116
|
+
3. **Create tasks** - What procedures do they follow?
|
|
117
|
+
4. **Design templates** - What outputs do they produce?
|
|
118
|
+
5. **Test with users** - Does it provide value?
|
|
119
|
+
6. **Share with community** - Help others benefit!
|
|
120
|
+
|
|
121
|
+
Remember: The BMAD Method works anywhere natural language instructions can guide AI assistance!
|