mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
more docs migrations
This commit is contained in:
51
README.md
51
README.md
@@ -26,7 +26,6 @@ The completely revamped **BMAD V6 installer** now includes built-in support for
|
|||||||
|
|
||||||
- [**Custom Content Overview**](docs/modules/bmb-bmad-builder/custom-content.md) - Discover all supported content types
|
- [**Custom Content Overview**](docs/modules/bmb-bmad-builder/custom-content.md) - Discover all supported content types
|
||||||
- [**Installation Guide**](docs/modules/bmb-bmad-builder/custom-content-installation.md) - Learn to create and install custom content
|
- [**Installation Guide**](docs/modules/bmb-bmad-builder/custom-content-installation.md) - Learn to create and install custom content
|
||||||
- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
|
|
||||||
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -68,7 +67,7 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
|||||||
## 📊 See It In Action
|
## 📊 See It In Action
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="./src/modules/bmm/docs/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
<img src="./docs/modules/bmm-bmad-method/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@@ -81,10 +80,10 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install v6 Alpha (recommended)
|
# Install v6 Alpha (recommended)
|
||||||
npx bmad-method@alpha install
|
npx bmad-method install
|
||||||
|
|
||||||
# Or stable v4 for production
|
# Or stable v4 for production
|
||||||
npx bmad-method install
|
npx bmad-method@latest install
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Initialize Your Project
|
### 2. Initialize Your Project
|
||||||
@@ -124,35 +123,35 @@ Each phase has specialized workflows and agents working together to deliver exce
|
|||||||
|
|
||||||
**12 Specialized Agents** working in concert:
|
**12 Specialized Agents** working in concert:
|
||||||
|
|
||||||
| Development | Architecture | Product | Leadership |
|
| Development | Architecture | Product | Leadership |
|
||||||
| ----------- | -------------- | ------------- | -------------- |
|
| ----------- | -------------- | ----------- | ------------ |
|
||||||
| Developer | Architect | PM | Scrum Master |
|
| Developer | Architect | PM | Scrum Master |
|
||||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
| UX Designer | Test Architect | Analyst | BMad Master |
|
||||||
| Tech Writer | Game Architect | Game Designer | Game Developer |
|
| | | Tech Writer | |
|
||||||
|
|
||||||
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready fixture-based utilities.
|
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities.
|
||||||
|
|
||||||
Each agent brings deep expertise and can be customized to match your team's style.
|
Each agent brings deep expertise and can be customized to match your team's style.
|
||||||
|
|
||||||
## 📦 What's Included
|
## 📦 What's Included
|
||||||
|
|
||||||
### Core Modules
|
### Official Modules
|
||||||
|
|
||||||
- **BMad Method (BMM)** - Complete agile development framework
|
- **BMad Method (BMM)** - Complete agile development framework
|
||||||
- 12 specialized agents
|
- 12 specialized agents
|
||||||
- 34 workflows across 4 phases
|
- 34 workflows across 4 phases
|
||||||
- Scale-adaptive planning
|
- Stand Along Quick Spec Flow for a streamlined simple implementation process
|
||||||
- [→ Documentation Hub](./src/modules/bmm/docs/index.md)
|
- [→ Documentation Hub](./docs/modules/bmm-bmad-method/index.md)
|
||||||
|
|
||||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||||
- Build anything from simple agents to complex modules
|
- Build anything from simple agents to complex modules
|
||||||
- Create domain-specific solutions (legal, medical, finance, education)
|
- Create domain-specific solutions (legal, medical, finance, education)
|
||||||
- [→ Builder Guide](./src/modules/bmb/docs/index.md)
|
- [→ Builder Guide](./docs/modules/bmb-bmad-builder/index.md)
|
||||||
|
|
||||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||||
- Brainstorming, design thinking, storytelling
|
- Brainstorming, design thinking, storytelling
|
||||||
- 5 creative facilitation workflows
|
- 5 creative facilitation workflows
|
||||||
- [→ Creative Workflows](docs/modules/cis-creative-intelligence-suite/index.md)
|
- [→ Creative Workflows](./docs/modules/cis-creative-intelligence-suite/index.md)
|
||||||
|
|
||||||
### Key Features
|
### Key Features
|
||||||
|
|
||||||
@@ -166,14 +165,14 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||||||
|
|
||||||
### Quick Links
|
### Quick Links
|
||||||
|
|
||||||
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
|
- **[Quick Start Guide](./docs/modules/bmm-bmad-method/quick-start.md)** - 15-minute introduction
|
||||||
- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
|
- **[Complete BMM Documentation](./docs/modules/bmm-bmad-method/index.md)** - All guides and references
|
||||||
- **[Agent Customization](docs/bmad-customization/agent-customization-guide.md)** - Personalize your agents
|
- **[Agent Customization](docs/bmad-customization/agent-customization-guide.md)** - Personalize your agents
|
||||||
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
||||||
|
|
||||||
### For v4 Users
|
### For v4 Users
|
||||||
|
|
||||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
|
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
||||||
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
|
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
|
||||||
|
|
||||||
## 💬 Community & Support
|
## 💬 Community & Support
|
||||||
@@ -181,24 +180,12 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
||||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
||||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
||||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
|
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
|
||||||
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
||||||
|
|
||||||
## 🛠️ Development
|
## 🛠️ Development
|
||||||
|
|
||||||
For contributors working on the BMad codebase:
|
If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run all quality checks
|
|
||||||
npm test
|
|
||||||
|
|
||||||
# Development commands
|
|
||||||
npm run lint:fix # Fix code style
|
|
||||||
npm run format:fix # Auto-format code
|
|
||||||
npm run bundle # Build web bundles
|
|
||||||
```
|
|
||||||
|
|
||||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
|
||||||
|
|
||||||
## What's New in v6
|
## What's New in v6
|
||||||
|
|
||||||
|
|||||||
@@ -34,14 +34,12 @@
|
|||||||
|
|
||||||
The flagship module for agile AI-driven development.
|
The flagship module for agile AI-driven development.
|
||||||
|
|
||||||
- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
|
- **[BMM Module Index](./modules/bmm-bmad-method/index)** - Module overview, agents, and complete documentation index
|
||||||
- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
|
- [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Step-by-step guide to building your first project
|
||||||
- [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
|
- [Quick Spec Flow](./modules/bmm-bmad-method/quick-spec-flow) - Rapid Level 0-1 development
|
||||||
- [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
|
- [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Working with existing codebases
|
||||||
- [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
|
- **[BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides)** - **ESSENTIAL READING**
|
||||||
- [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
|
- **[Test Architect Guide](./modules/bmm-bmad-method/test-architecture)** - Testing strategy and quality assurance
|
||||||
- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
|
|
||||||
- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
|
|
||||||
|
|
||||||
### BMad Builder (BMB) - Create Custom Solutions
|
### BMad Builder (BMB) - Create Custom Solutions
|
||||||
|
|
||||||
@@ -53,6 +51,12 @@ Build your own agents, workflows, and modules.
|
|||||||
|
|
||||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||||
|
|
||||||
|
- **[CIS Docs](./modules/cis-creative-intelligence-suite/index.md)**
|
||||||
|
|
||||||
|
#### Bmad Game Dev (BMGD)
|
||||||
|
|
||||||
|
- [Main Game Dev Module Docs Index](./modules/bmgd-bmad-game-dev/index.md)
|
||||||
|
|
||||||
AI-powered creative thinking and brainstorming.
|
AI-powered creative thinking and brainstorming.
|
||||||
|
|
||||||
- **[CIS Module README](./modules/cis-creative-intelligence-suite/index)** - Module overview and workflows
|
- **[CIS Module README](./modules/cis-creative-intelligence-suite/index)** - Module overview and workflows
|
||||||
@@ -69,28 +73,28 @@ AI-powered creative thinking and brainstorming.
|
|||||||
### Path 1: Brand New to BMad (Software Project)
|
### Path 1: Brand New to BMad (Software Project)
|
||||||
|
|
||||||
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
||||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
|
||||||
3. [BMM Module README](./modules/bmm/) - Understand agents
|
3. [BMM Module README](./modules/bmm-bmad-method/) - Understand agents
|
||||||
4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
4. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||||
|
|
||||||
### Path 2: Game Development Project
|
### Path 2: Game Development Project
|
||||||
|
|
||||||
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
||||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
|
||||||
3. [BMM Module README](./modules/bmm/) - Game agents are included
|
3. [BMM Module README](./modules/bmm-bmad-method/) - Game agents are included
|
||||||
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
|
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
|
||||||
|
|
||||||
### Path 3: Upgrading from v4
|
### Path 3: Upgrading from v4
|
||||||
|
|
||||||
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
||||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Reorient yourself
|
||||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
|
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Learn new v6 workflows
|
||||||
|
|
||||||
### Path 4: Working with Existing Codebase (Brownfield)
|
### Path 4: Working with Existing Codebase (Brownfield)
|
||||||
|
|
||||||
1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
|
1. [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Approach for legacy code
|
||||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Follow the process
|
||||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||||
|
|
||||||
### Path 5: Building Custom Solutions
|
### Path 5: Building Custom Solutions
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 200 KiB After Width: | Height: | Size: 200 KiB |
@@ -8,7 +8,7 @@ Complete reference for all BMGD workflows organized by development phase.
|
|||||||
|
|
||||||
BMGD workflows are organized into four phases:
|
BMGD workflows are organized into four phases:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -259,7 +259,7 @@ Checks current project status across all phases. Shows completed documents, curr
|
|||||||
|
|
||||||
## Quick-Flow Workflows
|
## Quick-Flow Workflows
|
||||||
|
|
||||||
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](./quick-flow-guide.md)** for detailed usage.
|
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** for detailed usage.
|
||||||
|
|
||||||
### Quick-Prototype
|
### Quick-Prototype
|
||||||
|
|
||||||
@@ -457,7 +457,7 @@ This means:
|
|||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
|
- **[Quick Start Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-start.md)** - Get started with BMGD
|
||||||
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development
|
- **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** - Rapid prototyping and development
|
||||||
- **[Agents Guide](./agents-guide.md)** - Agent reference
|
- **[Agents Guide](../../../../docs/modules/bmgd-bmad-game-dev/agents-guide.md)** - Agent reference
|
||||||
- **[Game Types Guide](./game-types-guide.md)** - Game type templates
|
- **[Game Types Guide](../../../../docs/modules/bmgd-bmad-game-dev/game-types-guide.md)** - Game type templates
|
||||||
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
@@ -192,8 +192,8 @@ Planning workflows automatically load these documents if they exist in the outpu
|
|||||||
|
|
||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase
|
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Next phase
|
||||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
- [Phase 3: Solutioning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-solutioning.md)
|
||||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md)
|
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md)
|
||||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity
|
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity
|
||||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||||
@@ -434,7 +434,7 @@ Architecture documents are living. Update them as you learn during implementatio
|
|||||||
|
|
||||||
**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method.
|
**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method.
|
||||||
|
|
||||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration.
|
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](../../../../docs/modules/bmm-bmad-method/test-architecture.md) for TEA's full lifecycle integration.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -471,10 +471,10 @@ Architecture documents are living. Update them as you learn during implementatio
|
|||||||
|
|
||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase
|
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Previous phase
|
||||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase
|
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md) - Next phase
|
||||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks
|
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks
|
||||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive
|
|||||||
|
|
||||||
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
||||||
|
|
||||||
Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
Note - a project is just a folder with `_bmad` in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||||
|
|
||||||
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
||||||
|
|
||||||
|
|||||||
@@ -1,123 +0,0 @@
|
|||||||
# BMM - BMad Method Module
|
|
||||||
|
|
||||||
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📚 Complete Documentation
|
|
||||||
|
|
||||||
👉 **[BMM Documentation Hub](./docs/index.md)** - Start here for complete guides, tutorials, and references
|
|
||||||
|
|
||||||
**Quick Links:**
|
|
||||||
|
|
||||||
- **[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
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🏗️ 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) - 2 workflows
|
|
||||||
**Phase 3:** Solutioning (required) - 3 workflows
|
|
||||||
**Phase 4:** Implementation (iterative) - 7 workflows
|
|
||||||
|
|
||||||
👉 **[Workflow Guides](./docs/index.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 → ready-for-dev → 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
|
|
||||||
|
|
||||||
## 🤝 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)
|
|
||||||
Reference in New Issue
Block a user