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:
113
bmad/bmm/workflows/1-analysis/brainstorm-project/README.md
Normal file
113
bmad/bmm/workflows/1-analysis/brainstorm-project/README.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# Project Brainstorming Workflow
|
||||
|
||||
Structured ideation for software projects exploring problem spaces, architectures, and innovative solutions beyond traditional requirements gathering.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Purpose](#purpose)
|
||||
- [Usage](#usage)
|
||||
- [Process](#process)
|
||||
- [Inputs & Outputs](#inputs--outputs)
|
||||
- [Integration](#integration)
|
||||
|
||||
## Purpose
|
||||
|
||||
Generate multiple solution approaches for software projects through:
|
||||
|
||||
- Parallel ideation tracks (architecture, UX, integration, value delivery)
|
||||
- Technical-business alignment from inception
|
||||
- Hidden assumption discovery
|
||||
- Innovation beyond obvious solutions
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Run brainstorming session
|
||||
bmad bmm *brainstorm-project
|
||||
|
||||
# Or via Analyst agent
|
||||
*brainstorm-project
|
||||
```
|
||||
|
||||
## Process
|
||||
|
||||
### 1. Context Capture
|
||||
|
||||
- Business objectives and constraints
|
||||
- Technical environment
|
||||
- Stakeholder needs
|
||||
- Success criteria
|
||||
|
||||
### 2. Parallel Ideation
|
||||
|
||||
- **Architecture Track**: Technical approaches with trade-offs
|
||||
- **UX Track**: Interface paradigms and user journeys
|
||||
- **Integration Track**: System connection patterns
|
||||
- **Value Track**: Feature prioritization and delivery
|
||||
|
||||
### 3. Solution Synthesis
|
||||
|
||||
- Evaluate feasibility and impact
|
||||
- Align with strategic objectives
|
||||
- Surface hidden assumptions
|
||||
- Generate recommendations
|
||||
|
||||
## Inputs & Outputs
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Type | Purpose |
|
||||
| ----------------- | -------- | --------------------------------------------- |
|
||||
| Project Context | Document | Business objectives, environment, constraints |
|
||||
| Problem Statement | Optional | Core challenge or opportunity |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Content |
|
||||
| ------------------------ | ------------------------------------------- |
|
||||
| Architecture Proposals | Multiple approaches with trade-off analysis |
|
||||
| Value Framework | Prioritized features aligned to objectives |
|
||||
| Risk Analysis | Dependencies, challenges, opportunities |
|
||||
| Strategic Recommendation | Synthesized direction with rationale |
|
||||
|
||||
## Integration
|
||||
|
||||
### Workflow Chain
|
||||
|
||||
1. **brainstorm-project** ← Current step
|
||||
2. research (optional deep dive)
|
||||
3. product-brief (strategic document)
|
||||
4. Phase 2 planning (PRD/tech-spec)
|
||||
|
||||
### Feed Into
|
||||
|
||||
- Product Brief development
|
||||
- Architecture decisions
|
||||
- PRD requirements
|
||||
- Epic prioritization
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Prepare context** - Gather business and technical background
|
||||
2. **Think broadly** - Explore non-obvious approaches
|
||||
3. **Document assumptions** - Capture implicit beliefs
|
||||
4. **Consider constraints** - Technical, organizational, resource
|
||||
5. **Focus on value** - Align to business objectives
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
# bmad/bmm/config.yaml
|
||||
output_folder: ./output
|
||||
project_name: Your Project
|
||||
```
|
||||
|
||||
## Related Workflows
|
||||
|
||||
- [Research](../research/README.md) - Deep investigation
|
||||
- [Product Brief](../product-brief/README.md) - Strategic planning
|
||||
- [PRD](../../2-plan-workflows/prd/README.md) - Requirements document
|
||||
|
||||
---
|
||||
|
||||
Part of BMad Method v6 - Phase 1 Analysis workflows
|
||||
Reference in New Issue
Block a user