mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
cfedecbd53
## 📚 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>
170 lines
5.1 KiB
Markdown
170 lines
5.1 KiB
Markdown
# BMM - BMad Method Module
|
|
|
|
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
|
|
|
|
## Table of Contents
|
|
|
|
- [Essential Reading](#essential-reading)
|
|
- [Documentation](#documentation)
|
|
- [Module Structure](#module-structure)
|
|
- [Quick Start](#quick-start)
|
|
- [Key Concepts](#key-concepts)
|
|
- [Scale Levels](#scale-levels)
|
|
- [Story Lifecycle](#story-lifecycle)
|
|
- [Best Practices](#best-practices)
|
|
|
|
## Essential Reading
|
|
|
|
**[📖 BMM v6 Workflows Guide](./workflows/README.md)** - Required reading before using BMM. Explains the revolutionary workflow system and component integration.
|
|
|
|
## Documentation
|
|
|
|
All BMM-specific documentation is organized in the `docs/` folder:
|
|
|
|
### Getting Started
|
|
|
|
- **[Quick Start Guide](./docs/quick-start.md)** - Step-by-step guide to building your first project with BMM
|
|
- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Rapid Level 0-1 development for bug fixes and small features
|
|
|
|
### Core Concepts
|
|
|
|
- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Understanding BMad Method's 5-level system (Level 0-4)
|
|
- **[Brownfield Guide](./docs/brownfield-guide.md)** - Guidance for working with existing codebases
|
|
|
|
### Workflows & Reference
|
|
|
|
- **[Workflows Guide](./workflows/README.md)** - Complete v6 workflow system (ESSENTIAL)
|
|
- **[Test Architect Guide](./testarch/README.md)** - Testing strategy and quality assurance
|
|
|
|
## Module Structure
|
|
|
|
### 🤖 Agents
|
|
|
|
**Core Development Roles:**
|
|
|
|
- **PM** - Product Manager for planning and requirements
|
|
- **Analyst** - Business analysis and research
|
|
- **Architect** - Technical architecture and design
|
|
- **SM** - Scrum Master for sprint and story management
|
|
- **DEV** - Developer for implementation
|
|
- **TEA** - Test Architect for quality assurance
|
|
- **UX** - User experience design
|
|
|
|
**Game Development** (Optional):
|
|
|
|
- **Game Designer** - Creative vision and GDD creation
|
|
- **Game Developer** - Game-specific implementation
|
|
- **Game Architect** - Game systems and infrastructure
|
|
|
|
### 📋 Workflows
|
|
|
|
Four-phase methodology adapting to project complexity:
|
|
|
|
**1. Analysis** (Optional)
|
|
|
|
- `brainstorm-project` - Project ideation
|
|
- `research` - Market/technical research
|
|
- `product-brief` - Product strategy
|
|
|
|
**2. Planning** (Required)
|
|
|
|
- `prd` - Scale-adaptive planning
|
|
- Routes to appropriate documentation level
|
|
|
|
**3. Solutioning** (Level 3-4)
|
|
|
|
- `architecture` - System design
|
|
- `tech-spec` - Epic technical specifications
|
|
|
|
**4. Implementation** (Iterative)
|
|
|
|
- `create-story` - Draft stories
|
|
- `story-context` - Inject expertise
|
|
- `dev-story` - Implement
|
|
- `code-review` - Validate quality
|
|
|
|
### 👥 Teams
|
|
|
|
Pre-configured agent groups for coordinated complex tasks.
|
|
|
|
### 📝 Tasks
|
|
|
|
Atomic work units composing into larger workflows.
|
|
|
|
### 🏗️ Test Architecture
|
|
|
|
**[TEA Guide](./testarch/README.md)** - Comprehensive testing strategy across 9 specialized workflows.
|
|
|
|
## Quick Start
|
|
|
|
1. **Load PM agent** in your IDE
|
|
2. **Wait for menu** to appear
|
|
3. **Run workflow:**
|
|
```
|
|
*prd
|
|
```
|
|
|
|
**IDE Instructions:**
|
|
|
|
- [Claude Code](../../../docs/ide-info/claude-code.md)
|
|
- [Cursor](../../../docs/ide-info/cursor.md)
|
|
- [VS Code](../../../docs/ide-info/windsurf.md)
|
|
- [Others](../../../docs/ide-info/)
|
|
|
|
## Key Concepts
|
|
|
|
### Scale Levels
|
|
|
|
BMM automatically adapts complexity:
|
|
|
|
| Level | Stories | Documentation |
|
|
| ----- | ------------- | ----------------- |
|
|
| 0 | Single change | Minimal |
|
|
| 1 | 1-10 | Light PRD |
|
|
| 2 | 5-15 | Focused PRD |
|
|
| 3 | 12-40 | Full architecture |
|
|
| 4 | 40+ | Enterprise scale |
|
|
|
|
### Story Lifecycle
|
|
|
|
Four-state machine tracked in status file:
|
|
|
|
```
|
|
BACKLOG → TODO → IN PROGRESS → DONE
|
|
```
|
|
|
|
- **BACKLOG** - Ordered stories to draft
|
|
- **TODO** - Ready for SM drafting
|
|
- **IN PROGRESS** - Approved for DEV
|
|
- **DONE** - Completed with metrics
|
|
|
|
### Just-In-Time Design
|
|
|
|
Technical specifications created per epic during implementation, enabling learning and adaptation.
|
|
|
|
### Context Injection
|
|
|
|
Dynamic technical guidance generated for each story, providing exact expertise when needed.
|
|
|
|
## Best Practices
|
|
|
|
1. **Start with workflows** - Let process guide you
|
|
2. **Respect scale** - Don't over-document small projects
|
|
3. **Trust the process** - Methodology carefully designed
|
|
4. **Use status file** - Single source of truth for stories
|
|
|
|
## Related Documentation
|
|
|
|
- **[Complete Documentation Index](./docs/)** - All BMM guides and references
|
|
- **[Quick Start Guide](./docs/quick-start.md)** - Getting started with BMM
|
|
- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Rapid Level 0-1 development
|
|
- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Understanding project levels
|
|
- **[Brownfield Guide](./docs/brownfield-guide.md)** - Working with existing code
|
|
- **[Workflows Guide](./workflows/README.md)** - Complete workflow reference
|
|
- **[Test Architect Guide](./testarch/README.md)** - Testing strategy
|
|
- **[IDE Setup](../../../docs/ide-info/)** - Environment configuration
|
|
|
|
---
|
|
|
|
For complete BMad Method workflow system details, see the [BMM Workflows README](./workflows/README.md).
|