bmad-method 4.13.0 → 4.14.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 (34) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/GUIDING-PRINCIPLES.md +0 -33
  3. package/README.md +3 -2
  4. package/bmad-core/agents/analyst.md +3 -1
  5. package/bmad-core/agents/dev.md +3 -2
  6. package/bmad-core/agents/qa.md +15 -14
  7. package/bmad-core/data/bmad-kb.md +280 -19
  8. package/bmad-core/tasks/document-project.md +250 -322
  9. package/bmad-core/tasks/review-story.md +135 -0
  10. package/bmad-core/templates/story-tmpl.md +8 -0
  11. package/bmad-core/workflows/brownfield-fullstack.yml +36 -1
  12. package/bmad-core/workflows/brownfield-service.yml +36 -1
  13. package/bmad-core/workflows/brownfield-ui.yml +36 -1
  14. package/bmad-core/workflows/greenfield-fullstack.yml +36 -1
  15. package/bmad-core/workflows/greenfield-service.yml +36 -1
  16. package/bmad-core/workflows/greenfield-ui.yml +36 -1
  17. package/dist/agents/analyst.txt +603 -20
  18. package/dist/agents/architect.txt +230 -302
  19. package/dist/agents/bmad-master.txt +543 -328
  20. package/dist/agents/bmad-orchestrator.txt +280 -19
  21. package/dist/agents/dev.txt +6 -4
  22. package/dist/agents/pm.txt +25 -7
  23. package/dist/agents/po.txt +33 -7
  24. package/dist/agents/qa.txt +153 -14
  25. package/dist/agents/sm.txt +8 -0
  26. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +323 -1
  27. package/dist/expansion-packs/expansion-creator/agents/bmad-the-creator.txt +4 -12
  28. package/dist/teams/team-all.txt +1011 -443
  29. package/dist/teams/team-fullstack.txt +852 -425
  30. package/dist/teams/team-ide-minimal.txt +472 -44
  31. package/dist/teams/team-no-ui.txt +708 -421
  32. package/docs/working-in-the-brownfield.md +362 -0
  33. package/package.json +1 -1
  34. package/tools/installer/package.json +1 -1
@@ -431,6 +431,50 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
431
431
  - **Quality Assurance**: Structured testing and validation
432
432
  - **Documentation**: Professional PRDs, architecture docs, user stories
433
433
 
