Compare commits
72 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ffae072143 | ||
|
|
84e394ac11 | ||
|
|
b89aa48f7b | ||
|
|
731589aa28 | ||
|
|
b7361d244c | ||
|
|
b2f8525bbf | ||
|
|
1a4ca4ffa6 | ||
|
|
3e2e43dd88 | ||
|
|
6905fe72f6 | ||
|
|
95ab8bbd9c | ||
|
|
a1b30d9341 | ||
|
|
6e094c8359 | ||
|
|
86d5139aea | ||
|
|
62ccb640e6 | ||
|
|
9371a5784f | ||
|
|
62c5d92089 | ||
|
|
c48f200727 | ||
|
|
c151bda938 | ||
|
|
ab70b8dc73 | ||
|
|
0ec4ad26c2 | ||
|
|
c881dcc48f | ||
|
|
5aed8f7603 | ||
|
|
929461a2fe | ||
|
|
f5fa2559f0 | ||
|
|
ead2c04b5b | ||
|
|
b9970c9d73 | ||
|
|
8182a3f4bc | ||
|
|
2408068884 | ||
|
|
9cafbe7014 | ||
|
|
466bef4398 | ||
|
|
2ea806b3af | ||
|
|
60c147aa75 | ||
|
|
ba91cb17cf | ||
|
|
b82978fd38 | ||
|
|
50d17ed65d | ||
|
|
aa15b7a2ca | ||
|
|
c70f1a056b | ||
|
|
95e833beeb | ||
|
|
1ea367619a | ||
|
|
6cdecec61f | ||
|
|
a5915934fd | ||
|
|
b557570081 | ||
|
|
4bbb251730 | ||
|
|
3cb8c02747 | ||
|
|
b1c2de1fb5 | ||
|
|
263d9c7618 | ||
|
|
08f541195d | ||
|
|
ea945bb43f | ||
|
|
dd27531151 | ||
|
|
44b9d7bcb5 | ||
|
|
429a3d41e9 | ||
|
|
6dabbcb670 | ||
|
|
8cf9e5d916 | ||
|
|
3af3d33d4a | ||
|
|
fb0be544ad | ||
|
|
913dbeced6 | ||
|
|
00a9891793 | ||
|
|
47c33d6482 | ||
|
|
febe7e149d | ||
|
|
730d51eb95 | ||
|
|
45110ffffe | ||
|
|
c19772498a | ||
|
|
540578b39d | ||
|
|
5c8485d09f | ||
|
|
cd058ee7ed | ||
|
|
835075e992 | ||
|
|
2cf3ba1ab8 | ||
|
|
f217bdf07e | ||
|
|
c78a35f547 | ||
|
|
d619068ccc | ||
|
|
1e5c0b5351 | ||
|
|
1148b32fa9 |
15
.github/FUNDING.yml
vendored
Normal file
15
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
polar: # Replace with a single Polar username
|
||||
buy_me_a_coffee: bmad
|
||||
thanks_dev: # Replace with a single thanks.dev username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**Steps to Reproduce**
|
||||
What lead to the bug and can it be reliable recreated - if so with what steps.
|
||||
|
||||
**PR**
|
||||
If you have an idea to fix and would like to contribute, please indicate here you are working on a fix, or link to a proposed PR to fix the issue. Please review the contribution.md - contributions are always welcome!
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Please be Specific if relevant**
|
||||
Model(s) Used:
|
||||
Agentic IDE Used:
|
||||
WebSite Used:
|
||||
Project Language:
|
||||
BMad Method version:
|
||||
|
||||
**Screenshots or Links**
|
||||
If applicable, add screenshots or links (if web sharable record) to help explain your problem.
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here. The more information you can provide, the easier it will be to suggest a fix or resolve
|
||||
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
**Did you discuss the idea first in Discord Server (#general-dev)**
|
||||
Yes/No - Link to thread. If no, please after posting request also share the link in the channel so it can be easily discussed.
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -19,4 +19,9 @@ Thumbs.db
|
||||
CLAUDE.md
|
||||
.ai/*
|
||||
test-project-install/*
|
||||
sample-project/*
|
||||
sample-project/*
|
||||
.claude
|
||||
.bmad-core
|
||||
.bmad-creator-tools
|
||||
.gemini
|
||||
.bmad*/
|
||||
6
.vscode/extensions.json
vendored
6
.vscode/extensions.json
vendored
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"davidanson.vscode-markdownlint",
|
||||
"streetsidesoftware.code-spell-checker"
|
||||
]
|
||||
}
|
||||
81
.vscode/settings.json
vendored
81
.vscode/settings.json
vendored
@@ -1,76 +1,7 @@
|
||||
{
|
||||
"cSpell.words": [
|
||||
"agentic",
|
||||
"Axios",
|
||||
"biomimicry",
|
||||
"BMAD",
|
||||
"Brainwriting",
|
||||
"Centricity",
|
||||
"cicd",
|
||||
"dataclass",
|
||||
"docstrings",
|
||||
"emergently",
|
||||
"explorative",
|
||||
"fintech",
|
||||
"firmographic",
|
||||
"firmographics",
|
||||
"frontends",
|
||||
"gamedev",
|
||||
"golint",
|
||||
"Goroutines",
|
||||
"hotspots",
|
||||
"HSTS",
|
||||
"httpx",
|
||||
"Immer",
|
||||
"implementability",
|
||||
"Inclusivity",
|
||||
"Luxon",
|
||||
"MERN",
|
||||
"mgmt",
|
||||
"nodir",
|
||||
"Nuxt",
|
||||
"overcommitting",
|
||||
"pasteable",
|
||||
"pentest",
|
||||
"PESTEL",
|
||||
"Pino",
|
||||
"Polyrepo",
|
||||
"psychographics",
|
||||
"Pydantic",
|
||||
"pyproject",
|
||||
"reqs",
|
||||
"rescope",
|
||||
"roadmaps",
|
||||
"roleplay",
|
||||
"roomodes",
|
||||
"runbooks",
|
||||
"Serilog",
|
||||
"shadcn",
|
||||
"structlog",
|
||||
"subfolders",
|
||||
"Supabase",
|
||||
"Systemization",
|
||||
"taskroot",
|
||||
"Testcontainers",
|
||||
"tmpl",
|
||||
"tmplv",
|
||||
"touchpoints",
|
||||
"trpc",
|
||||
"Turborepo",
|
||||
"Underserved",
|
||||
"unredacted",
|
||||
"upgrader",
|
||||
"upgraders",
|
||||
"VARCHAR",
|
||||
"venv",
|
||||
"vercel",
|
||||
"Vite",
|
||||
"WCAG",
|
||||
"wireframes"
|
||||
],
|
||||
"markdownlint.config": {
|
||||
"MD033": {
|
||||
"allowed_elements": ["br", "div", "img", "rule", "sub"]
|
||||
}
|
||||
}
|
||||
}
|
||||
"cSpell.words": [
|
||||
"Agentic",
|
||||
"elicitations",
|
||||
"Shardable"
|
||||
]
|
||||
}
|
||||
189
CHANGELOG.md
189
CHANGELOG.md
@@ -1,3 +1,192 @@
|
||||
# [4.24.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.23.0...v4.24.0) (2025-07-02)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* corrected cursor agent update instructions ([84e394a](https://github.com/bmadcode/BMAD-METHOD/commit/84e394ac11136d9cf8164cefc9ca8e298e8ef0ec))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* workflow plans introduced, preliminary feature under review ([731589a](https://github.com/bmadcode/BMAD-METHOD/commit/731589aa287c31ea120e232b4dcc07e9790500ff))
|
||||
|
||||
# [4.23.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.1...v4.23.0) (2025-07-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* VS Code Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](https://github.com/bmadcode/BMAD-METHOD/commit/1a4ca4ffa630c2d4156bdd7a040d4c2274801757))
|
||||
|
||||
## [4.22.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.0...v4.22.1) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update expansion versions ([6905fe7](https://github.com/bmadcode/BMAD-METHOD/commit/6905fe72f6c2abefbfd65729d1be85752130a1d2))
|
||||
|
||||
# [4.22.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.2...v4.22.0) (2025-06-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* create doc more explicit and readme improvement ([a1b30d9](https://github.com/bmadcode/BMAD-METHOD/commit/a1b30d9341d2ceff79db2c7e178860c5ef0d99e5))
|
||||
|
||||
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* improve create-doc task clarity for template execution ([86d5139](https://github.com/bmadcode/BMAD-METHOD/commit/86d5139aea7097cc5d4ee9da0f7d3e395ce0835e))
|
||||
|
||||
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* readme clarifies that the installer handles installs upgrades and expansion installation ([9371a57](https://github.com/bmadcode/BMAD-METHOD/commit/9371a5784f6a6f2ad358a72ea0cde9c980357167))
|
||||
|
||||
# [4.21.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.20.0...v4.21.0) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove unneeded files ([c48f200](https://github.com/bmadcode/BMAD-METHOD/commit/c48f200727384f37a42f4c6b1a946cb90f2445fe))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* massive installer improvement update ([c151bda](https://github.com/bmadcode/BMAD-METHOD/commit/c151bda93833aa310ccc7c0eabcf483376f9e82a))
|
||||
|
||||
# [4.20.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.2...v4.20.0) (2025-06-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* 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. ([c881dcc](https://github.com/bmadcode/BMAD-METHOD/commit/c881dcc48ff827ddfe8653aa364a021a66ce66eb))
|
||||
|
||||
## [4.19.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.1...v4.19.2) (2025-06-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* docs update and correction ([2408068](https://github.com/bmadcode/BMAD-METHOD/commit/240806888448bb3a42acfd2f209976d489157e21))
|
||||
|
||||
## [4.19.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.19.0...v4.19.1) (2025-06-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* discord link ([2ea806b](https://github.com/bmadcode/BMAD-METHOD/commit/2ea806b3af58ad37fcb695146883a9cd3003363d))
|
||||
|
||||
# [4.19.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.18.0...v4.19.0) (2025-06-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* expansion install config ([50d17ed](https://github.com/bmadcode/BMAD-METHOD/commit/50d17ed65d40f6688f3b6e62732fb2280b6b116e))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* install for ide now sets up rules also for expansion agents! ([b82978f](https://github.com/bmadcode/BMAD-METHOD/commit/b82978fd38ea789a799ccc1373cfb61a2001c1e0))
|
||||
|
||||
# [4.18.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.17.0...v4.18.0) (2025-06-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* expansion teams can now include core agents and include their assets automatically ([c70f1a0](https://github.com/bmadcode/BMAD-METHOD/commit/c70f1a056b0f6e3c805096ee5d27f0a3640fb00c))
|
||||
* remove hardcoding from installer for agents, improve expansion pack installation to its own locations, common files moved to common folder ([95e833b](https://github.com/bmadcode/BMAD-METHOD/commit/95e833beebc3a60f73a7a1c67d534c8eb6bf48fd))
|
||||
|
||||
# [4.17.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.16.1...v4.17.0) (2025-06-27)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add GEMINI.md to agent context files ([#272](https://github.com/bmadcode/BMAD-METHOD/issues/272)) ([b557570](https://github.com/bmadcode/BMAD-METHOD/commit/b557570081149352e4efbef8046935650f6ecea1))
|
||||
|
||||
## [4.16.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.16.0...v4.16.1) (2025-06-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove accidental folder add ([b1c2de1](https://github.com/bmadcode/BMAD-METHOD/commit/b1c2de1fb58029f68e021faa90cd5d5faf345198))
|
||||
|
||||
# [4.16.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.15.0...v4.16.0) (2025-06-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* repo builds all rules sets for supported ides for easy copy if desired ([ea945bb](https://github.com/bmadcode/BMAD-METHOD/commit/ea945bb43f6ea50594910b954c72e79f96a8504c))
|
||||
|
||||
# [4.15.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.14.1...v4.15.0) (2025-06-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Add Gemini CLI Integration ([#271](https://github.com/bmadcode/BMAD-METHOD/issues/271)) ([44b9d7b](https://github.com/bmadcode/BMAD-METHOD/commit/44b9d7bcb5cbb6de5a15d8f2ec7918d186ac9576))
|
||||
|
||||
## [4.14.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.14.0...v4.14.1) (2025-06-26)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add updated web builds ([6dabbcb](https://github.com/bmadcode/BMAD-METHOD/commit/6dabbcb670ef22708db6c01dac82069547ca79d6))
|
||||
|
||||
# [4.14.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.13.0...v4.14.0) (2025-06-25)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* enhance QA agent as senior developer with code review capabilities and major brownfield improvements ([3af3d33](https://github.com/bmadcode/BMAD-METHOD/commit/3af3d33d4a40586479a382620687fa99a9f6a5f7))
|
||||
|
||||
# [4.13.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.12.0...v4.13.0) (2025-06-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **ide-setup:** add support for Cline IDE and configuration rules ([#262](https://github.com/bmadcode/BMAD-METHOD/issues/262)) ([913dbec](https://github.com/bmadcode/BMAD-METHOD/commit/913dbeced60ad65086df6233086d83a51ead81a9))
|
||||
|
||||
# [4.12.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.11.0...v4.12.0) (2025-06-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **dev-agent:** add quality gates to prevent task completion with failing validations ([#261](https://github.com/bmadcode/BMAD-METHOD/issues/261)) ([45110ff](https://github.com/bmadcode/BMAD-METHOD/commit/45110ffffe6d29cc08e227e22a901892185dfbd2))
|
||||
|
||||
# [4.11.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.3...v4.11.0) (2025-06-21)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* resolve web bundles directory path when using relative paths in NPX installer ([5c8485d](https://github.com/bmadcode/BMAD-METHOD/commit/5c8485d09ffec60ad4965ced62f4595890cb7535))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add markdown-tree integration for document sharding ([540578b](https://github.com/bmadcode/BMAD-METHOD/commit/540578b39d1815e41e11f0e87545de3f09ee54e1))
|
||||
|
||||
## [4.10.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.2...v4.10.3) (2025-06-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* bundle update ([2cf3ba1](https://github.com/bmadcode/BMAD-METHOD/commit/2cf3ba1ab8dd7e52584bef16a96e65e7d2513c4f))
|
||||
|
||||
## [4.10.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.1...v4.10.2) (2025-06-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* file formatting ([c78a35f](https://github.com/bmadcode/BMAD-METHOD/commit/c78a35f547459b07a15d94c827ec05921cd21571))
|
||||
|
||||
## [4.10.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.10.0...v4.10.1) (2025-06-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* SM sometimes would skip the rest of the epic stories, fixed ([1148b32](https://github.com/bmadcode/BMAD-METHOD/commit/1148b32fa97586d2f86d07a70ffbf9bb8c327261))
|
||||
|
||||
# [4.10.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.9.2...v4.10.0) (2025-06-19)
|
||||
|
||||
|
||||
|
||||
171
CONTRIBUTING.md
171
CONTRIBUTING.md
@@ -4,8 +4,15 @@ 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.
|
||||
|
||||
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
||||
|
||||
💬 **Discord Community**: Join our [Discord server](https://discord.gg/g6ypHytrCB) for real-time discussions:
|
||||
|
||||
- **#general-dev** - Technical discussions, feature ideas, and development questions
|
||||
- **#bugs-issues** - Bug reports and issue discussions
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
|
||||
@@ -14,18 +21,96 @@ By participating in this project, you agree to abide by our Code of Conduct. Ple
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
- Check if the bug has already been reported in the Issues section
|
||||
- Include detailed steps to reproduce the bug
|
||||
- Include any relevant logs or screenshots
|
||||
1. **Check existing issues** first to avoid duplicates
|
||||
2. **Use the bug report template** when creating a new issue - it will guide you through providing:
|
||||
- Clear bug description
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Model/IDE/BMad version details
|
||||
- Screenshots or links if applicable
|
||||
3. **Consider discussing in Discord** (#bugs-issues channel) for quick help
|
||||
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
||||
|
||||
### Suggesting Features
|
||||
|
||||
- Check if the feature has already been suggested in the Issues section, and consider using the discussions tab in GitHub also. Explain the feature in detail and why it would be valuable.
|
||||
1. **Discuss first in Discord** (#general-dev channel) - the feature request template asks if you've done this
|
||||
2. **Check existing issues and discussions** to avoid duplicates
|
||||
3. **Use the feature request template** when creating an issue - it will guide you through:
|
||||
- Confirming Discord discussion
|
||||
- Describing the problem it solves
|
||||
- Explaining your solution
|
||||
- Listing alternatives considered
|
||||
4. **Be specific** about why this feature would benefit the BMad community
|
||||
|
||||
### Pull Request Process
|
||||
|
||||
⚠️ **Before starting work:**
|
||||
|
||||
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
||||
2. **For features**: Ensure you've discussed in Discord (#general-dev) AND created a feature request issue
|
||||
3. **For large changes**: Always open an issue first to discuss alignment
|
||||
|
||||
Please only propose small granular commits! If its large or significant, please discuss in the discussions tab and open up an issue first. I do not want you to waste your time on a potentially very large PR to have it rejected because it is not aligned or deviates from other planned changes. Communicate and lets work together to build and improve this great community project!
|
||||
|
||||
**Important**: All contributions must align with our [Guiding Principles](GUIDING-PRINCIPLES.md). Key points:
|
||||
|
||||
- Keep dev agents lean - they need context for coding, not documentation
|
||||
- Web/planning agents can be larger with more complex tasks
|
||||
- Everything is natural language (markdown) - no code in core framework
|
||||
- Use expansion packs for domain-specific features
|
||||
|
||||
#### Which Branch for Your PR?
|
||||
|
||||
**Submit to `next` branch** (most contributions):
|
||||
|
||||
- ✨ New features or agents
|
||||
- 🎨 Enhancements to existing features
|
||||
- 📚 Documentation updates
|
||||
- ♻️ Code refactoring
|
||||
- ⚡ Performance improvements
|
||||
- 🧪 New tests
|
||||
- 🎁 New expansion packs
|
||||
|
||||
**Submit to `main` branch** (critical only):
|
||||
|
||||
- 🚨 Critical bug fixes that break basic functionality
|
||||
- 🔒 Security patches
|
||||
- 📚 Fixing dangerously incorrect documentation
|
||||
- 🐛 Bugs preventing installation or basic usage
|
||||
|
||||
**When in doubt, submit to `next`**. We'd rather test changes thoroughly before they hit stable.
|
||||
|
||||
#### PR Size Guidelines
|
||||
|
||||
- **Ideal PR size**: 200-400 lines of code changes
|
||||
- **Maximum PR size**: 800 lines (excluding generated files)
|
||||
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
|
||||
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
|
||||
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
|
||||
|
||||
#### Breaking Down Large PRs
|
||||
|
||||
If your change exceeds 800 lines, use this checklist to split it:
|
||||
|
||||
- [ ] Can I separate the refactoring from the feature implementation?
|
||||
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
|
||||
- [ ] Can I split by file or module?
|
||||
- [ ] Can I create a base PR with shared utilities first?
|
||||
- [ ] Can I separate test additions from implementation?
|
||||
- [ ] Even if changes are related, can they deliver value independently?
|
||||
- [ ] Can these changes be merged in any order without breaking things?
|
||||
|
||||
Example breakdown:
|
||||
|
||||
1. PR #1: Add utility functions and types (100 lines)
|
||||
2. PR #2: Refactor existing code to use utilities (200 lines)
|
||||
3. PR #3: Implement new feature using refactored code (300 lines)
|
||||
4. PR #4: Add comprehensive tests (200 lines)
|
||||
|
||||
**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value and don't depend on each other's merge order.
|
||||
|
||||
#### Pull Request Steps
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a new branch (`git checkout -b feature/your-feature-name`)
|
||||
3. Make your changes
|
||||
@@ -34,9 +119,85 @@ Please only propose small granular commits! If its large or significant, please
|
||||
6. Push to your branch (`git push origin feature/your-feature-name`)
|
||||
7. Open a Pull Request against the main branch
|
||||
|
||||
## Issue Templates
|
||||
|
||||
We use GitHub issue templates to ensure all necessary information is provided:
|
||||
|
||||
- **Bug Reports**: Automatically guides you through providing reproduction steps, environment details, and expected behavior
|
||||
- **Feature Requests**: Requires Discord discussion confirmation and asks for problem/solution descriptions
|
||||
|
||||
Using these templates helps maintainers understand and address your contribution faster.
|
||||
|
||||
## Pull Request Description Guidelines
|
||||
|
||||
Keep PR descriptions short and to the point following this template:
|
||||
|
||||
### PR Description Template
|
||||
|
||||
Keep your PR description concise and focused. Use this template:
|
||||
|
||||
```markdown
|
||||
## What
|
||||
|
||||
[1-2 sentences describing WHAT changed]
|
||||
|
||||
## Why
|
||||
|
||||
[1-2 sentences explaining WHY this change is needed]
|
||||
Fixes #[issue number] (if applicable)
|
||||
|
||||
## How
|
||||
|
||||
[2-3 bullets listing HOW you implemented it]
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## Testing
|
||||
|
||||
[1-2 sentences on how you tested this]
|
||||
```
|
||||
|
||||
**Maximum PR description length: 200 words** (excluding code examples if needed)
|
||||
|
||||
### Good vs Bad PR Descriptions
|
||||
|
||||
❌ **Bad Example:**
|
||||
|
||||
> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics and deliver unprecedented value to stakeholders through innovative approaches...
|
||||
|
||||
✅ **Good Example:**
|
||||
|
||||
> **What:** Added validation for agent dependency resolution
|
||||
> **Why:** Build was failing silently when agents had circular dependencies
|
||||
> **How:**
|
||||
>
|
||||
> - Added cycle detection in dependency-resolver.js
|
||||
> - Throws clear error with dependency chain
|
||||
> **Testing:** Tested with circular deps between 3 agents
|
||||
|
||||
## Commit Message Convention
|
||||
|
||||
PRs with a wall of AI Generated marketing hype that is unclear in what is being proposed will be closed and rejected. Your best change to contribute is with a small clear PR description explaining, what is the issue being solved or gap in the system being filled. Also explain how it leads to the core guiding principles of the project.
|
||||
Use conventional commits format:
|
||||
|
||||
- `feat:` New feature
|
||||
- `fix:` Bug fix
|
||||
- `docs:` Documentation only
|
||||
- `refactor:` Code change that neither fixes a bug nor adds a feature
|
||||
- `test:` Adding missing tests
|
||||
- `chore:` Changes to build process or auxiliary tools
|
||||
|
||||
Keep commit messages under 72 characters.
|
||||
|
||||
### Atomic Commits
|
||||
|
||||
Each commit should represent one logical change:
|
||||
|
||||
- **Do:** One bug fix per commit
|
||||
- **Do:** One feature addition per commit
|
||||
- **Don't:** Mix refactoring with bug fixes
|
||||
- **Don't:** Combine unrelated changes
|
||||
|
||||
## Code Style
|
||||
|
||||
|
||||
85
GUIDING-PRINCIPLES.md
Normal file
85
GUIDING-PRINCIPLES.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# 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.
|
||||
|
||||
## Core Principles
|
||||
|
||||
### 1. Dev Agents Must Be Lean
|
||||
|
||||
- **Minimize dev agent dependencies**: Development agents that work in IDEs must have minimal context overhead
|
||||
- **Save context for code**: Every line counts - dev agents should focus on coding, not documentation
|
||||
- **Web agents can be larger**: Planning agents (PRD Writer, Architect) used in web UI can have more complex tasks and dependencies
|
||||
- **Small files, loaded on demand**: Multiple small, focused files are better than large files with many branches
|
||||
|
||||
### 2. Natural Language First
|
||||
|
||||
- **Everything is markdown**: Agents, tasks, templates - all written in plain English
|
||||
- **No code in core**: The framework itself contains no programming code, only natural language instructions
|
||||
- **Self-contained templates**: Templates include their own generation instructions using `[[LLM: ...]]` markup
|
||||
|
||||
### 3. Agent and Task Design
|
||||
|
||||
- **Agents define roles**: Each agent is a persona with specific expertise (e.g., Frontend Developer, API Developer)
|
||||
- **Tasks are procedures**: Step-by-step instructions an agent follows to complete work
|
||||
- **Templates are outputs**: Structured documents with embedded instructions for generation
|
||||
- **Dependencies matter**: Explicitly declare only what's needed
|
||||
|
||||
## Practical Guidelines
|
||||
|
||||
### When to Add to Core
|
||||
|
||||
- Universal software development needs only
|
||||
- Doesn't bloat dev agent contexts
|
||||
- Follows existing agent/task/template patterns
|
||||
|
||||
### When to Create Expansion Packs
|
||||
|
||||
- Domain-specific needs beyond software development
|
||||
- Non-technical domains (business, wellness, education, creative)
|
||||
- Specialized technical domains (games, infrastructure, mobile)
|
||||
- Heavy documentation or knowledge bases
|
||||
- Anything that would bloat core agents
|
||||
|
||||
See [Expansion Packs Guide](../docs/expansion-packs.md) for detailed examples and ideas.
|
||||
|
||||
### Agent Design Rules
|
||||
|
||||
1. **Web/Planning Agents**: Can have richer context, multiple tasks, extensive templates
|
||||
2. **Dev Agents**: Minimal dependencies, focused on code generation, lean task sets
|
||||
3. **All Agents**: Clear persona, specific expertise, well-defined capabilities
|
||||
|
||||
### Task Writing Rules
|
||||
|
||||
1. Write clear step-by-step procedures
|
||||
2. Use markdown formatting for readability
|
||||
3. Keep dev agent tasks focused and concise
|
||||
4. Planning tasks can be more elaborate
|
||||
5. **Prefer multiple small tasks over one large branching task**
|
||||
- Instead of one task with many conditional paths
|
||||
- Create multiple focused tasks the agent can choose from
|
||||
- This keeps context overhead minimal
|
||||
6. **Reuse common tasks** - Don't create new document creation tasks
|
||||
- Use the existing `create-doc` task
|
||||
- Pass the appropriate template with embedded LLM instructions
|
||||
- This maintains consistency and reduces duplication
|
||||
|
||||
### Template Rules
|
||||
|
||||
1. Include generation instructions with `[[LLM: ...]]` markup
|
||||
2. Provide clear structure for output
|
||||
3. Make templates reusable across agents
|
||||
4. Use standardized markup elements:
|
||||
- `{{placeholders}}` for variables to be replaced
|
||||
- `[[LLM: instructions]]` for AI-only processing (never shown to users)
|
||||
- `REPEAT` sections for repeatable content blocks
|
||||
- `^^CONDITION^^` blocks for conditional content
|
||||
- `@{examples}` for guidance examples (never output to users)
|
||||
5. NEVER display template markup or LLM instructions to users
|
||||
6. Focus on clean output - all processing instructions stay internal
|
||||
|
||||
## Remember
|
||||
|
||||
- The power is in natural language orchestration, not code
|
||||
- Dev agents code, planning agents plan
|
||||
- Keep dev agents lean for maximum coding efficiency
|
||||
- Expansion packs handle specialized domains
|
||||
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
|
||||
|
||||
453
README.md
453
README.md
@@ -1,76 +1,141 @@
|
||||
# BMAD-METHOD
|
||||
# BMad-METHOD: Universal AI Agent Framework
|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/g6ypHytrCB)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
|
||||
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)** - V4 walkthrough and comprehensive guide coming soon!
|
||||
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
||||
|
||||
⭐ **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!
|
||||
**[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!
|
||||
|
||||
## 🔄 Important: Keeping Your BMAD Installation Updated
|
||||
⭐ **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!
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD installed in your project, simply run:
|
||||
## Quick Navigation
|
||||
|
||||
### 🚨 MUST READ: Understanding the BMAD Workflow
|
||||
|
||||
**Before diving in, review these critical workflow diagrams that explain how BMAD works:**
|
||||
|
||||
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** - [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/)
|
||||
|
||||
### Quick Links
|
||||
|
||||
- **[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: Keep 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
|
||||
git pull
|
||||
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
|
||||
## Quick Start
|
||||
|
||||
### Fastest Start: Web UI (2 minutes) 🏃♂️
|
||||
### One Command for Everything (IDE Installation)
|
||||
|
||||
**Just run one of these commands:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR if you already have BMad installed:
|
||||
git pull
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
This single command handles:
|
||||
|
||||
- **New installations** - Sets up BMad in your project
|
||||
- **Upgrades** - Updates existing installations automatically
|
||||
- **Expansion packs** - Installs any expansion packs you've added to package.json
|
||||
|
||||
> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
|
||||
|
||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
||||
|
||||
### Fastest Start: Web UI (2 minutes)
|
||||
|
||||
1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
|
||||
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
||||
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
||||
|
||||
> 💡 **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
||||
> **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
||||
|
||||
### IDE Quick Start (5 minutes) 💻
|
||||
### Alternative: Clone and Build
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) (v20 or higher)
|
||||
|
||||
Run `npx bmad-method install`
|
||||
|
||||
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)
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
|
||||
## 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, and Windsurf
|
||||
- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
|
||||
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
|
||||
|
||||
### Method 1: Pre-Built Web Bundles (Fastest) 📦
|
||||
### Method 1: CLI Installer (For IDEs)
|
||||
|
||||
**Just run one command:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR if you already have BMad installed:
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
**This single command does everything:**
|
||||
|
||||
- Installs BMad for the first time
|
||||
- Updates existing installations
|
||||
- Adds any expansion packs from your package.json
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
||||
|
||||
### Method 2: Pre-Built Web Bundles (For Web UI)
|
||||
|
||||
For ChatGPT, Claude, or Gemini web interfaces:
|
||||
|
||||
@@ -81,49 +146,73 @@ For ChatGPT, Claude, or Gemini web interfaces:
|
||||
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. Type `/help` to see available commands
|
||||
|
||||
### Method 2: CLI Installer (For IDEs) 🎯
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
||||
|
||||
Install directly into your project: `npx bmad-method install`
|
||||
|
||||
**Supported IDEs:**
|
||||
|
||||
The BMad Method works with any IDE, but has built-in integration for:
|
||||
|
||||
- `cursor` - Cursor IDE with @agent commands
|
||||
- `cursor` - Cursor IDE with manual rule @agent commands
|
||||
- `claude-code` - Claude Code with /agent commands
|
||||
- `windsurf` - Windsurf with @agent commands
|
||||
- `cline` - Cline Rules integration
|
||||
- `gemini-cli` - Gemini with @agent commands
|
||||
- `windsurf` - Windsurf with manual rule @agent commands
|
||||
- `roo` - Roo Code with custom modes (see `.roomodes`)
|
||||
- More coming soon - BUT ITS easy to use with ANY IDE - just copy the bmad-code folder to your project, and rename it .bmad-code.
|
||||
- `vs-code-copilot` - VS Code with GitHub Copilot agent mode integration
|
||||
|
||||
## Available Agents
|
||||
|
||||
### 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 |
|
||||
| `ux-expert` | UX Designer | User experience, UI design, prototypes |
|
||||
| `po` | Product Owner | Backlog management, story validation |
|
||||
| `sm` | Scrum Master | Sprint planning, story creation |
|
||||
| Agent | Role | Specialty |
|
||||
| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| Agent | Role | Specialty |
|
||||
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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
|
||||
|
||||
### With IDE Integration
|
||||
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)**.
|
||||
|
||||
After installation with `--ide` flag:
|
||||
### Quick Start Examples
|
||||
|
||||
#### With IDE Integration
|
||||
|
||||
```bash
|
||||
# In Cursor
|
||||
@@ -136,118 +225,29 @@ After installation with `--ide` flag:
|
||||
@dev Implement story 1.3
|
||||
```
|
||||
|
||||
### With Web UI (ChatGPT/Claude/Gemini)
|
||||
#### With Web UI
|
||||
|
||||
After uploading a bundle you can ask /help of the agent to learn what it can do
|
||||
After uploading a bundle, type `/help` to see available commands.
|
||||
|
||||
### CLI Commands
|
||||
### Key Resources
|
||||
|
||||
```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
|
||||
- **[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
|
||||
|
||||
```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
|
||||
See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
|
||||
|
||||
tools/
|
||||
├── cli.js # Build tool
|
||||
├── installer/ # NPX installer
|
||||
└── lib/ # Build utilities
|
||||
### Key Directories
|
||||
|
||||
expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
|
||||
|
||||
dist/ # 📦 PRE-BUILT BUNDLES (Ready to use!)
|
||||
├── agents/ # Individual agent bundles (.txt files)
|
||||
├── teams/ # Team bundles (.txt files)
|
||||
└── expansion-packs/ # Expansion pack bundles
|
||||
```
|
||||
- **`.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)
|
||||
|
||||
@@ -269,55 +269,62 @@ dist/ # 📦 PRE-BUILT BUNDLES (Ready to use!)
|
||||
|
||||
**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 welcome contributions!
|
||||
|
||||
- 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
- See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines
|
||||
|
||||
### Development Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
cd bmad-method
|
||||
npm install
|
||||
```
|
||||
|
||||
## 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
|
||||
- 🎯 [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
|
||||
- 🏗️ [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
|
||||
- 💻 [VS Code Copilot Guide](docs/agentic-tools/vs-code-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
||||
|
||||
## 🌟 Beyond Software Development - Expansion Packs
|
||||
|
||||
While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMAD into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
|
||||
|
||||
### Available Expansion Packs
|
||||
|
||||
#### Technical Domains
|
||||
|
||||
- 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
|
||||
- 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
|
||||
- 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
|
||||
- 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
|
||||
|
||||
#### Non-Technical Domains
|
||||
|
||||
- 💼 **Business Strategy** - Strategic planners, market analysts, business coaches
|
||||
- 💪 **Health & Wellness** - Fitness coaches, nutrition advisors, meditation guides
|
||||
- 🎨 **Creative Arts** - Story writers, world builders, character developers
|
||||
- 📚 **Education** - Curriculum designers, tutors, learning coaches
|
||||
- 🧠 **Personal Development** - Life coaches, goal setters, habit builders
|
||||
- 🏢 **Professional Services** - Legal advisors, content creators, research assistants
|
||||
|
||||
### Creating Your Own Expansion Pack
|
||||
|
||||
Transform your expertise into AI agents:
|
||||
|
||||
1. **Identify your domain** - What knowledge do you want to share?
|
||||
2. **Design specialized agents** - Each with unique expertise and personality
|
||||
3. **Create reusable tasks** - Standard procedures in your field
|
||||
4. **Build professional templates** - Structured outputs for consistency
|
||||
5. **Share with the community** - Help others benefit from your expertise
|
||||
|
||||
📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
|
||||
|
||||
## Support
|
||||
|
||||
@@ -344,7 +351,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)
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ agent:
|
||||
id: analyst
|
||||
title: Business Analyst
|
||||
icon: 📊
|
||||
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery
|
||||
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, initial project discovery, and documenting existing projects (brownfield)
|
||||
customization: null
|
||||
persona:
|
||||
role: Insightful Analyst & Strategic Ideation Partner
|
||||
@@ -44,6 +44,7 @@ commands: # All commands require * prefix when used (e.g., *help)
|
||||
- brainstorm {topic}: Facilitate structured brainstorming session
|
||||
- research {topic}: Generate deep research prompt for investigation
|
||||
- elicit: Run advanced elicitation to clarify requirements
|
||||
- document-project: Analyze and document existing project structure comprehensively
|
||||
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
@@ -51,6 +52,7 @@ dependencies:
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- advanced-elicitation
|
||||
- document-project
|
||||
templates:
|
||||
- project-brief-tmpl
|
||||
- market-research-tmpl
|
||||
|
||||
@@ -26,6 +26,9 @@ persona:
|
||||
- Process (*) commands immediately
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
- "If plan exists: Show brief status - Active plan detected: {workflow} - {progress}%"
|
||||
- "If plan exists: Suggest next step based on plan"
|
||||
- CRITICAL: Do NOT scan filesystem or load any resources during startup
|
||||
- CRITICAL: Do NOT run discovery tasks automatically
|
||||
- Wait for user request before any tool use
|
||||
@@ -37,16 +40,24 @@ commands: # All commands require * prefix when used (e.g., *help)
|
||||
- status: Current context
|
||||
- task {template|util|checklist|workflow}: Execute
|
||||
- list {task|template|util|checklist|workflow}: List resources by type
|
||||
- plan: Create workflow plan (for complex projects)
|
||||
- plan-status: Show current workflow plan progress
|
||||
- plan-update: Update workflow plan status
|
||||
- exit: Exit (confirm)
|
||||
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
|
||||
- doc-out: Output full document
|
||||
fuzzy-matching:
|
||||
- 85% confidence threshold
|
||||
- Show numbered list if unsure
|
||||
workflow-guidance:
|
||||
- When user asks about workflows, offer: "Would you like me to create a workflow plan first? (*plan)"
|
||||
- For complex projects, suggest planning before execution
|
||||
- Plan command maps to create-workflow-plan task
|
||||
execution:
|
||||
- NEVER use tools during startup - only announce and wait
|
||||
- Runtime discovery ONLY when user requests specific resources
|
||||
- Workflow: User request → Runtime discovery → Load resource → Execute instructions → Guide inputs → Provide feedback
|
||||
- For workflow requests: Suggest *plan command first for complex projects
|
||||
- Suggest related resources after completion
|
||||
dependencies:
|
||||
tasks:
|
||||
@@ -58,12 +69,14 @@ dependencies:
|
||||
- correct-course
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- create-workflow-plan
|
||||
- document-project
|
||||
- create-next-story
|
||||
- execute-checklist
|
||||
- generate-ai-frontend-prompt
|
||||
- index-docs
|
||||
- shard-doc
|
||||
- update-workflow-plan
|
||||
templates:
|
||||
- agent-tmpl
|
||||
- architecture-tmpl
|
||||
@@ -81,7 +94,7 @@ dependencies:
|
||||
- bmad-kb
|
||||
- technical-preferences
|
||||
utils:
|
||||
- agent-switcher.ide
|
||||
- plan-management
|
||||
- template-format
|
||||
- workflow-management
|
||||
workflows:
|
||||
|
||||
@@ -31,6 +31,9 @@ startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
- "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
|
||||
- "If plan exists: Suggest next action based on plan progress"
|
||||
- Assess user goal against available agents and workflows in this bundle
|
||||
- If clear match to an agent's expertise, suggest transformation with *agent command
|
||||
- If project-oriented, suggest *workflow-guidance to explore options
|
||||
@@ -45,6 +48,9 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
||||
task: Run a specific task (list if name not specified)
|
||||
workflow: Start a specific workflow (list if name not specified)
|
||||
workflow-guidance: Get personalized help selecting the right workflow
|
||||
plan: Create detailed workflow plan before starting
|
||||
plan-status: Show current workflow plan progress
|
||||
plan-update: Update workflow plan status
|
||||
checklist: Execute a checklist (list if name not specified)
|
||||
yolo: Toggle skip confirmations mode
|
||||
party-mode: Group chat with all agents
|
||||
@@ -68,6 +74,9 @@ help-display-template: |
|
||||
Workflow Commands:
|
||||
*workflow [name] .... Start specific workflow (list if no name)
|
||||
*workflow-guidance .. Get personalized help selecting the right workflow
|
||||
*plan ............... Create detailed workflow plan before starting
|
||||
*plan-status ........ Show current workflow plan progress
|
||||
*plan-update ........ Update workflow plan status
|
||||
|
||||
Other Commands:
|
||||
*yolo ............... Toggle skip confirmations mode
|
||||
@@ -109,6 +118,8 @@ workflow-guidance:
|
||||
- Understand each workflow's purpose, options, and decision points
|
||||
- Ask clarifying questions based on the workflow's structure
|
||||
- Guide users through workflow selection when multiple options exist
|
||||
- For complex projects, offer to create a workflow plan using create-workflow-plan task
|
||||
- When appropriate, suggest: "Would you like me to create a detailed workflow plan before starting?"
|
||||
- For workflows with divergent paths, help users choose the right path
|
||||
- Adapt questions to the specific domain (e.g., game dev vs infrastructure vs web dev)
|
||||
- Only recommend workflows that actually exist in the current bundle
|
||||
@@ -117,10 +128,13 @@ dependencies:
|
||||
tasks:
|
||||
- advanced-elicitation
|
||||
- create-doc
|
||||
- create-workflow-plan
|
||||
- kb-mode-interaction
|
||||
- update-workflow-plan
|
||||
data:
|
||||
- bmad-kb
|
||||
utils:
|
||||
- plan-management
|
||||
- workflow-management
|
||||
- template-format
|
||||
```
|
||||
|
||||
@@ -32,6 +32,7 @@ core_principles:
|
||||
- CRITICAL: Dev Record Only - ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
|
||||
- Strive for Sequential Task Execution - Complete tasks 1-by-1 and mark [x] as completed
|
||||
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
|
||||
- Quality Gate Discipline - NEVER complete tasks with failing automated validations
|
||||
- Debug Log Discipline - Log temp changes to md table in devDebugLog. Revert after fix.
|
||||
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
|
||||
- Code Excellence - Clean, secure, maintainable code per loaded standards
|
||||
@@ -45,15 +46,16 @@ commands: # All commands require * prefix when used (e.g., *help)
|
||||
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
||||
|
||||
task-execution:
|
||||
flow: "Read task→Implement→Write tests→Pass tests→Update [x]→Next task"
|
||||
flow: "Read task→Implement→Write tests→Execute validations→Only if ALL pass→Update [x]→Next task"
|
||||
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"
|
||||
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config"
|
||||
done: "Code matches reqs + Tests pass + Follows standards + No lint errors"
|
||||
completion: "All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT"
|
||||
- "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"
|
||||
done: "Code matches reqs + All validations pass + Follows standards + File List complete"
|
||||
completion: "All [x]→Validations pass→Integration(if noted)→E2E(if noted)→DoD→Update File List→Mark Ready for Review→HALT"
|
||||
|
||||
dependencies:
|
||||
tasks:
|
||||
|
||||
@@ -14,34 +14,35 @@ activation-instructions:
|
||||
agent:
|
||||
name: Quinn
|
||||
id: qa
|
||||
title: Quality Assurance Test Architect
|
||||
title: Senior Developer & QA Architect
|
||||
icon: 🧪
|
||||
whenToUse: Use for test planning, test case creation, quality assurance, bug reporting, and testing strategy
|
||||
whenToUse: Use for senior code review, refactoring, test planning, quality assurance, and mentoring through code improvements
|
||||
customization: null
|
||||
persona:
|
||||
role: Test Architect & Automation Expert
|
||||
style: Methodical, detail-oriented, quality-focused, strategic
|
||||
identity: Senior quality advocate with expertise in test architecture and automation
|
||||
focus: Comprehensive testing strategies, automation frameworks, quality assurance at every phase
|
||||
role: Senior Developer & Test Architect
|
||||
style: Methodical, detail-oriented, quality-focused, mentoring, strategic
|
||||
identity: Senior developer with deep expertise in code quality, architecture, and test automation
|
||||
focus: Code excellence through review, refactoring, and comprehensive testing strategies
|
||||
core_principles:
|
||||
- Senior Developer Mindset - Review and improve code as a senior mentoring juniors
|
||||
- Active Refactoring - Don't just identify issues, fix them with clear explanations
|
||||
- Test Strategy & Architecture - Design holistic testing strategies across all levels
|
||||
- Automation Excellence - Build maintainable and efficient test automation frameworks
|
||||
- Code Quality Excellence - Enforce best practices, patterns, and clean code principles
|
||||
- Shift-Left Testing - Integrate testing early in development lifecycle
|
||||
- Performance & Security - Proactively identify and fix performance/security issues
|
||||
- Mentorship Through Action - Explain WHY and HOW when making improvements
|
||||
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
||||
- Performance & Load Testing - Ensure systems meet performance requirements
|
||||
- Security Testing Integration - Incorporate security testing into QA process
|
||||
- Test Data Management - Design strategies for realistic and compliant test data
|
||||
- Continuous Testing & CI/CD - Integrate tests seamlessly into pipelines
|
||||
- Quality Metrics & Reporting - Track meaningful metrics and provide insights
|
||||
- Cross-Browser & Cross-Platform Testing - Ensure comprehensive compatibility
|
||||
- Continuous Improvement - Balance perfection with pragmatism
|
||||
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands: # All commands require * prefix when used (e.g., *help)
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- review-story
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
|
||||
@@ -1,26 +1,25 @@
|
||||
core-project-information:
|
||||
dev-story-location: docs/stories # alternate could be .ai/stories if preferred for example
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs/prd
|
||||
epicFilePattern: epic-{n}*.md
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
# if you have a front-end architecture document, uncomment the following and validate the file path
|
||||
# front-end-architecture:
|
||||
# front-end-architecture-file: docs/front-end-architecture.md
|
||||
# architectureVersion: v4
|
||||
# architectureSharded: true
|
||||
# architectureShardedLocation: docs/architecture
|
||||
customTechnicalDocuments: null # list other documents only if you want the SM to read them when creating stories
|
||||
devLoadAlwaysFiles:
|
||||
- docs/architecture/coding-standards.md
|
||||
- docs/architecture/tech-stack.md
|
||||
- docs/architecture/project-structure.md
|
||||
devDebugLog: .ai/debug-log.md
|
||||
agentCoreDump: .ai/core-dump{n}.md
|
||||
version: 4.21.1
|
||||
markdownExploder: true
|
||||
prd:
|
||||
prdFile: docs/prd.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs/prd
|
||||
epicFilePattern: epic-{n}*.md
|
||||
architecture:
|
||||
architectureFile: docs/architecture.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
customTechnicalDocuments: null
|
||||
devLoadAlwaysFiles:
|
||||
- docs/architecture/coding-standards.md
|
||||
- docs/architecture/tech-stack.md
|
||||
- docs/architecture/source-tree.md
|
||||
devDebugLog: .ai/debug-log.md
|
||||
devStoryLocation: docs/stories
|
||||
workflow:
|
||||
planFile: docs/workflow-plan.md
|
||||
trackProgress: true
|
||||
enforceSequence: false
|
||||
updateOnCompletion: true
|
||||
|
||||
@@ -20,6 +20,50 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
|
||||
4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
|
||||
|
||||
### The Two-Phase Approach
|
||||
|
||||
**Phase 1: Planning (Web UI - Cost Effective)**
|
||||
- Use large context windows (Gemini's 1M tokens)
|
||||
- Generate comprehensive documents (PRD, Architecture)
|
||||
- Leverage multiple agents for brainstorming
|
||||
- Create once, use throughout development
|
||||
|
||||
**Phase 2: Development (IDE - Implementation)**
|
||||
- Shard documents into manageable pieces
|
||||
- Execute focused SM → Dev cycles
|
||||
- One story at a time, sequential progress
|
||||
- Real-time file operations and testing
|
||||
|
||||
### The Development Loop
|
||||
|
||||
```text
|
||||
1. SM Agent (New Chat) → Creates next story from sharded docs
|
||||
2. You → Review and approve story
|
||||
3. Dev Agent (New Chat) → Implements approved story
|
||||
4. QA Agent (New Chat) → Reviews and refactors code
|
||||
5. You → Verify completion
|
||||
6. Repeat until epic complete
|
||||
```
|
||||
|
||||
### Why This Works
|
||||
|
||||
- **Context Optimization**: Clean chats = better AI performance
|
||||
- **Role Clarity**: Agents don't context-switch = higher quality
|
||||
- **Incremental Progress**: Small stories = manageable complexity
|
||||
- **Human Oversight**: You validate each step = quality control
|
||||
- **Document-Driven**: Specs guide everything = consistency
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Quick Start Options
|
||||
@@ -34,7 +78,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -43,13 +87,23 @@ npx bmad-method install
|
||||
|
||||
**Installation Steps**:
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
||||
- Select your IDE from supported options:
|
||||
- **Cursor**: Native AI integration
|
||||
- **Claude Code**: Anthropic's official IDE
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
|
||||
**Note for VS Code Users**: BMAD-METHOD assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMAD agents. The installer includes built-in support for Cline and Roo.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**Remember**: At its core, BMAD-METHOD is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMAD - the framework provides the structured prompts and workflows that make AI development effective
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
**Use Web UI for**:
|
||||
@@ -66,6 +120,47 @@ npx bmad-method install
|
||||
|
||||
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
|
||||
|
||||
### IDE-Only Workflow Considerations
|
||||
|
||||
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
||||
|
||||
**Pros of IDE-Only**:
|
||||
- Single environment workflow
|
||||
- Direct file operations from start
|
||||
- No copy/paste between environments
|
||||
- Immediate project integration
|
||||
|
||||
**Cons of IDE-Only**:
|
||||
- Higher token costs for large document creation
|
||||
- Smaller context windows (varies by IDE/model)
|
||||
- May hit limits during planning phases
|
||||
- Less cost-effective for brainstorming
|
||||
|
||||
**Using Web Agents in IDE**:
|
||||
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
||||
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
||||
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
||||
|
||||
**About bmad-master and bmad-orchestrator**:
|
||||
- **bmad-master**: CAN do any task without switching agents, BUT...
|
||||
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
||||
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
||||
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
||||
|
||||
**CRITICAL RULE for Development**:
|
||||
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
||||
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
||||
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
||||
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
||||
|
||||
**Best Practice for IDE-Only**:
|
||||
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
||||
2. Create documents directly in project
|
||||
3. Shard immediately after creation
|
||||
4. **MUST switch to SM agent** for story creation
|
||||
5. **MUST switch to Dev agent** for implementation
|
||||
6. Keep planning and coding in separate chat sessions
|
||||
|
||||
## Core Configuration (core-config.yml)
|
||||
|
||||
**New in V4**: The `bmad-core/core-config.yml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
@@ -184,6 +279,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -306,10 +402,16 @@ This architecture enables seamless operation across environments while maintaini
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
### Planning Phase (Web UI Recommended)
|
||||
### Planning Phase (Web UI Recommended - Especially Gemini!)
|
||||
|
||||
**Ideal for cost efficiency, especially with Gemini:**
|
||||
**Ideal for cost efficiency with Gemini's massive context:**
|
||||
|
||||
**For Brownfield Projects - Start Here!**:
|
||||
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Document existing system**: `/analyst` → `*document-project`
|
||||
3. **Creates comprehensive docs** from entire codebase analysis
|
||||
|
||||
**For All Projects**:
|
||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||
@@ -343,10 +445,14 @@ that can handle [specific requirements]."
|
||||
|
||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||
|
||||
1. **Document Sharding**:
|
||||
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
|
||||
- If architecture exists, shard to `docs/architecture/` folder
|
||||
- Results in multiple manageable documents and epic files
|
||||
1. **Document Sharding** (CRITICAL STEP):
|
||||
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
||||
- Two methods to shard:
|
||||
a) **Manual**: Drag `shard-doc` task + document file into chat
|
||||
b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
|
||||
- Shards `docs/prd.md` → `docs/prd/` folder
|
||||
- Shards `docs/architecture.md` → `docs/architecture/` folder
|
||||
- **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
|
||||
|
||||
2. **Verify Sharded Content**:
|
||||
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
||||
@@ -360,19 +466,34 @@ that can handle [specific requirements]."
|
||||
|
||||
3. **Development Cycle** (Sequential, one story at a time):
|
||||
|
||||
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
|
||||
**CRITICAL CONTEXT MANAGEMENT**:
|
||||
- **Context windows matter!** Always use fresh, clean context windows
|
||||
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
||||
- **ALWAYS start new chat between SM, Dev, and QA work**
|
||||
|
||||
**Step 1 - Story Creation**:
|
||||
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
||||
- SM executes create-next-story task
|
||||
- Review generated story in `docs/stories/`
|
||||
- Update status from "Draft" to "Approved"
|
||||
|
||||
**Step 2 - Story Implementation**: New chat window → `@dev`
|
||||
**Step 2 - Story Implementation**:
|
||||
- **NEW CLEAN CHAT** → `@dev`
|
||||
- Agent asks which story to implement
|
||||
- Include story file content to save dev agent lookup time
|
||||
- Dev follows tasks/subtasks, marking completion
|
||||
- Dev leaves notes for SM about any deviations
|
||||
- Update status to "Done"
|
||||
- Dev maintains File List of all changes
|
||||
- Dev marks story as "Review" when complete with all tests passing
|
||||
|
||||
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
|
||||
**Step 3 - Senior QA Review**:
|
||||
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
||||
- QA performs senior developer code review
|
||||
- QA can refactor and improve code directly
|
||||
- QA appends results to story's QA Results section
|
||||
- If approved: Status → "Done"
|
||||
- If changes needed: Status stays "Review" with unchecked items for dev
|
||||
|
||||
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
||||
|
||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||
|
||||
@@ -392,12 +513,72 @@ Each status change requires user verification and approval before proceeding.
|
||||
- Development execution
|
||||
- Testing and deployment
|
||||
|
||||
#### Brownfield Enhancement
|
||||
- Current system analysis
|
||||
- Enhancement planning
|
||||
- Impact assessment
|
||||
- Incremental development
|
||||
- Integration testing
|
||||
#### Brownfield Enhancement (Existing Projects)
|
||||
|
||||
**Key Concept**: Brownfield development requires comprehensive documentation of your existing project for AI agents to understand context, patterns, and constraints.
|
||||
|
||||
**Complete Brownfield Workflow Options**:
|
||||
|
||||
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
||||
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
||||
3. **Focused documentation**: `@analyst` → `*document-project`
|
||||
- Analyst asks for focus if no PRD provided
|
||||
- Choose "single document" format for Web UI
|
||||
- Uses PRD to document ONLY relevant areas
|
||||
- Creates one comprehensive markdown file
|
||||
- Avoids bloating docs with unused code
|
||||
|
||||
**Option 2: Document-First (Good for Smaller Projects)**:
|
||||
1. **Upload project to Gemini Web**
|
||||
2. **Document everything**: `@analyst` → `*document-project`
|
||||
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
||||
- More thorough but can create excessive documentation
|
||||
|
||||
2. **Requirements Gathering**:
|
||||
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
||||
- **Analyzes**: Existing system, constraints, integration points
|
||||
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
||||
- **Creates**: Epic and story structure for changes
|
||||
|
||||
3. **Architecture Planning**:
|
||||
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
||||
- **Integration Strategy**: How new features integrate with existing system
|
||||
- **Migration Planning**: Gradual rollout and backwards compatibility
|
||||
- **Risk Mitigation**: Addressing potential breaking changes
|
||||
|
||||
**Brownfield-Specific Resources**:
|
||||
|
||||
**Templates**:
|
||||
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
||||
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
||||
|
||||
**Tasks**:
|
||||
- `document-project`: Generates comprehensive documentation from existing codebase
|
||||
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
||||
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
||||
|
||||
**When to Use Each Approach**:
|
||||
|
||||
**Full Brownfield Workflow** (Recommended for):
|
||||
- Major feature additions
|
||||
- System modernization
|
||||
- Complex integrations
|
||||
- Multiple related changes
|
||||
|
||||
**Quick Epic/Story Creation** (Use when):
|
||||
- Single, focused enhancement
|
||||
- Isolated bug fixes
|
||||
- Small feature additions
|
||||
- Well-documented existing system
|
||||
|
||||
**Critical Success Factors**:
|
||||
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
||||
2. **Context Matters**: Provide agents access to relevant code sections
|
||||
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
||||
4. **Incremental Approach**: Plan for gradual rollout and testing
|
||||
|
||||
**For detailed guide**: See `docs/working-in-the-brownfield.md`
|
||||
|
||||
## Document Creation Best Practices
|
||||
|
||||
@@ -478,9 +659,91 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
**Fork Workflow**:
|
||||
1. Fork the repository
|
||||
2. Create feature branches
|
||||
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
||||
4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
|
||||
5. One feature/fix per PR
|
||||
|
||||
**PR Requirements**:
|
||||
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
||||
- Use conventional commits (feat:, fix:, docs:)
|
||||
- Atomic commits - one logical change per commit
|
||||
- Must align with guiding principles
|
||||
|
||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||
- **Natural Language First**: Everything in markdown, no code in core
|
||||
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
||||
- **Design Philosophy**: "Dev agents code, planning agents plan"
|
||||
|
||||
## Expansion Packs
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
Expansion packs extend BMAD-METHOD beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
1. **Keep Core Lean**: Dev agents maintain maximum context for coding
|
||||
2. **Domain Expertise**: Deep, specialized knowledge without bloating core
|
||||
3. **Community Innovation**: Anyone can create and share packs
|
||||
4. **Modular Design**: Install only what you need
|
||||
|
||||
### Available Expansion Packs
|
||||
|
||||
**Technical Packs**:
|
||||
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
||||
- **Game Development**: Game designers, level designers, narrative writers
|
||||
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
||||
- **Data Science**: ML engineers, data scientists, visualization experts
|
||||
|
||||
**Non-Technical Packs**:
|
||||
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
||||
- **Creative Writing**: Plot architects, character developers, world builders
|
||||
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
||||
- **Education**: Curriculum designers, assessment specialists
|
||||
- **Legal Support**: Contract analysts, compliance checkers
|
||||
|
||||
**Specialty Packs**:
|
||||
- **Expansion Creator**: Tools to build your own expansion packs
|
||||
- **RPG Game Master**: Tabletop gaming assistance
|
||||
- **Life Event Planning**: Wedding planners, event coordinators
|
||||
- **Scientific Research**: Literature reviewers, methodology designers
|
||||
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# Select "Install expansion pack" option
|
||||
```
|
||||
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
||||
|
||||
### Creating Custom Expansion Packs
|
||||
|
||||
Use the **expansion-creator** pack to build your own:
|
||||
|
||||
1. **Define Domain**: What expertise are you capturing?
|
||||
2. **Design Agents**: Create specialized roles with clear boundaries
|
||||
3. **Build Resources**: Tasks, templates, checklists for your domain
|
||||
4. **Test & Share**: Validate with real use cases, share with community
|
||||
|
||||
**Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Commands**: Use `/help` in any environment to see available commands
|
||||
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
||||
- **Documentation**: Check `docs/` folder for project-specific context
|
||||
- **Community**: Discord and GitHub resources available for support
|
||||
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
# Core Dump Task
|
||||
|
||||
## Purpose
|
||||
|
||||
To create a concise memory recording file (`.ai/core-dump-n.md`) that captures the essential context of the current agent session, enabling seamless continuation of work in future agent sessions. This task ensures persistent context across agent conversations while maintaining minimal token usage for efficient context loading.
|
||||
|
||||
## Inputs for this Task
|
||||
|
||||
- Current session conversation history and accomplishments
|
||||
- Files created, modified, or deleted during the session
|
||||
- Key decisions made and procedures followed
|
||||
- Current project state and next logical steps
|
||||
- User requests and agent responses that shaped the session
|
||||
|
||||
## Task Execution Instructions
|
||||
|
||||
### 0. Check Existing Core Dump
|
||||
|
||||
Before proceeding, check if `.ai/core-dump.md` already exists:
|
||||
|
||||
- If file exists, ask user: "Core dump file exists. Should I: 1. Overwrite, 2. Update, 3. Append or 4. Create new?"
|
||||
- **Overwrite**: Replace entire file with new content
|
||||
- **Update**: Merge new session info with existing content, updating relevant sections
|
||||
- **Append**: Add new session as a separate entry while preserving existing content
|
||||
- **Create New**: Create a new file, appending the next possible -# to the file, such as core-dump-3.md if 1 and 2 already exist.
|
||||
- If file doesn't exist, proceed with creation of `core-dump-1.md`
|
||||
|
||||
### 1. Analyze Session Context
|
||||
|
||||
- Review the entire conversation to identify key accomplishments
|
||||
- Note any specific tasks, procedures, or workflows that were executed
|
||||
- Identify important decisions made or problems solved
|
||||
- Capture the user's working style and preferences observed during the session
|
||||
|
||||
### 2. Document What Was Accomplished
|
||||
|
||||
- **Primary Actions**: List the main tasks completed concisely
|
||||
- **Story Progress**: For story work, use format "Tasks Complete: 1-6, 8. Next Task Pending: 7, 9"
|
||||
- **Problem Solving**: Document any challenges encountered and how they were resolved
|
||||
- **User Communications**: Summarize key user requests, preferences, and discussion points
|
||||
|
||||
### 3. Record File System Changes (Concise Format)
|
||||
|
||||
- **Files Created**: `filename.ext` (brief purpose/size)
|
||||
- **Files Modified**: `filename.ext` (what changed)
|
||||
- **Files Deleted**: `filename.ext` (why removed)
|
||||
- Focus on essential details, avoid verbose descriptions
|
||||
|
||||
### 4. Capture Current Project State
|
||||
|
||||
- **Project Progress**: Where the project stands after this session
|
||||
- **Current Issues**: Any blockers or problems that need resolution
|
||||
- **Next Logical Steps**: What would be the natural next actions to take
|
||||
|
||||
### 5. Create/Update Core Dump File
|
||||
|
||||
Based on user's choice from step 0, handle the file accordingly:
|
||||
|
||||
### 6. Optimize for Minimal Context
|
||||
|
||||
- Keep descriptions concise but informative
|
||||
- Use abbreviated formats where possible (file sizes, task numbers)
|
||||
- Focus on actionable information rather than detailed explanations
|
||||
- Avoid redundant information that can be found in project documentation
|
||||
- Prioritize information that would be lost without this recording
|
||||
- Ensure the file can be quickly scanned and understood
|
||||
|
||||
### 7. Validate Completeness
|
||||
|
||||
- Verify all significant session activities are captured
|
||||
- Ensure a future agent could understand the current state
|
||||
- Check that file changes are accurately recorded
|
||||
- Confirm next steps are clear and actionable
|
||||
- Verify user communication style and preferences are noted
|
||||
355
bmad-core/tasks/create-brownfield-story.md
Normal file
355
bmad-core/tasks/create-brownfield-story.md
Normal file
@@ -0,0 +1,355 @@
|
||||
# Create Brownfield Story Task
|
||||
|
||||
## Purpose
|
||||
|
||||
Create detailed, implementation-ready stories for brownfield projects where traditional sharded PRD/architecture documents may not exist. This task bridges the gap between various documentation formats (document-project output, brownfield PRDs, epics, or user documentation) and executable stories for the Dev agent.
|
||||
|
||||
## When to Use This Task
|
||||
|
||||
**Use this task when:**
|
||||
|
||||
- Working on brownfield projects with non-standard documentation
|
||||
- Stories need to be created from document-project output
|
||||
- Working from brownfield epics without full PRD/architecture
|
||||
- Existing project documentation doesn't follow BMAD v4+ structure
|
||||
- Need to gather additional context from user during story creation
|
||||
|
||||
**Use create-next-story when:**
|
||||
|
||||
- Working with properly sharded PRD and v4 architecture documents
|
||||
- Following standard greenfield or well-documented brownfield workflow
|
||||
- All technical context is available in structured format
|
||||
|
||||
## Task Execution Instructions
|
||||
|
||||
### 0. Check Workflow Plan and Documentation Context
|
||||
|
||||
[[LLM: Check for workflow plan first, then available documentation]]
|
||||
|
||||
#### 0.1 Check Workflow Plan
|
||||
|
||||
- Load core-config.yml and check if `workflow.trackProgress: true`
|
||||
- If yes, check for active plan at `workflow.planFile`
|
||||
- If plan exists:
|
||||
- Verify story creation aligns with current plan step
|
||||
- If out of sequence, warn user (enforce based on config)
|
||||
- Note which step this story creation corresponds to
|
||||
|
||||
#### 0.2 Determine Documentation Context
|
||||
|
||||
Check for available documentation in this order:
|
||||
|
||||
1. **Sharded PRD/Architecture** (docs/prd/, docs/architecture/)
|
||||
- If found, recommend using create-next-story task instead
|
||||
|
||||
2. **Brownfield Architecture Document** (docs/brownfield-architecture.md or similar)
|
||||
- Created by document-project task
|
||||
- Contains actual system state, technical debt, workarounds
|
||||
|
||||
3. **Brownfield PRD** (docs/prd.md)
|
||||
- May contain embedded technical details
|
||||
|
||||
4. **Epic Files** (docs/epics/ or similar)
|
||||
- Created by brownfield-create-epic task
|
||||
|
||||
5. **User-Provided Documentation**
|
||||
- Ask user to specify location and format
|
||||
|
||||
### 1. Story Identification and Context Gathering
|
||||
|
||||
#### 1.1 Identify Story Source
|
||||
|
||||
Based on available documentation:
|
||||
|
||||
- **From Brownfield PRD**: Extract stories from epic sections
|
||||
- **From Epic Files**: Read epic definition and story list
|
||||
- **From User Direction**: Ask user which specific enhancement to implement
|
||||
- **No Clear Source**: Work with user to define the story scope
|
||||
|
||||
#### 1.2 Gather Essential Context
|
||||
|
||||
[[LLM: For brownfield stories, you MUST gather enough context for safe implementation. Be prepared to ask the user for missing information.]]
|
||||
|
||||
**Required Information Checklist:**
|
||||
|
||||
- [ ] What existing functionality might be affected?
|
||||
- [ ] What are the integration points with current code?
|
||||
- [ ] What patterns should be followed (with examples)?
|
||||
- [ ] What technical constraints exist?
|
||||
- [ ] Are there any "gotchas" or workarounds to know about?
|
||||
|
||||
If any required information is missing, ask the user:
|
||||
|
||||
```
|
||||
I need additional context for this brownfield story:
|
||||
|
||||
Missing Information:
|
||||
- [List specific missing items]
|
||||
|
||||
Please provide:
|
||||
1. [Specific question about integration]
|
||||
2. [Specific question about patterns]
|
||||
3. [Specific question about constraints]
|
||||
|
||||
Or point me to documentation that contains this information.
|
||||
```
|
||||
|
||||
### 2. Extract Technical Context from Available Sources
|
||||
|
||||
#### 2.1 From Document-Project Output
|
||||
|
||||
If using brownfield-architecture.md from document-project:
|
||||
|
||||
- **Technical Debt Section**: Note any workarounds affecting this story
|
||||
- **Key Files Section**: Identify files that will need modification
|
||||
- **Integration Points**: Find existing integration patterns
|
||||
- **Known Issues**: Check if story touches problematic areas
|
||||
- **Actual Tech Stack**: Verify versions and constraints
|
||||
|
||||
#### 2.2 From Brownfield PRD
|
||||
|
||||
If using brownfield PRD:
|
||||
|
||||
- **Technical Constraints Section**: Extract all relevant constraints
|
||||
- **Integration Requirements**: Note compatibility requirements
|
||||
- **Code Organization**: Follow specified patterns
|
||||
- **Risk Assessment**: Understand potential impacts
|
||||
|
||||
#### 2.3 From User Documentation
|
||||
|
||||
[[LLM: When working with non-BMAD documentation, actively extract and organize the information into categories the Dev agent will need]]
|
||||
|
||||
Ask the user to help identify:
|
||||
|
||||
- Relevant technical specifications
|
||||
- Existing code examples to follow
|
||||
- Integration requirements
|
||||
- Testing approaches used in the project
|
||||
|
||||
### 3. Story Creation with Progressive Detail Gathering
|
||||
|
||||
#### 3.1 Create Initial Story Structure
|
||||
|
||||
Start with the story template, filling in what's known:
|
||||
|
||||
```markdown
|
||||
# Story {{Enhancement Title}}
|
||||
|
||||
## Status: Draft
|
||||
|
||||
## Story
|
||||
As a {{user_type}},
|
||||
I want {{enhancement_capability}},
|
||||
so that {{value_delivered}}.
|
||||
|
||||
## Context Source
|
||||
[[LLM: Document where story requirements came from]]
|
||||
- Source Document: {{document name/type}}
|
||||
- Enhancement Type: {{single feature/bug fix/integration/etc}}
|
||||
- Existing System Impact: {{brief assessment}}
|
||||
```
|
||||
|
||||
#### 3.2 Develop Acceptance Criteria
|
||||
|
||||
[[LLM: For brownfield, ALWAYS include criteria about maintaining existing functionality]]
|
||||
|
||||
Standard structure:
|
||||
|
||||
1. New functionality works as specified
|
||||
2. Existing {{affected feature}} continues to work unchanged
|
||||
3. Integration with {{existing system}} maintains current behavior
|
||||
4. No regression in {{related area}}
|
||||
5. Performance remains within acceptable bounds
|
||||
|
||||
#### 3.3 Gather Technical Guidance
|
||||
|
||||
[[LLM: This is where you'll need to be interactive with the user if information is missing]]
|
||||
|
||||
Create Dev Technical Guidance section with available information:
|
||||
|
||||
```markdown
|
||||
## Dev Technical Guidance
|
||||
|
||||
### Existing System Context
|
||||
[Extract from available documentation]
|
||||
|
||||
### Integration Approach
|
||||
[Based on patterns found or ask user]
|
||||
|
||||
### Technical Constraints
|
||||
[From documentation or user input]
|
||||
|
||||
### Missing Information
|
||||
[[LLM: List anything you couldn't find that dev will need]]
|
||||
- [ ] {{missing item 1}}
|
||||
- [ ] {{missing item 2}}
|
||||
```
|
||||
|
||||
If critical information is missing, pause and ask:
|
||||
|
||||
```
|
||||
To complete the technical guidance for this story, I need:
|
||||
|
||||
1. **{{Missing Category}}**:
|
||||
- Specifically: {{what you need to know}}
|
||||
- Why needed: {{how it impacts implementation}}
|
||||
|
||||
Can you provide this information or point me to relevant code/docs?
|
||||
```
|
||||
|
||||
### 4. Task Generation with Safety Checks
|
||||
|
||||
#### 4.1 Generate Implementation Tasks
|
||||
|
||||
Based on gathered context, create tasks that:
|
||||
|
||||
- Include exploration tasks if system understanding is incomplete
|
||||
- Add verification tasks for existing functionality
|
||||
- Include rollback considerations
|
||||
- Reference specific files/patterns when known
|
||||
|
||||
Example task structure for brownfield:
|
||||
|
||||
```markdown
|
||||
## Tasks / Subtasks
|
||||
|
||||
- [ ] Task 1: Analyze existing {{component/feature}} implementation
|
||||
- [ ] Review {{specific files}} for current patterns
|
||||
- [ ] Document integration points
|
||||
- [ ] Identify potential impacts
|
||||
|
||||
- [ ] Task 2: Implement {{new functionality}}
|
||||
- [ ] Follow pattern from {{example file}}
|
||||
- [ ] Integrate with {{existing component}}
|
||||
- [ ] Maintain compatibility with {{constraint}}
|
||||
|
||||
- [ ] Task 3: Verify existing functionality
|
||||
- [ ] Test {{existing feature 1}} still works
|
||||
- [ ] Verify {{integration point}} behavior unchanged
|
||||
- [ ] Check performance impact
|
||||
|
||||
- [ ] Task 4: Add tests
|
||||
- [ ] Unit tests following {{project test pattern}}
|
||||
- [ ] Integration test for {{integration point}}
|
||||
- [ ] Update existing tests if needed
|
||||
```
|
||||
|
||||
### 5. Risk Assessment and Mitigation
|
||||
|
||||
[[LLM: CRITICAL for brownfield - always include risk assessment]]
|
||||
|
||||
Add section for brownfield-specific risks:
|
||||
|
||||
```markdown
|
||||
## Risk Assessment
|
||||
|
||||
### Implementation Risks
|
||||
- **Primary Risk**: {{main risk to existing system}}
|
||||
- **Mitigation**: {{how to address}}
|
||||
- **Verification**: {{how to confirm safety}}
|
||||
|
||||
### Rollback Plan
|
||||
- {{Simple steps to undo changes if needed}}
|
||||
|
||||
### Safety Checks
|
||||
- [ ] Existing {{feature}} tested before changes
|
||||
- [ ] Changes can be feature-flagged or isolated
|
||||
- [ ] Rollback procedure documented
|
||||
```
|
||||
|
||||
### 6. Final Story Validation
|
||||
|
||||
Before finalizing:
|
||||
|
||||
1. **Completeness Check**:
|
||||
- [ ] Story has clear scope and acceptance criteria
|
||||
- [ ] Technical context is sufficient for implementation
|
||||
- [ ] Integration approach is defined
|
||||
- [ ] Risks are identified with mitigation
|
||||
|
||||
2. **Safety Check**:
|
||||
- [ ] Existing functionality protection included
|
||||
- [ ] Rollback plan is feasible
|
||||
- [ ] Testing covers both new and existing features
|
||||
|
||||
3. **Information Gaps**:
|
||||
- [ ] All critical missing information gathered from user
|
||||
- [ ] Remaining unknowns documented for dev agent
|
||||
- [ ] Exploration tasks added where needed
|
||||
|
||||
### 7. Story Output Format
|
||||
|
||||
Save the story with appropriate naming:
|
||||
|
||||
- If from epic: `docs/stories/epic-{n}-story-{m}.md`
|
||||
- If standalone: `docs/stories/brownfield-{feature-name}.md`
|
||||
- If sequential: Follow existing story numbering
|
||||
|
||||
Include header noting documentation context:
|
||||
|
||||
```markdown
|
||||
# Story: {{Title}}
|
||||
|
||||
<!-- Source: {{documentation type used}} -->
|
||||
<!-- Context: Brownfield enhancement to {{existing system}} -->
|
||||
|
||||
## Status: Draft
|
||||
[Rest of story content...]
|
||||
```
|
||||
|
||||
### 8. Handoff Communication
|
||||
|
||||
Provide clear handoff to the user:
|
||||
|
||||
```text
|
||||
Brownfield story created: {{story title}}
|
||||
|
||||
Source Documentation: {{what was used}}
|
||||
Story Location: {{file path}}
|
||||
|
||||
Key Integration Points Identified:
|
||||
- {{integration point 1}}
|
||||
- {{integration point 2}}
|
||||
|
||||
Risks Noted:
|
||||
- {{primary risk}}
|
||||
|
||||
{{If missing info}}:
|
||||
Note: Some technical details were unclear. The story includes exploration tasks to gather needed information during implementation.
|
||||
|
||||
Next Steps:
|
||||
1. Review story for accuracy
|
||||
2. Verify integration approach aligns with your system
|
||||
3. Approve story or request adjustments
|
||||
4. Dev agent can then implement with safety checks
|
||||
```
|
||||
|
||||
### 9. Update Workflow Plan (if applicable)
|
||||
|
||||
[[LLM: After successful story creation]]
|
||||
|
||||
- If workflow plan tracking is enabled and story was created successfully:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-brownfield-story, step_id: {from plan check}, status: complete
|
||||
- If plan shows next recommended step, include it in handoff message
|
||||
|
||||
## Success Criteria
|
||||
|
||||
The brownfield story creation is successful when:
|
||||
|
||||
1. Story can be implemented without requiring dev to search multiple documents
|
||||
2. Integration approach is clear and safe for existing system
|
||||
3. All available technical context has been extracted and organized
|
||||
4. Missing information has been identified and addressed
|
||||
5. Risks are documented with mitigation strategies
|
||||
6. Story includes verification of existing functionality
|
||||
7. Rollback approach is defined
|
||||
|
||||
## Important Notes
|
||||
|
||||
- This task is specifically for brownfield projects with non-standard documentation
|
||||
- Always prioritize existing system safety over new features
|
||||
- When in doubt, add exploration and verification tasks
|
||||
- It's better to ask the user for clarification than make assumptions
|
||||
- Each story should be self-contained for the dev agent
|
||||
- Include references to existing code patterns when available
|
||||
@@ -1,74 +0,0 @@
|
||||
# Create Document from Template Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Identify Template and Context
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
|
||||
### 6. Validation
|
||||
|
||||
If template specifies a checklist:
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
|
||||
### 7. Final Presentation
|
||||
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
|
||||
## Important Notes
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
@@ -17,15 +17,31 @@ To identify the next logical story based on project progress and epic definition
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `dev-story-location`: Where to save story files
|
||||
- `devStoryLocation`: Where to save story files
|
||||
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
||||
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
|
||||
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
||||
- `prd.prdShardedLocation`: Location of sharded epic files
|
||||
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
||||
- `architecture.architectureVersion`: Architecture document version
|
||||
- `architecture.architectureSharded`: Whether architecture is sharded
|
||||
- `architecture.architecture-file`: Location of monolithic architecture
|
||||
- `architecture.architectureFile`: Location of monolithic architecture
|
||||
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
||||
- `workflow.trackProgress`: Whether workflow plan tracking is enabled
|
||||
- `workflow.planFile`: Location of workflow plan (if tracking enabled)
|
||||
|
||||
### 0.5 Check Workflow Plan (if configured)
|
||||
|
||||
[[LLM: Check if workflow plan tracking is enabled]]
|
||||
|
||||
- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
|
||||
- If plan exists:
|
||||
- Parse plan to check if story creation is the expected next step
|
||||
- If out of sequence and `workflow.enforceSequence: true`:
|
||||
- Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
|
||||
- Block execution unless user explicitly overrides
|
||||
- If out of sequence and `workflow.enforceSequence: false`:
|
||||
- Show warning but allow continuation with confirmation
|
||||
- Continue with story identification after plan check
|
||||
|
||||
### 1. Identify Next Story for Preparation
|
||||
|
||||
@@ -33,11 +49,11 @@ To identify the next logical story based on project progress and epic definition
|
||||
|
||||
- Based on `prdSharded` from config:
|
||||
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
||||
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
|
||||
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
||||
|
||||
#### 1.2 Review Existing Stories
|
||||
|
||||
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
|
||||
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
||||
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
||||
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
||||
- Verify its `Status` is 'Done' (or equivalent).
|
||||
@@ -57,12 +73,40 @@ To identify the next logical story based on project progress and epic definition
|
||||
```
|
||||
|
||||
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
|
||||
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and parse it to find ALL stories in that epic. **ALWAYS select the next sequential story** (e.g., if last was 2.2, next MUST be 2.3).
|
||||
- If the next sequential story has unmet prerequisites, present this to the user:
|
||||
|
||||
```plaintext
|
||||
ALERT: Next story has unmet prerequisites:
|
||||
Story: {epicNum}.{storyNum} - {Story Title}
|
||||
Prerequisites not met: [list specific prerequisites]
|
||||
|
||||
Would you like to:
|
||||
1. Create the story anyway (mark prerequisites as pending)
|
||||
2. Skip to a different story (requires your specific instruction)
|
||||
3. Cancel story creation
|
||||
|
||||
Please choose an option (1/2/3):
|
||||
```
|
||||
|
||||
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
||||
|
||||
```plaintext
|
||||
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
||||
|
||||
Would you like to:
|
||||
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
||||
2. Select a specific story to work on
|
||||
3. Cancel story creation
|
||||
|
||||
Please choose an option (1/2/3):
|
||||
```
|
||||
|
||||
- **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
|
||||
|
||||
- **If no story files exist in `docs/stories/`:**
|
||||
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
|
||||
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
|
||||
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
||||
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
||||
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
||||
|
||||
### 2. Gather Core Story Requirements (from Epic)
|
||||
@@ -98,13 +142,13 @@ Based on configuration loaded in Step 0:
|
||||
- Follow the structured reading order in section 4.2 below
|
||||
|
||||
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
||||
- Load the monolithic architecture from `architecture-file`
|
||||
- Load the monolithic architecture from `architectureFile`
|
||||
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
||||
|
||||
- **If `architectureVersion` is NOT v4**:
|
||||
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
||||
- If `architectureSharded: true`: Search sharded files by filename relevance
|
||||
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
|
||||
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
||||
|
||||
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
||||
|
||||
@@ -161,7 +205,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
|
||||
### 6. Populate Story Template with Full Context
|
||||
|
||||
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
|
||||
- Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
|
||||
- Use the Story Template to structure the file.
|
||||
- Fill in:
|
||||
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
||||
@@ -208,7 +252,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
- Verify all source references are included for technical details
|
||||
- Ensure tasks align with both epic requirements and architecture constraints
|
||||
- Update status to "Draft"
|
||||
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
|
||||
- Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
|
||||
|
||||
### 9. Report Completion
|
||||
|
||||
@@ -221,4 +265,13 @@ Provide a summary to the user including:
|
||||
- Recommendations for story review before approval
|
||||
- Next steps: Story should be reviewed by PO for approval before dev work begins
|
||||
|
||||
### 10. Update Workflow Plan (if applicable)
|
||||
|
||||
[[LLM: After successful story creation]]
|
||||
|
||||
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
|
||||
- Call update-workflow-plan task to mark story creation step complete
|
||||
- Parameters: task: create-next-story, step_id: {from plan}, status: complete
|
||||
- If plan shows next step, mention it in completion message
|
||||
|
||||
[[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]
|
||||
|
||||
289
bmad-core/tasks/create-workflow-plan.md
Normal file
289
bmad-core/tasks/create-workflow-plan.md
Normal file
@@ -0,0 +1,289 @@
|
||||
# Create Workflow Plan Task
|
||||
|
||||
## Purpose
|
||||
|
||||
Guide users through workflow selection and create a detailed plan document that outlines the selected workflow steps, decision points, and expected outputs. This task helps users understand what will happen before starting a complex workflow and provides a checklist to track progress.
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Understand User's Goal
|
||||
|
||||
[[LLM: Start with discovery questions to understand what the user wants to accomplish]]
|
||||
|
||||
Ask the user:
|
||||
|
||||
1. **Project Type**:
|
||||
- Are you starting a new project (greenfield) or enhancing an existing one (brownfield)?
|
||||
- What type of application? (web app, service/API, UI only, full-stack)
|
||||
|
||||
2. **For Greenfield**:
|
||||
- Do you need a quick prototype or production-ready application?
|
||||
- Will this have a UI component?
|
||||
- Single service or multiple services?
|
||||
|
||||
3. **For Brownfield**:
|
||||
- What's the scope of the enhancement?
|
||||
- Single bug fix or small feature (few hours)
|
||||
- Small enhancement (1-3 stories)
|
||||
- Major feature requiring coordination
|
||||
- Architectural changes or modernization
|
||||
- Do you have existing documentation?
|
||||
- Are you following existing patterns or introducing new ones?
|
||||
|
||||
### 2. Recommend Appropriate Workflow
|
||||
|
||||
Based on the answers, recommend:
|
||||
|
||||
**Greenfield Options:**
|
||||
|
||||
- `greenfield-fullstack` - Complete web application
|
||||
- `greenfield-service` - Backend API/service only
|
||||
- `greenfield-ui` - Frontend only
|
||||
|
||||
**Brownfield Options:**
|
||||
|
||||
- `brownfield-create-story` - Single small change
|
||||
- `brownfield-create-epic` - Small feature (1-3 stories)
|
||||
- `brownfield-fullstack` - Major enhancement
|
||||
|
||||
**Simplified Option:**
|
||||
|
||||
- For users unsure or wanting flexibility, suggest starting with individual agent tasks
|
||||
|
||||
### 3. Explain Selected Workflow
|
||||
|
||||
[[LLM: Once workflow is selected, provide clear explanation]]
|
||||
|
||||
For the selected workflow, explain:
|
||||
|
||||
1. **Overview**: What this workflow accomplishes
|
||||
2. **Duration**: Estimated time for planning phase
|
||||
3. **Outputs**: What documents will be created
|
||||
4. **Decision Points**: Where user input will be needed
|
||||
5. **Requirements**: What information should be ready
|
||||
|
||||
### 4. Create Workflow Plan Document
|
||||
|
||||
[[LLM: Generate a comprehensive plan document with the following structure]]
|
||||
|
||||
```markdown
|
||||
# Workflow Plan: {{Workflow Name}}
|
||||
|
||||
<!-- WORKFLOW-PLAN-META
|
||||
workflow-id: {{workflow-id}}
|
||||
status: active
|
||||
created: {{ISO-8601 timestamp}}
|
||||
updated: {{ISO-8601 timestamp}}
|
||||
version: 1.0
|
||||
-->
|
||||
|
||||
**Created Date**: {{current date}}
|
||||
**Project**: {{project name}}
|
||||
**Type**: {{greenfield/brownfield}}
|
||||
**Status**: Active
|
||||
**Estimated Planning Duration**: {{time estimate}}
|
||||
|
||||
## Objective
|
||||
|
||||
{{Clear description of what will be accomplished}}
|
||||
|
||||
## Selected Workflow
|
||||
|
||||
**Workflow**: `{{workflow-id}}`
|
||||
**Reason**: {{Why this workflow fits the user's needs}}
|
||||
|
||||
## Workflow Steps
|
||||
|
||||
### Planning Phase
|
||||
|
||||
- [ ] Step 1: {{step name}} <!-- step-id: 1.1, agent: {{agent}}, task: {{task}} -->
|
||||
- **Agent**: {{agent name}}
|
||||
- **Action**: {{what happens}}
|
||||
- **Output**: {{what's created}}
|
||||
- **User Input**: {{if any}}
|
||||
|
||||
- [ ] Step 2: {{step name}} <!-- step-id: 1.2, agent: {{agent}}, task: {{task}} -->
|
||||
- **Agent**: {{agent name}}
|
||||
- **Action**: {{what happens}}
|
||||
- **Output**: {{what's created}}
|
||||
- **Decision Point**: {{if any}} <!-- decision-id: D1 -->
|
||||
|
||||
{{Continue for all planning steps}}
|
||||
|
||||
### Development Phase (IDE)
|
||||
|
||||
- [ ] Document Sharding <!-- step-id: 2.1, agent: po, task: shard-doc -->
|
||||
- Prepare documents for story creation
|
||||
|
||||
- [ ] Story Development Cycle <!-- step-id: 2.2, repeats: true -->
|
||||
- [ ] Create story (SM agent) <!-- step-id: 2.2.1, agent: sm, task: create-next-story -->
|
||||
- [ ] Review story (optional) <!-- step-id: 2.2.2, agent: analyst, optional: true -->
|
||||
- [ ] Implement story (Dev agent) <!-- step-id: 2.2.3, agent: dev -->
|
||||
- [ ] QA review (optional) <!-- step-id: 2.2.4, agent: qa, optional: true -->
|
||||
- [ ] Repeat for all stories
|
||||
|
||||
- [ ] Epic Retrospective (optional) <!-- step-id: 2.3, agent: po, optional: true -->
|
||||
|
||||
## Key Decision Points
|
||||
|
||||
1. **{{Decision Name}}** (Step {{n}}): <!-- decision-id: D1, status: pending -->
|
||||
- Trigger: {{what causes this decision}}
|
||||
- Options: {{available choices}}
|
||||
- Impact: {{how it affects the workflow}}
|
||||
- Decision Made: _Pending_
|
||||
|
||||
{{List all decision points}}
|
||||
|
||||
## Expected Outputs
|
||||
|
||||
### Planning Documents
|
||||
- [ ] {{document 1}} - {{description}}
|
||||
- [ ] {{document 2}} - {{description}}
|
||||
{{etc...}}
|
||||
|
||||
### Development Artifacts
|
||||
- [ ] Stories in `docs/stories/`
|
||||
- [ ] Implementation code
|
||||
- [ ] Tests
|
||||
- [ ] Updated documentation
|
||||
|
||||
## Prerequisites Checklist
|
||||
|
||||
Before starting this workflow, ensure you have:
|
||||
|
||||
- [ ] {{prerequisite 1}}
|
||||
- [ ] {{prerequisite 2}}
|
||||
- [ ] {{prerequisite 3}}
|
||||
{{etc...}}
|
||||
|
||||
## Customization Options
|
||||
|
||||
Based on your project needs, you may:
|
||||
- Skip {{optional step}} if {{condition}}
|
||||
- Add {{additional step}} if {{condition}}
|
||||
- Choose {{alternative}} instead of {{default}}
|
||||
|
||||
## Risk Considerations
|
||||
|
||||
{{For brownfield only}}
|
||||
- Integration complexity: {{assessment}}
|
||||
- Rollback strategy: {{approach}}
|
||||
- Testing requirements: {{special needs}}
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Review this plan and confirm it matches your expectations
|
||||
2. Gather any missing prerequisites
|
||||
3. Start workflow with: `*task workflow {{workflow-id}}`
|
||||
4. Or begin with first agent: `@{{first-agent}}`
|
||||
|
||||
## Notes
|
||||
|
||||
{{Any additional context or warnings}}
|
||||
|
||||
---
|
||||
*This plan can be updated as you progress through the workflow. Check off completed items to track progress.*
|
||||
```
|
||||
|
||||
### 5. Save and Present Plan
|
||||
|
||||
1. Save the plan as `docs/workflow-plan.md`
|
||||
2. Inform user: "Workflow plan created at docs/workflow-plan.md"
|
||||
3. Offer options:
|
||||
- Review the plan together
|
||||
- Start the workflow now
|
||||
- Gather prerequisites first
|
||||
- Modify the plan
|
||||
|
||||
### 6. Plan Variations
|
||||
|
||||
[[LLM: Adjust plan detail based on workflow complexity]]
|
||||
|
||||
**For Simple Workflows** (create-story, create-epic):
|
||||
|
||||
- Simpler checklist format
|
||||
- Focus on immediate next steps
|
||||
- Less detailed explanations
|
||||
|
||||
**For Complex Workflows** (full greenfield/brownfield):
|
||||
|
||||
- Detailed step breakdowns
|
||||
- All decision points documented
|
||||
- Comprehensive output descriptions
|
||||
- Risk mitigation sections
|
||||
|
||||
**For Brownfield Workflows**:
|
||||
|
||||
- Include existing system impact analysis
|
||||
- Document integration checkpoints
|
||||
- Add rollback considerations
|
||||
- Note documentation dependencies
|
||||
|
||||
### 7. Interactive Planning Mode
|
||||
|
||||
[[LLM: If user wants to customize the workflow]]
|
||||
|
||||
If user wants to modify the standard workflow:
|
||||
|
||||
1. Present workflow steps as options
|
||||
2. Allow skipping optional steps
|
||||
3. Let user reorder certain steps
|
||||
4. Document customizations in plan
|
||||
5. Warn about dependencies if steps are skipped
|
||||
|
||||
### 8. Execution Guidance
|
||||
|
||||
After plan is created, provide clear guidance:
|
||||
|
||||
```text
|
||||
Your workflow plan is ready! Here's how to proceed:
|
||||
|
||||
1. **Review the plan**: Check that all steps align with your goals
|
||||
2. **Gather prerequisites**: Use the checklist to ensure you're ready
|
||||
3. **Start execution**:
|
||||
- Full workflow: `*task workflow {{workflow-id}}`
|
||||
- Step by step: Start with `@{{first-agent}}`
|
||||
4. **Track progress**: Check off steps in the plan as completed
|
||||
|
||||
Would you like to:
|
||||
a) Review the plan together
|
||||
b) Start the workflow now
|
||||
c) Gather prerequisites first
|
||||
d) Modify the plan
|
||||
```
|
||||
|
||||
## Success Criteria
|
||||
|
||||
The workflow plan is successful when:
|
||||
|
||||
1. User clearly understands what will happen
|
||||
2. All decision points are documented
|
||||
3. Prerequisites are identified
|
||||
4. Expected outputs are clear
|
||||
5. User feels confident to proceed
|
||||
6. Plan serves as useful progress tracker
|
||||
|
||||
## Integration with BMad Master and Orchestrator
|
||||
|
||||
When used by BMad Master or BMad Orchestrator, this task should:
|
||||
|
||||
1. Be offered when user asks about workflows
|
||||
2. Be suggested before starting complex workflows
|
||||
3. Create a plan that the agent can reference during execution
|
||||
4. Allow the agent to track progress against the plan
|
||||
|
||||
## Example Usage
|
||||
|
||||
```text
|
||||
User: "I need to add a payment system to my existing app"
|
||||
|
||||
BMad Orchestrator: "Let me help you create a workflow plan for that enhancement. I'll ask a few questions to recommend the best approach..."
|
||||
|
||||
[Runs through discovery questions]
|
||||
|
||||
BMad Orchestrator: "Based on your answers, I recommend the brownfield-fullstack workflow. Let me create a detailed plan for you..."
|
||||
|
||||
[Creates and saves plan]
|
||||
|
||||
BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This shows all the steps we'll go through, what documents will be created, and where you'll need to make decisions. Would you like to review it together?"
|
||||
```
|
||||
@@ -8,7 +8,39 @@ Generate comprehensive documentation for existing projects optimized for AI deve
|
||||
|
||||
### 1. Initial Project Analysis
|
||||
|
||||
[[LLM: Begin by conducting a comprehensive analysis of the existing project. Use available tools to:
|
||||
[[LLM: First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
||||
|
||||
**IF PRD EXISTS**:
|
||||
|
||||
- Review the PRD to understand what enhancement/feature is planned
|
||||
- Identify which modules, services, or areas will be affected
|
||||
- Focus documentation ONLY on these relevant areas
|
||||
- Skip unrelated parts of the codebase to keep docs lean
|
||||
|
||||
**IF NO PRD EXISTS**:
|
||||
Ask the user:
|
||||
|
||||
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
||||
|
||||
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
||||
|
||||
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
||||
|
||||
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
||||
- 'Adding payment processing to the user service'
|
||||
- 'Refactoring the authentication module'
|
||||
- 'Integrating with a new third-party API'
|
||||
|
||||
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
||||
|
||||
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
||||
|
||||
Based on their response:
|
||||
|
||||
- If they choose option 1-3: Use that context to focus documentation
|
||||
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
||||
|
||||
Begin by conducting analysis of the existing project. Use available tools to:
|
||||
|
||||
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
||||
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
||||
@@ -23,367 +55,263 @@ Ask the user these elicitation questions to better understand their needs:
|
||||
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
||||
- Are there any existing documentation standards or formats you prefer?
|
||||
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
||||
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
||||
]]
|
||||
|
||||
### 2. Core Documentation Generation
|
||||
### 2. Deep Codebase Analysis
|
||||
|
||||
[[LLM: Based on your analysis, generate the following core documentation files. Adapt the content and structure to match the specific project type and context you discovered:
|
||||
[[LLM: Before generating documentation, conduct extensive analysis of the existing codebase:
|
||||
|
||||
**Core Documents (always generate):**
|
||||
1. **Explore Key Areas**:
|
||||
- Entry points (main files, index files, app initializers)
|
||||
- Configuration files and environment setup
|
||||
- Package dependencies and versions
|
||||
- Build and deployment configurations
|
||||
- Test suites and coverage
|
||||
|
||||
1. **docs/index.md** - Master documentation index
|
||||
2. **docs/architecture/index.md** - Architecture documentation index
|
||||
3. **docs/architecture/coding-standards.md** - Coding conventions and style guidelines
|
||||
4. **docs/architecture/tech-stack.md** - Technology stack and version constraints
|
||||
5. **docs/architecture/unified-project-structure.md** - Project structure and organization
|
||||
6. **docs/architecture/testing-strategy.md** - Testing approaches and requirements
|
||||
2. **Ask Clarifying Questions**:
|
||||
- "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
|
||||
- "What are the most critical/complex parts of this system that developers struggle with?"
|
||||
- "Are there any undocumented 'tribal knowledge' areas I should capture?"
|
||||
- "What technical debt or known issues should I document?"
|
||||
- "Which parts of the codebase change most frequently?"
|
||||
|
||||
**Backend Documents (generate for backend/full-stack projects):**
|
||||
3. **Map the Reality**:
|
||||
- Identify ACTUAL patterns used (not theoretical best practices)
|
||||
- Find where key business logic lives
|
||||
- Locate integration points and external dependencies
|
||||
- Document workarounds and technical debt
|
||||
- Note areas that differ from standard patterns
|
||||
|
||||
7. **docs/architecture/backend-architecture.md** - Backend service patterns and structure
|
||||
8. **docs/architecture/rest-api-spec.md** - API endpoint specifications
|
||||
9. **docs/architecture/data-models.md** - Data structures and validation rules
|
||||
10. **docs/architecture/database-schema.md** - Database design and relationships
|
||||
11. **docs/architecture/external-apis.md** - Third-party integrations
|
||||
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement]]
|
||||
|
||||
**Frontend Documents (generate for frontend/full-stack projects):**
|
||||
### 3. Core Documentation Generation
|
||||
|
||||
12. **docs/architecture/frontend-architecture.md** - Frontend patterns and structure
|
||||
13. **docs/architecture/components.md** - UI component specifications
|
||||
14. **docs/architecture/core-workflows.md** - User interaction flows
|
||||
15. **docs/architecture/ui-ux-spec.md** - UI/UX specifications and guidelines
|
||||
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
||||
|
||||
**Additional Documents (generate if applicable):**
|
||||
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
||||
- Technical debt and workarounds
|
||||
- Inconsistent patterns between different parts
|
||||
- Legacy code that can't be changed
|
||||
- Integration constraints
|
||||
- Performance bottlenecks
|
||||
|
||||
16. **docs/prd.md** - Product requirements document (if not exists)
|
||||
17. **docs/architecture/deployment-guide.md** - Deployment and operations info
|
||||
18. **docs/architecture/security-considerations.md** - Security patterns and requirements
|
||||
19. **docs/architecture/performance-guidelines.md** - Performance optimization patterns
|
||||
**Document Structure**:
|
||||
|
||||
**Optional Enhancement Documents:**
|
||||
# [Project Name] Brownfield Architecture Document
|
||||
|
||||
20. **docs/architecture/troubleshooting-guide.md** - Common issues and solutions
|
||||
21. **docs/architecture/changelog-conventions.md** - Change management practices
|
||||
22. **docs/architecture/code-review-checklist.md** - Review standards and practices
|
||||
## Introduction
|
||||
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
||||
|
||||
Present each document section by section, using the advanced elicitation task after each major section.]]
|
||||
### Document Scope
|
||||
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
||||
[If no PRD: "Comprehensive documentation of entire system"]
|
||||
|
||||
### 3. Document Structure Template
|
||||
### Change Log
|
||||
| Date | Version | Description | Author |
|
||||
|------|---------|-------------|--------|
|
||||
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
||||
|
||||
[[LLM: Use this standardized structure for each documentation file, adapting content as needed:
|
||||
## Quick Reference - Key Files and Entry Points
|
||||
|
||||
```markdown
|
||||
# {{Document Title}}
|
||||
### Critical Files for Understanding the System
|
||||
- **Main Entry**: `src/index.js` (or actual entry point)
|
||||
- **Configuration**: `config/app.config.js`, `.env.example`
|
||||
- **Core Business Logic**: `src/services/`, `src/domain/`
|
||||
- **API Definitions**: `src/routes/` or link to OpenAPI spec
|
||||
- **Database Models**: `src/models/` or link to schema files
|
||||
- **Key Algorithms**: [List specific files with complex logic]
|
||||
|
||||
## Overview
|
||||
### If PRD Provided - Enhancement Impact Areas
|
||||
[Highlight which files/modules will be affected by the planned enhancement]
|
||||
|
||||
{{Brief description of what this document covers and why it's important for AI agents}}
|
||||
## High Level Architecture
|
||||
|
||||
## Quick Reference
|
||||
### Technical Summary
|
||||
[Real assessment of architecture - mention if it's well-structured or has issues]
|
||||
|
||||
{{Key points, commands, or patterns that agents need most frequently}}
|
||||
### Actual Tech Stack (from package.json/requirements.txt)
|
||||
| Category | Technology | Version | Notes |
|
||||
|----------|------------|---------|--------|
|
||||
| Runtime | Node.js | 16.x | [Any constraints] |
|
||||
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
||||
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
||||
| [etc...] |
|
||||
|
||||
## Detailed Information
|
||||
### Repository Structure Reality Check
|
||||
- Type: [Monorepo/Polyrepo/Hybrid]
|
||||
- Package Manager: [npm/yarn/pnpm]
|
||||
- Notable: [Any unusual structure decisions]
|
||||
|
||||
{{Comprehensive information organized into logical sections}}
|
||||
## Source Tree and Module Organization
|
||||
|
||||
## Examples
|
||||
|
||||
{{Concrete examples showing proper usage or implementation}}
|
||||
|
||||
## Common Patterns
|
||||
|
||||
{{Recurring patterns agents should recognize and follow}}
|
||||
|
||||
## Things to Avoid
|
||||
|
||||
{{Anti-patterns, deprecated approaches, or common mistakes}}
|
||||
|
||||
## Related Resources
|
||||
|
||||
{{Links to other relevant documentation or external resources}}
|
||||
### Project Structure (Actual)
|
||||
```
|
||||
project-root/
|
||||
├── src/
|
||||
│ ├── controllers/ # HTTP request handlers
|
||||
│ ├── services/ # Business logic (NOTE: inconsistent patterns between user and payment services)
|
||||
│ ├── models/ # Database models (Sequelize)
|
||||
│ ├── utils/ # Mixed bag - needs refactoring
|
||||
│ └── legacy/ # DO NOT MODIFY - old payment system still in use
|
||||
├── tests/ # Jest tests (60% coverage)
|
||||
├── scripts/ # Build and deployment scripts
|
||||
└── config/ # Environment configs
|
||||
```
|
||||
|
||||
Each document should be:
|
||||
|
||||
- **Concrete and actionable** - Focus on what agents need to do, not just concepts
|
||||
- **Pattern-focused** - Highlight recurring patterns agents can recognize and replicate
|
||||
- **Example-rich** - Include specific code examples and real file references
|
||||
- **Context-aware** - Reference actual project files, folders, and conventions
|
||||
- **Assumption-free** - Don't assume agents know project history or implicit knowledge
|
||||
]]
|
||||
|
||||
### 4. Content Guidelines for Each Document Type
|
||||
|
||||
#### Core Architecture Documents
|
||||
|
||||
##### docs/architecture/index.md
|
||||
|
||||
[[LLM: Create a comprehensive index of all architecture documentation:
|
||||
|
||||
- List all architecture documents with brief descriptions
|
||||
- Group documents by category (backend, frontend, shared)
|
||||
- Include quick links to key sections
|
||||
- Provide reading order recommendations for different use cases]]
|
||||
|
||||
##### docs/architecture/unified-project-structure.md
|
||||
|
||||
[[LLM: Document the complete project structure:
|
||||
|
||||
- Root-level directory structure with explanations
|
||||
- Where each type of code belongs (backend, frontend, tests, etc.)
|
||||
- File naming conventions and patterns
|
||||
- Module/package organization
|
||||
- Generated vs. source file locations
|
||||
- Build output locations]]
|
||||
|
||||
##### docs/architecture/coding-standards.md
|
||||
|
||||
[[LLM: Capture project-wide coding conventions:
|
||||
|
||||
- Language-specific style guidelines
|
||||
- Naming conventions (variables, functions, classes, files)
|
||||
- Code organization within files
|
||||
- Import/export patterns
|
||||
- Comment and documentation standards
|
||||
- Linting and formatting tool configurations
|
||||
- Git commit message conventions]]
|
||||
|
||||
##### docs/architecture/tech-stack.md
|
||||
|
||||
[[LLM: Document all technologies and versions:
|
||||
|
||||
- Primary languages and versions
|
||||
- Frameworks and major libraries with versions
|
||||
- Development tools and their versions
|
||||
- Database systems and versions
|
||||
- External services and APIs used
|
||||
- Browser/runtime requirements]]
|
||||
|
||||
##### docs/architecture/testing-strategy.md
|
||||
|
||||
[[LLM: Define testing approaches and requirements:
|
||||
|
||||
- Test file locations and naming conventions
|
||||
- Unit testing patterns and frameworks
|
||||
- Integration testing approaches
|
||||
- E2E testing setup (if applicable)
|
||||
- Test coverage requirements
|
||||
- Mocking strategies
|
||||
- Test data management]]
|
||||
|
||||
#### Backend Architecture Documents
|
||||
|
||||
##### docs/architecture/backend-architecture.md
|
||||
|
||||
[[LLM: Document backend service structure:
|
||||
|
||||
- Service layer organization
|
||||
- Controller/route patterns
|
||||
- Middleware architecture
|
||||
- Authentication/authorization patterns
|
||||
- Request/response flow
|
||||
- Background job processing
|
||||
- Service communication patterns]]
|
||||
|
||||
##### docs/architecture/rest-api-spec.md
|
||||
|
||||
[[LLM: Specify all API endpoints:
|
||||
|
||||
- Base URL and versioning strategy
|
||||
- Authentication methods
|
||||
- Common headers and parameters
|
||||
- Each endpoint with:
|
||||
- HTTP method and path
|
||||
- Request parameters/body
|
||||
- Response format and status codes
|
||||
- Error responses
|
||||
- Rate limiting and quotas]]
|
||||
|
||||
##### docs/architecture/data-models.md
|
||||
|
||||
[[LLM: Define data structures and validation:
|
||||
|
||||
- Core business entities
|
||||
- Data validation rules
|
||||
- Relationships between entities
|
||||
- Computed fields and derivations
|
||||
- Data transformation patterns
|
||||
- Serialization formats]]
|
||||
|
||||
##### docs/architecture/database-schema.md
|
||||
|
||||
[[LLM: Document database design:
|
||||
|
||||
- Database type and version
|
||||
- Table/collection structures
|
||||
- Indexes and constraints
|
||||
- Relationships and foreign keys
|
||||
- Migration patterns
|
||||
- Seed data requirements
|
||||
- Backup and recovery procedures]]
|
||||
|
||||
##### docs/architecture/external-apis.md
|
||||
|
||||
[[LLM: Document third-party integrations:
|
||||
|
||||
- List of external services used
|
||||
- Authentication methods for each
|
||||
- API endpoints and usage patterns
|
||||
- Rate limits and quotas
|
||||
- Error handling strategies
|
||||
- Webhook configurations
|
||||
- Data synchronization patterns]]
|
||||
|
||||
#### Frontend Architecture Documents
|
||||
|
||||
##### docs/architecture/frontend-architecture.md
|
||||
|
||||
[[LLM: Document frontend application structure:
|
||||
|
||||
- Component hierarchy and organization
|
||||
- State management patterns
|
||||
- Routing architecture
|
||||
- Data fetching patterns
|
||||
- Authentication flow
|
||||
- Error boundary strategies
|
||||
- Performance optimization patterns]]
|
||||
|
||||
##### docs/architecture/components.md
|
||||
|
||||
[[LLM: Specify UI components:
|
||||
|
||||
- Component library/design system used
|
||||
- Custom component specifications
|
||||
- Props and state for each component
|
||||
- Component composition patterns
|
||||
- Styling approaches
|
||||
- Accessibility requirements
|
||||
- Component testing patterns]]
|
||||
|
||||
##### docs/architecture/core-workflows.md
|
||||
|
||||
[[LLM: Document user interaction flows:
|
||||
|
||||
- Major user journeys
|
||||
- Screen flow diagrams
|
||||
- Form handling patterns
|
||||
- Navigation patterns
|
||||
- Data flow through workflows
|
||||
- Error states and recovery
|
||||
- Loading and transition states]]
|
||||
|
||||
##### docs/architecture/ui-ux-spec.md
|
||||
|
||||
[[LLM: Define UI/UX guidelines:
|
||||
|
||||
- Design system specifications
|
||||
- Color palette and typography
|
||||
- Spacing and layout grids
|
||||
- Responsive breakpoints
|
||||
- Animation and transition guidelines
|
||||
- Accessibility standards
|
||||
- Browser compatibility requirements]]
|
||||
|
||||
### 5. Adaptive Content Strategy
|
||||
|
||||
[[LLM: Adapt your documentation approach based on project characteristics:
|
||||
|
||||
**For Web Applications:**
|
||||
|
||||
- Focus on component patterns, routing, state management
|
||||
- Include build processes, asset handling, and deployment
|
||||
- Cover API integration patterns and data fetching
|
||||
|
||||
**For Backend Services:**
|
||||
|
||||
- Emphasize service architecture, data models, and API design
|
||||
- Include database interaction patterns and migration strategies
|
||||
- Cover authentication, authorization, and security patterns
|
||||
|
||||
**For CLI Tools:**
|
||||
|
||||
- Focus on command structure, argument parsing, and output formatting
|
||||
- Include plugin/extension patterns if applicable
|
||||
- Cover configuration file handling and user interaction patterns
|
||||
|
||||
**For Libraries/Frameworks:**
|
||||
|
||||
- Emphasize public API design and usage patterns
|
||||
- Include extension points and customization approaches
|
||||
- Cover versioning, compatibility, and migration strategies
|
||||
|
||||
**For Mobile Applications:**
|
||||
|
||||
- Focus on platform-specific patterns and navigation
|
||||
- Include state management and data persistence approaches
|
||||
- Cover platform integration and native feature usage
|
||||
|
||||
**For Data Science/ML Projects:**
|
||||
|
||||
- Emphasize data pipeline patterns and model organization
|
||||
- Include experiment tracking and reproducibility approaches
|
||||
- Cover data validation and model deployment patterns
|
||||
]]
|
||||
|
||||
### 6. Quality Assurance
|
||||
|
||||
[[LLM: Before completing each document:
|
||||
|
||||
1. **Accuracy Check**: Verify all file paths, commands, and code examples work
|
||||
2. **Completeness Review**: Ensure the document covers the most important patterns an agent would encounter
|
||||
3. **Clarity Assessment**: Check that explanations are clear and actionable
|
||||
4. **Consistency Verification**: Ensure terminology and patterns align across all documents
|
||||
5. **Agent Perspective**: Review from the viewpoint of an AI agent that needs to contribute to this project
|
||||
|
||||
Ask the user to review each completed document and use the advanced elicitation task to refine based on their feedback.]]
|
||||
|
||||
### 7. Final Integration
|
||||
|
||||
[[LLM: After all documents are completed:
|
||||
|
||||
1. Ensure all documents are created in the proper BMAD-expected locations:
|
||||
|
||||
- Core docs in `docs/` (index.md, prd.md)
|
||||
- Architecture shards in `docs/architecture/` subdirectory
|
||||
- Create the `docs/architecture/` directory if it doesn't exist
|
||||
|
||||
2. Create/update the master index documents:
|
||||
|
||||
- Update `docs/index.md` to reference all documentation
|
||||
- Create `docs/architecture/index.md` listing all architecture shards
|
||||
|
||||
3. Verify document cross-references:
|
||||
|
||||
- Ensure all documents link to related documentation
|
||||
- Check that file paths match the actual project structure
|
||||
- Validate that examples reference real files in the project
|
||||
|
||||
4. Provide maintenance guidance:
|
||||
|
||||
- Document update triggers (when to update each doc)
|
||||
- Create a simple checklist for keeping docs current
|
||||
- Suggest automated validation approaches
|
||||
|
||||
5. Summary report including:
|
||||
- List of all documents created with their paths
|
||||
- Any gaps or areas needing human review
|
||||
- Recommendations for project-specific additions
|
||||
- Next steps for maintaining documentation accuracy
|
||||
|
||||
Present a summary of what was created and ask if any additional documentation would be helpful for AI agents working on this specific project.]]
|
||||
### Key Modules and Their Purpose
|
||||
- **User Management**: `src/services/userService.js` - Handles all user operations
|
||||
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
||||
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
||||
- **[List other key modules with their actual files]**
|
||||
|
||||
## Data Models and APIs
|
||||
|
||||
### Data Models
|
||||
Instead of duplicating, reference actual model files:
|
||||
- **User Model**: See `src/models/User.js`
|
||||
- **Order Model**: See `src/models/Order.js`
|
||||
- **Related Types**: TypeScript definitions in `src/types/`
|
||||
|
||||
### API Specifications
|
||||
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
||||
- **Postman Collection**: `docs/api/postman-collection.json`
|
||||
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
||||
|
||||
## Technical Debt and Known Issues
|
||||
|
||||
### Critical Technical Debt
|
||||
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
||||
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
||||
3. **Database Migrations**: Manually tracked, no proper migration tool
|
||||
4. **[Other significant debt]**
|
||||
|
||||
### Workarounds and Gotchas
|
||||
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
||||
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
||||
- **[Other workarounds developers need to know]**
|
||||
|
||||
## Integration Points and External Dependencies
|
||||
|
||||
### External Services
|
||||
| Service | Purpose | Integration Type | Key Files |
|
||||
|---------|---------|------------------|-----------|
|
||||
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
||||
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
||||
| [etc...] |
|
||||
|
||||
### Internal Integration Points
|
||||
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
||||
- **Background Jobs**: Redis queue, see `src/workers/`
|
||||
- **[Other integrations]**
|
||||
|
||||
## Development and Deployment
|
||||
|
||||
### Local Development Setup
|
||||
1. Actual steps that work (not ideal steps)
|
||||
2. Known issues with setup
|
||||
3. Required environment variables (see `.env.example`)
|
||||
|
||||
### Build and Deployment Process
|
||||
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
||||
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
||||
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
||||
|
||||
## Testing Reality
|
||||
|
||||
### Current Test Coverage
|
||||
- Unit Tests: 60% coverage (Jest)
|
||||
- Integration Tests: Minimal, in `tests/integration/`
|
||||
- E2E Tests: None
|
||||
- Manual Testing: Primary QA method
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
npm test # Runs unit tests
|
||||
npm run test:integration # Runs integration tests (requires local DB)
|
||||
```
|
||||
|
||||
## If Enhancement PRD Provided - Impact Analysis
|
||||
|
||||
### Files That Will Need Modification
|
||||
Based on the enhancement requirements, these files will be affected:
|
||||
- `src/services/userService.js` - Add new user fields
|
||||
- `src/models/User.js` - Update schema
|
||||
- `src/routes/userRoutes.js` - New endpoints
|
||||
- [etc...]
|
||||
|
||||
### New Files/Modules Needed
|
||||
- `src/services/newFeatureService.js` - New business logic
|
||||
- `src/models/NewFeature.js` - New data model
|
||||
- [etc...]
|
||||
|
||||
### Integration Considerations
|
||||
- Will need to integrate with existing auth middleware
|
||||
- Must follow existing response format in `src/utils/responseFormatter.js`
|
||||
- [Other integration points]
|
||||
|
||||
## Appendix - Useful Commands and Scripts
|
||||
|
||||
### Frequently Used Commands
|
||||
```bash
|
||||
npm run dev # Start development server
|
||||
npm run build # Production build
|
||||
npm run migrate # Run database migrations
|
||||
npm run seed # Seed test data
|
||||
```
|
||||
|
||||
### Debugging and Troubleshooting
|
||||
- **Logs**: Check `logs/app.log` for application logs
|
||||
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
||||
- **Common Issues**: See `docs/troubleshooting.md`]]
|
||||
|
||||
### 4. Document Delivery
|
||||
|
||||
[[LLM: After generating the complete architecture document:
|
||||
|
||||
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
||||
- Present the entire document in one response (or multiple if too long)
|
||||
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
||||
- Mention it can be sharded later in IDE if needed
|
||||
|
||||
2. **In IDE Environment**:
|
||||
- Create the document as `docs/brownfield-architecture.md`
|
||||
- Inform user this single document contains all architectural information
|
||||
- Can be sharded later using PO agent if desired
|
||||
|
||||
The document should be comprehensive enough that future agents can understand:
|
||||
- The actual state of the system (not idealized)
|
||||
- Where to find key files and logic
|
||||
- What technical debt exists
|
||||
- What constraints must be respected
|
||||
- If PRD provided: What needs to change for the enhancement]]
|
||||
|
||||
### 5. Quality Assurance
|
||||
|
||||
[[LLM: Before finalizing the document:
|
||||
|
||||
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
||||
2. **Completeness Review**: Ensure all major system components are documented
|
||||
3. **Focus Validation**: If user provided scope, verify relevant areas are emphasized
|
||||
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
||||
5. **Navigation**: Ensure document has clear section structure for easy reference
|
||||
|
||||
Apply the advanced elicitation task after major sections to refine based on user feedback.]]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Documentation enables AI agents to understand project context without additional explanation
|
||||
- All major architectural patterns and coding conventions are captured
|
||||
- Examples reference actual project files and demonstrate real usage
|
||||
- Documentation is structured consistently and easy to navigate
|
||||
- Content is actionable and focuses on what agents need to do, not just understand
|
||||
- Single comprehensive brownfield architecture document created
|
||||
- Document reflects REALITY including technical debt and workarounds
|
||||
- Key files and modules are referenced with actual paths
|
||||
- Models/APIs reference source files rather than duplicating content
|
||||
- If PRD provided: Clear impact analysis showing what needs to change
|
||||
- Document enables AI agents to navigate and understand the actual codebase
|
||||
- Technical constraints and "gotchas" are clearly documented
|
||||
|
||||
## Notes
|
||||
|
||||
- This task is designed to work with any project type, language, or framework
|
||||
- The documentation should reflect the project as it actually is, not as it should be
|
||||
- Focus on patterns that agents can recognize and replicate consistently
|
||||
- Include both positive examples (what to do) and negative examples (what to avoid)
|
||||
- This task creates ONE document that captures the TRUE state of the system
|
||||
- References actual files rather than duplicating content when possible
|
||||
- Documents technical debt, workarounds, and constraints honestly
|
||||
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
||||
- The goal is PRACTICAL documentation for AI agents doing real work
|
||||
@@ -1,97 +0,0 @@
|
||||
# Checklist Validation Task
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
1. **Initial Assessment**
|
||||
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
- Confirm if they want to work through the checklist:
|
||||
- Section by section (interactive mode - very time consuming)
|
||||
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
|
||||
|
||||
2. **Document and Artifact Gathering**
|
||||
|
||||
- Each checklist will specify its required documents/artifacts at the beginning
|
||||
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
|
||||
|
||||
3. **Checklist Processing**
|
||||
|
||||
If in interactive mode:
|
||||
|
||||
- Work through each section of the checklist one at a time
|
||||
- For each section:
|
||||
- Review all items in the section following instructions for that section embedded in the checklist
|
||||
- Check each item against the relevant documentation or artifacts as appropriate
|
||||
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
|
||||
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
|
||||
|
||||
If in YOLO mode:
|
||||
|
||||
- Process all sections at once
|
||||
- Create a comprehensive report of all findings
|
||||
- Present the complete analysis to the user
|
||||
|
||||
4. **Validation Approach**
|
||||
|
||||
For each checklist item:
|
||||
|
||||
- Read and understand the requirement
|
||||
- Look for evidence in the documentation that satisfies the requirement
|
||||
- Consider both explicit mentions and implicit coverage
|
||||
- Aside from this, follow all checklist llm instructions
|
||||
- Mark items as:
|
||||
- ✅ PASS: Requirement clearly met
|
||||
- ❌ FAIL: Requirement not met or insufficient coverage
|
||||
- ⚠️ PARTIAL: Some aspects covered but needs improvement
|
||||
- N/A: Not applicable to this case
|
||||
|
||||
5. **Section Analysis**
|
||||
|
||||
For each section:
|
||||
|
||||
- think step by step to calculate pass rate
|
||||
- Identify common themes in failed items
|
||||
- Provide specific recommendations for improvement
|
||||
- In interactive mode, discuss findings with user
|
||||
- Document any user decisions or explanations
|
||||
|
||||
6. **Final Report**
|
||||
|
||||
Prepare a summary that includes:
|
||||
|
||||
- Overall checklist completion status
|
||||
- Pass rates by section
|
||||
- List of failed items with context
|
||||
- Specific recommendations for improvement
|
||||
- Any sections or items marked as N/A with justification
|
||||
|
||||
## Checklist Execution Methodology
|
||||
|
||||
Each checklist now contains embedded LLM prompts and instructions that will:
|
||||
|
||||
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
|
||||
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
|
||||
3. **Provide contextual guidance** - Section-specific prompts for better validation
|
||||
4. **Generate comprehensive reports** - Final summary with detailed findings
|
||||
|
||||
The LLM will:
|
||||
|
||||
- Execute the complete checklist validation
|
||||
- Present a final report with pass/fail rates and key findings
|
||||
- Offer to provide detailed analysis of any section, especially those with warnings or failures
|
||||
135
bmad-core/tasks/review-story.md
Normal file
135
bmad-core/tasks/review-story.md
Normal file
@@ -0,0 +1,135 @@
|
||||
# review-story
|
||||
|
||||
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
||||
|
||||
[[LLM: QA Agent executing review-story task as Senior Developer]]
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Story status must be "Review"
|
||||
- Developer has completed all tasks and updated the File List
|
||||
- All automated tests are passing
|
||||
|
||||
## Review Process
|
||||
|
||||
1. **Read the Complete Story**
|
||||
- Review all acceptance criteria
|
||||
- Understand the dev notes and requirements
|
||||
- Note any completion notes from the developer
|
||||
|
||||
2. **Focus on the File List**
|
||||
- Verify all files listed were actually created/modified
|
||||
- Check for any missing files that should have been updated
|
||||
|
||||
3. **Senior Developer Code Review**
|
||||
- Review code with the eye of a senior developer
|
||||
- If changes form a cohesive whole, review them together
|
||||
- If changes are independent, review incrementally file by file
|
||||
- Focus on:
|
||||
- Code architecture and design patterns
|
||||
- Refactoring opportunities
|
||||
- Code duplication or inefficiencies
|
||||
- Performance optimizations
|
||||
- Security concerns
|
||||
- Best practices and patterns
|
||||
|
||||
4. **Active Refactoring**
|
||||
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
||||
- When refactoring:
|
||||
- Make the changes directly in the files
|
||||
- Explain WHY you're making the change
|
||||
- Describe HOW the change improves the code
|
||||
- Ensure all tests still pass after refactoring
|
||||
- Update the File List if you modify additional files
|
||||
|
||||
5. **Standards Compliance Check**
|
||||
- Verify adherence to `docs/coding-standards.md`
|
||||
- Check compliance with `docs/unified-project-structure.md`
|
||||
- Validate testing approach against `docs/testing-strategy.md`
|
||||
- Ensure all guidelines mentioned in the story are followed
|
||||
|
||||
6. **Acceptance Criteria Validation**
|
||||
- Verify each AC is fully implemented
|
||||
- Check for any missing functionality
|
||||
- Validate edge cases are handled
|
||||
|
||||
7. **Test Coverage Review**
|
||||
- Ensure unit tests cover edge cases
|
||||
- Add missing tests if critical coverage is lacking
|
||||
- Verify integration tests (if required) are comprehensive
|
||||
- Check that test assertions are meaningful
|
||||
- Look for missing test scenarios
|
||||
|
||||
8. **Documentation and Comments**
|
||||
- Verify code is self-documenting where possible
|
||||
- Add comments for complex logic if missing
|
||||
- Ensure any API changes are documented
|
||||
|
||||
## Append Results to Story File
|
||||
|
||||
After review and any refactoring, append your results to the story file in the QA Results section:
|
||||
|
||||
```markdown
|
||||
## QA Results
|
||||
|
||||
### Review Date: [Date]
|
||||
### Reviewed By: Quinn (Senior Developer QA)
|
||||
|
||||
### Code Quality Assessment
|
||||
[Overall assessment of implementation quality]
|
||||
|
||||
### Refactoring Performed
|
||||
[List any refactoring you performed with explanations]
|
||||
- **File**: [filename]
|
||||
- **Change**: [what was changed]
|
||||
- **Why**: [reason for change]
|
||||
- **How**: [how it improves the code]
|
||||
|
||||
### Compliance Check
|
||||
- Coding Standards: [✓/✗] [notes if any]
|
||||
- Project Structure: [✓/✗] [notes if any]
|
||||
- Testing Strategy: [✓/✗] [notes if any]
|
||||
- All ACs Met: [✓/✗] [notes if any]
|
||||
|
||||
### Improvements Checklist
|
||||
[Check off items you handled yourself, leave unchecked for dev to address]
|
||||
|
||||
- [x] Refactored user service for better error handling (services/user.service.ts)
|
||||
- [x] Added missing edge case tests (services/user.service.test.ts)
|
||||
- [ ] Consider extracting validation logic to separate validator class
|
||||
- [ ] Add integration test for error scenarios
|
||||
- [ ] Update API documentation for new error codes
|
||||
|
||||
### Security Review
|
||||
[Any security concerns found and whether addressed]
|
||||
|
||||
### Performance Considerations
|
||||
[Any performance issues found and whether addressed]
|
||||
|
||||
### Final Status
|
||||
[✓ Approved - Ready for Done] / [✗ Changes Required - See unchecked items above]
|
||||
```
|
||||
|
||||
## Key Principles
|
||||
|
||||
- You are a SENIOR developer reviewing junior/mid-level work
|
||||
- You have the authority and responsibility to improve code directly
|
||||
- Always explain your changes for learning purposes
|
||||
- Balance between perfection and pragmatism
|
||||
- Focus on significant improvements, not nitpicks
|
||||
|
||||
## Blocking Conditions
|
||||
|
||||
Stop the review 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 that require discussion
|
||||
|
||||
## Completion
|
||||
|
||||
After review:
|
||||
1. If all items are checked and approved: Update story status to "Done"
|
||||
2. If unchecked items remain: Keep status as "Review" for dev to address
|
||||
3. Always provide constructive feedback and explanations for learning
|
||||
@@ -6,9 +6,27 @@
|
||||
- Create a folder structure to organize the sharded documents
|
||||
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
||||
|
||||
## Recommended Method: @kayvan/markdown-tree-parser
|
||||
## Primary Method: Automatic with markdown-tree
|
||||
|
||||
[[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
|
||||
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
||||
|
||||
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
||||
|
||||
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
||||
|
||||
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
||||
|
||||
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
||||
|
||||
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
||||
|
||||
1. Set markdownExploder to true in bmad-core/core-config.yml
|
||||
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
|
||||
I will now proceed with the manual sharding process."
|
||||
|
||||
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
||||
|
||||
### Installation and Usage
|
||||
|
||||
@@ -41,19 +59,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
|
||||
---
|
||||
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
||||
|
||||
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
||||
|
||||
### Task Instructions
|
||||
|
||||
### 1. Identify Document and Target Location
|
||||
1. Identify Document and Target Location
|
||||
|
||||
- Determine which document to shard (user-provided path)
|
||||
- Create a new folder under `docs/` with the same name as the document (without extension)
|
||||
- Example: `docs/prd.md` → create folder `docs/prd/`
|
||||
|
||||
### 2. Parse and Extract Sections
|
||||
2. Parse and Extract Sections
|
||||
|
||||
[[LLM: When sharding the document:
|
||||
|
||||
@@ -63,7 +81,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
- Extract the section heading and ALL content until the next level 2 section
|
||||
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
||||
- Be extremely careful with:
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
|
||||
- Mermaid diagrams - preserve the complete diagram syntax
|
||||
- Nested markdown elements
|
||||
- Multi-line content that might contain ## inside code blocks
|
||||
@@ -82,7 +100,7 @@ For each extracted section:
|
||||
|
||||
2. **Adjust heading levels**:
|
||||
|
||||
- The level 2 heading becomes level 1 (# instead of ##)
|
||||
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
||||
- All subsection levels decrease by 1:
|
||||
|
||||
```txt
|
||||
|
||||
248
bmad-core/tasks/update-workflow-plan.md
Normal file
248
bmad-core/tasks/update-workflow-plan.md
Normal file
@@ -0,0 +1,248 @@
|
||||
# Update Workflow Plan Task
|
||||
|
||||
## Purpose
|
||||
|
||||
Update the status of steps in an active workflow plan, mark completions, add notes about deviations, and maintain an accurate record of workflow progress. This task can be called directly by users or automatically by other tasks upon completion.
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 0. Load Plan Configuration
|
||||
|
||||
[[LLM: First load core-config.yml to get plan settings]]
|
||||
|
||||
Check workflow configuration:
|
||||
|
||||
- `workflow.planFile` - Location of the plan (default: docs/workflow-plan.md)
|
||||
- `workflow.trackProgress` - Whether tracking is enabled
|
||||
- `workflow.updateOnCompletion` - Whether to auto-update on task completion
|
||||
|
||||
If tracking is disabled, inform user and exit.
|
||||
|
||||
### 1. Verify Plan Exists
|
||||
|
||||
[[LLM: Check if workflow plan exists at configured location]]
|
||||
|
||||
If no plan exists:
|
||||
|
||||
```
|
||||
No active workflow plan found at {location}.
|
||||
Would you like to create one? Use *plan command.
|
||||
```
|
||||
|
||||
### 2. Determine Update Type
|
||||
|
||||
[[LLM: Ask user what type of update they want to make]]
|
||||
|
||||
Present options:
|
||||
|
||||
```
|
||||
What would you like to update in the workflow plan?
|
||||
|
||||
1. Mark step as complete
|
||||
2. Update current step
|
||||
3. Add deviation note
|
||||
4. Mark decision point resolution
|
||||
5. Update overall status
|
||||
6. View current plan status only
|
||||
|
||||
Please select an option (1-6):
|
||||
```
|
||||
|
||||
### 3. Parse Current Plan
|
||||
|
||||
[[LLM: Read and parse the plan to understand current state]]
|
||||
|
||||
Extract:
|
||||
|
||||
- All steps with their checkbox status
|
||||
- Step IDs from comments (if present)
|
||||
- Current completion percentage
|
||||
- Any existing deviation notes
|
||||
- Decision points and their status
|
||||
|
||||
### 4. Execute Updates
|
||||
|
||||
#### 4.1 Mark Step Complete
|
||||
|
||||
If user selected option 1:
|
||||
|
||||
1. Show numbered list of incomplete steps
|
||||
2. Ask which step to mark complete
|
||||
3. Update the checkbox from `[ ]` to `[x]`
|
||||
4. Add completion timestamp: `<!-- completed: YYYY-MM-DD HH:MM -->`
|
||||
5. If this was the current step, identify next step
|
||||
|
||||
#### 4.2 Update Current Step
|
||||
|
||||
If user selected option 2:
|
||||
|
||||
1. Show all steps with current status
|
||||
2. Ask which step is now current
|
||||
3. Add/move `<!-- current-step -->` marker
|
||||
4. Optionally add note about why sequence changed
|
||||
|
||||
#### 4.3 Add Deviation Note
|
||||
|
||||
If user selected option 3:
|
||||
|
||||
1. Ask for deviation description
|
||||
2. Ask which step this relates to (or general)
|
||||
3. Insert note in appropriate location:
|
||||
|
||||
```markdown
|
||||
> **Deviation Note** (YYYY-MM-DD): {user_note}
|
||||
> Related to: Step X.Y or General workflow
|
||||
```
|
||||
|
||||
#### 4.4 Mark Decision Resolution
|
||||
|
||||
If user selected option 4:
|
||||
|
||||
1. Show pending decision points
|
||||
2. Ask which decision was made
|
||||
3. Record the decision and chosen path
|
||||
4. Update related steps based on decision
|
||||
|
||||
#### 4.5 Update Overall Status
|
||||
|
||||
If user selected option 5:
|
||||
|
||||
1. Show current overall status
|
||||
2. Provide options:
|
||||
- Active (continuing with plan)
|
||||
- Paused (temporarily stopped)
|
||||
- Abandoned (no longer following)
|
||||
- Complete (all steps done)
|
||||
3. Update plan header with new status
|
||||
|
||||
### 5. Automatic Updates (When Called by Tasks)
|
||||
|
||||
[[LLM: When called automatically by another task]]
|
||||
|
||||
If called with parameters:
|
||||
|
||||
```
|
||||
task: {task_name}
|
||||
step_id: {step_identifier}
|
||||
status: complete|skipped|failed
|
||||
note: {optional_note}
|
||||
```
|
||||
|
||||
Automatically:
|
||||
|
||||
1. Find the corresponding step
|
||||
2. Update its status
|
||||
3. Add completion metadata
|
||||
4. Add note if provided
|
||||
5. Calculate new progress percentage
|
||||
|
||||
### 6. Generate Update Summary
|
||||
|
||||
After updates, show summary:
|
||||
|
||||
```
|
||||
✅ Workflow Plan Updated
|
||||
|
||||
Changes made:
|
||||
- {change_1}
|
||||
- {change_2}
|
||||
|
||||
New Status:
|
||||
- Progress: {X}% complete ({completed}/{total} steps)
|
||||
- Current Step: {current_step}
|
||||
- Next Recommended: {next_step}
|
||||
|
||||
Plan location: {file_path}
|
||||
```
|
||||
|
||||
### 7. Integration with Other Tasks
|
||||
|
||||
[[LLM: How other tasks should call this]]
|
||||
|
||||
Other tasks can integrate by:
|
||||
|
||||
1. **After Task Completion**:
|
||||
|
||||
```
|
||||
At end of task execution:
|
||||
- Check if task corresponds to a plan step
|
||||
- If yes, call update-workflow-plan with:
|
||||
- task: {current_task_name}
|
||||
- step_id: {matching_step}
|
||||
- status: complete
|
||||
```
|
||||
|
||||
2. **On Task Failure**:
|
||||
|
||||
```
|
||||
If task fails:
|
||||
- Call update-workflow-plan with:
|
||||
- task: {current_task_name}
|
||||
- status: failed
|
||||
- note: {failure_reason}
|
||||
```
|
||||
|
||||
### 8. Plan Status Display
|
||||
|
||||
[[LLM: When user selects view status only]]
|
||||
|
||||
Display comprehensive status:
|
||||
|
||||
```markdown
|
||||
📋 Workflow Plan Status
|
||||
━━━━━━━━━━━━━━━━━━━━
|
||||
Workflow: {workflow_name}
|
||||
Status: {Active|Paused|Complete}
|
||||
Progress: {X}% complete ({completed}/{total} steps)
|
||||
Last Updated: {timestamp}
|
||||
|
||||
✅ Completed Steps:
|
||||
- [x] Step 1.1: {description} (completed: {date})
|
||||
- [x] Step 1.2: {description} (completed: {date})
|
||||
|
||||
🔄 Current Step:
|
||||
- [ ] Step 2.1: {description} <!-- current-step -->
|
||||
Agent: {agent_name}
|
||||
Task: {task_name}
|
||||
|
||||
📌 Upcoming Steps:
|
||||
- [ ] Step 2.2: {description}
|
||||
- [ ] Step 3.1: {description}
|
||||
|
||||
⚠️ Deviations/Notes:
|
||||
{any_deviation_notes}
|
||||
|
||||
📊 Decision Points:
|
||||
- Decision 1: {status} - {choice_made}
|
||||
- Decision 2: Pending
|
||||
|
||||
💡 Next Action:
|
||||
Based on the plan, you should {recommended_action}
|
||||
```
|
||||
|
||||
## Success Criteria
|
||||
|
||||
The update is successful when:
|
||||
|
||||
1. Plan accurately reflects current workflow state
|
||||
2. All updates are clearly timestamped
|
||||
3. Deviations are documented with reasons
|
||||
4. Progress calculation is correct
|
||||
5. Next steps are clear to user
|
||||
6. Plan remains readable and well-formatted
|
||||
|
||||
## Error Handling
|
||||
|
||||
- **Plan file not found**: Offer to create new plan
|
||||
- **Malformed plan**: Attempt basic updates, warn user
|
||||
- **Write permission error**: Show changes that would be made
|
||||
- **Step not found**: Show available steps, ask for clarification
|
||||
- **Concurrent updates**: Implement simple locking or warn about conflicts
|
||||
|
||||
## Notes
|
||||
|
||||
- Always preserve plan history (don't delete old information)
|
||||
- Keep updates atomic to prevent corruption
|
||||
- Consider creating backup before major updates
|
||||
- Updates should enhance, not complicate, the workflow experience
|
||||
- If plan becomes too cluttered, suggest creating fresh plan for next phase
|
||||
@@ -22,34 +22,45 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Existing Project Overview
|
||||
|
||||
[[LLM: If working in IDE with project loaded, analyze the project structure and existing documentation. If working in web interface, request project upload or detailed project information from user.]]
|
||||
[[LLM: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.]]
|
||||
|
||||
**Project Location**: [[LLM: Note if this is IDE-based analysis or user-provided information]]
|
||||
**Analysis Source**: [[LLM: Indicate one of the following:
|
||||
- Document-project output available at: {{path}}
|
||||
- IDE-based fresh analysis
|
||||
- User-provided information
|
||||
]]
|
||||
|
||||
**Current Project State**: [[LLM: Brief description of what the project currently does and its primary purpose]]
|
||||
**Current Project State**: [[LLM:
|
||||
- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
|
||||
- Otherwise: Brief description of what the project currently does and its primary purpose
|
||||
]]
|
||||
|
||||
### Available Documentation Analysis
|
||||
|
||||
[[LLM: Check for existing documentation in docs folder or provided by user. List what documentation is available and assess its completeness. Required documents include:
|
||||
[[LLM:
|
||||
If document-project was run:
|
||||
- Note: "Document-project analysis available - using existing technical documentation"
|
||||
- List key documents created by document-project
|
||||
- Skip the missing documentation check below
|
||||
|
||||
- Tech stack documentation
|
||||
- Source tree/architecture overview
|
||||
- Coding standards
|
||||
- API documentation or OpenAPI specs
|
||||
- External API integrations
|
||||
- UX/UI guidelines or existing patterns]]
|
||||
Otherwise, check for existing documentation:
|
||||
]]
|
||||
|
||||
**Available Documentation**:
|
||||
|
||||
- [ ] Tech Stack Documentation
|
||||
- [ ] Source Tree/Architecture
|
||||
- [ ] Coding Standards
|
||||
- [ ] API Documentation
|
||||
- [ ] External API Documentation
|
||||
- [ ] UX/UI Guidelines
|
||||
- [ ] Tech Stack Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Source Tree/Architecture [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Coding Standards [[LLM: If from document-project, may be partial]]
|
||||
- [ ] API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] External API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] UX/UI Guidelines [[LLM: May not be in document-project]]
|
||||
- [ ] Technical Debt Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Other: \***\*\_\_\_\*\***
|
||||
|
||||
[[LLM: If critical documentation is missing, STOP and recommend: "I recommend running the document-project task first to generate baseline documentation including tech-stack, source-tree, coding-standards, APIs, external-APIs, and UX/UI information. This will provide the foundation needed for a comprehensive brownfield PRD."]]
|
||||
[[LLM:
|
||||
- If document-project was already run: "Using existing project analysis from document-project output."
|
||||
- If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
|
||||
]]
|
||||
|
||||
### Enhancement Scope Definition
|
||||
|
||||
@@ -139,13 +150,19 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Existing Technology Stack
|
||||
|
||||
[[LLM: Document the current technology stack that must be maintained or integrated with]]
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
||||
- Include version numbers and any noted constraints
|
||||
|
||||
**Languages**: [[LLM: Current programming languages in use]]
|
||||
**Frameworks**: [[LLM: Current frameworks and their versions]]
|
||||
**Database**: [[LLM: Current database technology and schema considerations]]
|
||||
**Infrastructure**: [[LLM: Current deployment and hosting infrastructure]]
|
||||
**External Dependencies**: [[LLM: Current third-party services and APIs]]
|
||||
Otherwise, document the current technology stack:
|
||||
]]
|
||||
|
||||
**Languages**: [[LLM: From document-project or fresh analysis]]
|
||||
**Frameworks**: [[LLM: From document-project or fresh analysis]]
|
||||
**Database**: [[LLM: From document-project or fresh analysis]]
|
||||
**Infrastructure**: [[LLM: From document-project or fresh analysis]]
|
||||
**External Dependencies**: [[LLM: From document-project "External Services" section or fresh analysis]]
|
||||
|
||||
### Integration Approach
|
||||
|
||||
@@ -176,12 +193,19 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Risk Assessment and Mitigation
|
||||
|
||||
[[LLM: Identify risks specific to working with existing codebase]]
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Reference "Technical Debt and Known Issues" section
|
||||
- Include "Workarounds and Gotchas" that might impact enhancement
|
||||
- Note any identified constraints from "Critical Technical Debt"
|
||||
|
||||
**Technical Risks**: [[LLM: Risks related to modifying existing code]]
|
||||
**Integration Risks**: [[LLM: Risks in integrating with existing systems]]
|
||||
**Deployment Risks**: [[LLM: Risks in deploying alongside existing features]]
|
||||
**Mitigation Strategies**: [[LLM: Specific strategies to address identified risks]]
|
||||
Build risk assessment incorporating existing known issues:
|
||||
]]
|
||||
|
||||
**Technical Risks**: [[LLM: Include risks from document-project + new enhancement risks]]
|
||||
**Integration Risks**: [[LLM: Reference integration constraints from document-project]]
|
||||
**Deployment Risks**: [[LLM: Include deployment gotchas from document-project]]
|
||||
**Mitigation Strategies**: [[LLM: Address both existing and new risks]]
|
||||
|
||||
## Epic and Story Structure
|
||||
|
||||
|
||||
@@ -52,6 +52,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
||||
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
||||
|
||||
### File List
|
||||
|
||||
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
||||
@@ -59,3 +63,7 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## QA Results
|
||||
|
||||
[[LLM: QA Agent Results]]
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
# File Resolution Context
|
||||
|
||||
Update the installer/upgrader so that when agents are added to a project (under Add these two lines to any agent's `activation-instructions` for ide installation:
|
||||
|
||||
```yaml
|
||||
- IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
|
||||
- REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
|
||||
```
|
||||
|
||||
and add `root: .bmad-core` as the first root yml property.
|
||||
223
bmad-core/utils/plan-management.md
Normal file
223
bmad-core/utils/plan-management.md
Normal file
@@ -0,0 +1,223 @@
|
||||
# Plan Management Utility
|
||||
|
||||
## Purpose
|
||||
|
||||
Provides utilities for agents and tasks to interact with workflow plans, check progress, update status, and ensure workflow steps are executed in the appropriate sequence.
|
||||
|
||||
## Core Functions
|
||||
|
||||
### 1. Check Plan Existence
|
||||
|
||||
[[LLM: When any agent starts or task begins, check if a workflow plan exists]]
|
||||
|
||||
```
|
||||
Check for workflow plan:
|
||||
1. Look for docs/workflow-plan.md (default location)
|
||||
2. Check core-config.yml for custom plan location
|
||||
3. Return plan status (exists/not exists)
|
||||
```
|
||||
|
||||
### 2. Parse Plan Status
|
||||
|
||||
[[LLM: Extract current progress from the plan document]]
|
||||
|
||||
**Plan Parsing Logic:**
|
||||
|
||||
1. **Identify Step Structure**:
|
||||
- Look for checkbox lines: `- [ ]` or `- [x]`
|
||||
- Extract step IDs from comments: `<!-- step-id: X.Y -->`
|
||||
- Identify agent assignments: `<!-- agent: pm -->`
|
||||
|
||||
2. **Determine Current State**:
|
||||
- Last completed step (highest numbered `[x]`)
|
||||
- Next expected step (first `[ ]` after completed steps)
|
||||
- Overall progress percentage
|
||||
|
||||
3. **Extract Metadata**:
|
||||
- Workflow type from plan header
|
||||
- Decision points and their status
|
||||
- Any deviation notes
|
||||
|
||||
### 3. Sequence Validation
|
||||
|
||||
[[LLM: Check if requested action aligns with plan sequence]]
|
||||
|
||||
**Validation Rules:**
|
||||
|
||||
1. **Strict Mode** (enforceSequence: true):
|
||||
- Must complete steps in exact order
|
||||
- Warn and block if out of sequence
|
||||
- Require explicit override justification
|
||||
|
||||
2. **Flexible Mode** (enforceSequence: false):
|
||||
- Warn about sequence deviation
|
||||
- Allow with confirmation
|
||||
- Log deviation reason
|
||||
|
||||
**Warning Templates:**
|
||||
|
||||
```
|
||||
SEQUENCE WARNING:
|
||||
The workflow plan shows you should complete "{expected_step}" next.
|
||||
You're attempting to: "{requested_action}"
|
||||
|
||||
In strict mode: Block and require plan update
|
||||
In flexible mode: Allow with confirmation
|
||||
```
|
||||
|
||||
### 4. Plan Update Operations
|
||||
|
||||
[[LLM: Provide consistent way to update plan progress]]
|
||||
|
||||
**Update Actions:**
|
||||
|
||||
1. **Mark Step Complete**:
|
||||
- Change `- [ ]` to `- [x]`
|
||||
- Add completion timestamp comment
|
||||
- Update any status metadata
|
||||
|
||||
2. **Add Deviation Note**:
|
||||
- Insert note explaining why sequence changed
|
||||
- Reference the deviation in plan
|
||||
|
||||
3. **Update Current Step Pointer**:
|
||||
- Add/move `<!-- current-step -->` marker
|
||||
- Update last-modified timestamp
|
||||
|
||||
### 5. Integration Instructions
|
||||
|
||||
[[LLM: How agents and tasks should use this utility]]
|
||||
|
||||
**For Agents (startup sequence)**:
|
||||
|
||||
```
|
||||
1. Check if plan exists using this utility
|
||||
2. If exists:
|
||||
- Parse current status
|
||||
- Show user: "Active workflow plan detected. Current step: {X}"
|
||||
- Suggest: "Next recommended action: {next_step}"
|
||||
3. Continue with normal startup
|
||||
```
|
||||
|
||||
**For Tasks (pre-execution)**:
|
||||
|
||||
```
|
||||
1. Check if plan exists
|
||||
2. If exists:
|
||||
- Verify this task aligns with plan
|
||||
- If not aligned:
|
||||
- In strict mode: Show warning and stop
|
||||
- In flexible mode: Show warning and ask for confirmation
|
||||
3. After task completion:
|
||||
- Update plan if task was a planned step
|
||||
- Add note if task was unplanned
|
||||
```
|
||||
|
||||
### 6. Plan Status Report Format
|
||||
|
||||
[[LLM: Standard format for showing plan status]]
|
||||
|
||||
```
|
||||
📋 Workflow Plan Status
|
||||
━━━━━━━━━━━━━━━━━━━━
|
||||
Workflow: {workflow_name}
|
||||
Progress: {X}% complete ({completed}/{total} steps)
|
||||
|
||||
✅ Completed:
|
||||
- {completed_step_1}
|
||||
- {completed_step_2}
|
||||
|
||||
🔄 Current Step:
|
||||
- {current_step_description}
|
||||
|
||||
📌 Upcoming:
|
||||
- {next_step_1}
|
||||
- {next_step_2}
|
||||
|
||||
⚠️ Notes:
|
||||
- {any_deviations_or_notes}
|
||||
```
|
||||
|
||||
### 7. Decision Point Handling
|
||||
|
||||
[[LLM: Special handling for workflow decision points]]
|
||||
|
||||
When encountering a decision point in the plan:
|
||||
|
||||
1. **Identify Decision Marker**: `<!-- decision: {decision_id} -->`
|
||||
2. **Check Decision Status**: Made/Pending
|
||||
3. **If Pending**:
|
||||
- Block progress until decision made
|
||||
- Show options to user
|
||||
- Record decision when made
|
||||
4. **If Made**:
|
||||
- Verify current path aligns with decision
|
||||
- Warn if attempting alternate path
|
||||
|
||||
### 8. Plan Abandonment
|
||||
|
||||
[[LLM: Graceful handling when user wants to stop following plan]]
|
||||
|
||||
If user wants to abandon plan:
|
||||
|
||||
1. Confirm abandonment intent
|
||||
2. Add abandonment note to plan
|
||||
3. Mark plan as "Abandoned" in header
|
||||
4. Stop plan checking for remainder of session
|
||||
5. Suggest creating new plan if needed
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Example 1: Agent Startup Check
|
||||
|
||||
```
|
||||
BMad Master starting...
|
||||
|
||||
[Check for plan]
|
||||
Found active workflow plan: brownfield-fullstack
|
||||
Progress: 40% complete (4/10 steps)
|
||||
Current step: Create PRD (pm agent)
|
||||
|
||||
Suggestion: Based on your plan, you should work with the PM agent next.
|
||||
Use *agent pm to switch, or *plan-status to see full progress.
|
||||
```
|
||||
|
||||
### Example 2: Task Sequence Warning
|
||||
|
||||
```
|
||||
User: *task create-next-story
|
||||
|
||||
[Plan check triggered]
|
||||
⚠️ SEQUENCE WARNING:
|
||||
Your workflow plan indicates the PRD hasn't been created yet.
|
||||
Creating stories before the PRD may lead to incomplete requirements.
|
||||
|
||||
Would you like to:
|
||||
1. Continue anyway (will note deviation in plan)
|
||||
2. Switch to creating PRD first (*agent pm)
|
||||
3. View plan status (*plan-status)
|
||||
```
|
||||
|
||||
### Example 3: Automatic Plan Update
|
||||
|
||||
```
|
||||
[After completing create-doc task for PRD]
|
||||
|
||||
✅ Plan Updated: Marked "Create PRD" as complete
|
||||
📍 Next step: Create Architecture Document (architect agent)
|
||||
```
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
- This utility should be lightweight and fast
|
||||
- Plan parsing should be resilient to format variations
|
||||
- Always preserve user agency - warnings not blocks (unless strict mode)
|
||||
- Plan updates should be atomic to prevent corruption
|
||||
- Consider plan versioning for rollback capability
|
||||
|
||||
## Error Handling
|
||||
|
||||
- Missing plan: Return null, don't error
|
||||
- Malformed plan: Warn but continue, treat as no plan
|
||||
- Update failures: Log but don't block task completion
|
||||
- Parse errors: Fallback to basic text search
|
||||
@@ -1,223 +0,0 @@
|
||||
# Workflow Management
|
||||
|
||||
This utility enables the BMAD orchestrator to manage and execute team workflows.
|
||||
|
||||
## Important: Dynamic Workflow Loading
|
||||
|
||||
The BMAD orchestrator MUST read the available workflows from the current team configuration's `workflows` field. Do not use hardcoded workflow lists. Each team bundle defines its own set of supported workflows based on the agents it includes.
|
||||
|
||||
**Critical Distinction**:
|
||||
|
||||
- When asked "what workflows are available?", show ONLY the workflows defined in the current team bundle's configuration
|
||||
- Use `/agent-list` to show agents in the current bundle
|
||||
- Use `/workflows` to show workflows in the current bundle, NOT any creation tasks
|
||||
|
||||
### Workflow Descriptions
|
||||
|
||||
When displaying workflows, use these descriptions based on the workflow ID:
|
||||
|
||||
- **greenfield-fullstack**: Build a new full-stack application from concept to development
|
||||
- **brownfield-fullstack**: Enhance an existing full-stack application with new features
|
||||
- **greenfield-service**: Build a new backend service or API from concept to development
|
||||
- **brownfield-service**: Enhance an existing backend service or API
|
||||
- **greenfield-ui**: Build a new frontend/UI application from concept to development
|
||||
- **brownfield-ui**: Enhance an existing frontend/UI application
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
### /workflows
|
||||
|
||||
Lists all available workflows for the current team. The available workflows are determined by the team configuration and may include workflows such as:
|
||||
|
||||
- greenfield-fullstack
|
||||
- brownfield-fullstack
|
||||
- greenfield-service
|
||||
- brownfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-ui
|
||||
|
||||
The actual list depends on which team bundle is loaded. When responding to this command, display the workflows that are configured in the current team's `workflows` field.
|
||||
|
||||
Example response format:
|
||||
|
||||
```text
|
||||
Available workflows for [Team Name]:
|
||||
1. [workflow-id] - [Brief description based on workflow type]
|
||||
2. [workflow-id] - [Brief description based on workflow type]
|
||||
[... etc. ...]
|
||||
|
||||
Use /workflow-start {number or id} to begin a workflow.
|
||||
```
|
||||
|
||||
### /workflow-start {workflow-id}
|
||||
|
||||
Starts a specific workflow and transitions to the first agent.
|
||||
|
||||
Example: `/workflow-start greenfield-fullstack`
|
||||
|
||||
### /workflow-status
|
||||
|
||||
Shows current workflow progress, completed artifacts, and next steps.
|
||||
|
||||
Example response:
|
||||
|
||||
```text
|
||||
Current Workflow: Greenfield Full-Stack Development
|
||||
Stage: Product Planning (2 of 6)
|
||||
Completed:
|
||||
✓ Discovery & Requirements
|
||||
- project-brief (completed by Mary)
|
||||
|
||||
In Progress:
|
||||
⚡ Product Planning
|
||||
- Create PRD (John) - awaiting input
|
||||
|
||||
Next: Technical Architecture
|
||||
```
|
||||
|
||||
### /workflow-resume
|
||||
|
||||
Resumes a workflow from where it left off, useful when starting a new chat.
|
||||
|
||||
User can provide completed artifacts:
|
||||
|
||||
```text
|
||||
User: /workflow-resume greenfield-fullstack
|
||||
I have completed: project-brief, PRD
|
||||
BMad: I see you've completed Discovery and part of Product Planning.
|
||||
Based on the greenfield-fullstack workflow, the next step is:
|
||||
- UX Strategy with Sally (ux-expert)
|
||||
|
||||
Would you like me to load Sally to continue?
|
||||
```
|
||||
|
||||
### /workflow-next
|
||||
|
||||
Shows the next recommended agent and action in the current workflow.
|
||||
|
||||
## Workflow Execution Flow
|
||||
|
||||
### 1. Starting a Workflow
|
||||
|
||||
When a workflow is started:
|
||||
|
||||
1. Load the workflow definition
|
||||
2. Identify the first stage and step
|
||||
3. Transition to the required agent
|
||||
4. Provide context about expected inputs/outputs
|
||||
5. Guide artifact creation
|
||||
|
||||
### 2. Stage Transitions
|
||||
|
||||
After each artifact is completed:
|
||||
|
||||
1. Mark the step as complete
|
||||
2. Check transition conditions
|
||||
3. If stage is complete, move to next stage
|
||||
4. Load the appropriate agent
|
||||
5. Pass relevant artifacts as context
|
||||
|
||||
### 3. Artifact Tracking
|
||||
|
||||
Track all created artifacts:
|
||||
|
||||
```yaml
|
||||
workflow_state:
|
||||
current_workflow: greenfield-fullstack
|
||||
current_stage: planning
|
||||
current_step: 2
|
||||
artifacts:
|
||||
project-brief:
|
||||
status: completed
|
||||
created_by: analyst
|
||||
timestamp: 2024-01-15T10:30:00.000Z
|
||||
prd:
|
||||
status: in-progress
|
||||
created_by: pm
|
||||
started: 2024-01-15T11:00:00.000Z
|
||||
```
|
||||
|
||||
### 4. Workflow Interruption Handling
|
||||
|
||||
When user returns after interruption:
|
||||
|
||||
1. Ask if continuing previous workflow
|
||||
2. Request any completed artifacts
|
||||
3. Analyze provided artifacts
|
||||
4. Determine workflow position
|
||||
5. Suggest next appropriate step
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
User: I'm working on a new app. Here's my PRD and architecture doc.
|
||||
BMad: I see you have a PRD and architecture document. Based on these artifacts,
|
||||
it looks like you're following the greenfield-fullstack workflow and have completed
|
||||
stages 1-3. The next recommended step would be:
|
||||
|
||||
Stage 4: Validation & Refinement
|
||||
- Load Sarah (Product Owner) to validate all artifacts
|
||||
|
||||
Would you like to continue with this workflow?
|
||||
```
|
||||
|
||||
## Workflow Context Passing
|
||||
|
||||
When transitioning between agents, pass:
|
||||
|
||||
1. Previous artifacts created
|
||||
2. Current workflow stage
|
||||
3. Expected outputs
|
||||
4. Any decisions or constraints identified
|
||||
|
||||
Example transition:
|
||||
|
||||
```text
|
||||
BMad: Great! John has completed the PRD. According to the greenfield-fullstack workflow,
|
||||
the next step is UX Strategy with Sally.
|
||||
|
||||
/ux-expert
|
||||
|
||||
Sally: I see we're in the Product Planning stage of the greenfield-fullstack workflow.
|
||||
I have access to:
|
||||
- Project Brief from Mary
|
||||
- PRD from John
|
||||
|
||||
Let's create the UX strategy and UI specifications. First, let me review
|
||||
the PRD to understand the features we're designing for...
|
||||
```
|
||||
|
||||
## Multi-Path Workflows
|
||||
|
||||
Some workflows may have multiple paths:
|
||||
|
||||
```yaml
|
||||
conditional_paths:
|
||||
- condition: project_type == 'mobile'
|
||||
next_stage: mobile-specific-design
|
||||
- condition: project_type == 'web'
|
||||
next_stage: web-architecture
|
||||
- default: fullstack-architecture
|
||||
```
|
||||
|
||||
Handle these by asking clarifying questions when needed.
|
||||
|
||||
## Workflow Best Practices
|
||||
|
||||
1. **Always show progress** - Users should know where they are
|
||||
2. **Explain transitions** - Why moving to next agent
|
||||
3. **Preserve context** - Pass relevant information forward
|
||||
4. **Allow flexibility** - Users can skip or modify steps
|
||||
5. **Track everything** - Maintain complete workflow state
|
||||
|
||||
## Integration with Agents
|
||||
|
||||
Each agent should be workflow-aware:
|
||||
|
||||
- Know which workflow is active
|
||||
- Understand their role in the workflow
|
||||
- Access previous artifacts
|
||||
- Know expected outputs
|
||||
- Guide toward workflow goals
|
||||
|
||||
This creates a seamless experience where the entire team works together toward the workflow's objectives.
|
||||
@@ -12,53 +12,243 @@ workflow:
|
||||
- integration-enhancement
|
||||
|
||||
sequence:
|
||||
- step: enhancement_classification
|
||||
agent: analyst
|
||||
action: classify enhancement scope
|
||||
notes: |
|
||||
Determine enhancement complexity to route to appropriate path:
|
||||
- Single story (< 4 hours) → Use brownfield-create-story task
|
||||
- Small feature (1-3 stories) → Use brownfield-create-epic task
|
||||
- Major enhancement (multiple epics) → Continue with full workflow
|
||||
|
||||
Ask user: "Can you describe the enhancement scope? Is this a small fix, a feature addition, or a major enhancement requiring architectural changes?"
|
||||
|
||||
- step: routing_decision
|
||||
condition: based_on_classification
|
||||
routes:
|
||||
single_story:
|
||||
agent: pm
|
||||
uses: brownfield-create-story
|
||||
notes: "Create single story for immediate implementation. Exit workflow after story creation."
|
||||
small_feature:
|
||||
agent: pm
|
||||
uses: brownfield-create-epic
|
||||
notes: "Create focused epic with 1-3 stories. Exit workflow after epic creation."
|
||||
major_enhancement:
|
||||
continue: to_next_step
|
||||
notes: "Continue with comprehensive planning workflow below."
|
||||
|
||||
- step: documentation_check
|
||||
agent: analyst
|
||||
action: check existing documentation
|
||||
condition: major_enhancement_path
|
||||
notes: |
|
||||
Check if adequate project documentation exists:
|
||||
- Look for existing architecture docs, API specs, coding standards
|
||||
- Assess if documentation is current and comprehensive
|
||||
- If adequate: Skip document-project, proceed to PRD
|
||||
- If inadequate: Run document-project first
|
||||
|
||||
- step: project_analysis
|
||||
agent: architect
|
||||
action: analyze existing project and use task document-project
|
||||
creates: multiple documents per the document-project template
|
||||
notes: "Review existing documentation, codebase structure, and identify integration points. Document current system understanding before proceeding."
|
||||
creates: brownfield-architecture.md (or multiple documents)
|
||||
condition: documentation_inadequate
|
||||
notes: "Run document-project to capture current system state, technical debt, and constraints. Pass findings to PRD creation."
|
||||
|
||||
- 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."
|
||||
requires: existing_documentation_or_analysis
|
||||
notes: |
|
||||
Creates PRD for major enhancement. If document-project was run, reference its output to avoid re-analysis.
|
||||
If skipped, use existing project documentation.
|
||||
SAVE OUTPUT: Copy final prd.md to your project's docs/ folder.
|
||||
|
||||
- step: architecture_decision
|
||||
agent: pm/architect
|
||||
action: determine if architecture document needed
|
||||
condition: after_prd_creation
|
||||
notes: |
|
||||
Review PRD to determine if architectural planning is needed:
|
||||
- New architectural patterns → Create architecture doc
|
||||
- New libraries/frameworks → Create architecture doc
|
||||
- Platform/infrastructure changes → Create architecture doc
|
||||
- Following existing patterns → Skip to story creation
|
||||
|
||||
- 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
|
||||
condition: architecture_changes_needed
|
||||
notes: "Creates architecture ONLY for significant architectural changes. 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
|
||||
condition: po_checklist_issues
|
||||
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs_or_brownfield_docs
|
||||
repeats: for_each_epic_or_enhancement
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- For sharded PRD: @sm → *create (uses create-next-story)
|
||||
- For brownfield docs: @sm → use create-brownfield-story task
|
||||
- Creates story from available documentation
|
||||
- Story starts in "Draft" status
|
||||
- May require additional context gathering for brownfield
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Project development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Start: Brownfield Enhancement] --> B[analyst: analyze existing project]
|
||||
B --> C[pm: brownfield-prd.md]
|
||||
C --> D[architect: brownfield-architecture.md]
|
||||
D --> E[po: validate with po-master-checklist]
|
||||
E --> F{PO finds issues?}
|
||||
F -->|Yes| G[Return to relevant agent for fixes]
|
||||
F -->|No| H[Move to IDE Environment]
|
||||
G --> E
|
||||
A[Start: Brownfield Enhancement] --> B[analyst: classify enhancement scope]
|
||||
B --> C{Enhancement Size?}
|
||||
|
||||
C -->|Single Story| D[pm: brownfield-create-story]
|
||||
C -->|1-3 Stories| E[pm: brownfield-create-epic]
|
||||
C -->|Major Enhancement| F[analyst: check documentation]
|
||||
|
||||
D --> END1[To Dev Implementation]
|
||||
E --> END2[To Story Creation]
|
||||
|
||||
F --> G{Docs Adequate?}
|
||||
G -->|No| H[architect: document-project]
|
||||
G -->|Yes| I[pm: brownfield PRD]
|
||||
H --> I
|
||||
|
||||
I --> J{Architecture Needed?}
|
||||
J -->|Yes| K[architect: architecture.md]
|
||||
J -->|No| L[po: validate artifacts]
|
||||
K --> L
|
||||
|
||||
L --> M{PO finds issues?}
|
||||
M -->|Yes| N[Fix issues]
|
||||
M -->|No| O[po: shard documents]
|
||||
N --> L
|
||||
|
||||
O --> P[sm: create story]
|
||||
P --> Q{Story Type?}
|
||||
Q -->|Sharded PRD| R[create-next-story]
|
||||
Q -->|Brownfield Docs| S[create-brownfield-story]
|
||||
|
||||
R --> T{Review draft?}
|
||||
S --> T
|
||||
T -->|Yes| U[review & approve]
|
||||
T -->|No| V[dev: implement]
|
||||
U --> V
|
||||
|
||||
V --> W{QA review?}
|
||||
W -->|Yes| X[qa: review]
|
||||
W -->|No| Y{More stories?}
|
||||
X --> Z{Issues?}
|
||||
Z -->|Yes| AA[dev: fix]
|
||||
Z -->|No| Y
|
||||
AA --> X
|
||||
Y -->|Yes| P
|
||||
Y -->|No| AB{Retrospective?}
|
||||
AB -->|Yes| AC[po: retrospective]
|
||||
AB -->|No| AD[Complete]
|
||||
AC --> AD
|
||||
|
||||
style H fill:#90EE90
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style AD fill:#90EE90
|
||||
style END1 fill:#90EE90
|
||||
style END2 fill:#90EE90
|
||||
style D fill:#87CEEB
|
||||
style E fill:#87CEEB
|
||||
style I fill:#FFE4B5
|
||||
style K fill:#FFE4B5
|
||||
style O fill:#ADD8E6
|
||||
style P fill:#ADD8E6
|
||||
style V fill:#ADD8E6
|
||||
style U fill:#F0E68C
|
||||
style X fill:#F0E68C
|
||||
style AC fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
@@ -70,8 +260,38 @@ 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."
|
||||
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."
|
||||
classification_complete: |
|
||||
Enhancement classified as: {{enhancement_type}}
|
||||
{{if single_story}}: Proceeding with brownfield-create-story task for immediate implementation.
|
||||
{{if small_feature}}: Creating focused epic with brownfield-create-epic task.
|
||||
{{if major_enhancement}}: Continuing with comprehensive planning workflow.
|
||||
|
||||
documentation_assessment: |
|
||||
Documentation assessment complete:
|
||||
{{if adequate}}: Existing documentation is sufficient. Proceeding directly to PRD creation.
|
||||
{{if inadequate}}: Running document-project to capture current system state before PRD.
|
||||
|
||||
document_project_to_pm: |
|
||||
Project analysis complete. Key findings documented in:
|
||||
- {{document_list}}
|
||||
Use these findings to inform PRD creation and avoid re-analyzing the same aspects.
|
||||
|
||||
pm_to_architect_decision: |
|
||||
PRD complete and saved as docs/prd.md.
|
||||
Architectural changes identified: {{yes/no}}
|
||||
{{if yes}}: Proceeding to create architecture document for: {{specific_changes}}
|
||||
{{if no}}: No architectural changes needed. Proceeding to validation.
|
||||
|
||||
architect_to_po: "Architecture complete. Save it as docs/architecture.md. Please validate all artifacts for integration safety."
|
||||
|
||||
po_to_sm: |
|
||||
All artifacts validated.
|
||||
Documentation type available: {{sharded_prd / brownfield_docs}}
|
||||
{{if sharded}}: Use standard create-next-story task.
|
||||
{{if brownfield}}: Use create-brownfield-story task to handle varied documentation formats.
|
||||
|
||||
sm_story_creation: |
|
||||
Creating story from {{documentation_type}}.
|
||||
{{if missing_context}}: May need to gather additional context from user during story creation.
|
||||
|
||||
complete: "All planning artifacts validated and development can begin. Stories will be created based on available documentation format."
|
||||
|
||||
@@ -20,46 +20,155 @@ 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
|
||||
condition: po_checklist_issues
|
||||
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs
|
||||
repeats: for_each_epic
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- SM Agent (New Chat): @sm → *create
|
||||
- Creates next story from sharded docs
|
||||
- Story starts in "Draft" status
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Project development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```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]
|
||||
F -->|No| H[Move to IDE Environment]
|
||||
F -->|No| H[po: shard documents]
|
||||
G --> E
|
||||
|
||||
H --> I[sm: create story]
|
||||
I --> J{Review draft story?}
|
||||
J -->|Yes| K[analyst/pm: review & approve story]
|
||||
J -->|No| L[dev: implement story]
|
||||
K --> L
|
||||
L --> M{QA review?}
|
||||
M -->|Yes| N[qa: review implementation]
|
||||
M -->|No| O{More stories?}
|
||||
N --> P{QA found issues?}
|
||||
P -->|Yes| Q[dev: address QA feedback]
|
||||
P -->|No| O
|
||||
Q --> N
|
||||
O -->|Yes| I
|
||||
O -->|No| R{Epic retrospective?}
|
||||
R -->|Yes| S[po: epic retrospective]
|
||||
R -->|No| T[Project Complete]
|
||||
S --> T
|
||||
|
||||
style H fill:#90EE90
|
||||
style T fill:#90EE90
|
||||
style H fill:#ADD8E6
|
||||
style I fill:#ADD8E6
|
||||
style L fill:#ADD8E6
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style K fill:#F0E68C
|
||||
style N fill:#F0E68C
|
||||
style S fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
@@ -71,8 +180,8 @@ 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."
|
||||
|
||||
@@ -19,56 +19,165 @@ 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
|
||||
condition: po_checklist_issues
|
||||
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs
|
||||
repeats: for_each_epic
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- SM Agent (New Chat): @sm → *create
|
||||
- Creates next story from sharded docs
|
||||
- Story starts in "Draft" status
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Project development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```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]
|
||||
G -->|No| I[Move to IDE Environment]
|
||||
G -->|No| I[po: shard documents]
|
||||
H --> F
|
||||
|
||||
I --> J[sm: create story]
|
||||
J --> K{Review draft story?}
|
||||
K -->|Yes| L[analyst/pm: review & approve story]
|
||||
K -->|No| M[dev: implement story]
|
||||
L --> M
|
||||
M --> N{QA review?}
|
||||
N -->|Yes| O[qa: review implementation]
|
||||
N -->|No| P{More stories?}
|
||||
O --> Q{QA found issues?}
|
||||
Q -->|Yes| R[dev: address QA feedback]
|
||||
Q -->|No| P
|
||||
R --> O
|
||||
P -->|Yes| J
|
||||
P -->|No| S{Epic retrospective?}
|
||||
S -->|Yes| T[po: epic retrospective]
|
||||
S -->|No| U[Project Complete]
|
||||
T --> U
|
||||
|
||||
style I fill:#90EE90
|
||||
style U fill:#90EE90
|
||||
style I fill:#ADD8E6
|
||||
style J fill:#ADD8E6
|
||||
style M fill:#ADD8E6
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style E fill:#FFE4B5
|
||||
style L fill:#F0E68C
|
||||
style O fill:#F0E68C
|
||||
style T fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
@@ -80,9 +189,9 @@ 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."
|
||||
|
||||
@@ -73,9 +73,94 @@ workflow:
|
||||
action: guide_development_sequence
|
||||
notes: "Based on PRD stories: If stories are frontend-heavy, start with frontend project/directory first. If backend-heavy or API-first, start with backend. For tightly coupled features, follow story sequence in monorepo setup. Reference sharded PRD epics for development order."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs
|
||||
repeats: for_each_epic
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- SM Agent (New Chat): @sm → *create
|
||||
- Creates next story from sharded docs
|
||||
- Story starts in "Draft" status
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Project development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
@@ -94,21 +179,45 @@ workflow:
|
||||
G --> H
|
||||
H --> I{PO finds issues?}
|
||||
I -->|Yes| J[Return to relevant agent for fixes]
|
||||
I -->|No| K[Move to IDE Environment]
|
||||
I -->|No| K[po: shard documents]
|
||||
J --> H
|
||||
|
||||
K --> L[sm: create story]
|
||||
L --> M{Review draft story?}
|
||||
M -->|Yes| N[analyst/pm: review & approve story]
|
||||
M -->|No| O[dev: implement story]
|
||||
N --> O
|
||||
O --> P{QA review?}
|
||||
P -->|Yes| Q[qa: review implementation]
|
||||
P -->|No| R{More stories?}
|
||||
Q --> S{QA found issues?}
|
||||
S -->|Yes| T[dev: address QA feedback]
|
||||
S -->|No| R
|
||||
T --> Q
|
||||
R -->|Yes| L
|
||||
R -->|No| U{Epic retrospective?}
|
||||
U -->|Yes| V[po: epic retrospective]
|
||||
U -->|No| W[Project Complete]
|
||||
V --> W
|
||||
|
||||
B -.-> B1[Optional: brainstorming]
|
||||
B -.-> B2[Optional: market research]
|
||||
D -.-> D1[Optional: user research]
|
||||
E -.-> E1[Optional: technical research]
|
||||
|
||||
style K fill:#90EE90
|
||||
style W fill:#90EE90
|
||||
style K fill:#ADD8E6
|
||||
style L fill:#ADD8E6
|
||||
style O fill:#ADD8E6
|
||||
style D3 fill:#E6E6FA
|
||||
style D4 fill:#E6E6FA
|
||||
style B fill:#FFE4B5
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style E fill:#FFE4B5
|
||||
style N fill:#F0E68C
|
||||
style Q fill:#F0E68C
|
||||
style V fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
|
||||
@@ -49,9 +49,94 @@ workflow:
|
||||
condition: po_checklist_issues
|
||||
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs
|
||||
repeats: for_each_epic
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- SM Agent (New Chat): @sm → *create
|
||||
- Creates next story from sharded docs
|
||||
- Story starts in "Draft" status
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Service development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
@@ -65,17 +150,41 @@ workflow:
|
||||
F --> G
|
||||
G --> H{PO finds issues?}
|
||||
H -->|Yes| I[Return to relevant agent for fixes]
|
||||
H -->|No| J[Move to IDE Environment]
|
||||
H -->|No| J[po: shard documents]
|
||||
I --> G
|
||||
|
||||
J --> K[sm: create story]
|
||||
K --> L{Review draft story?}
|
||||
L -->|Yes| M[analyst/pm: review & approve story]
|
||||
L -->|No| N[dev: implement story]
|
||||
M --> N
|
||||
N --> O{QA review?}
|
||||
O -->|Yes| P[qa: review implementation]
|
||||
O -->|No| Q{More stories?}
|
||||
P --> R{QA found issues?}
|
||||
R -->|Yes| S[dev: address QA feedback]
|
||||
R -->|No| Q
|
||||
S --> P
|
||||
Q -->|Yes| K
|
||||
Q -->|No| T{Epic retrospective?}
|
||||
T -->|Yes| U[po: epic retrospective]
|
||||
T -->|No| V[Project Complete]
|
||||
U --> V
|
||||
|
||||
B -.-> B1[Optional: brainstorming]
|
||||
B -.-> B2[Optional: market research]
|
||||
D -.-> D1[Optional: technical research]
|
||||
|
||||
style J fill:#90EE90
|
||||
style V fill:#90EE90
|
||||
style J fill:#ADD8E6
|
||||
style K fill:#ADD8E6
|
||||
style N fill:#ADD8E6
|
||||
style B fill:#FFE4B5
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style M fill:#F0E68C
|
||||
style P fill:#F0E68C
|
||||
style U fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
|
||||
@@ -68,9 +68,94 @@ workflow:
|
||||
condition: user_has_generated_ui
|
||||
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo. For monorepo, place in apps/web or frontend/ directory. Review architecture document for specific guidance."
|
||||
|
||||
- agent: po
|
||||
action: shard_documents
|
||||
creates: sharded_docs
|
||||
requires: all_artifacts_in_project
|
||||
notes: |
|
||||
Shard documents for IDE development:
|
||||
- Option A: Use PO agent to shard: @po then ask to shard docs/prd.md
|
||||
- Option B: Manual: Drag shard-doc task + docs/prd.md into chat
|
||||
- Creates docs/prd/ and docs/architecture/ folders with sharded content
|
||||
|
||||
- agent: sm
|
||||
action: create_story
|
||||
creates: story.md
|
||||
requires: sharded_docs
|
||||
repeats: for_each_epic
|
||||
notes: |
|
||||
Story creation cycle:
|
||||
- SM Agent (New Chat): @sm → *create
|
||||
- Creates next story from sharded docs
|
||||
- Story starts in "Draft" status
|
||||
|
||||
- agent: analyst/pm
|
||||
action: review_draft_story
|
||||
updates: story.md
|
||||
requires: story.md
|
||||
optional: true
|
||||
condition: user_wants_story_review
|
||||
notes: |
|
||||
OPTIONAL: Review and approve draft story
|
||||
- NOTE: story-review task coming soon
|
||||
- Review story completeness and alignment
|
||||
- Update story status: Draft → Approved
|
||||
|
||||
- agent: dev
|
||||
action: implement_story
|
||||
creates: implementation_files
|
||||
requires: story.md
|
||||
notes: |
|
||||
Dev Agent (New Chat): @dev
|
||||
- Implements approved story
|
||||
- Updates File List with all changes
|
||||
- Marks story as "Review" when complete
|
||||
|
||||
- agent: qa
|
||||
action: review_implementation
|
||||
updates: implementation_files
|
||||
requires: implementation_files
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: QA Agent (New Chat): @qa → review-story
|
||||
- Senior dev review with refactoring ability
|
||||
- Fixes small issues directly
|
||||
- Leaves checklist for remaining items
|
||||
- Updates story status (Review → Done or stays Review)
|
||||
|
||||
- agent: dev
|
||||
action: address_qa_feedback
|
||||
updates: implementation_files
|
||||
condition: qa_left_unchecked_items
|
||||
notes: |
|
||||
If QA left unchecked items:
|
||||
- Dev Agent (New Chat): Address remaining items
|
||||
- Return to QA for final approval
|
||||
|
||||
- repeat_development_cycle:
|
||||
action: continue_for_all_stories
|
||||
notes: |
|
||||
Repeat story cycle (SM → Dev → QA) for all epic stories
|
||||
Continue until all stories in PRD are complete
|
||||
|
||||
- agent: po
|
||||
action: epic_retrospective
|
||||
creates: epic-retrospective.md
|
||||
condition: epic_complete
|
||||
optional: true
|
||||
notes: |
|
||||
OPTIONAL: After epic completion
|
||||
- NOTE: epic-retrospective task coming soon
|
||||
- Validate epic was completed correctly
|
||||
- Document learnings and improvements
|
||||
|
||||
- workflow_end:
|
||||
action: move_to_ide
|
||||
notes: "All planning artifacts complete. Move to IDE environment to begin development. Explain to the user the IDE Development Workflow next steps: data#bmad-kb:IDE Development Workflow"
|
||||
action: project_complete
|
||||
notes: |
|
||||
All stories implemented and reviewed!
|
||||
Project development phase complete.
|
||||
|
||||
Reference: data#bmad-kb:IDE Development Workflow
|
||||
|
||||
flow_diagram: |
|
||||
```mermaid
|
||||
@@ -89,21 +174,45 @@ workflow:
|
||||
G --> H
|
||||
H --> I{PO finds issues?}
|
||||
I -->|Yes| J[Return to relevant agent for fixes]
|
||||
I -->|No| K[Move to IDE Environment]
|
||||
I -->|No| K[po: shard documents]
|
||||
J --> H
|
||||
|
||||
K --> L[sm: create story]
|
||||
L --> M{Review draft story?}
|
||||
M -->|Yes| N[analyst/pm: review & approve story]
|
||||
M -->|No| O[dev: implement story]
|
||||
N --> O
|
||||
O --> P{QA review?}
|
||||
P -->|Yes| Q[qa: review implementation]
|
||||
P -->|No| R{More stories?}
|
||||
Q --> S{QA found issues?}
|
||||
S -->|Yes| T[dev: address QA feedback]
|
||||
S -->|No| R
|
||||
T --> Q
|
||||
R -->|Yes| L
|
||||
R -->|No| U{Epic retrospective?}
|
||||
U -->|Yes| V[po: epic retrospective]
|
||||
U -->|No| W[Project Complete]
|
||||
V --> W
|
||||
|
||||
B -.-> B1[Optional: brainstorming]
|
||||
B -.-> B2[Optional: market research]
|
||||
D -.-> D1[Optional: user research]
|
||||
E -.-> E1[Optional: technical research]
|
||||
|
||||
style K fill:#90EE90
|
||||
style W fill:#90EE90
|
||||
style K fill:#ADD8E6
|
||||
style L fill:#ADD8E6
|
||||
style O fill:#ADD8E6
|
||||
style D3 fill:#E6E6FA
|
||||
style D4 fill:#E6E6FA
|
||||
style B fill:#FFE4B5
|
||||
style C fill:#FFE4B5
|
||||
style D fill:#FFE4B5
|
||||
style E fill:#FFE4B5
|
||||
style N fill:#F0E68C
|
||||
style Q fill:#F0E68C
|
||||
style V fill:#F0E68C
|
||||
```
|
||||
|
||||
decision_guidance:
|
||||
|
||||
91
common/tasks/create-doc.md
Normal file
91
common/tasks/create-doc.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# Create Document from Template Task
|
||||
|
||||
## Purpose
|
||||
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## CRITICAL RULES
|
||||
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
## Execution Flow
|
||||
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
### 1. Identify Template
|
||||
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
@@ -2,13 +2,9 @@
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -17,7 +13,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
69
common/utils/workflow-management.md
Normal file
69
common/utils/workflow-management.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
Read available workflows from current team configuration's `workflows` field. Each team bundle defines its own supported workflows.
|
||||
|
||||
**Key Commands**:
|
||||
|
||||
- `/workflows` - List workflows in current bundle or workflows folder
|
||||
- `/agent-list` - Show agents in current bundle
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
### /workflows
|
||||
|
||||
Lists available workflows with titles and descriptions.
|
||||
|
||||
### /workflow-start {workflow-id}
|
||||
|
||||
Starts workflow and transitions to first agent.
|
||||
|
||||
### /workflow-status
|
||||
|
||||
Shows current progress, completed artifacts, and next steps.
|
||||
|
||||
### /workflow-resume
|
||||
|
||||
Resumes workflow from last position. User can provide completed artifacts.
|
||||
|
||||
### /workflow-next
|
||||
|
||||
Shows next recommended agent and action.
|
||||
|
||||
## Execution Flow
|
||||
|
||||
1. **Starting**: Load definition → Identify first stage → Transition to agent → Guide artifact creation
|
||||
|
||||
2. **Stage Transitions**: Mark complete → Check conditions → Load next agent → Pass artifacts
|
||||
|
||||
3. **Artifact Tracking**: Track status, creator, timestamps in workflow_state
|
||||
|
||||
4. **Interruption Handling**: Analyze provided artifacts → Determine position → Suggest next step
|
||||
|
||||
## Context Passing
|
||||
|
||||
When transitioning, pass:
|
||||
|
||||
- Previous artifacts
|
||||
- Current workflow stage
|
||||
- Expected outputs
|
||||
- Decisions/constraints
|
||||
|
||||
## Multi-Path Workflows
|
||||
|
||||
Handle conditional paths by asking clarifying questions when needed.
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. Show progress
|
||||
2. Explain transitions
|
||||
3. Preserve context
|
||||
4. Allow flexibility
|
||||
5. Track state
|
||||
|
||||
## Agent Integration
|
||||
|
||||
Agents should be workflow-aware: know active workflow, their role, access artifacts, understand expected outputs.
|
||||
792
dist/agents/analyst.txt
vendored
792
dist/agents/analyst.txt
vendored
@@ -54,7 +54,7 @@ agent:
|
||||
id: analyst
|
||||
title: Business Analyst
|
||||
icon: 📊
|
||||
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery
|
||||
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, initial project discovery, and documenting existing projects (brownfield)
|
||||
customization: null
|
||||
persona:
|
||||
role: Insightful Analyst & Strategic Ideation Partner
|
||||
@@ -82,6 +82,7 @@ commands:
|
||||
- brainstorm {topic}: Facilitate structured brainstorming session
|
||||
- research {topic}: Generate deep research prompt for investigation
|
||||
- elicit: Run advanced elicitation to clarify requirements
|
||||
- document-project: Analyze and document existing project structure comprehensively
|
||||
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
@@ -89,6 +90,7 @@ dependencies:
|
||||
- create-deep-research-prompt
|
||||
- create-doc
|
||||
- advanced-elicitation
|
||||
- document-project
|
||||
templates:
|
||||
- project-brief-tmpl
|
||||
- market-research-tmpl
|
||||
@@ -650,76 +652,93 @@ Present these numbered options to the user:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#advanced-elicitation ====================
|
||||
@@ -817,6 +836,326 @@ Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
|
||||
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
|
||||
==================== END: tasks#advanced-elicitation ====================
|
||||
|
||||
==================== START: tasks#document-project ====================
|
||||
# Document an Existing Project
|
||||
|
||||
## Purpose
|
||||
|
||||
Generate comprehensive documentation for existing projects optimized for AI development agents. This task creates structured reference materials that enable AI agents to understand project context, conventions, and patterns for effective contribution to any codebase.
|
||||
|
||||
## Task Instructions
|
||||
|
||||
### 1. Initial Project Analysis
|
||||
|
||||
[[LLM: First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
||||
|
||||
**IF PRD EXISTS**:
|
||||
|
||||
- Review the PRD to understand what enhancement/feature is planned
|
||||
- Identify which modules, services, or areas will be affected
|
||||
- Focus documentation ONLY on these relevant areas
|
||||
- Skip unrelated parts of the codebase to keep docs lean
|
||||
|
||||
**IF NO PRD EXISTS**:
|
||||
Ask the user:
|
||||
|
||||
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
||||
|
||||
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
||||
|
||||
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
||||
|
||||
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
||||
- 'Adding payment processing to the user service'
|
||||
- 'Refactoring the authentication module'
|
||||
- 'Integrating with a new third-party API'
|
||||
|
||||
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
||||
|
||||
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
||||
|
||||
Based on their response:
|
||||
|
||||
- If they choose option 1-3: Use that context to focus documentation
|
||||
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
||||
|
||||
Begin by conducting analysis of the existing project. Use available tools to:
|
||||
|
||||
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
||||
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
||||
3. **Build System Analysis**: Find build scripts, CI/CD configurations, and development commands
|
||||
4. **Existing Documentation Review**: Check for README files, docs folders, and any existing documentation
|
||||
5. **Code Pattern Analysis**: Sample key files to understand coding patterns, naming conventions, and architectural approaches
|
||||
|
||||
Ask the user these elicitation questions to better understand their needs:
|
||||
|
||||
- What is the primary purpose of this project?
|
||||
- Are there any specific areas of the codebase that are particularly complex or important for agents to understand?
|
||||
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
||||
- Are there any existing documentation standards or formats you prefer?
|
||||
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
||||
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
||||
]]
|
||||
|
||||
### 2. Deep Codebase Analysis
|
||||
|
||||
[[LLM: Before generating documentation, conduct extensive analysis of the existing codebase:
|
||||
|
||||
1. **Explore Key Areas**:
|
||||
- Entry points (main files, index files, app initializers)
|
||||
- Configuration files and environment setup
|
||||
- Package dependencies and versions
|
||||
- Build and deployment configurations
|
||||
- Test suites and coverage
|
||||
|
||||
2. **Ask Clarifying Questions**:
|
||||
- "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
|
||||
- "What are the most critical/complex parts of this system that developers struggle with?"
|
||||
- "Are there any undocumented 'tribal knowledge' areas I should capture?"
|
||||
- "What technical debt or known issues should I document?"
|
||||
- "Which parts of the codebase change most frequently?"
|
||||
|
||||
3. **Map the Reality**:
|
||||
- Identify ACTUAL patterns used (not theoretical best practices)
|
||||
- Find where key business logic lives
|
||||
- Locate integration points and external dependencies
|
||||
- Document workarounds and technical debt
|
||||
- Note areas that differ from standard patterns
|
||||
|
||||
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement]]
|
||||
|
||||
### 3. Core Documentation Generation
|
||||
|
||||
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
||||
|
||||
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
||||
- Technical debt and workarounds
|
||||
- Inconsistent patterns between different parts
|
||||
- Legacy code that can't be changed
|
||||
- Integration constraints
|
||||
- Performance bottlenecks
|
||||
|
||||
**Document Structure**:
|
||||
|
||||
# [Project Name] Brownfield Architecture Document
|
||||
|
||||
## Introduction
|
||||
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
||||
|
||||
### Document Scope
|
||||
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
||||
[If no PRD: "Comprehensive documentation of entire system"]
|
||||
|
||||
### Change Log
|
||||
| Date | Version | Description | Author |
|
||||
|------|---------|-------------|--------|
|
||||
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
||||
|
||||
## Quick Reference - Key Files and Entry Points
|
||||
|
||||
### Critical Files for Understanding the System
|
||||
- **Main Entry**: `src/index.js` (or actual entry point)
|
||||
- **Configuration**: `config/app.config.js`, `.env.example`
|
||||
- **Core Business Logic**: `src/services/`, `src/domain/`
|
||||
- **API Definitions**: `src/routes/` or link to OpenAPI spec
|
||||
- **Database Models**: `src/models/` or link to schema files
|
||||
- **Key Algorithms**: [List specific files with complex logic]
|
||||
|
||||
### If PRD Provided - Enhancement Impact Areas
|
||||
[Highlight which files/modules will be affected by the planned enhancement]
|
||||
|
||||
## High Level Architecture
|
||||
|
||||
### Technical Summary
|
||||
[Real assessment of architecture - mention if it's well-structured or has issues]
|
||||
|
||||
### Actual Tech Stack (from package.json/requirements.txt)
|
||||
| Category | Technology | Version | Notes |
|
||||
|----------|------------|---------|--------|
|
||||
| Runtime | Node.js | 16.x | [Any constraints] |
|
||||
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
||||
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
||||
| [etc...] |
|
||||
|
||||
### Repository Structure Reality Check
|
||||
- Type: [Monorepo/Polyrepo/Hybrid]
|
||||
- Package Manager: [npm/yarn/pnpm]
|
||||
- Notable: [Any unusual structure decisions]
|
||||
|
||||
## Source Tree and Module Organization
|
||||
|
||||
### Project Structure (Actual)
|
||||
```
|
||||
project-root/
|
||||
├── src/
|
||||
│ ├── controllers/ # HTTP request handlers
|
||||
│ ├── services/ # Business logic (NOTE: inconsistent patterns between user and payment services)
|
||||
│ ├── models/ # Database models (Sequelize)
|
||||
│ ├── utils/ # Mixed bag - needs refactoring
|
||||
│ └── legacy/ # DO NOT MODIFY - old payment system still in use
|
||||
├── tests/ # Jest tests (60% coverage)
|
||||
├── scripts/ # Build and deployment scripts
|
||||
└── config/ # Environment configs
|
||||
```
|
||||
|
||||
### Key Modules and Their Purpose
|
||||
- **User Management**: `src/services/userService.js` - Handles all user operations
|
||||
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
||||
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
||||
- **[List other key modules with their actual files]**
|
||||
|
||||
## Data Models and APIs
|
||||
|
||||
### Data Models
|
||||
Instead of duplicating, reference actual model files:
|
||||
- **User Model**: See `src/models/User.js`
|
||||
- **Order Model**: See `src/models/Order.js`
|
||||
- **Related Types**: TypeScript definitions in `src/types/`
|
||||
|
||||
### API Specifications
|
||||
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
||||
- **Postman Collection**: `docs/api/postman-collection.json`
|
||||
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
||||
|
||||
## Technical Debt and Known Issues
|
||||
|
||||
### Critical Technical Debt
|
||||
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
||||
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
||||
3. **Database Migrations**: Manually tracked, no proper migration tool
|
||||
4. **[Other significant debt]**
|
||||
|
||||
### Workarounds and Gotchas
|
||||
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
||||
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
||||
- **[Other workarounds developers need to know]**
|
||||
|
||||
## Integration Points and External Dependencies
|
||||
|
||||
### External Services
|
||||
| Service | Purpose | Integration Type | Key Files |
|
||||
|---------|---------|------------------|-----------|
|
||||
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
||||
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
||||
| [etc...] |
|
||||
|
||||
### Internal Integration Points
|
||||
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
||||
- **Background Jobs**: Redis queue, see `src/workers/`
|
||||
- **[Other integrations]**
|
||||
|
||||
## Development and Deployment
|
||||
|
||||
### Local Development Setup
|
||||
1. Actual steps that work (not ideal steps)
|
||||
2. Known issues with setup
|
||||
3. Required environment variables (see `.env.example`)
|
||||
|
||||
### Build and Deployment Process
|
||||
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
||||
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
||||
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
||||
|
||||
## Testing Reality
|
||||
|
||||
### Current Test Coverage
|
||||
- Unit Tests: 60% coverage (Jest)
|
||||
- Integration Tests: Minimal, in `tests/integration/`
|
||||
- E2E Tests: None
|
||||
- Manual Testing: Primary QA method
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
npm test # Runs unit tests
|
||||
npm run test:integration # Runs integration tests (requires local DB)
|
||||
```
|
||||
|
||||
## If Enhancement PRD Provided - Impact Analysis
|
||||
|
||||
### Files That Will Need Modification
|
||||
Based on the enhancement requirements, these files will be affected:
|
||||
- `src/services/userService.js` - Add new user fields
|
||||
- `src/models/User.js` - Update schema
|
||||
- `src/routes/userRoutes.js` - New endpoints
|
||||
- [etc...]
|
||||
|
||||
### New Files/Modules Needed
|
||||
- `src/services/newFeatureService.js` - New business logic
|
||||
- `src/models/NewFeature.js` - New data model
|
||||
- [etc...]
|
||||
|
||||
### Integration Considerations
|
||||
- Will need to integrate with existing auth middleware
|
||||
- Must follow existing response format in `src/utils/responseFormatter.js`
|
||||
- [Other integration points]
|
||||
|
||||
## Appendix - Useful Commands and Scripts
|
||||
|
||||
### Frequently Used Commands
|
||||
```bash
|
||||
npm run dev # Start development server
|
||||
npm run build # Production build
|
||||
npm run migrate # Run database migrations
|
||||
npm run seed # Seed test data
|
||||
```
|
||||
|
||||
### Debugging and Troubleshooting
|
||||
- **Logs**: Check `logs/app.log` for application logs
|
||||
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
||||
- **Common Issues**: See `docs/troubleshooting.md`]]
|
||||
|
||||
### 4. Document Delivery
|
||||
|
||||
[[LLM: After generating the complete architecture document:
|
||||
|
||||
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
||||
- Present the entire document in one response (or multiple if too long)
|
||||
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
||||
- Mention it can be sharded later in IDE if needed
|
||||
|
||||
2. **In IDE Environment**:
|
||||
- Create the document as `docs/brownfield-architecture.md`
|
||||
- Inform user this single document contains all architectural information
|
||||
- Can be sharded later using PO agent if desired
|
||||
|
||||
The document should be comprehensive enough that future agents can understand:
|
||||
- The actual state of the system (not idealized)
|
||||
- Where to find key files and logic
|
||||
- What technical debt exists
|
||||
- What constraints must be respected
|
||||
- If PRD provided: What needs to change for the enhancement]]
|
||||
|
||||
### 5. Quality Assurance
|
||||
|
||||
[[LLM: Before finalizing the document:
|
||||
|
||||
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
||||
2. **Completeness Review**: Ensure all major system components are documented
|
||||
3. **Focus Validation**: If user provided scope, verify relevant areas are emphasized
|
||||
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
||||
5. **Navigation**: Ensure document has clear section structure for easy reference
|
||||
|
||||
Apply the advanced elicitation task after major sections to refine based on user feedback.]]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Single comprehensive brownfield architecture document created
|
||||
- Document reflects REALITY including technical debt and workarounds
|
||||
- Key files and modules are referenced with actual paths
|
||||
- Models/APIs reference source files rather than duplicating content
|
||||
- If PRD provided: Clear impact analysis showing what needs to change
|
||||
- Document enables AI agents to navigate and understand the actual codebase
|
||||
- Technical constraints and "gotchas" are clearly documented
|
||||
|
||||
## Notes
|
||||
|
||||
- This task creates ONE document that captures the TRUE state of the system
|
||||
- References actual files rather than duplicating content when possible
|
||||
- Documents technical debt, workarounds, and constraints honestly
|
||||
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
||||
- The goal is PRACTICAL documentation for AI agents doing real work
|
||||
==================== END: tasks#document-project ====================
|
||||
|
||||
==================== START: templates#project-brief-tmpl ====================
|
||||
# Project Brief: {{Project Name}}
|
||||
|
||||
@@ -1633,6 +1972,50 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
3. **Structured Workflows**: Proven patterns guide you from idea to deployed code
|
||||
4. **Clean Handoffs**: Fresh context windows ensure agents stay focused and effective
|
||||
|
||||
### The Two-Phase Approach
|
||||
|
||||
**Phase 1: Planning (Web UI - Cost Effective)**
|
||||
- Use large context windows (Gemini's 1M tokens)
|
||||
- Generate comprehensive documents (PRD, Architecture)
|
||||
- Leverage multiple agents for brainstorming
|
||||
- Create once, use throughout development
|
||||
|
||||
**Phase 2: Development (IDE - Implementation)**
|
||||
- Shard documents into manageable pieces
|
||||
- Execute focused SM → Dev cycles
|
||||
- One story at a time, sequential progress
|
||||
- Real-time file operations and testing
|
||||
|
||||
### The Development Loop
|
||||
|
||||
```text
|
||||
1. SM Agent (New Chat) → Creates next story from sharded docs
|
||||
2. You → Review and approve story
|
||||
3. Dev Agent (New Chat) → Implements approved story
|
||||
4. QA Agent (New Chat) → Reviews and refactors code
|
||||
5. You → Verify completion
|
||||
6. Repeat until epic complete
|
||||
```
|
||||
|
||||
### Why This Works
|
||||
|
||||
- **Context Optimization**: Clean chats = better AI performance
|
||||
- **Role Clarity**: Agents don't context-switch = higher quality
|
||||
- **Incremental Progress**: Small stories = manageable complexity
|
||||
- **Human Oversight**: You validate each step = quality control
|
||||
- **Document-Driven**: Specs guide everything = consistency
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Quick Start Options
|
||||
@@ -1647,7 +2030,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1656,13 +2039,23 @@ npx bmad-method install
|
||||
|
||||
**Installation Steps**:
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
||||
- Select your IDE from supported options:
|
||||
- **Cursor**: Native AI integration
|
||||
- **Claude Code**: Anthropic's official IDE
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
|
||||
**Note for VS Code Users**: BMAD-METHOD assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMAD agents. The installer includes built-in support for Cline and Roo.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**Remember**: At its core, BMAD-METHOD is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMAD - the framework provides the structured prompts and workflows that make AI development effective
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
**Use Web UI for**:
|
||||
@@ -1679,6 +2072,105 @@ npx bmad-method install
|
||||
|
||||
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
|
||||
|
||||
### IDE-Only Workflow Considerations
|
||||
|
||||
**Can you do everything in IDE?** Yes, but understand the tradeoffs:
|
||||
|
||||
**Pros of IDE-Only**:
|
||||
- Single environment workflow
|
||||
- Direct file operations from start
|
||||
- No copy/paste between environments
|
||||
- Immediate project integration
|
||||
|
||||
**Cons of IDE-Only**:
|
||||
- Higher token costs for large document creation
|
||||
- Smaller context windows (varies by IDE/model)
|
||||
- May hit limits during planning phases
|
||||
- Less cost-effective for brainstorming
|
||||
|
||||
**Using Web Agents in IDE**:
|
||||
- **NOT RECOMMENDED**: Web agents (PM, Architect) have rich dependencies designed for large contexts
|
||||
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
||||
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
||||
|
||||
**About bmad-master and bmad-orchestrator**:
|
||||
- **bmad-master**: CAN do any task without switching agents, BUT...
|
||||
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
||||
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
||||
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
||||
|
||||
**CRITICAL RULE for Development**:
|
||||
- **ALWAYS use SM agent for story creation** - Never use bmad-master/orchestrator
|
||||
- **ALWAYS use Dev agent for implementation** - Never use bmad-master/orchestrator
|
||||
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
||||
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
||||
|
||||
**Best Practice for IDE-Only**:
|
||||
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
||||
2. Create documents directly in project
|
||||
3. Shard immediately after creation
|
||||
4. **MUST switch to SM agent** for story creation
|
||||
5. **MUST switch to Dev agent** for implementation
|
||||
6. Keep planning and coding in separate chat sessions
|
||||
|
||||
## Core Configuration (core-config.yml)
|
||||
|
||||
**New in V4**: The `bmad-core/core-config.yml` file is a critical innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
|
||||
### What is core-config.yml?
|
||||
|
||||
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
- **Developer Context**: Specify which files the dev agent should always load
|
||||
- **Debug Support**: Built-in logging for troubleshooting
|
||||
|
||||
### Key Configuration Areas
|
||||
|
||||
#### PRD Configuration
|
||||
- **prdVersion**: Tells agents if PRD follows v3 or v4 conventions
|
||||
- **prdSharded**: Whether epics are embedded (false) or in separate files (true)
|
||||
- **prdShardedLocation**: Where to find sharded epic files
|
||||
- **epicFilePattern**: Pattern for epic filenames (e.g., `epic-{n}*.md`)
|
||||
|
||||
#### Architecture Configuration
|
||||
- **architectureVersion**: v3 (monolithic) or v4 (sharded)
|
||||
- **architectureSharded**: Whether architecture is split into components
|
||||
- **architectureShardedLocation**: Where sharded architecture files live
|
||||
|
||||
#### Developer Files
|
||||
- **devLoadAlwaysFiles**: List of files the dev agent loads for every task
|
||||
- **devDebugLog**: Where dev agent logs repeated failures
|
||||
- **agentCoreDump**: Export location for chat conversations
|
||||
|
||||
### Why It Matters
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
|
||||
**Legacy V3 Project**:
|
||||
```yaml
|
||||
prdVersion: v3
|
||||
prdSharded: false
|
||||
architectureVersion: v3
|
||||
architectureSharded: false
|
||||
```
|
||||
|
||||
**V4 Optimized Project**:
|
||||
```yaml
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs/prd
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
```
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
### Vibe CEO'ing
|
||||
@@ -1739,6 +2231,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1861,10 +2354,16 @@ This architecture enables seamless operation across environments while maintaini
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
### Planning Phase (Web UI Recommended)
|
||||
### Planning Phase (Web UI Recommended - Especially Gemini!)
|
||||
|
||||
**Ideal for cost efficiency, especially with Gemini:**
|
||||
**Ideal for cost efficiency with Gemini's massive context:**
|
||||
|
||||
**For Brownfield Projects - Start Here!**:
|
||||
1. **Upload entire project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Document existing system**: `/analyst` → `*document-project`
|
||||
3. **Creates comprehensive docs** from entire codebase analysis
|
||||
|
||||
**For All Projects**:
|
||||
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
|
||||
2. **Project Brief**: Create foundation document (Analyst or user)
|
||||
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
|
||||
@@ -1898,10 +2397,14 @@ that can handle [specific requirements]."
|
||||
|
||||
**Prerequisites**: Planning documents must exist in `docs/` folder
|
||||
|
||||
1. **Document Sharding**:
|
||||
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
|
||||
- If architecture exists, shard to `docs/architecture/` folder
|
||||
- Results in multiple manageable documents and epic files
|
||||
1. **Document Sharding** (CRITICAL STEP):
|
||||
- Documents created by PM/Architect (in Web or IDE) MUST be sharded for development
|
||||
- Two methods to shard:
|
||||
a) **Manual**: Drag `shard-doc` task + document file into chat
|
||||
b) **Agent**: Ask `@bmad-master` or `@po` to shard documents
|
||||
- Shards `docs/prd.md` → `docs/prd/` folder
|
||||
- Shards `docs/architecture.md` → `docs/architecture/` folder
|
||||
- **WARNING**: Do NOT shard in Web UI - copying many small files is painful!
|
||||
|
||||
2. **Verify Sharded Content**:
|
||||
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
|
||||
@@ -1915,19 +2418,34 @@ that can handle [specific requirements]."
|
||||
|
||||
3. **Development Cycle** (Sequential, one story at a time):
|
||||
|
||||
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
|
||||
**CRITICAL CONTEXT MANAGEMENT**:
|
||||
- **Context windows matter!** Always use fresh, clean context windows
|
||||
- **Model selection matters!** Use most powerful thinking model for SM story creation
|
||||
- **ALWAYS start new chat between SM, Dev, and QA work**
|
||||
|
||||
**Step 1 - Story Creation**:
|
||||
- **NEW CLEAN CHAT** → Select powerful model → `@sm` → `*create`
|
||||
- SM executes create-next-story task
|
||||
- Review generated story in `docs/stories/`
|
||||
- Update status from "Draft" to "Approved"
|
||||
|
||||
**Step 2 - Story Implementation**: New chat window → `@dev`
|
||||
**Step 2 - Story Implementation**:
|
||||
- **NEW CLEAN CHAT** → `@dev`
|
||||
- Agent asks which story to implement
|
||||
- Include story file content to save dev agent lookup time
|
||||
- Dev follows tasks/subtasks, marking completion
|
||||
- Dev leaves notes for SM about any deviations
|
||||
- Update status to "Done"
|
||||
- Dev maintains File List of all changes
|
||||
- Dev marks story as "Review" when complete with all tests passing
|
||||
|
||||
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
|
||||
**Step 3 - Senior QA Review**:
|
||||
- **NEW CLEAN CHAT** → `@qa` → execute review-story task
|
||||
- QA performs senior developer code review
|
||||
- QA can refactor and improve code directly
|
||||
- QA appends results to story's QA Results section
|
||||
- If approved: Status → "Done"
|
||||
- If changes needed: Status stays "Review" with unchecked items for dev
|
||||
|
||||
**Step 4 - Repeat**: Continue SM → Dev → QA cycle until all epic stories complete
|
||||
|
||||
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
|
||||
|
||||
@@ -1947,12 +2465,72 @@ Each status change requires user verification and approval before proceeding.
|
||||
- Development execution
|
||||
- Testing and deployment
|
||||
|
||||
#### Brownfield Enhancement
|
||||
- Current system analysis
|
||||
- Enhancement planning
|
||||
- Impact assessment
|
||||
- Incremental development
|
||||
- Integration testing
|
||||
#### Brownfield Enhancement (Existing Projects)
|
||||
|
||||
**Key Concept**: Brownfield development requires comprehensive documentation of your existing project for AI agents to understand context, patterns, and constraints.
|
||||
|
||||
**Complete Brownfield Workflow Options**:
|
||||
|
||||
**Option 1: PRD-First (Recommended for Large Codebases/Monorepos)**:
|
||||
1. **Upload project to Gemini Web** (GitHub URL, files, or zip)
|
||||
2. **Create PRD first**: `@pm` → `*create-doc brownfield-prd`
|
||||
3. **Focused documentation**: `@analyst` → `*document-project`
|
||||
- Analyst asks for focus if no PRD provided
|
||||
- Choose "single document" format for Web UI
|
||||
- Uses PRD to document ONLY relevant areas
|
||||
- Creates one comprehensive markdown file
|
||||
- Avoids bloating docs with unused code
|
||||
|
||||
**Option 2: Document-First (Good for Smaller Projects)**:
|
||||
1. **Upload project to Gemini Web**
|
||||
2. **Document everything**: `@analyst` → `*document-project`
|
||||
3. **Then create PRD**: `@pm` → `*create-doc brownfield-prd`
|
||||
- More thorough but can create excessive documentation
|
||||
|
||||
2. **Requirements Gathering**:
|
||||
- **Brownfield PRD**: Use PM agent with `brownfield-prd-tmpl`
|
||||
- **Analyzes**: Existing system, constraints, integration points
|
||||
- **Defines**: Enhancement scope, compatibility requirements, risk assessment
|
||||
- **Creates**: Epic and story structure for changes
|
||||
|
||||
3. **Architecture Planning**:
|
||||
- **Brownfield Architecture**: Use Architect agent with `brownfield-architecture-tmpl`
|
||||
- **Integration Strategy**: How new features integrate with existing system
|
||||
- **Migration Planning**: Gradual rollout and backwards compatibility
|
||||
- **Risk Mitigation**: Addressing potential breaking changes
|
||||
|
||||
**Brownfield-Specific Resources**:
|
||||
|
||||
**Templates**:
|
||||
- `brownfield-prd-tmpl.md`: Comprehensive enhancement planning with existing system analysis
|
||||
- `brownfield-architecture-tmpl.md`: Integration-focused architecture for existing systems
|
||||
|
||||
**Tasks**:
|
||||
- `document-project`: Generates comprehensive documentation from existing codebase
|
||||
- `brownfield-create-epic`: Creates single epic for focused enhancements (when full PRD is overkill)
|
||||
- `brownfield-create-story`: Creates individual story for small, isolated changes
|
||||
|
||||
**When to Use Each Approach**:
|
||||
|
||||
**Full Brownfield Workflow** (Recommended for):
|
||||
- Major feature additions
|
||||
- System modernization
|
||||
- Complex integrations
|
||||
- Multiple related changes
|
||||
|
||||
**Quick Epic/Story Creation** (Use when):
|
||||
- Single, focused enhancement
|
||||
- Isolated bug fixes
|
||||
- Small feature additions
|
||||
- Well-documented existing system
|
||||
|
||||
**Critical Success Factors**:
|
||||
1. **Documentation First**: Always run `document-project` if docs are outdated/missing
|
||||
2. **Context Matters**: Provide agents access to relevant code sections
|
||||
3. **Integration Focus**: Emphasize compatibility and non-breaking changes
|
||||
4. **Incremental Approach**: Plan for gradual rollout and testing
|
||||
|
||||
**For detailed guide**: See `docs/working-in-the-brownfield.md`
|
||||
|
||||
## Document Creation Best Practices
|
||||
|
||||
@@ -2033,12 +2611,94 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
**Fork Workflow**:
|
||||
1. Fork the repository
|
||||
2. Create feature branches
|
||||
3. Submit PRs to `next` branch (default) or `main` for critical fixes only
|
||||
4. Keep PRs small: 200-400 lines ideal, 800 lines maximum
|
||||
5. One feature/fix per PR
|
||||
|
||||
**PR Requirements**:
|
||||
- Clear descriptions (max 200 words) with What/Why/How/Testing
|
||||
- Use conventional commits (feat:, fix:, docs:)
|
||||
- Atomic commits - one logical change per commit
|
||||
- Must align with guiding principles
|
||||
|
||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||
- **Natural Language First**: Everything in markdown, no code in core
|
||||
- **Core vs Expansion Packs**: Core for universal needs, packs for specialized domains
|
||||
- **Design Philosophy**: "Dev agents code, planning agents plan"
|
||||
|
||||
## Expansion Packs
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
Expansion packs extend BMAD-METHOD beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
1. **Keep Core Lean**: Dev agents maintain maximum context for coding
|
||||
2. **Domain Expertise**: Deep, specialized knowledge without bloating core
|
||||
3. **Community Innovation**: Anyone can create and share packs
|
||||
4. **Modular Design**: Install only what you need
|
||||
|
||||
### Available Expansion Packs
|
||||
|
||||
**Technical Packs**:
|
||||
- **Infrastructure/DevOps**: Cloud architects, SRE experts, security specialists
|
||||
- **Game Development**: Game designers, level designers, narrative writers
|
||||
- **Mobile Development**: iOS/Android specialists, mobile UX experts
|
||||
- **Data Science**: ML engineers, data scientists, visualization experts
|
||||
|
||||
**Non-Technical Packs**:
|
||||
- **Business Strategy**: Consultants, financial analysts, marketing strategists
|
||||
- **Creative Writing**: Plot architects, character developers, world builders
|
||||
- **Health & Wellness**: Fitness trainers, nutritionists, habit engineers
|
||||
- **Education**: Curriculum designers, assessment specialists
|
||||
- **Legal Support**: Contract analysts, compliance checkers
|
||||
|
||||
**Specialty Packs**:
|
||||
- **Expansion Creator**: Tools to build your own expansion packs
|
||||
- **RPG Game Master**: Tabletop gaming assistance
|
||||
- **Life Event Planning**: Wedding planners, event coordinators
|
||||
- **Scientific Research**: Literature reviewers, methodology designers
|
||||
|
||||
### Using Expansion Packs
|
||||
|
||||
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
||||
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
||||
3. **Install via CLI**:
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# Select "Install expansion pack" option
|
||||
```
|
||||
4. **Use in Your Workflow**: Installed packs integrate seamlessly with existing agents
|
||||
|
||||
### Creating Custom Expansion Packs
|
||||
|
||||
Use the **expansion-creator** pack to build your own:
|
||||
|
||||
1. **Define Domain**: What expertise are you capturing?
|
||||
2. **Design Agents**: Create specialized roles with clear boundaries
|
||||
3. **Build Resources**: Tasks, templates, checklists for your domain
|
||||
4. **Test & Share**: Validate with real use cases, share with community
|
||||
|
||||
**Key Principle**: Expansion packs democratize expertise by making specialized knowledge accessible through AI agents.
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Commands**: Use `/help` in any environment to see available commands
|
||||
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
||||
- **Documentation**: Check `docs/` folder for project-specific context
|
||||
- **Community**: Discord and GitHub resources available for support
|
||||
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
||||
==================== END: data#bmad-kb ====================
|
||||
|
||||
==================== START: utils#template-format ====================
|
||||
|
||||
711
dist/agents/architect.txt
vendored
711
dist/agents/architect.txt
vendored
@@ -107,76 +107,93 @@ dependencies:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#create-deep-research-prompt ====================
|
||||
@@ -494,7 +511,39 @@ Generate comprehensive documentation for existing projects optimized for AI deve
|
||||
|
||||
### 1. Initial Project Analysis
|
||||
|
||||
[[LLM: Begin by conducting a comprehensive analysis of the existing project. Use available tools to:
|
||||
[[LLM: First, check if a PRD or requirements document exists in context. If yes, use it to focus your documentation efforts on relevant areas only.
|
||||
|
||||
**IF PRD EXISTS**:
|
||||
|
||||
- Review the PRD to understand what enhancement/feature is planned
|
||||
- Identify which modules, services, or areas will be affected
|
||||
- Focus documentation ONLY on these relevant areas
|
||||
- Skip unrelated parts of the codebase to keep docs lean
|
||||
|
||||
**IF NO PRD EXISTS**:
|
||||
Ask the user:
|
||||
|
||||
"I notice you haven't provided a PRD or requirements document. To create more focused and useful documentation, I recommend one of these options:
|
||||
|
||||
1. **Create a PRD first** - Would you like me to help create a brownfield PRD before documenting? This helps focus documentation on relevant areas.
|
||||
|
||||
2. **Provide existing requirements** - Do you have a requirements document, epic, or feature description you can share?
|
||||
|
||||
3. **Describe the focus** - Can you briefly describe what enhancement or feature you're planning? For example:
|
||||
- 'Adding payment processing to the user service'
|
||||
- 'Refactoring the authentication module'
|
||||
- 'Integrating with a new third-party API'
|
||||
|
||||
4. **Document everything** - Or should I proceed with comprehensive documentation of the entire codebase? (Note: This may create excessive documentation for large projects)
|
||||
|
||||
Please let me know your preference, or I can proceed with full documentation if you prefer."
|
||||
|
||||
Based on their response:
|
||||
|
||||
- If they choose option 1-3: Use that context to focus documentation
|
||||
- If they choose option 4 or decline: Proceed with comprehensive analysis below
|
||||
|
||||
Begin by conducting analysis of the existing project. Use available tools to:
|
||||
|
||||
1. **Project Structure Discovery**: Examine the root directory structure, identify main folders, and understand the overall organization
|
||||
2. **Technology Stack Identification**: Look for package.json, requirements.txt, Cargo.toml, pom.xml, etc. to identify languages, frameworks, and dependencies
|
||||
@@ -509,370 +558,266 @@ Ask the user these elicitation questions to better understand their needs:
|
||||
- What types of tasks do you expect AI agents to perform on this project? (e.g., bug fixes, feature additions, refactoring, testing)
|
||||
- Are there any existing documentation standards or formats you prefer?
|
||||
- What level of technical detail should the documentation target? (junior developers, senior developers, mixed team)
|
||||
- Is there a specific feature or enhancement you're planning? (This helps focus documentation)
|
||||
]]
|
||||
|
||||
### 2. Core Documentation Generation
|
||||
### 2. Deep Codebase Analysis
|
||||
|
||||
[[LLM: Based on your analysis, generate the following core documentation files. Adapt the content and structure to match the specific project type and context you discovered:
|
||||
[[LLM: Before generating documentation, conduct extensive analysis of the existing codebase:
|
||||
|
||||
**Core Documents (always generate):**
|
||||
1. **Explore Key Areas**:
|
||||
- Entry points (main files, index files, app initializers)
|
||||
- Configuration files and environment setup
|
||||
- Package dependencies and versions
|
||||
- Build and deployment configurations
|
||||
- Test suites and coverage
|
||||
|
||||
1. **docs/index.md** - Master documentation index
|
||||
2. **docs/architecture/index.md** - Architecture documentation index
|
||||
3. **docs/architecture/coding-standards.md** - Coding conventions and style guidelines
|
||||
4. **docs/architecture/tech-stack.md** - Technology stack and version constraints
|
||||
5. **docs/architecture/unified-project-structure.md** - Project structure and organization
|
||||
6. **docs/architecture/testing-strategy.md** - Testing approaches and requirements
|
||||
2. **Ask Clarifying Questions**:
|
||||
- "I see you're using [technology X]. Are there any custom patterns or conventions I should document?"
|
||||
- "What are the most critical/complex parts of this system that developers struggle with?"
|
||||
- "Are there any undocumented 'tribal knowledge' areas I should capture?"
|
||||
- "What technical debt or known issues should I document?"
|
||||
- "Which parts of the codebase change most frequently?"
|
||||
|
||||
**Backend Documents (generate for backend/full-stack projects):**
|
||||
3. **Map the Reality**:
|
||||
- Identify ACTUAL patterns used (not theoretical best practices)
|
||||
- Find where key business logic lives
|
||||
- Locate integration points and external dependencies
|
||||
- Document workarounds and technical debt
|
||||
- Note areas that differ from standard patterns
|
||||
|
||||
7. **docs/architecture/backend-architecture.md** - Backend service patterns and structure
|
||||
8. **docs/architecture/rest-api-spec.md** - API endpoint specifications
|
||||
9. **docs/architecture/data-models.md** - Data structures and validation rules
|
||||
10. **docs/architecture/database-schema.md** - Database design and relationships
|
||||
11. **docs/architecture/external-apis.md** - Third-party integrations
|
||||
**IF PRD PROVIDED**: Also analyze what would need to change for the enhancement]]
|
||||
|
||||
**Frontend Documents (generate for frontend/full-stack projects):**
|
||||
### 3. Core Documentation Generation
|
||||
|
||||
12. **docs/architecture/frontend-architecture.md** - Frontend patterns and structure
|
||||
13. **docs/architecture/components.md** - UI component specifications
|
||||
14. **docs/architecture/core-workflows.md** - User interaction flows
|
||||
15. **docs/architecture/ui-ux-spec.md** - UI/UX specifications and guidelines
|
||||
[[LLM: Generate a comprehensive BROWNFIELD architecture document that reflects the ACTUAL state of the codebase.
|
||||
|
||||
**Additional Documents (generate if applicable):**
|
||||
**CRITICAL**: This is NOT an aspirational architecture document. Document what EXISTS, including:
|
||||
- Technical debt and workarounds
|
||||
- Inconsistent patterns between different parts
|
||||
- Legacy code that can't be changed
|
||||
- Integration constraints
|
||||
- Performance bottlenecks
|
||||
|
||||
16. **docs/prd.md** - Product requirements document (if not exists)
|
||||
17. **docs/architecture/deployment-guide.md** - Deployment and operations info
|
||||
18. **docs/architecture/security-considerations.md** - Security patterns and requirements
|
||||
19. **docs/architecture/performance-guidelines.md** - Performance optimization patterns
|
||||
**Document Structure**:
|
||||
|
||||
**Optional Enhancement Documents:**
|
||||
# [Project Name] Brownfield Architecture Document
|
||||
|
||||
20. **docs/architecture/troubleshooting-guide.md** - Common issues and solutions
|
||||
21. **docs/architecture/changelog-conventions.md** - Change management practices
|
||||
22. **docs/architecture/code-review-checklist.md** - Review standards and practices
|
||||
## Introduction
|
||||
This document captures the CURRENT STATE of the [Project Name] codebase, including technical debt, workarounds, and real-world patterns. It serves as a reference for AI agents working on enhancements.
|
||||
|
||||
Present each document section by section, using the advanced elicitation task after each major section.]]
|
||||
### Document Scope
|
||||
[If PRD provided: "Focused on areas relevant to: {enhancement description}"]
|
||||
[If no PRD: "Comprehensive documentation of entire system"]
|
||||
|
||||
### 3. Document Structure Template
|
||||
### Change Log
|
||||
| Date | Version | Description | Author |
|
||||
|------|---------|-------------|--------|
|
||||
| [Date] | 1.0 | Initial brownfield analysis | [Analyst] |
|
||||
|
||||
[[LLM: Use this standardized structure for each documentation file, adapting content as needed:
|
||||
## Quick Reference - Key Files and Entry Points
|
||||
|
||||
```markdown
|
||||
# {{Document Title}}
|
||||
### Critical Files for Understanding the System
|
||||
- **Main Entry**: `src/index.js` (or actual entry point)
|
||||
- **Configuration**: `config/app.config.js`, `.env.example`
|
||||
- **Core Business Logic**: `src/services/`, `src/domain/`
|
||||
- **API Definitions**: `src/routes/` or link to OpenAPI spec
|
||||
- **Database Models**: `src/models/` or link to schema files
|
||||
- **Key Algorithms**: [List specific files with complex logic]
|
||||
|
||||
## Overview
|
||||
### If PRD Provided - Enhancement Impact Areas
|
||||
[Highlight which files/modules will be affected by the planned enhancement]
|
||||
|
||||
{{Brief description of what this document covers and why it's important for AI agents}}
|
||||
## High Level Architecture
|
||||
|
||||
## Quick Reference
|
||||
### Technical Summary
|
||||
[Real assessment of architecture - mention if it's well-structured or has issues]
|
||||
|
||||
{{Key points, commands, or patterns that agents need most frequently}}
|
||||
### Actual Tech Stack (from package.json/requirements.txt)
|
||||
| Category | Technology | Version | Notes |
|
||||
|----------|------------|---------|--------|
|
||||
| Runtime | Node.js | 16.x | [Any constraints] |
|
||||
| Framework | Express | 4.18.2 | [Custom middleware?] |
|
||||
| Database | PostgreSQL | 13 | [Connection pooling setup] |
|
||||
| [etc...] |
|
||||
|
||||
## Detailed Information
|
||||
### Repository Structure Reality Check
|
||||
- Type: [Monorepo/Polyrepo/Hybrid]
|
||||
- Package Manager: [npm/yarn/pnpm]
|
||||
- Notable: [Any unusual structure decisions]
|
||||
|
||||
{{Comprehensive information organized into logical sections}}
|
||||
## Source Tree and Module Organization
|
||||
|
||||
## Examples
|
||||
|
||||
{{Concrete examples showing proper usage or implementation}}
|
||||
|
||||
## Common Patterns
|
||||
|
||||
{{Recurring patterns agents should recognize and follow}}
|
||||
|
||||
## Things to Avoid
|
||||
|
||||
{{Anti-patterns, deprecated approaches, or common mistakes}}
|
||||
|
||||
## Related Resources
|
||||
|
||||
{{Links to other relevant documentation or external resources}}
|
||||
### Project Structure (Actual)
|
||||
```
|
||||
project-root/
|
||||
├── src/
|
||||
│ ├── controllers/ # HTTP request handlers
|
||||
│ ├── services/ # Business logic (NOTE: inconsistent patterns between user and payment services)
|
||||
│ ├── models/ # Database models (Sequelize)
|
||||
│ ├── utils/ # Mixed bag - needs refactoring
|
||||
│ └── legacy/ # DO NOT MODIFY - old payment system still in use
|
||||
├── tests/ # Jest tests (60% coverage)
|
||||
├── scripts/ # Build and deployment scripts
|
||||
└── config/ # Environment configs
|
||||
```
|
||||
|
||||
Each document should be:
|
||||
|
||||
- **Concrete and actionable** - Focus on what agents need to do, not just concepts
|
||||
- **Pattern-focused** - Highlight recurring patterns agents can recognize and replicate
|
||||
- **Example-rich** - Include specific code examples and real file references
|
||||
- **Context-aware** - Reference actual project files, folders, and conventions
|
||||
- **Assumption-free** - Don't assume agents know project history or implicit knowledge
|
||||
]]
|
||||
|
||||
### 4. Content Guidelines for Each Document Type
|
||||
|
||||
#### Core Architecture Documents
|
||||
|
||||
##### docs/architecture/index.md
|
||||
|
||||
[[LLM: Create a comprehensive index of all architecture documentation:
|
||||
|
||||
- List all architecture documents with brief descriptions
|
||||
- Group documents by category (backend, frontend, shared)
|
||||
- Include quick links to key sections
|
||||
- Provide reading order recommendations for different use cases]]
|
||||
|
||||
##### docs/architecture/unified-project-structure.md
|
||||
|
||||
[[LLM: Document the complete project structure:
|
||||
|
||||
- Root-level directory structure with explanations
|
||||
- Where each type of code belongs (backend, frontend, tests, etc.)
|
||||
- File naming conventions and patterns
|
||||
- Module/package organization
|
||||
- Generated vs. source file locations
|
||||
- Build output locations]]
|
||||
|
||||
##### docs/architecture/coding-standards.md
|
||||
|
||||
[[LLM: Capture project-wide coding conventions:
|
||||
|
||||
- Language-specific style guidelines
|
||||
- Naming conventions (variables, functions, classes, files)
|
||||
- Code organization within files
|
||||
- Import/export patterns
|
||||
- Comment and documentation standards
|
||||
- Linting and formatting tool configurations
|
||||
- Git commit message conventions]]
|
||||
|
||||
##### docs/architecture/tech-stack.md
|
||||
|
||||
[[LLM: Document all technologies and versions:
|
||||
|
||||
- Primary languages and versions
|
||||
- Frameworks and major libraries with versions
|
||||
- Development tools and their versions
|
||||
- Database systems and versions
|
||||
- External services and APIs used
|
||||
- Browser/runtime requirements]]
|
||||
|
||||
##### docs/architecture/testing-strategy.md
|
||||
|
||||
[[LLM: Define testing approaches and requirements:
|
||||
|
||||
- Test file locations and naming conventions
|
||||
- Unit testing patterns and frameworks
|
||||
- Integration testing approaches
|
||||
- E2E testing setup (if applicable)
|
||||
- Test coverage requirements
|
||||
- Mocking strategies
|
||||
- Test data management]]
|
||||
|
||||
#### Backend Architecture Documents
|
||||
|
||||
##### docs/architecture/backend-architecture.md
|
||||
|
||||
[[LLM: Document backend service structure:
|
||||
|
||||
- Service layer organization
|
||||
- Controller/route patterns
|
||||
- Middleware architecture
|
||||
- Authentication/authorization patterns
|
||||
- Request/response flow
|
||||
- Background job processing
|
||||
- Service communication patterns]]
|
||||
|
||||
##### docs/architecture/rest-api-spec.md
|
||||
|
||||
[[LLM: Specify all API endpoints:
|
||||
|
||||
- Base URL and versioning strategy
|
||||
- Authentication methods
|
||||
- Common headers and parameters
|
||||
- Each endpoint with:
|
||||
- HTTP method and path
|
||||
- Request parameters/body
|
||||
- Response format and status codes
|
||||
- Error responses
|
||||
- Rate limiting and quotas]]
|
||||
|
||||
##### docs/architecture/data-models.md
|
||||
|
||||
[[LLM: Define data structures and validation:
|
||||
|
||||
- Core business entities
|
||||
- Data validation rules
|
||||
- Relationships between entities
|
||||
- Computed fields and derivations
|
||||
- Data transformation patterns
|
||||
- Serialization formats]]
|
||||
|
||||
##### docs/architecture/database-schema.md
|
||||
|
||||
[[LLM: Document database design:
|
||||
|
||||
- Database type and version
|
||||
- Table/collection structures
|
||||
- Indexes and constraints
|
||||
- Relationships and foreign keys
|
||||
- Migration patterns
|
||||
- Seed data requirements
|
||||
- Backup and recovery procedures]]
|
||||
|
||||
##### docs/architecture/external-apis.md
|
||||
|
||||
[[LLM: Document third-party integrations:
|
||||
|
||||
- List of external services used
|
||||
- Authentication methods for each
|
||||
- API endpoints and usage patterns
|
||||
- Rate limits and quotas
|
||||
- Error handling strategies
|
||||
- Webhook configurations
|
||||
- Data synchronization patterns]]
|
||||
|
||||
#### Frontend Architecture Documents
|
||||
|
||||
##### docs/architecture/frontend-architecture.md
|
||||
|
||||
[[LLM: Document frontend application structure:
|
||||
|
||||
- Component hierarchy and organization
|
||||
- State management patterns
|
||||
- Routing architecture
|
||||
- Data fetching patterns
|
||||
- Authentication flow
|
||||
- Error boundary strategies
|
||||
- Performance optimization patterns]]
|
||||
|
||||
##### docs/architecture/components.md
|
||||
|
||||
[[LLM: Specify UI components:
|
||||
|
||||
- Component library/design system used
|
||||
- Custom component specifications
|
||||
- Props and state for each component
|
||||
- Component composition patterns
|
||||
- Styling approaches
|
||||
- Accessibility requirements
|
||||
- Component testing patterns]]
|
||||
|
||||
##### docs/architecture/core-workflows.md
|
||||
|
||||
[[LLM: Document user interaction flows:
|
||||
|
||||
- Major user journeys
|
||||
- Screen flow diagrams
|
||||
- Form handling patterns
|
||||
- Navigation patterns
|
||||
- Data flow through workflows
|
||||
- Error states and recovery
|
||||
- Loading and transition states]]
|
||||
|
||||
##### docs/architecture/ui-ux-spec.md
|
||||
|
||||
[[LLM: Define UI/UX guidelines:
|
||||
|
||||
- Design system specifications
|
||||
- Color palette and typography
|
||||
- Spacing and layout grids
|
||||
- Responsive breakpoints
|
||||
- Animation and transition guidelines
|
||||
- Accessibility standards
|
||||
- Browser compatibility requirements]]
|
||||
|
||||
### 5. Adaptive Content Strategy
|
||||
|
||||
[[LLM: Adapt your documentation approach based on project characteristics:
|
||||
|
||||
**For Web Applications:**
|
||||
|
||||
- Focus on component patterns, routing, state management
|
||||
- Include build processes, asset handling, and deployment
|
||||
- Cover API integration patterns and data fetching
|
||||
|
||||
**For Backend Services:**
|
||||
|
||||
- Emphasize service architecture, data models, and API design
|
||||
- Include database interaction patterns and migration strategies
|
||||
- Cover authentication, authorization, and security patterns
|
||||
|
||||
**For CLI Tools:**
|
||||
|
||||
- Focus on command structure, argument parsing, and output formatting
|
||||
- Include plugin/extension patterns if applicable
|
||||
- Cover configuration file handling and user interaction patterns
|
||||
|
||||
**For Libraries/Frameworks:**
|
||||
|
||||
- Emphasize public API design and usage patterns
|
||||
- Include extension points and customization approaches
|
||||
- Cover versioning, compatibility, and migration strategies
|
||||
|
||||
**For Mobile Applications:**
|
||||
|
||||
- Focus on platform-specific patterns and navigation
|
||||
- Include state management and data persistence approaches
|
||||
- Cover platform integration and native feature usage
|
||||
|
||||
**For Data Science/ML Projects:**
|
||||
|
||||
- Emphasize data pipeline patterns and model organization
|
||||
- Include experiment tracking and reproducibility approaches
|
||||
- Cover data validation and model deployment patterns
|
||||
]]
|
||||
|
||||
### 6. Quality Assurance
|
||||
|
||||
[[LLM: Before completing each document:
|
||||
|
||||
1. **Accuracy Check**: Verify all file paths, commands, and code examples work
|
||||
2. **Completeness Review**: Ensure the document covers the most important patterns an agent would encounter
|
||||
3. **Clarity Assessment**: Check that explanations are clear and actionable
|
||||
4. **Consistency Verification**: Ensure terminology and patterns align across all documents
|
||||
5. **Agent Perspective**: Review from the viewpoint of an AI agent that needs to contribute to this project
|
||||
|
||||
Ask the user to review each completed document and use the advanced elicitation task to refine based on their feedback.]]
|
||||
|
||||
### 7. Final Integration
|
||||
|
||||
[[LLM: After all documents are completed:
|
||||
|
||||
1. Ensure all documents are created in the proper BMAD-expected locations:
|
||||
|
||||
- Core docs in `docs/` (index.md, prd.md)
|
||||
- Architecture shards in `docs/architecture/` subdirectory
|
||||
- Create the `docs/architecture/` directory if it doesn't exist
|
||||
|
||||
2. Create/update the master index documents:
|
||||
|
||||
- Update `docs/index.md` to reference all documentation
|
||||
- Create `docs/architecture/index.md` listing all architecture shards
|
||||
|
||||
3. Verify document cross-references:
|
||||
|
||||
- Ensure all documents link to related documentation
|
||||
- Check that file paths match the actual project structure
|
||||
- Validate that examples reference real files in the project
|
||||
|
||||
4. Provide maintenance guidance:
|
||||
|
||||
- Document update triggers (when to update each doc)
|
||||
- Create a simple checklist for keeping docs current
|
||||
- Suggest automated validation approaches
|
||||
|
||||
5. Summary report including:
|
||||
- List of all documents created with their paths
|
||||
- Any gaps or areas needing human review
|
||||
- Recommendations for project-specific additions
|
||||
- Next steps for maintaining documentation accuracy
|
||||
|
||||
Present a summary of what was created and ask if any additional documentation would be helpful for AI agents working on this specific project.]]
|
||||
### Key Modules and Their Purpose
|
||||
- **User Management**: `src/services/userService.js` - Handles all user operations
|
||||
- **Authentication**: `src/middleware/auth.js` - JWT-based, custom implementation
|
||||
- **Payment Processing**: `src/legacy/payment.js` - CRITICAL: Do not refactor, tightly coupled
|
||||
- **[List other key modules with their actual files]**
|
||||
|
||||
## Data Models and APIs
|
||||
|
||||
### Data Models
|
||||
Instead of duplicating, reference actual model files:
|
||||
- **User Model**: See `src/models/User.js`
|
||||
- **Order Model**: See `src/models/Order.js`
|
||||
- **Related Types**: TypeScript definitions in `src/types/`
|
||||
|
||||
### API Specifications
|
||||
- **OpenAPI Spec**: `docs/api/openapi.yaml` (if exists)
|
||||
- **Postman Collection**: `docs/api/postman-collection.json`
|
||||
- **Manual Endpoints**: [List any undocumented endpoints discovered]
|
||||
|
||||
## Technical Debt and Known Issues
|
||||
|
||||
### Critical Technical Debt
|
||||
1. **Payment Service**: Legacy code in `src/legacy/payment.js` - tightly coupled, no tests
|
||||
2. **User Service**: Different pattern than other services, uses callbacks instead of promises
|
||||
3. **Database Migrations**: Manually tracked, no proper migration tool
|
||||
4. **[Other significant debt]**
|
||||
|
||||
### Workarounds and Gotchas
|
||||
- **Environment Variables**: Must set `NODE_ENV=production` even for staging (historical reason)
|
||||
- **Database Connections**: Connection pool hardcoded to 10, changing breaks payment service
|
||||
- **[Other workarounds developers need to know]**
|
||||
|
||||
## Integration Points and External Dependencies
|
||||
|
||||
### External Services
|
||||
| Service | Purpose | Integration Type | Key Files |
|
||||
|---------|---------|------------------|-----------|
|
||||
| Stripe | Payments | REST API | `src/integrations/stripe/` |
|
||||
| SendGrid | Emails | SDK | `src/services/emailService.js` |
|
||||
| [etc...] |
|
||||
|
||||
### Internal Integration Points
|
||||
- **Frontend Communication**: REST API on port 3000, expects specific headers
|
||||
- **Background Jobs**: Redis queue, see `src/workers/`
|
||||
- **[Other integrations]**
|
||||
|
||||
## Development and Deployment
|
||||
|
||||
### Local Development Setup
|
||||
1. Actual steps that work (not ideal steps)
|
||||
2. Known issues with setup
|
||||
3. Required environment variables (see `.env.example`)
|
||||
|
||||
### Build and Deployment Process
|
||||
- **Build Command**: `npm run build` (webpack config in `webpack.config.js`)
|
||||
- **Deployment**: Manual deployment via `scripts/deploy.sh`
|
||||
- **Environments**: Dev, Staging, Prod (see `config/environments/`)
|
||||
|
||||
## Testing Reality
|
||||
|
||||
### Current Test Coverage
|
||||
- Unit Tests: 60% coverage (Jest)
|
||||
- Integration Tests: Minimal, in `tests/integration/`
|
||||
- E2E Tests: None
|
||||
- Manual Testing: Primary QA method
|
||||
|
||||
### Running Tests
|
||||
```bash
|
||||
npm test # Runs unit tests
|
||||
npm run test:integration # Runs integration tests (requires local DB)
|
||||
```
|
||||
|
||||
## If Enhancement PRD Provided - Impact Analysis
|
||||
|
||||
### Files That Will Need Modification
|
||||
Based on the enhancement requirements, these files will be affected:
|
||||
- `src/services/userService.js` - Add new user fields
|
||||
- `src/models/User.js` - Update schema
|
||||
- `src/routes/userRoutes.js` - New endpoints
|
||||
- [etc...]
|
||||
|
||||
### New Files/Modules Needed
|
||||
- `src/services/newFeatureService.js` - New business logic
|
||||
- `src/models/NewFeature.js` - New data model
|
||||
- [etc...]
|
||||
|
||||
### Integration Considerations
|
||||
- Will need to integrate with existing auth middleware
|
||||
- Must follow existing response format in `src/utils/responseFormatter.js`
|
||||
- [Other integration points]
|
||||
|
||||
## Appendix - Useful Commands and Scripts
|
||||
|
||||
### Frequently Used Commands
|
||||
```bash
|
||||
npm run dev # Start development server
|
||||
npm run build # Production build
|
||||
npm run migrate # Run database migrations
|
||||
npm run seed # Seed test data
|
||||
```
|
||||
|
||||
### Debugging and Troubleshooting
|
||||
- **Logs**: Check `logs/app.log` for application logs
|
||||
- **Debug Mode**: Set `DEBUG=app:*` for verbose logging
|
||||
- **Common Issues**: See `docs/troubleshooting.md`]]
|
||||
|
||||
### 4. Document Delivery
|
||||
|
||||
[[LLM: After generating the complete architecture document:
|
||||
|
||||
1. **In Web UI (Gemini, ChatGPT, Claude)**:
|
||||
- Present the entire document in one response (or multiple if too long)
|
||||
- Tell user to copy and save as `docs/brownfield-architecture.md` or `docs/project-architecture.md`
|
||||
- Mention it can be sharded later in IDE if needed
|
||||
|
||||
2. **In IDE Environment**:
|
||||
- Create the document as `docs/brownfield-architecture.md`
|
||||
- Inform user this single document contains all architectural information
|
||||
- Can be sharded later using PO agent if desired
|
||||
|
||||
The document should be comprehensive enough that future agents can understand:
|
||||
- The actual state of the system (not idealized)
|
||||
- Where to find key files and logic
|
||||
- What technical debt exists
|
||||
- What constraints must be respected
|
||||
- If PRD provided: What needs to change for the enhancement]]
|
||||
|
||||
### 5. Quality Assurance
|
||||
|
||||
[[LLM: Before finalizing the document:
|
||||
|
||||
1. **Accuracy Check**: Verify all technical details match the actual codebase
|
||||
2. **Completeness Review**: Ensure all major system components are documented
|
||||
3. **Focus Validation**: If user provided scope, verify relevant areas are emphasized
|
||||
4. **Clarity Assessment**: Check that explanations are clear for AI agents
|
||||
5. **Navigation**: Ensure document has clear section structure for easy reference
|
||||
|
||||
Apply the advanced elicitation task after major sections to refine based on user feedback.]]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- Documentation enables AI agents to understand project context without additional explanation
|
||||
- All major architectural patterns and coding conventions are captured
|
||||
- Examples reference actual project files and demonstrate real usage
|
||||
- Documentation is structured consistently and easy to navigate
|
||||
- Content is actionable and focuses on what agents need to do, not just understand
|
||||
- Single comprehensive brownfield architecture document created
|
||||
- Document reflects REALITY including technical debt and workarounds
|
||||
- Key files and modules are referenced with actual paths
|
||||
- Models/APIs reference source files rather than duplicating content
|
||||
- If PRD provided: Clear impact analysis showing what needs to change
|
||||
- Document enables AI agents to navigate and understand the actual codebase
|
||||
- Technical constraints and "gotchas" are clearly documented
|
||||
|
||||
## Notes
|
||||
|
||||
- This task is designed to work with any project type, language, or framework
|
||||
- The documentation should reflect the project as it actually is, not as it should be
|
||||
- Focus on patterns that agents can recognize and replicate consistently
|
||||
- Include both positive examples (what to do) and negative examples (what to avoid)
|
||||
- This task creates ONE document that captures the TRUE state of the system
|
||||
- References actual files rather than duplicating content when possible
|
||||
- Documents technical debt, workarounds, and constraints honestly
|
||||
- For brownfield projects with PRD: Provides clear enhancement impact analysis
|
||||
- The goal is PRACTICAL documentation for AI agents doing real work
|
||||
==================== END: tasks#document-project ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
@@ -880,13 +825,9 @@ Present a summary of what was created and ask if any additional documentation wo
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -895,7 +836,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
2346
dist/agents/bmad-master.txt
vendored
2346
dist/agents/bmad-master.txt
vendored
File diff suppressed because it is too large
Load Diff
1546
dist/agents/bmad-orchestrator.txt
vendored
1546
dist/agents/bmad-orchestrator.txt
vendored
File diff suppressed because it is too large
Load Diff
20
dist/agents/dev.txt
vendored
20
dist/agents/dev.txt
vendored
@@ -67,6 +67,7 @@ core_principles:
|
||||
- CRITICAL: Dev Record Only - ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
|
||||
- Strive for Sequential Task Execution - Complete tasks 1-by-1 and mark [x] as completed
|
||||
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
|
||||
- Quality Gate Discipline - NEVER complete tasks with failing automated validations
|
||||
- Debug Log Discipline - Log temp changes to md table in devDebugLog. Revert after fix.
|
||||
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
|
||||
- Code Excellence - Clean, secure, maintainable code per loaded standards
|
||||
@@ -78,15 +79,16 @@ commands:
|
||||
- complete-story: Finalize to "Review"
|
||||
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
|
||||
task-execution:
|
||||
flow: Read task→Implement→Write tests→Pass tests→Update [x]→Next task
|
||||
flow: Read task→Implement→Write tests→Execute validations→Only if ALL pass→Update [x]→Next task
|
||||
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'
|
||||
blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing config
|
||||
done: Code matches reqs + Tests pass + Follows standards + No lint errors
|
||||
completion: All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT
|
||||
- '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
|
||||
done: Code matches reqs + All validations pass + Follows standards + File List complete
|
||||
completion: All [x]→Validations pass→Integration(if noted)→E2E(if noted)→DoD→Update File List→Mark Ready for Review→HALT
|
||||
dependencies:
|
||||
tasks:
|
||||
- execute-checklist
|
||||
@@ -100,13 +102,9 @@ dependencies:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -115,7 +113,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
229
dist/agents/pm.txt
vendored
229
dist/agents/pm.txt
vendored
@@ -104,76 +104,93 @@ dependencies:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#correct-course ====================
|
||||
@@ -874,13 +891,9 @@ The story creation is successful when:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -889,7 +902,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -978,9 +991,27 @@ The LLM will:
|
||||
- Create a folder structure to organize the sharded documents
|
||||
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
||||
|
||||
## Recommended Method: @kayvan/markdown-tree-parser
|
||||
## Primary Method: Automatic with markdown-tree
|
||||
|
||||
[[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
|
||||
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
||||
|
||||
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
||||
|
||||
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
||||
|
||||
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
||||
|
||||
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
||||
|
||||
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
||||
|
||||
1. Set markdownExploder to true in bmad-core/core-config.yml
|
||||
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
|
||||
I will now proceed with the manual sharding process."
|
||||
|
||||
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
||||
|
||||
### Installation and Usage
|
||||
|
||||
@@ -1013,19 +1044,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
|
||||
---
|
||||
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
||||
|
||||
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
||||
|
||||
### Task Instructions
|
||||
|
||||
### 1. Identify Document and Target Location
|
||||
1. Identify Document and Target Location
|
||||
|
||||
- Determine which document to shard (user-provided path)
|
||||
- Create a new folder under `docs/` with the same name as the document (without extension)
|
||||
- Example: `docs/prd.md` → create folder `docs/prd/`
|
||||
|
||||
### 2. Parse and Extract Sections
|
||||
2. Parse and Extract Sections
|
||||
|
||||
[[LLM: When sharding the document:
|
||||
|
||||
@@ -1035,7 +1066,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
- Extract the section heading and ALL content until the next level 2 section
|
||||
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
||||
- Be extremely careful with:
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
|
||||
- Mermaid diagrams - preserve the complete diagram syntax
|
||||
- Nested markdown elements
|
||||
- Multi-line content that might contain ## inside code blocks
|
||||
@@ -1054,7 +1085,7 @@ For each extracted section:
|
||||
|
||||
2. **Adjust heading levels**:
|
||||
|
||||
- The level 2 heading becomes level 1 (# instead of ##)
|
||||
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
||||
- All subsection levels decrease by 1:
|
||||
|
||||
```txt
|
||||
@@ -1375,34 +1406,45 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Existing Project Overview
|
||||
|
||||
[[LLM: If working in IDE with project loaded, analyze the project structure and existing documentation. If working in web interface, request project upload or detailed project information from user.]]
|
||||
[[LLM: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.]]
|
||||
|
||||
**Project Location**: [[LLM: Note if this is IDE-based analysis or user-provided information]]
|
||||
**Analysis Source**: [[LLM: Indicate one of the following:
|
||||
- Document-project output available at: {{path}}
|
||||
- IDE-based fresh analysis
|
||||
- User-provided information
|
||||
]]
|
||||
|
||||
**Current Project State**: [[LLM: Brief description of what the project currently does and its primary purpose]]
|
||||
**Current Project State**: [[LLM:
|
||||
- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
|
||||
- Otherwise: Brief description of what the project currently does and its primary purpose
|
||||
]]
|
||||
|
||||
### Available Documentation Analysis
|
||||
|
||||
[[LLM: Check for existing documentation in docs folder or provided by user. List what documentation is available and assess its completeness. Required documents include:
|
||||
[[LLM:
|
||||
If document-project was run:
|
||||
- Note: "Document-project analysis available - using existing technical documentation"
|
||||
- List key documents created by document-project
|
||||
- Skip the missing documentation check below
|
||||
|
||||
- Tech stack documentation
|
||||
- Source tree/architecture overview
|
||||
- Coding standards
|
||||
- API documentation or OpenAPI specs
|
||||
- External API integrations
|
||||
- UX/UI guidelines or existing patterns]]
|
||||
Otherwise, check for existing documentation:
|
||||
]]
|
||||
|
||||
**Available Documentation**:
|
||||
|
||||
- [ ] Tech Stack Documentation
|
||||
- [ ] Source Tree/Architecture
|
||||
- [ ] Coding Standards
|
||||
- [ ] API Documentation
|
||||
- [ ] External API Documentation
|
||||
- [ ] UX/UI Guidelines
|
||||
- [ ] Tech Stack Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Source Tree/Architecture [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Coding Standards [[LLM: If from document-project, may be partial]]
|
||||
- [ ] API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] External API Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] UX/UI Guidelines [[LLM: May not be in document-project]]
|
||||
- [ ] Technical Debt Documentation [[LLM: If from document-project, check ✓]]
|
||||
- [ ] Other: \***\*\_\_\_\*\***
|
||||
|
||||
[[LLM: If critical documentation is missing, STOP and recommend: "I recommend running the document-project task first to generate baseline documentation including tech-stack, source-tree, coding-standards, APIs, external-APIs, and UX/UI information. This will provide the foundation needed for a comprehensive brownfield PRD."]]
|
||||
[[LLM:
|
||||
- If document-project was already run: "Using existing project analysis from document-project output."
|
||||
- If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
|
||||
]]
|
||||
|
||||
### Enhancement Scope Definition
|
||||
|
||||
@@ -1492,13 +1534,19 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Existing Technology Stack
|
||||
|
||||
[[LLM: Document the current technology stack that must be maintained or integrated with]]
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Extract from "Actual Tech Stack" table in High Level Architecture section
|
||||
- Include version numbers and any noted constraints
|
||||
|
||||
**Languages**: [[LLM: Current programming languages in use]]
|
||||
**Frameworks**: [[LLM: Current frameworks and their versions]]
|
||||
**Database**: [[LLM: Current database technology and schema considerations]]
|
||||
**Infrastructure**: [[LLM: Current deployment and hosting infrastructure]]
|
||||
**External Dependencies**: [[LLM: Current third-party services and APIs]]
|
||||
Otherwise, document the current technology stack:
|
||||
]]
|
||||
|
||||
**Languages**: [[LLM: From document-project or fresh analysis]]
|
||||
**Frameworks**: [[LLM: From document-project or fresh analysis]]
|
||||
**Database**: [[LLM: From document-project or fresh analysis]]
|
||||
**Infrastructure**: [[LLM: From document-project or fresh analysis]]
|
||||
**External Dependencies**: [[LLM: From document-project "External Services" section or fresh analysis]]
|
||||
|
||||
### Integration Approach
|
||||
|
||||
@@ -1529,12 +1577,19 @@ Do not proceed with any recommendations until the user has validated your unders
|
||||
|
||||
### Risk Assessment and Mitigation
|
||||
|
||||
[[LLM: Identify risks specific to working with existing codebase]]
|
||||
[[LLM:
|
||||
If document-project output available:
|
||||
- Reference "Technical Debt and Known Issues" section
|
||||
- Include "Workarounds and Gotchas" that might impact enhancement
|
||||
- Note any identified constraints from "Critical Technical Debt"
|
||||
|
||||
**Technical Risks**: [[LLM: Risks related to modifying existing code]]
|
||||
**Integration Risks**: [[LLM: Risks in integrating with existing systems]]
|
||||
**Deployment Risks**: [[LLM: Risks in deploying alongside existing features]]
|
||||
**Mitigation Strategies**: [[LLM: Specific strategies to address identified risks]]
|
||||
Build risk assessment incorporating existing known issues:
|
||||
]]
|
||||
|
||||
**Technical Risks**: [[LLM: Include risks from document-project + new enhancement risks]]
|
||||
**Integration Risks**: [[LLM: Reference integration constraints from document-project]]
|
||||
**Deployment Risks**: [[LLM: Include deployment gotchas from document-project]]
|
||||
**Mitigation Strategies**: [[LLM: Address both existing and new risks]]
|
||||
|
||||
## Epic and Story Structure
|
||||
|
||||
|
||||
48
dist/agents/po.txt
vendored
48
dist/agents/po.txt
vendored
@@ -106,13 +106,9 @@ dependencies:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -121,7 +117,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -210,9 +206,27 @@ The LLM will:
|
||||
- Create a folder structure to organize the sharded documents
|
||||
- Maintain all content integrity including code blocks, diagrams, and markdown formatting
|
||||
|
||||
## Recommended Method: @kayvan/markdown-tree-parser
|
||||
## Primary Method: Automatic with markdown-tree
|
||||
|
||||
[[LLM: First, suggest the user install and use the @kayvan/markdown-tree-parser tool if the md-tree command is unavailable so we can have the best performance and reliable document sharding. Let the user know this will save cost of having the LLM to the expensive sharding operation. Give instructions for MPV NPX and PNPM global installs.]]
|
||||
[[LLM: First, check if markdownExploder is set to true in bmad-core/core-config.yml. If it is, attempt to run the command: `md-tree explode {input file} {output path}`.
|
||||
|
||||
If the command succeeds, inform the user that the document has been sharded successfully and STOP - do not proceed further.
|
||||
|
||||
If the command fails (especially with an error indicating the command is not found or not available), inform the user: "The markdownExploder setting is enabled but the md-tree command is not available. Please either:
|
||||
|
||||
1. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
2. Or set markdownExploder to false in bmad-core/core-config.yml
|
||||
|
||||
**IMPORTANT: STOP HERE - do not proceed with manual sharding until one of the above actions is taken.**"
|
||||
|
||||
If markdownExploder is set to false, inform the user: "The markdownExploder setting is currently false. For better performance and reliability, you should:
|
||||
|
||||
1. Set markdownExploder to true in bmad-core/core-config.yml
|
||||
2. Install @kayvan/markdown-tree-parser globally with: `npm install -g @kayvan/markdown-tree-parser`
|
||||
|
||||
I will now proceed with the manual sharding process."
|
||||
|
||||
Then proceed with the manual method below ONLY if markdownExploder is false.]]
|
||||
|
||||
### Installation and Usage
|
||||
|
||||
@@ -245,19 +259,19 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
|
||||
---
|
||||
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available)
|
||||
## Manual Method (if @kayvan/markdown-tree-parser is not available or user indicated manual method)
|
||||
|
||||
[[LLM: Only proceed with the manual instructions below if the user cannot or does not want to use @kayvan/markdown-tree-parser.]]
|
||||
|
||||
### Task Instructions
|
||||
|
||||
### 1. Identify Document and Target Location
|
||||
1. Identify Document and Target Location
|
||||
|
||||
- Determine which document to shard (user-provided path)
|
||||
- Create a new folder under `docs/` with the same name as the document (without extension)
|
||||
- Example: `docs/prd.md` → create folder `docs/prd/`
|
||||
|
||||
### 2. Parse and Extract Sections
|
||||
2. Parse and Extract Sections
|
||||
|
||||
[[LLM: When sharding the document:
|
||||
|
||||
@@ -267,7 +281,7 @@ If the user has @kayvan/markdown-tree-parser installed, use it and skip the manu
|
||||
- Extract the section heading and ALL content until the next level 2 section
|
||||
- Include all subsections, code blocks, diagrams, lists, tables, etc.
|
||||
- Be extremely careful with:
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks
|
||||
- Fenced code blocks (```) - ensure you capture the full block including closing backticks and account for potential misleading level 2's that are actually part of a fenced section example
|
||||
- Mermaid diagrams - preserve the complete diagram syntax
|
||||
- Nested markdown elements
|
||||
- Multi-line content that might contain ## inside code blocks
|
||||
@@ -286,7 +300,7 @@ For each extracted section:
|
||||
|
||||
2. **Adjust heading levels**:
|
||||
|
||||
- The level 2 heading becomes level 1 (# instead of ##)
|
||||
- The level 2 heading becomes level 1 (# instead of ##) in the sharded new document
|
||||
- All subsection levels decrease by 1:
|
||||
|
||||
```txt
|
||||
@@ -821,6 +835,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
||||
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
||||
|
||||
### File List
|
||||
|
||||
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
||||
@@ -828,6 +846,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## QA Results
|
||||
|
||||
[[LLM: QA Agent Results]]
|
||||
==================== END: templates#story-tmpl ====================
|
||||
|
||||
==================== START: checklists#po-master-checklist ====================
|
||||
|
||||
167
dist/agents/qa.txt
vendored
167
dist/agents/qa.txt
vendored
@@ -52,34 +52,35 @@ activation-instructions:
|
||||
agent:
|
||||
name: Quinn
|
||||
id: qa
|
||||
title: Quality Assurance Test Architect
|
||||
title: Senior Developer & QA Architect
|
||||
icon: 🧪
|
||||
whenToUse: Use for test planning, test case creation, quality assurance, bug reporting, and testing strategy
|
||||
whenToUse: Use for senior code review, refactoring, test planning, quality assurance, and mentoring through code improvements
|
||||
customization: null
|
||||
persona:
|
||||
role: Test Architect & Automation Expert
|
||||
style: Methodical, detail-oriented, quality-focused, strategic
|
||||
identity: Senior quality advocate with expertise in test architecture and automation
|
||||
focus: Comprehensive testing strategies, automation frameworks, quality assurance at every phase
|
||||
role: Senior Developer & Test Architect
|
||||
style: Methodical, detail-oriented, quality-focused, mentoring, strategic
|
||||
identity: Senior developer with deep expertise in code quality, architecture, and test automation
|
||||
focus: Code excellence through review, refactoring, and comprehensive testing strategies
|
||||
core_principles:
|
||||
- Senior Developer Mindset - Review and improve code as a senior mentoring juniors
|
||||
- Active Refactoring - Don't just identify issues, fix them with clear explanations
|
||||
- Test Strategy & Architecture - Design holistic testing strategies across all levels
|
||||
- Automation Excellence - Build maintainable and efficient test automation frameworks
|
||||
- Code Quality Excellence - Enforce best practices, patterns, and clean code principles
|
||||
- Shift-Left Testing - Integrate testing early in development lifecycle
|
||||
- Performance & Security - Proactively identify and fix performance/security issues
|
||||
- Mentorship Through Action - Explain WHY and HOW when making improvements
|
||||
- Risk-Based Testing - Prioritize testing based on risk and critical areas
|
||||
- Performance & Load Testing - Ensure systems meet performance requirements
|
||||
- Security Testing Integration - Incorporate security testing into QA process
|
||||
- Test Data Management - Design strategies for realistic and compliant test data
|
||||
- Continuous Testing & CI/CD - Integrate tests seamlessly into pipelines
|
||||
- Quality Metrics & Reporting - Track meaningful metrics and provide insights
|
||||
- Cross-Browser & Cross-Platform Testing - Ensure comprehensive compatibility
|
||||
- Continuous Improvement - Balance perfection with pragmatism
|
||||
- Architecture & Design Patterns - Ensure proper patterns and maintainable code structure
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command.
|
||||
commands:
|
||||
- help: Show numbered list of the following commands to allow selection
|
||||
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
|
||||
- create-doc {template}: Create doc (no template = show available templates)
|
||||
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
|
||||
dependencies:
|
||||
tasks:
|
||||
- review-story
|
||||
data:
|
||||
- technical-preferences
|
||||
utils:
|
||||
@@ -87,6 +88,144 @@ dependencies:
|
||||
```
|
||||
==================== END: agents#qa ====================
|
||||
|
||||
==================== START: tasks#review-story ====================
|
||||
# review-story
|
||||
|
||||
When a developer marks a story as "Ready for Review", perform a comprehensive senior developer code review with the ability to refactor and improve code directly.
|
||||
|
||||
[[LLM: QA Agent executing review-story task as Senior Developer]]
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Story status must be "Review"
|
||||
- Developer has completed all tasks and updated the File List
|
||||
- All automated tests are passing
|
||||
|
||||
## Review Process
|
||||
|
||||
1. **Read the Complete Story**
|
||||
- Review all acceptance criteria
|
||||
- Understand the dev notes and requirements
|
||||
- Note any completion notes from the developer
|
||||
|
||||
2. **Focus on the File List**
|
||||
- Verify all files listed were actually created/modified
|
||||
- Check for any missing files that should have been updated
|
||||
|
||||
3. **Senior Developer Code Review**
|
||||
- Review code with the eye of a senior developer
|
||||
- If changes form a cohesive whole, review them together
|
||||
- If changes are independent, review incrementally file by file
|
||||
- Focus on:
|
||||
- Code architecture and design patterns
|
||||
- Refactoring opportunities
|
||||
- Code duplication or inefficiencies
|
||||
- Performance optimizations
|
||||
- Security concerns
|
||||
- Best practices and patterns
|
||||
|
||||
4. **Active Refactoring**
|
||||
- As a senior developer, you CAN and SHOULD refactor code where improvements are needed
|
||||
- When refactoring:
|
||||
- Make the changes directly in the files
|
||||
- Explain WHY you're making the change
|
||||
- Describe HOW the change improves the code
|
||||
- Ensure all tests still pass after refactoring
|
||||
- Update the File List if you modify additional files
|
||||
|
||||
5. **Standards Compliance Check**
|
||||
- Verify adherence to `docs/coding-standards.md`
|
||||
- Check compliance with `docs/unified-project-structure.md`
|
||||
- Validate testing approach against `docs/testing-strategy.md`
|
||||
- Ensure all guidelines mentioned in the story are followed
|
||||
|
||||
6. **Acceptance Criteria Validation**
|
||||
- Verify each AC is fully implemented
|
||||
- Check for any missing functionality
|
||||
- Validate edge cases are handled
|
||||
|
||||
7. **Test Coverage Review**
|
||||
- Ensure unit tests cover edge cases
|
||||
- Add missing tests if critical coverage is lacking
|
||||
- Verify integration tests (if required) are comprehensive
|
||||
- Check that test assertions are meaningful
|
||||
- Look for missing test scenarios
|
||||
|
||||
8. **Documentation and Comments**
|
||||
- Verify code is self-documenting where possible
|
||||
- Add comments for complex logic if missing
|
||||
- Ensure any API changes are documented
|
||||
|
||||
## Append Results to Story File
|
||||
|
||||
After review and any refactoring, append your results to the story file in the QA Results section:
|
||||
|
||||
```markdown
|
||||
## QA Results
|
||||
|
||||
### Review Date: [Date]
|
||||
### Reviewed By: Quinn (Senior Developer QA)
|
||||
|
||||
### Code Quality Assessment
|
||||
[Overall assessment of implementation quality]
|
||||
|
||||
### Refactoring Performed
|
||||
[List any refactoring you performed with explanations]
|
||||
- **File**: [filename]
|
||||
- **Change**: [what was changed]
|
||||
- **Why**: [reason for change]
|
||||
- **How**: [how it improves the code]
|
||||
|
||||
### Compliance Check
|
||||
- Coding Standards: [✓/✗] [notes if any]
|
||||
- Project Structure: [✓/✗] [notes if any]
|
||||
- Testing Strategy: [✓/✗] [notes if any]
|
||||
- All ACs Met: [✓/✗] [notes if any]
|
||||
|
||||
### Improvements Checklist
|
||||
[Check off items you handled yourself, leave unchecked for dev to address]
|
||||
|
||||
- [x] Refactored user service for better error handling (services/user.service.ts)
|
||||
- [x] Added missing edge case tests (services/user.service.test.ts)
|
||||
- [ ] Consider extracting validation logic to separate validator class
|
||||
- [ ] Add integration test for error scenarios
|
||||
- [ ] Update API documentation for new error codes
|
||||
|
||||
### Security Review
|
||||
[Any security concerns found and whether addressed]
|
||||
|
||||
### Performance Considerations
|
||||
[Any performance issues found and whether addressed]
|
||||
|
||||
### Final Status
|
||||
[✓ Approved - Ready for Done] / [✗ Changes Required - See unchecked items above]
|
||||
```
|
||||
|
||||
## Key Principles
|
||||
|
||||
- You are a SENIOR developer reviewing junior/mid-level work
|
||||
- You have the authority and responsibility to improve code directly
|
||||
- Always explain your changes for learning purposes
|
||||
- Balance between perfection and pragmatism
|
||||
- Focus on significant improvements, not nitpicks
|
||||
|
||||
## Blocking Conditions
|
||||
|
||||
Stop the review 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 that require discussion
|
||||
|
||||
## Completion
|
||||
|
||||
After review:
|
||||
1. If all items are checked and approved: Update story status to "Done"
|
||||
2. If unchecked items remain: Keep status as "Review" for dev to address
|
||||
3. Always provide constructive feedback and explanations for learning
|
||||
==================== END: tasks#review-story ====================
|
||||
|
||||
==================== START: data#technical-preferences ====================
|
||||
# User-Defined Preferred Patterns and Preferences
|
||||
|
||||
|
||||
95
dist/agents/sm.txt
vendored
95
dist/agents/sm.txt
vendored
@@ -109,15 +109,31 @@ To identify the next logical story based on project progress and epic definition
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `dev-story-location`: Where to save story files
|
||||
- `devStoryLocation`: Where to save story files
|
||||
- `prd.prdSharded`: Whether PRD is sharded or monolithic
|
||||
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
|
||||
- `prd.prdFile`: Location of monolithic PRD (if not sharded)
|
||||
- `prd.prdShardedLocation`: Location of sharded epic files
|
||||
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
|
||||
- `architecture.architectureVersion`: Architecture document version
|
||||
- `architecture.architectureSharded`: Whether architecture is sharded
|
||||
- `architecture.architecture-file`: Location of monolithic architecture
|
||||
- `architecture.architectureFile`: Location of monolithic architecture
|
||||
- `architecture.architectureShardedLocation`: Location of sharded architecture files
|
||||
- `workflow.trackProgress`: Whether workflow plan tracking is enabled
|
||||
- `workflow.planFile`: Location of workflow plan (if tracking enabled)
|
||||
|
||||
### 0.5 Check Workflow Plan (if configured)
|
||||
|
||||
[[LLM: Check if workflow plan tracking is enabled]]
|
||||
|
||||
- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
|
||||
- If plan exists:
|
||||
- Parse plan to check if story creation is the expected next step
|
||||
- If out of sequence and `workflow.enforceSequence: true`:
|
||||
- Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
|
||||
- Block execution unless user explicitly overrides
|
||||
- If out of sequence and `workflow.enforceSequence: false`:
|
||||
- Show warning but allow continuation with confirmation
|
||||
- Continue with story identification after plan check
|
||||
|
||||
### 1. Identify Next Story for Preparation
|
||||
|
||||
@@ -125,11 +141,11 @@ To identify the next logical story based on project progress and epic definition
|
||||
|
||||
- Based on `prdSharded` from config:
|
||||
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
|
||||
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
|
||||
- **If `prdSharded: false`**: Load the full PRD from `prdFile` and extract epics from section headings (## Epic N or ### Epic N)
|
||||
|
||||
#### 1.2 Review Existing Stories
|
||||
|
||||
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
|
||||
- Check `devStoryLocation` from config (e.g., `docs/stories/`) for existing story files
|
||||
- If the directory exists and has at least 1 file, find the highest-numbered story file.
|
||||
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
|
||||
- Verify its `Status` is 'Done' (or equivalent).
|
||||
@@ -149,12 +165,40 @@ To identify the next logical story based on project progress and epic definition
|
||||
```
|
||||
|
||||
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
|
||||
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
|
||||
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and parse it to find ALL stories in that epic. **ALWAYS select the next sequential story** (e.g., if last was 2.2, next MUST be 2.3).
|
||||
- If the next sequential story has unmet prerequisites, present this to the user:
|
||||
|
||||
```plaintext
|
||||
ALERT: Next story has unmet prerequisites:
|
||||
Story: {epicNum}.{storyNum} - {Story Title}
|
||||
Prerequisites not met: [list specific prerequisites]
|
||||
|
||||
Would you like to:
|
||||
1. Create the story anyway (mark prerequisites as pending)
|
||||
2. Skip to a different story (requires your specific instruction)
|
||||
3. Cancel story creation
|
||||
|
||||
Please choose an option (1/2/3):
|
||||
```
|
||||
|
||||
- If there are no more stories in the current epic (e.g., 2.9 was done and there is no 2.10):
|
||||
|
||||
```plaintext
|
||||
Epic {epicNum} Complete: All stories in Epic {epicNum} have been completed.
|
||||
|
||||
Would you like to:
|
||||
1. Begin Epic {epicNum + 1} with story {epicNum + 1}.1
|
||||
2. Select a specific story to work on
|
||||
3. Cancel story creation
|
||||
|
||||
Please choose an option (1/2/3):
|
||||
```
|
||||
|
||||
- **CRITICAL**: NEVER automatically skip to another epic or non-sequential story. The user MUST explicitly instruct which story to create if skipping the sequential order.
|
||||
|
||||
- **If no story files exist in `docs/stories/`:**
|
||||
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
|
||||
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
|
||||
- The next story is ALWAYS 1.1 (the first story of the first epic).
|
||||
- If story 1.1 has unmet prerequisites, follow the same alert process as above.
|
||||
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
|
||||
|
||||
### 2. Gather Core Story Requirements (from Epic)
|
||||
@@ -190,13 +234,13 @@ Based on configuration loaded in Step 0:
|
||||
- Follow the structured reading order in section 4.2 below
|
||||
|
||||
- **If `architectureVersion: v4` and `architectureSharded: false`**:
|
||||
- Load the monolithic architecture from `architecture-file`
|
||||
- Load the monolithic architecture from `architectureFile`
|
||||
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
|
||||
|
||||
- **If `architectureVersion` is NOT v4**:
|
||||
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
|
||||
- If `architectureSharded: true`: Search sharded files by filename relevance
|
||||
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
|
||||
- If `architectureSharded: false`: Search within monolithic `architectureFile` for relevant sections
|
||||
|
||||
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
|
||||
|
||||
@@ -253,7 +297,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
|
||||
### 6. Populate Story Template with Full Context
|
||||
|
||||
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
|
||||
- Create a new story file: `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config).
|
||||
- Use the Story Template to structure the file.
|
||||
- Fill in:
|
||||
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
|
||||
@@ -300,7 +344,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
|
||||
- Verify all source references are included for technical details
|
||||
- Ensure tasks align with both epic requirements and architecture constraints
|
||||
- Update status to "Draft"
|
||||
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
|
||||
- Save the story file to `{devStoryLocation}/{epicNum}.{storyNum}.story.md` (using location from config)
|
||||
|
||||
### 9. Report Completion
|
||||
|
||||
@@ -313,6 +357,15 @@ Provide a summary to the user including:
|
||||
- Recommendations for story review before approval
|
||||
- Next steps: Story should be reviewed by PO for approval before dev work begins
|
||||
|
||||
### 10. Update Workflow Plan (if applicable)
|
||||
|
||||
[[LLM: After successful story creation]]
|
||||
|
||||
- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
|
||||
- Call update-workflow-plan task to mark story creation step complete
|
||||
- Parameters: task: create-next-story, step_id: {from plan}, status: complete
|
||||
- If plan shows next step, mention it in completion message
|
||||
|
||||
[[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]
|
||||
==================== END: tasks#create-next-story ====================
|
||||
|
||||
@@ -321,13 +374,9 @@ Provide a summary to the user including:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -336,7 +385,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
@@ -471,6 +520,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update - remove this line to the SM]]
|
||||
[[LLM: (Dev Agent) Anything the SM needs to know that deviated from the story that might impact drafting the next story.]]
|
||||
|
||||
### File List
|
||||
|
||||
[[LLM: (Dev Agent) List every new file created, or existing file modified in a bullet list.]]
|
||||
|
||||
### Change Log
|
||||
|
||||
[[LLM: (SM Agent) When Drafting Story, leave next prompt in place for dev agent to remove and update- remove this line to the SM]]
|
||||
@@ -478,6 +531,10 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
|
||||
|
||||
| Date | Version | Description | Author |
|
||||
| :--- | :------ | :---------- | :----- |
|
||||
|
||||
## QA Results
|
||||
|
||||
[[LLM: QA Agent Results]]
|
||||
==================== END: templates#story-tmpl ====================
|
||||
|
||||
==================== START: checklists#story-draft-checklist ====================
|
||||
|
||||
117
dist/agents/ux-expert.txt
vendored
117
dist/agents/ux-expert.txt
vendored
@@ -464,76 +464,93 @@ Present these numbered options to the user:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
@@ -541,13 +558,9 @@ If template specifies a checklist:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -556,7 +569,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
@@ -104,76 +104,93 @@ dependencies:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#execute-checklist ====================
|
||||
@@ -181,13 +198,9 @@ If template specifies a checklist:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -196,7 +209,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
@@ -112,13 +112,9 @@ dependencies:
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -127,7 +123,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
@@ -316,13 +316,9 @@ This task ensures game development stories are immediately actionable and enable
|
||||
|
||||
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
|
||||
|
||||
## Context
|
||||
|
||||
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
|
||||
|
||||
## Available Checklists
|
||||
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
|
||||
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the {root}/checklists folder to select the appropriate one to run.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -331,7 +327,7 @@ If the user asks or does not specify a specific checklist, list the checklists a
|
||||
- If user or the task being run provides a checklist name:
|
||||
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
|
||||
- If multiple matches found, ask user to clarify
|
||||
- Load the appropriate checklist from bmad-core/checklists/
|
||||
- Load the appropriate checklist from {root}/checklists/
|
||||
- If no checklist specified:
|
||||
- Ask the user which checklist they want to use
|
||||
- Present the available options from the files in the checklists folder
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -101,7 +101,7 @@ This task guides you through creating a new BMAD agent following the standard te
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Agent template: `.bmad-core/templates/agent-tmpl.md`
|
||||
- Agent template: `../templates/agent-tmpl.md`
|
||||
- Target directory: `.bmad-core/agents/`
|
||||
|
||||
## Steps
|
||||
@@ -318,7 +318,7 @@ Every expansion pack MUST include a custom BMAD orchestrator agent with sophisti
|
||||
|
||||
1. **Create Planning Document First**: Before any implementation, create a comprehensive plan for user approval
|
||||
2. **Agent Architecture Standards**: Use YAML-in-Markdown structure with activation instructions, personas, and command systems
|
||||
3. **Character Consistency**: Every agent must have a persistent persona with name, communication style, and numbered options protocol
|
||||
3. **Character Consistency**: Every agent must have a persistent persona with name, communication style, and numbered options protocol similar to `expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md`
|
||||
4. **Custom Themed Orchestrator**: The orchestrator should embody the domain theme (e.g., Office Manager for medical, Project Lead for tech) for better user experience
|
||||
5. **Core Utilities Required**: ALWAYS include these core files in every expansion pack:
|
||||
- `tasks/create-doc.md` - Document creation from templates
|
||||
@@ -326,8 +326,8 @@ Every expansion pack MUST include a custom BMAD orchestrator agent with sophisti
|
||||
- `utils/template-format.md` - Template markup conventions
|
||||
- `utils/workflow-management.md` - Workflow orchestration
|
||||
6. **Team and Workflow Requirements**: If pack has >1 agent, MUST include:
|
||||
- At least one team configuration in `agent-teams/`
|
||||
- At least one workflow in `workflows/`
|
||||
- At least one team configuration in `expansion-packs/{new-expansion}/agent-teams/`
|
||||
- At least one workflow in `expansion-packs/{new-expansion}workflows/`
|
||||
7. **Template Sophistication**: Implement LLM instruction embedding with `[[LLM: guidance]]`, conditional content, and variable systems
|
||||
8. **Workflow Orchestration**: Include decision trees, handoff protocols, and validation loops
|
||||
9. **Quality Assurance Integration**: Multi-level checklists with star ratings and ready/not-ready frameworks
|
||||
@@ -736,17 +736,17 @@ IMPORTANT: Work through plan.md checklist systematically!
|
||||
|
||||
**Step 2: Copy Core Utilities**
|
||||
|
||||
Before proceeding, copy these essential files from bmad-core:
|
||||
Before proceeding, copy these essential files from common:
|
||||
|
||||
```bash
|
||||
# Copy core task utilities
|
||||
cp bmad-core/tasks/create-doc.md expansion-packs/{pack-name}/tasks/
|
||||
cp bmad-core/tasks/execute-checklist.md expansion-packs/{pack-name}/tasks/
|
||||
cp common/tasks/create-doc.md expansion-packs/{pack-name}/tasks/
|
||||
cp common/tasks/execute-checklist.md expansion-packs/{pack-name}/tasks/
|
||||
|
||||
# Copy core utility files
|
||||
mkdir -p expansion-packs/{pack-name}/utils
|
||||
cp bmad-core/utils/template-format.md expansion-packs/{pack-name}/utils/
|
||||
cp bmad-core/utils/workflow-management.md expansion-packs/{pack-name}/utils/
|
||||
cp common/utils/template-format.md expansion-packs/{pack-name}/utils/
|
||||
cp common/utils/workflow-management.md expansion-packs/{pack-name}/utils/
|
||||
```
|
||||
|
||||
**Step 3: Technical Implementation**
|
||||
@@ -1318,14 +1318,6 @@ Embedded knowledge (automatic):
|
||||
- [ ] Template conditional content tested with different scenarios
|
||||
- [ ] Workflow decision trees validated with sample use cases
|
||||
- [ ] Character interactions tested for consistency and professional authenticity
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
==================== END: tasks#generate-expansion-pack ====================
|
||||
|
||||
==================== START: tasks#advanced-elicitation ====================
|
||||
@@ -105,76 +105,93 @@ dependencies:
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 0. Check Workflow Plan (if configured)
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
[[LLM: Check if plan tracking is enabled in core-config.yml]]
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
- If `workflow.trackProgress: true`, check for active plan using utils#plan-management
|
||||
- If plan exists and this document creation is part of the plan:
|
||||
- Verify this is the expected next step
|
||||
- If out of sequence and `enforceSequence: true`, warn user and halt without user override
|
||||
- If out of sequence and `enforceSequence: false`, ask for confirmation
|
||||
- Continue with normal execution after plan check
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
### 1. Identify Template
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]` for example, then offer to create "PRD" and "Architecture" documents
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
### 6. Update Workflow Plan (if applicable)
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
[[LLM: After successful document creation]]
|
||||
|
||||
- If plan tracking is enabled and document was part of plan:
|
||||
- Call update-workflow-plan task to mark step complete
|
||||
- Parameters: task: create-doc, step_id: {from plan}, status: complete
|
||||
- Show next recommended step from plan
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
==================== END: tasks#create-doc ====================
|
||||
|
||||
==================== START: tasks#review-infrastructure ====================
|
||||
|
||||
3561
dist/teams/team-all.txt
vendored
3561
dist/teams/team-all.txt
vendored
File diff suppressed because it is too large
Load Diff
3303
dist/teams/team-fullstack.txt
vendored
3303
dist/teams/team-fullstack.txt
vendored
File diff suppressed because it is too large
Load Diff
1852
dist/teams/team-ide-minimal.txt
vendored
1852
dist/teams/team-ide-minimal.txt
vendored
File diff suppressed because it is too large
Load Diff
2650
dist/teams/team-no-ui.txt
vendored
2650
dist/teams/team-no-ui.txt
vendored
File diff suppressed because it is too large
Load Diff
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
|
||||
@@ -22,7 +22,7 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
|
||||
```
|
||||
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or VS Code Copilot)
|
||||
|
||||
2. **Verify installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
@@ -113,6 +113,7 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
### Chat Management:
|
||||
|
||||
|
||||
@@ -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,181 @@ 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
|
||||
│ │ └── vs-code-copilot-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.
|
||||
280
docs/expansion-packs.md
Normal file
280
docs/expansion-packs.md
Normal file
@@ -0,0 +1,280 @@
|
||||
# The Power of BMAD Expansion Packs
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMAD into a universal AI agent system.
|
||||
|
||||
## Why Expansion Packs?
|
||||
|
||||
### Keep Core Lean
|
||||
|
||||
The core BMAD framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
|
||||
|
||||
### Domain Expertise
|
||||
|
||||
Each expansion pack provides deep, specialized knowledge without bloating the core system. Install only what you need.
|
||||
|
||||
### Community Innovation
|
||||
|
||||
Anyone can create and share expansion packs, fostering a ecosystem of AI-powered solutions across all industries and interests.
|
||||
|
||||
## Technical Expansion Packs
|
||||
|
||||
### Game Development Pack
|
||||
|
||||
Transform your AI into a complete game development studio:
|
||||
|
||||
- **Game Designer**: Mechanics, balance, progression systems
|
||||
- **Level Designer**: Map layouts, puzzle design, difficulty curves
|
||||
- **Narrative Designer**: Story arcs, dialog trees, lore creation
|
||||
- **Art Director**: Visual style guides, asset specifications
|
||||
- **Sound Designer**: Audio direction, music themes, SFX planning
|
||||
|
||||
### Mobile Development Pack
|
||||
|
||||
Specialized agents for mobile app creation:
|
||||
|
||||
- **iOS Specialist**: Swift/SwiftUI patterns, Apple guidelines
|
||||
- **Android Expert**: Kotlin best practices, Material Design
|
||||
- **Mobile UX Designer**: Touch interfaces, gesture patterns
|
||||
- **App Store Optimizer**: ASO strategies, listing optimization
|
||||
- **Performance Tuner**: Battery optimization, network efficiency
|
||||
|
||||
### DevOps/Infrastructure Pack
|
||||
|
||||
Complete infrastructure automation team:
|
||||
|
||||
- **Cloud Architect**: AWS/Azure/GCP design patterns
|
||||
- **Security Specialist**: Zero-trust implementation, compliance
|
||||
- **SRE Expert**: Monitoring, alerting, incident response
|
||||
- **Container Orchestrator**: Kubernetes, Docker optimization
|
||||
- **Cost Optimizer**: Cloud spend analysis, resource right-sizing
|
||||
|
||||
### Data Science Pack
|
||||
|
||||
AI-powered data analysis team:
|
||||
|
||||
- **Data Scientist**: Statistical analysis, ML model selection
|
||||
- **Data Engineer**: Pipeline design, ETL processes
|
||||
- **ML Engineer**: Model deployment, A/B testing
|
||||
- **Visualization Expert**: Dashboard design, insight communication
|
||||
- **Ethics Advisor**: Bias detection, fairness assessment
|
||||
|
||||
## Non-Technical Expansion Packs
|
||||
|
||||
### Business Strategy Pack
|
||||
|
||||
Complete business advisory team:
|
||||
|
||||
- **Strategy Consultant**: Market positioning, competitive analysis
|
||||
- **Financial Analyst**: Projections, unit economics, funding strategies
|
||||
- **Operations Manager**: Process optimization, efficiency improvements
|
||||
- **Marketing Strategist**: Go-to-market plans, growth hacking
|
||||
- **HR Advisor**: Talent strategies, culture building
|
||||
|
||||
### Creative Writing Pack
|
||||
|
||||
Your personal writing team:
|
||||
|
||||
- **Plot Architect**: Three-act structure, story beats, pacing
|
||||
- **Character Psychologist**: Deep motivations, authentic dialog
|
||||
- **World Builder**: Consistent universes, cultural systems
|
||||
- **Editor**: Style consistency, grammar, flow
|
||||
- **Beta Reader**: Feedback simulation, plot hole detection
|
||||
|
||||
### Health & Wellness Pack
|
||||
|
||||
Personal wellness coaching system:
|
||||
|
||||
- **Fitness Trainer**: Progressive overload, form correction
|
||||
- **Nutritionist**: Macro planning, supplement guidance
|
||||
- **Sleep Coach**: Circadian optimization, sleep hygiene
|
||||
- **Stress Manager**: Coping strategies, work-life balance
|
||||
- **Habit Engineer**: Behavior change, accountability systems
|
||||
|
||||
### Education Pack
|
||||
|
||||
Complete learning design system:
|
||||
|
||||
- **Curriculum Architect**: Learning objectives, scope & sequence
|
||||
- **Instructional Designer**: Engagement strategies, multimedia learning
|
||||
- **Assessment Specialist**: Rubrics, formative/summative evaluation
|
||||
- **Differentiation Expert**: Adaptive learning, special needs
|
||||
- **EdTech Integrator**: Tool selection, digital pedagogy
|
||||
|
||||
### Mental Health Support Pack
|
||||
|
||||
Therapeutic support system:
|
||||
|
||||
- **CBT Guide**: Cognitive restructuring, thought challenging
|
||||
- **Mindfulness Teacher**: Meditation scripts, awareness exercises
|
||||
- **Journal Therapist**: Reflective prompts, emotional processing
|
||||
- **Crisis Support**: Coping strategies, safety planning
|
||||
- **Habit Tracker**: Mood monitoring, trigger identification
|
||||
|
||||
### Legal Assistant Pack
|
||||
|
||||
Legal document and research support:
|
||||
|
||||
- **Contract Analyst**: Term review, risk assessment
|
||||
- **Legal Researcher**: Case law, precedent analysis
|
||||
- **Document Drafter**: Template customization, clause libraries
|
||||
- **Compliance Checker**: Regulatory alignment, audit prep
|
||||
- **IP Advisor**: Patent strategies, trademark guidance
|
||||
|
||||
### Real Estate Pack
|
||||
|
||||
Property investment and management:
|
||||
|
||||
- **Market Analyst**: Comparable analysis, trend prediction
|
||||
- **Investment Calculator**: ROI modeling, cash flow analysis
|
||||
- **Property Manager**: Tenant screening, maintenance scheduling
|
||||
- **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
|
||||
|
||||
AI-powered tabletop RPG assistance:
|
||||
|
||||
- **World Master**: Dynamic world generation, NPC creation
|
||||
- **Combat Referee**: Initiative tracking, rule clarification
|
||||
- **Story Weaver**: Plot hooks, side quests, consequences
|
||||
- **Character Builder**: Backstory generation, stat optimization
|
||||
- **Loot Master**: Treasure generation, magic item creation
|
||||
|
||||
### Life Event Planning Pack
|
||||
|
||||
Major life event coordination:
|
||||
|
||||
- **Wedding Planner**: Vendor coordination, timeline creation
|
||||
- **Event Designer**: Theme development, decoration plans
|
||||
- **Budget Manager**: Cost tracking, vendor negotiation
|
||||
- **Guest Coordinator**: RSVP tracking, seating arrangements
|
||||
- **Timeline Keeper**: Day-of scheduling, contingency planning
|
||||
|
||||
### Hobby Mastery Pack
|
||||
|
||||
Deep dive into specific hobbies:
|
||||
|
||||
- **Garden Designer**: Plant selection, seasonal planning
|
||||
- **Brew Master**: Recipe formulation, process optimization
|
||||
- **Maker Assistant**: 3D printing, woodworking, crafts
|
||||
- **Collection Curator**: Organization, valuation, trading
|
||||
- **Photography Coach**: Composition, lighting, post-processing
|
||||
|
||||
### Scientific Research Pack
|
||||
|
||||
Research acceleration tools:
|
||||
|
||||
- **Literature Reviewer**: Paper summarization, gap analysis
|
||||
- **Hypothesis Generator**: Research question formulation
|
||||
- **Methodology Designer**: Experiment planning, control design
|
||||
- **Statistical Advisor**: Test selection, power analysis
|
||||
- **Grant Writer**: Proposal structure, impact statements
|
||||
|
||||
## Creating Your Own Expansion Pack
|
||||
|
||||
### Step 1: Define Your Domain
|
||||
|
||||
What expertise are you capturing? What problems will it solve?
|
||||
|
||||
### Step 2: Design Your Agents
|
||||
|
||||
Each agent should have:
|
||||
|
||||
- Clear expertise area
|
||||
- Specific personality traits
|
||||
- Defined capabilities
|
||||
- Knowledge boundaries
|
||||
|
||||
### Step 3: Create Tasks
|
||||
|
||||
Tasks should be:
|
||||
|
||||
- Step-by-step procedures
|
||||
- Reusable across scenarios
|
||||
- Clear and actionable
|
||||
- Domain-specific
|
||||
|
||||
### Step 4: Build Templates
|
||||
|
||||
Templates need:
|
||||
|
||||
- Structured output format
|
||||
- Embedded LLM instructions
|
||||
- Placeholders for customization
|
||||
- Professional formatting
|
||||
|
||||
### Step 5: Test & Iterate
|
||||
|
||||
- Use with real scenarios
|
||||
- Gather user feedback
|
||||
- Refine agent responses
|
||||
- Improve task clarity
|
||||
|
||||
### Step 6: Package & Share
|
||||
|
||||
- Create clear documentation
|
||||
- Include usage examples
|
||||
- Add to expansion-packs directory
|
||||
- Share with community
|
||||
|
||||
## The Future of Expansion Packs
|
||||
|
||||
### Marketplace Potential
|
||||
|
||||
Imagine a future where:
|
||||
|
||||
- Professional expansion packs are sold
|
||||
- Certified packs for regulated industries
|
||||
- Community ratings and reviews
|
||||
- Automatic updates and improvements
|
||||
|
||||
### AI Agent Ecosystems
|
||||
|
||||
Expansion packs could enable:
|
||||
|
||||
- Cross-pack agent collaboration
|
||||
- Industry-standard agent protocols
|
||||
- Interoperable AI workflows
|
||||
- Universal agent languages
|
||||
|
||||
### Democratizing Expertise
|
||||
|
||||
Every expansion pack:
|
||||
|
||||
- Makes expert knowledge accessible
|
||||
- Reduces barriers to entry
|
||||
- Enables solo entrepreneurs
|
||||
- Empowers small teams
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Browse existing packs**: Check `expansion-packs/` directory
|
||||
2. **Install what you need**: Use the installer's expansion pack option
|
||||
3. **Create your own**: Use the expansion-creator pack
|
||||
4. **Share with others**: Submit PRs with new packs
|
||||
5. **Build the future**: Help shape AI-assisted work
|
||||
|
||||
## Remember
|
||||
|
||||
The BMAD Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
|
||||
|
||||
**What expertise will you share with the world?**
|
||||
@@ -8,7 +8,15 @@ A pull request (PR) is how you propose changes to a project on GitHub. Think of
|
||||
|
||||
## Before You Start
|
||||
|
||||
⚠️ **Important**: Please keep your contributions small and focused! We prefer many small, clear changes rather than one massive change. If you're planning something big, please [open an issue](https://github.com/bmadcode/bmad-method/issues) or start a [discussion](https://github.com/bmadcode/bmad-method/discussions) first.
|
||||
⚠️ **Important**: Please keep your contributions small and focused! We prefer many small, clear changes rather than one massive change.
|
||||
|
||||
**Required before submitting PRs:**
|
||||
|
||||
- **For bug fixes**: Create an issue using the [bug report template](https://github.com/bmadcode/bmad-method/issues/new?template=bug_report.md)
|
||||
- **For new features**:
|
||||
1. Discuss in Discord [#general-dev channel](https://discord.gg/g6ypHytrCB)
|
||||
2. Create an issue using the [feature request template](https://github.com/bmadcode/bmad-method/issues/new?template=feature_request.md)
|
||||
- **For large changes**: Always open an issue first to discuss alignment
|
||||
|
||||
## Step-by-Step Guide
|
||||
|
||||
@@ -82,9 +90,15 @@ git push origin fix/typo-in-readme
|
||||
|
||||
1. Go to your fork on GitHub
|
||||
2. You'll see a green "Compare & pull request" button - click it
|
||||
3. Fill out the PR template:
|
||||
- **Title**: Clear, descriptive title
|
||||
- **Description**: Explain what you changed and why
|
||||
3. Select the correct target branch:
|
||||
- **`next` branch** for most contributions (features, docs, enhancements)
|
||||
- **`main` branch** only for critical fixes
|
||||
4. Fill out the PR description using the template in CONTRIBUTING.md:
|
||||
- **What**: 1-2 sentences describing what changed
|
||||
- **Why**: 1-2 sentences explaining why
|
||||
- **How**: 2-3 bullets on implementation
|
||||
- **Testing**: How you tested
|
||||
5. Reference the related issue number (e.g., "Fixes #123")
|
||||
|
||||
### 8. Wait for Review
|
||||
|
||||
@@ -117,9 +131,12 @@ git push origin fix/typo-in-readme
|
||||
|
||||
## Need Help?
|
||||
|
||||
- 💬 Join our [Discord Community](https://discord.gg/g6ypHytrCB) for real-time help
|
||||
- 💬 Ask questions in [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
||||
- 🐛 Report bugs in [Issues](https://github.com/bmadcode/bmad-method/issues)
|
||||
- 💬 Join our [Discord Community](https://discord.gg/g6ypHytrCB) for real-time help:
|
||||
- **#general-dev** - Technical questions and feature discussions
|
||||
- **#bugs-issues** - Get help with bugs before filing issues
|
||||
- 💬 Ask questions in [GitHub Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
||||
- 🐛 Report bugs using the [bug report template](https://github.com/bmadcode/bmad-method/issues/new?template=bug_report.md)
|
||||
- 💡 Suggest features using the [feature request template](https://github.com/bmadcode/bmad-method/issues/new?template=feature_request.md)
|
||||
- 📖 Read the full [Contributing Guidelines](../CONTRIBUTING.md)
|
||||
|
||||
## Example: Good vs Bad PRs
|
||||
|
||||
@@ -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,20 +81,47 @@ 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 |
|
||||
| `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 |
|
||||
| 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 | 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 |
|
||||
|
||||
### Meta Agents
|
||||
|
||||
@@ -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
|
||||
@@ -895,18 +1142,18 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
#### Configuration Structure
|
||||
|
||||
```yaml
|
||||
core-project-information:
|
||||
dev-story-location: docs/stories # Where completed stories are saved
|
||||
coreProjectLocation:
|
||||
devStoryLocation: docs/stories # Where completed stories are saved
|
||||
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdFile: docs/prd.md
|
||||
prdVersion: v4 # v3 or v4
|
||||
prdSharded: true # false if epics are embedded in PRD
|
||||
prdShardedLocation: docs/prd # Where sharded epics live
|
||||
epicFilePattern: epic-{n}*.md # Pattern for epic files
|
||||
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureFile: docs/architecture.md
|
||||
architectureVersion: v4 # v3 or v4
|
||||
architectureSharded: true # false if monolithic
|
||||
architectureShardedLocation: docs/architecture
|
||||
@@ -932,7 +1179,7 @@ The Scrum Master agent uses these settings to locate epics:
|
||||
|
||||
```yaml
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdFile: docs/prd.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs/prd
|
||||
@@ -943,7 +1190,7 @@ prd:
|
||||
|
||||
```yaml
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdFile: docs/prd.md
|
||||
prdVersion: v3
|
||||
prdSharded: false # Epics are inside PRD
|
||||
```
|
||||
@@ -952,7 +1199,7 @@ prd:
|
||||
|
||||
```yaml
|
||||
prd:
|
||||
prd-file: docs/product-requirements.md
|
||||
prdFile: docs/product-requirements.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: docs # Epics in docs/ not docs/prd/
|
||||
@@ -967,7 +1214,7 @@ Similar flexibility for architecture documents:
|
||||
|
||||
```yaml
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureFile: docs/architecture.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
@@ -977,7 +1224,7 @@ architecture:
|
||||
|
||||
```yaml
|
||||
architecture:
|
||||
architecture-file: docs/technical-architecture.md
|
||||
architectureFile: docs/technical-architecture.md
|
||||
architectureVersion: v3
|
||||
architectureSharded: false # All in one file
|
||||
```
|
||||
@@ -1021,14 +1268,14 @@ Export entire chat conversations for preservation or analysis. The `{n}` is repl
|
||||
##### Legacy V3 Project
|
||||
|
||||
```yaml
|
||||
core-project-information:
|
||||
dev-story-location: docs/stories
|
||||
coreProjectLocation:
|
||||
devStoryLocation: docs/stories
|
||||
prd:
|
||||
prd-file: docs/prd.md
|
||||
prdFile: docs/prd.md
|
||||
prdVersion: v3
|
||||
prdSharded: false
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureFile: docs/architecture.md
|
||||
architectureVersion: v3
|
||||
architectureSharded: false
|
||||
devLoadAlwaysFiles: []
|
||||
@@ -1037,14 +1284,14 @@ core-project-information:
|
||||
##### Hybrid Project (V3 PRD, V4 Architecture)
|
||||
|
||||
```yaml
|
||||
core-project-information:
|
||||
dev-story-location: .ai/stories
|
||||
coreProjectLocation:
|
||||
devStoryLocation: .ai/stories
|
||||
prd:
|
||||
prd-file: docs/product-requirements.md
|
||||
prdFile: docs/product-requirements.md
|
||||
prdVersion: v3
|
||||
prdSharded: false
|
||||
architecture:
|
||||
architecture-file: docs/architecture.md
|
||||
architectureFile: docs/architecture.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: docs/architecture
|
||||
@@ -1055,16 +1302,16 @@ core-project-information:
|
||||
##### Custom Organization
|
||||
|
||||
```yaml
|
||||
core-project-information:
|
||||
dev-story-location: development/completed-stories
|
||||
coreProjectLocation:
|
||||
devStoryLocation: development/completed-stories
|
||||
prd:
|
||||
prd-file: planning/requirements.md
|
||||
prdFile: planning/requirements.md
|
||||
prdVersion: v4
|
||||
prdSharded: true
|
||||
prdShardedLocation: planning/epics
|
||||
epicFilePattern: requirement-{n}.md
|
||||
architecture:
|
||||
architecture-file: technical/system-design.md
|
||||
architectureFile: technical/system-design.md
|
||||
architectureVersion: v4
|
||||
architectureSharded: true
|
||||
architectureShardedLocation: technical/components
|
||||
@@ -1122,7 +1369,7 @@ customTechnicalDocuments:
|
||||
|
||||
**Architecture Not Loading:**
|
||||
|
||||
- Verify `architecture-file` path
|
||||
- Verify `architectureFile` path
|
||||
- Check `architectureVersion` setting
|
||||
- Confirm sharding configuration matches reality
|
||||
|
||||
@@ -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.
|
||||
358
docs/working-in-the-brownfield.md
Normal file
358
docs/working-in-the-brownfield.md
Normal file
@@ -0,0 +1,358 @@
|
||||
# Working in the Brownfield: A Complete Guide
|
||||
|
||||
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation!**
|
||||
>
|
||||
> 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
|
||||
|
||||
## 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
|
||||
|
||||
- Add significant new features to existing applications
|
||||
- Modernize legacy codebases
|
||||
- Integrate new technologies or services
|
||||
- Refactor complex systems
|
||||
- Fix bugs that require architectural understanding
|
||||
- Document undocumented systems
|
||||
|
||||
## The Complete Brownfield Workflow
|
||||
|
||||
### Choose Your Approach
|
||||
|
||||
#### 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
|
||||
|
||||
1. **Create PRD First** to define requirements
|
||||
2. **Document only relevant areas** based on PRD needs
|
||||
3. **More efficient** - avoids documenting unused code
|
||||
|
||||
#### Approach B: Document-First (Good for Smaller Projects)
|
||||
|
||||
**Best for**: Smaller codebases, unknown systems, or exploratory changes
|
||||
|
||||
1. **Document entire system** first
|
||||
2. **Create PRD** with full context
|
||||
3. **More thorough** - captures everything
|
||||
|
||||
### Approach A: PRD-First Workflow (Recommended)
|
||||
|
||||
#### Phase 1: Define Requirements First
|
||||
|
||||
**In Gemini Web (with your codebase uploaded):**
|
||||
|
||||
```bash
|
||||
@pm
|
||||
*create-doc brownfield-prd
|
||||
```
|
||||
|
||||
The PM will:
|
||||
|
||||
- **Ask about your enhancement** requirements
|
||||
- **Explore the codebase** to understand current state
|
||||
- **Identify affected areas** that need documentation
|
||||
- **Create focused PRD** with clear scope
|
||||
|
||||
**Key Advantage**: The PRD identifies which parts of your monorepo/large codebase actually need documentation!
|
||||
|
||||
#### Phase 2: Focused Documentation
|
||||
|
||||
**Still in Gemini Web, now with PRD context:**
|
||||
|
||||
```bash
|
||||
@analyst
|
||||
*document-project
|
||||
```
|
||||
|
||||
The analyst will:
|
||||
|
||||
- **Ask about your focus** if no PRD was provided
|
||||
- **Offer options**: Create PRD, provide requirements, or describe the enhancement
|
||||
- **Reference the PRD/description** to understand scope
|
||||
- **Focus on relevant modules** identified in PRD or your description
|
||||
- **Skip unrelated areas** to keep docs lean
|
||||
- **Generate ONE architecture document** for all environments
|
||||
|
||||
The analyst creates:
|
||||
|
||||
- **One comprehensive architecture document** following fullstack-architecture template
|
||||
- **Covers all system aspects** in a single file
|
||||
- **Easy to copy and save** as `docs/project-architecture.md`
|
||||
- **Can be sharded later** in IDE if desired
|
||||
|
||||
For example, if you say "Add payment processing to user service":
|
||||
|
||||
- Documents only: user service, API endpoints, database schemas, payment integrations
|
||||
- Creates focused source tree showing only payment-related code paths
|
||||
- Skips: admin panels, reporting modules, unrelated microservices
|
||||
|
||||
### Approach B: Document-First Workflow
|
||||
|
||||
#### Phase 1: Document the Existing System
|
||||
|
||||
**Best Approach - Gemini Web with 1M+ Context**:
|
||||
|
||||
1. **Go to Gemini Web** (gemini.google.com)
|
||||
2. **Upload your project**:
|
||||
- **Option A**: Paste your GitHub repository URL directly
|
||||
- **Option B**: Upload up to 1000 files from your src/project folder
|
||||
- **Option C**: Zip your project and upload the archive
|
||||
3. **Load the analyst agent**: Upload `dist/agents/analyst.txt`
|
||||
4. **Run documentation**: Type `*document-project`
|
||||
|
||||
The analyst will generate comprehensive documentation of everything.
|
||||
|
||||
#### Phase 2: Plan Your Enhancement
|
||||
|
||||
#### Option A: Full Brownfield Workflow (Recommended for Major Changes)
|
||||
|
||||
**1. Create Brownfield PRD**:
|
||||
|
||||
```bash
|
||||
@pm
|
||||
*create-doc brownfield-prd
|
||||
```
|
||||
|
||||
The PM agent will:
|
||||
|
||||
- **Analyze existing documentation** from Phase 1
|
||||
- **Request specific enhancement details** from you
|
||||
- **Assess complexity** and recommend approach
|
||||
- **Create epic/story structure** for the enhancement
|
||||
- **Identify risks and integration points**
|
||||
|
||||
**How PM Agent Gets Project Context**:
|
||||
|
||||
- In Gemini Web: Already has full project context from Phase 1 documentation
|
||||
- In IDE: Will ask "Please provide the path to your existing project documentation"
|
||||
|
||||
**Key Prompts You'll Encounter**:
|
||||
|
||||
- "What specific enhancement or feature do you want to add?"
|
||||
- "Are there any existing systems or APIs this needs to integrate with?"
|
||||
- "What are the critical constraints we must respect?"
|
||||
- "What is your timeline and team size?"
|
||||
|
||||
**2. Create Brownfield Architecture**:
|
||||
|
||||
```bash
|
||||
@architect
|
||||
*create-doc brownfield-architecture
|
||||
```
|
||||
|
||||
The architect will:
|
||||
|
||||
- **Review the brownfield PRD**
|
||||
- **Design integration strategy**
|
||||
- **Plan migration approach** if needed
|
||||
- **Identify technical risks**
|
||||
- **Define compatibility requirements**
|
||||
|
||||
#### Option B: Quick Enhancement (For Focused Changes)
|
||||
|
||||
**For Single Epic Without Full PRD**:
|
||||
|
||||
```bash
|
||||
@pm
|
||||
*brownfield-create-epic
|
||||
```
|
||||
|
||||
Use when:
|
||||
|
||||
- Enhancement is well-defined and isolated
|
||||
- Existing documentation is comprehensive
|
||||
- Changes don't impact multiple systems
|
||||
- You need quick turnaround
|
||||
|
||||
**For Single Story**:
|
||||
|
||||
```bash
|
||||
@pm
|
||||
*brownfield-create-story
|
||||
```
|
||||
|
||||
Use when:
|
||||
|
||||
- Bug fix or tiny feature
|
||||
- Very isolated change
|
||||
- No architectural impact
|
||||
- Clear implementation path
|
||||
|
||||
### Phase 3: Validate Planning Artifacts
|
||||
|
||||
```bash
|
||||
@po
|
||||
*execute-checklist po-master-checklist
|
||||
```
|
||||
|
||||
The PO ensures:
|
||||
|
||||
- Compatibility with existing system
|
||||
- No breaking changes planned
|
||||
- Risk mitigation strategies in place
|
||||
- Clear integration approach
|
||||
|
||||
### Phase 4: Transition to Development
|
||||
|
||||
Follow the enhanced IDE Development Workflow:
|
||||
|
||||
1. **Ensure documents are in project**:
|
||||
|
||||
- Copy `docs/prd.md` (or brownfield-prd.md)
|
||||
- Copy `docs/architecture.md` (or brownfield-architecture.md)
|
||||
|
||||
2. **Shard documents**:
|
||||
|
||||
```bash
|
||||
@po
|
||||
# Ask to shard docs/prd.md
|
||||
```
|
||||
|
||||
3. **Development cycle**:
|
||||
- **SM** creates stories with integration awareness
|
||||
- **Dev** implements with existing code respect
|
||||
- **QA** reviews for compatibility and improvements
|
||||
|
||||
## Brownfield Best Practices
|
||||
|
||||
### 1. Always Document First
|
||||
|
||||
Even if you think you know the codebase:
|
||||
|
||||
- Run `document-project` to capture current state
|
||||
- AI agents need this context
|
||||
- Discovers undocumented patterns
|
||||
|
||||
### 2. Respect Existing Patterns
|
||||
|
||||
The brownfield templates specifically look for:
|
||||
|
||||
- Current coding conventions
|
||||
- Existing architectural patterns
|
||||
- Technology constraints
|
||||
- Team preferences
|
||||
|
||||
### 3. Plan for Gradual Rollout
|
||||
|
||||
Brownfield changes should:
|
||||
|
||||
- Support feature flags
|
||||
- Plan rollback strategies
|
||||
- Include migration scripts
|
||||
- Maintain backwards compatibility
|
||||
|
||||
### 4. Test Integration Thoroughly
|
||||
|
||||
Focus testing on:
|
||||
|
||||
- Integration points
|
||||
- Existing functionality (regression)
|
||||
- Performance impact
|
||||
- Data migrations
|
||||
|
||||
### 5. Communicate Changes
|
||||
|
||||
Document:
|
||||
|
||||
- What changed and why
|
||||
- Migration instructions
|
||||
- New patterns introduced
|
||||
- Deprecation notices
|
||||
|
||||
## Common Brownfield Scenarios
|
||||
|
||||
### Scenario 1: Adding a New Feature
|
||||
|
||||
1. Document existing system
|
||||
2. Create brownfield PRD focusing on integration
|
||||
3. Architecture emphasizes compatibility
|
||||
4. Stories include integration tasks
|
||||
|
||||
### Scenario 2: Modernizing Legacy Code
|
||||
|
||||
1. Extensive documentation phase
|
||||
2. PRD includes migration strategy
|
||||
3. Architecture plans gradual transition
|
||||
4. Stories follow strangler fig pattern
|
||||
|
||||
### Scenario 3: Bug Fix in Complex System
|
||||
|
||||
1. Document relevant subsystems
|
||||
2. Use `brownfield-create-story` for focused fix
|
||||
3. Include regression test requirements
|
||||
4. QA validates no side effects
|
||||
|
||||
### Scenario 4: API Integration
|
||||
|
||||
1. Document existing API patterns
|
||||
2. PRD defines integration requirements
|
||||
3. Architecture ensures consistent patterns
|
||||
4. Stories include API documentation updates
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "The AI doesn't understand my codebase"
|
||||
|
||||
**Solution**: Re-run `document-project` with more specific paths to critical files
|
||||
|
||||
### "Generated plans don't fit our patterns"
|
||||
|
||||
**Solution**: Update generated documentation with your specific conventions before planning phase
|
||||
|
||||
### "Too much boilerplate for small changes"
|
||||
|
||||
**Solution**: Use `brownfield-create-story` instead of full workflow
|
||||
|
||||
### "Integration points unclear"
|
||||
|
||||
**Solution**: Provide more context during PRD creation, specifically highlighting integration systems
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Brownfield-Specific Commands
|
||||
|
||||
```bash
|
||||
# Document existing project
|
||||
@analyst → *document-project
|
||||
|
||||
# Create enhancement PRD
|
||||
@pm → *create-doc brownfield-prd
|
||||
|
||||
# Create architecture with integration focus
|
||||
@architect → *create-doc brownfield-architecture
|
||||
|
||||
# Quick epic creation
|
||||
@pm → *brownfield-create-epic
|
||||
|
||||
# Single story creation
|
||||
@pm → *brownfield-create-story
|
||||
```
|
||||
|
||||
### Decision Tree
|
||||
|
||||
```text
|
||||
Do you have a large codebase or monorepo?
|
||||
├─ Yes → PRD-First Approach
|
||||
│ └─ Create PRD → Document only affected areas
|
||||
└─ No → Is the codebase well-known to you?
|
||||
├─ Yes → PRD-First Approach
|
||||
└─ No → Document-First Approach
|
||||
|
||||
Is this a major enhancement affecting multiple systems?
|
||||
├─ Yes → Full Brownfield Workflow
|
||||
└─ No → Is this more than a simple bug fix?
|
||||
├─ Yes → brownfield-create-epic
|
||||
└─ No → brownfield-create-story
|
||||
```
|
||||
|
||||
## Conclusion
|
||||
|
||||
Brownfield development with BMAD-METHOD provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
|
||||
|
||||
Remember: **Document First, Plan Carefully, Integrate Safely**
|
||||
7
expansion-packs/bmad-2d-phaser-game-dev/config.yml
Normal file
7
expansion-packs/bmad-2d-phaser-game-dev/config.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
name: bmad-2d-phaser-game-dev
|
||||
version: 1.2.0
|
||||
short-title: 2D game development with Phaser 3 & TypeScript
|
||||
description: >-
|
||||
2D Game Development expansion pack for BMAD Method - Phaser 3 & TypeScript
|
||||
focused
|
||||
author: Brian (BMad)
|
||||
@@ -1,45 +0,0 @@
|
||||
name: bmad-2d-phaser-game-dev
|
||||
version: 1.0.0
|
||||
description: 2D Game Development expansion pack for BMAD Method - Phaser 3 & TypeScript focused
|
||||
author: BMAD Team
|
||||
files:
|
||||
- source: agents/game-designer.md
|
||||
destination: .bmad-core/agents/game-designer.md
|
||||
- source: agents/game-developer.md
|
||||
destination: .bmad-core/agents/game-developer.md
|
||||
- source: agents/game-sm.md
|
||||
destination: .bmad-core/agents/game-sm.md
|
||||
- source: team-game-dev.yml
|
||||
destination: .bmad-core/agent-teams/team-game-dev.yml
|
||||
- source: templates/game-design-doc-tmpl.md
|
||||
destination: .bmad-core/templates/game-design-doc-tmpl.md
|
||||
- source: templates/game-architecture-tmpl.md
|
||||
destination: .bmad-core/templates/game-architecture-tmpl.md
|
||||
- source: templates/level-design-doc-tmpl.md
|
||||
destination: .bmad-core/templates/level-design-doc-tmpl.md
|
||||
- source: templates/game-story-tmpl.md
|
||||
destination: .bmad-core/templates/game-story-tmpl.md
|
||||
- source: templates/game-brief-tmpl.md
|
||||
destination: .bmad-core/templates/game-brief-tmpl.md
|
||||
- source: tasks/create-game-story.md
|
||||
destination: .bmad-core/tasks/create-game-story.md
|
||||
- source: tasks/game-design-brainstorming.md
|
||||
destination: .bmad-core/tasks/game-design-brainstorming.md
|
||||
- source: tasks/advanced-elicitation.md
|
||||
destination: .bmad-core/tasks/advanced-elicitation.md
|
||||
- source: checklists/game-story-dod-checklist.md
|
||||
destination: .bmad-core/checklists/game-story-dod-checklist.md
|
||||
- source: checklists/game-design-checklist.md
|
||||
destination: .bmad-core/checklists/game-design-checklist.md
|
||||
- source: data/bmad-kb.md
|
||||
destination: .bmad-core/data/bmad-kb.md
|
||||
- source: data/development-guidelines.md
|
||||
destination: .bmad-core/data/development-guidelines.md
|
||||
- source: workflows/game-dev-greenfield.yml
|
||||
destination: .bmad-core/workflows/game-dev-greenfield.yml
|
||||
- source: workflows/game-prototype.yml
|
||||
destination: .bmad-core/workflows/game-prototype.yml
|
||||
dependencies:
|
||||
- architect
|
||||
- developer
|
||||
- sm
|
||||
5
expansion-packs/bmad-creator-tools/config.yml
Normal file
5
expansion-packs/bmad-creator-tools/config.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
name: bmad-creator-tools
|
||||
version: 1.1.0
|
||||
short-title: Tools for creating BMAD framework components
|
||||
description: Tools for creating and extending BMAD framework components.
|
||||
author: Brian (BMad)
|
||||
@@ -4,7 +4,7 @@ This task guides you through creating a new BMAD agent following the standard te
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Agent template: `.bmad-core/templates/agent-tmpl.md`
|
||||
- Agent template: `../templates/agent-tmpl.md`
|
||||
- Target directory: `.bmad-core/agents/`
|
||||
|
||||
## Steps
|
||||
@@ -18,7 +18,7 @@ Every expansion pack MUST include a custom BMAD orchestrator agent with sophisti
|
||||
|
||||
1. **Create Planning Document First**: Before any implementation, create a comprehensive plan for user approval
|
||||
2. **Agent Architecture Standards**: Use YAML-in-Markdown structure with activation instructions, personas, and command systems
|
||||
3. **Character Consistency**: Every agent must have a persistent persona with name, communication style, and numbered options protocol
|
||||
3. **Character Consistency**: Every agent must have a persistent persona with name, communication style, and numbered options protocol similar to `expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md`
|
||||
4. **Custom Themed Orchestrator**: The orchestrator should embody the domain theme (e.g., Office Manager for medical, Project Lead for tech) for better user experience
|
||||
5. **Core Utilities Required**: ALWAYS include these core files in every expansion pack:
|
||||
- `tasks/create-doc.md` - Document creation from templates
|
||||
@@ -26,8 +26,8 @@ Every expansion pack MUST include a custom BMAD orchestrator agent with sophisti
|
||||
- `utils/template-format.md` - Template markup conventions
|
||||
- `utils/workflow-management.md` - Workflow orchestration
|
||||
6. **Team and Workflow Requirements**: If pack has >1 agent, MUST include:
|
||||
- At least one team configuration in `agent-teams/`
|
||||
- At least one workflow in `workflows/`
|
||||
- At least one team configuration in `expansion-packs/{new-expansion}/agent-teams/`
|
||||
- At least one workflow in `expansion-packs/{new-expansion}workflows/`
|
||||
7. **Template Sophistication**: Implement LLM instruction embedding with `[[LLM: guidance]]`, conditional content, and variable systems
|
||||
8. **Workflow Orchestration**: Include decision trees, handoff protocols, and validation loops
|
||||
9. **Quality Assurance Integration**: Multi-level checklists with star ratings and ready/not-ready frameworks
|
||||
@@ -436,17 +436,17 @@ IMPORTANT: Work through plan.md checklist systematically!
|
||||
|
||||
**Step 2: Copy Core Utilities**
|
||||
|
||||
Before proceeding, copy these essential files from bmad-core:
|
||||
Before proceeding, copy these essential files from common:
|
||||
|
||||
```bash
|
||||
# Copy core task utilities
|
||||
cp bmad-core/tasks/create-doc.md expansion-packs/{pack-name}/tasks/
|
||||
cp bmad-core/tasks/execute-checklist.md expansion-packs/{pack-name}/tasks/
|
||||
cp common/tasks/create-doc.md expansion-packs/{pack-name}/tasks/
|
||||
cp common/tasks/execute-checklist.md expansion-packs/{pack-name}/tasks/
|
||||
|
||||
# Copy core utility files
|
||||
mkdir -p expansion-packs/{pack-name}/utils
|
||||
cp bmad-core/utils/template-format.md expansion-packs/{pack-name}/utils/
|
||||
cp bmad-core/utils/workflow-management.md expansion-packs/{pack-name}/utils/
|
||||
cp common/utils/template-format.md expansion-packs/{pack-name}/utils/
|
||||
cp common/utils/workflow-management.md expansion-packs/{pack-name}/utils/
|
||||
```
|
||||
|
||||
**Step 3: Technical Implementation**
|
||||
@@ -1018,11 +1018,3 @@ Embedded knowledge (automatic):
|
||||
- [ ] Template conditional content tested with different scenarios
|
||||
- [ ] Workflow decision trees validated with sample use cases
|
||||
- [ ] Character interactions tested for consistency and professional authenticity
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
8
expansion-packs/bmad-infrastructure-devops/config.yml
Normal file
8
expansion-packs/bmad-infrastructure-devops/config.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
name: bmad-infrastructure-devops
|
||||
version: 1.1.0
|
||||
short-title: Infrastructure and DevOps capabilities
|
||||
description: >-
|
||||
This expansion pack extends BMAD Method with comprehensive infrastructure and
|
||||
DevOps capabilities. It's designed for teams that need to define, implement,
|
||||
and manage cloud infrastructure alongside their application development.
|
||||
author: Brian (BMad)
|
||||
@@ -1,23 +0,0 @@
|
||||
name: bmad-infrastructure-devops
|
||||
version: 1.0.0
|
||||
description: Infrastructure & DevOps expansion pack for BMAD Method - Platform engineering and cloud infrastructure focused
|
||||
author: BMAD Team
|
||||
files:
|
||||
- source: agents/infra-devops-platform.md
|
||||
destination: .bmad-core/agents/infra-devops-platform.md
|
||||
- source: templates/infrastructure-architecture-tmpl.md
|
||||
destination: .bmad-core/templates/infrastructure-architecture-tmpl.md
|
||||
- source: templates/infrastructure-platform-from-arch-tmpl.md
|
||||
destination: .bmad-core/templates/infrastructure-platform-from-arch-tmpl.md
|
||||
- source: tasks/create-doc.md
|
||||
destination: .bmad-core/tasks/create-doc.md
|
||||
- source: tasks/review-infrastructure.md
|
||||
destination: .bmad-core/tasks/review-infrastructure.md
|
||||
- source: tasks/validate-infrastructure.md
|
||||
destination: .bmad-core/tasks/validate-infrastructure.md
|
||||
- source: checklists/infrastructure-checklist.md
|
||||
destination: .bmad-core/checklists/infrastructure-checklist.md
|
||||
dependencies:
|
||||
- architect
|
||||
- operations-specialist
|
||||
- security-specialist
|
||||
@@ -1,74 +0,0 @@
|
||||
# Create Document from Template Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Identify Template and Context
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
|
||||
### 6. Validation
|
||||
|
||||
If template specifies a checklist:
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
|
||||
### 7. Final Presentation
|
||||
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
|
||||
## Important Notes
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
@@ -1,74 +0,0 @@
|
||||
# Create Document from Template Task
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
|
||||
## Instructions
|
||||
|
||||
### 1. Identify Template and Context
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the /templates directory
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
|
||||
### 6. Validation
|
||||
|
||||
If template specifies a checklist:
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
|
||||
### 7. Final Presentation
|
||||
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
|
||||
## Important Notes
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
@@ -1,12 +0,0 @@
|
||||
name: bmad-creator-tools
|
||||
version: 1.0.0
|
||||
description: Tools for creating and extending BMAD framework components
|
||||
type: creator-tools
|
||||
compatibility:
|
||||
bmad-version: '>=4.0.0'
|
||||
components:
|
||||
agents:
|
||||
- bmad-the-creator
|
||||
tasks:
|
||||
- create-agent
|
||||
- generate-expansion-pack
|
||||
@@ -1,26 +0,0 @@
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
- **{{placeholders}}**: Variables to be replaced with actual content
|
||||
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
|
||||
- **REPEAT** sections: Content blocks that may be repeated as needed
|
||||
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
|
||||
- **@{examples}**: Example content for guidance (never output to users)
|
||||
|
||||
## Processing Rules
|
||||
|
||||
- Replace all {{placeholders}} with project-specific content
|
||||
- Execute all [[LLM: instructions]] internally without showing users
|
||||
- Process conditional and repeat blocks as specified
|
||||
- Use examples for guidance but never include them in final output
|
||||
- Present only clean, formatted content to users
|
||||
|
||||
## Critical Guidelines
|
||||
|
||||
- **NEVER display template markup, LLM instructions, or examples to users**
|
||||
- Template elements are for AI processing only
|
||||
- Focus on faithful template execution and clean output
|
||||
- All template-specific instructions are embedded within templates
|
||||
@@ -1,223 +0,0 @@
|
||||
# Workflow Management
|
||||
|
||||
This utility enables the BMAD orchestrator to manage and execute team workflows.
|
||||
|
||||
## Important: Dynamic Workflow Loading
|
||||
|
||||
The BMAD orchestrator MUST read the available workflows from the current team configuration's `workflows` field. Do not use hardcoded workflow lists. Each team bundle defines its own set of supported workflows based on the agents it includes.
|
||||
|
||||
**Critical Distinction**:
|
||||
|
||||
- When asked "what workflows are available?", show ONLY the workflows defined in the current team bundle's configuration
|
||||
- Use `/agent-list` to show agents in the current bundle
|
||||
- Use `/workflows` to show workflows in the current bundle, NOT any creation tasks
|
||||
|
||||
### Workflow Descriptions
|
||||
|
||||
When displaying workflows, use these descriptions based on the workflow ID:
|
||||
|
||||
- **greenfield-fullstack**: Build a new full-stack application from concept to development
|
||||
- **brownfield-fullstack**: Enhance an existing full-stack application with new features
|
||||
- **greenfield-service**: Build a new backend service or API from concept to development
|
||||
- **brownfield-service**: Enhance an existing backend service or API
|
||||
- **greenfield-ui**: Build a new frontend/UI application from concept to development
|
||||
- **brownfield-ui**: Enhance an existing frontend/UI application
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
### /workflows
|
||||
|
||||
Lists all available workflows for the current team. The available workflows are determined by the team configuration and may include workflows such as:
|
||||
|
||||
- greenfield-fullstack
|
||||
- brownfield-fullstack
|
||||
- greenfield-service
|
||||
- brownfield-service
|
||||
- greenfield-ui
|
||||
- brownfield-ui
|
||||
|
||||
The actual list depends on which team bundle is loaded. When responding to this command, display the workflows that are configured in the current team's `workflows` field.
|
||||
|
||||
Example response format:
|
||||
|
||||
```text
|
||||
Available workflows for [Team Name]:
|
||||
1. [workflow-id] - [Brief description based on workflow type]
|
||||
2. [workflow-id] - [Brief description based on workflow type]
|
||||
[... etc. ...]
|
||||
|
||||
Use /workflow-start {number or id} to begin a workflow.
|
||||
```
|
||||
|
||||
### /workflow-start {workflow-id}
|
||||
|
||||
Starts a specific workflow and transitions to the first agent.
|
||||
|
||||
Example: `/workflow-start greenfield-fullstack`
|
||||
|
||||
### /workflow-status
|
||||
|
||||
Shows current workflow progress, completed artifacts, and next steps.
|
||||
|
||||
Example response:
|
||||
|
||||
```text
|
||||
Current Workflow: Greenfield Full-Stack Development
|
||||
Stage: Product Planning (2 of 6)
|
||||
Completed:
|
||||
✓ Discovery & Requirements
|
||||
- project-brief (completed by Mary)
|
||||
|
||||
In Progress:
|
||||
⚡ Product Planning
|
||||
- Create PRD (John) - awaiting input
|
||||
|
||||
Next: Technical Architecture
|
||||
```
|
||||
|
||||
### /workflow-resume
|
||||
|
||||
Resumes a workflow from where it left off, useful when starting a new chat.
|
||||
|
||||
User can provide completed artifacts:
|
||||
|
||||
```text
|
||||
User: /workflow-resume greenfield-fullstack
|
||||
I have completed: project-brief, PRD
|
||||
BMad: I see you've completed Discovery and part of Product Planning.
|
||||
Based on the greenfield-fullstack workflow, the next step is:
|
||||
- UX Strategy with Sally (ux-expert)
|
||||
|
||||
Would you like me to load Sally to continue?
|
||||
```
|
||||
|
||||
### /workflow-next
|
||||
|
||||
Shows the next recommended agent and action in the current workflow.
|
||||
|
||||
## Workflow Execution Flow
|
||||
|
||||
### 1. Starting a Workflow
|
||||
|
||||
When a workflow is started:
|
||||
|
||||
1. Load the workflow definition
|
||||
2. Identify the first stage and step
|
||||
3. Transition to the required agent
|
||||
4. Provide context about expected inputs/outputs
|
||||
5. Guide artifact creation
|
||||
|
||||
### 2. Stage Transitions
|
||||
|
||||
After each artifact is completed:
|
||||
|
||||
1. Mark the step as complete
|
||||
2. Check transition conditions
|
||||
3. If stage is complete, move to next stage
|
||||
4. Load the appropriate agent
|
||||
5. Pass relevant artifacts as context
|
||||
|
||||
### 3. Artifact Tracking
|
||||
|
||||
Track all created artifacts:
|
||||
|
||||
```yaml
|
||||
workflow_state:
|
||||
current_workflow: greenfield-fullstack
|
||||
current_stage: planning
|
||||
current_step: 2
|
||||
artifacts:
|
||||
project-brief:
|
||||
status: completed
|
||||
created_by: analyst
|
||||
timestamp: 2024-01-15T10:30:00.000Z
|
||||
prd:
|
||||
status: in-progress
|
||||
created_by: pm
|
||||
started: 2024-01-15T11:00:00.000Z
|
||||
```
|
||||
|
||||
### 4. Workflow Interruption Handling
|
||||
|
||||
When user returns after interruption:
|
||||
|
||||
1. Ask if continuing previous workflow
|
||||
2. Request any completed artifacts
|
||||
3. Analyze provided artifacts
|
||||
4. Determine workflow position
|
||||
5. Suggest next appropriate step
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
User: I'm working on a new app. Here's my PRD and architecture doc.
|
||||
BMad: I see you have a PRD and architecture document. Based on these artifacts,
|
||||
it looks like you're following the greenfield-fullstack workflow and have completed
|
||||
stages 1-3. The next recommended step would be:
|
||||
|
||||
Stage 4: Validation & Refinement
|
||||
- Load Sarah (Product Owner) to validate all artifacts
|
||||
|
||||
Would you like to continue with this workflow?
|
||||
```
|
||||
|
||||
## Workflow Context Passing
|
||||
|
||||
When transitioning between agents, pass:
|
||||
|
||||
1. Previous artifacts created
|
||||
2. Current workflow stage
|
||||
3. Expected outputs
|
||||
4. Any decisions or constraints identified
|
||||
|
||||
Example transition:
|
||||
|
||||
```text
|
||||
BMad: Great! John has completed the PRD. According to the greenfield-fullstack workflow,
|
||||
the next step is UX Strategy with Sally.
|
||||
|
||||
/ux-expert
|
||||
|
||||
Sally: I see we're in the Product Planning stage of the greenfield-fullstack workflow.
|
||||
I have access to:
|
||||
- Project Brief from Mary
|
||||
- PRD from John
|
||||
|
||||
Let's create the UX strategy and UI specifications. First, let me review
|
||||
the PRD to understand the features we're designing for...
|
||||
```
|
||||
|
||||
## Multi-Path Workflows
|
||||
|
||||
Some workflows may have multiple paths:
|
||||
|
||||
```yaml
|
||||
conditional_paths:
|
||||
- condition: project_type == 'mobile'
|
||||
next_stage: mobile-specific-design
|
||||
- condition: project_type == 'web'
|
||||
next_stage: web-architecture
|
||||
- default: fullstack-architecture
|
||||
```
|
||||
|
||||
Handle these by asking clarifying questions when needed.
|
||||
|
||||
## Workflow Best Practices
|
||||
|
||||
1. **Always show progress** - Users should know where they are
|
||||
2. **Explain transitions** - Why moving to next agent
|
||||
3. **Preserve context** - Pass relevant information forward
|
||||
4. **Allow flexibility** - Users can skip or modify steps
|
||||
5. **Track everything** - Maintain complete workflow state
|
||||
|
||||
## Integration with Agents
|
||||
|
||||
Each agent should be workflow-aware:
|
||||
|
||||
- Know which workflow is active
|
||||
- Understand their role in the workflow
|
||||
- Access previous artifacts
|
||||
- Know expected outputs
|
||||
- Guide toward workflow goals
|
||||
|
||||
This creates a seamless experience where the entire team works together toward the workflow's objectives.
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.10.0",
|
||||
"version": "4.24.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "4.10.0",
|
||||
"version": "4.24.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||
|
||||
16
package.json
16
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.10.0",
|
||||
"version": "4.24.0",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
@@ -18,6 +18,20 @@
|
||||
"version:patch": "node tools/version-bump.js patch",
|
||||
"version:minor": "node tools/version-bump.js minor",
|
||||
"version:major": "node tools/version-bump.js major",
|
||||
"version:core": "node tools/bump-core-version.js",
|
||||
"version:core:major": "node tools/bump-core-version.js major",
|
||||
"version:core:minor": "node tools/bump-core-version.js minor",
|
||||
"version:core:patch": "node tools/bump-core-version.js patch",
|
||||
"version:expansion": "node tools/bump-expansion-version.js",
|
||||
"version:expansion:set": "node tools/update-expansion-version.js",
|
||||
"version:all": "node tools/bump-all-versions.js",
|
||||
"version:all:minor": "node tools/bump-all-versions.js minor",
|
||||
"version:all:major": "node tools/bump-all-versions.js major",
|
||||
"version:all:patch": "node tools/bump-all-versions.js patch",
|
||||
"version:expansion:all": "node tools/bump-all-versions.js",
|
||||
"version:expansion:all:minor": "node tools/bump-all-versions.js minor",
|
||||
"version:expansion:all:major": "node tools/bump-all-versions.js major",
|
||||
"version:expansion:all:patch": "node tools/bump-all-versions.js patch",
|
||||
"release": "semantic-release",
|
||||
"release:test": "semantic-release --dry-run --no-ci || echo 'Config test complete - authentication errors are expected locally'",
|
||||
"prepare": "husky"
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user