ros/BMAD-METHOD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
Brian Madison
2025-06-13 07:27:22 -05:00
parent 8916211ba9
commit e4d64c8f05
4 changed files with 129 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
docs/CONTRIBUTING.md → CONTRIBUTING.md
View File

0
docs/LICENSE → LICENSE
View File

133
README.md
View File

@@ -1,80 +1,107 @@
# The BMAD-Method V4 (Breakthrough Method of AgileAI Driven Development)
# BMAD-METHOD
## 🚀 Quick Start (No Installation Required!)
AI agent orchestration framework for software development. Provides specialized AI agents that function as a complete Agile development team.
### Option 1: Use Pre-built Web Bundles (Easiest)
## Overview
**No Node.js needed! Just download and use:**
BMAD-METHOD (Breakthrough Method of AgileAI Driven Development) transforms software development workflows by providing 10 specialized AI agents that handle different aspects of the development lifecycle.
1. Go to the [`/web-bundles/`](web-bundles/) folder in this repo
2. Download a bundle file:
- **Team bundles** in [`/web-bundles/teams/`](web-bundles/teams/) - Full agile teams with all roles
- **Individual agents** in [`/web-bundles/agents/`](web-bundles/agents/) - Single role agents
3. Upload to your AI platform:
## Features
- **Gemini**: Create a new Gem → Upload the bundle file → Start using!
- **ChatGPT**: Create a custom GPT → Attach as knowledge → Start using!
### Specialized Agents
Wether you use Gemini or ChatGPT, you will want to set the instructions as follows: 'Your critical operating instructions are attached, you ARE the BMad Agent, and you are orchestrating the team attached as instructed. Do not deviate from the attached operating instructions.'
- Business Analyst: Requirements gathering and project briefs
- Product Manager: Product roadmaps and PRDs
- UX Expert: User experience design and UI specifications
- Solution Architect: System design and technical architecture
- Product Owner: Story validation and backlog management
- Scrum Master: Story generation and sprint planning
- Developer: Code implementation
- QA Specialist: Testing and quality assurance
- BMAD Orchestrator: Role transformation via slash commands
- BMAD Master: Universal executor of all capabilities
Thanks it, you are now ready to go. I suggest starting with typing `/help` - and if you dont know what to do, select the option to hear about and select a workflow - and BMad will help you throughout the whole process guiding you agent to agent now!
### Team Configurations
That's it! You're ready to use BMAD agents. 🎉
- Team All: Complete agile team with all roles
- Team Fullstack: Full-stack application development focus
- Team No-UI: Backend/service development without UX roles
### Option 2: IDE Agents (Also No Installation)
### Structured Workflows
For Cursor, Windsurf, or other IDEs:
- Greenfield: New project workflows (fullstack, service, UI)
- Brownfield: Existing project workflows (fullstack, service, UI)
- Decision guidance for complex and simple project paths
1. Copy the `bmad-core/` folder to your project root
2. Use agents from `bmad-core/ide-agents/`
3. Set up slash commands (see examples in `.cursor/` or `.claude/commands/`)
## Installation
## What is BMAD?
### Option 1: Web Bundles (No Installation)
BMAD is a framework that gives you a complete Agile development team powered by AI. Each agent specializes in a specific role:
1. Download pre-built bundles from `web-bundles/`
2. Upload to ChatGPT or Gemini
3. Set instructions: "Your critical operating instructions are attached, you ARE the BMad Agent..."
4. Start with `/help` command
- **🧠 Business Analyst** - Requirements gathering and project briefs
- **📋 Product Manager** - PRDs and product planning
- **👁️ UX Expert** - User experience design and UI specifications
- **🏗️ Architect** - System design and technical architecture
- **🔄 Fullstack Architect** - Holistic full-stack system design
- **🎨 Design Architect** - UI/UX and frontend architecture
- **✅ Product Owner** - Story validation and backlog management
- **📝 Scrum Master** - Story generation and sprint planning
- **💻 Developer** - Code implementation
- **🧪 QA Engineer** - Testing and quality assurance
### Option 2: IDE Integration
The **BMAD Orchestrator** can transform into any role using slash commands!
The **BMAD Master** can do anything within the bmad-core without agent switching.
1. Copy `bmad-core/` to project root
2. Use agents from `bmad-core/agents/`
3. Configure IDE slash commands
## 🛠️ Advanced: Build Custom Bundles
### Option 3: Build Custom Bundles
Only needed if you want to customize agents:
```bash
git clone [repository]
npm install
npm run build
```
1. Clone this repository
2. Install Node.js and run `npm install`
3. Create or Modify agents in `/agents/` folder
4. Add your own custom templates, tasks, etc...
5. Run `npm run build`
6. Find your custom bundles in `/dist/` for the web agents
7. If it is for an ide, just copy them to the same folders from the bmad method that are already in your project.
Find bundles in `dist/`
### IDE Slash Commands
## Build Commands
For Cursor, Windsurf, VSCode, and Claude Code: Check the `.cursor/` or `.claude/commands/` folders for example slash command setups. These let you quickly switch between agents in your IDE!
```bash
npm run build # Build all bundles
npm run build:agents # Build agent bundles only
npm run build:teams # Build team bundles only
npm run list:agents # List available agents
npm run validate # Validate configurations
```
## 📚 Documentation
## Project Structure
Updates to docs coming soon.
```
bmad-core/
├── agents/ # Individual agent definitions
├── agent-teams/ # Team configurations
├── workflows/ # Development workflows
├── templates/ # Document templates
├── tasks/ # Reusable task definitions
├── checklists/ # Quality checklists
├── data/ # Knowledge base
└── web-bundles/ # Pre-built bundles
## Previous Versions
expansion-packs/ # Modular extensions
tools/ # Build and CLI tools
```
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
## Technical Details
---
- Language: JavaScript
- Runtime: Node.js 14.0.0+
- Configuration: YAML-based
- License: [MIT](LICENSE)
Thank you and enjoy! - BMad
## Contributing
[MIT License](docs/LICENSE)
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## Author
Brian (BMad) Madison
## Version
4.0.0
See [versions.md](docs/versions.md) for previous versions and history.