434
+ ## How BMAD Works
435
+
436
+ ### The Core Method
437
+
438
+ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
439
+
440
+ 1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
441
+ 2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
442
+ 3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
443
+ 4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
444
+
445
+ ### The Two-Phase Approach
446
+
447
+ **Phase 1: Planning (Web UI - Cost Effective)**
448
+ - Use large context windows (Gemini's 1M tokens)
449
+ - Generate comprehensive documents (PRD, Architecture)
450
+ - Leverage multiple agents for brainstorming
451
+ - Create once, use throughout development
452
+
453
+ **Phase 2: Development (IDE - Implementation)**
454
+ - Shard documents into manageable pieces
455
+ - Execute focused SM → Dev cycles
456
+ - One story at a time, sequential progress
457
+ - Real-time file operations and testing
458
+
459
+ ### The Development Loop
460
+
461
+ ```text
462
+ 1. SM Agent (New Chat) → Creates next story from sharded docs
463
+ 2. You → Review and approve story
464
+ 3. Dev Agent (New Chat) → Implements approved story
465
+ 4. QA Agent (New Chat) → Reviews and refactors code
466
+ 5. You → Verify completion
467
+ 6. Repeat until epic complete
468
+ ```
469
+
470
+ ### Why This Works
471
+
472
+ - **Context Optimization**: Clean chats = better AI performance
473
+ - **Role Clarity**: Agents don't context-switch = higher quality
474
+ - **Incremental Progress**: Small stories = manageable complexity
475
+ - **Human Oversight**: You validate each step = quality control
476
+ - **Document-Driven**: Specs guide everything = consistency
477
+
434
478
  ## Getting Started
435
479
 
436
480
  ### Quick Start Options
@@ -445,7 +489,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
445
489
  5. Type `/help` to see available commands
446
490
 
447
491
  #### Option 2: IDE Integration
448
- **Best for**: Cursor, Claude Code, Windsurf, VS Code users
492
+ **Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code users
449
493
 
450
494
  ```bash
451
495
  # Interactive installation (recommended)
@@ -454,13 +498,22 @@ npx bmad-method install
454
498
 
455
499
  **Installation Steps**:
456
500
  - Choose "Complete installation"
457
- - Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
501
+ - Select your IDE from supported options:
502
+ - **Cursor**: Native AI integration
503
+ - **Claude Code**: Anthropic's official IDE
504
+ - **Windsurf**: Built-in AI capabilities
505
+ - **Cline**: VS Code extension with AI features
506
+ - **Roo Code**: Web-based IDE with agent support
507
+
508
+ **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.
458
509
 
459
510
  **Verify Installation**:
460
511
  - `.bmad-core/` folder created with all agents
461
512
  - IDE-specific integration files created
462
513
  - All agent commands/rules/modes available
463
514
 
515
+ **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
516
+
464
517
  ### Environment Selection Guide
465
518
 
466
519
  **Use Web UI for**:
@@ -477,6 +530,47 @@ npx bmad-method install
477
530
 
478
531
  **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.
479
532
 
533
+ ### IDE-Only Workflow Considerations
534
+
535
+ **Can you do everything in IDE?** Yes, but understand the tradeoffs:
536
+
537
+ **Pros of IDE-Only**:
538
+ - Single environment workflow
539
+ - Direct file operations from start
540
+ - No copy/paste between environments
541
+ - Immediate project integration
542
+
543
+ **Cons of IDE-Only**:
544
+ - Higher token costs for large document creation
545
+ - Smaller context windows (varies by IDE/model)
546
+ - May hit limits during planning phases
547
+ - Less cost-effective for brainstorming
548
+
549
+ **Using Web Agents in IDE**:
550
+ - **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
551
+ - **Why it matters**: Dev agents are kept lean to maximize coding context
552
+ - **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
553
+
554
+ **About bmad-master and bmad-orchestrator**:
555
+ - **bmad-master**: CAN do any task without switching agents, BUT...
556
+ - **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
557
+ - **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
558
+ - **If using bmad-master/orchestrator**: Fine for planning phases, but...
559
+
560
+ **CRITICAL RULE for Development**:
561
+ - **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
562
+ - **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
563
+ - **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
564
+ - **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
565
+
566
+ **Best Practice for IDE-Only**:
567
+ 1. Use PM/Architect/UX agents for planning (better than bmad-master)
568
+ 2. Create documents directly in project
569
+ 3. Shard immediately after creation
570
+ 4. **MUST switch to SM agent** for story creation
571
+ 5. **MUST switch to Dev agent** for implementation
572
+ 6. Keep planning and coding in separate chat sessions
573
+
480
574
  ## Core Configuration (core-config.yml)
481
575
 
482
576
  **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.
@@ -717,10 +811,16 @@ This architecture enables seamless operation across environments while maintaini
717
811
 
718
812
  ## Complete Development Workflow
719
813
 
720
- ### Planning Phase (Web UI Recommended)
814
+ ### Planning Phase (Web UI Recommended - Especially Gemini!)
815
+
816
+ **Ideal for cost efficiency with Gemini's massive context:**
721
817
 
722
- **Ideal for cost efficiency, especially with Gemini:**
818
+ **For Brownfield Projects - Start Here!**:
819
+ 1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
820
+ 2. **Document existing system**: `/analyst` → `*document-project`
821
+ 3. **Creates comprehensive docs** from entire codebase analysis
723
822
 
823
+ **For All Projects**:
724
824
  1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
725
825
  2. **Project Brief**: Create foundation document (Analyst or user)
726
826
  3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
@@ -754,10 +854,14 @@ that can handle [specific requirements]."
754
854
 
755
855
  **Prerequisites**: Planning documents must exist in `docs/` folder
756
856
 
757
- 1. **Document Sharding**:
758
- - `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
759
- - If architecture exists, shard to `docs/architecture/` folder
760
- - Results in multiple manageable documents and epic files
857
+ 1. **Document Sharding** (CRITICAL STEP):
858
+ - Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
859
+ - Two methods to shard:
860
+ a) **Manual**: Drag `shard-doc` task + document file into chat
861
+ b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
862
+ - Shards `docs/prd.md` → `docs/prd/` folder
863
+ - Shards `docs/architecture.md` → `docs/architecture/` folder
864
+ - **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
761
865
 
