289 lines
18 KiB
Markdown
289 lines
18 KiB
Markdown
# The BMAD-Method 4.0 (Breakthrough Method of Agile (ai-driven) Development)
|
|
|
|
Previous Versions:
|
|
[Prior Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) | [Prior Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) | [Prior Version 3.1](https://github.com/bmadcode/BMAD-METHOD/tree/V3.1)
|
|
|
|
## 🚀 Major Update: Complete Documentation Enhancement Project
|
|
|
|
**BMAD Method 4.0** represents a massive expansion with **100+ documents**, **500+ pages**, and **comprehensive persona documentation packages**. This release includes complete documentation ecosystems for all personas, integration guides, quality frameworks, and success metrics.
|
|
|
|
## Do This First, and all will make sense
|
|
|
|
There are lots of docs here, but I HIGHLY suggest you just try the Web Agent - it takes just a few minutes to set up in Gemini - and you can use the BMad Agent to explain how this method works, how to set up in the IDE, how to set up in the Web, what should be done in the web or ide (although you can choose your own path also!) - all just by talking to the bmad agent!
|
|
|
|
### Web Quickstart Project Setup (Recommended)
|
|
|
|
Orchestrator Uber BMad Agent that does it all - already pre-compiled in the `web-build-sample` folder.
|
|
|
|
- The contents of [Agent Prompt Sample](web-build-sample/agent-prompt.txt) text get pasted into the Gemini Gem, or ChatPGT customGPT customGPT 'Instructions' field.
|
|
- The remaining files in that same folder folder just need to be attached as shown in the screenshot below. Give it a name (such as BMad Agent) and save it, and you now have the BMad Agent available to help you brainstorm, research, plan, execute on your vision, or understand how this all even works!
|
|
- Once its running, start with typing `/help`, and then type option `2` when it presents 3 options to learn about the method!
|
|
|
|
|
|
|
|
## How It Works: The BMAD Method Explained
|
|
|
|
The BMAD Method uses a powerful **Orchestrator** system that coordinates specialized AI personas to handle different aspects of your project:
|
|
|
|
### Core Mechanics:
|
|
|
|
1. **Orchestrator**: The central "brain" that manages all personas and tasks
|
|
2. **Personas**: Specialized AI experts (PM, Architect, UX/UI Designer, etc.)
|
|
3. **Tasks**: Specific workflows each persona can execute
|
|
4. **Templates**: Standardized documents personas use to create deliverables
|
|
|
|
### Workflow:
|
|
|
|
```
|
|
User Request → Orchestrator → Appropriate Persona → Task Execution → Deliverable
|
|
```
|
|
|
|
### Environments:
|
|
|
|
- **Web-based**: Run in ChatGPT or Gemini with attached knowledge files
|
|
- **IDE-based**: Run directly in your code editor with full project context
|
|
|
|
### Key Commands:
|
|
|
|
- `/persona [name]` - Activate a specific persona (Web)
|
|
- `/task [name]` - Execute a specific task (Web)
|
|
- `*persona [name]` - Activate a specific persona (IDE)
|
|
- `*task [name]` - Execute a specific task (IDE)
|
|
|
|
[Learn more about BMAD orchestration](docs/readme.md) | [Detailed mechanics](docs/workflow-diagram.md) | [Command reference](docs/instruction.md)
|
|
|
|
## 📚 Complete Documentation Ecosystem (NEW in 4.0)
|
|
|
|
BMAD Method 4.0 includes the most comprehensive AI-driven development documentation available, with **complete persona packages**, **integration guides**, and **quality frameworks**.
|
|
|
|
### 🎯 Complete Persona Documentation Packages
|
|
|
|
Each persona now has a **complete documentation package** including comprehensive guides, templates, quality standards, workflows, and success metrics:
|
|
|
|
#### Business Analysis & Product Management
|
|
- **[Business Analyst Complete Package](docs/analyst-comprehensive-guide.md)** - Full BA documentation suite
|
|
- [Integration Guide](docs/analyst-integration-guide.md) | [Quickstart](docs/analyst-quickstart.md)
|
|
- [Templates](docs/analyst-template-guide.md) | [Quality Standards](docs/analyst-quality-standards.md)
|
|
- [Workflows](docs/analyst-workflow-mapping.md) | [Success Metrics](docs/analyst-success-metrics.md)
|
|
|
|
- **[Product Manager Complete Package](docs/pm-comprehensive-guide.md)** - Full PM documentation suite
|
|
- [Integration Guide](docs/pm-integration-guide.md) | [Quickstart](docs/pm-quickstart.md)
|
|
- [Templates](docs/pm-template-guide.md) | [Quality Standards](docs/pm-quality-standards.md)
|
|
- [Workflows](docs/pm-workflow-mapping.md) | [Success Metrics](docs/pm-success-metrics.md)
|
|
|
|
- **[Product Owner Complete Package](docs/po-comprehensive-guide.md)** - Full PO documentation suite
|
|
- [Integration Guide](docs/po-integration-guide.md) | [Quickstart](docs/po-quickstart.md)
|
|
- [Templates](docs/po-template-guide.md) | [Quality Standards](docs/po-quality-standards.md)
|
|
- [Workflows](docs/po-workflow-mapping.md) | [Success Metrics](docs/po-success-metrics.md)
|
|
|
|
#### Architecture & Development
|
|
- **[System Architect Complete Package](docs/architect-comprehensive-guide.md)** - Full architect documentation suite
|
|
- [Integration Guide](docs/architect-integration-guide.md) | [Quickstart](docs/architect-quickstart.md)
|
|
- [Templates](docs/architect-template-guide.md) | [Quality Standards](docs/architect-quality-standards.md)
|
|
- [Task Library](docs/architect-task-library.md) | [Success Metrics](docs/architect-success-metrics.md)
|
|
|
|
- **[Developer Complete Package](docs/dev-comprehensive-guide.md)** - Full developer documentation suite
|
|
- [Integration Guide](docs/dev-integration-guide.md) | [Quickstart](docs/dev-quickstart.md)
|
|
- [Templates](docs/dev-template-guide.md) | [Quality Standards](docs/dev-quality-standards.md)
|
|
- [Workflows](docs/dev-workflow-mapping.md) | [Success Metrics](docs/dev-success-metrics.md)
|
|
|
|
#### Design & User Experience
|
|
- **[Design Architect Complete Package](docs/design-architect-comprehensive-guide.md)** - Full design documentation suite
|
|
- [Integration Guide](docs/design-architect-integration-guide.md) | [Quickstart](docs/design-architect-quickstart.md)
|
|
- [Templates](docs/design-architect-template-guide.md) | [Quality Standards](docs/design-architect-quality-standards.md)
|
|
- [Workflows](docs/design-architect-workflow-mapping.md) | [Success Metrics](docs/design-architect-success-metrics.md)
|
|
|
|
- **[v0 UX/UI Architect Complete Package](docs/v0-ux-ui-architect-comprehensive-guide.md)** - Revolutionary design-to-code workflow
|
|
- [Integration Guide](docs/v0-ux-ui-architect-integration-guide.md) | [Quickstart](docs/v0-ux-ui-architect-quickstart.md)
|
|
- [User Guide](docs/v0-ux-ui-architect-user-guide.md) | [Quality Assurance](docs/v0-ux-ui-architect-quality-assurance.md)
|
|
|
|
#### Agile & Process Management
|
|
- **[Scrum Master Complete Package](docs/sm-comprehensive-guide.md)** - Full Scrum Master documentation suite
|
|
- [Templates](docs/sm-template-guide.md) | [Quality Standards](docs/sm-quality-standards.md)
|
|
- [Workflows](docs/sm-workflow-mapping.md) | [Success Metrics](docs/sm-success-metrics.md)
|
|
|
|
### 🔗 Integration & Architecture Documentation
|
|
|
|
- **[Comprehensive Integration Guide](docs/bmad-comprehensive-integration-guide.md)** - How all personas work together
|
|
- **[Documentation Map](docs/bmad-documentation-map.md)** - Navigate the complete documentation ecosystem
|
|
- **[System Architecture](docs/system-architecture/README.md)** - Complete system design and integration
|
|
- **[Integration Architecture](docs/system-architecture/integration-architecture.md)** - External system connections
|
|
|
|
### 🧠How It Works Documentation
|
|
- **[Complete Guide](docs/how-it-works/README.md)** - Comprehensive workflow understanding
|
|
- **[Core Concepts](docs/how-it-works/core-concepts.md)** - Fundamental BMAD principles
|
|
- **[Orchestrator Mechanics](docs/how-it-works/orchestrator-mechanics.md)** - Technical coordination details
|
|
- **[Persona Workflows](docs/how-it-works/persona-workflows.md)** - Individual persona processes
|
|
- **[Integration Points](docs/how-it-works/integration-points.md)** - System integration patterns
|
|
- **[Troubleshooting Guide](docs/how-it-works/troubleshooting.md)** - Common issues and solutions
|
|
|
|
### ðŸ—ºï¸ User Journey Maps
|
|
- **[Journey Overview](docs/user-journeys/README.md)** - Complete user experience documentation
|
|
- **[First-Time Setup](docs/user-journeys/first-time-setup.md)** - New user onboarding
|
|
- **[Project Initiation](docs/user-journeys/project-initiation.md)** - Starting new projects
|
|
- **[Feature Development](docs/user-journeys/feature-development.md)** - Development workflows
|
|
- **[Design System Creation](docs/user-journeys/design-system-creation.md)** - UX/UI processes
|
|
- **[Architecture Planning](docs/user-journeys/architecture-planning.md)** - Technical planning
|
|
|
|
### 🎨 Visual Design System
|
|
- **[Visual Standards](docs/visual-elements/README.md)** - Design guidelines and standards
|
|
- **[Interactive Components](docs/visual-elements/interactive-examples.md)** - Reusable UI elements
|
|
- **[Accessibility Guide](docs/visual-elements/accessibility-guide.md)** - WCAG AA compliance
|
|
|
|
### 📋 Documentation Standards & Quality
|
|
- **[Documentation Standards](docs/documentation-standards/README.md)** - Quality framework for all documentation
|
|
- **[Style Guide](docs/documentation-standards/style-guide.md)** - Consistent documentation formatting
|
|
- **[Review Process](docs/documentation-standards/review-process.md)** - Quality assurance procedures
|
|
- **[Contribution Guidelines](docs/documentation-standards/contribution-guidelines.md)** - How to contribute
|
|
|
|
## 🚀 Quick Start Guides
|
|
|
|
### For Different Roles:
|
|
- **[BMAD Method Quickstart](docs/quick-start-guides/bmad-method-quickstart.md)** - General overview and getting started
|
|
- **[Web Environment Quickstart](docs/quick-start-guides/web-environment-quickstart.md)** - ChatGPT/Gemini setup
|
|
- **[IDE Environment Quickstart](docs/quick-start-guides/ide-environment-quickstart.md)** - Development environment setup
|
|
|
|
### For Specific Personas:
|
|
- **[Business Analyst Quickstart](docs/analyst-quickstart.md)** - BA-specific getting started
|
|
- **[Product Manager Quickstart](docs/pm-quickstart.md)** - PM-specific getting started
|
|
- **[System Architect Quickstart](docs/architect-quickstart.md)** - Architect-specific getting started
|
|
- **[Product Owner Quickstart](docs/po-quickstart.md)** - PO-specific getting started
|
|
- **[Developer Quickstart](docs/dev-quickstart.md)** - Developer-specific getting started
|
|
- **[Design Architect Quickstart](docs/design-architect-quickstart.md)** - Design-specific getting started
|
|
- **[v0 UX/UI Architect Quickstart](docs/v0-ux-ui-architect-quickstart.md)** - UX/UI-specific getting started
|
|
|
|
## 🔧 IDE Integration & Setup
|
|
|
|
The BMAD Method supports multiple AI-powered development environments with specialized configurations:
|
|
|
|
| IDE Environment | Setup Guide | Training Material | Best For |
|
|
|----------------|-------------|-------------------|----------|
|
|
| **Cursor AI** | [Setup Guide](docs/ide-setup-guides/cursor-ai-setup.md) | [Training Guide](docs/training/ide-specific-guides/cursor-ai-guide.md) | Advanced codebase integration |
|
|
| **Cline (Claude Dev)** | [Setup Guide](docs/ide-setup-guides/cline-setup.md) | [Training Guide](docs/training/ide-specific-guides/cline-guide.md) | Project context awareness |
|
|
| **Claude Code** | [Setup Guide](docs/ide-setup-guides/claude-code-setup.md) | [Training Guide](docs/training/ide-specific-guides/claude-code-guide.md) | Code quality standards |
|
|
| **Roocode** | [Setup Guide](docs/ide-setup-guides/roocode-setup.md) | [Training Guide](docs/training/ide-specific-guides/roocode-guide.md) | Rapid prototyping |
|
|
| **VS Code** | [Setup Guide](docs/ide-setup-guides/vscode-setup.md) | - | Traditional development |
|
|
| **JetBrains** | [Setup Guide](docs/ide-setup-guides/jetbrains-setup.md) | - | Enterprise development |
|
|
|
|
### Complete IDE Documentation:
|
|
- **[IDE Setup Overview](docs/ide-setup-guides/README.md)** - Choose the right IDE for your needs
|
|
- **[IDE Setup Guide](docs/ide-setup.md)** - General IDE configuration
|
|
- **[Recommended IDE Plugins](docs/recommended-ide-plugins.md)** - Essential plugins and extensions
|
|
|
|
## 📊 Project Statistics (Version 4.0)
|
|
|
|
- **100+ Total Documents** - Comprehensive coverage of all aspects
|
|
- **500+ Total Pages** - In-depth documentation and guidance
|
|
- **50+ Diagrams & Visualizations** - Clear process flows and architectures
|
|
- **20+ Templates** - Ready-to-use templates for all personas
|
|
- **15+ Examples** - Real-world implementation examples
|
|
- **8 Complete Persona Packages** - Full documentation suites
|
|
- **6 IDE Environments Supported** - Flexible development options
|
|
|
|
## 🎯 Available Personas & Capabilities
|
|
|
|
### Core Business Personas:
|
|
- **Business Analyst (BA)** - Requirements analysis, stakeholder management, process optimization
|
|
- **Product Manager (PM)** - Product strategy, roadmap planning, feature prioritization
|
|
- **Product Owner (PO)** - Backlog management, user story creation, acceptance criteria
|
|
|
|
### Technical Personas:
|
|
- **System Architect** - Technical architecture, system design, technology decisions
|
|
- **Developer** - Code implementation, technical solutions, development best practices
|
|
- **Design Architect** - Design systems, visual architecture, design standards
|
|
|
|
### Specialized Personas:
|
|
- **v0 UX/UI Architect (Veronica/Victor)** - AI-powered design-to-code workflows
|
|
- **Scrum Master** - Agile facilitation, process improvement, team coaching
|
|
|
|
### Process Personas:
|
|
- **DevOps/Platform Engineer** - Infrastructure, deployment, operational excellence
|
|
- **Quality Assurance** - Testing strategies, quality frameworks, validation processes
|
|
|
|
## 🔄 Integration & Workflow
|
|
|
|
The BMAD Method provides seamless integration between all personas through:
|
|
|
|
- **Cross-Persona Workflows** - Standardized handoff procedures
|
|
- **Integration Architecture** - Technical integration patterns
|
|
- **Communication Protocols** - Structured information exchange
|
|
- **Quality Gates** - Consistent quality assurance across all deliverables
|
|
- **Shared Templates** - Common document formats and structures
|
|
|
|
## 📈 Success Metrics & Quality Framework
|
|
|
|
Every persona includes comprehensive success metrics and quality standards:
|
|
|
|
- **Performance Metrics** - Quantitative success measurements
|
|
- **Quality Standards** - Consistent output quality across all personas
|
|
- **Process Metrics** - Workflow efficiency and effectiveness
|
|
- **Outcome Metrics** - Business value and impact measurement
|
|
- **Continuous Improvement** - Feedback loops and optimization processes
|
|
|
|
## 🚀 What's New - Version 4.0 Major Release
|
|
|
|
### 🎉 Documentation Enhancement Project Completed:
|
|
- **Complete Persona Documentation Packages** - Every persona now has comprehensive documentation
|
|
- **Integration Architecture** - Detailed integration guides showing how all personas work together
|
|
- **Quality Framework** - Comprehensive quality standards and success metrics for all personas
|
|
- **Template Library** - Extensive collection of templates for all processes and personas
|
|
- **Training Materials** - Complete training guides for all environments and personas
|
|
|
|
### 🔧 Enhanced Capabilities:
|
|
- **Cross-Persona Workflows** - Seamless collaboration between all personas
|
|
- **Quality Assurance Framework** - Built-in quality validation and improvement processes
|
|
- **Success Metrics System** - Comprehensive measurement and optimization framework
|
|
- **Documentation Standards** - Consistent quality and formatting across all documentation
|
|
|
|
### 📚 New Documentation Categories:
|
|
- **Comprehensive Guides** - In-depth documentation for each persona
|
|
- **Integration Guides** - How personas work together in real projects
|
|
- **Template Guides** - Complete template libraries with usage instructions
|
|
- **Quality Standards** - Quality frameworks and validation procedures
|
|
- **Workflow Mapping** - Detailed process flows and decision trees
|
|
- **Success Metrics** - Measurement frameworks and optimization strategies
|
|
|
|
### 🎯 Enhanced User Experience:
|
|
- **Documentation Map** - Easy navigation through the complete documentation ecosystem
|
|
- **Role-Based Quickstarts** - Tailored getting-started guides for each persona
|
|
- **Integration Examples** - Real-world examples of cross-persona collaboration
|
|
- **Quality Checklists** - Validation tools for consistent output quality
|
|
|
|
### 📊 Project Deliverables:
|
|
- **28 New Documentation Files** - Comprehensive coverage of all personas
|
|
- **8 Complete Persona Packages** - Full documentation suites for each role
|
|
- **4 Integration Guides** - Cross-persona collaboration documentation
|
|
- **Multiple Quality Frameworks** - Standards and metrics for all processes
|
|
|
|
**Previous Versions**: [V1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) | [V2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) | [V3.1](https://github.com/bmadcode/BMAD-METHOD/tree/V3.1)
|
|
|
|
## 📋 Navigation & Getting Started
|
|
|
|
### New Users:
|
|
1. **Start Here**: [BMAD Method Quickstart](docs/quick-start-guides/bmad-method-quickstart.md)
|
|
2. **Choose Environment**: [Web](docs/quick-start-guides/web-environment-quickstart.md) or [IDE](docs/quick-start-guides/ide-environment-quickstart.md)
|
|
3. **Select Your Role**: Use the persona-specific quickstart guides above
|
|
4. **Explore Integration**: [Comprehensive Integration Guide](docs/bmad-comprehensive-integration-guide.md)
|
|
|
|
### Existing Users:
|
|
1. **What's New**: [Release Notes](docs/bmad-release-notes.md)
|
|
2. **Documentation Map**: [Complete Documentation Overview](docs/bmad-documentation-map.md)
|
|
3. **Integration Updates**: [Integration Architecture](docs/system-architecture/integration-architecture.md)
|
|
4. **Quality Standards**: [Documentation Standards](docs/documentation-standards/README.md)
|
|
|
|
### Project Teams:
|
|
1. **Project Summary**: [Complete Project Overview](docs/bmad-project-summary.md)
|
|
2. **Team Setup**: Choose appropriate persona packages for your team members
|
|
3. **Workflow Integration**: [Cross-Persona Workflows](docs/bmad-comprehensive-integration-guide.md)
|
|
4. **Quality Assurance**: Use the quality standards and success metrics for each persona
|
|
|
|
[More Documentation, Explanations, and IDE Specifics](docs/readme.md) available here!
|
|
|
|
## End Matter
|
|
|
|
Thank you and enjoy - BMad!
|
|
|
|
**[License](docs/LICENSE)** | **[Contributing Guidelines](docs/CONTRIBUTING.md)** | **[Support](https://vercel.com/help)**
|
|
|
|
Interested in improving the BMAD Method? See the [contributing guidelines](docs/CONTRIBUTING.md).
|