mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)
## 📚 Complete Documentation Restructure **BMM Documentation Hub Created:** - New centralized documentation system at `src/modules/bmm/docs/` - 18 comprehensive guides organized by topic (7000+ lines total) - Clear learning paths for greenfield, brownfield, and quick spec flows - Professional technical writing standards throughout **New Documentation:** - `README.md` - Complete documentation hub with navigation - `quick-start.md` - 15-minute getting started guide - `agents-guide.md` - Comprehensive 12-agent reference (45 min read) - `party-mode.md` - Multi-agent collaboration guide (20 min read) - `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read) - `brownfield-guide.md` - Existing codebase development (53 min read) - `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read) - `workflows-analysis.md` - Phase 1 workflows (12 min read) - `workflows-planning.md` - Phase 2 workflows (19 min read) - `workflows-solutioning.md` - Phase 3 workflows (13 min read) - `workflows-implementation.md` - Phase 4 workflows (33 min read) - `workflows-testing.md` - Testing & QA workflows (29 min read) - `workflow-architecture-reference.md` - Architecture workflow deep-dive - `workflow-document-project-reference.md` - Document-project workflow reference - `enterprise-agentic-development.md` - Team collaboration patterns - `faq.md` - Comprehensive Q&A covering all topics - `glossary.md` - Complete terminology reference - `troubleshooting.md` - Common issues and solutions **Documentation Improvements:** - Removed all version/date footers (git handles versioning) - Agent customization docs now include full rebuild process - Cross-referenced links between all guides - Reading time estimates for all major docs - Consistent professional formatting and structure **Consolidated & Streamlined:** - Module README (`src/modules/bmm/README.md`) streamlined to lean signpost - Root README polished with better hierarchy and clear CTAs - Moved docs from root `docs/` to module-specific locations - Better separation of user docs vs. developer reference ## 🤖 New Agent: Paige (Documentation Guide) **Role:** Technical documentation specialist and information architect **Expertise:** - Professional technical writing standards - Documentation structure and organization - Information architecture and navigation - User-focused content design - Style guide enforcement **Status:** Work in progress - Paige will evolve as documentation needs grow **Integration:** - Listed in agents-guide.md, glossary.md, FAQ - Available for all phases (documentation is continuous) - Can be customized like all BMM agents ## 🔧 Additional Changes - Updated agent manifest with Paige - Updated workflow manifest with new documentation workflows - Fixed workflow-to-agent mappings across all guides - Improved root README with clearer Quick Start section - Better module structure explanations - Enhanced community links with Discord channel names **Total Impact:** - 18 new/restructured documentation files - 7000+ lines of professional technical documentation - Complete navigation system with cross-references - Clear learning paths for all user types - Foundation for knowledge base (coming in beta) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Brian Madison
347
bmad/bmm/workflows/1-analysis/research/template-market.md
Normal file
347
bmad/bmm/workflows/1-analysis/research/template-market.md
Normal file
@@ -0,0 +1,347 @@
|
||||
# Market Research Report: {{product_name}}
|
||||
|
||||
**Date:** {{date}}
|
||||
**Prepared by:** {{user_name}}
|
||||
**Research Depth:** {{research_depth}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
{{executive_summary}}
|
||||
|
||||
### Key Market Metrics
|
||||
|
||||
- **Total Addressable Market (TAM):** {{tam_calculation}}
|
||||
- **Serviceable Addressable Market (SAM):** {{sam_calculation}}
|
||||
- **Serviceable Obtainable Market (SOM):** {{som_scenarios}}
|
||||
|
||||
### Critical Success Factors
|
||||
|
||||
{{key_success_factors}}
|
||||
|
||||
---
|
||||
|
||||
## 1. Research Objectives and Methodology
|
||||
|
||||
### Research Objectives
|
||||
|
||||
{{research_objectives}}
|
||||
|
||||
### Scope and Boundaries
|
||||
|
||||
- **Product/Service:** {{product_description}}
|
||||
- **Market Definition:** {{market_definition}}
|
||||
- **Geographic Scope:** {{geographic_scope}}
|
||||
- **Customer Segments:** {{segment_boundaries}}
|
||||
|
||||
### Research Methodology
|
||||
|
||||
{{research_methodology}}
|
||||
|
||||
### Data Sources
|
||||
|
||||
{{source_credibility_notes}}
|
||||
|
||||
---
|
||||
|
||||
## 2. Market Overview
|
||||
|
||||
### Market Definition
|
||||
|
||||
{{market_definition}}
|
||||
|
||||
### Market Size and Growth
|
||||
|
||||
#### Total Addressable Market (TAM)
|
||||
|
||||
**Methodology:** {{tam_methodology}}
|
||||
|
||||
{{tam_calculation}}
|
||||
|
||||
#### Serviceable Addressable Market (SAM)
|
||||
|
||||
{{sam_calculation}}
|
||||
|
||||
#### Serviceable Obtainable Market (SOM)
|
||||
|
||||
{{som_scenarios}}
|
||||
|
||||
### Market Intelligence Summary
|
||||
|
||||
{{market_intelligence_raw}}
|
||||
|
||||
### Key Data Points
|
||||
|
||||
{{key_data_points}}
|
||||
|
||||
---
|
||||
|
||||
## 3. Market Trends and Drivers
|
||||
|
||||
### Key Market Trends
|
||||
|
||||
{{market_trends}}
|
||||
|
||||
### Growth Drivers
|
||||
|
||||
{{growth_drivers}}
|
||||
|
||||
### Market Inhibitors
|
||||
|
||||
{{market_inhibitors}}
|
||||
|
||||
### Future Outlook
|
||||
|
||||
{{future_outlook}}
|
||||
|
||||
---
|
||||
|
||||
## 4. Customer Analysis
|
||||
|
||||
### Target Customer Segments
|
||||
|
||||
{{#segment_profile_1}}
|
||||
|
||||
#### Segment 1
|
||||
|
||||
{{segment_profile_1}}
|
||||
{{/segment_profile_1}}
|
||||
|
||||
{{#segment_profile_2}}
|
||||
|
||||
#### Segment 2
|
||||
|
||||
{{segment_profile_2}}
|
||||
{{/segment_profile_2}}
|
||||
|
||||
{{#segment_profile_3}}
|
||||
|
||||
#### Segment 3
|
||||
|
||||
{{segment_profile_3}}
|
||||
{{/segment_profile_3}}
|
||||
|
||||
{{#segment_profile_4}}
|
||||
|
||||
#### Segment 4
|
||||
|
||||
{{segment_profile_4}}
|
||||
{{/segment_profile_4}}
|
||||
|
||||
{{#segment_profile_5}}
|
||||
|
||||
#### Segment 5
|
||||
|
||||
{{segment_profile_5}}
|
||||
{{/segment_profile_5}}
|
||||
|
||||
### Jobs-to-be-Done Analysis
|
||||
|
||||
{{jobs_to_be_done}}
|
||||
|
||||
### Pricing Analysis and Willingness to Pay
|
||||
|
||||
{{pricing_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 5. Competitive Landscape
|
||||
|
||||
### Market Structure
|
||||
|
||||
{{market_structure}}
|
||||
|
||||
### Competitor Analysis
|
||||
|
||||
{{#competitor_analysis_1}}
|
||||
|
||||
#### Competitor 1
|
||||
|
||||
{{competitor_analysis_1}}
|
||||
{{/competitor_analysis_1}}
|
||||
|
||||
{{#competitor_analysis_2}}
|
||||
|
||||
#### Competitor 2
|
||||
|
||||
{{competitor_analysis_2}}
|
||||
{{/competitor_analysis_2}}
|
||||
|
||||
{{#competitor_analysis_3}}
|
||||
|
||||
#### Competitor 3
|
||||
|
||||
{{competitor_analysis_3}}
|
||||
{{/competitor_analysis_3}}
|
||||
|
||||
{{#competitor_analysis_4}}
|
||||
|
||||
#### Competitor 4
|
||||
|
||||
{{competitor_analysis_4}}
|
||||
{{/competitor_analysis_4}}
|
||||
|
||||
{{#competitor_analysis_5}}
|
||||
|
||||
#### Competitor 5
|
||||
|
||||
{{competitor_analysis_5}}
|
||||
{{/competitor_analysis_5}}
|
||||
|
||||
### Competitive Positioning
|
||||
|
||||
{{competitive_positioning}}
|
||||
|
||||
---
|
||||
|
||||
## 6. Industry Analysis
|
||||
|
||||
### Porter's Five Forces Assessment
|
||||
|
||||
{{porters_five_forces}}
|
||||
|
||||
### Technology Adoption Lifecycle
|
||||
|
||||
{{adoption_lifecycle}}
|
||||
|
||||
### Value Chain Analysis
|
||||
|
||||
{{value_chain_analysis}}
|
||||
|
||||
---
|
||||
|
||||
## 7. Market Opportunities
|
||||
|
||||
### Identified Opportunities
|
||||
|
||||
{{market_opportunities}}
|
||||
|
||||
### Opportunity Prioritization Matrix
|
||||
|
||||
{{opportunity_prioritization}}
|
||||
|
||||
---
|
||||
|
||||
## 8. Strategic Recommendations
|
||||
|
||||
### Go-to-Market Strategy
|
||||
|
||||
{{gtm_strategy}}
|
||||
|
||||
#### Positioning Strategy
|
||||
|
||||
{{positioning_strategy}}
|
||||
|
||||
#### Target Segment Sequencing
|
||||
|
||||
{{segment_sequencing}}
|
||||
|
||||
#### Channel Strategy
|
||||
|
||||
{{channel_strategy}}
|
||||
|
||||
#### Pricing Strategy
|
||||
|
||||
{{pricing_recommendations}}
|
||||
|
||||
### Implementation Roadmap
|
||||
|
||||
{{implementation_roadmap}}
|
||||
|
||||
---
|
||||
|
||||
## 9. Risk Assessment
|
||||
|
||||
### Risk Analysis
|
||||
|
||||
{{risk_assessment}}
|
||||
|
||||
### Mitigation Strategies
|
||||
|
||||
{{mitigation_strategies}}
|
||||
|
||||
---
|
||||
|
||||
## 10. Financial Projections
|
||||
|
||||
{{#financial_projections}}
|
||||
{{financial_projections}}
|
||||
{{/financial_projections}}
|
||||
|
||||
---
|
||||
|
||||
## Appendices
|
||||
|
||||
### Appendix A: Data Sources and References
|
||||
|
||||
{{data_sources}}
|
||||
|
||||
### Appendix B: Detailed Calculations
|
||||
|
||||
{{detailed_calculations}}
|
||||
|
||||
### Appendix C: Additional Analysis
|
||||
|
||||
{{#appendices}}
|
||||
{{appendices}}
|
||||
{{/appendices}}
|
||||
|
||||
### Appendix D: Glossary of Terms
|
||||
|
||||
{{glossary}}
|
||||
|
||||
---
|
||||
|
||||
## References and Sources
|
||||
|
||||
**CRITICAL: All data in this report must be verifiable through the sources listed below**
|
||||
|
||||
### Market Size and Growth Data Sources
|
||||
|
||||
{{sources_market_size}}
|
||||
|
||||
### Competitive Intelligence Sources
|
||||
|
||||
{{sources_competitive}}
|
||||
|
||||
### Customer Research Sources
|
||||
|
||||
{{sources_customer}}
|
||||
|
||||
### Industry Trends and Analysis Sources
|
||||
|
||||
{{sources_trends}}
|
||||
|
||||
### Additional References
|
||||
|
||||
{{sources_additional}}
|
||||
|
||||
### Source Quality Assessment
|
||||
|
||||
- **High Credibility Sources (2+ corroborating):** {{high_confidence_count}} claims
|
||||
- **Medium Credibility (single source):** {{medium_confidence_count}} claims
|
||||
- **Low Credibility (needs verification):** {{low_confidence_count}} claims
|
||||
|
||||
**Note:** Any claim marked [Low Confidence] or [Single source] should be independently verified before making critical business decisions.
|
||||
|
||||
---
|
||||
|
||||
## Document Information
|
||||
|
||||
**Workflow:** BMad Market Research Workflow v1.0
|
||||
**Generated:** {{date}}
|
||||
**Next Review:** {{next_review_date}}
|
||||
**Classification:** {{classification}}
|
||||
|
||||
### Research Quality Metrics
|
||||
|
||||
- **Data Freshness:** Current as of {{date}}
|
||||
- **Source Reliability:** {{source_reliability_score}}
|
||||
- **Confidence Level:** {{confidence_level}}
|
||||
- **Total Sources Cited:** {{total_sources}}
|
||||
- **Web Searches Conducted:** {{search_count}}
|
||||
|
||||
---
|
||||
|
||||
_This market research report was generated using the BMad Method Market Research Workflow, combining systematic analysis frameworks with real-time market intelligence gathering. All factual claims are backed by cited sources with verification dates._
|
||||
Reference in New Issue
Block a user