762
866
  2. **Verify Sharded Content**:
763
867
  - At least one `epic-n.md` file in `docs/prd/` with stories in development order
@@ -771,19 +875,34 @@ that can handle [specific requirements]."
771
875
 
772
876
  3. **Development Cycle** (Sequential, one story at a time):
773
877
 
774
- **Step 1 - Story Creation**: New chat window → `@sm` → `*create`
878
+ **CRITICAL CONTEXT MANAGEMENT**:
879
+ - **Context windows matter!** Always use fresh, clean context windows
880
+ - **Model selection matters!** Use most powerful thinking model for SM story creation
881
+ - **ALWAYS start new chat between SM, Dev, and QA work**
882
+
883
+ **Step 1 - Story Creation**:
884
+ - **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
775
885
  - SM executes create-next-story task
776
886
  - Review generated story in `docs/stories/`
777
887
  - Update status from "Draft" to "Approved"
778
888
 
779
- **Step 2 - Story Implementation**: New chat window → `@dev`
889
+ **Step 2 - Story Implementation**:
890
+ - **NEW CLEAN CHAT** → `@dev`
780
891
  - Agent asks which story to implement
781
892
  - Include story file content to save dev agent lookup time
782
893
  - Dev follows tasks/subtasks, marking completion
783
- - Dev leaves notes for SM about any deviations
784
- - Update status to "Done"
894
+ - Dev maintains File List of all changes
895
+ - Dev marks story as "Review" when complete with all tests passing
785
896
 
786
- **Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
897
+ **Step 3 - Senior QA Review**:
898
+ - **NEW CLEAN CHAT** → `@qa` → execute review-story task
899
+ - QA performs senior developer code review
900
+ - QA can refactor and improve code directly
901
+ - QA appends results to story's QA Results section
902
+ - If approved: Status → "Done"
903
+ - If changes needed: Status stays "Review" with unchecked items for dev
904
+
905
+ **Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
787
906
 
788
907
  **Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
789
908
 
@@ -803,12 +922,72 @@ Each status change requires user verification and approval before proceeding.
803
922
  - Development execution
804
923
  - Testing and deployment
805
924
 
