111 lines
4.3 KiB
Markdown
111 lines
4.3 KiB
Markdown
# Welcome to BMad Method Documentation
|
|
|
|
**The AI-assisted coding methodology for building things right that last.**
|
|
|
|
BMad Method transforms how developers work with AI coding assistants, providing structure, quality standards, and proven workflows that help you build better software faster.
|
|
|
|
## Quick Start
|
|
|
|
New to BMad Method? Get up and running in under 10 minutes:
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :fontawesome-solid-rocket:{ .lg .middle } **Get Started**
|
|
|
|
---
|
|
|
|
Install BMad Method and validate your setup with our guided installation process.
|
|
|
|
[:octicons-arrow-right-24: Installation Guide](getting-started/installation.md)
|
|
|
|
- :fontawesome-solid-terminal:{ .lg .middle } **Learn Commands**
|
|
|
|
---
|
|
|
|
Discover the powerful command system that makes BMad Method so effective.
|
|
|
|
[:octicons-arrow-right-24: Command Reference](commands/quick-reference.md)
|
|
|
|
- :fontawesome-solid-play:{ .lg .middle } **Build Something**
|
|
|
|
---
|
|
|
|
Follow a complete example to build your first project with BMad Method.
|
|
|
|
[:octicons-arrow-right-24: First Project](getting-started/first-project.md)
|
|
|
|
- :fontawesome-solid-book:{ .lg .middle } **Master Workflows**
|
|
|
|
---
|
|
|
|
Learn proven workflows for different development scenarios and project types.
|
|
|
|
[:octicons-arrow-right-24: Workflows](getting-started/first-project.md)
|
|
|
|
</div>
|
|
|
|
## What is BMad Method?
|
|
|
|
BMad Method is a comprehensive methodology for AI-assisted software development that provides:
|
|
|
|
- **🎯 Structured Approach** - Clear personas, tasks, and workflows for every development phase
|
|
- **⚡ Quality First** - Built-in quality gates and standards that prevent technical debt
|
|
- **🧠 Memory System** - Learn from your patterns and continuously improve your development process
|
|
- **🤝 Collaboration** - Brotherhood review system ensures code quality and knowledge sharing
|
|
- **📚 Comprehensive Toolkit** - Everything from project setup to deployment and maintenance
|
|
|
|
## Why BMad Method?
|
|
|
|
Traditional AI coding assistants can be powerful, but without structure they often lead to:
|
|
|
|
- ❌ Inconsistent code quality
|
|
- ❌ Technical debt accumulation
|
|
- ❌ Unclear development processes
|
|
- ❌ Difficulty scaling projects
|
|
- ❌ Poor collaboration patterns
|
|
|
|
**BMad Method solves these problems** by providing:
|
|
|
|
- ✅ **Quality Standards** - Zero-tolerance for anti-patterns and technical debt
|
|
- ✅ **Clear Processes** - Step-by-step workflows for every development scenario
|
|
- ✅ **Smart Automation** - Automated quality checks and validation throughout
|
|
- ✅ **Continuous Learning** - Memory system that improves with every project
|
|
- ✅ **Proven Patterns** - Battle-tested approaches from successful projects
|
|
|
|
## Core Principles
|
|
|
|
The BMad Method is built on five core principles:
|
|
|
|
### 1. Ultra-Deep Thinking Mode (UDTM)
|
|
Systematic analysis and validation of every significant decision, ensuring thorough consideration of alternatives and implications.
|
|
|
|
### 2. Quality Gates
|
|
Mandatory checkpoints that prevent low-quality code and architectural decisions from entering your codebase.
|
|
|
|
### 3. Brotherhood Reviews
|
|
Collaborative review process that combines human insight with AI capabilities for optimal code quality.
|
|
|
|
### 4. Memory-Enhanced Development
|
|
Learn from every project, decision, and outcome to continuously improve your development process.
|
|
|
|
### 5. Evidence-Based Decisions
|
|
All architectural and design decisions must be supported by data, testing, or proven patterns.
|
|
|
|
## What You'll Learn
|
|
|
|
Through this documentation, you'll master:
|
|
|
|
- **[Getting Started](getting-started/index.md)** - Installation, setup, and your first successful project
|
|
- **[Commands](commands/quick-reference.md)** - The command system that powers BMad Method workflows
|
|
- **[Workflows](getting-started/first-project.md)** - Proven processes for MVPs, features, and maintenance
|
|
- **[Reference](reference/personas.md)** - Complete reference for personas, tasks, and systems
|
|
|
|
## Community & Support
|
|
|
|
- **GitHub Repository**: [DMAD-METHOD](https://github.com/danielbentes/DMAD-METHOD)
|
|
- **Issues & Questions**: Use GitHub Issues for bugs and feature requests
|
|
- **Discussions**: Join the GitHub Discussions for community help
|
|
|
|
---
|
|
|
|
**Ready to get started?** Follow our [Installation Guide](getting-started/installation.md) and be productive with BMad Method in under 10 minutes. |