bmad-method 6.0.0-alpha.0 → 6.0.0-alpha.10

package/src/modules/bmm/workflows/1-analysis/product-brief/template.md

@@ -2,7 +2,7 @@
 
 **Date:** {{date}}
 **Author:** {{user_name}}
-**Status:** Draft for PM Review
+**Context:** {{context_type}}
 
 ---
 
@@ -12,154 +12,170 @@
 
 ---
 
-## Problem Statement
+## Core Vision
+
+### Problem Statement
 
 {{problem_statement}}
 
----
+{{#if problem_impact}}
 
-## Proposed Solution
+### Problem Impact
 
-{{proposed_solution}}
+{{problem_impact}}
+{{/if}}
 
----
+{{#if existing_solutions_gaps}}
 
-## Target Users
+### Why Existing Solutions Fall Short
 
-### Primary User Segment
+{{existing_solutions_gaps}}
+{{/if}}
 
-{{primary_user_segment}}
+### Proposed Solution
 
-### Secondary User Segment
+{{proposed_solution}}
 
-{{secondary_user_segment}}
+{{#if key_differentiators}}
+
+### Key Differentiators
+
+{{key_differentiators}}
+{{/if}}
 
 ---
 
-## Goals & Success Metrics
+## Target Users
 
-### Business Objectives
+### Primary Users
 
-{{business_objectives}}
+{{primary_user_segment}}
 
-### User Success Metrics
+{{#if secondary_user_segment}}
 
-{{user_success_metrics}}
+### Secondary Users
 
-### Key Performance Indicators (KPIs)
+{{secondary_user_segment}}
+{{/if}}
 
-{{key_performance_indicators}}
+{{#if user_journey}}
+
+### User Journey
+
+{{user_journey}}
+{{/if}}
 
 ---
 
-## Strategic Alignment & Financial Impact
+{{#if success_metrics}}
 
-### Financial Impact
+## Success Metrics
 
-{{financial_impact}}
+{{success_metrics}}
 
-### Company Objectives Alignment
+{{#if business_objectives}}
 
-{{company_objectives_alignment}}
+### Business Objectives
+
+{{business_objectives}}
+{{/if}}
 
-### Strategic Initiatives
+{{#if key_performance_indicators}}
 
-{{strategic_initiatives}}
+### Key Performance Indicators
+
+{{key_performance_indicators}}
+{{/if}}
+{{/if}}
 
 ---
 
 ## MVP Scope
 
-### Core Features (Must Have)
+### Core Features
 
 {{core_features}}
 
+{{#if out_of_scope}}
+
 ### Out of Scope for MVP
 
 {{out_of_scope}}
+{{/if}}
+
+{{#if mvp_success_criteria}}
 
 ### MVP Success Criteria
 
 {{mvp_success_criteria}}
+{{/if}}
 
----
-
-## Post-MVP Vision
-
-### Phase 2 Features
-
-{{phase_2_features}}
-
-### Long-term Vision
-
-{{long_term_vision}}
+{{#if future_vision_features}}
 
-### Expansion Opportunities
+### Future Vision
 
-{{expansion_opportunities}}
+{{future_vision_features}}
+{{/if}}
 
 ---
 
-## Technical Considerations
+{{#if market_analysis}}
 
-### Platform Requirements
+## Market Context
 
-{{platform_requirements}}
+{{market_analysis}}
+{{/if}}
 
-### Technology Preferences
+{{#if financial_considerations}}
 
-{{technology_preferences}}
+## Financial Considerations
 
-### Architecture Considerations
+{{financial_considerations}}
+{{/if}}
 
-{{architecture_considerations}}
+{{#if technical_preferences}}
 
----
+## Technical Preferences
 
-## Constraints & Assumptions
+{{technical_preferences}}
+{{/if}}
 
-### Constraints
+{{#if organizational_context}}
 
-{{constraints}}
+## Organizational Context
 
-### Key Assumptions
+{{organizational_context}}
+{{/if}}
 
-{{key_assumptions}}
+{{#if risks_and_assumptions}}
 
----
+## Risks and Assumptions
 
-## Risks & Open Questions
+{{risks_and_assumptions}}
+{{/if}}
 
-### Key Risks
+{{#if timeline_constraints}}
 
-{{key_risks}}
+## Timeline
 
-### Open Questions
+{{timeline_constraints}}
+{{/if}}
 
-{{open_questions}}
+{{#if supporting_materials}}
 
-### Areas Needing Further Research
+## Supporting Materials
 
-{{research_areas}}
+{{supporting_materials}}
+{{/if}}
 
 ---
 
-## Appendices
-
-### A. Research Summary
-
-{{research_summary}}
-
-### B. Stakeholder Input
-
-{{stakeholder_input}}
-
-### C. References
-
-{{references}}
-
----
+_This Product Brief captures the vision and requirements for {{project_name}}._
 
-_This Product Brief serves as the foundational input for Product Requirements Document (PRD) creation._
+_It was created through collaborative discovery and reflects the unique needs of this {{context_type}} project._
 
-_Next Steps: Handoff to Product Manager for PRD development using the `workflow prd` command._
+{{#if next_workflow}}
+_Next: {{next_workflow}} will transform this brief into detailed planning artifacts._
+{{else}}
+_Next: Use the PRD workflow to create detailed product requirements from this brief._
+{{/if}}

package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml

@@ -3,21 +3,38 @@ name: product-brief
 description: "Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration"
 author: "BMad"
 
-# Critical variables
-config_source: "{project-root}/bmad/bmm/config.yaml"
+# Critical variables from config
+config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
 output_folder: "{config_source}:output_folder"
 user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+document_output_language: "{config_source}:document_output_language"
+user_skill_level: "{config_source}:user_skill_level"
 date: system-generated
 
-# Optional input documents
-recommended_inputs:
-  - market_research: "Market research document (optional)"
-  - brainstorming_results: "Brainstorming session outputs (optional)"
-  - competitive_analysis: "Competitive analysis (optional)"
-  - initial_ideas: "Initial product ideas or notes (optional)"
+# Smart input file references - handles both whole docs and sharded docs
+# Priority: Whole document first, then sharded version
+# Strategy: How to load sharded documents (FULL_LOAD, SELECTIVE_LOAD, INDEX_GUIDED)
+input_file_patterns:
+  research:
+    description: "Market research or competitive analysis (optional)"
+    whole: "{output_folder}/*research*.md"
+    sharded: "{output_folder}/*research*/index.md"
+    load_strategy: "FULL_LOAD"
+
+  brainstorming:
+    description: "Brainstorming session outputs (optional)"
+    whole: "{output_folder}/*brainstorm*.md"
+    sharded: "{output_folder}/*brainstorm*/index.md"
+    load_strategy: "FULL_LOAD"
+
+  document_project:
+    description: "Brownfield project documentation (optional)"
+    sharded: "{output_folder}/index.md"
+    load_strategy: "INDEX_GUIDED"
 
 # Module path and component files
-installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/product-brief"
+installed_path: "{project-root}/{bmad_folder}/bmm/workflows/1-analysis/product-brief"
 template: "{installed_path}/template.md"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
@@ -25,9 +42,20 @@ validation: "{installed_path}/checklist.md"
 # Output configuration
 default_output_file: "{output_folder}/product-brief-{{project_name}}-{{date}}.md"
 
-# Required tools
-required_tools: []
+standalone: true
+
+web_bundle:
+  name: "product-brief"
+  description: "Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration"
+  author: "BMad"
+  instructions: "{bmad_folder}/bmm/workflows/1-analysis/product-brief/instructions.md"
+  validation: "{bmad_folder}/bmm/workflows/1-analysis/product-brief/checklist.md"
+  template: "{bmad_folder}/bmm/workflows/1-analysis/product-brief/template.md"
+  web_bundle_files:
+    # Core workflow files
+    - "{bmad_folder}/bmm/workflows/1-analysis/product-brief/template.md"
+    - "{bmad_folder}/bmm/workflows/1-analysis/product-brief/instructions.md"
+    - "{bmad_folder}/bmm/workflows/1-analysis/product-brief/checklist.md"
 
-# Workflow settings
-autonomous: false # This is an interactive workflow requiring user collaboration
-brief_format: "comprehensive" # Options: "comprehensive" (full detail) or "executive" (3-page limit)
+    # Task dependencies (referenced in instructions.md)
+    - "{bmad_folder}/core/tasks/workflow.xml"

package/src/modules/bmm/workflows/1-analysis/research/checklist-deep-prompt.md

@@ -0,0 +1,144 @@
+# Deep Research Prompt Validation Checklist
+
+## 🚨 CRITICAL: Anti-Hallucination Instructions (PRIORITY)
+
+### Citation Requirements Built Into Prompt
+
+- [ ] Prompt EXPLICITLY instructs: "Cite sources with URLs for ALL factual claims"
+- [ ] Prompt requires: "Include source name, date, and URL for every statistic"
+- [ ] Prompt mandates: "If you cannot find reliable data, state 'No verified data found for [X]'"
+- [ ] Prompt specifies inline citation format (e.g., "[Source: Company, Year, URL]")
+- [ ] Prompt requires References section at end with all sources listed
+
+### Multi-Source Verification Requirements
+
+- [ ] Prompt instructs: "Cross-reference critical claims with at least 2 independent sources"
+- [ ] Prompt requires: "Note when sources conflict and present all viewpoints"
+- [ ] Prompt specifies: "Verify version numbers and dates from official sources"
+- [ ] Prompt mandates: "Mark confidence levels: [Verified], [Single source], [Uncertain]"
+
+### Fact vs Analysis Distinction
+
+- [ ] Prompt requires clear labeling: "Distinguish FACTS (sourced), ANALYSIS (your interpretation), SPECULATION (projections)"
+- [ ] Prompt instructs: "Do not present assumptions or analysis as verified facts"
+- [ ] Prompt requires: "Label projections and forecasts clearly as such"
+- [ ] Prompt warns: "Avoid vague attributions like 'experts say' - name the expert/source"
+
+### Source Quality Guidance
+
+- [ ] Prompt specifies preferred sources (e.g., "Official docs > analyst reports > blog posts")
+- [ ] Prompt prioritizes recency: "Prioritize {{current_year}} sources for time-sensitive data"
+- [ ] Prompt requires credibility assessment: "Note source credibility for each citation"
+- [ ] Prompt warns against: "Do not rely on single blog posts for critical claims"
+
+### Anti-Hallucination Safeguards
+
+- [ ] Prompt warns: "If data seems convenient or too round, verify with additional sources"
+- [ ] Prompt instructs: "Flag suspicious claims that need third-party verification"
+- [ ] Prompt requires: "Provide date accessed for all web sources"
+- [ ] Prompt mandates: "Do NOT invent statistics - only use verified data"
+
+## Prompt Foundation
+
+### Topic and Scope
+
+- [ ] Research topic is specific and focused (not too broad)
+- [ ] Target platform is specified (ChatGPT, Gemini, Grok, Claude)
+- [ ] Temporal scope defined and includes "current {{current_year}}" requirement
+- [ ] Source recency requirement specified (e.g., "prioritize 2024-2025 sources")
+
+## Content Requirements
+
+### Information Specifications
+
+- [ ] Types of information needed are listed (quantitative, qualitative, trends, case studies, etc.)
+- [ ] Preferred sources are specified (academic, industry reports, news, etc.)
+- [ ] Recency requirements are stated (e.g., "prioritize {{current_year}} sources")
+- [ ] Keywords and technical terms are included for search optimization
+- [ ] Validation criteria are defined (how to verify findings)
+
+### Output Structure
+
+- [ ] Desired format is clear (executive summary, comparison table, timeline, SWOT, etc.)
+- [ ] Key sections or questions are outlined
+- [ ] Depth level is specified (overview, standard, comprehensive, exhaustive)
+- [ ] Citation requirements are stated
+- [ ] Any special formatting needs are mentioned
+
+## Platform Optimization
+
+### Platform-Specific Elements
+
+- [ ] Prompt is optimized for chosen platform's capabilities
+- [ ] Platform-specific tips are included
+- [ ] Query limit considerations are noted (if applicable)
+- [ ] Platform strengths are leveraged (e.g., ChatGPT's multi-step search, Gemini's plan modification)
+
+### Execution Guidance
+
+- [ ] Research persona/perspective is specified (if applicable)
+- [ ] Special requirements are stated (bias considerations, recency, etc.)
+- [ ] Follow-up strategy is outlined
+- [ ] Validation approach is defined
+
+## Quality and Usability
+
+### Clarity and Completeness
+
+- [ ] Prompt language is clear and unambiguous
+- [ ] All placeholders and variables are replaced with actual values
+- [ ] Prompt can be copy-pasted directly into platform
+- [ ] No contradictory instructions exist
+- [ ] Prompt is self-contained (doesn't assume unstated context)
+
+### Practical Utility
+
+- [ ] Execution checklist is provided (before, during, after research)
+- [ ] Platform usage tips are included
+- [ ] Follow-up questions are anticipated
+- [ ] Success criteria are defined
+- [ ] Output file format is specified
+
+## Research Depth
+
+### Scope Appropriateness
+
+- [ ] Scope matches user's available time and resources
+- [ ] Depth is appropriate for decision at hand
+- [ ] Key questions that MUST be answered are identified
+- [ ] Nice-to-have vs. critical information is distinguished
+
+## Validation Criteria
+
+### Quality Standards
+
+- [ ] Method for cross-referencing sources is specified
+- [ ] Approach to handling conflicting information is defined
+- [ ] Confidence level indicators are requested
+- [ ] Gap identification is included
+- [ ] Fact vs. opinion distinction is required
+
+---
+
+## Issues Found
+
+### Critical Issues
+
+_List any critical gaps or errors that must be addressed:_
+
+- [ ] Issue 1: [Description]
+- [ ] Issue 2: [Description]
+
+### Minor Improvements
+
+_List minor improvements that would enhance the prompt:_
+
+- [ ] Issue 1: [Description]
+- [ ] Issue 2: [Description]
+
+---
+
+**Validation Complete:** ☐ Yes ☐ No
+**Ready to Execute:** ☐ Yes ☐ No
+**Reviewer:** {agent}
+**Date:** {date}