npm - bmad-method - Versions diffs - 6.0.0-alpha.4 → 6.0.0-alpha.6 - Mend

bmad-method 6.0.0-alpha.4 → 6.0.0-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (225) hide show

package/bmad/bmm/workflows/1-analysis/research/README.md DELETED Viewed

@@ -1,454 +0,0 @@
-# Research Workflow - Multi-Type Research System
-## Overview
-The Research Workflow is a comprehensive, adaptive research system that supports multiple research types through an intelligent router pattern. This workflow consolidates various research methodologies into a single, powerful tool that adapts to your specific research needs - from market analysis to technical evaluation to AI prompt generation.
-**Version 2.0.0** - Multi-type research system with router-based architecture
-## Key Features
-### 🔀 Intelligent Research Router
-- **6 Research Types**: Market, Deep Prompt, Technical, Competitive, User, Domain
-- **Dynamic Instructions**: Loads appropriate instruction set based on research type
-- **Adaptive Templates**: Selects optimal output format for research goal
-- **Context-Aware**: Adjusts frameworks and methods per research type
-### 🔍 Market Research (Type: `market`)
-- Real-time web research for current market data
-- TAM/SAM/SOM calculations with multiple methodologies
-- Competitive landscape analysis and positioning
-- Customer persona development and Jobs-to-be-Done
-- Porter's Five Forces and strategic frameworks
-- Go-to-market strategy recommendations
-### 🤖 Deep Research Prompt Generation (Type: `deep_prompt`)
-- **Optimized for AI Research Platforms**: ChatGPT Deep Research, Gemini, Grok DeepSearch, Claude Projects
-- **Prompt Engineering Best Practices**: Multi-stage research workflows, iterative refinement
-- **Platform-Specific Optimization**: Tailored prompts for each AI research tool
-- **Context Packaging**: Structures background information for optimal AI understanding
-- **Research Question Refinement**: Transforms vague questions into precise research prompts
-### 🏗️ Technical/Architecture Research (Type: `technical`)
-- Technology evaluation and comparison matrices
-- Architecture pattern research and trade-off analysis
-- Framework/library assessment with pros/cons
-- Technical feasibility studies
-- Cost-benefit analysis for technology decisions
-- Architecture Decision Records (ADR) generation
-### 🎯 Competitive Intelligence (Type: `competitive`)
-- Deep competitor analysis and profiling
-- Competitive positioning and gap analysis
-- Strategic group mapping
-- Feature comparison matrices
-- Pricing strategy analysis
-- Market share and growth tracking
-### 👥 User Research (Type: `user`)
-- Customer insights and behavioral analysis
-- Persona development with demographics and psychographics
-- Jobs-to-be-Done framework application
-- Customer journey mapping
-- Pain point identification
-- Willingness-to-pay analysis
-### 🌐 Domain/Industry Research (Type: `domain`)
-- Industry deep dives and trend analysis
-- Regulatory landscape assessment
-- Domain expertise synthesis
-- Best practices identification
-- Standards and compliance requirements
-- Emerging patterns and disruptions
-## Usage
-### Basic Invocation
-```bash
-workflow research
-```
-The workflow will prompt you to select a research type.
-### Direct Research Type Selection
-```bash
-# Market research
-workflow research --type market
-# Deep research prompt generation
-workflow research --type deep_prompt
-# Technical evaluation
-workflow research --type technical
-# Competitive intelligence
-workflow research --type competitive
-# User research
-workflow research --type user
-# Domain analysis
-workflow research --type domain
-```
-### With Input Documents
-```bash
-workflow research --type market --input product-brief.md --input competitor-list.md
-workflow research --type technical --input requirements.md --input architecture.md
-workflow research --type deep_prompt --input research-question.md
-```
-### Configuration Options
-Can be customized through `workflow.yaml`:
-- **research_depth**: `quick`, `standard`, or `comprehensive`
-- **enable_web_research**: `true`/`false` for real-time data gathering
-- **enable_competitor_analysis**: `true`/`false` (market/competitive types)
-- **enable_financial_modeling**: `true`/`false` (market type)
-## Workflow Structure
-### Files Included
-```
-research/
-├── workflow.yaml                  # Multi-type configuration
-├── instructions-router.md         # Router logic (loads correct instructions)
-├── instructions-market.md         # Market research workflow
-├── instructions-deep-prompt.md    # Deep prompt generation workflow
-├── instructions-technical.md      # Technical evaluation workflow
-├── template-market.md             # Market research report template
-├── template-deep-prompt.md        # Research prompt template
-├── template-technical.md          # Technical evaluation template
-├── checklist.md                   # Universal validation criteria
-├── README.md                      # This file
-└── claude-code/                   # Claude Code enhancements (optional)
-    ├── injections.yaml            # Integration configuration
-    └── sub-agents/                # Specialized research agents
-        ├── bmm-market-researcher.md
-        ├── bmm-trend-spotter.md
-        ├── bmm-data-analyst.md
-        ├── bmm-competitor-analyzer.md
-        ├── bmm-user-researcher.md
-        └── bmm-technical-evaluator.md
-```
-## Workflow Process
-### Phase 1: Research Type Selection and Setup
-1. Router presents research type menu
-2. User selects research type (market, deep_prompt, technical, competitive, user, domain)
-3. Router loads appropriate instructions and template
-4. Gather research parameters and inputs
-### Phase 2: Research Type-Specific Execution
-**For Market Research:**
-1. Define research objectives and market boundaries
-2. Conduct web research across multiple sources
-3. Calculate TAM/SAM/SOM with triangulation
-4. Develop customer segments and personas
-5. Analyze competitive landscape
-6. Apply industry frameworks (Porter's Five Forces, etc.)
-7. Identify trends and opportunities
-8. Develop strategic recommendations
-9. Create financial projections (optional)
-10. Compile comprehensive report
-**For Deep Prompt Generation:**
-1. Analyze research question or topic
-2. Identify optimal AI research platform (ChatGPT, Gemini, Grok, Claude)
-3. Structure research context and background
-4. Generate platform-optimized prompt
-5. Create multi-stage research workflow
-6. Define iteration and refinement strategy
-7. Package with context documents
-8. Provide execution guidance
-**For Technical Research:**
-1. Define technical requirements and constraints
-2. Identify technologies/frameworks to evaluate
-3. Research each option (documentation, community, maturity)
-4. Create comparison matrix with criteria
-5. Perform trade-off analysis
-6. Calculate cost-benefit for each option
-7. Generate Architecture Decision Record (ADR)
-8. Provide recommendation with rationale
-**For Competitive/User/Domain:**
-- Uses market research workflow with specific focus
-- Adapts questions and frameworks to research type
-- Customizes output format for target audience
-### Phase 3: Validation and Delivery
-1. Review outputs against checklist
-2. Validate completeness and quality
-3. Generate final report/document
-4. Provide next steps and recommendations
-## Output
-### Generated Files by Research Type
-**Market Research:**
-- `market-research-{product_name}-{date}.md`
-- Comprehensive market analysis report (10+ sections)
-**Deep Research Prompt:**
-- `deep-research-prompt-{date}.md`
-- Optimized AI research prompt with context and instructions
-**Technical Research:**
-- `technical-research-{date}.md`
-- Technology evaluation with comparison matrix and ADR
-**Competitive Intelligence:**
-- `competitive-intelligence-{date}.md`
-- Detailed competitor analysis and positioning
-**User Research:**
-- `user-research-{date}.md`
-- Customer insights and persona documentation
-**Domain Research:**
-- `domain-research-{date}.md`
-- Industry deep dive with trends and best practices
-## Requirements
-### All Research Types
-- BMAD Core v6 project structure
-- Web search capability (for real-time research)
-- Access to research data sources
-### Market Research
-- Product or business description
-- Target customer hypotheses (optional)
-- Known competitors list (optional)
-### Deep Prompt Research
-- Research question or topic
-- Background context documents (optional)
-- Target AI platform preference (optional)
-### Technical Research
-- Technical requirements document
-- Current architecture (if brownfield)
-- Technical constraints list
-## Best Practices
-### Before Starting
-1. **Know Your Research Goal**: Select the most appropriate research type
-2. **Gather Context**: Collect relevant documents before starting
-3. **Set Depth Level**: Choose appropriate research_depth (quick/standard/comprehensive)
-4. **Define Success Criteria**: What decisions will this research inform?
-### During Execution
-**Market Research:**
-- Provide specific product/service details
-- Validate market boundaries carefully
-- Review TAM/SAM/SOM assumptions
-- Challenge competitive positioning
-**Deep Prompt Generation:**
-- Be specific about research platform target
-- Provide rich context documents
-- Clarify expected research outcome
-- Define iteration strategy
-**Technical Research:**
-- List all evaluation criteria upfront
-- Weight criteria by importance
-- Consider long-term implications
-- Include cost analysis
-### After Completion
-1. Review using the validation checklist
-2. Update with any missing information
-3. Share with stakeholders for feedback
-4. Schedule follow-up research if needed
-5. Document decisions made based on research
-## Research Frameworks Available
-### Market Research Frameworks
-- TAM/SAM/SOM Analysis
-- Porter's Five Forces
-- Jobs-to-be-Done (JTBD)
-- Technology Adoption Lifecycle
-- SWOT Analysis
-- Value Chain Analysis
-### Technical Research Frameworks
-- Trade-off Analysis Matrix
-- Architecture Decision Records (ADR)
-- Technology Radar
-- Comparison Matrix
-- Cost-Benefit Analysis
-- Technical Risk Assessment
-### Deep Prompt Frameworks
-- ChatGPT Deep Research Best Practices
-- Gemini Deep Research Framework
-- Grok DeepSearch Optimization
-- Claude Projects Methodology
-- Iterative Prompt Refinement
-## Data Sources
-The workflow leverages multiple data sources:
-- Industry reports and publications
-- Government statistics and databases
-- Financial reports and SEC filings
-- News articles and press releases
-- Academic research papers
-- Technical documentation and RFCs
-- GitHub repositories and discussions
-- Stack Overflow and developer forums
-- Market research firm reports
-- Social media and communities
-- Patent databases
-- Benchmarking studies
-## Claude Code Enhancements
-### Available Subagents
-1. **bmm-market-researcher** - Market intelligence gathering
-2. **bmm-trend-spotter** - Emerging trends and weak signals
-3. **bmm-data-analyst** - Quantitative analysis and modeling
-4. **bmm-competitor-analyzer** - Competitive intelligence
-5. **bmm-user-researcher** - Customer insights and personas
-6. **bmm-technical-evaluator** - Technology assessment
-These are automatically invoked during workflow execution if Claude Code integration is configured.
-## Troubleshooting
-### Issue: Don't know which research type to choose
-- **Solution**: Start with research question - "What do I need to know?"
-  - Market viability? → `market`
-  - Best technology? → `technical`
-  - Need AI to research deeper? → `deep_prompt`
-  - Who are competitors? → `competitive`
-  - Who are users? → `user`
-  - Industry understanding? → `domain`
-### Issue: Market research results seem incomplete
-- **Solution**: Increase research_depth to `comprehensive`
-- **Check**: Enable web_research in workflow.yaml
-- **Try**: Run competitive and user research separately for more depth
-### Issue: Deep prompt doesn't work with target platform
-- **Solution**: Review platform-specific best practices in generated prompt
-- **Check**: Ensure context documents are included
-- **Try**: Regenerate with different platform selection
-### Issue: Technical comparison is subjective
-- **Solution**: Add more objective criteria (performance metrics, cost, community size)
-- **Check**: Weight criteria by business importance
-- **Try**: Run pilot implementations for top 2 options
-## Customization
-### Adding New Research Types
-1. Create new instructions file: `instructions-{type}.md`
-2. Create new template file: `template-{type}.md`
-3. Add research type to `workflow.yaml` `research_types` section
-4. Update router logic in `instructions-router.md`
-### Modifying Existing Research Types
-1. Edit appropriate `instructions-{type}.md` file
-2. Update corresponding `template-{type}.md` if needed
-3. Adjust validation criteria in `checklist.md`
-### Creating Custom Frameworks
-Add to `workflow.yaml` `frameworks` section under appropriate research type.
-## Version History
-- **v2.0.0** - Multi-type research system with router architecture
-  - Added deep_prompt research type for AI research platform optimization
-  - Added technical research type for technology evaluation
-  - Consolidated competitive, user, domain under market with focus variants
-  - Router-based instruction loading
-  - Template selection by research type
-  - Enhanced Claude Code subagent support
-- **v1.0.0** - Initial market research only implementation
-  - Single-purpose market research workflow
-  - Now deprecated in favor of v2.0.0 multi-type system
-## Support
-For issues or questions:
-- Review workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
-- Check validation against `checklist.md`
-- Examine router logic in `instructions-router.md`
-- Review research type-specific instructions
-- Consult BMAD Method v6 documentation
-## Migration from v1.0 market-research
-If you're used to the standalone `market-research` workflow:
-```bash
-# Old way
-workflow market-research
-# New way
-workflow research --type market
-# Or just: workflow research (then select market)
-```
-All market research functionality is preserved and enhanced in v2.0.0.
----
-_Part of the BMad Method v6 - BMM (BMad Method) Module - Empowering systematic research and analysis_

package/bmad/bmm/workflows/2-plan-workflows/README.md DELETED Viewed

@@ -1,258 +0,0 @@
----
-last-redoc-date: 2025-10-01
----
-# Project Planning Workflow (Phase 2)
-The Phase 2 Planning workflow is **scale-adaptive**, meaning it automatically determines the right level of planning documentation based on project complexity (Levels 0-4). This ensures planning overhead matches project value—from minimal tech specs for bug fixes to comprehensive PRDs for enterprise platforms.
-## Scale-Adaptive Flow (Levels 0-4)
-The workflow routes to different planning approaches based on project level:
-### Level 0 - Single File Change / Bug Fix
-**Planning:** Tech-spec only (lightweight implementation plan)
-**Output:** `tech-spec.md` with single story
-**Next Phase:** Direct to implementation (Phase 4)
-### Level 1 - Small Feature (1-3 files, 2-5 stories)
-**Planning:** Tech-spec only (implementation-focused)
-**Output:** `tech-spec.md` with epic breakdown and stories
-**Next Phase:** Direct to implementation (Phase 4)
-### Level 2 - Feature Set / Small Project (5-15 stories, 1-2 epics)
-**Planning:** PRD (product-focused) + Tech-spec (technical planning)
-**Output:** `PRD.md`, `epics.md`, `tech-spec.md`
-**Next Phase:** Tech-spec workflow (lightweight solutioning), then implementation (Phase 4)
-**Note:** Level 2 uses tech-spec instead of full architecture to keep planning lightweight
-### Level 3 - Medium Project (15-40 stories, 2-5 epics)
-**Planning:** PRD (strategic product document)
-**Output:** `PRD.md`, `epics.md`
-**Next Phase:** create-architecture workflow (Phase 3), then implementation (Phase 4)
-### Level 4 - Large/Enterprise Project (40-100+ stories, 5-10 epics)
-**Planning:** PRD (comprehensive product specification)
-**Output:** `PRD.md`, `epics.md`
-**Next Phase:** create-architecture workflow (Phase 3), then implementation (Phase 4)
-**Critical Distinction:**
-- **Levels 0-1:** No PRD, tech-spec only
-- **Level 2:** PRD + tech-spec (skips full architecture)
-- **Levels 3-4:** PRD → full create-architecture workflow
-Critical to v6's flow improvement is this workflow's integration with the bmm-workflow-status.md tracking document, which maintains project state across sessions, tracks which agents participate in each phase, and provides continuity for multi-session planning efforts. The workflow can resume from any point, intelligently detecting existing artifacts and determining next steps without redundant work. For UX-heavy projects, it can generate standalone UX specifications or AI frontend prompts from existing specs.
-## Key Features
-- **Scale-adaptive planning** - Automatically determines output based on project complexity
-- **Intelligent routing** - Uses router system to load appropriate instruction sets
-- **Continuation support** - Can resume from previous sessions and handle incremental work
-- **Multi-level outputs** - Supports 5 project levels (0-4) with appropriate artifacts
-- **Input integration** - Leverages product briefs and market research when available
-- **Template-driven** - Uses validated templates for consistent output structure
-### Configuration
-The workflow adapts automatically based on project assessment, but key configuration options include:
-- **scale_parameters**: Defines story/epic counts for each project level
-- **output_folder**: Where all generated documents are stored
-- **project_name**: Used in document names and templates
-## Workflow Structure
-### Files Included
-```
-2-plan-workflows/
-├── README.md                      # Overview and usage details
-├── checklist.md                   # Shared validation criteria
-├── prd/
-│   ├── epics-template.md          # Epic breakdown template
-│   ├── instructions.md            # Level 2-4 PRD instructions
-│   ├── prd-template.md            # Product Requirements Document template
-│   └── workflow.yaml
-├── tech-spec/
-│   ├── epics-template.md          # Epic-to-story handoff template
-│   ├── instructions-level0-story.md
-│   ├── instructions-level1-stories.md
-│   ├── instructions.md            # Level 0-1 tech-spec instructions
-│   ├── tech-spec-template.md      # Technical Specification template
-│   ├── user-story-template.md     # Story template for Level 0/1
-│   └── workflow.yaml
-├── gdd/
-│   ├── instructions-gdd.md        # Game Design Document instructions
-│   ├── gdd-template.md            # GDD template
-│   ├── game-types.csv             # Genre catalog
-│   ├── game-types/                # Genre-specific templates
-│   └── workflow.yaml
-├── narrative/
-│   ├── instructions-narrative.md  # Narrative design instructions
-│   ├── narrative-template.md      # Narrative planning template
-│   └── workflow.yaml
-└── create-ux-design/
-    ├── instructions.md            # UX design instructions
-    ├── ux-design-template.md      # UX design template
-    ├── checklist.md               # UX design validation checklist
-    └── workflow.yaml
-```
-## Workflow Process
-### Phase 1: Assessment and Routing (Steps 1-5)
-- **Project Analysis**: Determines project type (greenfield/brownfield/legacy)
-- **Scope Assessment**: Classifies into 5 levels based on complexity
-- **Document Discovery**: Identifies existing inputs and documentation
-- **Workflow Routing**: Loads appropriate instruction set based on level
-- **Continuation Handling**: Resumes from previous work when applicable
-### Phase 2: Level-Specific Planning (Steps vary by level)
-**Level 0 (Single File Change / Bug Fix)**:
-- Tech-spec only workflow
-- Single story implementation plan
-- Direct to Phase 4 (implementation)
-**Level 1 (Small Feature)**:
-- Tech-spec only workflow
-- Epic breakdown with 2-5 stories
-- Direct to Phase 4 (implementation)
-**Level 2 (Feature Set / Small Project)**:
-- PRD workflow (strategic product document)
-- Generates `PRD.md` and `epics.md`
-- Then runs tech-spec workflow (lightweight solutioning)
-- Then to Phase 4 (implementation)
-**Level 3-4 (Medium to Enterprise Projects)**:
-- PRD workflow (comprehensive product specification)
-- Generates `PRD.md` and `epics.md`
-- Hands off to Phase 3 (create-architecture workflow)
-- Full architecture design before implementation
-### Phase 3: Validation and Handoff (Final steps)
-- **Document Review**: Validates outputs against checklists
-- **Architect Preparation**: For Level 3-4, prepares handoff materials
-- **Next Steps**: Provides guidance for development phase
-## Output
-### Generated Files
-- **Primary output**: PRD.md (except Level 0), tech-spec.md, bmm-workflow-status.md
-- **Supporting files**: epics.md (Level 2-4), PRD-validation-report.md (if validation run)
-### Output Structure by Level
-**Level 0 - Tech Spec Only**:
-- `tech-spec.md` - Single story implementation plan
-- Direct to implementation
-**Level 1 - Tech Spec with Epic Breakdown**:
-- `tech-spec.md` - Epic breakdown with 2-5 stories
-- Direct to implementation
-**Level 2 - PRD + Tech Spec**:
-- `PRD.md` - Strategic product document (goals, requirements, user journeys, UX principles, UI goals, epic list, scope)
-- `epics.md` - Tactical implementation roadmap (detailed story breakdown)
-- `tech-spec.md` - Lightweight technical planning (generated after PRD)
-- Then to implementation
-**Level 3-4 - PRD + Full Architecture**:
-- `PRD.md` - Comprehensive product specification
-- `epics.md` - Complete epic/story breakdown
-- Hands off to create-architecture workflow (Phase 3)
-- `architecture.md` - Generated by architect workflow
-- Then to implementation
-## Requirements
-- **Input Documents**: Product brief and/or market research (recommended but not required)
-- **Project Configuration**: Valid config.yaml with project_name and output_folder
-- **Assessment Readiness**: Clear understanding of project scope and objectives
-## Best Practices
-### Before Starting
-1. **Gather Context**: Collect any existing product briefs, market research, or requirements
-2. **Define Scope**: Have a clear sense of project boundaries and complexity
-3. **Prepare Stakeholders**: Ensure key stakeholders are available for input if needed
-### During Execution
-1. **Be Honest About Scope**: Accurate assessment ensures appropriate planning depth
-2. **Leverage Existing Work**: Reference previous documents and avoid duplication
-3. **Think Incrementally**: Remember that planning can evolve - start with what you know
-### After Completion
-1. **Validate Against Checklist**: Use included validation criteria to ensure completeness
-2. **Share with Stakeholders**: Distribute appropriate documents to relevant team members
-3. **Prepare for Architecture**: For Level 3-4 projects, ensure architect has complete context
-## Troubleshooting
-### Common Issues
-**Issue**: Workflow creates wrong level of documentation
-- **Solution**: Review project assessment and restart with correct scope classification
-- **Check**: Verify the bmm-workflow-status.md reflects actual project complexity
-**Issue**: Missing input documents cause incomplete planning
-- **Solution**: Gather recommended inputs or proceed with manual context gathering
-- **Check**: Ensure critical business context is captured even without formal documents
-**Issue**: Continuation from previous session fails
-- **Solution**: Check for existing bmm-workflow-status.md and ensure output folder is correct
-- **Check**: Verify previous session completed at a valid checkpoint
-## Customization
-To customize this workflow:
-1. **Modify Assessment Logic**: Update instructions-router.md to adjust level classification
-2. **Adjust Templates**: Customize PRD, tech-spec, or epic templates for organizational needs
-3. **Add Validation**: Extend checklist.md with organization-specific quality criteria
-4. **Configure Outputs**: Modify workflow.yaml to change file naming or structure
-## Version History
-- **v6.0.0** - Scale-adaptive architecture with intelligent routing
-  - Multi-level project support (0-4)
-  - Continuation and resumption capabilities
-  - Template-driven output generation
-  - Input document integration
-## Support
-For issues or questions:
-- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
-- Validate output using `checklist.md`
-- Consult project assessment in `bmm-workflow-status.md`
-- Check continuation status in existing output documents
----
-_Part of the BMad Method v6 - BMM (Method) Module_