112 lines
4.6 KiB
Markdown
112 lines
4.6 KiB
Markdown
# BMAD Documentation
|
|
|
|
Complete documentation for the BMAD Method.
|
|
|
|
## Getting Started
|
|
|
|
### New to BMAD?
|
|
Start with the core concepts to understand how BMAD works:
|
|
|
|
- **[Core Concepts](./bmad-core-concepts/)** - Agents, workflows, and modules explained
|
|
- **[Installation Guide](./bmad-core-concepts/installing/)** - Set up BMAD in your project
|
|
- **[Quick Start Guide](./modules/bmm-bmad-method/quick-start)** - Build your first feature
|
|
|
|
### Upgrading from v4?
|
|
- **[v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md)** - Migration path for v4 users
|
|
|
|
---
|
|
|
|
## Module Documentation
|
|
|
|
### BMAD Method (BMM) - Software & Game Development
|
|
|
|
The flagship module for agile AI-driven development.
|
|
|
|
- **[BMM Module Index](./modules/bmm-bmad-method/index)** - Module overview, agents, and documentation
|
|
- [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Step-by-step guide
|
|
- [Quick Spec Flow](./modules/bmm-bmad-method/quick-spec-flow) - Rapid Level 0-1 development
|
|
- [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Working with existing codebases
|
|
- **[BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides)** - Essential reading
|
|
|
|
### BMAD Builder (BMB) - Create Custom Solutions
|
|
|
|
Build your own agents, workflows, and modules.
|
|
|
|
- **[BMB Module Overview](./modules/bmb-bmad-builder/index)** - Module overview and capabilities
|
|
- **[Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md)** - Create custom agents
|
|
- **[Custom Content Installation](./modules/bmb-bmad-builder/custom-content-installation.md)** - Share and install custom creations
|
|
|
|
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
|
|
|
- **[CIS Documentation](./modules/cis-creative-intelligence-suite/index)**
|
|
|
|
### BMAD Game Dev (BMGD)
|
|
|
|
- **[BMGD Documentation](./modules/bmgd-bmad-game-dev/index)** - Game development workflows
|
|
|
|
---
|
|
|
|
## Core Module
|
|
|
|
### Global Core Entities
|
|
|
|
- **[Core Module Index](./modules/core/index)** - Shared functionality available to all modules
|
|
- [Global Core Config](./modules/core/global-core-config.md) - Inheritable configuration
|
|
- [Core Workflows](./modules/core/core-workflows.md) - Domain-agnostic workflows
|
|
- [Party Mode](./modules/core/party-mode.md) - Multi-agent conversations
|
|
- [Brainstorming](./modules/core/brainstorming.md) - Structured creative sessions
|
|
- [Advanced Elicitation](./modules/core/advanced-elicitation.md) - LLM reasoning techniques
|
|
- [Core Tasks](./modules/core/core-tasks.md) - Common tasks across modules
|
|
|
|
---
|
|
|
|
## Advanced Topics
|
|
|
|
### Customization
|
|
|
|
- **[BMAD Customization](./bmad-core-concepts/bmad-customization/)** - Modify agents and workflows
|
|
|
|
### Platform Guides
|
|
|
|
- **[Web Bundles](./bmad-core-concepts/web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
|
|
|
|
---
|
|
|
|
## Recommended Reading Paths
|
|
|
|
### Path 1: Brand New to BMAD (Software Project)
|
|
|
|
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
|
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
|
3. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
|
|
4. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
|
|
|
### Path 2: Game Development Project
|
|
|
|
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
|
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
|
3. [BMGD Workflows Guide](./modules/bmgd-bmad-game-dev/workflows-guide) - Game-specific workflows
|
|
|
|
### Path 3: Upgrading from v4
|
|
|
|
1. [v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md) - Understand what changed
|
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Reorient yourself
|
|
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Learn new v6 workflows
|
|
|
|
### Path 4: Working with Existing Codebase (Brownfield)
|
|
|
|
1. [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Approach for legacy code
|
|
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Follow the process
|
|
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
|
|
|
### Path 5: Building Custom Agents
|
|
|
|
1. [Core Concepts: Agents](./bmad-core-concepts/agents.md) - Understand Simple vs Expert
|
|
2. [Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md) - Build your first agent
|
|
3. [Agent Architecture](./modules/bmb-bmad-builder/index) - Deep technical details
|
|
|
|
### Path 6: Contributing to BMAD
|
|
|
|
1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
|
|
2. Relevant module README - Understand the area you're contributing to
|