bmad-method 4.6.0 → 4.6.2

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 CHANGED
@@ -1,3 +1,17 @@
1
+ ## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * installer upgrade path fixed ([bd6a558](https://github.com/bmadcode/BMAD-METHOD/commit/bd6a55892906077a700f488bde175b57e846729d))
7
+
8
+ ## [4.6.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.0...v4.6.1) (2025-06-19)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions ([9dded00](https://github.com/bmadcode/BMAD-METHOD/commit/9dded003565879901246885d60787695e0d0b7bd))
14
+
1
15
  # [4.6.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.5.1...v4.6.0) (2025-06-18)
2
16
 
3
17
 
@@ -2,6 +2,8 @@
2
2
 
3
3
  [[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
4
4
 
5
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
6
+
5
7
  ## Introduction
6
8
 
7
9
  [[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} Brownfield Enhancement Architecture
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
4
+
3
5
  [[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
4
6
 
5
7
  This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} Brownfield Enhancement PRD
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/prd.md]]
4
+
3
5
  [[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
4
6
 
5
7
  This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
@@ -1,5 +1,7 @@
1
1
  # Competitive Analysis Report: {{Project/Product Name}}
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
4
+
3
5
  [[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
4
6
 
5
7
  ## Executive Summary
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} Frontend Architecture Document
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
4
+
3
5
  [[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
4
6
 
5
7
  ## Template and Framework Selection
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} UI/UX Specification
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
4
+
3
5
  [[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
4
6
 
5
7
  ## Introduction
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} Fullstack Architecture Document
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
4
+
3
5
  [[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
4
6
 
5
7
  ## Introduction
@@ -1,5 +1,7 @@
1
1
  # Market Research Report: {{Project/Product Name}}
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/market-research.md]]
4
+
3
5
  [[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
4
6
 
5
7
  ## Executive Summary
@@ -1,5 +1,7 @@
1
1
  # {{Project Name}} Product Requirements Document (PRD)
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/prd.md]]
4
+
3
5
  [[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
4
6
 
5
7
  ## Goals and Background Context
@@ -1,5 +1,7 @@
1
1
  # Project Brief: {{Project Name}}
2
2
 
3
+ [[LLM: The default path and filename unless specified is docs/brief.md]]
4
+
3
5
  [[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
4
6
 
5
7
  Start by asking the user which mode they prefer:
@@ -99,6 +99,183 @@ dependencies:
99
99
  ```
100
100
  ==================== END: agents#game-designer ====================
101
101
 
102
+ ==================== START: tasks#create-doc ====================
103
+ # Create Document from Template Task
104
+
105
+ ## Purpose
106
+
107
+ - Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
108
+
109
+ ## Instructions
110
+
111
+ ### 1. Identify Template and Context
112
+
113
+ - Determine which template to use (user-provided or list available for selection to user)
114
+
115
+ - Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
116
+
117
+ @{example}
118
+ dependencies:
119
+ templates: - prd-tmpl - architecture-tmpl
120
+ @{/example}
121
+
122
+ You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
123
+
124
+ - Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
125
+ - Understand the document purpose and target audience
126
+
127
+ ### 2. Determine Interaction Mode
128
+
129
+ Confirm with the user their preferred interaction style:
130
+
131
+ - **Incremental:** Work through chunks of the document.
132
+ - **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
133
+
134
+ ### 3. Execute Template
135
+
136
+ - Load specified template from `templates#*` or the /templates directory
137
+ - Follow ALL embedded LLM instructions within the template
138
+ - Process template markup according to `utils#template-format` conventions
139
+
140
+ ### 4. Template Processing Rules
141
+
142
+ #### CRITICAL: Never display template markup, LLM instructions, or examples to users
143
+
144
+ - Replace all {{placeholders}} with actual content
145
+ - Execute all [[LLM: instructions]] internally
146
+ - Process `<<REPEAT>>` sections as needed
147
+ - Evaluate ^^CONDITION^^ blocks and include only if applicable
148
+ - Use @{examples} for guidance but never output them
149
+
150
+ ### 5. Content Generation
151
+
152
+ - **Incremental Mode**: Present each major section for review before proceeding
153
+ - **YOLO Mode**: Generate all sections, then review complete document with user
154
+ - Apply any elicitation protocols specified in template
155
+ - Incorporate user feedback and iterate as needed
156
+
157
+ ### 6. Validation
158
+
159
+ If template specifies a checklist:
160
+
161
+ - Run the appropriate checklist against completed document
162
+ - Document completion status for each item
163
+ - Address any deficiencies found
164
+ - Present validation summary to user
165
+
166
+ ### 7. Final Presentation
167
+
168
+ - Present clean, formatted content only
169
+ - Ensure all sections are complete
170
+ - DO NOT truncate or summarize content
171
+ - Begin directly with document content (no preamble)
172
+ - Include any handoff prompts specified in template
173
+
174
+ ## Important Notes
175
+
176
+ - Template markup is for AI processing only - never expose to users
177
+ ==================== END: tasks#create-doc ====================
178
+
179
+ ==================== START: tasks#execute-checklist ====================
180
+ # Checklist Validation Task
181
+
182
+ This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
183
+
184
+ ## Context
185
+
186
+ The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
187
+
188
+ ## Available Checklists
189
+
190
+ If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
191
+
192
+ ## Instructions
193
+
194
+ 1. **Initial Assessment**
195
+
196
+ - If user or the task being run provides a checklist name:
197
+ - Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
198
+ - If multiple matches found, ask user to clarify
199
+ - Load the appropriate checklist from bmad-core/checklists/
200
+ - If no checklist specified:
201
+ - Ask the user which checklist they want to use
202
+ - Present the available options from the files in the checklists folder
203
+ - Confirm if they want to work through the checklist:
204
+ - Section by section (interactive mode - very time consuming)
205
+ - All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
206
+
207
+ 2. **Document and Artifact Gathering**
208
+
209
+ - Each checklist will specify its required documents/artifacts at the beginning
210
+ - Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
211
+
212
+ 3. **Checklist Processing**
213
+
214
+ If in interactive mode:
215
+
216
+ - Work through each section of the checklist one at a time
217
+ - For each section:
218
+ - Review all items in the section following instructions for that section embedded in the checklist
219
+ - Check each item against the relevant documentation or artifacts as appropriate
220
+ - Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
221
+ - Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
222
+
223
+ If in YOLO mode:
224
+
225
+ - Process all sections at once
226
+ - Create a comprehensive report of all findings
227
+ - Present the complete analysis to the user
228
+
229
+ 4. **Validation Approach**
230
+
231
+ For each checklist item:
232
+
233
+ - Read and understand the requirement
234
+ - Look for evidence in the documentation that satisfies the requirement
235
+ - Consider both explicit mentions and implicit coverage
236
+ - Aside from this, follow all checklist llm instructions
237
+ - Mark items as:
238
+ - ✅ PASS: Requirement clearly met
239
+ - ❌ FAIL: Requirement not met or insufficient coverage
240
+ - ⚠️ PARTIAL: Some aspects covered but needs improvement
241
+ - N/A: Not applicable to this case
242
+
243
+ 5. **Section Analysis**
244
+
245
+ For each section:
246
+
247
+ - think step by step to calculate pass rate
248
+ - Identify common themes in failed items
249
+ - Provide specific recommendations for improvement
250
+ - In interactive mode, discuss findings with user
251
+ - Document any user decisions or explanations
252
+
253
+ 6. **Final Report**
254
+
255
+ Prepare a summary that includes:
256
+
257
+ - Overall checklist completion status
258
+ - Pass rates by section
259
+ - List of failed items with context
260
+ - Specific recommendations for improvement
261
+ - Any sections or items marked as N/A with justification
262
+
263
+ ## Checklist Execution Methodology
264
+
265
+ Each checklist now contains embedded LLM prompts and instructions that will:
266
+
267
+ 1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
268
+ 2. **Request specific artifacts** - Clear instructions on what documents/access is needed
269
+ 3. **Provide contextual guidance** - Section-specific prompts for better validation
270
+ 4. **Generate comprehensive reports** - Final summary with detailed findings
271
+
272
+ The LLM will:
273
+
274
+ - Execute the complete checklist validation
275
+ - Present a final report with pass/fail rates and key findings
276
+ - Offer to provide detailed analysis of any section, especially those with warnings or failures
277
+ ==================== END: tasks#execute-checklist ====================
278
+
102
279
  ==================== START: tasks#game-design-brainstorming ====================
103
280
  # Game Design Brainstorming Techniques Task
104
281
 
@@ -392,6 +569,310 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
392
569
  - Plan for iteration based on player feedback
393
570
  ==================== END: tasks#game-design-brainstorming ====================
394
571
 
572
+ ==================== START: tasks#create-deep-research-prompt ====================
573
+ # Create Deep Research Prompt Task
574
+
575
+ This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
576
+
577
+ ## Purpose
578
+
579
+ Generate well-structured research prompts that:
580
+
581
+ - Define clear research objectives and scope
582
+ - Specify appropriate research methodologies
583
+ - Outline expected deliverables and formats
584
+ - Guide systematic investigation of complex topics
585
+ - Ensure actionable insights are captured
586
+
587
+ ## Research Type Selection
588
+
589
+ [[LLM: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.]]
590
+
591
+ ### 1. Research Focus Options
592
+
593
+ Present these numbered options to the user:
594
+
595
+ 1. **Product Validation Research**
596
+
597
+ - Validate product hypotheses and market fit
598
+ - Test assumptions about user needs and solutions
599
+ - Assess technical and business feasibility
600
+ - Identify risks and mitigation strategies
601
+
602
+ 2. **Market Opportunity Research**
603
+
604
+ - Analyze market size and growth potential
605
+ - Identify market segments and dynamics
606
+ - Assess market entry strategies
607
+ - Evaluate timing and market readiness
608
+
609
+ 3. **User & Customer Research**
610
+
611
+ - Deep dive into user personas and behaviors
612
+ - Understand jobs-to-be-done and pain points
613
+ - Map customer journeys and touchpoints
614
+ - Analyze willingness to pay and value perception
615
+
616
+ 4. **Competitive Intelligence Research**
617
+
618
+ - Detailed competitor analysis and positioning
619
+ - Feature and capability comparisons
620
+ - Business model and strategy analysis
621
+ - Identify competitive advantages and gaps
622
+
623
+ 5. **Technology & Innovation Research**
624
+
625
+ - Assess technology trends and possibilities
626
+ - Evaluate technical approaches and architectures
627
+ - Identify emerging technologies and disruptions
628
+ - Analyze build vs. buy vs. partner options
629
+
630
+ 6. **Industry & Ecosystem Research**
631
+
632
+ - Map industry value chains and dynamics
633
+ - Identify key players and relationships
634
+ - Analyze regulatory and compliance factors
635
+ - Understand partnership opportunities
636
+
637
+ 7. **Strategic Options Research**
638
+
639
+ - Evaluate different strategic directions
640
+ - Assess business model alternatives
641
+ - Analyze go-to-market strategies
642
+ - Consider expansion and scaling paths
643
+
644
+ 8. **Risk & Feasibility Research**
645
+
646
+ - Identify and assess various risk factors
647
+ - Evaluate implementation challenges
648
+ - Analyze resource requirements
649
+ - Consider regulatory and legal implications
650
+
651
+ 9. **Custom Research Focus**
652
+ [[LLM: Allow user to define their own specific research focus.]]
653
+ - User-defined research objectives
654
+ - Specialized domain investigation
655
+ - Cross-functional research needs
656
+
657
+ ### 2. Input Processing
658
+
659
+ [[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
660
+
661
+ **If Project Brief provided:**
662
+
663
+ - Extract key product concepts and goals
664
+ - Identify target users and use cases
665
+ - Note technical constraints and preferences
666
+ - Highlight uncertainties and assumptions
667
+
668
+ **If Brainstorming Results provided:**
669
+
670
+ - Synthesize main ideas and themes
671
+ - Identify areas needing validation
672
+ - Extract hypotheses to test
673
+ - Note creative directions to explore
674
+
675
+ **If Market Research provided:**
676
+
677
+ - Build on identified opportunities
678
+ - Deepen specific market insights
679
+ - Validate initial findings
680
+ - Explore adjacent possibilities
681
+
682
+ **If Starting Fresh:**
683
+
684
+ - Gather essential context through questions
685
+ - Define the problem space
686
+ - Clarify research objectives
687
+ - Establish success criteria
688
+
689
+ ## Process
690
+
691
+ ### 3. Research Prompt Structure
692
+
693
+ [[LLM: Based on the selected research type and context, collaboratively develop a comprehensive research prompt with these components.]]
694
+
695
+ #### A. Research Objectives
696
+
697
+ [[LLM: Work with the user to articulate clear, specific objectives for the research.]]
698
+
699
+ - Primary research goal and purpose
700
+ - Key decisions the research will inform
701
+ - Success criteria for the research
702
+ - Constraints and boundaries
703
+
704
+ #### B. Research Questions
705
+
706
+ [[LLM: Develop specific, actionable research questions organized by theme.]]
707
+
708
+ **Core Questions:**
709
+
710
+ - Central questions that must be answered
711
+ - Priority ranking of questions
712
+ - Dependencies between questions
713
+
714
+ **Supporting Questions:**
715
+
716
+ - Additional context-building questions
717
+ - Nice-to-have insights
718
+ - Future-looking considerations
719
+
720
+ #### C. Research Methodology
721
+
722
+ [[LLM: Specify appropriate research methods based on the type and objectives.]]
723
+
724
+ **Data Collection Methods:**
725
+
726
+ - Secondary research sources
727
+ - Primary research approaches (if applicable)
728
+ - Data quality requirements
729
+ - Source credibility criteria
730
+
731
+ **Analysis Frameworks:**
732
+
733
+ - Specific frameworks to apply
734
+ - Comparison criteria
735
+ - Evaluation methodologies
736
+ - Synthesis approaches
737
+
738
+ #### D. Output Requirements
739
+
740
+ [[LLM: Define how research findings should be structured and presented.]]
741
+
742
+ **Format Specifications:**
743
+
744
+ - Executive summary requirements
745
+ - Detailed findings structure
746
+ - Visual/tabular presentations
747
+ - Supporting documentation
748
+
749
+ **Key Deliverables:**
750
+
751
+ - Must-have sections and insights
752
+ - Decision-support elements
753
+ - Action-oriented recommendations
754
+ - Risk and uncertainty documentation
755
+
756
+ ### 4. Prompt Generation
757
+
758
+ [[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
759
+
760
+ **Research Prompt Template:**
761
+
762
+ ```markdown
763
+ ## Research Objective
764
+
765
+ [Clear statement of what this research aims to achieve]
766
+
767
+ ## Background Context
768
+
769
+ [Relevant information from project brief, brainstorming, or other inputs]
770
+
771
+ ## Research Questions
772
+
773
+ ### Primary Questions (Must Answer)
774
+
775
+ 1. [Specific, actionable question]
776
+ 2. [Specific, actionable question]
777
+ ...
778
+
779
+ ### Secondary Questions (Nice to Have)
780
+
781
+ 1. [Supporting question]
782
+ 2. [Supporting question]
783
+ ...
784
+
785
+ ## Research Methodology
786
+
787
+ ### Information Sources
788
+
789
+ - [Specific source types and priorities]
790
+
791
+ ### Analysis Frameworks
792
+
793
+ - [Specific frameworks to apply]
794
+
795
+ ### Data Requirements
796
+
797
+ - [Quality, recency, credibility needs]
798
+
799
+ ## Expected Deliverables
800
+
801
+ ### Executive Summary
802
+
803
+ - Key findings and insights
804
+ - Critical implications
805
+ - Recommended actions
806
+
807
+ ### Detailed Analysis
808
+
809
+ [Specific sections needed based on research type]
810
+
811
+ ### Supporting Materials
812
+
813
+ - Data tables
814
+ - Comparison matrices
815
+ - Source documentation
816
+
817
+ ## Success Criteria
818
+
819
+ [How to evaluate if research achieved its objectives]
820
+
821
+ ## Timeline and Priority
822
+
823
+ [If applicable, any time constraints or phasing]
824
+ ```
825
+
826
+ ### 5. Review and Refinement
827
+
828
+ [[LLM: Present the draft research prompt for user review and refinement.]]
829
+
830
+ 1. **Present Complete Prompt**
831
+
832
+ - Show the full research prompt
833
+ - Explain key elements and rationale
834
+ - Highlight any assumptions made
835
+
836
+ 2. **Gather Feedback**
837
+
838
+ - Are the objectives clear and correct?
839
+ - Do the questions address all concerns?
840
+ - Is the scope appropriate?
841
+ - Are output requirements sufficient?
842
+
843
+ 3. **Refine as Needed**
844
+ - Incorporate user feedback
845
+ - Adjust scope or focus
846
+ - Add missing elements
847
+ - Clarify ambiguities
848
+
849
+ ### 6. Next Steps Guidance
850
+
851
+ [[LLM: Provide clear guidance on how to use the research prompt.]]
852
+
853
+ **Execution Options:**
854
+
855
+ 1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
856
+ 2. **Guide Human Research**: Use as a framework for manual research efforts
857
+ 3. **Hybrid Approach**: Combine AI and human research using this structure
858
+
859
+ **Integration Points:**
860
+
861
+ - How findings will feed into next phases
862
+ - Which team members should review results
863
+ - How to validate findings
864
+ - When to revisit or expand research
865
+
866
+ ## Important Notes
867
+
868
+ - The quality of the research prompt directly impacts the quality of insights gathered
869
+ - Be specific rather than general in research questions
870
+ - Consider both current state and future implications
871
+ - Balance comprehensiveness with focus
872
+ - Document assumptions and limitations clearly
873
+ - Plan for iterative refinement based on initial findings
874
+ ==================== END: tasks#create-deep-research-prompt ====================
875
+
395
876
  ==================== START: tasks#advanced-elicitation ====================
396
877
  # Advanced Game Design Elicitation Task
397
878