806
- #### Brownfield Enhancement
807
- - Current system analysis
808
- - Enhancement planning
809
- - Impact assessment
810
- - Incremental development
811
- - Integration testing
925
+ #### Brownfield Enhancement (Existing Projects)
926
+
927
+ **Key Concept**: Brownfield development requires comprehensive documentation of your existing project for AI agents to understand context, patterns, and constraints.
928
+
929
+ **Complete Brownfield Workflow Options**:
930
+
931
+ **Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
932
+ 1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
933
+ 2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
934
+ 3. **Focused documentation**: `@analyst` → `*document-project`
935
+ - Analyst asks for focus if no PRD provided
936
+ - Choose "single document" format for Web UI
937
+ - Uses PRD to document ONLY relevant areas
938
+ - Creates one comprehensive markdown file
939
+ - Avoids bloating docs with unused code
940
+
941
+ **Option 2: Document-First (Good for Smaller Projects)**:
942
+ 1. **Upload project to Gemini Web**
943
+ 2. **Document everything**: `@analyst` → `*document-project`
944
+ 3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
945
+ - More thorough but can create excessive documentation
946
+
947
+ 2. **Requirements Gathering**:
948
+ - **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
949
+ - **Analyzes**: Existing system, constraints, integration points
950
+ - **Defines**: Enhancement scope, compatibility requirements, risk assessment
951
+ - **Creates**: Epic and story structure for changes
952
+
953
+ 3. **Architecture Planning**:
954
+ - **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
955
+ - **Integration Strategy**: How new features integrate with existing system
956
+ - **Migration Planning**: Gradual rollout and backwards compatibility
957
+ - **Risk Mitigation**: Addressing potential breaking changes
958
+
959
+ **Brownfield-Specific Resources**:
960
+
961
+ **Templates**:
962
+ - `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
963
+ - `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
964
+
965
+ **Tasks**:
966
+ - `document-project`: Generates comprehensive documentation from existing codebase
967
+ - `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
968
+ - `brownfield-create-story`: Creates individual story for small, isolated changes
969
+
970
+ **When to Use Each Approach**:
971
+
972
+ **Full Brownfield Workflow** (Recommended for):
973
+ - Major feature additions
974
+ - System modernization
975
+ - Complex integrations
976
+ - Multiple related changes
977
+
978
+ **Quick Epic/Story Creation** (Use when):
979
+ - Single, focused enhancement
980
+ - Isolated bug fixes
981
+ - Small feature additions
982
+ - Well-documented existing system
983
+
984
+ **Critical Success Factors**:
985
+ 1. **Documentation First**: Always run `document-project` if docs are outdated/missing
986
+ 2. **Context Matters**: Provide agents access to relevant code sections
987
+ 3. **Integration Focus**: Emphasize compatibility and non-breaking changes
988
+ 4. **Incremental Approach**: Plan for gradual rollout and testing
989
+
990
+ **For detailed guide**: See `docs/working-in-the-brownfield.md`
812
991
 
813
992
  ## Document Creation Best Practices
814
993
 
@@ -889,12 +1068,94 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
889
1068
  - **Keep conversations focused** - One agent, one task per conversation
890
1069
  - **Review everything** - Always review and approve before marking complete
891
1070
 
1071
+ ## Contributing to BMAD-METHOD
1072
+
1073
+ ### Quick Contribution Guidelines
1074
+
1075
+ For full details, see `CONTRIBUTING.md`. Key points:
1076
+
1077
+ **Fork Workflow**:
1078
+ 1. Fork the repository
1079
+ 2. Create feature branches
1080
+ 3. Submit PRs to `next` branch (default) or `main` for critical fixes only
1081
+ 4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
1082
+ 5. One feature/fix per PR
1083
+
1084
+ **PR Requirements**:
1085
+ - Clear descriptions (max 200 words) with What/Why/How/Testing
1086
+ - Use conventional commits (feat:, fix:, docs:)
1087
+ - Atomic commits - one logical change per commit
1088
+ - Must align with guiding principles
1089
+
1090
+ **Core Principles** (from GUIDING-PRINCIPLES.md):
1091
+ - **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
1092
+ - **Natural Language First**: Everything in markdown, no code in core
1093
+ - **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
1094
+ - **Design Philosophy**: "Dev agents code, planning agents plan"
1095
+
1096
+ ## Expansion Packs
1097
+
1098
+ ### What Are Expansion Packs?
1099
+
1100
+ 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.
1101
+
1102
+ ### Why Use Expansion Packs?
1103
+
1104
+ 1. **Keep Core Lean**: Dev agents maintain maximum context for coding
1105
+ 2. **Domain Expertise**: Deep, specialized knowledge without bloating core
1106
+ 3. **Community Innovation**: Anyone can create and share packs
1107
+ 4. **Modular Design**: Install only what you need
1108
+
1109
+ ### Available Expansion Packs
1110
+
1111
+ **Technical Packs**:
1112
+ - **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
1113
+ - **Game Development**: Game designers, level designers, narrative writers
1114
+ - **Mobile Development**: iOS/Android specialists, mobile UX experts
1115
+ - **Data Science**: ML engineers, data scientists, visualization experts
1116
+
1117
+ **Non-Technical Packs**:
1118
+ - **Business Strategy**: Consultants, financial analysts, marketing strategists
1119
+ - **Creative Writing**: Plot architects, character developers, world builders
1120
+ - **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
1121
+ - **Education**: Curriculum designers, assessment specialists
1122
+ - **Legal Support**: Contract analysts, compliance checkers
1123
+
1124
+ **Specialty Packs**:
1125
+ - **Expansion Creator**: Tools to build your own expansion packs
1126
+ - **RPG Game Master**: Tabletop gaming assistance
1127
+ - **Life Event Planning**: Wedding planners, event coordinators
1128
+ - **Scientific Research**: Literature reviewers, methodology designers
1129
+
1130
+ ### Using Expansion Packs
1131
+
1132
+ 1. **Browse Available Packs**: Check `expansion-packs/` directory
1133
+ 2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
1134
+ 3. **Install via CLI**:
1135
+ ```bash
1136
+ npx bmad-method install
1137
+ # Select "Install expansion pack" option
1138
+ ```
1139
+ 4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
1140
+
1141
+ ### Creating Custom Expansion Packs
1142
+
1143
+ Use the **expansion-creator** pack to build your own:
1144
+
1145
+ 1. **Define Domain**: What expertise are you capturing?
1146
+ 2. **Design Agents**: Create specialized roles with clear boundaries
1147
+ 3. **Build Resources**: Tasks, templates, checklists for your domain
1148
+ 4. **Test & Share**: Validate with real use cases, share with community
1149
+
1150
+ **Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
1151
+
892
1152
  ## Getting Help
893
1153
 
894
1154
  - **Commands**: Use `/help` in any environment to see available commands
895
1155
  - **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
896
1156
  - **Documentation**: Check `docs/` folder for project-specific context
897
1157
  - **Community**: Discord and GitHub resources available for support
1158
+ - **Contributing**: See `CONTRIBUTING.md` for full guidelines
898
1159
  ==================== END: data#bmad-kb ====================
899
1160
 
900
1161
  ==================== START: utils#workflow-management ====================
@@ -67,6 +67,7 @@ core_principles:
67
67
  - CRITICAL: Dev Record Only - ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
68
68
  - Strive for Sequential Task Execution - Complete tasks 1-by-1 and mark [x] as completed
69
69
  - Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
70
+ - Quality Gate Discipline - NEVER complete tasks with failing automated validations
70
71
  - Debug Log Discipline - Log temp changes to md table in devDebugLog. Revert after fix.
71
72
  - Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
72
73
  - Code Excellence - Clean, secure, maintainable code per loaded standards
@@ -78,15 +79,16 @@ commands:
78
79
  - complete-story: Finalize to "Review"
79
80
  - exit: Say goodbye as the Developer, and then abandon inhabiting this persona
80
81
  task-execution:
81
- flow: Read task→Implement→Write tests→Pass tests→Update [x]→Next task
82
+ flow: Read task→Implement→Write tests→Execute validationsOnly if ALL pass→Update [x]→Next task
82
83
  updates-ONLY:
83
84
  - 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
84
85
  - 'Debug Log: | Task | File | Change | Reverted? |'
85
86
  - 'Completion Notes: Deviations only, <50 words'
86
87
  - 'Change Log: Requirement changes only'
87
- blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing config
88
- done: Code matches reqs + Tests pass + Follows standards + No lint errors
89
- completion: All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT
88
+ - 'File List: CRITICAL - Maintain complete list of ALL files created/modified during implementation'
89
+ blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing config | Failing validations
90
+ done: Code matches reqs + All validations pass + Follows standards + File List complete
91
+ completion: All [x]→Validations pass→Integration(if noted)→E2E(if noted)→DoD→Update File List→Mark Ready for Review→HALT
90
92
  dependencies:
91
93
  tasks:
92
94
  - execute-checklist
@@ -978,9 +978,27 @@ The LLM will:
978
978
  - Create a folder structure to organize the sharded documents
979
979
  - Maintain all content integrity including code blocks, diagrams, and markdown formatting
980
980
 
981
- ## Recommended Method: @kayvan/markdown-tree-parser
981
+ ## Primary Method: Automatic with markdown-tree
982
982
 
983
- [[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
983
+ [[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}`.
984
+
985
+ If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
986
+
987
+ 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:
988
+
989
+ 1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
990
+ 2. Or set markdownExploder to false in bmad-core/core-config.yml
991
+
992
+ **IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
993
+
994
+ If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
995
+
996
+ 1. Set markdownExploder to true in bmad-core/core-config.yml
997
+ 2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
998
+
999
+ I will now proceed with the manual sharding process."
1000
+
1001
+ Then proceed with the manual method below ONLY if markdownExploder is false.]]
984
1002
 
