mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
## 📚 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>
95 lines
1.5 KiB
Markdown
95 lines
1.5 KiB
Markdown
# Deep Research Prompt
|
|
|
|
**Generated:** {{date}}
|
|
**Created by:** {{user_name}}
|
|
**Target Platform:** {{target_platform}}
|
|
|
|
---
|
|
|
|
## Research Prompt (Ready to Use)
|
|
|
|
### Research Question
|
|
|
|
{{research_topic}}
|
|
|
|
### Research Goal and Context
|
|
|
|
**Objective:** {{research_goal}}
|
|
|
|
**Context:**
|
|
{{research_persona}}
|
|
|
|
### Scope and Boundaries
|
|
|
|
**Temporal Scope:** {{temporal_scope}}
|
|
|
|
**Geographic Scope:** {{geographic_scope}}
|
|
|
|
**Thematic Focus:**
|
|
{{thematic_boundaries}}
|
|
|
|
### Information Requirements
|
|
|
|
**Types of Information Needed:**
|
|
{{information_types}}
|
|
|
|
**Preferred Sources:**
|
|
{{preferred_sources}}
|
|
|
|
### Output Structure
|
|
|
|
**Format:** {{output_format}}
|
|
|
|
**Required Sections:**
|
|
{{key_sections}}
|
|
|
|
**Depth Level:** {{depth_level}}
|
|
|
|
### Research Methodology
|
|
|
|
**Keywords and Technical Terms:**
|
|
{{research_keywords}}
|
|
|
|
**Special Requirements:**
|
|
{{special_requirements}}
|
|
|
|
**Validation Criteria:**
|
|
{{validation_criteria}}
|
|
|
|
### Follow-up Strategy
|
|
|
|
{{follow_up_strategy}}
|
|
|
|
---
|
|
|
|
## Complete Research Prompt (Copy and Paste)
|
|
|
|
```
|
|
{{deep_research_prompt}}
|
|
```
|
|
|
|
---
|
|
|
|
## Platform-Specific Usage Tips
|
|
|
|
{{platform_tips}}
|
|
|
|
---
|
|
|
|
## Research Execution Checklist
|
|
|
|
{{execution_checklist}}
|
|
|
|
---
|
|
|
|
## Metadata
|
|
|
|
**Workflow:** BMad Research Workflow - Deep Research Prompt Generator v2.0
|
|
**Generated:** {{date}}
|
|
**Research Type:** Deep Research Prompt
|
|
**Platform:** {{target_platform}}
|
|
|
|
---
|
|
|
|
_This research prompt was generated using the BMad Method Research Workflow, incorporating best practices from ChatGPT Deep Research, Gemini Deep Research, Grok DeepSearch, and Claude Projects (2025)._
|