49
docs/versions.md Normal file
View File

@@ -0,0 +1,49 @@
# Version History
## Previous Versions
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
## Current Version: V4 - Alpha
Guiding Principles of V4:
- Simple to understand, install and start using
- Support Greenfield and Brownfield Scenarios
- Greater configurability and more scenarios for usage - but kept out of the main package to maintain simplicity
- Helpers for installers and web builders that will work with any OS and IDE easily
- Align all agents to be the same for IDE and Web, without losing the power of the web versions, or the leanness of the files in the IDE to reduce context
- Further improvements to the two most important agents - the SM and DEV
- Expansion Packs - Coming soon...
## V3
With the customizability of V2, there were still some issues. A PM could only easily do one thing, create a PRD. And maintaining the consistency between Web and IDE agents was a pain.
V3 didn't fix the disconnect, but it did make it easier to maintain them all in a single folder, but there were only two official ide agents - all the rest were really made and optimized for the web.
V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMAD AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.
But V3 had a major flaw - with massive configuration comes massive complexity - and in some ways, V3 started to get away from core principles - power through simplicity. The core system needs to do one thing well and be solid, and not stretch too thing with every possible thing.
Also - while the dev is amazing and better in V3 than all the past, along with the SM - the dev started over documenting every step and really started to bloat stories with their own notes. And the SM was forgetting to add details to stories, or embellishing information. This was fixed somewhat in V3.1 - but the dev is still over explaining everything it does, instead of just capturing the changes to the story.
## V2
After V1 proved that the BMad method was solid and repeatable, 2 key ideas emerged. Separation of concerns, and building for the web made easier. By separating out templates - it was now much easier for the PRD fields to be customized, or the architecture.
And the introduction that really supercharged everything in my opinion, the web versions! There were 4 hard coded web variants hand crafted - and we saw that we could, dirt cheap, work with agents for hours in the massive context of Gemini - from a PRD generating PM, through to an architect and even an analyst that could help us do extensive market research and brain storming.
What I never expected is the names would stick, and people would keep the sample names I made that I thought people would configure. But now 4 version is, people refer to Mary, and John, and Bob! And when I randomly changed the names, I got A LOT of feedback! These have become trusted allies people are relying on, including for me!
## V1
Believe it or not (well you can view the link), V1 was a simple 7 file system! 7 Core agents working in harmony to help build a pretty specific type of application. But it showed its power and adaptability.
Meant to be a simple Tech Demo showing how custom agents with agile personas can help streamline your project, and create rails for your dev agents that to that point had gone unmatched - while also putting a focus on the planning phases - the project sparked the imagination of many, and a seed of a potential was realized.