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
|
@@ -167,7 +167,6 @@ workflow-guidance:
|
|
|
167
167
|
- Understand each workflow's purpose, options, and decision points
|
|
168
168
|
- Ask clarifying questions based on the workflow's structure
|
|
169
169
|
- Guide users through workflow selection when multiple options exist
|
|
170
|
-
- For complex projects, offer to create a workflow plan using create-workflow-plan task
|
|
171
170
|
- When appropriate, suggest: Would you like me to create a detailed workflow plan before starting?
|
|
172
171
|
- For workflows with divergent paths, help users choose the right path
|
|
173
172
|
- Adapt questions to the specific domain (e.g., game dev vs infrastructure vs web dev)
|
|
@@ -177,9 +176,7 @@ dependencies:
|
|
|
177
176
|
tasks:
|
|
178
177
|
- advanced-elicitation.md
|
|
179
178
|
- create-doc.md
|
|
180
|
-
- create-workflow-plan.md
|
|
181
179
|
- kb-mode-interaction.md
|
|
182
|
-
- update-workflow-plan.md
|
|
183
180
|
data:
|
|
184
181
|
- bmad-kb.md
|
|
185
182
|
- elicitation-methods.md
|
|
@@ -639,302 +636,11 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
|
|
|
639
636
|
- End with "Select 1-9 or just type your question/feedback:"
|
|
640
637
|
==================== END: .bmad-core/tasks/create-doc.md ====================
|
|
641
638
|
|
|
642
|
-
==================== START: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
643
|
-
# Create Workflow Plan Task
|
|
644
|
-
|
|
645
|
-
## Purpose
|
|
646
|
-
|
|
647
|
-
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.
|
|
648
|
-
|
|
649
|
-
## Task Instructions
|
|
650
|
-
|
|
651
|
-
### 1. Understand User's Goal
|
|
652
|
-
|
|
653
|
-
[[LLM: Start with discovery questions to understand what the user wants to accomplish]]
|
|
654
|
-
|
|
655
|
-
Ask the user:
|
|
656
|
-
|
|
657
|
-
1. **Project Type**:
|
|
658
|
-
- Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
|
|
659
|
-
- What type of application? (web app, service/API, UI only, full-stack)
|
|
660
|
-
|
|
661
|
-
2. **For Greenfield**:
|
|
662
|
-
- Do you need a quick prototype or production-ready application?
|
|
663
|
-
- Will this have a UI component?
|
|
664
|
-
- Single service or multiple services?
|
|
665
|
-
|
|
666
|
-
3. **For Brownfield**:
|
|
667
|
-
- What's the scope of the enhancement?
|
|
668
|
-
- Single bug fix or small feature (few hours)
|
|
669
|
-
- Small enhancement (1-3 stories)
|
|
670
|
-
- Major feature requiring coordination
|
|
671
|
-
- Architectural changes or modernization
|
|
672
|
-
- Do you have existing documentation?
|
|
673
|
-
- Are you following existing patterns or introducing new ones?
|
|
674
|
-
|
|
675
|
-
### 2. Recommend Appropriate Workflow
|
|
676
|
-
|
|
677
|
-
Based on the answers, recommend:
|
|
678
|
-
|
|
679
|
-
**Greenfield Options:**
|
|
680
|
-
|
|
681
|
-
- `greenfield-fullstack` - Complete web application
|
|
682
|
-
- `greenfield-service` - Backend API/service only
|
|
683
|
-
- `greenfield-ui` - Frontend only
|
|
684
|
-
|
|
685
|
-
**Brownfield Options:**
|
|
686
|
-
|
|
687
|
-
- `brownfield-create-story` - Single small change
|
|
688
|
-
- `brownfield-create-epic` - Small feature (1-3 stories)
|
|
689
|
-
- `brownfield-fullstack` - Major enhancement
|
|
690
|
-
|
|
691
|
-
**Simplified Option:**
|
|
692
|
-
|
|
693
|
-
- For users unsure or wanting flexibility, suggest starting with individual agent tasks
|
|
694
|
-
|
|
695
|
-
### 3. Explain Selected Workflow
|
|
696
|
-
|
|
697
|
-
[[LLM: Once workflow is selected, provide clear explanation]]
|
|
698
|
-
|
|
699
|
-
For the selected workflow, explain:
|
|
700
|
-
|
|
701
|
-
1. **Overview**: What this workflow accomplishes
|
|
702
|
-
2. **Duration**: Estimated time for planning phase
|
|
703
|
-
3. **Outputs**: What documents will be created
|
|
704
|
-
4. **Decision Points**: Where user input will be needed
|
|
705
|
-
5. **Requirements**: What information should be ready
|
|
706
|
-
|
|
707
|
-
### 4. Create Workflow Plan Document
|
|
708
|
-
|
|
709
|
-
[[LLM: Generate a comprehensive plan document with the following structure]]
|
|
710
|
-
|
|
711
|
-
```markdown
|
|
712
|
-
# Workflow Plan: {{Workflow Name}}
|
|
713
|
-
|
|
714
|
-
<!-- WORKFLOW-PLAN-META
|
|
715
|
-
workflow-id: {{workflow-id}}
|
|
716
|
-
status: active
|
|
717
|
-
created: {{ISO-8601 timestamp}}
|
|
718
|
-
updated: {{ISO-8601 timestamp}}
|
|
719
|
-
version: 1.0
|
|
720
|
-
-->
|
|
721
|
-
|
|
722
|
-
**Created Date**: {{current date}}
|
|
723
|
-
**Project**: {{project name}}
|
|
724
|
-
**Type**: {{greenfield/brownfield}}
|
|
725
|
-
**Status**: Active
|
|
726
|
-
**Estimated Planning Duration**: {{time estimate}}
|
|
727
|
-
|
|
728
|
-
## Objective
|
|
729
|
-
|
|
730
|
-
{{Clear description of what will be accomplished}}
|
|
731
|
-
|
|
732
|
-
## Selected Workflow
|
|
733
|
-
|
|
734
|
-
**Workflow**: `{{workflow-id}}`
|
|
735
|
-
**Reason**: {{Why this workflow fits the user's needs}}
|
|
736
|
-
|
|
737
|
-
## Workflow Steps
|
|
738
|
-
|
|
739
|
-
### Planning Phase
|
|
740
|
-
|
|
741
|
-
- [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
|
|
742
|
-
- **Agent**: {{agent name}}
|
|
743
|
-
- **Action**: {{what happens}}
|
|
744
|
-
- **Output**: {{what's created}}
|
|
745
|
-
- **User Input**: {{if any}}
|
|
746
|
-
|
|
747
|
-
- [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
|
|
748
|
-
- **Agent**: {{agent name}}
|
|
749
|
-
- **Action**: {{what happens}}
|
|
750
|
-
- **Output**: {{what's created}}
|
|
751
|
-
- **Decision Point**: {{if any}} <!-- decision-id: D1 -->
|
|
752
|
-
|
|
753
|
-
{{Continue for all planning steps}}
|
|
754
|
-
|
|
755
|
-
### Development Phase (IDE)
|
|
756
|
-
|
|
757
|
-
- [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
|
|
758
|
-
- Prepare documents for story creation
|
|
759
|
-
|
|
760
|
-
- [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
|
|
761
|
-
- [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
|
|
762
|
-
- [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
|
|
763
|
-
- [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
|
|
764
|
-
- [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
|
|
765
|
-
- [ ] Repeat for all stories
|
|
766
|
-
|
|
767
|
-
- [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
|
|
768
|
-
|
|
769
|
-
## Key Decision Points
|
|
770
|
-
|
|
771
|
-
1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
|
|
772
|
-
- Trigger: {{what causes this decision}}
|
|
773
|
-
- Options: {{available choices}}
|
|
774
|
-
- Impact: {{how it affects the workflow}}
|
|
775
|
-
- Decision Made: _Pending_
|
|
776
|
-
|
|
777
|
-
{{List all decision points}}
|
|
778
|
-
|
|
779
|
-
## Expected Outputs
|
|
780
|
-
|
|
781
|
-
### Planning Documents
|
|
782
|
-
- [ ] {{document 1}} - {{description}}
|
|
783
|
-
- [ ] {{document 2}} - {{description}}
|
|
784
|
-
{{etc...}}
|
|
785
|
-
|
|
786
|
-
### Development Artifacts
|
|
787
|
-
- [ ] Stories in `docs/stories/`
|
|
788
|
-
- [ ] Implementation code
|
|
789
|
-
- [ ] Tests
|
|
790
|
-
- [ ] Updated documentation
|
|
791
|
-
|
|
792
|
-
## Prerequisites Checklist
|
|
793
|
-
|
|
794
|
-
Before starting this workflow, ensure you have:
|
|
795
|
-
|
|
796
|
-
- [ ] {{prerequisite 1}}
|
|
797
|
-
- [ ] {{prerequisite 2}}
|
|
798
|
-
- [ ] {{prerequisite 3}}
|
|
799
|
-
{{etc...}}
|
|
800
|
-
|
|
801
|
-
## Customization Options
|
|
802
|
-
|
|
803
|
-
Based on your project needs, you may:
|
|
804
|
-
- Skip {{optional step}} if {{condition}}
|
|
805
|
-
- Add {{additional step}} if {{condition}}
|
|
806
|
-
- Choose {{alternative}} instead of {{default}}
|
|
807
|
-
|
|
808
|
-
## Risk Considerations
|
|
809
|
-
|
|
810
|
-
{{For brownfield only}}
|
|
811
|
-
- Integration complexity: {{assessment}}
|
|
812
|
-
- Rollback strategy: {{approach}}
|
|
813
|
-
- Testing requirements: {{special needs}}
|
|
814
|
-
|
|
815
|
-
## Next Steps
|
|
816
|
-
|
|
817
|
-
1. Review this plan and confirm it matches your expectations
|
|
818
|
-
2. Gather any missing prerequisites
|
|
819
|
-
3. Start workflow with: `*task workflow {{workflow-id}}`
|
|
820
|
-
4. Or begin with first agent: `@{{first-agent}}`
|
|
821
|
-
|
|
822
|
-
## Notes
|
|
823
|
-
|
|
824
|
-
{{Any additional context or warnings}}
|
|
825
|
-
|
|
826
|
-
---
|
|
827
|
-
*This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
|
|
828
|
-
```
|
|
829
|
-
|
|
830
|
-
### 5. Save and Present Plan
|
|
831
|
-
|
|
832
|
-
1. Save the plan as `docs/workflow-plan.md`
|
|
833
|
-
2. Inform user: "Workflow plan created at docs/workflow-plan.md"
|
|
834
|
-
3. Offer options:
|
|
835
|
-
- Review the plan together
|
|
836
|
-
- Start the workflow now
|
|
837
|
-
- Gather prerequisites first
|
|
838
|
-
- Modify the plan
|
|
839
|
-
|
|
840
|
-
### 6. Plan Variations
|
|
841
|
-
|
|
842
|
-
[[LLM: Adjust plan detail based on workflow complexity]]
|
|
843
|
-
|
|
844
|
-
**For Simple Workflows** (create-story, create-epic):
|
|
845
|
-
|
|
846
|
-
- Simpler checklist format
|
|
847
|
-
- Focus on immediate next steps
|
|
848
|
-
- Less detailed explanations
|
|
849
|
-
|
|
850
|
-
**For Complex Workflows** (full greenfield/brownfield):
|
|
851
|
-
|
|
852
|
-
- Detailed step breakdowns
|
|
853
|
-
- All decision points documented
|
|
854
|
-
- Comprehensive output descriptions
|
|
855
|
-
- Risk mitigation sections
|
|
856
|
-
|
|
857
|
-
**For Brownfield Workflows**:
|
|
858
|
-
|
|
859
|
-
- Include existing system impact analysis
|
|
860
|
-
- Document integration checkpoints
|
|
861
|
-
- Add rollback considerations
|
|
862
|
-
- Note documentation dependencies
|
|
863
|
-
|
|
864
|
-
### 7. Interactive Planning Mode
|
|
865
|
-
|
|
866
|
-
[[LLM: If user wants to customize the workflow]]
|
|
867
|
-
|
|
868
|
-
If user wants to modify the standard workflow:
|
|
869
|
-
|
|
870
|
-
1. Present workflow steps as options
|
|
871
|
-
2. Allow skipping optional steps
|
|
872
|
-
3. Let user reorder certain steps
|
|
873
|
-
4. Document customizations in plan
|
|
874
|
-
5. Warn about dependencies if steps are skipped
|
|
875
|
-
|
|
876
|
-
### 8. Execution Guidance
|
|
877
|
-
|
|
878
|
-
After plan is created, provide clear guidance:
|
|
879
|
-
|
|
880
|
-
```text
|
|
881
|
-
Your workflow plan is ready! Here's how to proceed:
|
|
882
|
-
|
|
883
|
-
1. **Review the plan**: Check that all steps align with your goals
|
|
884
|
-
2. **Gather prerequisites**: Use the checklist to ensure you're ready
|
|
885
|
-
3. **Start execution**:
|
|
886
|
-
- Full workflow: `*task workflow {{workflow-id}}`
|
|
887
|
-
- Step by step: Start with `@{{first-agent}}`
|
|
888
|
-
4. **Track progress**: Check off steps in the plan as completed
|
|
889
|
-
|
|
890
|
-
Would you like to:
|
|
891
|
-
a) Review the plan together
|
|
892
|
-
b) Start the workflow now
|
|
893
|
-
c) Gather prerequisites first
|
|
894
|
-
d) Modify the plan
|
|
895
|
-
```
|
|
896
|
-
|
|
897
|
-
## Success Criteria
|
|
898
|
-
|
|
899
|
-
The workflow plan is successful when:
|
|
900
|
-
|
|
901
|
-
1. User clearly understands what will happen
|
|
902
|
-
2. All decision points are documented
|
|
903
|
-
3. Prerequisites are identified
|
|
904
|
-
4. Expected outputs are clear
|
|
905
|
-
5. User feels confident to proceed
|
|
906
|
-
6. Plan serves as useful progress tracker
|
|
907
|
-
|
|
908
|
-
## Integration with BMad Master and Orchestrator
|
|
909
|
-
|
|
910
|
-
When used by BMad Master or BMad Orchestrator, this task should:
|
|
911
|
-
|
|
912
|
-
1. Be offered when user asks about workflows
|
|
913
|
-
2. Be suggested before starting complex workflows
|
|
914
|
-
3. Create a plan that the agent can reference during execution
|
|
915
|
-
4. Allow the agent to track progress against the plan
|
|
916
|
-
|
|
917
|
-
## Example Usage
|
|
918
|
-
|
|
919
|
-
```text
|
|
920
|
-
User: "I need to add a payment system to my existing app"
|
|
921
|
-
|
|
922
|
-
BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
|
|
923
|
-
|
|
924
|
-
[Runs through discovery questions]
|
|
925
|
-
|
|
926
|
-
BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
|
|
927
|
-
|
|
928
|
-
[Creates and saves plan]
|
|
929
|
-
|
|
930
|
-
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?"
|
|
931
|
-
```
|
|
932
|
-
==================== END: .bmad-core/tasks/create-workflow-plan.md ====================
|
|
933
|
-
|
|
934
639
|
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
935
640
|
# KB Mode Interaction Task
|
|
936
641
|
|
|
937
642
|
## Purpose
|
|
643
|
+
|
|
938
644
|
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
|
939
645
|
|
|
940
646
|
## Instructions
|
|
@@ -942,11 +648,11 @@ Provide a user-friendly interface to the BMad knowledge base without overwhelmin
|
|
|
942
648
|
When entering KB mode (*kb-mode), follow these steps:
|
|
943
649
|
|
|
944
650
|
### 1. Welcome and Guide
|
|
945
|
-
Announce entering KB mode with a brief, friendly introduction:
|
|
946
651
|
|
|
947
|
-
|
|
652
|
+
Announce entering KB mode with a brief, friendly introduction.
|
|
948
653
|
|
|
949
654
|
### 2. Present Topic Areas
|
|
655
|
+
|
|
950
656
|
Offer a concise list of main topic areas the user might want to explore:
|
|
951
657
|
|
|
952
658
|
**What would you like to know more about?**
|
|
@@ -963,19 +669,23 @@ Offer a concise list of main topic areas the user might want to explore:
|
|
|
963
669
|
Or ask me about anything else related to BMad-Method!
|
|
964
670
|
|
|
965
671
|
### 3. Respond Contextually
|
|
672
|
+
|
|
966
673
|
- Wait for user's specific question or topic selection
|
|
967
674
|
- Provide focused, relevant information from the knowledge base
|
|
968
675
|
- Offer to dive deeper or explore related topics
|
|
969
676
|
- Keep responses concise unless user asks for detailed explanations
|
|
970
677
|
|
|
971
678
|
### 4. Interactive Exploration
|
|
679
|
+
|
|
972
680
|
- After answering, suggest related topics they might find helpful
|
|
973
681
|
- Maintain conversational flow rather than data dumping
|
|
974
682
|
- Use examples when appropriate
|
|
975
683
|
- Reference specific documentation sections when relevant
|
|
976
684
|
|
|
977
685
|
### 5. Exit Gracefully
|
|
686
|
+
|
|
978
687
|
When user is done or wants to exit KB mode:
|
|
688
|
+
|
|
979
689
|
- Summarize key points discussed if helpful
|
|
980
690
|
- Remind them they can return to KB mode anytime with *kb-mode
|
|
981
691
|
- Suggest next steps based on what was discussed
|
|
@@ -1004,257 +714,6 @@ Or ask me about anything else related to BMad-Method!
|
|
|
1004
714
|
**Assistant**: [Provides focused information about workflows from the KB, then offers to explore specific workflow types or related topics]
|
|
1005
715
|
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
|
|
1006
716
|
|
|
1007
|
-
==================== START: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
1008
|
-
# Update Workflow Plan Task
|
|
1009
|
-
|
|
1010
|
-
## Purpose
|
|
1011
|
-
|
|
1012
|
-
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.
|
|
1013
|
-
|
|
1014
|
-
## Task Instructions
|
|
1015
|
-
|
|
1016
|
-
### 0. Load Plan Configuration
|
|
1017
|
-
|
|
1018
|
-
[[LLM: First load core-config.yaml to get plan settings]]
|
|
1019
|
-
|
|
1020
|
-
Check workflow configuration:
|
|
1021
|
-
|
|
1022
|
-
- `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
|
|
1023
|
-
- `workflow.trackProgress` - Whether tracking is enabled
|
|
1024
|
-
- `workflow.updateOnCompletion` - Whether to auto-update on task completion
|
|
1025
|
-
|
|
1026
|
-
If tracking is disabled, inform user and exit.
|
|
1027
|
-
|
|
1028
|
-
### 1. Verify Plan Exists
|
|
1029
|
-
|
|
1030
|
-
[[LLM: Check if workflow plan exists at configured location]]
|
|
1031
|
-
|
|
1032
|
-
If no plan exists:
|
|
1033
|
-
|
|
1034
|
-
```
|
|
1035
|
-
No active workflow plan found at {location}.
|
|
1036
|
-
Would you like to create one? Use *plan command.
|
|
1037
|
-
```
|
|
1038
|
-
|
|
1039
|
-
### 2. Determine Update Type
|
|
1040
|
-
|
|
1041
|
-
[[LLM: Ask user what type of update they want to make]]
|
|
1042
|
-
|
|
1043
|
-
Present options:
|
|
1044
|
-
|
|
1045
|
-
```
|
|
1046
|
-
What would you like to update in the workflow plan?
|
|
1047
|
-
|
|
1048
|
-
1. Mark step as complete
|
|
1049
|
-
2. Update current step
|
|
1050
|
-
3. Add deviation note
|
|
1051
|
-
4. Mark decision point resolution
|
|
1052
|
-
5. Update overall status
|
|
1053
|
-
6. View current plan status only
|
|
1054
|
-
|
|
1055
|
-
Please select an option (1-6):
|
|
1056
|
-
```
|
|
1057
|
-
|
|
1058
|
-
### 3. Parse Current Plan
|
|
1059
|
-
|
|
1060
|
-
[[LLM: Read and parse the plan to understand current state]]
|
|
1061
|
-
|
|
1062
|
-
Extract:
|
|
1063
|
-
|
|
1064
|
-
- All steps with their checkbox status
|
|
1065
|
-
- Step IDs from comments (if present)
|
|
1066
|
-
- Current completion percentage
|
|
1067
|
-
- Any existing deviation notes
|
|
1068
|
-
- Decision points and their status
|
|
1069
|
-
|
|
1070
|
-
### 4. Execute Updates
|
|
1071
|
-
|
|
1072
|
-
#### 4.1 Mark Step Complete
|
|
1073
|
-
|
|
1074
|
-
If user selected option 1:
|
|
1075
|
-
|
|
1076
|
-
1. Show numbered list of incomplete steps
|
|
1077
|
-
2. Ask which step to mark complete
|
|
1078
|
-
3. Update the checkbox from `[ ]` to `[x]`
|
|
1079
|
-
4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
|
|
1080
|
-
5. If this was the current step, identify next step
|
|
1081
|
-
|
|
1082
|
-
#### 4.2 Update Current Step
|
|
1083
|
-
|
|
1084
|
-
If user selected option 2:
|
|
1085
|
-
|
|
1086
|
-
1. Show all steps with current status
|
|
1087
|
-
2. Ask which step is now current
|
|
1088
|
-
3. Add/move `<!-- current-step -->` marker
|
|
1089
|
-
4. Optionally add note about why sequence changed
|
|
1090
|
-
|
|
1091
|
-
#### 4.3 Add Deviation Note
|
|
1092
|
-
|
|
1093
|
-
If user selected option 3:
|
|
1094
|
-
|
|
1095
|
-
1. Ask for deviation description
|
|
1096
|
-
2. Ask which step this relates to (or general)
|
|
1097
|
-
3. Insert note in appropriate location:
|
|
1098
|
-
|
|
1099
|
-
```markdown
|
|
1100
|
-
> **Deviation Note** (YYYY-MM-DD): {user_note}
|
|
1101
|
-
> Related to: Step X.Y or General workflow
|
|
1102
|
-
```
|
|
1103
|
-
|
|
1104
|
-
#### 4.4 Mark Decision Resolution
|
|
1105
|
-
|
|
1106
|
-
If user selected option 4:
|
|
1107
|
-
|
|
1108
|
-
1. Show pending decision points
|
|
1109
|
-
2. Ask which decision was made
|
|
1110
|
-
3. Record the decision and chosen path
|
|
1111
|
-
4. Update related steps based on decision
|
|
1112
|
-
|
|
1113
|
-
#### 4.5 Update Overall Status
|
|
1114
|
-
|
|
1115
|
-
If user selected option 5:
|
|
1116
|
-
|
|
1117
|
-
1. Show current overall status
|
|
1118
|
-
2. Provide options:
|
|
1119
|
-
- Active (continuing with plan)
|
|
1120
|
-
- Paused (temporarily stopped)
|
|
1121
|
-
- Abandoned (no longer following)
|
|
1122
|
-
- Complete (all steps done)
|
|
1123
|
-
3. Update plan header with new status
|
|
1124
|
-
|
|
1125
|
-
### 5. Automatic Updates (When Called by Tasks)
|
|
1126
|
-
|
|
1127
|
-
[[LLM: When called automatically by another task]]
|
|
1128
|
-
|
|
1129
|
-
If called with parameters:
|
|
1130
|
-
|
|
1131
|
-
```
|
|
1132
|
-
task: {task_name}
|
|
1133
|
-
step_id: {step_identifier}
|
|
1134
|
-
status: complete|skipped|failed
|
|
1135
|
-
note: {optional_note}
|
|
1136
|
-
```
|
|
1137
|
-
|
|
1138
|
-
Automatically:
|
|
1139
|
-
|
|
1140
|
-
1. Find the corresponding step
|
|
1141
|
-
2. Update its status
|
|
1142
|
-
3. Add completion metadata
|
|
1143
|
-
4. Add note if provided
|
|
1144
|
-
5. Calculate new progress percentage
|
|
1145
|
-
|
|
1146
|
-
### 6. Generate Update Summary
|
|
1147
|
-
|
|
1148
|
-
After updates, show summary:
|
|
1149
|
-
|
|
1150
|
-
```
|
|
1151
|
-
✅ Workflow Plan Updated
|
|
1152
|
-
|
|
1153
|
-
Changes made:
|
|
1154
|
-
- {change_1}
|
|
1155
|
-
- {change_2}
|
|
1156
|
-
|
|
1157
|
-
New Status:
|
|
1158
|
-
- Progress: {X}% complete ({completed}/{total} steps)
|
|
1159
|
-
- Current Step: {current_step}
|
|
1160
|
-
- Next Recommended: {next_step}
|
|
1161
|
-
|
|
1162
|
-
Plan location: {file_path}
|
|
1163
|
-
```
|
|
1164
|
-
|
|
1165
|
-
### 7. Integration with Other Tasks
|
|
1166
|
-
|
|
1167
|
-
[[LLM: How other tasks should call this]]
|
|
1168
|
-
|
|
1169
|
-
Other tasks can integrate by:
|
|
1170
|
-
|
|
1171
|
-
1. **After Task Completion**:
|
|
1172
|
-
|
|
1173
|
-
```
|
|
1174
|
-
At end of task execution:
|
|
1175
|
-
- Check if task corresponds to a plan step
|
|
1176
|
-
- If yes, call update-workflow-plan with:
|
|
1177
|
-
- task: {current_task_name}
|
|
1178
|
-
- step_id: {matching_step}
|
|
1179
|
-
- status: complete
|
|
1180
|
-
```
|
|
1181
|
-
|
|
1182
|
-
2. **On Task Failure**:
|
|
1183
|
-
|
|
1184
|
-
```
|
|
1185
|
-
If task fails:
|
|
1186
|
-
- Call update-workflow-plan with:
|
|
1187
|
-
- task: {current_task_name}
|
|
1188
|
-
- status: failed
|
|
1189
|
-
- note: {failure_reason}
|
|
1190
|
-
```
|
|
1191
|
-
|
|
1192
|
-
### 8. Plan Status Display
|
|
1193
|
-
|
|
1194
|
-
[[LLM: When user selects view status only]]
|
|
1195
|
-
|
|
1196
|
-
Display comprehensive status:
|
|
1197
|
-
|
|
1198
|
-
```markdown
|
|
1199
|
-
📋 Workflow Plan Status
|
|
1200
|
-
━━━━━━━━━━━━━━━━━━━━
|
|
1201
|
-
Workflow: {workflow_name}
|
|
1202
|
-
Status: {Active|Paused|Complete}
|
|
1203
|
-
Progress: {X}% complete ({completed}/{total} steps)
|
|
1204
|
-
Last Updated: {timestamp}
|
|
1205
|
-
|
|
1206
|
-
✅ Completed Steps:
|
|
1207
|
-
- [x] Step 1.1: {description} (completed: {date})
|
|
1208
|
-
- [x] Step 1.2: {description} (completed: {date})
|
|
1209
|
-
|
|
1210
|
-
🔄 Current Step:
|
|
1211
|
-
- [ ] Step 2.1: {description} <!-- current-step -->
|
|
1212
|
-
Agent: {agent_name}
|
|
1213
|
-
Task: {task_name}
|
|
1214
|
-
|
|
1215
|
-
📌 Upcoming Steps:
|
|
1216
|
-
- [ ] Step 2.2: {description}
|
|
1217
|
-
- [ ] Step 3.1: {description}
|
|
1218
|
-
|
|
1219
|
-
⚠️ Deviations/Notes:
|
|
1220
|
-
{any_deviation_notes}
|
|
1221
|
-
|
|
1222
|
-
📊 Decision Points:
|
|
1223
|
-
- Decision 1: {status} - {choice_made}
|
|
1224
|
-
- Decision 2: Pending
|
|
1225
|
-
|
|
1226
|
-
💡 Next Action:
|
|
1227
|
-
Based on the plan, you should {recommended_action}
|
|
1228
|
-
```
|
|
1229
|
-
|
|
1230
|
-
## Success Criteria
|
|
1231
|
-
|
|
1232
|
-
The update is successful when:
|
|
1233
|
-
|
|
1234
|
-
1. Plan accurately reflects current workflow state
|
|
1235
|
-
2. All updates are clearly timestamped
|
|
1236
|
-
3. Deviations are documented with reasons
|
|
1237
|
-
4. Progress calculation is correct
|
|
1238
|
-
5. Next steps are clear to user
|
|
1239
|
-
6. Plan remains readable and well-formatted
|
|
1240
|
-
|
|
1241
|
-
## Error Handling
|
|
1242
|
-
|
|
1243
|
-
- **Plan file not found**: Offer to create new plan
|
|
1244
|
-
- **Malformed plan**: Attempt basic updates, warn user
|
|
1245
|
-
- **Write permission error**: Show changes that would be made
|
|
1246
|
-
- **Step not found**: Show available steps, ask for clarification
|
|
1247
|
-
- **Concurrent updates**: Implement simple locking or warn about conflicts
|
|
1248
|
-
|
|
1249
|
-
## Notes
|
|
1250
|
-
|
|
1251
|
-
- Always preserve plan history (don't delete old information)
|
|
1252
|
-
- Keep updates atomic to prevent corruption
|
|
1253
|
-
- Consider creating backup before major updates
|
|
1254
|
-
- Updates should enhance, not complicate, the workflow experience
|
|
1255
|
-
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
|
1256
|
-
==================== END: .bmad-core/tasks/update-workflow-plan.md ====================
|
|
1257
|
-
|
|
1258
717
|
==================== START: .bmad-core/data/bmad-kb.md ====================
|
|
1259
718
|
# BMad Knowledge Base
|
|
1260
719
|
|
|
@@ -2273,7 +1732,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
|
|
2273
1732
|
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
|
|
2274
1733
|
---
|
|
2275
1734
|
docOutputLocation: docs/brainstorming-session-results.md
|
|
2276
|
-
template: brainstorming-output-tmpl
|
|
1735
|
+
template: ".bmad-core/templates/brainstorming-output-tmpl.md"
|
|
2277
1736
|
---
|
|
2278
1737
|
|
|
2279
1738
|
# Facilitate Brainstorming Session Task
|
|
@@ -2426,7 +1885,7 @@ Generate well-structured research prompts that:
|
|
|
2426
1885
|
|
|
2427
1886
|
## Research Type Selection
|
|
2428
1887
|
|
|
2429
|
-
|
|
1888
|
+
CRITICAL: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.
|
|
2430
1889
|
|
|
2431
1890
|
### 1. Research Focus Options
|
|
2432
1891
|
|
|
@@ -2489,15 +1948,13 @@ Present these numbered options to the user:
|
|
|
2489
1948
|
- Consider regulatory and legal implications
|
|
2490
1949
|
|
|
2491
1950
|
9. **Custom Research Focus**
|
|
2492
|
-
|
|
1951
|
+
|
|
2493
1952
|
- User-defined research objectives
|
|
2494
1953
|
- Specialized domain investigation
|
|
2495
1954
|
- Cross-functional research needs
|
|
2496
1955
|
|
|
2497
1956
|
### 2. Input Processing
|
|
2498
1957
|
|
|
2499
|
-
[[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
|
|
2500
|
-
|
|
2501
1958
|
**If Project Brief provided:**
|
|
2502
1959
|
|
|
2503
1960
|
- Extract key product concepts and goals
|
|
@@ -2530,11 +1987,11 @@ Present these numbered options to the user:
|
|
|
2530
1987
|
|
|
2531
1988
|
### 3. Research Prompt Structure
|
|
2532
1989
|
|
|
2533
|
-
|
|
1990
|
+
CRITICAL: collaboratively develop a comprehensive research prompt with these components.
|
|
2534
1991
|
|
|
2535
1992
|
#### A. Research Objectives
|
|
2536
1993
|
|
|
2537
|
-
|
|
1994
|
+
CRITICAL: collaborate with the user to articulate clear, specific objectives for the research.
|
|
2538
1995
|
|
|
2539
1996
|
- Primary research goal and purpose
|
|
2540
1997
|
- Key decisions the research will inform
|
|
@@ -2543,7 +2000,7 @@ Present these numbered options to the user:
|
|
|
2543
2000
|
|
|
2544
2001
|
#### B. Research Questions
|
|
2545
2002
|
|
|
2546
|
-
|
|
2003
|
+
CRITICAL: collaborate with the user to develop specific, actionable research questions organized by theme.
|
|
2547
2004
|
|
|
2548
2005
|
**Core Questions:**
|
|
2549
2006
|
|
|
@@ -2559,8 +2016,6 @@ Present these numbered options to the user:
|
|
|
2559
2016
|
|
|
2560
2017
|
#### C. Research Methodology
|
|
2561
2018
|
|
|
2562
|
-
[[LLM: Specify appropriate research methods based on the type and objectives.]]
|
|
2563
|
-
|
|
2564
2019
|
**Data Collection Methods:**
|
|
2565
2020
|
|
|
2566
2021
|
- Secondary research sources
|
|
@@ -2577,8 +2032,6 @@ Present these numbered options to the user:
|
|
|
2577
2032
|
|
|
2578
2033
|
#### D. Output Requirements
|
|
2579
2034
|
|
|
2580
|
-
[[LLM: Define how research findings should be structured and presented.]]
|
|
2581
|
-
|
|
2582
2035
|
**Format Specifications:**
|
|
2583
2036
|
|
|
2584
2037
|
- Executive summary requirements
|
|
@@ -2595,8 +2048,6 @@ Present these numbered options to the user:
|
|
|
2595
2048
|
|
|
2596
2049
|
### 4. Prompt Generation
|
|
2597
2050
|
|
|
2598
|
-
[[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
|
|
2599
|
-
|
|
2600
2051
|
**Research Prompt Template:**
|
|
2601
2052
|
|
|
2602
2053
|
```markdown
|
|
@@ -2665,8 +2116,6 @@ Present these numbered options to the user:
|
|
|
2665
2116
|
|
|
2666
2117
|
### 5. Review and Refinement
|
|
2667
2118
|
|
|
2668
|
-
[[LLM: Present the draft research prompt for user review and refinement.]]
|
|
2669
|
-
|
|
2670
2119
|
1. **Present Complete Prompt**
|
|
2671
2120
|
|
|
2672
2121
|
- Show the full research prompt
|
|
@@ -2688,8 +2137,6 @@ Present these numbered options to the user:
|
|
|
2688
2137
|
|
|
2689
2138
|
### 6. Next Steps Guidance
|
|
2690
2139
|
|
|
2691
|
-
[[LLM: Provide clear guidance on how to use the research prompt.]]
|
|
2692
|
-
|
|
2693
2140
|
**Execution Options:**
|
|
2694
2141
|
|
|
2695
2142
|
1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
|
|
@@ -2724,9 +2171,9 @@ Generate comprehensive documentation for existing projects optimized for AI deve
|
|
|
2724
2171
|
|
|
2725
2172
|
### 1. Initial Project Analysis
|
|
2726
2173
|
|
|
2727
|
-
|
|
2174
|
+
**CRITICAL:** First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
|
2728
2175
|
|
|
2729
|
-
**IF PRD EXISTS**:
|
|
2176
|
+
**IF PRD EXISTS**:
|
|
2730
2177
|
|
|
2731
2178
|
- Review the PRD to understand what enhancement/feature is planned
|
|
2732
2179
|
- Identify which modules, services, or areas will be affected
|
|
@@ -2772,11 +2219,10 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
2772
2219
|
- Are there any existing documentation standards or formats you prefer?
|
|
2773
2220
|
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
|
2774
2221
|
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
|
2775
|
-
]]
|
|
2776
2222
|
|
|
2777
2223
|
### 2. Deep Codebase Analysis
|
|
2778
2224
|
|
|
2779
|
-
|
|
2225
|
+
CRITICAL: Before generating documentation, conduct extensive analysis of the existing codebase:
|
|
2780
2226
|
|
|
2781
2227
|
1. **Explore Key Areas**:
|
|
2782
2228
|
- Entry points (main files, index files, app initializers)
|
|
@@ -2799,13 +2245,14 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
2799
2245
|
- Document workarounds and technical debt
|
|
2800
2246
|
- Note areas that differ from standard patterns
|
|
2801
2247
|
|
|
2802
|
-
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
|
|
2248
|
+
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement
|
|
2803
2249
|
|
|
2804
2250
|
### 3. Core Documentation Generation
|
|
2805
2251
|
|
|
2806
2252
|
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
|
2807
2253
|
|
|
2808
2254
|
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
|
2255
|
+
|
|
2809
2256
|
- Technical debt and workarounds
|
|
2810
2257
|
- Inconsistent patterns between different parts
|
|
2811
2258
|
- Legacy code that can't be changed
|
|
@@ -2817,13 +2264,16 @@ Ask the user these elicitation questions to better understand their needs:
|
|
|
2817
2264
|
# [Project Name] Brownfield Architecture Document
|
|
2818
2265
|
|
|
2819
2266
|
## Introduction
|
|
2267
|
+
|
|
2820
2268
|
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
|
2821
2269
|
|
|
2822
2270
|
### Document Scope
|
|
2271
|
+
|
|
2823
2272
|
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
|
2824
2273
|
[If no PRD: "Comprehensive documentation of entire system"]
|
|
2825
2274
|
|
|
2826
2275
|
### Change Log
|
|
2276
|
+
|
|
2827
2277
|
| Date | Version | Description | Author |
|
|
2828
2278
|
|------|---------|-------------|--------|
|
|
2829
2279
|
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
|
@@ -2831,6 +2281,7 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
2831
2281
|
## Quick Reference - Key Files and Entry Points
|
|
2832
2282
|
|
|
2833
2283
|
### Critical Files for Understanding the System
|
|
2284
|
+
|
|
2834
2285
|
- **Main Entry**: `src/index.js` (or actual entry point)
|
|
2835
2286
|
- **Configuration**: `config/app.config.js`, `.env.example`
|
|
2836
2287
|
- **Core Business Logic**: `src/services/`, `src/domain/`
|
|
@@ -2839,22 +2290,25 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
2839
2290
|
- **Key Algorithms**: [List specific files with complex logic]
|
|
2840
2291
|
|
|
2841
2292
|
### If PRD Provided - Enhancement Impact Areas
|
|
2293
|
+
|
|
2842
2294
|
[Highlight which files/modules will be affected by the planned enhancement]
|
|
2843
2295
|
|
|
2844
2296
|
## High Level Architecture
|
|
2845
2297
|
|
|
2846
2298
|
### Technical Summary
|
|
2847
|
-
[Real assessment of architecture - mention if it's well-structured or has issues]
|
|
2848
2299
|
|
|
2849
2300
|
### Actual Tech Stack (from package.json/requirements.txt)
|
|
2301
|
+
|
|
2850
2302
|
| Category | Technology | Version | Notes |
|
|
2851
2303
|
|----------|------------|---------|--------|
|
|
2852
2304
|
| Runtime | Node.js | 16.x | [Any constraints] |
|
|
2853
2305
|
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
|
2854
2306
|
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
|
2855
|
-
|
|
2307
|
+
|
|
2308
|
+
etc...
|
|
2856
2309
|
|
|
2857
2310
|
### Repository Structure Reality Check
|
|
2311
|
+
|
|
2858
2312
|
- Type: [Monorepo/Polyrepo/Hybrid]
|
|
2859
2313
|
- Package Manager: [npm/yarn/pnpm]
|
|
2860
2314
|
- Notable: [Any unusual structure decisions]
|
|
@@ -2862,7 +2316,8 @@ This document captures the CURRENT STATE of the [Project Name] codebase, includi
|
|
|
2862
2316
|
## Source Tree and Module Organization
|
|
2863
2317
|
|
|
2864
2318
|
### Project Structure (Actual)
|
|
2865
|
-
|
|
2319
|
+
|
|
2320
|
+
```text
|
|
2866
2321
|
project-root/
|
|
2867
2322
|
├── src/
|
|
2868
2323
|
│ ├── controllers/ # HTTP request handlers
|
|
@@ -2876,6 +2331,7 @@ project-root/
|
|
|
2876
2331
|
```
|
|
2877
2332
|
|
|
2878
2333
|
### Key Modules and Their Purpose
|
|
2334
|
+
|
|
2879
2335
|
- **User Management**: `src/services/userService.js` - Handles all user operations
|
|
2880
2336
|
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
|
2881
2337
|
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
|
@@ -2884,12 +2340,14 @@ project-root/
|
|
|
2884
2340
|
## Data Models and APIs
|
|
2885
2341
|
|
|
2886
2342
|
### Data Models
|
|
2343
|
+
|
|
2887
2344
|
Instead of duplicating, reference actual model files:
|
|
2888
2345
|
- **User Model**: See `src/models/User.js`
|
|
2889
2346
|
- **Order Model**: See `src/models/Order.js`
|
|
2890
2347
|
- **Related Types**: TypeScript definitions in `src/types/`
|
|
2891
2348
|
|
|
2892
2349
|
### API Specifications
|
|
2350
|
+
|
|
2893
2351
|
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
|
2894
2352
|
- **Postman Collection**: `docs/api/postman-collection.json`
|
|
2895
2353
|
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
|
@@ -2897,12 +2355,14 @@ Instead of duplicating, reference actual model files:
|
|
|
2897
2355
|
## Technical Debt and Known Issues
|
|
2898
2356
|
|
|
2899
2357
|
### Critical Technical Debt
|
|
2358
|
+
|
|
2900
2359
|
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
|
2901
2360
|
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
|
2902
2361
|
3. **Database Migrations**: Manually tracked, no proper migration tool
|
|
2903
2362
|
4. **[Other significant debt]**
|
|
2904
2363
|
|
|
2905
2364
|
### Workarounds and Gotchas
|
|
2365
|
+
|
|
2906
2366
|
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
|
2907
2367
|
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
|
2908
2368
|
- **[Other workarounds developers need to know]**
|
|
@@ -2910,13 +2370,16 @@ Instead of duplicating, reference actual model files:
|
|
|
2910
2370
|
## Integration Points and External Dependencies
|
|
2911
2371
|
|
|
2912
2372
|
### External Services
|
|
2373
|
+
|
|
2913
2374
|
| Service | Purpose | Integration Type | Key Files |
|
|
2914
2375
|
|---------|---------|------------------|-----------|
|
|
2915
2376
|
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
|
2916
2377
|
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
|
2917
|
-
|
|
2378
|
+
|
|
2379
|
+
etc...
|
|
2918
2380
|
|
|
2919
2381
|
### Internal Integration Points
|
|
2382
|
+
|
|
2920
2383
|
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
|
2921
2384
|
- **Background Jobs**: Redis queue, see `src/workers/`
|
|
2922
2385
|
- **[Other integrations]**
|
|
@@ -2924,11 +2387,13 @@ Instead of duplicating, reference actual model files:
|
|
|
2924
2387
|
## Development and Deployment
|
|
2925
2388
|
|
|
2926
2389
|
### Local Development Setup
|
|
2390
|
+
|
|
2927
2391
|
1. Actual steps that work (not ideal steps)
|
|
2928
2392
|
2. Known issues with setup
|
|
2929
2393
|
3. Required environment variables (see `.env.example`)
|
|
2930
2394
|
|
|
2931
2395
|
### Build and Deployment Process
|
|
2396
|
+
|
|
2932
2397
|
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
|
2933
2398
|
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
|
2934
2399
|
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
|
@@ -2936,12 +2401,14 @@ Instead of duplicating, reference actual model files:
|
|
|
2936
2401
|
## Testing Reality
|
|
2937
2402
|
|
|
2938
2403
|
### Current Test Coverage
|
|
2404
|
+
|
|
2939
2405
|
- Unit Tests: 60% coverage (Jest)
|
|
2940
2406
|
- Integration Tests: Minimal, in `tests/integration/`
|
|
2941
2407
|
- E2E Tests: None
|
|
2942
2408
|
- Manual Testing: Primary QA method
|
|
2943
2409
|
|
|
2944
2410
|
### Running Tests
|
|
2411
|
+
|
|
2945
2412
|
```bash
|
|
2946
2413
|
npm test # Runs unit tests
|
|
2947
2414
|
npm run test:integration # Runs integration tests (requires local DB)
|
|
@@ -2950,6 +2417,7 @@ npm run test:integration # Runs integration tests (requires local DB)
|
|
|
2950
2417
|
## If Enhancement PRD Provided - Impact Analysis
|
|
2951
2418
|
|
|
2952
2419
|
### Files That Will Need Modification
|
|
2420
|
+
|
|
2953
2421
|
Based on the enhancement requirements, these files will be affected:
|
|
2954
2422
|
- `src/services/userService.js` - Add new user fields
|
|
2955
2423
|
- `src/models/User.js` - Update schema
|
|
@@ -2957,11 +2425,13 @@ Based on the enhancement requirements, these files will be affected:
|
|
|
2957
2425
|
- [etc...]
|
|
2958
2426
|
|
|
2959
2427
|
### New Files/Modules Needed
|
|
2428
|
+
|
|
2960
2429
|
- `src/services/newFeatureService.js` - New business logic
|
|
2961
2430
|
- `src/models/NewFeature.js` - New data model
|
|
2962
2431
|
- [etc...]
|
|
2963
2432
|
|
|
2964
2433
|
### Integration Considerations
|
|
2434
|
+
|
|
2965
2435
|
- Will need to integrate with existing auth middleware
|
|
2966
2436
|
- Must follow existing response format in `src/utils/responseFormatter.js`
|
|
2967
2437
|
- [Other integration points]
|
|
@@ -2969,6 +2439,7 @@ Based on the enhancement requirements, these files will be affected:
|
|
|
2969
2439
|
## Appendix - Useful Commands and Scripts
|
|
2970
2440
|
|
|
2971
2441
|
### Frequently Used Commands
|
|
2442
|
+
|
|
2972
2443
|
```bash
|
|
2973
2444
|
npm run dev # Start development server
|
|
2974
2445
|
npm run build # Production build
|
|
@@ -2977,14 +2448,13 @@ npm run seed # Seed test data
|
|
|
2977
2448
|
```
|
|
2978
2449
|
|
|
2979
2450
|
### Debugging and Troubleshooting
|
|
2451
|
+
|
|
2980
2452
|
- **Logs**: Check `logs/app.log` for application logs
|
|
2981
2453
|
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
|
2982
2454
|
- **Common Issues**: See `docs/troubleshooting.md`]]
|
|
2983
2455
|
|
|
2984
2456
|
### 4. Document Delivery
|
|
2985
2457
|
|
|
2986
|
-
[[LLM: After generating the complete architecture document:
|
|
2987
|
-
|
|
2988
2458
|
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
|
2989
2459
|
- Present the entire document in one response (or multiple if too long)
|
|
2990
2460
|
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
|
@@ -2996,6 +2466,7 @@ npm run seed # Seed test data
|
|
|
2996
2466
|
- Can be sharded later using PO agent if desired
|
|
2997
2467
|
|
|
2998
2468
|
The document should be comprehensive enough that future agents can understand:
|
|
2469
|
+
|
|
2999
2470
|
- The actual state of the system (not idealized)
|
|
3000
2471
|
- Where to find key files and logic
|
|
3001
2472
|
- What technical debt exists
|
|
@@ -3004,7 +2475,7 @@ The document should be comprehensive enough that future agents can understand:
|
|
|
3004
2475
|
|
|
3005
2476
|
### 5. Quality Assurance
|
|
3006
2477
|
|
|
3007
|
-
|
|
2478
|
+
CRITICAL: Before finalizing the document:
|
|
3008
2479
|
|
|
3009
2480
|
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
|
3010
2481
|
2. **Completeness Review**: Ensure all major system components are documented
|
|
@@ -3012,7 +2483,7 @@ The document should be comprehensive enough that future agents can understand:
|
|
|
3012
2483
|
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
|
3013
2484
|
5. **Navigation**: Ensure document has clear section structure for easy reference
|
|
3014
2485
|
|
|
3015
|
-
Apply the advanced elicitation task after major sections to refine based on user feedback.
|
|
2486
|
+
Apply the advanced elicitation task after major sections to refine based on user feedback.
|
|
3016
2487
|
|
|
3017
2488
|
## Success Criteria
|
|
3018
2489
|
|
|
@@ -4011,9 +3482,9 @@ sections:
|
|
|
4011
3482
|
|
|
4012
3483
|
## Purpose
|
|
4013
3484
|
|
|
4014
|
-
- Guide a structured response to a change trigger using the
|
|
3485
|
+
- Guide a structured response to a change trigger using the `.bmad-core/checklists/change-checklist`.
|
|
4015
3486
|
- Analyze the impacts of the change on epics, project artifacts, and the MVP, guided by the checklist's structure.
|
|
4016
|
-
- Explore potential solutions (e.g., adjust scope, rollback elements,
|
|
3487
|
+
- Explore potential solutions (e.g., adjust scope, rollback elements, re-scope features) as prompted by the checklist.
|
|
4017
3488
|
- Draft specific, actionable proposed updates to any affected project artifacts (e.g., epics, user stories, PRD sections, architecture document sections) based on the analysis.
|
|
4018
3489
|
- Produce a consolidated "Sprint Change Proposal" document that contains the impact analysis and the clearly drafted proposed edits for user review and approval.
|
|
4019
3490
|
- Ensure a clear handoff path if the nature of the changes necessitates fundamental replanning by other core agents (like PM or Architect).
|
|
@@ -4025,19 +3496,16 @@ sections:
|
|
|
4025
3496
|
- **Acknowledge Task & Inputs:**
|
|
4026
3497
|
- Confirm with the user that the "Correct Course Task" (Change Navigation & Integration) is being initiated.
|
|
4027
3498
|
- Verify the change trigger and ensure you have the user's initial explanation of the issue and its perceived impact.
|
|
4028
|
-
- Confirm access to all relevant project artifacts (e.g., PRD, Epics/Stories, Architecture Documents, UI/UX Specifications) and, critically, the
|
|
3499
|
+
- 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`.
|
|
4029
3500
|
- **Establish Interaction Mode:**
|
|
4030
3501
|
- Ask the user their preferred interaction mode for this task:
|
|
4031
|
-
- **"Incrementally (Default & Recommended):** Shall we work through the
|
|
3502
|
+
- **"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."
|
|
4032
3503
|
- **"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."
|
|
4033
|
-
-
|
|
4034
|
-
- 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.
|
|
4035
|
-
- **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."
|
|
4036
|
-
<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>
|
|
3504
|
+
- 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."
|
|
4037
3505
|
|
|
4038
3506
|
### 2. Execute Checklist Analysis (Iteratively or Batched, per Interaction Mode)
|
|
4039
3507
|
|
|
4040
|
-
- Systematically work through Sections 1-4 of the
|
|
3508
|
+
- 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).
|
|
4041
3509
|
- For each checklist item or logical group of items (depending on interaction mode):
|
|
4042
3510
|
- Present the relevant prompt(s) or considerations from the checklist to the user.
|
|
4043
3511
|
- Request necessary information and actively analyze the relevant project artifacts (PRD, epics, architecture documents, story history, etc.) to assess the impact.
|
|
@@ -4060,7 +3528,7 @@ sections:
|
|
|
4060
3528
|
|
|
4061
3529
|
### 4. Generate "Sprint Change Proposal" with Edits
|
|
4062
3530
|
|
|
4063
|
-
- Synthesize the complete
|
|
3531
|
+
- 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.
|
|
4064
3532
|
- The proposal must clearly present:
|
|
4065
3533
|
- **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.
|
|
4066
3534
|
- **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]").
|
|
@@ -4077,9 +3545,9 @@ sections:
|
|
|
4077
3545
|
## Output Deliverables
|
|
4078
3546
|
|
|
4079
3547
|
- **Primary:** A "Sprint Change Proposal" document (in markdown format). This document will contain:
|
|
4080
|
-
- A summary of the
|
|
3548
|
+
- A summary of the change-checklist analysis (issue, impact, rationale for the chosen path).
|
|
4081
3549
|
- Specific, clearly drafted proposed edits for all affected project artifacts.
|
|
4082
|
-
- **Implicit:** An annotated
|
|
3550
|
+
- **Implicit:** An annotated change-checklist (or the record of its completion) reflecting the discussions, findings, and decisions made during the process.
|
|
4083
3551
|
==================== END: .bmad-core/tasks/correct-course.md ====================
|
|
4084
3552
|
|
|
4085
3553
|
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
|
|
@@ -4502,20 +3970,20 @@ The LLM will:
|
|
|
4502
3970
|
|
|
4503
3971
|
## Primary Method: Automatic with markdown-tree
|
|
4504
3972
|
|
|
4505
|
-
[[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}`.
|
|
3973
|
+
[[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}`.
|
|
4506
3974
|
|
|
4507
3975
|
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
|
4508
3976
|
|
|
4509
3977
|
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:
|
|
4510
3978
|
|
|
4511
3979
|
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4512
|
-
2. Or set markdownExploder to false in bmad-core/core-config.yaml
|
|
3980
|
+
2. Or set markdownExploder to false in .bmad-core/core-config.yaml
|
|
4513
3981
|
|
|
4514
3982
|
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
|
4515
3983
|
|
|
4516
3984
|
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
|
4517
3985
|
|
|
4518
|
-
1. Set markdownExploder to true in bmad-core/core-config.yaml
|
|
3986
|
+
1. Set markdownExploder to true in .bmad-core/core-config.yaml
|
|
4519
3987
|
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
|
4520
3988
|
|
|
4521
3989
|
I will now proceed with the manual sharding process."
|
|
@@ -4555,8 +4023,6 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
4555
4023
|
|
|
4556
4024
|
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
|
4557
4025
|
|
|
4558
|
-
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
|
4559
|
-
|
|
4560
4026
|
### Task Instructions
|
|
4561
4027
|
|
|
4562
4028
|
1. Identify Document and Target Location
|
|
@@ -4567,7 +4033,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
|
|
4567
4033
|
|
|
4568
4034
|
2. Parse and Extract Sections
|
|
4569
4035
|
|
|
4570
|
-
|
|
4036
|
+
CRITICAL AEGNT SHARDING RULES:
|
|
4571
4037
|
|
|
4572
4038
|
1. Read the entire document content
|
|
4573
4039
|
2. Identify all level 2 sections (## headings)
|
|
@@ -4628,8 +4094,6 @@ Create an `index.md` file in the sharded folder that:
|
|
|
4628
4094
|
|
|
4629
4095
|
### 5. Preserve Special Content
|
|
4630
4096
|
|
|
4631
|
-
[[LLM: Pay special attention to preserving:
|
|
4632
|
-
|
|
4633
4097
|
1. **Code blocks**: Must capture complete blocks including:
|
|
4634
4098
|
|
|
4635
4099
|
```language
|
|
@@ -4651,7 +4115,7 @@ Create an `index.md` file in the sharded folder that:
|
|
|
4651
4115
|
|
|
4652
4116
|
6. **Links and references**: Keep all markdown links intact
|
|
4653
4117
|
|
|
4654
|
-
7. **Template markup**: If documents contain {{placeholders}}
|
|
4118
|
+
7. **Template markup**: If documents contain {{placeholders}} ,preserve exactly
|
|
4655
4119
|
|
|
4656
4120
|
### 6. Validation
|
|
4657
4121
|
|