feat: Massive documentation refactor, added explanation of the new expanded role of the QA agent that will make your code quality MUCH better. 2 new diagram clearly explain the role of the pre dev ideation cycle (prd and architecture) and the details of how the dev cycle works.
This commit is contained in:
Brian Madison
7
.vscode/settings.json
vendored
Normal file
7
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"cSpell.words": [
|
||||
"Agentic",
|
||||
"elicitations",
|
||||
"Shardable"
|
||||
]
|
||||
}
|
||||
@@ -4,7 +4,7 @@ Thank you for considering contributing to this project! This document outlines t
|
||||
|
||||
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
||||
|
||||
📋 **Before contributing**, please read our [Guiding Principles](GUIDING-PRINCIPLES.md) to understand the BMAD Method's core philosophy and architectural decisions.
|
||||
📋 **Before contributing**, please read our [Guiding Principles](GUIDING-PRINCIPLES.md) to understand the BMad Method's core philosophy and architectural decisions.
|
||||
|
||||
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD Method Guiding Principles
|
||||
# BMad Method Guiding Principles
|
||||
|
||||
The BMAD Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
|
||||
The BMad Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
|
||||
|
||||
## Core Principles
|
||||
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Brian AKA BMad AKA Bmad Code
|
||||
Copyright (c) 2025 Brian AKA BMad AKA BMad Code
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
476
README.md
476
README.md
@@ -1,53 +1,73 @@
|
||||
# BMAD-METHOD
|
||||
# BMad-METHOD: Universal AI Agent Framework
|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**Universal AI Agent Framework** - Transform any domain with specialized AI expertise. From software development to creative writing, business strategy to personal wellness.
|
||||
Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, but it is so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
|
||||
|
||||
📺 **[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
||||
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
||||
|
||||
💬 **[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMAD, building your own agents, or just want to chat about the latest in AI - we're here for you!
|
||||
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you!
|
||||
|
||||
⭐ **If you find this project helpful or useful, please give it a star!** It helps others discover BMAD-METHOD and you will be notified of updates!
|
||||
⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-METHOD and you will be notified of updates!
|
||||
|
||||
## 🧭 Quick Navigation - Find Your Path
|
||||
|
||||
### I want to...
|
||||
### 🚨 MUST READ: Understanding the BMAD Workflow
|
||||
|
||||
- **🚀 [Build software with AI agents](#-quick-start)** → Start here for development teams
|
||||
- **🎨 [Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
||||
- **🛠️ [Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
||||
- **📦 [Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure
|
||||
- **💡 [See expansion pack ideas](docs/expansion-pack-ideas.md)** → Get inspired
|
||||
- **🏗️ [Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
||||
**Before diving in, review these critical workflow diagrams that explain how BMAD works:**
|
||||
|
||||
### Popular Use Cases:
|
||||
1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
||||
2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
|
||||
|
||||
> ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
|
||||
|
||||
### What would you like to do?
|
||||
|
||||
- **[Build software with Full Stack Agile AI Team](#-quick-start)** → Quick Start Instruction
|
||||
- **[Learn how to use BMAD](docs/user-guide.md)** → Complete user guide and walkthrough
|
||||
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
||||
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
||||
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
||||
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
|
||||
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
||||
- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
|
||||
|
||||
### Popular Use Cases
|
||||
|
||||
- **Software Development** - [Quick Start](#-quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
|
||||
- **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
|
||||
- **Business Strategy** - [Ideas](docs/expansion-pack-ideas.md#business-strategy-pack) | [Full Guide](docs/expansion-packs.md#business-strategy-pack)
|
||||
- **Creative Writing** - [Ideas](docs/expansion-pack-ideas.md#creative-writing-pack) | [Full Guide](docs/expansion-packs.md#creative-writing-pack)
|
||||
- **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
|
||||
- **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
|
||||
- **DevOps/Infrastructure** - [Infrastructure Pack](expansion-packs/bmad-infrastructure-devops/)
|
||||
|
||||
## 🔄 Important: Keeping Your BMAD Installation Updated
|
||||
### Quick Links
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD installed in your project, simply run:
|
||||
- **[Installation](#installation)** → Get started in minutes
|
||||
- **[Documentation](#documentation--guides)** → All guides and references
|
||||
- **[Contributing](#contributing)** → Help improve BMAD
|
||||
- **[Support](#support)** → Get help and connect
|
||||
|
||||
## 🔄 Important: Keeping Your BMad Installation Updated
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMad-METHOD installed in your project, simply run:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
The installer will:
|
||||
This will:
|
||||
|
||||
- ✅ Automatically detect your existing v4 installation
|
||||
- ✅ Update only the files that have changed
|
||||
- ✅ Update only the files that have changed and add new files
|
||||
- ✅ Create `.bak` backup files for any custom modifications you've made
|
||||
- ✅ Preserve your project-specific configurations
|
||||
|
||||
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
||||
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! If for some reason this fails, you can rename or remove your .bmad-code folder and run the install again. The main thing to look out for is if you have set up custom modes that are not file driven (Cursor is the only one at this time that is not done through project files lagging behind) - you will want to ensure your sm and dev custom modes especially are kept up to date.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
@@ -75,27 +95,11 @@ npm run install:bmad # build and install all to a destination folder
|
||||
|
||||
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
|
||||
|
||||
## 📋 Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Installation](#installation)
|
||||
- [Available Agents](#available-agents)
|
||||
- [Usage](#usage)
|
||||
- [Project Structure](#project-structure)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.
|
||||
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
|
||||
|
||||
### Why BMAD?
|
||||
|
||||
- **🎯 Specialized Expertise**: Each agent is an expert in their specific role
|
||||
- **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
|
||||
- **📦 Modular Design**: Use one agent or an entire team
|
||||
- **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, Windsurf, and Gemini
|
||||
- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
|
||||
- **🌍 Universal Framework**: Not just for coding - structure any expertise into AI-accessible formats
|
||||
Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile flow does so much more. With most systems, you give your idea in a few sentences at most, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM techniques and techniques also based in psychology to produce beyond the average slop LLMs and Task generators will on their own. This truly is a system of Human in the Loop produces markedly better results.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -133,22 +137,133 @@ The BMad Method works with any IDE, but has built-in integration for:
|
||||
### Core Development Team
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ----------- | ------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `analyst` | Business Analyst | market analysis, brainstorming, project brief |
|
||||
| `pm` | Product Manager | Product strategy, roadmaps, PRDs |
|
||||
| `architect` | Solution Architect | System design, technical architecture |
|
||||
| `dev` | Developer | Code implementation across all technologies |
|
||||
| `qa` | QA Specialist | Testing strategies, quality assurance, Refactor Post Story Creation before next story |
|
||||
| `ux-expert` | UX Designer | User experience, UI design, prototypes |
|
||||
| `po` | Product Owner | Backlog management, story validation |
|
||||
| `sm` | Scrum Master | Sprint planning, story creation |
|
||||
| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
|
||||
| `analyst` | Business Analyst | market analysis, brainstorming, project brief creation |
|
||||
| `pm` | Product Manager | Product strategy, MVP Decisioning, PRD creation with Epics |
|
||||
| `architect` | Solution Architect | System design, technical full stack, front end or backend architecture |
|
||||
| `ux-expert` | UX Designer | User experience, UI design, prompts for V0, Lovable, and others |
|
||||
| `po` | Product Owner | Ensure PRD and Architecture are aligned, and changes from architecture end up in PRD stories |
|
||||
| `sm` | Scrum Master | High level epics and stories transformed into detailed dev stories with tasks and subtasks |
|
||||
| `dev` | Developer | Code implementation across all technologies - follows the detailed SM created story |
|
||||
| `qa` | QA Specialist | Detailed review of the devs ready for review story, refactor and propose issues and changes |
|
||||
|
||||
### Meta Agents
|
||||
### BMad Agents
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ------------------- | ---------------- | ------------------------------------------------------------------- |
|
||||
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching, is part of every team bundle |
|
||||
| `bmad-master` | Universal Expert | All capabilities without switching |
|
||||
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `bmad-orchestrator` | Team Coordinator | Helps guide you and answers your questions with its massive knowledge base, and guides you through Multi-agent workflows |
|
||||
| `bmad-master` | Universal Expert | All capabilities without switching (Except Dev) |
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Dynamic Dependencies
|
||||
|
||||
Each agent only loads the resources it needs, keeping context windows lean.
|
||||
|
||||
### Template System
|
||||
|
||||
Rich templates for all document types:
|
||||
|
||||
- Product Requirements (PRD)
|
||||
- Architecture Documents
|
||||
- User Stories
|
||||
- Test Plans
|
||||
- And more...
|
||||
|
||||
Templates are unique in that they are embedded with the LLM instructions also for further working with you to prompt and elicit the best from you and your agile agent team member - allowing for unique coaching and customization options. While there is a single create-doc task, the possibilities are endless when you expand the templates into more doc types, or customize with your own docs embedded with the templating markup and LLM instruction framework that is core to the BMad Method.
|
||||
|
||||
### Slash Star Commands
|
||||
|
||||
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
||||
|
||||
### Advanced Elicitation
|
||||
|
||||
Many of the Agents and Templates for docs, and some tasks, include Advanced Elicitation directives based on the latest in LLM interactions and pro level prompt engineering guidance. With this, you can push the Agents further than ever before. If an agent proposes an idea, or an architecture - you can push it further with optional elicitations where it will have to really expand on, defend, or produce other options and prove its suggestion was better. This is a necessary step if you want the absolute best beyond accepting the generated average responses the LLMs think you want to hear for their first response. Some of this is interactive, and some of this is baked into the core prompting engine that powers the LLM progression through various tasks and template flows.
|
||||
|
||||
## Usage
|
||||
|
||||
The BMAD Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
|
||||
|
||||
### Quick Start Examples
|
||||
|
||||
#### With IDE Integration
|
||||
|
||||
```bash
|
||||
# In Cursor
|
||||
@pm Create a PRD for a task management app
|
||||
|
||||
# In Claude Code
|
||||
/architect Design a microservices architecture
|
||||
|
||||
# In Windsurf
|
||||
@dev Implement story 1.3
|
||||
```
|
||||
|
||||
#### With Web UI
|
||||
|
||||
After uploading a bundle, type `/help` to see available commands.
|
||||
|
||||
### Key Resources
|
||||
|
||||
- **[Complete User Guide](docs/user-guide.md)** - Full walkthrough from project inception to completion
|
||||
- **[CLI Commands](docs/user-guide.md#cli-commands)** - Installation, updates, and management
|
||||
- **[Upgrading from V3](docs/user-guide.md#upgrading-from-v3-to-v4)** - Migration instructions
|
||||
- **[Core Configuration](docs/user-guide.md#core-configuration-coreconfigyml)** - V4's flexible project structure support
|
||||
- **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
|
||||
|
||||
## Project Structure
|
||||
|
||||
See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
|
||||
|
||||
### Key Directories
|
||||
|
||||
- **`.bmad-core/`** - Heart of the framework (agents, templates, workflows)
|
||||
- **`dist/`** - Pre-built bundles ready for web UI use
|
||||
- **`expansion-packs/`** - Domain-specific extensions
|
||||
- **`tools/`** - Build and installation utilities
|
||||
- **`docs/`** - Your project documentation (PRD, architecture, stories)
|
||||
|
||||
### 📦 Pre-Built Bundles (dist/ folder)
|
||||
|
||||
**All ready-to-use bundles are in the `dist/` directory!**
|
||||
|
||||
- **Teams**: `dist/teams/` - Complete team configurations
|
||||
|
||||
- `team-fullstack.txt` - Full-stack development team
|
||||
- `team-ide-minimal.txt` - Minimal IDE workflow team
|
||||
- `team-no-ui.txt` - Backend-only team
|
||||
- `team-all.txt` - All agents included
|
||||
|
||||
- **Individual Agents**: `dist/agents/` - Single agent files
|
||||
|
||||
- One `.txt` file per agent (analyst, architect, dev, etc.)
|
||||
|
||||
- **Expansion Packs**: `dist/expansion-packs/` - Specialized domains
|
||||
- Game development, DevOps, etc.
|
||||
|
||||
**For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
|
||||
|
||||
## Documentation & Guides
|
||||
|
||||
### Architecture & Technical
|
||||
|
||||
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
||||
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
|
||||
|
||||
### Workflow Guides
|
||||
|
||||
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
||||
|
||||
### IDE-Specific Guides
|
||||
|
||||
- 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor
|
||||
- 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code
|
||||
- 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf
|
||||
- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
|
||||
- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
|
||||
- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
|
||||
|
||||
## 🌟 Beyond Software Development - Expansion Packs
|
||||
|
||||
@@ -184,231 +299,6 @@ Transform your expertise into AI agents:
|
||||
|
||||
📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
|
||||
|
||||
🛠️ **[Use the Expansion Pack Creator](expansion-packs/bmad-creator-tools/)** - Automated tools to build your own pack
|
||||
|
||||
💡 **[Browse Expansion Pack Ideas](docs/expansion-pack-ideas.md)** - Get inspired by possibilities
|
||||
|
||||
## Usage
|
||||
|
||||
### With IDE Integration
|
||||
|
||||
After installation with `--ide` flag:
|
||||
|
||||
```bash
|
||||
# In Cursor
|
||||
@pm Create a PRD for a task management app
|
||||
|
||||
# In Claude Code
|
||||
/architect Design a microservices architecture
|
||||
|
||||
# In Windsurf
|
||||
@dev Implement story 1.3
|
||||
```
|
||||
|
||||
### With Web UI (ChatGPT/Claude/Gemini)
|
||||
|
||||
After uploading a bundle you can ask /help of the agent to learn what it can do
|
||||
|
||||
### CLI Commands
|
||||
|
||||
```bash
|
||||
# List all available agents
|
||||
npx bmad-method list
|
||||
|
||||
# Install or update (automatically detects existing installations)
|
||||
npx bmad-method install
|
||||
|
||||
# Check installation status
|
||||
npx bmad-method status
|
||||
```
|
||||
|
||||
### Upgrading from V3 to V4
|
||||
|
||||
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# The installer will automatically detect your V3 installation and offer to upgrade
|
||||
```
|
||||
|
||||
The upgrade process will:
|
||||
|
||||
1. Create a backup of your V3 files in `.bmad-v3-backup/`
|
||||
2. Install the new V4 `.bmad-core/` structure
|
||||
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
||||
4. Set up IDE integration for all V4 agents
|
||||
5. Create an install manifest for future updates
|
||||
|
||||
After upgrading:
|
||||
|
||||
1. Review your documents in the `docs/` folder - if you had a PRD or architecture in your old project, copy it from the backup to the docs folder if they are not there.
|
||||
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent my saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}
|
||||
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
|
||||
|
||||
The reason #2 and 3 are optional is because now BMad V4 makes sharding optional for the SM. See [Core Configuration](#-core-configuration-new-in-v4)
|
||||
|
||||
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
|
||||
|
||||
### 🔧 Core Configuration (NEW in V4)
|
||||
|
||||
**Critical**: V4 introduces `bmad-core/core-config.yml` - a powerful configuration file that enables BMAD to work seamlessly with any project structure, whether it's V4-optimized or legacy. You can even now use non-standard PRDs and architectures!
|
||||
|
||||
#### What is core-config.yml?
|
||||
|
||||
This configuration file tells BMAD agents exactly where to find your project documents and how they're structured. It's the key to V4's flexibility and backwards compatibility.
|
||||
|
||||
#### Key Features
|
||||
|
||||
- **Version Awareness**: Agents understand if your PRD/Architecture follows V4 conventions or earlier versions
|
||||
- **Flexible Document Locations**: Works whether your epics are embedded in PRD or properly sharded
|
||||
- **Developer Context**: Define which files the dev agent should always load
|
||||
- **Debug Support**: Built-in logging for troubleshooting story implementation
|
||||
|
||||
#### Why It Matters
|
||||
|
||||
- **Use BMAD with ANY project structure** - V3, V4, or custom layouts
|
||||
- **No forced migrations** - Keep your existing document organization
|
||||
- **Customize developer workflow** - Specify exactly which files provide context
|
||||
- **Seamless upgrades** - Start with V3 docs and gradually adopt V4 patterns
|
||||
|
||||
See the [detailed core-config.yml guide](docs/user-guide.md#core-configuration-coreconfigyml) for configuration examples and best practices.
|
||||
|
||||
## Teams & Workflows
|
||||
|
||||
### Pre-Configured Teams
|
||||
|
||||
Save context by using specialized teams:
|
||||
|
||||
- **Team All**: Complete Agile team with all 10 agents
|
||||
- **Team Fullstack**: Frontend + Backend development focus
|
||||
- **Team No-UI**: Backend/API development without UX
|
||||
|
||||
### Workflows
|
||||
|
||||
Structured approaches for different scenarios:
|
||||
|
||||
- **Greenfield**: Starting new projects (fullstack/service/UI)
|
||||
- **Brownfield**: Enhancing existing projects
|
||||
- **Simple**: Quick prototypes and MVPs
|
||||
- **Complex**: Enterprise and large-scale projects
|
||||
|
||||
## Project Structure
|
||||
|
||||
```plaintext
|
||||
.bmad-core/
|
||||
├── agents/ # Individual agent definitions
|
||||
├── agent-teams/ # Team configurations
|
||||
├── workflows/ # Development workflows
|
||||
├── templates/ # Document templates (PRD, Architecture, etc.)
|
||||
├── tasks/ # Reusable task definitions
|
||||
├── checklists/ # Quality checklists
|
||||
├── data/ # Knowledge base
|
||||
└── web-bundles/ # Optional can be added if you use the install command and select this folder as a destination for the build bundle files
|
||||
|
||||
tools/
|
||||
├── cli.js # Build tool
|
||||
├── installer/ # NPX installer
|
||||
└── lib/ # Build utilities
|
||||
|
||||
expansion-packs/ # Domain-specific add-ons (Technical & Non-Technical)
|
||||
|
||||
dist/ # 📦 PRE-BUILT BUNDLES (Ready to use!)
|
||||
├── agents/ # Individual agent bundles (.txt files)
|
||||
├── teams/ # Team bundles (.txt files)
|
||||
└── expansion-packs/ # Expansion pack bundles
|
||||
```
|
||||
|
||||
### 📦 Pre-Built Bundles (dist/ folder)
|
||||
|
||||
**All ready-to-use bundles are in the `dist/` directory!**
|
||||
|
||||
- **Teams**: `dist/teams/` - Complete team configurations
|
||||
|
||||
- `team-fullstack.txt` - Full-stack development team
|
||||
- `team-ide-minimal.txt` - Minimal IDE workflow team
|
||||
- `team-no-ui.txt` - Backend-only team
|
||||
- `team-all.txt` - All agents included
|
||||
|
||||
- **Individual Agents**: `dist/agents/` - Single agent files
|
||||
|
||||
- One `.txt` file per agent (analyst, architect, dev, etc.)
|
||||
|
||||
- **Expansion Packs**: `dist/expansion-packs/` - Specialized domains
|
||||
- Game development, DevOps, etc.
|
||||
|
||||
**For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Dynamic Dependencies
|
||||
|
||||
Each agent only loads the resources it needs, keeping context windows lean.
|
||||
|
||||
### Template System
|
||||
|
||||
Rich templates for all document types:
|
||||
|
||||
- Product Requirements (PRD)
|
||||
- Architecture Documents
|
||||
- User Stories
|
||||
- Test Plans
|
||||
- And more...
|
||||
|
||||
### Slash Star Commands
|
||||
|
||||
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
||||
|
||||
## Contributing
|
||||
|
||||
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
||||
|
||||
### Before Contributing - MUST READ
|
||||
|
||||
To ensure your contribution aligns with the BMAD Method and gets merged smoothly:
|
||||
|
||||
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMAD powerful through simplicity
|
||||
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
|
||||
### Key Points to Remember
|
||||
|
||||
- Keep dev agents lean (save context for coding!)
|
||||
- Use small, focused files over large branching ones
|
||||
- Reuse existing tasks (like `create-doc`) instead of creating duplicates
|
||||
- Consider expansion packs for domain-specific features
|
||||
- All contributions must follow our natural language, markdown-based approach
|
||||
|
||||
We're building something amazing together - let's keep it simple, powerful, and focused! 💪
|
||||
|
||||
### Development Setup
|
||||
|
||||
Want to help improve the BMad Method. Fork n' Clone the repo
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
cd bmad-method
|
||||
|
||||
npm run build # rebuild the dist folder
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
|
||||
## Documentation & Guides
|
||||
|
||||
### Architecture & Technical
|
||||
|
||||
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
||||
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
|
||||
|
||||
### Workflow Guides
|
||||
|
||||
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
||||
- 🎯 [Cursor Guide](docs/cursor-guide.md) - Complete workflow for Cursor users
|
||||
- 🤖 [Claude Code Guide](docs/claude-code-guide.md) - Complete workflow for Claude Code users
|
||||
- 🌊 [Windsurf Guide](docs/windsurf-guide.md) - Complete workflow for Windsurf users
|
||||
- 🦘 [Roo Code Guide](docs/roo-code-guide.md) - Complete workflow for Roo Code users
|
||||
|
||||
## Support
|
||||
|
||||
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
||||
@@ -434,7 +324,39 @@ See [versions.md](docs/versions.md) for detailed version history and migration g
|
||||
|
||||
Created by Brian (BMad) Madison
|
||||
|
||||
---
|
||||
## Contributing
|
||||
|
||||
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
||||
|
||||
### Before Contributing - MUST READ
|
||||
|
||||
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
||||
|
||||
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMAD powerful through simplicity
|
||||
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
|
||||
### Key Points to Remember
|
||||
|
||||
- Keep dev agents lean (save context for coding!)
|
||||
- Use small, focused files over large branching ones
|
||||
- Reuse existing tasks (like `create-doc`) instead of creating duplicates
|
||||
- Consider expansion packs for domain-specific features and not improvements to the core system (those belong in the core system)
|
||||
- All contributions must follow our natural language, markdown-based templating approach with template embedded LLM instructions and elicitations
|
||||
|
||||
We're building something amazing together - let's keep it simple, powerful, and focused! 💪
|
||||
|
||||
### Development Setup
|
||||
|
||||
Want to help improve the BMad Method. Fork n' Clone the repo
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
cd bmad-method
|
||||
|
||||
npm run build # rebuild the dist folder
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
|
||||
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ task-execution:
|
||||
updates-ONLY:
|
||||
- "Checkboxes: [ ] not started | [-] in progress | [x] complete"
|
||||
- "Debug Log: | Task | File | Change | Reverted? |"
|
||||
- "Completion Notes: Deviations only, <50 words"
|
||||
- "Completion Notes: Deviations from AC or tasks during execution only, <50 words"
|
||||
- "Change Log: Requirement changes only"
|
||||
- "File List: CRITICAL - Maintain complete list of ALL files created/modified during implementation"
|
||||
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config | Failing validations"
|
||||
|
||||
@@ -719,7 +719,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
|
||||
2
dist/agents/analyst.txt
vendored
2
dist/agents/analyst.txt
vendored
@@ -2654,7 +2654,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
|
||||
2
dist/agents/bmad-master.txt
vendored
2
dist/agents/bmad-master.txt
vendored
@@ -9040,7 +9040,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
|
||||
2
dist/agents/bmad-orchestrator.txt
vendored
2
dist/agents/bmad-orchestrator.txt
vendored
@@ -1130,7 +1130,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
|
||||
78
dist/teams/team-all.txt
vendored
78
dist/teams/team-all.txt
vendored
@@ -1622,7 +1622,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
@@ -9742,21 +9742,21 @@ workflow:
|
||||
notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_project_analysis
|
||||
notes: "Creates comprehensive brownfield PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates brownfield architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for integration safety and completeness. May require updates to any document."
|
||||
notes: "Validates all documents for integration safety and completeness. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -9806,8 +9806,8 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[architect: architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
@@ -9828,11 +9828,11 @@ workflow:
|
||||
- Multiple team members will work on related changes
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "Existing project analysis complete. Create comprehensive brownfield PRD with integration strategy."
|
||||
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the integration architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for integration safety."
|
||||
analyst_to_pm: "Existing project analysis complete. Create comprehensive PRD with integration strategy."
|
||||
pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the integration architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-fullstack ====================
|
||||
|
||||
==================== START: workflows#brownfield-service ====================
|
||||
@@ -9858,21 +9858,21 @@ workflow:
|
||||
notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_service_analysis
|
||||
notes: "Creates comprehensive brownfield PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates brownfield architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for service integration safety and API compatibility. May require updates to any document."
|
||||
notes: "Validates all documents for service integration safety and API compatibility. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -9922,8 +9922,8 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Service Enhancement] --> B[analyst: analyze existing service]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[architect: architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
@@ -9944,11 +9944,11 @@ workflow:
|
||||
- Multiple integration points affected
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive brownfield PRD with service integration strategy."
|
||||
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for service integration safety."
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive PRD with service integration strategy."
|
||||
pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for service integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-service ====================
|
||||
|
||||
==================== START: workflows#brownfield-ui ====================
|
||||
@@ -9973,29 +9973,29 @@ workflow:
|
||||
notes: "Review existing frontend application, user feedback, analytics data, and identify improvement areas."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_ui_analysis
|
||||
notes: "Creates comprehensive brownfield PRD focused on UI enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD focused on UI enhancement with existing system analysis. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: ux-expert
|
||||
creates: front-end-spec.md
|
||||
uses: front-end-spec-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates UI/UX specification for brownfield enhancement that integrates with existing design patterns. SAVE OUTPUT: Copy final front-end-spec.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates UI/UX specification that integrates with existing design patterns. SAVE OUTPUT: Copy final front-end-spec.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires:
|
||||
- brownfield-prd.md
|
||||
- prd.md
|
||||
- front-end-spec.md
|
||||
notes: "Creates brownfield frontend architecture with component integration strategy and migration planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
notes: "Creates frontend architecture with component integration strategy and migration planning. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for UI integration safety and design consistency. May require updates to any document."
|
||||
notes: "Validates all documents for UI integration safety and design consistency. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -10045,9 +10045,9 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: UI Enhancement] --> B[analyst: analyze existing UI]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[ux-expert: front-end-spec.md]
|
||||
D --> E[architect: brownfield-architecture.md]
|
||||
D --> E[architect: architecture.md]
|
||||
E --> F[po: validate with po-master-checklist]
|
||||
F --> G{PO finds issues?}
|
||||
G -->|Yes| H[Return to relevant agent for fixes]
|
||||
@@ -10069,12 +10069,12 @@ workflow:
|
||||
- Multiple team members will work on related changes
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "UI analysis complete. Create comprehensive brownfield PRD with UI integration strategy."
|
||||
pm_to_ux: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the UI/UX specification."
|
||||
analyst_to_pm: "UI analysis complete. Create comprehensive PRD with UI integration strategy."
|
||||
pm_to_ux: "PRD ready. Save it as docs/prd.md, then create the UI/UX specification."
|
||||
ux_to_architect: "UI/UX spec complete. Save it as docs/front-end-spec.md, then create the frontend architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for UI integration safety."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for UI integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-ui ====================
|
||||
|
||||
==================== START: workflows#greenfield-fullstack ====================
|
||||
|
||||
78
dist/teams/team-fullstack.txt
vendored
78
dist/teams/team-fullstack.txt
vendored
@@ -1466,7 +1466,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
@@ -8930,21 +8930,21 @@ workflow:
|
||||
notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_project_analysis
|
||||
notes: "Creates comprehensive brownfield PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD with existing system analysis and enhancement planning. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates brownfield architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates architecture with integration strategy and existing system constraints. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for integration safety and completeness. May require updates to any document."
|
||||
notes: "Validates all documents for integration safety and completeness. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -8994,8 +8994,8 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[architect: architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
@@ -9016,11 +9016,11 @@ workflow:
|
||||
- Multiple team members will work on related changes
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "Existing project analysis complete. Create comprehensive brownfield PRD with integration strategy."
|
||||
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the integration architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for integration safety."
|
||||
analyst_to_pm: "Existing project analysis complete. Create comprehensive PRD with integration strategy."
|
||||
pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the integration architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-fullstack ====================
|
||||
|
||||
==================== START: workflows#brownfield-service ====================
|
||||
@@ -9046,21 +9046,21 @@ workflow:
|
||||
notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_service_analysis
|
||||
notes: "Creates comprehensive brownfield PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates brownfield architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for service integration safety and API compatibility. May require updates to any document."
|
||||
notes: "Validates all documents for service integration safety and API compatibility. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -9110,8 +9110,8 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Service Enhancement] --> B[analyst: analyze existing service]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[architect: architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
@@ -9132,11 +9132,11 @@ workflow:
|
||||
- Multiple integration points affected
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive brownfield PRD with service integration strategy."
|
||||
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for service integration safety."
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive PRD with service integration strategy."
|
||||
pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for service integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-service ====================
|
||||
|
||||
==================== START: workflows#brownfield-ui ====================
|
||||
@@ -9161,29 +9161,29 @@ workflow:
|
||||
notes: "Review existing frontend application, user feedback, analytics data, and identify improvement areas."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_ui_analysis
|
||||
notes: "Creates comprehensive brownfield PRD focused on UI enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD focused on UI enhancement with existing system analysis. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: ux-expert
|
||||
creates: front-end-spec.md
|
||||
uses: front-end-spec-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates UI/UX specification for brownfield enhancement that integrates with existing design patterns. SAVE OUTPUT: Copy final front-end-spec.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates UI/UX specification that integrates with existing design patterns. SAVE OUTPUT: Copy final front-end-spec.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires:
|
||||
- brownfield-prd.md
|
||||
- prd.md
|
||||
- front-end-spec.md
|
||||
notes: "Creates brownfield frontend architecture with component integration strategy and migration planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
notes: "Creates frontend architecture with component integration strategy and migration planning. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for UI integration safety and design consistency. May require updates to any document."
|
||||
notes: "Validates all documents for UI integration safety and design consistency. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -9233,9 +9233,9 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: UI Enhancement] --> B[analyst: analyze existing UI]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[ux-expert: front-end-spec.md]
|
||||
D --> E[architect: brownfield-architecture.md]
|
||||
D --> E[architect: architecture.md]
|
||||
E --> F[po: validate with po-master-checklist]
|
||||
F --> G{PO finds issues?}
|
||||
G -->|Yes| H[Return to relevant agent for fixes]
|
||||
@@ -9257,12 +9257,12 @@ workflow:
|
||||
- Multiple team members will work on related changes
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "UI analysis complete. Create comprehensive brownfield PRD with UI integration strategy."
|
||||
pm_to_ux: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the UI/UX specification."
|
||||
analyst_to_pm: "UI analysis complete. Create comprehensive PRD with UI integration strategy."
|
||||
pm_to_ux: "PRD ready. Save it as docs/prd.md, then create the UI/UX specification."
|
||||
ux_to_architect: "UI/UX spec complete. Save it as docs/front-end-spec.md, then create the frontend architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for UI integration safety."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for UI integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-ui ====================
|
||||
|
||||
==================== START: workflows#greenfield-fullstack ====================
|
||||
|
||||
2
dist/teams/team-ide-minimal.txt
vendored
2
dist/teams/team-ide-minimal.txt
vendored
@@ -1366,7 +1366,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
|
||||
26
dist/teams/team-no-ui.txt
vendored
26
dist/teams/team-no-ui.txt
vendored
@@ -1398,7 +1398,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
@@ -8528,21 +8528,21 @@ workflow:
|
||||
notes: "Review existing service documentation, codebase, performance metrics, and identify integration dependencies."
|
||||
|
||||
- agent: pm
|
||||
creates: brownfield-prd.md
|
||||
creates: prd.md
|
||||
uses: brownfield-prd-tmpl
|
||||
requires: existing_service_analysis
|
||||
notes: "Creates comprehensive brownfield PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final brownfield-prd.md to your project's docs/ folder."
|
||||
notes: "Creates comprehensive PRD focused on service enhancement with existing system analysis. SAVE OUTPUT: Copy final prd.md to your project's docs/ folder."
|
||||
|
||||
- agent: architect
|
||||
creates: brownfield-architecture.md
|
||||
creates: architecture.md
|
||||
uses: brownfield-architecture-tmpl
|
||||
requires: brownfield-prd.md
|
||||
notes: "Creates brownfield architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final brownfield-architecture.md to your project's docs/ folder."
|
||||
requires: prd.md
|
||||
notes: "Creates architecture with service integration strategy and API evolution planning. SAVE OUTPUT: Copy final architecture.md to your project's docs/ folder."
|
||||
|
||||
- agent: po
|
||||
validates: all_artifacts
|
||||
uses: po-master-checklist
|
||||
notes: "Validates all brownfield documents for service integration safety and API compatibility. May require updates to any document."
|
||||
notes: "Validates all documents for service integration safety and API compatibility. May require updates to any document."
|
||||
|
||||
- agent: various
|
||||
updates: any_flagged_documents
|
||||
@@ -8592,8 +8592,8 @@ workflow:
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Service Enhancement] --> B[analyst: analyze existing service]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
B --> C[pm: prd.md]
|
||||
C --> D[architect: architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
@@ -8614,9 +8614,9 @@ workflow:
|
||||
- Multiple integration points affected
|
||||
|
||||
handoff_prompts:
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive brownfield PRD with service integration strategy."
|
||||
pm_to_architect: "Brownfield PRD ready. Save it as docs/brownfield-prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/brownfield-architecture.md. Please validate all artifacts for service integration safety."
|
||||
analyst_to_pm: "Service analysis complete. Create comprehensive PRD with service integration strategy."
|
||||
pm_to_architect: "PRD ready. Save it as docs/prd.md, then create the service architecture."
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for service integration safety."
|
||||
po_issues: "PO found issues with [document]. Please return to [agent] to fix and re-save the updated document."
|
||||
complete: "All brownfield planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
complete: "All planning artifacts validated and saved in docs/ folder. Move to IDE environment to begin development."
|
||||
==================== END: workflows#brownfield-service ====================
|
||||
|
||||
36
docs/agentic-tools/claude-code-guide.md
Normal file
36
docs/agentic-tools/claude-code-guide.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# BMAD Method Guide for Claude Code
|
||||
|
||||
This guide covers Claude Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Claude Code** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.claude/commands/` folder with agent command files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Claude Code
|
||||
|
||||
Type `/agent-name` in your chat to activate an agent:
|
||||
|
||||
- `/bmad-master` - Universal task executor
|
||||
- `/sm` - Scrum Master
|
||||
- `/dev` - Full-stack developer
|
||||
- `/architect` - Solution architect
|
||||
- `/pm` - Product manager
|
||||
- `/analyst` - Business analyst
|
||||
- `/qa` - QA specialist
|
||||
- `/po` - Product owner
|
||||
- `/ux-expert` - UX specialist
|
||||
|
||||
## Claude Code-Specific Features
|
||||
|
||||
- **Command files**: Stored in `.claude/commands/` as `.md` files
|
||||
- **Activation**: Use forward slash `/` prefix for all agents
|
||||
- **Chat management**: Start new chats when switching agents for clean context
|
||||
|
||||
## Tips for Claude Code Users
|
||||
|
||||
- Commands are auto-suggested as you type `/`
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Claude Code maintains excellent context within each chat
|
||||
42
docs/agentic-tools/cline-guide.md
Normal file
42
docs/agentic-tools/cline-guide.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# BMAD Method Guide for Cline (VS Code)
|
||||
|
||||
This guide covers Cline-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Cline** as your IDE. This creates:
|
||||
|
||||
- `.clinerules/` directory with numbered agent rule files (`.md`)
|
||||
- Agents ordered by priority (bmad-master first)
|
||||
|
||||
## Using BMAD Agents in Cline
|
||||
|
||||
1. **Open Cline panel** in VS Code
|
||||
2. **Type `@agent-name`** in the chat (e.g., `@dev`, `@sm`, `@architect`)
|
||||
3. The agent adopts that persona for the conversation
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents use `@` prefix:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cline-Specific Features
|
||||
|
||||
- **Rule files**: Stored as numbered files in `.clinerules/` (e.g., `01-bmad-master.md`)
|
||||
- **Agent ordering**: Prioritized list with core agents first
|
||||
- **VS Code integration**: Works within VS Code's Cline extension panel
|
||||
|
||||
## Tips for Cline Users
|
||||
|
||||
- Cline maintains conversation context well
|
||||
- Use `@agent-name` at the start of your message for best results
|
||||
- Agent rules are loaded automatically when mentioned
|
||||
37
docs/agentic-tools/cursor-guide.md
Normal file
37
docs/agentic-tools/cursor-guide.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# BMAD Method Guide for Cursor
|
||||
|
||||
This guide covers Cursor-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Cursor** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.cursor/rules/` folder with agent rule files (`.mdc`)
|
||||
|
||||
## Using BMAD Agents in Cursor
|
||||
|
||||
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cursor-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.cursor/rules/` as `.mdc` files
|
||||
- **Auto-completion**: Cursor suggests agents as you type `@`
|
||||
- **Context awareness**: Agents can see your current file selection
|
||||
- **Custom agents**: For better performance, copy agent content into Cursor's custom modes
|
||||
|
||||
## Tips for Cursor Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Cursor's file context for more accurate assistance
|
||||
46
docs/agentic-tools/gemini-cli-guide.md
Normal file
46
docs/agentic-tools/gemini-cli-guide.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# BMAD Method Guide for Gemini CLI
|
||||
|
||||
This guide covers Gemini CLI-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Gemini CLI** as your IDE. This creates:
|
||||
|
||||
- `.gemini/agents/` directory with all agent context files
|
||||
- `.gemini/settings.json` configured to load all agents automatically
|
||||
|
||||
## Using BMAD Agents with Gemini CLI
|
||||
|
||||
Simply mention the agent in your prompt:
|
||||
|
||||
- "As @dev, implement the login feature"
|
||||
- "Acting as @architect, review this system design"
|
||||
- "@sm, create the next story for our project"
|
||||
|
||||
The Gemini CLI automatically loads the appropriate agent context.
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents are referenced with `@` in prompts:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Gemini CLI-Specific Features
|
||||
|
||||
- **Context files**: All agents loaded as context in `.gemini/agents/`
|
||||
- **Automatic loading**: Settings.json ensures agents are always available
|
||||
- **Natural language**: No special syntax needed, just mention the agent
|
||||
|
||||
## Tips for Gemini CLI Users
|
||||
|
||||
- Be explicit about which agent you're addressing
|
||||
- You can switch agents mid-conversation by mentioning a different one
|
||||
- The CLI maintains context across your session
|
||||
46
docs/agentic-tools/roo-code-guide.md
Normal file
46
docs/agentic-tools/roo-code-guide.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# BMAD Method Guide for Roo Code
|
||||
|
||||
This guide covers Roo Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Roo Code** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.roomodes` file in project root with custom modes
|
||||
|
||||
## Using BMAD Agents in Roo Code
|
||||
|
||||
Select mode from the mode selector (usually in status bar):
|
||||
|
||||
- `bmad-bmad-master` - 🧙 Universal task executor
|
||||
- `bmad-sm` - 🏃 Scrum Master
|
||||
- `bmad-dev` - 💻 Full-stack developer
|
||||
- `bmad-architect` - 🏗️ Solution architect
|
||||
- `bmad-pm` - 📋 Product manager
|
||||
- `bmad-analyst` - 📊 Business analyst
|
||||
- `bmad-qa` - 🧪 QA specialist
|
||||
- `bmad-po` - 🎯 Product owner
|
||||
- `bmad-ux-expert` - 🎨 UX specialist
|
||||
|
||||
## Roo Code-Specific Features
|
||||
|
||||
- **Mode file**: `.roomodes` in project root
|
||||
- **Mode switching**: Use mode selector instead of starting new chats
|
||||
- **Context preservation**: Maintains context across mode switches
|
||||
- **File permissions**: Each agent has specific file access:
|
||||
|
||||
### File Permission Summary
|
||||
|
||||
- **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
|
||||
- **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json`
|
||||
- **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
|
||||
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
|
||||
- **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
|
||||
|
||||
## Tips for Roo Code Users
|
||||
|
||||
- Switch modes instead of starting new chats
|
||||
- Each mode supports `*help` to see available commands
|
||||
- Agents respect file permission boundaries
|
||||
- Context persists across mode switches
|
||||
37
docs/agentic-tools/windsurf-guide.md
Normal file
37
docs/agentic-tools/windsurf-guide.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# BMAD Method Guide for Windsurf
|
||||
|
||||
This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Windsurf** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.windsurf/rules/` folder with agent rule files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Windsurf
|
||||
|
||||
Type `@agent-name` in chat to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Windsurf-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.windsurf/rules/` as `.md` files
|
||||
- **Activation**: Use `@` prefix to mention agents
|
||||
- **Collaborative features**: Works well with BMAD's agent-switching pattern
|
||||
- **Project context**: Agents have access to your full project context
|
||||
|
||||
## Tips for Windsurf Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Windsurf's collaboration features for team reviews
|
||||
@@ -1,121 +0,0 @@
|
||||
# BMAD Method Guide for Claude Code
|
||||
|
||||
This guide walks you through the complete BMAD workflow using Claude Code as your AI-powered IDE.
|
||||
|
||||
## Step 1: Install BMAD in Your Project
|
||||
|
||||
1. Navigate to your project directory
|
||||
2. Run the BMAD installer:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
3. When prompted:
|
||||
- **Installation Type**: Choose "Complete installation (recommended)"
|
||||
- **IDE**: Select "Claude Code"
|
||||
|
||||
This creates a `.bmad-core` folder with all agents and a `.claude/commands` folder with agent commands.
|
||||
|
||||
## Step 2: Set Up Team Fullstack in Gemini
|
||||
|
||||
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
||||
|
||||
1. Open [Google gems](https://gemini.google.com/gems/view)
|
||||
2. Create a new Gem - give it a title and description
|
||||
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
||||
4. Paste this content into Gemini to set up the team
|
||||
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
## Step 3: Back to Claude Code - Document Sharding
|
||||
|
||||
Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
|
||||
1. **Start a new chat in Claude Code**
|
||||
2. **Load the bmad-master agent**: Type `/bmad-master`
|
||||
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
## Step 4: Story Development Cycle
|
||||
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `/sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `/dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
4. **Follow the development tasks** the agent provides
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`/sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
4. **Start new chat with Dev agent** (`/dev`)
|
||||
5. **Implement the story**
|
||||
6. **Repeat until project complete**
|
||||
|
||||
## Available Commands in Claude Code
|
||||
|
||||
All BMAD agents are available as Claude Code commands:
|
||||
|
||||
- `/bmad-master` - Universal task executor
|
||||
- `/sm` - Scrum Master for story creation
|
||||
- `/dev` - Full-stack developer for implementation
|
||||
- `/architect` - Solution architect for design
|
||||
- `/pm` - Product manager for planning
|
||||
- `/analyst` - Business analyst for requirements
|
||||
- `/qa` - QA specialist for testing
|
||||
- `/po` - Product owner for prioritization
|
||||
- `/ux-expert` - UX specialist for design
|
||||
|
||||
## Key Workflow Principles
|
||||
|
||||
1. **Always start new chats** when switching agents to avoid context confusion
|
||||
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
||||
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
||||
4. **Follow the SM → Dev cycle** for consistent story development
|
||||
5. **Review and approve stories** before implementation begins
|
||||
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
@@ -204,12 +204,180 @@ graph TD
|
||||
F -->|Approved| G["Dev: Implement Story"]
|
||||
F -->|Needs Changes| E
|
||||
G --> H["Dev: Complete story Tasks"]
|
||||
H --> I{"User Verification"}
|
||||
I -->|Verified Complete| J["Mark Story as Done"]
|
||||
I -->|Needs Fixes| G
|
||||
J --> E
|
||||
H --> I["Dev: Mark Ready for Review"]
|
||||
I --> J{"User Verification"}
|
||||
J -->|Request QA Review| K["QA: Run review-story task"]
|
||||
J -->|Approve Without QA| M["Mark Story as Done"]
|
||||
K --> L{"QA Review Results"}
|
||||
L -->|Needs Work| G
|
||||
L -->|Approved| M["Mark Story as Done"]
|
||||
J -->|Needs Fixes| G
|
||||
M --> E
|
||||
|
||||
style J fill:#34a853,color:#fff
|
||||
style M fill:#34a853,color:#fff
|
||||
style K fill:#f9ab00,color:#fff
|
||||
```
|
||||
|
||||
This cycle continues, with the Scrum Master and Developer agents working in tandem, until all stories in the epic are completed.
|
||||
This cycle continues, with the Scrum Master, Developer, and optionally QA agents working together. The QA agent provides senior developer review capabilities through the `review-story` task, offering code refactoring, quality improvements, and knowledge transfer. This ensures high code quality while maintaining development velocity.
|
||||
|
||||
## 8. Complete Source Tree
|
||||
|
||||
The BMAD-METHOD project structure is designed for clarity, modularity, and extensibility. Here's the complete source tree with explanations:
|
||||
|
||||
```plaintext
|
||||
bmad-method/
|
||||
├── .bmad-core/ # Core framework (installed in user projects)
|
||||
│ ├── agents/ # Individual agent definitions
|
||||
│ │ ├── analyst.md # Business analyst agent
|
||||
│ │ ├── architect.md # Solution architect agent
|
||||
│ │ ├── bmad-master.md # Universal expert agent
|
||||
│ │ ├── bmad-orchestrator.md # Multi-agent coordinator
|
||||
│ │ ├── dev.md # Full-stack developer agent
|
||||
│ │ ├── pm.md # Product manager agent
|
||||
│ │ ├── po.md # Product owner agent
|
||||
│ │ ├── qa.md # QA specialist agent
|
||||
│ │ ├── sm.md # Scrum master agent
|
||||
│ │ └── ux-expert.md # UX designer agent
|
||||
│ ├── agent-teams/ # Pre-configured agent teams
|
||||
│ │ ├── team-all.yml # All agents bundle
|
||||
│ │ ├── team-fullstack.yml # Full-stack development team
|
||||
│ │ ├── team-ide-minimal.yml # Minimal IDE-focused team
|
||||
│ │ └── team-no-ui.yml # Backend-only team
|
||||
│ ├── checklists/ # Quality assurance checklists
|
||||
│ │ ├── architect-checklist.md
|
||||
│ │ ├── po-master-checklist.md
|
||||
│ │ └── story-dod-checklist.md
|
||||
│ ├── data/ # Knowledge base and preferences
|
||||
│ │ ├── bmad-kb.md # Core knowledge base
|
||||
│ │ └── technical-preferences.md # User tech preferences
|
||||
│ ├── tasks/ # Reusable task definitions
|
||||
│ │ ├── advanced-elicitation.md # Deep diving techniques
|
||||
│ │ ├── create-doc.md # Document creation task
|
||||
│ │ ├── create-next-story.md # Story generation task
|
||||
│ │ ├── doc-migration-task.md # V3 to V4 migration
|
||||
│ │ ├── execute-checklist.md # Checklist runner
|
||||
│ │ └── shard-doc.md # Document sharding task
|
||||
│ ├── templates/ # Document templates
|
||||
│ │ ├── full-stack-architecture-tmpl.md
|
||||
│ │ ├── prd-tmpl.md
|
||||
│ │ ├── project-brief-tmpl.md
|
||||
│ │ ├── story-tmpl.md
|
||||
│ │ └── [other templates...]
|
||||
│ ├── utils/ # Utility components
|
||||
│ │ ├── agent-switcher.web # Web UI agent switching
|
||||
│ │ ├── template-format.md # Template markup spec
|
||||
│ │ └── workflow-management.md # Workflow helpers
|
||||
│ ├── workflows/ # Development workflows
|
||||
│ │ ├── brownfield-enhancement.yml
|
||||
│ │ ├── greenfield-fullstack.yml
|
||||
│ │ ├── greenfield-service.yml
|
||||
│ │ └── greenfield-simple.yml
|
||||
│ └── core-config.yml # V4 configuration system
|
||||
│
|
||||
├── dist/ # Pre-built bundles (generated)
|
||||
│ ├── agents/ # Individual agent bundles
|
||||
│ │ ├── analyst.txt
|
||||
│ │ ├── architect.txt
|
||||
│ │ └── [other agents...]
|
||||
│ ├── teams/ # Team bundles for web UI
|
||||
│ │ ├── team-all.txt
|
||||
│ │ ├── team-fullstack.txt
|
||||
│ │ └── [other teams...]
|
||||
│ └── expansion-packs/ # Expansion pack bundles
|
||||
│
|
||||
├── docs/ # Documentation
|
||||
│ ├── agentic-tools/ # IDE-specific guides
|
||||
│ │ ├── claude-code-guide.md
|
||||
│ │ ├── cursor-guide.md
|
||||
│ │ ├── cline-guide.md
|
||||
│ │ ├── gemini-cli-guide.md
|
||||
│ │ ├── roo-code-guide.md
|
||||
│ │ └── windsurf-guide.md
|
||||
│ ├── bmad-workflow-guide.md # Universal workflow guide
|
||||
│ ├── core-architecture.md # This document
|
||||
│ ├── expansion-packs.md # Expansion pack guide
|
||||
│ ├── user-guide.md # Comprehensive user guide
|
||||
│ └── [other docs...]
|
||||
│
|
||||
├── expansion-packs/ # Domain-specific extensions
|
||||
│ ├── bmad-2d-phaser-game-dev/ # Game development pack
|
||||
│ ├── bmad-creator-tools/ # Agent creation tools
|
||||
│ ├── bmad-infrastructure-devops/ # DevOps pack
|
||||
│ └── README.md
|
||||
│
|
||||
├── tools/ # Build and installation tools
|
||||
│ ├── builders/ # Build system
|
||||
│ │ └── web-builder.js # Bundle generator
|
||||
│ ├── cli.js # Main CLI tool
|
||||
│ ├── installer/ # NPX installer
|
||||
│ │ ├── index.js # Installer entry point
|
||||
│ │ ├── config/ # Installation configs
|
||||
│ │ ├── lib/ # Installer utilities
|
||||
│ │ └── templates/ # IDE template files
|
||||
│ └── lib/ # Shared libraries
|
||||
│ ├── bundle-utils.js
|
||||
│ ├── dependency-resolver.js
|
||||
│ └── file-processor.js
|
||||
│
|
||||
├── .github/ # GitHub configuration
|
||||
│ ├── workflows/ # GitHub Actions
|
||||
│ └── ISSUE_TEMPLATE/ # Issue templates
|
||||
│
|
||||
├── common/ # Shared resources
|
||||
│ ├── tasks/ # Common tasks
|
||||
│ └── utils/ # Common utilities
|
||||
│
|
||||
├── bmad-core/ # Source for .bmad-core
|
||||
│ └── [mirrors .bmad-core structure]
|
||||
│
|
||||
├── package.json # Node.js configuration
|
||||
├── README.md # Project readme
|
||||
├── CONTRIBUTING.md # Contribution guidelines
|
||||
├── GUIDING-PRINCIPLES.md # Core principles
|
||||
└── LICENSE # MIT license
|
||||
```
|
||||
|
||||
### Directory Purposes
|
||||
|
||||
#### Core Framework (.bmad-core/)
|
||||
|
||||
- **agents/**: Individual AI agent personalities and capabilities
|
||||
- **agent-teams/**: Bundles of agents for specific workflows
|
||||
- **checklists/**: Quality assurance and validation steps
|
||||
- **data/**: Knowledge base and user preferences
|
||||
- **tasks/**: Reusable procedures agents can execute
|
||||
- **templates/**: Document templates with embedded AI instructions
|
||||
- **utils/**: Helper components for agents
|
||||
- **workflows/**: Structured development processes
|
||||
|
||||
#### Generated Bundles (dist/)
|
||||
|
||||
- Pre-built text files ready for web UI upload
|
||||
- Automatically generated by the build system
|
||||
- Includes resolved dependencies for each agent/team
|
||||
|
||||
#### Tools (tools/)
|
||||
|
||||
- **cli.js**: Main build tool for creating bundles
|
||||
- **installer/**: NPX-based installer for projects
|
||||
- **builders/**: Bundle generation logic
|
||||
- **lib/**: Shared utilities for build system
|
||||
|
||||
#### Expansion Packs (expansion-packs/)
|
||||
|
||||
- Domain-specific agent collections
|
||||
- Extend BMAD beyond software development
|
||||
- Each pack is self-contained with its own agents, tasks, and templates
|
||||
|
||||
#### Documentation (docs/)
|
||||
|
||||
- Comprehensive guides for users
|
||||
- Technical architecture documentation
|
||||
- IDE-specific setup instructions
|
||||
|
||||
### Key Files
|
||||
|
||||
- **core-config.yml**: V4's flexible configuration system
|
||||
- **bmad-kb.md**: Central knowledge base loaded by most agents
|
||||
- **template-format.md**: Specification for BMAD's template markup
|
||||
- **dependency-resolver.js**: Manages agent resource loading
|
||||
|
||||
@@ -1,131 +0,0 @@
|
||||
# BMAD Method Guide for Cursor
|
||||
|
||||
This guide walks you through the complete BMAD workflow using Cursor as your AI-powered IDE.
|
||||
|
||||
## Step 1: Install BMAD in Your Project
|
||||
|
||||
1. Navigate to your project directory
|
||||
2. Run the BMAD installer:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
3. When prompted:
|
||||
- **Installation Type**: Choose "Complete installation (recommended)"
|
||||
- **IDE**: Select "Cursor"
|
||||
|
||||
This creates a `.bmad-core` folder with all agents and a `.cursor/rules` folder with agent rules.
|
||||
|
||||
## Step 2: Set Up Team Fullstack in Gemini
|
||||
|
||||
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
||||
|
||||
1. Open [Google gems](https://gemini.google.com/gems/view)
|
||||
2. Create a new Gem - give it a title and description
|
||||
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
||||
4. Paste this content into Gemini to set up the team
|
||||
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
## Step 3: Back to Cursor - Document Sharding
|
||||
|
||||
Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
|
||||
1. **Start a new chat in Cursor**
|
||||
2. **Load the bmad-master agent**: Type `@bmad-master`
|
||||
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
## Step 4: Story Development Cycle
|
||||
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `@dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
4. **Follow the development tasks** the agent provides
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`@sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
4. **Start new chat with Dev agent** (`@dev`)
|
||||
5. **Implement the story**
|
||||
6. **Repeat until project complete**
|
||||
|
||||
## Available Agent Rules in Cursor
|
||||
|
||||
All BMAD agents are available as Cursor rules (use `@` prefix):
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master for story creation
|
||||
- `@dev` - Full-stack developer for implementation
|
||||
- `@architect` - Solution architect for design
|
||||
- `@pm` - Product manager for planning
|
||||
- `@analyst` - Business analyst for requirements
|
||||
- `@qa` - QA specialist for testing
|
||||
- `@po` - Product owner for prioritization
|
||||
- `@ux-expert` - UX specialist for design
|
||||
|
||||
Alternatively, and more performance - you can copy the contents of an agent file into a custom mode - see the cursor docs on how to use custom agents.
|
||||
|
||||
## Cursor-Specific Features
|
||||
|
||||
- **Agent rules are stored in**: `.cursor/rules/` as `.mdc` files
|
||||
- **Auto-completion**: Cursor will suggest `@agent-name` as you type
|
||||
- **Rule activation**: Rules activate automatically when you mention `@agent-name`
|
||||
- **Context awareness**: Agents have access to your current file context
|
||||
|
||||
## Key Workflow Principles
|
||||
|
||||
1. **Always start new chats** when switching agents to avoid context confusion
|
||||
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
||||
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
||||
4. **Follow the SM → Dev cycle** for consistent story development
|
||||
5. **Review and approve stories** before implementation begins
|
||||
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Cursor's context**: Agents can see your current file selection for better assistance
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
@@ -1,121 +0,0 @@
|
||||
# Expansion Pack Ideas
|
||||
|
||||
The BMAD Method's natural language framework can be applied to any domain. Here are ideas to inspire your own expansion packs:
|
||||
|
||||
## Health & Wellness Pack
|
||||
|
||||
### Agents
|
||||
|
||||
- **Fitness Coach** - Creates personalized workout plans
|
||||
- **Nutrition Advisor** - Designs meal plans and tracks nutrition
|
||||
- **Meditation Guide** - Leads mindfulness sessions
|
||||
- **Sleep Optimizer** - Improves sleep habits
|
||||
|
||||
### Tasks
|
||||
|
||||
- `create-workout-plan` - Generates weekly exercise routines
|
||||
- `analyze-nutrition` - Reviews dietary habits
|
||||
- `design-meditation` - Creates guided meditation scripts
|
||||
|
||||
### Templates
|
||||
|
||||
- `workout-plan-tmpl` - Structured exercise program
|
||||
- `meal-plan-tmpl` - Weekly nutrition guide
|
||||
- `wellness-journal-tmpl` - Progress tracking
|
||||
|
||||
## Creative Writing Pack
|
||||
|
||||
### Agents
|
||||
|
||||
- **Story Architect** - Plots narratives and story structures
|
||||
- **Character Developer** - Creates deep, complex characters
|
||||
- **World Builder** - Designs fictional universes
|
||||
- **Dialog Master** - Crafts authentic conversations
|
||||
|
||||
### Tasks
|
||||
|
||||
- `develop-plot` - Creates story outlines
|
||||
- `build-character` - Develops character profiles
|
||||
- `create-world` - Designs settings and cultures
|
||||
|
||||
### Templates
|
||||
|
||||
- `story-outline-tmpl` - Three-act structure
|
||||
- `character-sheet-tmpl` - Detailed character profile
|
||||
- `world-bible-tmpl` - Universe documentation
|
||||
|
||||
## Business Strategy Pack
|
||||
|
||||
### Agents
|
||||
|
||||
- **Strategy Consultant** - Develops business strategies
|
||||
- **Market Analyst** - Researches market opportunities
|
||||
- **Financial Advisor** - Creates financial projections
|
||||
- **Operations Expert** - Optimizes business processes
|
||||
|
||||
### Tasks
|
||||
|
||||
- `swot-analysis` - Conducts SWOT analysis
|
||||
- `market-research` - Analyzes market conditions
|
||||
- `financial-forecast` - Projects revenue/costs
|
||||
|
||||
### Templates
|
||||
|
||||
- `business-plan-tmpl` - Complete business plan
|
||||
- `market-analysis-tmpl` - Market research report
|
||||
- `pitch-deck-tmpl` - Investor presentation
|
||||
|
||||
## Education Pack
|
||||
|
||||
### Agents
|
||||
|
||||
- **Curriculum Designer** - Creates learning pathways
|
||||
- **Lesson Planner** - Develops engaging lessons
|
||||
- **Assessment Creator** - Designs fair evaluations
|
||||
- **Learning Coach** - Provides personalized guidance
|
||||
|
||||
### Tasks
|
||||
|
||||
- `design-curriculum` - Creates course structure
|
||||
- `plan-lesson` - Develops lesson content
|
||||
- `create-assessment` - Builds tests/quizzes
|
||||
|
||||
### Templates
|
||||
|
||||
- `course-outline-tmpl` - Semester plan
|
||||
- `lesson-plan-tmpl` - Daily lesson structure
|
||||
- `rubric-tmpl` - Assessment criteria
|
||||
|
||||
## Personal Development Pack
|
||||
|
||||
### Agents
|
||||
|
||||
- **Life Coach** - Guides personal growth
|
||||
- **Goal Strategist** - Helps achieve objectives
|
||||
- **Habit Builder** - Creates lasting habits
|
||||
- **Mindset Mentor** - Develops positive thinking
|
||||
|
||||
### Tasks
|
||||
|
||||
- `goal-setting` - Defines SMART goals
|
||||
- `habit-tracking` - Monitors habit formation
|
||||
- `reflection-exercise` - Facilitates self-reflection
|
||||
|
||||
### Templates
|
||||
|
||||
- `goal-plan-tmpl` - Goal achievement roadmap
|
||||
- `habit-tracker-tmpl` - Daily habit log
|
||||
- `journal-prompts-tmpl` - Reflection questions
|
||||
|
||||
## Creating Your Own
|
||||
|
||||
To create an expansion pack:
|
||||
|
||||
1. **Identify the domain** - What area of expertise?
|
||||
2. **Define agent roles** - Who are the experts?
|
||||
3. **Create tasks** - What procedures do they follow?
|
||||
4. **Design templates** - What outputs do they produce?
|
||||
5. **Test with users** - Does it provide value?
|
||||
6. **Share with community** - Help others benefit!
|
||||
|
||||
Remember: The BMAD Method works anywhere natural language instructions can guide AI assistance!
|
||||
@@ -132,6 +132,21 @@ Property investment and management:
|
||||
- **Flip Strategist**: Renovation ROI, project planning
|
||||
- **Agent Assistant**: Listing optimization, showing prep
|
||||
|
||||
### Personal Development Pack
|
||||
|
||||
Complete personal growth system:
|
||||
|
||||
- **Life Coach**: Guides personal growth and transformation
|
||||
- **Goal Strategist**: Helps achieve objectives with SMART goals
|
||||
- **Habit Builder**: Creates lasting habits with accountability
|
||||
- **Mindset Mentor**: Develops positive thinking patterns
|
||||
|
||||
Key tasks include:
|
||||
|
||||
- `goal-setting`: Defines SMART goals with action plans
|
||||
- `habit-tracking`: Monitors habit formation progress
|
||||
- `reflection-exercise`: Facilitates deep self-reflection
|
||||
|
||||
## Unique & Innovative Packs
|
||||
|
||||
### Role-Playing Game Master Pack
|
||||
|
||||
@@ -1,142 +0,0 @@
|
||||
# BMAD Method Guide for Roo Code
|
||||
|
||||
This guide walks you through the complete BMAD workflow using Roo Code as your AI-powered IDE.
|
||||
|
||||
## Step 1: Install BMAD in Your Project
|
||||
|
||||
1. Navigate to your project directory
|
||||
2. Run the BMAD installer:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
3. When prompted:
|
||||
- **Installation Type**: Choose "Complete installation (recommended)"
|
||||
- **IDE**: Select "Roo Code"
|
||||
|
||||
This creates a `.bmad-core` folder with all agents and a `.roomodes` file (in the project root) with custom modes.
|
||||
|
||||
## Step 2: Set Up Team Fullstack in Gemini
|
||||
|
||||
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
||||
|
||||
1. Open [Google gems](https://gemini.google.com/gems/view)
|
||||
2. Create a new Gem - give it a title and description
|
||||
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
||||
4. Paste this content into Gemini to set up the team
|
||||
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
## Step 3: Back to Roo Code - Document Sharding
|
||||
|
||||
Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
|
||||
1. **Open your project in Roo Code**
|
||||
2. **Select the bmad-master mode** from the mode selector (usually in status bar)
|
||||
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
## Step 4: Story Development Cycle
|
||||
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat or conversation**
|
||||
2. **Switch to SM mode**: Select `bmad-sm` from the mode selector
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new conversation**
|
||||
2. **Switch to Dev mode**: Select `bmad-dev` from the mode selector
|
||||
3. **The agent will ask which story to implement**
|
||||
4. **Follow the development tasks** the agent provides
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Switch to SM mode** (`bmad-sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
4. **Switch to Dev mode** (`bmad-dev`)
|
||||
5. **Implement the story**
|
||||
6. **Repeat until project complete**
|
||||
|
||||
## Available Custom Modes in Roo Code
|
||||
|
||||
All BMAD agents are available as custom modes:
|
||||
|
||||
- `bmad-bmad-master` - 🧙 Universal task executor
|
||||
- `bmad-sm` - 🏃 Scrum Master for story creation
|
||||
- `bmad-dev` - 💻 Full-stack developer for implementation
|
||||
- `bmad-architect` - 🏗️ Solution architect for design
|
||||
- `bmad-pm` - 📋 Product manager for planning
|
||||
- `bmad-analyst` - 📊 Business analyst for requirements
|
||||
- `bmad-qa` - 🧪 QA specialist for testing
|
||||
- `bmad-po` - 🎯 Product owner for prioritization
|
||||
- `bmad-ux-expert` - 🎨 UX specialist for design
|
||||
|
||||
## Roo Code-Specific Features
|
||||
|
||||
- **Custom modes are stored in**: `.roomodes` file (in the project root)
|
||||
- **Mode switching**: Use the mode selector in Roo Code's interface
|
||||
- **File permissions**: Each agent has specific file access permissions
|
||||
- **Documentation agents** (SM, PM, PO, Analyst): Limited to `.md` and `.txt` files
|
||||
- **Technical agents** (Dev, Architect, Master): Full file access
|
||||
- **QA agents**: Access to test files and documentation
|
||||
- **UX agents**: Access to design-related files
|
||||
- **Context preservation**: Modes maintain context within conversations
|
||||
|
||||
## Key Workflow Principles
|
||||
|
||||
1. **Switch modes instead of starting new chats** - Roo Code handles context better with mode switching
|
||||
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
||||
3. **Use bmad-master mode for document management** (sharding, templates, etc.)
|
||||
4. **Follow the SM → Dev mode cycle** for consistent story development
|
||||
5. **Review and approve stories** before implementation begins
|
||||
|
||||
## Tips for Success
|
||||
|
||||
- **Use mode selector effectively**: Switch modes as needed for different tasks
|
||||
- **Respect file permissions**: Agents can only edit files they have permission for
|
||||
- **Use \*help command**: Every mode supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Roo's context**: Modes can maintain context across the conversation
|
||||
|
||||
## File Permission Summary
|
||||
|
||||
- **bmad-analyst, bmad-pm, bmad-po, bmad-sm**: `.md`, `.txt` files only
|
||||
- **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json` files
|
||||
- **bmad-qa**: Test files (`.test.js`, `.spec.ts`, etc.) and `.md` files
|
||||
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx` files
|
||||
- **bmad-dev, bmad-bmad-master, bmad-orchestrator**: Full file access
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD-METHOD User Guide
|
||||
# BMAD-METHOD Agentic Agile Driven Development User Guide
|
||||
|
||||
This comprehensive guide will help you understand and effectively use the BMAD-METHOD framework for AI-assisted software development.
|
||||
This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -61,6 +61,19 @@ Best for: Cursor, Claude Code, Windsurf, VS Code users
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
### CLI Commands
|
||||
|
||||
```bash
|
||||
# List all available agents
|
||||
npx bmad-method list
|
||||
|
||||
# Install or update (automatically detects existing installations)
|
||||
npx bmad-method install
|
||||
|
||||
# Check installation status
|
||||
npx bmad-method status
|
||||
```
|
||||
|
||||
### First Steps
|
||||
|
||||
1. **Choose Your Environment**: Web UI or IDE
|
||||
@@ -68,17 +81,44 @@ npx bmad-method install
|
||||
3. **Initialize Project**: Run `/help` or `*help` to see capabilities
|
||||
4. **Start Development**: Begin with planning or jump into coding
|
||||
|
||||
### Upgrading from V3 to V4
|
||||
|
||||
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# The installer will automatically detect your V3 installation and offer to upgrade
|
||||
```
|
||||
|
||||
The upgrade process will:
|
||||
|
||||
1. Create a backup of your V3 files in `.bmad-v3-backup/`
|
||||
2. Install the new V4 `.bmad-core/` structure
|
||||
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
||||
4. Set up IDE integration for all V4 agents
|
||||
5. Create an install manifest for future updates
|
||||
|
||||
After upgrading:
|
||||
|
||||
1. Review your documents in the `docs/` folder - if you had a PRD or architecture in your old project, copy it from the backup to the docs folder if they are not there.
|
||||
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent by saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}'
|
||||
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
|
||||
|
||||
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration-coreconfigyml)
|
||||
|
||||
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
|
||||
|
||||
## Agent System
|
||||
|
||||
### Core Development Team
|
||||
|
||||
| Agent | Role | Primary Functions | When to Use |
|
||||
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
|
||||
| ----------- | ------------------ | ---------------------------------------------- | ------------------------------------------------- |
|
||||
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
|
||||
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
|
||||
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
|
||||
| `dev` | Developer | Code implementation, debugging | All development tasks |
|
||||
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
|
||||
| `dev` | Developer | Sequential task execution, testing, validation | Story implementation with test-driven development |
|
||||
| `qa` | QA Specialist | Code review, refactoring, test validation | Senior developer review via `review-story` task |
|
||||
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
|
||||
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
|
||||
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
|
||||
@@ -284,20 +324,29 @@ Once planning is complete and documents are sharded, BMAD follows a structured d
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
|
||||
B --> C["PO: Shard Arch"]
|
||||
C --> D["Development Phase"]
|
||||
D --> E["Scrum Master: Drafts next story from sharded epic"]
|
||||
E --> F{"User Approval"}
|
||||
F -->|Approved| G["Dev: Implement Story"]
|
||||
F -->|Needs Changes| E
|
||||
G --> H["Dev: Complete story Tasks"]
|
||||
H --> I{"User Verification"}
|
||||
I -->|Verified Complete| J["Mark Story as Done"]
|
||||
I -->|Needs Fixes| G
|
||||
J --> E
|
||||
A["Development Phase Start"] --> B["SM: Reviews Previous Story Dev/QA Notes"]
|
||||
B --> B2["SM: Drafts Next Story from Sharded Epic + Architecture"]
|
||||
B2 --> C{"User Approval"}
|
||||
C -->|Approved| D["Dev: Sequential Task Execution"]
|
||||
C -->|Needs Changes| B2
|
||||
D --> E["Dev: Implement Tasks + Tests"]
|
||||
E --> F["Dev: Run All Validations"]
|
||||
F --> G["Dev: Mark Ready for Review + Add Notes"]
|
||||
G --> H{"User Verification"}
|
||||
H -->|Request QA Review| I["QA: Senior Dev Review + Active Refactoring"]
|
||||
H -->|Approve Without QA| K["Mark Story as Done"]
|
||||
I --> J["QA: Review, Refactor Code, Add Tests, Document Notes"]
|
||||
J --> L{"QA Decision"}
|
||||
L -->|Needs Dev Work| D
|
||||
L -->|Approved| K
|
||||
H -->|Needs Fixes| D
|
||||
K --> B
|
||||
|
||||
style J fill:#34a853,color:#fff
|
||||
style K fill:#34a853,color:#fff
|
||||
style I fill:#f9ab00,color:#fff
|
||||
style J fill:#ffd54f,color:#000
|
||||
style E fill:#e3f2fd,color:#000
|
||||
style B fill:#e8f5e9,color:#000
|
||||
```
|
||||
|
||||
### Workflow Phases
|
||||
@@ -319,15 +368,213 @@ graph TD
|
||||
|
||||
- **SM**: Draft next story from sharded epic
|
||||
- **User**: Review and approve story
|
||||
- **Dev**: Implement all story tasks
|
||||
- **Dev**: Sequential task execution:
|
||||
- Reads each task in the story
|
||||
- Implements code for the task
|
||||
- Writes tests alongside implementation
|
||||
- Runs validations (linting, tests)
|
||||
- Updates task checkbox [x] only if all validations pass
|
||||
- Maintains Debug Log for temporary changes
|
||||
- Updates File List with all created/modified files
|
||||
- **Dev**: After all tasks complete:
|
||||
- Runs integration tests (if specified)
|
||||
- Runs E2E tests (if specified)
|
||||
- Validates Definition of Done checklist
|
||||
- Marks story as "Ready for Review"
|
||||
- **User**: Verify implementation
|
||||
- **Optional QA Review**: User can request QA to run `review-story` task
|
||||
- **Repeat**: Until all stories complete
|
||||
|
||||
#### 4. Quality Assurance
|
||||
#### Dev Agent Workflow Details
|
||||
|
||||
- **QA**: Test planning and execution
|
||||
- **Dev**: Bug fixes and refinements
|
||||
- **PO**: Acceptance criteria validation
|
||||
The Dev agent follows a strict test-driven sequential workflow:
|
||||
|
||||
**Key Behaviors:**
|
||||
|
||||
- **Story-Centric**: Works only from the story file, never loads PRD/architecture unless specified in dev notes
|
||||
- **Sequential Execution**: Completes tasks one by one, marking [x] only after validations pass
|
||||
- **Test-Driven**: Writes tests alongside code for every task
|
||||
- **Quality Gates**: Never marks tasks complete if validations fail
|
||||
- **Debug Logging**: Tracks temporary changes in the story's Debug Log table
|
||||
- **File Tracking**: Maintains complete File List of all created/modified files
|
||||
|
||||
**Blocking Conditions:**
|
||||
The Dev agent will stop and request help if:
|
||||
|
||||
- Story is not approved
|
||||
- Requirements are ambiguous after checking the story
|
||||
- Validations fail 3 times for the same task
|
||||
- Critical configuration files are missing
|
||||
- Automated tests or linting fails
|
||||
|
||||
#### 4. Quality Assurance Integration
|
||||
|
||||
The QA agent plays a crucial role after development:
|
||||
|
||||
- **When Dev marks "Ready for Review"**: Story is ready for user verification
|
||||
- **User Options**:
|
||||
- **Direct Approval**: If satisfied, mark story as "Done"
|
||||
- **Request Changes**: Send back to Dev with specific feedback
|
||||
- **Request QA Review**: Ask QA to run the `review-story` task for senior developer review
|
||||
- **QA Review Process** (`/qa run review-story`):
|
||||
|
||||
- Reviews code as a senior developer with authority to refactor
|
||||
- **Active Refactoring**: Makes improvements directly in the code
|
||||
- **Comprehensive Review Focus**:
|
||||
- Code architecture and design patterns
|
||||
- Refactoring opportunities and code duplication
|
||||
- Performance optimizations and security concerns
|
||||
- Best practices and patterns
|
||||
- **Standards Compliance**: Verifies adherence to:
|
||||
- `docs/coding-standards.md`
|
||||
- `docs/unified-project-structure.md`
|
||||
- `docs/testing-strategy.md`
|
||||
- **Test Coverage Review**: Can add missing tests if critical coverage is lacking
|
||||
- **Documentation**: Adds comments for complex logic if missing
|
||||
- **Results Documentation** in story's QA Results section:
|
||||
- Code quality assessment
|
||||
- Refactoring performed with WHY and HOW explanations
|
||||
- Compliance check results
|
||||
- Improvements checklist (completed vs. pending items)
|
||||
- Security and performance findings
|
||||
- Final approval status
|
||||
|
||||
### Understanding the SM/Dev/QA Story Workflow
|
||||
|
||||
The story file is the central artifact that enables seamless collaboration between the Scrum Master (SM), Developer (Dev), and Quality Assurance (QA) agents. Here's how they work together:
|
||||
|
||||
#### Why We Have the Scrum Master
|
||||
|
||||
The SM agent serves as a critical bridge between high-level planning and technical implementation:
|
||||
|
||||
1. **Document Synthesis**: Reads sharded PRD epics and architecture documents to extract relevant technical details
|
||||
2. **Story Enrichment**: Creates self-contained stories with all technical context needed for implementation
|
||||
3. **Continuous Learning**: Uses notes from previous stories to improve future story preparation
|
||||
4. **Developer Efficiency**: Ensures developers have everything needed without searching multiple documents
|
||||
|
||||
#### The Story Creation Process
|
||||
|
||||
When the SM agent executes the `create-next-story` task:
|
||||
|
||||
1. **Loads Configuration**: Reads `core-config.yml` to understand project structure
|
||||
2. **Identifies Next Story**: Sequentially processes stories from epics (1.1, 1.2, 2.1, etc.)
|
||||
3. **Gathers Architecture Context**: Reads relevant sharded architecture documents based on story type:
|
||||
|
||||
- Backend stories: data models, API specs, database schemas
|
||||
- Frontend stories: component specs, UI patterns, workflows
|
||||
- Full-stack: both backend and frontend documents
|
||||
|
||||
4. **Reviews Previous Story**: Extracts Dev and QA notes to learn from past implementation
|
||||
|
||||
#### The Story Template Structure
|
||||
|
||||
The story template contains embedded LLM instructions for different agents:
|
||||
|
||||
**SM Agent Instructions**:
|
||||
|
||||
- Populate Dev Notes with specific technical details from architecture
|
||||
- Include source references for all technical guidance
|
||||
- Create detailed tasks based on architecture constraints
|
||||
- Add testing requirements from testing strategy
|
||||
|
||||
**Dev Agent Instructions**:
|
||||
|
||||
- Update Debug Log References during implementation
|
||||
- Document any deviations in Completion Notes
|
||||
- Maintain comprehensive File List of all changes
|
||||
- Track requirement changes in Change Log
|
||||
|
||||
**QA Agent Instructions**:
|
||||
|
||||
- Append review results in QA Results section
|
||||
- Document refactoring performed with explanations
|
||||
- Note security and performance considerations
|
||||
|
||||
#### How Agents Pass Information
|
||||
|
||||
##### SM → Dev Flow
|
||||
|
||||
The SM prepares the story with:
|
||||
|
||||
- **Dev Notes**: Specific technical guidance extracted from architecture
|
||||
- **Testing Requirements**: Unit, integration, and E2E test specifications
|
||||
- **Tasks/Subtasks**: Detailed implementation steps with AC mappings
|
||||
|
||||
##### Dev → SM Flow
|
||||
|
||||
The Dev agent provides feedback through:
|
||||
|
||||
- **Completion Notes**: Deviations or discoveries that impact future stories
|
||||
- **Debug Log References**: Technical challenges and solutions
|
||||
- **File List**: Complete inventory of created/modified files
|
||||
- **Change Log**: Any requirement modifications during development
|
||||
|
||||
##### QA → SM Flow
|
||||
|
||||
The QA agent contributes:
|
||||
|
||||
- **Code Quality Assessment**: Senior developer perspective on implementation quality
|
||||
- **Refactoring Performed**: Direct code improvements with:
|
||||
- What was changed
|
||||
- Why the change was made
|
||||
- How it improves the code
|
||||
- **Compliance Results**: Verification against coding standards, project structure, and testing strategy
|
||||
- **Test Coverage**: Added tests for critical missing coverage
|
||||
- **Security Review**: Any security concerns found and whether addressed
|
||||
- **Performance Considerations**: Performance issues found and optimizations made
|
||||
- **Improvements Checklist**: Items completed (marked [x]) vs. items for Dev to address (marked [ ])
|
||||
- **Learning Opportunities**: Explanations for junior/mid-level developer growth
|
||||
|
||||
#### Example: How Notes Flow Between Stories
|
||||
|
||||
**Story 1.1 Completion**:
|
||||
|
||||
```markdown
|
||||
### Completion Notes List
|
||||
|
||||
- Discovered that user authentication requires additional session management not specified in architecture
|
||||
- Created new SessionManager service in services/auth/session-manager.ts
|
||||
- Recommend updating architecture to include session management patterns
|
||||
```
|
||||
|
||||
**Story 1.2 Creation** (SM uses the above notes):
|
||||
|
||||
```markdown
|
||||
## Dev Notes
|
||||
|
||||
### Previous Story Insights
|
||||
|
||||
- Story 1.1 created SessionManager service for auth (services/auth/session-manager.ts)
|
||||
- Consider using SessionManager for this story's user profile feature
|
||||
- Architecture update pending for session management patterns
|
||||
```
|
||||
|
||||
This continuous feedback loop ensures each story benefits from lessons learned in previous implementations.
|
||||
|
||||
#### QA Agent Key Principles
|
||||
|
||||
When the QA agent performs the review-story task:
|
||||
|
||||
- **Senior Developer Authority**: Reviews as a senior developer with authority to refactor directly
|
||||
- **Active Improvement**: Makes code improvements rather than just identifying issues
|
||||
- **Teaching Focus**: Explains all changes for developer learning and growth
|
||||
- **Pragmatic Balance**: Focuses on significant improvements, not nitpicks
|
||||
- **Quality Gates**: Can block story completion if critical issues exist
|
||||
|
||||
**QA Blocking Conditions**:
|
||||
The QA will stop and request clarification if:
|
||||
|
||||
- Story file is incomplete or missing critical sections
|
||||
- File List is empty or clearly incomplete
|
||||
- No tests exist when they were required
|
||||
- Code changes don't align with story requirements
|
||||
- Critical architectural issues require discussion
|
||||
|
||||
- **Benefits of QA Review**:
|
||||
- Code quality improvements and refactoring
|
||||
- Knowledge transfer through documented explanations
|
||||
- Catching edge cases and security issues
|
||||
- Ensuring architectural consistency
|
||||
|
||||
### Workflow Types
|
||||
|
||||
@@ -528,7 +775,7 @@ Web UI agents focus on planning and documentation. Here's how to interact with e
|
||||
|
||||
### Dynamic Resource Loading
|
||||
|
||||
BMAD's dependency system ensures agents only load necessary resources:
|
||||
BMad's dependency system ensures agents only load necessary resources:
|
||||
|
||||
- **Templates**: Only relevant document templates
|
||||
- **Tasks**: Only required automation tasks
|
||||
@@ -595,7 +842,7 @@ phases:
|
||||
|
||||
Templates are self-contained documents that embed both output structure and processing instructions. Follow these patterns from existing templates:
|
||||
|
||||
#### Template Structure
|
||||
#### Template Structure Example
|
||||
|
||||
```markdown
|
||||
# {{Project Name}} Document Title
|
||||
@@ -1135,7 +1382,7 @@ Add specialized capabilities:
|
||||
- **Data Pack**: Analytics, ML integration
|
||||
- **Security Pack**: Security analysis, compliance
|
||||
|
||||
## Troubleshooting
|
||||
## Troubleshooting Guide
|
||||
|
||||
### Common Issues
|
||||
|
||||
@@ -1178,7 +1425,7 @@ Add specialized capabilities:
|
||||
- **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/tree/main/docs)
|
||||
- **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
## Best Practices
|
||||
## Best Practices and Tips
|
||||
|
||||
### Project Organization
|
||||
|
||||
@@ -1201,7 +1448,7 @@ project/
|
||||
- Version control all BMAD-generated content
|
||||
- Regular backups of `.bmad-core/` customizations
|
||||
|
||||
### Development Workflow
|
||||
### Recommended Development Flow
|
||||
|
||||
#### Planning Phase
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Automated Releases (Recommended)
|
||||
|
||||
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push - everything else happens automatically!
|
||||
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push and everything else happens automatically.
|
||||
|
||||
### Commit Message Format
|
||||
|
||||
@@ -58,7 +58,7 @@ npm run release:test # Safe to run locally - tests the config
|
||||
|
||||
## Manual Release Methods (Exceptions Only)
|
||||
|
||||
**⚠️ Only use these methods if you need to bypass the automatic system**
|
||||
⚠️ Only use these methods if you need to bypass the automatic system
|
||||
|
||||
### Quick Manual Version Bump
|
||||
|
||||
@@ -75,11 +75,3 @@ git push && git push --tags
|
||||
### Manual GitHub Actions Trigger
|
||||
|
||||
You can also trigger releases manually through GitHub Actions workflow dispatch if needed.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
**For 99% of releases**: Just use `fix:` or `feat:` commit messages and push. Everything else is automatic!
|
||||
|
||||
**Manual methods**: Only needed for special cases or if you want to bypass the automated system.
|
||||
|
||||
@@ -16,7 +16,6 @@ Guiding Principles of V4:
|
||||
- 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
|
||||
|
||||
|
||||
@@ -1,129 +0,0 @@
|
||||
# BMAD Method Guide for Windsurf
|
||||
|
||||
This guide walks you through the complete BMAD workflow using Windsurf as your AI-powered IDE.
|
||||
|
||||
## Step 1: Install BMAD in Your Project
|
||||
|
||||
1. Navigate to your project directory
|
||||
2. Run the BMAD installer:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
3. When prompted:
|
||||
- **Installation Type**: Choose "Complete installation (recommended)"
|
||||
- **IDE**: Select "Windsurf"
|
||||
|
||||
This creates a `.bmad-core` folder with all agents and a `.windsurf/rules` folder with agent rules.
|
||||
|
||||
## Step 2: Set Up Team Fullstack in Gemini
|
||||
|
||||
For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
|
||||
|
||||
1. Open [Google gems](https://gemini.google.com/gems/view)
|
||||
2. Create a new Gem - give it a title and description
|
||||
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
|
||||
4. Paste this content into Gemini to set up the team
|
||||
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
## Step 3: Back to Windsurf - Document Sharding
|
||||
|
||||
Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
|
||||
1. **Start a new chat in Windsurf**
|
||||
2. **Load the bmad-master agent**: Type `@bmad-master`
|
||||
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
## Step 4: Story Development Cycle
|
||||
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `@dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
4. **Follow the development tasks** the agent provides
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`@sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
4. **Start new chat with Dev agent** (`@dev`)
|
||||
5. **Implement the story**
|
||||
6. **Repeat until project complete**
|
||||
|
||||
## Available Agent Rules in Windsurf
|
||||
|
||||
All BMAD agents are available as Windsurf rules (use `@` prefix):
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master for story creation
|
||||
- `@dev` - Full-stack developer for implementation
|
||||
- `@architect` - Solution architect for design
|
||||
- `@pm` - Product manager for planning
|
||||
- `@analyst` - Business analyst for requirements
|
||||
- `@qa` - QA specialist for testing
|
||||
- `@po` - Product owner for prioritization
|
||||
- `@ux-expert` - UX specialist for design
|
||||
|
||||
## Windsurf-Specific Features
|
||||
|
||||
- **Agent rules are stored in**: `.windsurf/rules/` as `.md` files
|
||||
- **Rule activation**: Rules activate when you mention `@agent-name` in chat
|
||||
- **Collaborative workflow**: Windsurf's collaborative features work well with BMAD's agent-switching pattern
|
||||
- **Context awareness**: Agents have access to your project context
|
||||
|
||||
## Key Workflow Principles
|
||||
|
||||
1. **Always start new chats** when switching agents to avoid context confusion
|
||||
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
||||
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
||||
4. **Follow the SM → Dev cycle** for consistent story development
|
||||
5. **Review and approve stories** before implementation begins
|
||||
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Windsurf's collaboration**: Use the collaborative features for team reviews
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
@@ -1,22 +1,18 @@
|
||||
# Working in the Brownfield: A Complete Guide
|
||||
|
||||
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web for Brownfield Documentation!**
|
||||
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation!**
|
||||
>
|
||||
> Gemini Web's 1M+ token context window can analyze your ENTIRE codebase at once:
|
||||
> Gemini Web's 1M+ token context window or Gemini CLI (when its working) can analyze your ENTIRE codebase at once:
|
||||
>
|
||||
> - Upload via GitHub URL
|
||||
> - Upload up to 1000 files
|
||||
> - Upload zipped project
|
||||
>
|
||||
> This is MUCH more cost-effective than IDE analysis which reads files one by one!
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
Brownfield development refers to adding features, fixing bugs, or modernizing existing software projects. Unlike greenfield (new) projects, brownfield work requires understanding existing code, respecting constraints, and ensuring new changes integrate seamlessly without breaking existing functionality.
|
||||
|
||||
## When to Use BMAD for Brownfield
|
||||
|
||||
BMAD-METHOD excels at brownfield development when you need to:
|
||||
## When to Use BMad for Brownfield
|
||||
|
||||
- Add significant new features to existing applications
|
||||
- Modernize legacy codebases
|
||||
@@ -29,7 +25,7 @@ BMAD-METHOD excels at brownfield development when you need to:
|
||||
|
||||
### Choose Your Approach
|
||||
|
||||
#### Approach A: PRD-First (Recommended for Large Codebases/Monorepos)
|
||||
#### Approach A: PRD-First (Recommended if adding very large and complex new features, single or multiple epics or massive changes)
|
||||
|
||||
**Best for**: Large codebases, monorepos, or when you know exactly what you want to build
|
||||
|
||||
|
||||
Reference in New Issue
Block a user