bmad-method 4.28.0 → 4.29.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 +7 -0
- package/bmad-core/agents/bmad-master.md +0 -2
- package/bmad-core/agents/bmad-orchestrator.md +0 -3
- package/bmad-core/core-config.yaml +1 -5
- package/bmad-core/data/bmad-kb.md +2 -2
- package/bmad-core/tasks/correct-course.md +9 -12
- package/bmad-core/tasks/create-brownfield-story.md +10 -61
- package/bmad-core/tasks/create-deep-research-prompt.md +5 -17
- package/bmad-core/tasks/create-next-story.md +3 -4
- package/bmad-core/tasks/document-project.md +37 -13
- package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +1 -1
- package/bmad-core/tasks/kb-mode-interaction.md +8 -3
- package/bmad-core/tasks/review-story.md +3 -3
- package/bmad-core/tasks/shard-doc.md +5 -9
- package/common/tasks/create-doc.md +4 -0
- package/dist/agents/analyst.txt +43 -31
- package/dist/agents/architect.txt +42 -30
- package/dist/agents/bmad-master.txt +61 -602
- package/dist/agents/bmad-orchestrator.txt +7 -548
- package/dist/agents/pm.txt +19 -38
- package/dist/agents/po.txt +14 -21
- package/dist/agents/qa.txt +3 -3
- package/dist/agents/sm.txt +11 -15
- package/dist/agents/ux-expert.txt +6 -18
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +5 -17
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +50 -579
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +5 -17
- package/dist/teams/team-all.txt +70 -607
- package/dist/teams/team-fullstack.txt +65 -601
- package/dist/teams/team-ide-minimal.txt +26 -575
- package/dist/teams/team-no-ui.txt +64 -600
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -0
- package/expansion-packs/bmad-creator-tools/config.yaml +1 -0
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -0
- package/package.json +1 -1
- package/tools/installer/lib/ide-setup.js +325 -12
- package/tools/installer/package.json +1 -1
- package/bmad-core/tasks/create-workflow-plan.md +0 -289
- package/bmad-core/tasks/doc-migration-task.md +0 -143
- package/bmad-core/tasks/update-workflow-plan.md +0 -248
|
@@ -164,7 +164,6 @@ workflow-guidance:
|
|
|
164
164
|
- Understand each workflow's purpose, options, and decision points
|
|
165
165
|
- Ask clarifying questions based on the workflow's structure
|
|
166
166
|
- Guide users through workflow selection when multiple options exist
|
|
167
|
-
- For complex projects, offer to create a workflow plan using create-workflow-plan task
|
|
168
167
|
- When appropriate, suggest: Would you like me to create a detailed workflow plan before starting?
|
|
169
168
|
- For workflows with divergent paths, help users choose the right path
|
|
170
169
|
- Adapt questions to the specific domain (e.g., game dev vs infrastructure vs web dev)
|
|
@@ -174,9 +173,7 @@ dependencies:
|
|
|
174
173
|
tasks:
|
|
175
174
|
- advanced-elicitation.md
|
|
176
175
|
- create-doc.md
|
|
177
|
-
- create-workflow-plan.md
|
|
178
176
|
- kb-mode-interaction.md
|
|
179
|
-
- update-workflow-plan.md
|
|
180
177
|
data:
|
|
181
178
|
- bmad-kb.md
|
|
182
179
|
- elicitation-methods.md
|
|
@@ -596,302 +593,11 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
|
596
593
|
- End with "Select 1-9 or just type your question/feedback:"
|
|
597
594
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
|
598
595
|
|
|
599
|
-
==================== START: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
600
|
-
# Create Workflow Plan Task
|
|
601
|
-
|
|
602
|
-
## Purpose
|
|
603
|
-
|
|
604
|
-
Guide users through workflow selection and create a detailed plan document that outlines the selected workflow steps, decision points, and expected outputs. This task helps users understand what will happen before starting a complex workflow and provides a checklist to track progress.
|
|
605
|
-
|
|
606
|
-
## Task Instructions
|
|
607
|
-
|
|
608
|
-
### 1. Understand User's Goal
|
|
609
|
-
|
|
610
|
-
[[LLM: Start with discovery questions to understand what the user wants to accomplish]]
|
|
611
|
-
|
|
612
|
-
Ask the user:
|
|
613
|
-
|
|
614
|
-
1. **Project Type**:
|
|
615
|
-
- Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
|
|
616
|
-
- What type of application? (web app, service/API, UI only, full-stack)
|
|
617
|
-
|
|
618
|
-
2. **For Greenfield**:
|
|
619
|
-
- Do you need a quick prototype or production-ready application?
|
|
620
|
-
- Will this have a UI component?
|
|
621
|
-
- Single service or multiple services?
|
|
622
|
-
|
|
623
|
-
3. **For Brownfield**:
|
|
624
|
-
- What's the scope of the enhancement?
|
|
625
|
-
- Single bug fix or small feature (few hours)
|
|
626
|
-
- Small enhancement (1-3 stories)
|
|
627
|
-
- Major feature requiring coordination
|
|
628
|
-
- Architectural changes or modernization
|
|
629
|
-
- Do you have existing documentation?
|
|
630
|
-
- Are you following existing patterns or introducing new ones?
|
|
631
|
-
|
|
632
|
-
### 2. Recommend Appropriate Workflow
|
|
633
|
-
|
|
634
|
-
Based on the answers, recommend:
|
|
635
|
-
|
|
636
|
-
**Greenfield Options:**
|
|
637
|
-
|
|
638
|
-
- `greenfield-fullstack` - Complete web application
|
|
639
|
-
- `greenfield-service` - Backend API/service only
|
|
640
|
-
- `greenfield-ui` - Frontend only
|
|
641
|
-
|
|
642
|
-
**Brownfield Options:**
|
|
643
|
-
|
|
644
|
-
- `brownfield-create-story` - Single small change
|
|
645
|
-
- `brownfield-create-epic` - Small feature (1-3 stories)
|
|
646
|
-
- `brownfield-fullstack` - Major enhancement
|
|
647
|
-
|
|
648
|
-
**Simplified Option:**
|
|
649
|
-
|
|
650
|
-
- For users unsure or wanting flexibility, suggest starting with individual agent tasks
|
|
651
|
-
|
|
652
|
-
### 3. Explain Selected Workflow
|
|
653
|
-
|
|
654
|
-
[[LLM: Once workflow is selected, provide clear explanation]]
|
|
655
|
-
|
|
656
|
-
For the selected workflow, explain:
|
|
657
|
-
|
|
658
|
-
1. **Overview**: What this workflow accomplishes
|
|
659
|
-
2. **Duration**: Estimated time for planning phase
|
|
660
|
-
3. **Outputs**: What documents will be created
|
|
661
|
-
4. **Decision Points**: Where user input will be needed
|
|
662
|
-
5. **Requirements**: What information should be ready
|
|
663
|
-
|
|
664
|
-
### 4. Create Workflow Plan Document
|
|
665
|
-
|
|
666
|
-
[[LLM: Generate a comprehensive plan document with the following structure]]
|
|
667
|
-
|
|
668
|
-
```markdown
|
|
669
|
-
# Workflow Plan: {{Workflow Name}}
|
|
670
|
-
|
|
671
|
-
<!-- WORKFLOW-PLAN-META
|
|
672
|
-
workflow-id: {{workflow-id}}
|
|
673
|
-
status: active
|
|
674
|
-
created: {{ISO-8601 timestamp}}
|
|
675
|
-
updated: {{ISO-8601 timestamp}}
|
|
676
|
-
version: 1.0
|
|
677
|
-
-->
|
|
678
|
-
|
|
679
|
-
**Created Date**: {{current date}}
|
|
680
|
-
**Project**: {{project name}}
|
|
681
|
-
**Type**: {{greenfield/brownfield}}
|
|
682
|
-
**Status**: Active
|
|
683
|
-
**Estimated Planning Duration**: {{time estimate}}
|
|
684
|
-
|
|
685
|
-
## Objective
|
|
686
|
-
|
|
687
|
-
{{Clear description of what will be accomplished}}
|
|
688
|
-
|
|
689
|
-
## Selected Workflow
|
|
690
|
-
|
|
691
|
-
**Workflow**: `{{workflow-id}}`
|
|
692
|
-
**Reason**: {{Why this workflow fits the user's needs}}
|
|
693
|
-
|
|
694
|
-
## Workflow Steps
|
|
695
|
-
|
|
696
|
-
### Planning Phase
|
|
697
|
-
|
|
698
|
-
- [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
|
|
699
|
-
- **Agent**: {{agent name}}
|
|
700
|
-
- **Action**: {{what happens}}
|
|
701
|
-
- **Output**: {{what's created}}
|
|
702
|
-
- **User Input**: {{if any}}
|
|
703
|
-
|
|
704
|
-
- [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
|
|
705
|
-
- **Agent**: {{agent name}}
|
|
706
|
-
- **Action**: {{what happens}}
|
|
707
|
-
- **Output**: {{what's created}}
|
|
708
|
-
- **Decision Point**: {{if any}} <!-- decision-id: D1 -->
|
|
709
|
-
|
|
710
|
-
{{Continue for all planning steps}}
|
|
711
|
-
|
|
712
|
-
### Development Phase (IDE)
|
|
713
|
-
|
|
714
|
-
- [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
|
|
715
|
-
- Prepare documents for story creation
|
|
716
|
-
|
|
717
|
-
- [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
|
|
718
|
-
- [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
|
|
719
|
-
- [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
|
|
720
|
-
- [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
|
|
721
|
-
- [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
|
|
722
|
-
- [ ] Repeat for all stories
|
|
723
|
-
|
|
724
|
-
- [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
|
|
725
|
-
|
|
726
|
-
## Key Decision Points
|
|
727
|
-
|
|
728
|
-
1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
|
|
729
|
-
- Trigger: {{what causes this decision}}
|
|
730
|
-
- Options: {{available choices}}
|
|
731
|
-
- Impact: {{how it affects the workflow}}
|
|
732
|
-
- Decision Made: _Pending_
|
|
733
|
-
|
|
734
|
-
{{List all decision points}}
|
|
735
|
-
|
|
736
|
-
## Expected Outputs
|
|
737
|
-
|
|
738
|
-
### Planning Documents
|
|
739
|
-
- [ ] {{document 1}} - {{description}}
|
|
740
|
-
- [ ] {{document 2}} - {{description}}
|
|
741
|
-
{{etc...}}
|
|
742
|
-
|
|
743
|
-
### Development Artifacts
|
|
744
|
-
- [ ] Stories in `docs/stories/`
|
|
745
|
-
- [ ] Implementation code
|
|
746
|
-
- [ ] Tests
|
|
747
|
-
- [ ] Updated documentation
|
|
748
|
-
|
|
749
|
-
## Prerequisites Checklist
|
|
750
|
-
|
|
751
|
-
Before starting this workflow, ensure you have:
|
|
752
|
-
|
|
753
|
-
- [ ] {{prerequisite 1}}
|
|
754
|
-
- [ ] {{prerequisite 2}}
|
|
755
|
-
- [ ] {{prerequisite 3}}
|
|
756
|
-
{{etc...}}
|
|
757
|
-
|
|
758
|
-
## Customization Options
|
|
759
|
-
|
|
760
|
-
Based on your project needs, you may:
|
|
761
|
-
- Skip {{optional step}} if {{condition}}
|
|
762
|
-
- Add {{additional step}} if {{condition}}
|
|
763
|
-
- Choose {{alternative}} instead of {{default}}
|
|
764
|
-
|
|
765
|
-
## Risk Considerations
|
|
766
|
-
|
|
767
|
-
{{For brownfield only}}
|
|
768
|
-
- Integration complexity: {{assessment}}
|
|
769
|
-
- Rollback strategy: {{approach}}
|
|
770
|
-
- Testing requirements: {{special needs}}
|
|
771
|
-
|
|
772
|
-
## Next Steps
|
|
773
|
-
|
|
774
|
-
1. Review this plan and confirm it matches your expectations
|
|
775
|
-
2. Gather any missing prerequisites
|
|
776
|
-
3. Start workflow with: `*task workflow {{workflow-id}}`
|
|
777
|
-
4. Or begin with first agent: `@{{first-agent}}`
|
|
778
|
-
|
|
779
|
-
## Notes
|
|
780
|
-
|
|
781
|
-
{{Any additional context or warnings}}
|
|
782
|
-
|
|
783
|
-
---
|
|
784
|
-
*This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
|
|
785
|
-
```
|
|
786
|
-
|
|
787
|
-
### 5. Save and Present Plan
|
|
788
|
-
|
|
789
|
-
1. Save the plan as `docs/workflow-plan.md`
|
|
790
|
-
2. Inform user: "Workflow plan created at docs/workflow-plan.md"
|
|
791
|
-
3. Offer options:
|
|
792
|
-
- Review the plan together
|
|
793
|
-
- Start the workflow now
|
|
794
|
-
- Gather prerequisites first
|
|
795
|
-
- Modify the plan
|
|
796
|
-
|
|
797
|
-
### 6. Plan Variations
|
|
798
|
-
|
|
799
|
-
[[LLM: Adjust plan detail based on workflow complexity]]
|
|
800
|
-
|
|
801
|
-
**For Simple Workflows** (create-story, create-epic):
|
|
802
|
-
|
|
803
|
-
- Simpler checklist format
|
|
804
|
-
- Focus on immediate next steps
|
|
805
|
-
- Less detailed explanations
|
|
806
|
-
|
|
807
|
-
**For Complex Workflows** (full greenfield/brownfield):
|
|
808
|
-
|
|
809
|
-
- Detailed step breakdowns
|
|
810
|
-
- All decision points documented
|
|
811
|
-
- Comprehensive output descriptions
|
|
812
|
-
- Risk mitigation sections
|
|
813
|
-
|
|
814
|
-
**For Brownfield Workflows**:
|
|
815
|
-
|
|
816
|
-
- Include existing system impact analysis
|
|
817
|
-
- Document integration checkpoints
|
|
818
|
-
- Add rollback considerations
|
|
819
|
-
- Note documentation dependencies
|
|
820
|
-
|
|
821
|
-
### 7. Interactive Planning Mode
|
|
822
|
-
|
|
823
|
-
[[LLM: If user wants to customize the workflow]]
|
|
824
|
-
|
|
825
|
-
If user wants to modify the standard workflow:
|
|
826
|
-
|
|
827
|
-
1. Present workflow steps as options
|
|
828
|
-
2. Allow skipping optional steps
|
|
829
|
-
3. Let user reorder certain steps
|
|
830
|
-
4. Document customizations in plan
|
|
831
|
-
5. Warn about dependencies if steps are skipped
|
|
832
|
-
|
|
833
|
-
### 8. Execution Guidance
|
|
834
|
-
|
|
835
|
-
After plan is created, provide clear guidance:
|
|
836
|
-
|
|
837
|
-
```text
|
|
838
|
-
Your workflow plan is ready! Here's how to proceed:
|
|
839
|
-
|
|
840
|
-
1. **Review the plan**: Check that all steps align with your goals
|
|
841
|
-
2. **Gather prerequisites**: Use the checklist to ensure you're ready
|
|
842
|
-
3. **Start execution**:
|
|
843
|
-
- Full workflow: `*task workflow {{workflow-id}}`
|
|
844
|
-
- Step by step: Start with `@{{first-agent}}`
|
|
845
|
-
4. **Track progress**: Check off steps in the plan as completed
|
|
846
|
-
|
|
847
|
-
Would you like to:
|
|
848
|
-
a) Review the plan together
|
|
849
|
-
b) Start the workflow now
|
|
850
|
-
c) Gather prerequisites first
|
|
851
|
-
d) Modify the plan
|
|
852
|
-
```
|
|
853
|
-
|
|
854
|
-
## Success Criteria
|
|
855
|
-
|
|
856
|
-
The workflow plan is successful when:
|
|
857
|
-
|
|
858
|
-
1. User clearly understands what will happen
|
|
859
|
-
2. All decision points are documented
|
|
860
|
-
3. Prerequisites are identified
|
|
861
|
-
4. Expected outputs are clear
|
|
862
|
-
5. User feels confident to proceed
|
|
863
|
-
6. Plan serves as useful progress tracker
|
|
864
|
-
|
|
865
|
-
## Integration with BMad Master and Orchestrator
|
|
866
|
-
|
|
867
|
-
When used by BMad Master or BMad Orchestrator, this task should:
|
|
868
|
-
|
|
869
|
-
1. Be offered when user asks about workflows
|
|
870
|
-
2. Be suggested before starting complex workflows
|
|
871
|
-
3. Create a plan that the agent can reference during execution
|
|
872
|
-
4. Allow the agent to track progress against the plan
|
|
873
|
-
|
|
874
|
-
## Example Usage
|
|
875
|
-
|
|
876
|
-
```text
|
|
877
|
-
User: "I need to add a payment system to my existing app"
|
|
878
|
-
|
|
879
|
-
BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
|
|
880
|
-
|
|
881
|
-
[Runs through discovery questions]
|
|
882
|
-
|
|
883
|
-
BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
|
|
884
|
-
|
|
885
|
-
[Creates and saves plan]
|
|
886
|
-
|
|
887
|
-
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
|
888
|
-
```
|
|
889
|
-
==================== END: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
890
|
-
|
|
891
596
|
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
892
597
|
# KB Mode Interaction Task
|
|
893
598
|
|
|
894
599
|
## Purpose
|
|
600
|
+
|
|
895
601
|
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
|
896
602
|
|
|
897
603
|
## Instructions
|
|
@@ -899,11 +605,11 @@ Provide a user-friendly interface to the BMad knowledge base without overwhelmin
|
|
|
899
605
|
When entering KB mode (*kb-mode), follow these steps:
|
|
900
606
|
|
|
901
607
|
### 1. Welcome and Guide
|
|
902
|
-
Announce entering KB mode with a brief, friendly introduction:
|
|
903
608
|
|
|
904
|
-
|
|
609
|
+
Announce entering KB mode with a brief, friendly introduction.
|
|
905
610
|
|
|
906
611
|
### 2. Present Topic Areas
|
|
612
|
+
|
|
907
613
|
Offer a concise list of main topic areas the user might want to explore:
|
|
908
614
|
|
|
909
615
|
**What would you like to know more about?**
|
|
@@ -920,19 +626,23 @@ Offer a concise list of main topic areas the user might want to explore:
|
|
|
920
626
|
Or ask me about anything else related to BMad-Method!
|
|
921
627
|
|
|
922
628
|
### 3. Respond Contextually
|
|
629
|
+
|
|
923
630
|
- Wait for user's specific question or topic selection
|
|
924
631
|
- Provide focused, relevant information from the knowledge base
|
|
925
632
|
- Offer to dive deeper or explore related topics
|
|
926
633
|
- Keep responses concise unless user asks for detailed explanations
|
|
927
634
|
|
|
928
635
|
### 4. Interactive Exploration
|
|
636
|
+
|
|
929
637
|
- After answering, suggest related topics they might find helpful
|
|
930
638
|
- Maintain conversational flow rather than data dumping
|
|
931
639
|
- Use examples when appropriate
|
|
932
640
|
- Reference specific documentation sections when relevant
|
|
933
641
|
|
|
934
642
|
### 5. Exit Gracefully
|
|
643
|
+
|
|
935
644
|
When user is done or wants to exit KB mode:
|
|
645
|
+
|
|
936
646
|
- Summarize key points discussed if helpful
|
|
937
647
|
- Remind them they can return to KB mode anytime with *kb-mode
|
|
938
648
|
- Suggest next steps based on what was discussed
|
|
@@ -961,257 +671,6 @@ Or ask me about anything else related to BMad-Method!
|
|
|
961
671
|
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
|
962
672
|
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
963
673
|
|
|
964
|
-
==================== START: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
965
|
-
# Update Workflow Plan Task
|
|
966
|
-
|
|
967
|
-
## Purpose
|
|
968
|
-
|
|
969
|
-
Update the status of steps in an active workflow plan, mark completions, add notes about deviations, and maintain an accurate record of workflow progress. This task can be called directly by users or automatically by other tasks upon completion.
|
|
970
|
-
|
|
971
|
-
## Task Instructions
|
|
972
|
-
|
|
973
|
-
### 0. Load Plan Configuration
|
|
974
|
-
|
|
975
|
-
[[LLM: First load core-config.yaml to get plan settings]]
|
|
976
|
-
|
|
977
|
-
Check workflow configuration:
|
|
978
|
-
|
|
979
|
-
- `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
|
|
980
|
-
- `workflow.trackProgress` - Whether tracking is enabled
|
|
981
|
-
- `workflow.updateOnCompletion` - Whether to auto-update on task completion
|
|
982
|
-
|
|
983
|
-
If tracking is disabled, inform user and exit.
|
|
984
|
-
|
|
985
|
-
### 1. Verify Plan Exists
|
|
986
|
-
|
|
987
|
-
[[LLM: Check if workflow plan exists at configured location]]
|
|
988
|
-
|
|
989
|
-
If no plan exists:
|
|
990
|
-
|
|
991
|
-
```
|
|
992
|
-
No active workflow plan found at {location}.
|
|
993
|
-
Would you like to create one? Use *plan command.
|
|
994
|
-
```
|
|
995
|
-
|
|
996
|
-
### 2. Determine Update Type
|
|
997
|
-
|
|
998
|
-
[[LLM: Ask user what type of update they want to make]]
|
|
999
|
-
|
|
1000
|
-
Present options:
|
|
1001
|
-
|
|
1002
|
-
```
|
|
1003
|
-
What would you like to update in the workflow plan?
|
|
1004
|
-
|
|
1005
|
-
1. Mark step as complete
|
|
1006
|
-
2. Update current step
|
|
1007
|
-
3. Add deviation note
|
|
1008
|
-
4. Mark decision point resolution
|
|
1009
|
-
5. Update overall status
|
|
1010
|
-
6. View current plan status only
|
|
1011
|
-
|
|
1012
|
-
Please select an option (1-6):
|
|
1013
|
-
```
|
|
1014
|
-
|
|
1015
|
-
### 3. Parse Current Plan
|
|
1016
|
-
|
|
1017
|
-
[[LLM: Read and parse the plan to understand current state]]
|
|
1018
|
-
|
|
1019
|
-
Extract:
|
|
1020
|
-
|
|
1021
|
-
- All steps with their checkbox status
|
|
1022
|
-
- Step IDs from comments (if present)
|
|
1023
|
-
- Current completion percentage
|
|
1024
|
-
- Any existing deviation notes
|
|
1025
|
-
- Decision points and their status
|
|
1026
|
-
|
|
1027
|
-
### 4. Execute Updates
|
|
1028
|
-
|
|
1029
|
-
#### 4.1 Mark Step Complete
|
|
1030
|
-
|
|
1031
|
-
If user selected option 1:
|
|
1032
|
-
|
|
1033
|
-
1. Show numbered list of incomplete steps
|
|
1034
|
-
2. Ask which step to mark complete
|
|
1035
|
-
3. Update the checkbox from `[ ]` to `[x]`
|
|
1036
|
-
4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
|
|
1037
|
-
5. If this was the current step, identify next step
|
|
1038
|
-
|
|
1039
|
-
#### 4.2 Update Current Step
|
|
1040
|
-
|
|
1041
|
-
If user selected option 2:
|
|
1042
|
-
|
|
1043
|
-
1. Show all steps with current status
|
|
1044
|
-
2. Ask which step is now current
|
|
1045
|
-
3. Add/move `<!-- current-step -->` marker
|
|
1046
|
-
4. Optionally add note about why sequence changed
|
|
1047
|
-
|
|
1048
|
-
#### 4.3 Add Deviation Note
|
|
1049
|
-
|
|
1050
|
-
If user selected option 3:
|
|
1051
|
-
|
|
1052
|
-
1. Ask for deviation description
|
|
1053
|
-
2. Ask which step this relates to (or general)
|
|
1054
|
-
3. Insert note in appropriate location:
|
|
1055
|
-
|
|
1056
|
-
```markdown
|
|
1057
|
-
> **Deviation Note** (YYYY-MM-DD): {user_note}
|
|
1058
|
-
> Related to: Step X.Y or General workflow
|
|
1059
|
-
```
|
|
1060
|
-
|
|
1061
|
-
#### 4.4 Mark Decision Resolution
|
|
1062
|
-
|
|
1063
|
-
If user selected option 4:
|
|
1064
|
-
|
|
1065
|
-
1. Show pending decision points
|
|
1066
|
-
2. Ask which decision was made
|
|
1067
|
-
3. Record the decision and chosen path
|
|
1068
|
-
4. Update related steps based on decision
|
|
1069
|
-
|
|
1070
|
-
#### 4.5 Update Overall Status
|
|
1071
|
-
|
|
1072
|
-
If user selected option 5:
|
|
1073
|
-
|
|
1074
|
-
1. Show current overall status
|
|
1075
|
-
2. Provide options:
|
|
1076
|
-
- Active (continuing with plan)
|
|
1077
|
-
- Paused (temporarily stopped)
|
|
1078
|
-
- Abandoned (no longer following)
|
|
1079
|
-
- Complete (all steps done)
|
|
1080
|
-
3. Update plan header with new status
|
|
1081
|
-
|
|
1082
|
-
### 5. Automatic Updates (When Called by Tasks)
|
|
1083
|
-
|
|
1084
|
-
[[LLM: When called automatically by another task]]
|
|
1085
|
-
|
|
1086
|
-
If called with parameters:
|
|
1087
|
-
|
|
1088
|
-
```
|
|
1089
|
-
task: {task_name}
|
|
1090
|
-
step_id: {step_identifier}
|
|
1091
|
-
status: complete|skipped|failed
|
|
1092
|
-
note: {optional_note}
|
|
1093
|
-
```
|
|
1094
|
-
|
|
1095
|
-
Automatically:
|
|
1096
|
-
|
|
1097
|
-
1. Find the corresponding step
|
|
1098
|
-
2. Update its status
|
|
1099
|
-
3. Add completion metadata
|
|
1100
|
-
4. Add note if provided
|
|
1101
|
-
5. Calculate new progress percentage
|
|
1102
|
-
|
|
1103
|
-
### 6. Generate Update Summary
|
|
1104
|
-
|
|
1105
|
-
After updates, show summary:
|
|
1106
|
-
|
|
1107
|
-
```
|
|
1108
|
-
✅ Workflow Plan Updated
|
|
1109
|
-
|
|
1110
|
-
Changes made:
|
|
1111
|
-
- {change_1}
|
|
1112
|
-
- {change_2}
|
|
1113
|
-
|
|
1114
|
-
New Status:
|
|
1115
|
-
- Progress: {X}% complete ({completed}/{total} steps)
|
|
1116
|
-
- Current Step: {current_step}
|
|
1117
|
-
- Next Recommended: {next_step}
|
|
1118
|
-
|
|
1119
|
-
Plan location: {file_path}
|
|
1120
|
-
```
|
|
1121
|
-
|
|
1122
|
-
### 7. Integration with Other Tasks
|
|
1123
|
-
|
|
1124
|
-
[[LLM: How other tasks should call this]]
|
|
1125
|
-
|
|
1126
|
-
Other tasks can integrate by:
|
|
1127
|
-
|
|
1128
|
-
1. **After Task Completion**:
|
|
1129
|
-
|
|
1130
|
-
```
|
|
1131
|
-
At end of task execution:
|
|
1132
|
-
- Check if task corresponds to a plan step
|
|
1133
|
-
- If yes, call update-workflow-plan with:
|
|
1134
|
-
- task: {current_task_name}
|
|
1135
|
-
- step_id: {matching_step}
|
|
1136
|
-
- status: complete
|
|
1137
|
-
```
|
|
1138
|
-
|
|
1139
|
-
2. **On Task Failure**:
|
|
1140
|
-
|
|
1141
|
-
```
|
|
1142
|
-
If task fails:
|
|
1143
|
-
- Call update-workflow-plan with:
|
|
1144
|
-
- task: {current_task_name}
|
|
1145
|
-
- status: failed
|
|
1146
|
-
- note: {failure_reason}
|
|
1147
|
-
```
|
|
1148
|
-
|
|
1149
|
-
### 8. Plan Status Display
|
|
1150
|
-
|
|
1151
|
-
[[LLM: When user selects view status only]]
|
|
1152
|
-
|
|
1153
|
-
Display comprehensive status:
|
|
1154
|
-
|
|
1155
|
-
```markdown
|
|
1156
|
-
📋 Workflow Plan Status
|
|
1157
|
-
━━━━━━━━━━━━━━━━━━━━
|
|
1158
|
-
Workflow: {workflow_name}
|
|
1159
|
-
Status: {Active|Paused|Complete}
|
|
1160
|
-
Progress: {X}% complete ({completed}/{total} steps)
|
|
1161
|
-
Last Updated: {timestamp}
|
|
1162
|
-
|
|
1163
|
-
✅ Completed Steps:
|
|
1164
|
-
- [x] Step 1.1: {description} (completed: {date})
|
|
1165
|
-
- [x] Step 1.2: {description} (completed: {date})
|
|
1166
|
-
|
|
1167
|
-
🔄 Current Step:
|
|
1168
|
-
- [ ] Step 2.1: {description} <!-- current-step -->
|
|
1169
|
-
Agent: {agent_name}
|
|
1170
|
-
Task: {task_name}
|
|
1171
|
-
|
|
1172
|
-
📌 Upcoming Steps:
|
|
1173
|
-
- [ ] Step 2.2: {description}
|
|
1174
|
-
- [ ] Step 3.1: {description}
|
|
1175
|
-
|
|
1176
|
-
⚠️ Deviations/Notes:
|
|
1177
|
-
{any_deviation_notes}
|
|
1178
|
-
|
|
1179
|
-
📊 Decision Points:
|
|
1180
|
-
- Decision 1: {status} - {choice_made}
|
|
1181
|
-
- Decision 2: Pending
|
|
1182
|
-
|
|
1183
|
-
💡 Next Action:
|
|
1184
|
-
Based on the plan, you should {recommended_action}
|
|
1185
|
-
```
|
|
1186
|
-
|
|
1187
|
-
## Success Criteria
|
|
1188
|
-
|
|
1189
|
-
The update is successful when:
|
|
1190
|
-
|
|
1191
|
-
1. Plan accurately reflects current workflow state
|
|
1192
|
-
2. All updates are clearly timestamped
|
|
1193
|
-
3. Deviations are documented with reasons
|
|
1194
|
-
4. Progress calculation is correct
|
|
1195
|
-
5. Next steps are clear to user
|
|
1196
|
-
6. Plan remains readable and well-formatted
|
|
1197
|
-
|
|
1198
|
-
## Error Handling
|
|
1199
|
-
|
|
1200
|
-
- **Plan file not found**: Offer to create new plan
|
|
1201
|
-
- **Malformed plan**: Attempt basic updates, warn user
|
|
1202
|
-
- **Write permission error**: Show changes that would be made
|
|
1203
|
-
- **Step not found**: Show available steps, ask for clarification
|
|
1204
|
-
- **Concurrent updates**: Implement simple locking or warn about conflicts
|
|
1205
|
-
|
|
1206
|
-
## Notes
|
|
1207
|
-
|
|
1208
|
-
- Always preserve plan history (don't delete old information)
|
|
1209
|
-
- Keep updates atomic to prevent corruption
|
|
1210
|
-
- Consider creating backup before major updates
|
|
1211
|
-
- Updates should enhance, not complicate, the workflow experience
|
|
1212
|
-
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
|
1213
|
-
==================== END: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
1214
|
-
|
|
1215
674
|
==================== START: .bmad-core/data/bmad-kb.md ====================
|
|
1216
675
|
# BMad Knowledge Base
|
|
1217
676
|
|
|
@@ -2334,20 +1793,20 @@ The LLM will:
|
|
|
2334
1793
|
|
|
2335
1794
|
## Primary Method: Automatic with markdown-tree
|
|
2336
1795
|
|
|
2337
|
-
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
1796
|
+
[[LLM: First, check if markdownExploder is set to true in .bmad-core/core-config.yaml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
|
2338
1797
|
|
|
2339
1798
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
2340
1799
|
|
|
2341
1800
|
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:
|
|
2342
1801
|
|
|
2343
1802
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2344
|
-
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
1803
|
+
2. Or set markdownExploder to false in .bmad-core/core-config.yaml
|
|
2345
1804
|
|
|
2346
1805
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
2347
1806
|
|
|
2348
1807
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
2349
1808
|
|
|
2350
|
-
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
1809
|
+
1. Set markdownExploder to true in .bmad-core/core-config.yaml
|
|
2351
1810
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
2352
1811
|
|
|
2353
1812
|
I will now proceed with the manual sharding process."
|
|
@@ -2387,8 +1846,6 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
2387
1846
|
|
|
2388
1847
|
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
2389
1848
|
|
|
2390
|
-
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
2391
|
-
|
|
2392
1849
|
### Task Instructions
|
|
2393
1850
|
|
|
2394
1851
|
1. Identify Document and Target Location
|
|
@@ -2399,7 +1856,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
2399
1856
|
|
|
2400
1857
|
2. Parse and Extract Sections
|
|
2401
1858
|
|
|
2402
|
-
|
|
1859
|
+
CRITICAL AEGNT SHARDING RULES:
|
|
2403
1860
|
|
|
2404
1861
|
1. Read the entire document content
|
|
2405
1862
|
2. Identify all level 2 sections (## headings)
|
|
@@ -2460,8 +1917,6 @@ Create an `index.md` file in the sharded folder that:
|
|
|
2460
1917
|
|
|
2461
1918
|
### 5. Preserve Special Content
|
|
2462
1919
|
|
|
2463
|
-
[[LLM: Pay special attention to preserving:
|
|
2464
|
-
|
|
2465
1920
|
1. **Code blocks**: Must capture complete blocks including:
|
|
2466
1921
|
|
|
2467
1922
|
```language
|
|
@@ -2483,7 +1938,7 @@ Create an `index.md` file in the sharded folder that:
|
|
|
2483
1938
|
|
|
2484
1939
|
6. **Links and references**: Keep all markdown links intact
|
|
2485
1940
|
|
|
2486
|
-
7. **Template markup**: If documents contain {{placeholders}}
|
|
1941
|
+
7. **Template markup**: If documents contain {{placeholders}} ,preserve exactly
|
|
2487
1942
|
|
|
2488
1943
|
### 6. Validation
|
|
2489
1944
|
|
|
@@ -2522,9 +1977,9 @@ Document sharded successfully:
|
|
|
2522
1977
|
|
|
2523
1978
|
## Purpose
|
|
2524
1979
|
|
|
2525
|
-
- Guide a structured response to a change trigger using the
|
|
1980
|
+
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
|
2526
1981
|
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
|
2527
|
-
- Explore potential solutions (e.g., adjust scope, rollback elements,
|
|
1982
|
+
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
|
2528
1983
|
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
|
2529
1984
|
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
|
2530
1985
|
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
|
@@ -2536,19 +1991,16 @@ Document sharded successfully:
|
|
|
2536
1991
|
- **Acknowledge Task & Inputs:**
|
|
2537
1992
|
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
|
2538
1993
|
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
|
2539
|
-
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the
|
|
1994
|
+
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the `.bmad-core/checklists/change-checklist`.
|
|
2540
1995
|
- **Establish Interaction Mode:**
|
|
2541
1996
|
- Ask the user their preferred interaction mode for this task:
|
|
2542
|
-
- **"Incrementally (Default & Recommended):** Shall we work through the
|
|
1997
|
+
- **"Incrementally (Default & Recommended):** Shall we work through the change-checklist section by section, discussing findings and collaboratively drafting proposed changes for each relevant part before moving to the next? This allows for detailed, step-by-step refinement."
|
|
2543
1998
|
- **"YOLO Mode (Batch Processing):** Or, would you prefer I conduct a more batched analysis based on the checklist and then present a consolidated set of findings and proposed changes for a broader review? This can be quicker for initial assessment but might require more extensive review of the combined proposals."
|
|
2544
|
-
-
|
|
2545
|
-
- Once the user chooses, confirm the selected mode (e.g., "Okay, we will proceed in Incremental mode."). This chosen mode will govern how subsequent steps in this task are executed.
|
|
2546
|
-
- **Explain Process:** Briefly inform the user: "We will now use the `change-checklist` to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
|
2547
|
-
<rule>When asking multiple questions or presenting multiple points for user input at once, number them clearly (e.g., 1., 2a., 2b.) to make it easier for the user to provide specific responses.</rule>
|
|
1999
|
+
- Once the user chooses, confirm the selected mode and then inform the user: "We will now use the change-checklist to analyze the change and draft proposed updates. I will guide you through the checklist items based on our chosen interaction mode."
|
|
2548
2000
|
|
|
2549
2001
|
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
|
2550
2002
|
|
|
2551
|
-
- Systematically work through Sections 1-4 of the
|
|
2003
|
+
- Systematically work through Sections 1-4 of the change-checklist (typically covering Change Context, Epic/Story Impact Analysis, Artifact Conflict Resolution, and Path Evaluation/Recommendation).
|
|
2552
2004
|
- For each checklist item or logical group of items (depending on interaction mode):
|
|
2553
2005
|
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
|
2554
2006
|
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
|
@@ -2571,7 +2023,7 @@ Document sharded successfully:
|
|
|
2571
2023
|
|
|
2572
2024
|
### 4. Generate "Sprint Change Proposal" with Edits
|
|
2573
2025
|
|
|
2574
|
-
- Synthesize the complete
|
|
2026
|
+
- Synthesize the complete change-checklist analysis (covering findings from Sections 1-4) and all the agreed-upon proposed edits (from Instruction 3) into a single document titled "Sprint Change Proposal." This proposal should align with the structure suggested by Section 5 of the change-checklist.
|
|
2575
2027
|
- The proposal must clearly present:
|
|
2576
2028
|
- **Analysis Summary:** A concise overview of the original issue, its analyzed impact (on epics, artifacts, MVP scope), and the rationale for the chosen path forward.
|
|
2577
2029
|
- **Specific Proposed Edits:** For each affected artifact, clearly show or describe the exact changes (e.g., "Change Story X.Y from: [old text] To: [new text]", "Add new Acceptance Criterion to Story A.B: [new AC]", "Update Section 3.2 of Architecture Document as follows: [new/modified text or diagram description]").
|
|
@@ -2588,9 +2040,9 @@ Document sharded successfully:
|
|
|
2588
2040
|
## Output Deliverables
|
|
2589
2041
|
|
|
2590
2042
|
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
|
2591
|
-
- A summary of the
|
|
2043
|
+
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
|
2592
2044
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
|
2593
|
-
- **Implicit:** An annotated
|
|
2045
|
+
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
|
2594
2046
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
|
2595
2047
|
|
|
2596
2048
|
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
|
@@ -3917,15 +3369,14 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
|
|
|
3917
3369
|
- Verify all source references are included for technical details
|
|
3918
3370
|
- Ensure tasks align with both epic requirements and architecture constraints
|
|
3919
3371
|
- Update status to "Draft" and save the story file
|
|
3920
|
-
-
|
|
3921
|
-
- Execute `tasks/execute-checklist` `checklists/story-draft-checklist`
|
|
3372
|
+
- Execute `.bmad-core/tasks/execute-checklist` `.bmad-core/checklists/story-draft-checklist`
|
|
3922
3373
|
- Provide summary to user including:
|
|
3923
3374
|
- Story created: `{devStoryLocation}/{epicNum}.{storyNum}.story.md`
|
|
3924
3375
|
- Status: Draft
|
|
3925
3376
|
- Key technical components included from architecture docs
|
|
3926
3377
|
- Any deviations or conflicts noted between epic and architecture
|
|
3927
3378
|
- Checklist Results
|
|
3928
|
-
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task
|
|
3379
|
+
- Next steps: For Complex stories, suggest the user carefully review the story draft and also optionally have the PO run the task `.bmad-core/tasks/validate-next-story`
|
|
3929
3380
|
==================== END: .bmad-core/tasks/create-next-story.md ====================
|
|
3930
3381
|
|
|
3931
3382
|
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
|
|
@@ -4194,9 +3645,7 @@ Be honest - it's better to flag issues now than have them discovered later.]]
|
|
|
4194
3645
|
==================== START: .bmad-core/tasks/review-story.md ====================
|
|
4195
3646
|
# review-story
|
|
4196
3647
|
|
|
4197
|
-
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
|
4198
|
-
|
|
4199
|
-
[[LLM: QA Agent executing review-story task as Senior Developer]]
|
|
3648
|
+
When a developer agent marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
|
4200
3649
|
|
|
4201
3650
|
## Prerequisites
|
|
4202
3651
|
|
|
@@ -4325,6 +3774,7 @@ After review and any refactoring, append your results to the story file in the Q
|
|
|
4325
3774
|
## Blocking Conditions
|
|
4326
3775
|
|
|
4327
3776
|
Stop the review and request clarification if:
|
|
3777
|
+
|
|
4328
3778
|
- Story file is incomplete or missing critical sections
|
|
4329
3779
|
- File List is empty or clearly incomplete
|
|
4330
3780
|
- No tests exist when they were required
|
|
@@ -4334,6 +3784,7 @@ Stop the review and request clarification if:
|
|
|
4334
3784
|
## Completion
|
|
4335
3785
|
|
|
4336
3786
|
After review:
|
|
3787
|
+
|
|
4337
3788
|
1. If all items are checked and approved: Update story status to "Done"
|
|
4338
3789
|
2. If unchecked items remain: Keep status as "Review" for dev to address
|
|
4339
3790
|
3. Always provide constructive feedback and explanations for learning
|