External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-29 16:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

update local install

Browse Source
This commit is contained in:
Brian Madison
2025-11-03 21:05:18 -06:00
parent 17f81a84f3
commit e7d51739e4
105 changed files with 11997 additions and 13131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

275
bmad/bmm/README.md
View File

@@ -2,168 +2,127 @@
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)
## 📚 Complete Documentation
## Essential Reading
👉 **[BMM Documentation Hub](./docs/README.md)** - Start here for complete guides, tutorials, and references
**[📖 BMM v6 Workflows Guide](./workflows/README.md)** - Required reading before using BMM. Explains the revolutionary workflow system and component integration.
**Quick Links:**
## 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
- **[Quick Start Guide](./docs/quick-start.md)** - New to BMM? Start here (15 min)
- **[Agents Guide](./docs/agents-guide.md)** - Meet your 12 specialized AI agents (45 min)
- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - How BMM adapts to project size (42 min)
- **[FAQ](./docs/faq.md)** - Quick answers to common questions
- **[Glossary](./docs/glossary.md)** - Key terminology reference
---
For complete BMad Method workflow system details, see the [BMM Workflows README](./workflows/README.md).
## 🏗️ Module Structure
This module contains:
```
bmm/
├── agents/ # 12 specialized AI agents (PM, Architect, SM, DEV, TEA, etc.)
├── workflows/ # 34 workflows across 4 phases + testing
├── teams/ # Pre-configured agent groups
├── tasks/ # Atomic work units
├── testarch/ # Comprehensive testing infrastructure
└── docs/ # Complete user documentation
```
### Agent Roster
**Core Development:** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer
**Game Development:** Game Designer, Game Developer, Game Architect
**Orchestration:** BMad Master (from Core)
👉 **[Full Agents Guide](./docs/agents-guide.md)** - Roles, workflows, and when to use each agent
### Workflow Phases
**Phase 0:** Documentation (brownfield only)
**Phase 1:** Analysis (optional) - 5 workflows
**Phase 2:** Planning (required) - 6 workflows
**Phase 3:** Solutioning (Level 3-4) - 2 workflows
**Phase 4:** Implementation (iterative) - 10 workflows
**Testing:** Quality assurance (parallel) - 9 workflows
👉 **[Workflow Guides](./docs/README.md#-workflow-guides)** - Detailed documentation for each phase
---
## 🚀 Getting Started
**New Project:**
```bash
# Install BMM
npx bmad-method@alpha install
# Load Analyst agent in your IDE, then:
*workflow-init
```
**Existing Project (Brownfield):**
```bash
# Document your codebase first
*document-project
# Then initialize
*workflow-init
```
👉 **[Quick Start Guide](./docs/quick-start.md)** - Complete setup and first project walkthrough
---
## 🎯 Key Concepts
### Scale-Adaptive Design
BMM automatically adjusts to project complexity (Levels 0-4):
- **Level 0-1:** Quick Spec Flow for bug fixes and small features
- **Level 2:** PRD with optional architecture
- **Level 3-4:** Full PRD + comprehensive architecture
👉 **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Complete level breakdown
### Story-Centric Implementation
Stories move through a defined lifecycle: `backlog → drafted → ready → in-progress → review → done`
Just-in-time epic context and story context provide exact expertise when needed.
👉 **[Implementation Workflows](./docs/workflows-implementation.md)** - Complete story lifecycle guide
### Multi-Agent Collaboration
Use party mode to engage all 19+ agents (from BMM, CIS, BMB, custom modules) in group discussions for strategic decisions, creative brainstorming, and complex problem-solving.
👉 **[Party Mode Guide](./docs/party-mode.md)** - How to orchestrate multi-agent collaboration
---
## 📖 Additional Resources
- **[Brownfield Guide](./docs/brownfield-guide.md)** - Working with existing codebases
- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Fast-track for Level 0-1 projects
- **[Enterprise Agentic Development](./docs/enterprise-agentic-development.md)** - Team collaboration patterns
- **[Troubleshooting](./docs/troubleshooting.md)** - Common issues and solutions
- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure Claude Code, Cursor, Windsurf, etc.
---
## 🤝 Community
- **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share feedback (#general-dev, #bugs-issues)
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
- **[YouTube](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
---
**Ready to build?** → [Start with the Quick Start Guide](./docs/quick-start.md)