985
1003
  ### Installation and Usage
986
1004
 
@@ -1013,19 +1031,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
1013
1031
 
1014
1032
  ---
1015
1033
 
1016
- ## Manual Method (if @kayvan/markdown-tree-parser is not available)
1034
+ ## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
1017
1035
 
1018
1036
  [[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
1019
1037
 
1020
1038
  ### Task Instructions
1021
1039
 
1022
- ### 1. Identify Document and Target Location
1040
+ 1. Identify Document and Target Location
1023
1041
 
1024
1042
  - Determine which document to shard (user-provided path)
1025
1043
  - Create a new folder under `docs/` with the same name as the document (without extension)
1026
1044
  - Example: `docs/prd.md` → create folder `docs/prd/`
1027
1045
 
1028
- ### 2. Parse and Extract Sections
1046
+ 2. Parse and Extract Sections
1029
1047
 
1030
1048
  [[LLM: When sharding the document:
1031
1049
 
@@ -1035,7 +1053,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
1035
1053
  - Extract the section heading and ALL content until the next level 2 section
1036
1054
  - Include all subsections, code blocks, diagrams, lists, tables, etc.
1037
1055
  - Be extremely careful with:
1038
- - Fenced code blocks (```) - ensure you capture the full block including closing backticks
1056
+ - 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
1039
1057
  - Mermaid diagrams - preserve the complete diagram syntax
1040
1058
  - Nested markdown elements
1041
1059
  - Multi-line content that might contain ## inside code blocks
@@ -1054,7 +1072,7 @@ For each extracted section:
1054
1072
 
1055
1073
  2. **Adjust heading levels**:
1056
1074
 
1057
- - The level 2 heading becomes level 1 (# instead of ##)
1075
+ - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
1058
1076
  - All subsection levels decrease by 1:
1059
1077
 
1060
1078
  ```txt
@@ -210,9 +210,27 @@ The LLM will:
210
210
  - Create a folder structure to organize the sharded documents
211
211
  - Maintain all content integrity including code blocks, diagrams, and markdown formatting
212
212
 
213
- ## Recommended Method: @kayvan/markdown-tree-parser
213
+ ## Primary Method: Automatic with markdown-tree
214
214
 
215
- [[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
215
+ [[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}`.
216
+
217
+ If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
218
+
219
+ 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:
220
+
221
+ 1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
222
+ 2. Or set markdownExploder to false in bmad-core/core-config.yml
223
+
224
+ **IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
225
+
226
+ If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
227
+
228
+ 1. Set markdownExploder to true in bmad-core/core-config.yml
229
+ 2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
230
+
231
+ I will now proceed with the manual sharding process."
232
+
233
+ Then proceed with the manual method below ONLY if markdownExploder is false.]]
216
234
 
217
235
  ### Installation and Usage
218
236
 
@@ -245,19 +263,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
245
263
 
246
264
  ---
247
265
 
248
- ## Manual Method (if @kayvan/markdown-tree-parser is not available)
266
+ ## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
249
267
 
250
268
  [[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
251
269
 
252
270
  ### Task Instructions
253
271
 
254
- ### 1. Identify Document and Target Location
272
+ 1. Identify Document and Target Location
255
273
 
256
274
  - Determine which document to shard (user-provided path)
257
275
  - Create a new folder under `docs/` with the same name as the document (without extension)
258
276
  - Example: `docs/prd.md` → create folder `docs/prd/`
259
277
 
260
- ### 2. Parse and Extract Sections
278
+ 2. Parse and Extract Sections
261
279
 
262
280
  [[LLM: When sharding the document:
263
281
 
@@ -267,7 +285,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
267
285
  - Extract the section heading and ALL content until the next level 2 section
268
286
  - Include all subsections, code blocks, diagrams, lists, tables, etc.
269
287
  - Be extremely careful with:
270
- - Fenced code blocks (```) - ensure you capture the full block including closing backticks
288
+ - 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
271
289
  - Mermaid diagrams - preserve the complete diagram syntax
272
290
  - Nested markdown elements
273
291
  - Multi-line content that might contain ## inside code blocks
@@ -286,7 +304,7 @@ For each extracted section:
286
304
 
287
305
  2. **Adjust heading levels**:
288
306
 
289
- - The level 2 heading becomes level 1 (# instead of ##)
307
+ - The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
290
308
  - All subsection levels decrease by 1:
291
309
 
292
310
  ```txt
@@ -821,6 +839,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
821
839
  [[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
822
840
  [[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
823
841
 
842
+ ### File List
843
+
844
+ [[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
845
+
824
846
  ### Change Log
825
847
 
826
848
  [[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
@@ -828,6 +850,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
828
850
 
829
851
  | Date | Version | Description | Author |
830
852
  | :--- | :------ | :---------- | :----- |
853
+
854
+ ## QA Results
855
+
856
+ [[LLM: QA Agent Results]]
831
857
  ==================== END: templates#story-tmpl ====================
832
858
 
833
859
  ==================== START: checklists#po-master-checklist ====================