mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
Compare commits
109 Commits
docs/tea-a
...
0d2b8c3429
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0d2b8c3429 | ||
|
|
984bd9e558 | ||
|
|
6a282f86b4 | ||
|
|
6c5381b6dc | ||
|
|
27c18e0020 | ||
|
|
9ebc4ce9c0 | ||
|
|
5ffef8dc35 | ||
|
|
43c0e290d2 | ||
|
|
cad9be3e89 | ||
|
|
82d211b7ca | ||
|
|
8719d828d0 | ||
|
|
3abcefe1fb | ||
|
|
9168e00167 | ||
|
|
d0c9cd7b0b | ||
|
|
c352e03d18 | ||
|
|
9b12f6f86c | ||
|
|
91f6c41be1 | ||
|
|
02513c721f | ||
|
|
e7a34a2b61 | ||
|
|
85339708e6 | ||
|
|
b4f230f565 | ||
|
|
b102694c64 | ||
|
|
5aef6379b9 | ||
|
|
4cb5cc7dbc | ||
|
|
c5d0fb55ba | ||
|
|
c0adbc4e76 | ||
|
|
f6dab0d0ff | ||
|
|
cf6cf779bb | ||
|
|
7074395bdd | ||
|
|
9b8ce69f37 | ||
|
|
79959e75ac | ||
|
|
8bdf21f65b | ||
|
|
7d63dcd6a0 | ||
|
|
999ece33a9 | ||
|
|
baf2b9daef | ||
|
|
9abd6654f1 | ||
|
|
4346f0bcf3 | ||
|
|
431b961451 | ||
|
|
def8da0acb | ||
|
|
48881f86a6 | ||
|
|
efbe839a0a | ||
|
|
3f9ad4868c | ||
|
|
aad132c9b1 | ||
|
|
c9f2dc51db | ||
|
|
6eb7c34752 | ||
|
|
9b9f43fcb9 | ||
|
|
77a53a20ed | ||
|
|
5d89298fe8 | ||
|
|
421a811e87 | ||
|
|
c9c3d31d3a | ||
|
|
ec8ab0c638 | ||
|
|
aae7923d5d | ||
|
|
3734607994 | ||
|
|
e29a1273e1 | ||
|
|
01bbe2a3ef | ||
|
|
73135bee8e | ||
|
|
6f8f0871cf | ||
|
|
14bfa5b224 | ||
|
|
83641eee9d | ||
|
|
a96ea2f19a | ||
|
|
28e6dded4d | ||
|
|
966ca5db0b | ||
|
|
e0318d9da8 | ||
|
|
4a983d64a7 | ||
|
|
f25fcc686c | ||
|
|
411cded4d0 | ||
|
|
a50d82df1c | ||
|
|
d022e569bd | ||
|
|
7990ad528c | ||
|
|
5881790068 | ||
|
|
d83a88da66 | ||
|
|
7b68d1a326 | ||
|
|
7cd4926adb | ||
|
|
0fa53ad144 | ||
|
|
afee68ca99 | ||
|
|
b952d28fb3 | ||
|
|
577c1aa218 | ||
|
|
abba7ee987 | ||
|
|
d34efa2695 | ||
|
|
87b1292e3f | ||
|
|
43f7eee29a | ||
|
|
96f21be73e | ||
|
|
66e7d3a36d | ||
|
|
2b7f7ff421 | ||
|
|
3360666c2a | ||
|
|
274dea16fa | ||
|
|
dcd581c84a | ||
|
|
6d84a60a78 | ||
|
|
59e1b7067c | ||
|
|
1d8df63ac5 | ||
|
|
993d02b8b3 | ||
|
|
5cb5606ba3 | ||
|
|
eeebf152af | ||
|
|
d419ac8a70 | ||
|
|
568249e985 | ||
|
|
c0f6401902 | ||
|
|
e535f94325 | ||
|
|
e465ce4bb5 | ||
|
|
9d328082eb | ||
|
|
d4f6642333 | ||
|
|
9f85dade25 | ||
|
|
5870651bad | ||
|
|
eff826eef9 | ||
|
|
0a3cc1d12c | ||
|
|
c3b7e98241 | ||
|
|
2f98f9130a | ||
|
|
c18904d674 | ||
|
|
3e3c92ed3e | ||
|
|
12d3492e0c |
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,32 +0,0 @@
|
||||
---
|
||||
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
|
||||
7
.github/ISSUE_TEMPLATE/config.yaml
vendored
7
.github/ISSUE_TEMPLATE/config.yaml
vendored
@@ -1,5 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discord Community Support
|
||||
- name: 📚 Documentation
|
||||
url: http://docs.bmad-method.org
|
||||
about: Check the docs first — tutorials, guides, and reference
|
||||
- name: 💬 Discord Community
|
||||
url: https://discord.gg/gk8jAdXWmj
|
||||
about: Please join our Discord server for general questions and community discussion before opening an issue.
|
||||
about: Join for questions, discussion, and help before opening an issue
|
||||
|
||||
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 or new feature
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe your idea**
|
||||
A clear and concise description of what you'd like to see added or changed.
|
||||
|
||||
**Why is this needed?**
|
||||
Explain the problem this solves or the benefit it brings to the BMad community.
|
||||
|
||||
**How should it work?**
|
||||
Describe your proposed solution. If you have ideas on implementation, share them here.
|
||||
|
||||
**PR**
|
||||
If you'd like to contribute, please indicate you're working on this or link to your PR. Please review [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
|
||||
|
||||
**Additional context**
|
||||
Add any other context, screenshots, or links that help explain your idea.
|
||||
109
.github/ISSUE_TEMPLATE/idea_submission.md
vendored
109
.github/ISSUE_TEMPLATE/idea_submission.md
vendored
@@ -1,109 +0,0 @@
|
||||
---
|
||||
name: V6 Idea Submission
|
||||
about: Suggest an idea for v6
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
# Idea: [Replace with a clear, actionable title]
|
||||
|
||||
## PASS Framework
|
||||
|
||||
**P**roblem:
|
||||
|
||||
> What's broken or missing? What pain point are we addressing? (1-2 sentences)
|
||||
>
|
||||
> [Your answer here]
|
||||
|
||||
**A**udience:
|
||||
|
||||
> Who's affected by this problem and how severely? (1-2 sentences)
|
||||
>
|
||||
> [Your answer here]
|
||||
|
||||
**S**olution:
|
||||
|
||||
> What will we build or change? How will we measure success? (1-2 sentences with at least 1 measurable outcome)
|
||||
>
|
||||
> [Your answer here]
|
||||
>
|
||||
> [Your Acceptance Criteria for measuring success here]
|
||||
|
||||
**S**ize:
|
||||
|
||||
> How much effort do you estimate this will take?
|
||||
>
|
||||
> - [ ] **XS** - A few hours
|
||||
> - [ ] **S** - 1-2 days
|
||||
> - [ ] **M** - 3-5 days
|
||||
> - [ ] **L** - 1-2 weeks
|
||||
> - [ ] **XL** - More than 2 weeks
|
||||
|
||||
---
|
||||
|
||||
### Metadata
|
||||
|
||||
**Submitted by:** [Your name]
|
||||
**Date:** [Today's date]
|
||||
**Priority:** [Leave blank - will be assigned during team review]
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
<details>
|
||||
<summary>Click to see a GOOD example</summary>
|
||||
|
||||
### Idea: Add search functionality to customer dashboard
|
||||
|
||||
**P**roblem:
|
||||
Customers can't find their past orders quickly. They have to scroll through pages of orders to find what they're looking for, leading to 15+ support tickets per week.
|
||||
|
||||
**A**udience:
|
||||
All 5,000+ active customers are affected. Support team spends ~10 hours/week helping customers find orders.
|
||||
|
||||
**S**olution:
|
||||
Add a search bar that filters by order number, date range, and product name. Success = 50% reduction in order-finding support tickets within 2 weeks of launch.
|
||||
|
||||
**S**ize:
|
||||
|
||||
- [x] **M** - 3-5 days
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Click to see a POOR example</summary>
|
||||
|
||||
### Idea: Make the app better
|
||||
|
||||
**P**roblem:
|
||||
The app needs improvements and updates.
|
||||
|
||||
**A**udience:
|
||||
Users
|
||||
|
||||
**S**olution:
|
||||
Fix issues and add features.
|
||||
|
||||
**S**ize:
|
||||
|
||||
- [ ] Unknown
|
||||
|
||||
_Why this is poor: Too vague, no specific problem identified, no measurable success criteria, unclear scope_
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Tips for Success
|
||||
|
||||
1. **Be specific** - Vague problems lead to vague solutions
|
||||
2. **Quantify when possible** - Numbers help us prioritize (e.g., "20 customers asked for this" vs "customers want this")
|
||||
3. **One idea per submission** - If you have multiple ideas, submit multiple templates
|
||||
4. **Success metrics matter** - How will we know this worked?
|
||||
5. **Honest sizing** - Better to overestimate than underestimate
|
||||
|
||||
## Questions?
|
||||
|
||||
Reach out to @OverlordBaconPants if you need help completing this template.
|
||||
32
.github/ISSUE_TEMPLATE/issue.md
vendored
Normal file
32
.github/ISSUE_TEMPLATE/issue.md
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
name: Issue
|
||||
about: Report a problem or something that's not working
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**Steps to reproduce**
|
||||
1. What were you doing when the bug occurred?
|
||||
2. What steps can recreate the issue?
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Environment (if relevant)**
|
||||
- Model(s) used:
|
||||
- Agentic IDE used:
|
||||
- BMad version:
|
||||
- Project language:
|
||||
|
||||
**Screenshots or links**
|
||||
If applicable, add screenshots or links to help explain the problem.
|
||||
|
||||
**PR**
|
||||
If you'd like to contribute a fix, please indicate you're working on it or link to your PR. See [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here. The more information you provide, the easier it is to help.
|
||||
329
.github/workflows/bundle-latest.yaml
vendored
329
.github/workflows/bundle-latest.yaml
vendored
@@ -1,329 +0,0 @@
|
||||
name: Publish Latest Bundles
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch: {}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
bundle-and-publish:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout BMAD-METHOD
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ".nvmrc"
|
||||
cache: npm
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Generate bundles
|
||||
run: npm run bundle
|
||||
|
||||
- name: Create bundle distribution structure
|
||||
run: |
|
||||
mkdir -p dist/bundles
|
||||
|
||||
# Copy web bundles (XML files from npm run bundle output)
|
||||
cp -r web-bundles/* dist/bundles/ 2>/dev/null || true
|
||||
|
||||
# Verify bundles were copied (fail if completely empty)
|
||||
if [ ! "$(ls -A dist/bundles)" ]; then
|
||||
echo "❌ ERROR: No bundles found in dist/bundles/"
|
||||
echo "This likely means 'npm run bundle' failed or bundles weren't generated"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Count bundles per module
|
||||
for module in bmm bmb cis bmgd; do
|
||||
if [ -d "dist/bundles/$module/agents" ]; then
|
||||
COUNT=$(find dist/bundles/$module/agents -name '*.xml' 2>/dev/null | wc -l)
|
||||
echo "✅ $module: $COUNT agent bundles"
|
||||
fi
|
||||
done
|
||||
|
||||
# Generate index.html for each agents directory (fixes directory browsing)
|
||||
for module in bmm bmb cis bmgd; do
|
||||
if [ -d "dist/bundles/$module/agents" ]; then
|
||||
cat > "dist/bundles/$module/agents/index.html" << 'DIREOF'
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>MODULE_NAME Agents</title>
|
||||
<style>
|
||||
body { font-family: system-ui; max-width: 800px; margin: 50px auto; padding: 20px; }
|
||||
li { margin: 10px 0; }
|
||||
a { color: #0066cc; text-decoration: none; }
|
||||
a:hover { text-decoration: underline; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>MODULE_NAME Agents</h1>
|
||||
<ul>
|
||||
AGENT_LINKS
|
||||
</ul>
|
||||
<p><a href="../../">← Back to all modules</a></p>
|
||||
</body>
|
||||
</html>
|
||||
DIREOF
|
||||
|
||||
# Replace MODULE_NAME
|
||||
sed -i "s/MODULE_NAME/${module^^}/g" "dist/bundles/$module/agents/index.html"
|
||||
|
||||
# Generate agent links
|
||||
LINKS=""
|
||||
for file in dist/bundles/$module/agents/*.xml; do
|
||||
if [ -f "$file" ]; then
|
||||
name=$(basename "$file" .xml)
|
||||
LINKS="$LINKS <li><a href=\"./$name.xml\">$name</a></li>\n"
|
||||
fi
|
||||
done
|
||||
sed -i "s|AGENT_LINKS|$LINKS|" "dist/bundles/$module/agents/index.html"
|
||||
fi
|
||||
done
|
||||
|
||||
# Create zip archives per module
|
||||
mkdir -p dist/bundles/downloads
|
||||
for module in bmm bmb cis bmgd; do
|
||||
if [ -d "dist/bundles/$module" ]; then
|
||||
(cd dist/bundles && zip -r downloads/$module-agents.zip $module/)
|
||||
echo "✅ Created $module-agents.zip"
|
||||
fi
|
||||
done
|
||||
|
||||
# Generate index.html dynamically based on actual bundles
|
||||
TIMESTAMP=$(date -u +"%Y-%m-%d %H:%M UTC")
|
||||
COMMIT_SHA=$(git rev-parse --short HEAD)
|
||||
|
||||
# Function to generate agent links for a module
|
||||
generate_agent_links() {
|
||||
local module=$1
|
||||
local agent_dir="dist/bundles/$module/agents"
|
||||
|
||||
if [ ! -d "$agent_dir" ]; then
|
||||
echo ""
|
||||
return
|
||||
fi
|
||||
|
||||
local links=""
|
||||
local count=0
|
||||
|
||||
# Find all XML files and generate links
|
||||
for xml_file in "$agent_dir"/*.xml; do
|
||||
if [ -f "$xml_file" ]; then
|
||||
local agent_name=$(basename "$xml_file" .xml)
|
||||
# Convert filename to display name (pm -> PM, tech-writer -> Tech Writer)
|
||||
local display_name=$(echo "$agent_name" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++) {if(length($i)==2) $i=toupper($i); else $i=toupper(substr($i,1,1)) tolower(substr($i,2));}}1')
|
||||
|
||||
if [ $count -gt 0 ]; then
|
||||
links="$links | "
|
||||
fi
|
||||
links="$links<a href=\"./$module/agents/$agent_name.xml\">$display_name</a>"
|
||||
count=$((count + 1))
|
||||
fi
|
||||
done
|
||||
|
||||
echo "$links"
|
||||
}
|
||||
|
||||
# Generate agent links for each module
|
||||
BMM_LINKS=$(generate_agent_links "bmm")
|
||||
CIS_LINKS=$(generate_agent_links "cis")
|
||||
BMGD_LINKS=$(generate_agent_links "bmgd")
|
||||
|
||||
# Count agents for bulk downloads
|
||||
BMM_COUNT=$(find dist/bundles/bmm/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
||||
CIS_COUNT=$(find dist/bundles/cis/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
||||
BMGD_COUNT=$(find dist/bundles/bmgd/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
||||
|
||||
# Create index.html
|
||||
cat > dist/bundles/index.html << EOF
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>BMAD Bundles - Latest</title>
|
||||
<meta charset="utf-8">
|
||||
<style>
|
||||
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; max-width: 800px; margin: 50px auto; padding: 20px; }
|
||||
h1 { color: #333; }
|
||||
.platform { margin: 30px 0; padding: 20px; background: #f5f5f5; border-radius: 8px; }
|
||||
.module { margin: 15px 0; }
|
||||
a { color: #0066cc; text-decoration: none; }
|
||||
a:hover { text-decoration: underline; }
|
||||
code { background: #e0e0e0; padding: 2px 6px; border-radius: 3px; }
|
||||
.warning { background: #fff3cd; padding: 15px; border-left: 4px solid #ffc107; margin: 20px 0; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h1>BMAD Web Bundles - Latest (Main Branch)</h1>
|
||||
|
||||
<div class="warning">
|
||||
<strong>⚠️ Latest Build (Unstable)</strong><br>
|
||||
These bundles are built from the latest main branch commit. For stable releases, visit
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD/releases/latest">GitHub Releases</a>.
|
||||
</div>
|
||||
|
||||
<p><strong>Last Updated:</strong> <code>$TIMESTAMP</code></p>
|
||||
<p><strong>Commit:</strong> <code>$COMMIT_SHA</code></p>
|
||||
|
||||
<h2>Available Modules</h2>
|
||||
|
||||
EOF
|
||||
|
||||
# Add BMM section if agents exist
|
||||
if [ -n "$BMM_LINKS" ]; then
|
||||
cat >> dist/bundles/index.html << EOF
|
||||
<div class="platform">
|
||||
<h3>BMM (BMad Method)</h3>
|
||||
<div class="module">
|
||||
$BMM_LINKS<br>
|
||||
📁 <a href="./bmm/agents/">Browse All</a> | 📦 <a href="./downloads/bmm-agents.zip">Download Zip</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Add CIS section if agents exist
|
||||
if [ -n "$CIS_LINKS" ]; then
|
||||
cat >> dist/bundles/index.html << EOF
|
||||
<div class="platform">
|
||||
<h3>CIS (Creative Intelligence Suite)</h3>
|
||||
<div class="module">
|
||||
$CIS_LINKS<br>
|
||||
📁 <a href="./cis/agents/">Browse Agents</a> | 📦 <a href="./downloads/cis-agents.zip">Download Zip</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Add BMGD section if agents exist
|
||||
if [ -n "$BMGD_LINKS" ]; then
|
||||
cat >> dist/bundles/index.html << EOF
|
||||
<div class="platform">
|
||||
<h3>BMGD (Game Development)</h3>
|
||||
<div class="module">
|
||||
$BMGD_LINKS<br>
|
||||
📁 <a href="./bmgd/agents/">Browse Agents</a> | 📦 <a href="./downloads/bmgd-agents.zip">Download Zip</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Add bulk downloads section
|
||||
cat >> dist/bundles/index.html << EOF
|
||||
<h2>Bulk Downloads</h2>
|
||||
<p>Download all agents for a module as a zip archive:</p>
|
||||
<ul>
|
||||
EOF
|
||||
|
||||
[ "$BMM_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/bmm-agents.zip\">📦 BMM Agents (all $BMM_COUNT)</a></li>" >> dist/bundles/index.html
|
||||
[ "$CIS_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/cis-agents.zip\">📦 CIS Agents (all $CIS_COUNT)</a></li>" >> dist/bundles/index.html
|
||||
[ "$BMGD_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/bmgd-agents.zip\">📦 BMGD Agents (all $BMGD_COUNT)</a></li>" >> dist/bundles/index.html
|
||||
|
||||
# Close HTML
|
||||
cat >> dist/bundles/index.html << 'EOF'
|
||||
</ul>
|
||||
|
||||
<h2>Usage</h2>
|
||||
<p>Copy the raw XML URL and paste into your AI platform's custom instructions or project knowledge.</p>
|
||||
<p>Example: <code>https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/pm.xml</code></p>
|
||||
|
||||
<h2>Installation (Recommended)</h2>
|
||||
<p>For full IDE integration with slash commands, use the installer:</p>
|
||||
<pre>npx bmad-method@alpha install</pre>
|
||||
|
||||
<footer style="margin-top: 50px; padding-top: 20px; border-top: 1px solid #ccc; color: #666;">
|
||||
<p>Built from <a href="https://github.com/bmad-code-org/BMAD-METHOD">BMAD-METHOD</a> repository.</p>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
EOF
|
||||
|
||||
- name: Checkout bmad-bundles repo
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
repository: bmad-code-org/bmad-bundles
|
||||
path: bmad-bundles
|
||||
token: ${{ secrets.BUNDLES_PAT }}
|
||||
|
||||
- name: Update bundles
|
||||
run: |
|
||||
# Clear old bundles
|
||||
rm -rf bmad-bundles/*
|
||||
|
||||
# Copy new bundles
|
||||
cp -r dist/bundles/* bmad-bundles/
|
||||
|
||||
# Create .nojekyll for GitHub Pages
|
||||
touch bmad-bundles/.nojekyll
|
||||
|
||||
# Create README
|
||||
cat > bmad-bundles/README.md << 'EOF'
|
||||
# BMAD Web Bundles (Latest)
|
||||
|
||||
**⚠️ Unstable Build**: These bundles are auto-generated from the latest `main` branch.
|
||||
|
||||
For stable releases, visit [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases/latest).
|
||||
|
||||
## Usage
|
||||
|
||||
Copy raw markdown URLs for use in AI platforms:
|
||||
|
||||
- Claude Code: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/claude-code/sub-agents/{agent}.md`
|
||||
- ChatGPT: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/chatgpt/sub-agents/{agent}.md`
|
||||
- Gemini: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/gemini/sub-agents/{agent}.md`
|
||||
|
||||
## Browse
|
||||
|
||||
Visit [https://bmad-code-org.github.io/bmad-bundles/](https://bmad-code-org.github.io/bmad-bundles/) to browse bundles.
|
||||
|
||||
## Installation (Recommended)
|
||||
|
||||
For full IDE integration:
|
||||
```bash
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Auto-updated by [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) on every main branch merge.
|
||||
EOF
|
||||
|
||||
- name: Commit and push to bmad-bundles
|
||||
run: |
|
||||
cd bmad-bundles
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
git add .
|
||||
|
||||
if git diff --staged --quiet; then
|
||||
echo "No changes to bundles, skipping commit"
|
||||
else
|
||||
COMMIT_SHA=$(cd .. && git rev-parse --short HEAD)
|
||||
git commit -m "Update bundles from BMAD-METHOD@${COMMIT_SHA}"
|
||||
git push
|
||||
echo "✅ Bundles published to GitHub Pages"
|
||||
fi
|
||||
|
||||
- name: Summary
|
||||
run: |
|
||||
echo "## 🎉 Bundles Published!" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Latest bundles** available at:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- 🌐 Browse: https://bmad-code-org.github.io/bmad-bundles/" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- 📦 Raw files: https://github.com/bmad-code-org/bmad-bundles" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Commit**: ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY
|
||||
230
.github/workflows/discord.yaml
vendored
230
.github/workflows/discord.yaml
vendored
@@ -2,19 +2,9 @@ name: Discord Notification
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, closed, reopened, ready_for_review]
|
||||
release:
|
||||
types: [published]
|
||||
create:
|
||||
delete:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request_review:
|
||||
types: [submitted]
|
||||
pull_request_review_comment:
|
||||
types: [created]
|
||||
types: [opened, closed]
|
||||
issues:
|
||||
types: [opened, closed, reopened]
|
||||
types: [opened]
|
||||
|
||||
env:
|
||||
MAX_TITLE: 100
|
||||
@@ -47,9 +37,7 @@ jobs:
|
||||
|
||||
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
|
||||
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
|
||||
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"
|
||||
elif [ "$ACTION" = "reopened" ]; then ICON="🔄"; LABEL="Reopened"
|
||||
else ICON="📋"; LABEL="Ready"; fi
|
||||
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"; fi
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
@@ -77,22 +65,16 @@ jobs:
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
ACTION: ${{ github.event.action }}
|
||||
ISSUE_NUM: ${{ github.event.issue.number }}
|
||||
ISSUE_URL: ${{ github.event.issue.html_url }}
|
||||
ISSUE_TITLE: ${{ github.event.issue.title }}
|
||||
ISSUE_USER: ${{ github.event.issue.user.login }}
|
||||
ISSUE_BODY: ${{ github.event.issue.body }}
|
||||
ACTOR: ${{ github.actor }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
if [ "$ACTION" = "opened" ]; then ICON="🐛"; LABEL="New Issue"; USER="$ISSUE_USER"
|
||||
elif [ "$ACTION" = "closed" ]; then ICON="✅"; LABEL="Closed"; USER="$ACTOR"
|
||||
else ICON="🔄"; LABEL="Reopened"; USER="$ACTOR"; fi
|
||||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
||||
@@ -102,209 +84,7 @@ jobs:
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
USER=$(printf '%s' "$USER" | esc)
|
||||
USER=$(printf '%s' "$ISSUE_USER" | esc)
|
||||
|
||||
MSG="$ICON **[$LABEL #$ISSUE_NUM: $TITLE](<$ISSUE_URL>)**"$'\n'"by @$USER$BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
issue_comment:
|
||||
if: github.event_name == 'issue_comment'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
sparse-checkout: .github/scripts
|
||||
sparse-checkout-cone-mode: false
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
IS_PR: ${{ github.event.issue.pull_request && 'true' || 'false' }}
|
||||
ISSUE_NUM: ${{ github.event.issue.number }}
|
||||
ISSUE_TITLE: ${{ github.event.issue.title }}
|
||||
COMMENT_URL: ${{ github.event.comment.html_url }}
|
||||
COMMENT_USER: ${{ github.event.comment.user.login }}
|
||||
COMMENT_BODY: ${{ github.event.comment.body }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
[ "$IS_PR" = "true" ] && TYPE="PR" || TYPE="Issue"
|
||||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
||||
|
||||
MSG="💬 **[Comment on $TYPE #$ISSUE_NUM: $TITLE](<$COMMENT_URL>)**"$'\n'"@$USER: $BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
pull_request_review:
|
||||
if: github.event_name == 'pull_request_review'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
sparse-checkout: .github/scripts
|
||||
sparse-checkout-cone-mode: false
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
STATE: ${{ github.event.review.state }}
|
||||
PR_NUM: ${{ github.event.pull_request.number }}
|
||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||
REVIEW_URL: ${{ github.event.review.html_url }}
|
||||
REVIEW_USER: ${{ github.event.review.user.login }}
|
||||
REVIEW_BODY: ${{ github.event.review.body }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
if [ "$STATE" = "approved" ]; then ICON="✅"; LABEL="Approved"
|
||||
elif [ "$STATE" = "changes_requested" ]; then ICON="🔧"; LABEL="Changes Requested"
|
||||
else ICON="👀"; LABEL="Reviewed"; fi
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$REVIEW_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=": $BODY"
|
||||
USER=$(printf '%s' "$REVIEW_USER" | esc)
|
||||
|
||||
MSG="$ICON **[$LABEL PR #$PR_NUM: $TITLE](<$REVIEW_URL>)**"$'\n'"@$USER$BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
pull_request_review_comment:
|
||||
if: github.event_name == 'pull_request_review_comment'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
sparse-checkout: .github/scripts
|
||||
sparse-checkout-cone-mode: false
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
PR_NUM: ${{ github.event.pull_request.number }}
|
||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||
COMMENT_URL: ${{ github.event.comment.html_url }}
|
||||
COMMENT_USER: ${{ github.event.comment.user.login }}
|
||||
COMMENT_BODY: ${{ github.event.comment.body }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
||||
|
||||
MSG="💭 **[Review Comment PR #$PR_NUM: $TITLE](<$COMMENT_URL>)**"$'\n'"@$USER: $BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
release:
|
||||
if: github.event_name == 'release'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
sparse-checkout: .github/scripts
|
||||
sparse-checkout-cone-mode: false
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
TAG: ${{ github.event.release.tag_name }}
|
||||
NAME: ${{ github.event.release.name }}
|
||||
URL: ${{ github.event.release.html_url }}
|
||||
RELEASE_BODY: ${{ github.event.release.body }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
REL_NAME=$(printf '%s' "$NAME" | trunc $MAX_TITLE | esc)
|
||||
[ ${#NAME} -gt $MAX_TITLE ] && REL_NAME="${REL_NAME}..."
|
||||
BODY=$(printf '%s' "$RELEASE_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
TAG_ESC=$(printf '%s' "$TAG" | esc)
|
||||
|
||||
MSG="🚀 **[Release $TAG_ESC: $REL_NAME](<$URL>)**"$'\n'"$BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
create:
|
||||
if: github.event_name == 'create'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
sparse-checkout: .github/scripts
|
||||
sparse-checkout-cone-mode: false
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
REF_TYPE: ${{ github.event.ref_type }}
|
||||
REF: ${{ github.event.ref }}
|
||||
ACTOR: ${{ github.actor }}
|
||||
REPO_URL: ${{ github.event.repository.html_url }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
[ "$REF_TYPE" = "branch" ] && ICON="🌿" || ICON="🏷️"
|
||||
REF_TRUNC=$(printf '%s' "$REF" | trunc $MAX_TITLE)
|
||||
[ ${#REF} -gt $MAX_TITLE ] && REF_TRUNC="${REF_TRUNC}..."
|
||||
REF_ESC=$(printf '%s' "$REF_TRUNC" | esc)
|
||||
REF_URL=$(jq -rn --arg ref "$REF" '$ref | @uri')
|
||||
ACTOR_ESC=$(printf '%s' "$ACTOR" | esc)
|
||||
MSG="$ICON **${REF_TYPE^} created: [$REF_ESC](<$REPO_URL/tree/$REF_URL>)** by @$ACTOR_ESC"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
delete:
|
||||
if: github.event_name == 'delete'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Notify Discord
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
REF_TYPE: ${{ github.event.ref_type }}
|
||||
REF: ${{ github.event.ref }}
|
||||
ACTOR: ${{ github.actor }}
|
||||
run: |
|
||||
set -o pipefail
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
esc() { sed -e 's/[][\*_()~`]/\\&/g' -e 's/@/@ /g'; }
|
||||
trunc() { tr '\n\r' ' ' | cut -c1-"$1"; }
|
||||
|
||||
REF_TRUNC=$(printf '%s' "$REF" | trunc 100)
|
||||
[ ${#REF} -gt 100 ] && REF_TRUNC="${REF_TRUNC}..."
|
||||
REF_ESC=$(printf '%s' "$REF_TRUNC" | esc)
|
||||
ACTOR_ESC=$(printf '%s' "$ACTOR" | esc)
|
||||
MSG="🗑️ **${REF_TYPE^} deleted: $REF_ESC** by @$ACTOR_ESC"
|
||||
MSG="🐛 **[Issue #$ISSUE_NUM: $TITLE](<$ISSUE_URL>)**"$'\n'"by @$USER$BODY"
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
|
||||
11
.github/workflows/manual-release.yaml
vendored
11
.github/workflows/manual-release.yaml
vendored
@@ -6,11 +6,11 @@ on:
|
||||
version_bump:
|
||||
description: Version bump type
|
||||
required: true
|
||||
default: alpha
|
||||
default: beta
|
||||
type: choice
|
||||
options:
|
||||
- alpha
|
||||
- beta
|
||||
- alpha
|
||||
- patch
|
||||
- minor
|
||||
- major
|
||||
@@ -158,9 +158,12 @@ jobs:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.new_version }}"
|
||||
if [[ "$VERSION" == *"alpha"* ]] || [[ "$VERSION" == *"beta"* ]]; then
|
||||
echo "Publishing prerelease version with --tag alpha"
|
||||
if [[ "$VERSION" == *"alpha"* ]]; then
|
||||
echo "Publishing alpha prerelease version with --tag alpha"
|
||||
npm publish --tag alpha
|
||||
elif [[ "$VERSION" == *"beta"* ]]; then
|
||||
echo "Publishing beta prerelease version with --tag latest"
|
||||
npm publish --tag latest
|
||||
else
|
||||
echo "Publishing stable version with --tag latest"
|
||||
npm publish --tag latest
|
||||
|
||||
21
.github/workflows/quality.yaml
vendored
21
.github/workflows/quality.yaml
vendored
@@ -69,6 +69,27 @@ jobs:
|
||||
- name: markdownlint
|
||||
run: npm run lint:md
|
||||
|
||||
docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ".nvmrc"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Validate documentation links
|
||||
run: npm run docs:validate-links
|
||||
|
||||
- name: Build documentation
|
||||
run: npm run docs:build
|
||||
|
||||
validate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
43
.gitignore
vendored
43
.gitignore
vendored
@@ -1,12 +1,11 @@
|
||||
# Dependencies
|
||||
node_modules/
|
||||
**/node_modules/
|
||||
pnpm-lock.yaml
|
||||
bun.lock
|
||||
deno.lock
|
||||
pnpm-workspace.yaml
|
||||
package-lock.json
|
||||
|
||||
|
||||
test-output/*
|
||||
coverage/
|
||||
|
||||
@@ -28,11 +27,6 @@ Thumbs.db
|
||||
# Development tools and configs
|
||||
.prettierrc
|
||||
|
||||
# IDE and editor configs
|
||||
.windsurf/
|
||||
.trae/
|
||||
_bmad*/.cursor/
|
||||
|
||||
# AI assistant files
|
||||
CLAUDE.md
|
||||
.ai/*
|
||||
@@ -43,37 +37,30 @@ CLAUDE.local.md
|
||||
.serena/
|
||||
.claude/settings.local.json
|
||||
|
||||
# Project-specific
|
||||
_bmad-core
|
||||
_bmad-creator-tools
|
||||
flattened-codebase.xml
|
||||
*.stats.md
|
||||
.internal-docs/
|
||||
#UAT template testing output files
|
||||
tools/template-test-generator/test-scenarios/
|
||||
|
||||
# Bundler temporary files and generated bundles
|
||||
.bundler-temp/
|
||||
|
||||
# Generated web bundles (built by CI, not committed)
|
||||
src/modules/bmm/sub-modules/
|
||||
src/modules/bmb/sub-modules/
|
||||
src/modules/cis/sub-modules/
|
||||
src/modules/bmgd/sub-modules/
|
||||
shared-modules
|
||||
z*/
|
||||
|
||||
_bmad
|
||||
_bmad-output
|
||||
.clinerules
|
||||
.augment
|
||||
.crush
|
||||
.cursor
|
||||
.iflow
|
||||
.opencode
|
||||
.qwen
|
||||
.rovodev
|
||||
.kilocodemodes
|
||||
.claude
|
||||
.codex
|
||||
.github/chatmodes
|
||||
.github/agents
|
||||
.agent
|
||||
.agentvibes/
|
||||
.kiro/
|
||||
.agentvibes
|
||||
.kiro
|
||||
.roo
|
||||
.trae
|
||||
.windsurf
|
||||
|
||||
bmad-custom-src/
|
||||
|
||||
# Astro / Documentation Build
|
||||
website/.astro/
|
||||
|
||||
@@ -5,3 +5,16 @@ npx --no-install lint-staged
|
||||
|
||||
# Validate everything
|
||||
npm test
|
||||
|
||||
# Validate docs links only when docs change
|
||||
if command -v rg >/dev/null 2>&1; then
|
||||
if git diff --cached --name-only | rg -q '^docs/'; then
|
||||
npm run docs:validate-links
|
||||
npm run docs:build
|
||||
fi
|
||||
else
|
||||
if git diff --cached --name-only | grep -Eq '^docs/'; then
|
||||
npm run docs:validate-links
|
||||
npm run docs:build
|
||||
fi
|
||||
fi
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
# https://github.com/DavidAnson/markdownlint-cli2
|
||||
|
||||
ignores:
|
||||
- node_modules/**
|
||||
- "**/node_modules/**"
|
||||
- test/fixtures/**
|
||||
- CODE_OF_CONDUCT.md
|
||||
- _bmad/**
|
||||
@@ -11,7 +11,6 @@ ignores:
|
||||
- .claude/**
|
||||
- .roo/**
|
||||
- .codex/**
|
||||
- .agentvibes/**
|
||||
- .kiro/**
|
||||
- sample-project/**
|
||||
- test-project-install/**
|
||||
|
||||
247
CHANGELOG.md
247
CHANGELOG.md
@@ -1,5 +1,252 @@
|
||||
# Changelog
|
||||
|
||||
## [6.0.0-Beta.2]
|
||||
|
||||
- Fix installer so commands match what is installed, centralize most ide into a central file instead of separate files for each ide.
|
||||
- Specific IDEs may still need udpates, but all is config driven now and should be easier to maintain
|
||||
- Kiro still needs updates, but its been in this state since contributed, will investigate soon
|
||||
- Any version older than Beta.0 will recommend removal and reinstall to project. From later alphas though its sufficient to quick update if still desired, but best is just start fresh with Beta.
|
||||
|
||||
## [6.0.0-Beta.1]
|
||||
|
||||
**Release: January 2026 - Alpha to Beta Transition**
|
||||
|
||||
### 🎉 Beta Release
|
||||
|
||||
- **Transition from Alpha to Beta**: BMad Method is now in Beta! This marks a significant milestone in the framework's development
|
||||
- **NPM Default Tag**: Beta versions are now published with the `latest` tag, making `npx bmad-method` serve the beta version by default
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **bmad-help**: Revolutionary AI-powered guidance system replaces the alpha workflow-init and workflow tracking — introduces full AI intelligence to guide users through workflows, commands, and project context
|
||||
2. **Module Ecosystem Expansion**: bmad-builder, CIS (Creative Intelligence Suite), and Game Dev Studio moved to separate repositories for focused development
|
||||
3. **Installer Consolidation**: Unified installer architecture with standardized command naming (`bmad-dash-case.md` or `bmad-*-agent-*.md`)
|
||||
4. **Windows Compatibility**: Complete migration from Inquirer.js to @clack/prompts for reliable cross-platform support
|
||||
|
||||
### 🚀 Major Features
|
||||
|
||||
**bmad-help - Intelligent Guidance System:**
|
||||
|
||||
- **Replaces**: workflow-init and legacy workflow tracking
|
||||
- **AI-Powered**: Full context awareness of installed modules, workflows, agents, and commands
|
||||
- **Dynamic Discovery**: Automatically catalogs all available workflows from installed modules
|
||||
- **Intelligent Routing**: Guides users to the right workflow or agent based on their goal
|
||||
- **IDE Integration**: Generates proper IDE command files for all discovered workflows
|
||||
|
||||
**Module Restructuring:**
|
||||
|
||||
| Module | Status | New Location |
|
||||
| ------------------------------------- | ------------------------------------------------- | ------------------------------------------------------- |
|
||||
| **bmad-builder** | Near beta, with docs and walkthroughs coming soon | `bmad-code-org/bmad-builder` |
|
||||
| **CIS** (Creative Intelligence Suite) | Published as npm package | `bmad-code-org/bmad-module-creative-intelligence-suite` |
|
||||
| **Game Dev Studio** | Published as npm package | `bmad-code-org/bmad-module-game-dev-studio` |
|
||||
|
||||
### 🔧 Installer & CLI Improvements
|
||||
|
||||
**UnifiedInstaller Architecture:**
|
||||
|
||||
- All IDE installers now use a common `UnifiedInstaller` class
|
||||
- Standardized command naming conventions:
|
||||
- Workflows: `bmad-module-workflow-name.md`
|
||||
- Agents: `bmad-module-agent-name.md`
|
||||
- Tasks: `bmad-task-name.md`
|
||||
- Tools: `bmad-tool-name.md`
|
||||
- External module installation from npm with progress indicators
|
||||
- Module removal on unselect with confirmation
|
||||
|
||||
**Windows Compatibility Fix:**
|
||||
|
||||
- Replaced Inquirer.js with @clack/prompts to fix arrow key navigation issues on Windows
|
||||
- All 91 installer workflows migrated to new prompt system
|
||||
|
||||
### 📚 Documentation Updates
|
||||
|
||||
**Significant docsite improvements:**
|
||||
|
||||
- Interactive workflow guide page (`/workflow-guide`) with track selector
|
||||
- TEA documentation restructured using Diátaxis framework (25 docs)
|
||||
- Style guide optimized for LLM readers (367 lines, down from 767)
|
||||
- Glossary rewritten using table format (123 lines, down from 373)
|
||||
- README overhaul with numbered command flows and prominent `/bmad-help` callout
|
||||
- New workflow map diagram with interactive HTML
|
||||
- New editorial review tasks for document quality
|
||||
- E2E testing methodology for Game Dev Studio
|
||||
|
||||
More documentation updates coming soon.
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- Fixed TodoMVC URL references to include `/dist/` path
|
||||
- Fixed glob pattern normalization for Windows compatibility
|
||||
- Fixed YAML indentation in kilo.js customInstructions field
|
||||
- Fixed stale path references in check-implementation-readiness workflow
|
||||
- Fixed sprint-status.yaml sync in correct-course workflow
|
||||
- Fixed web bundler entry point reference
|
||||
- Fixed mergeModuleHelpCatalogs ordering after generateManifests
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **91 commits** since alpha.23
|
||||
- **969 files changed** (+23,716 / -91,509 lines)
|
||||
- **Net reduction of ~67,793 lines** through cleanup and consolidation
|
||||
- **3 major modules** moved to separate repositories
|
||||
- **Complete installer refactor** for standardization
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.23]
|
||||
|
||||
**Release: January 11, 2026**
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **Astro/Starlight Documentation Platform**: Complete migration from Docusaurus to modern Astro+Starlight for superior performance and customization
|
||||
2. **Diataxis Framework Implementation**: Professional documentation restructuring with tutorials, how-to guides, explanations, and references
|
||||
3. **Workflow Creator & Validator**: Powerful new tools for workflow creation with subprocess support and PRD validation
|
||||
4. **TEA Documentation Expansion**: Comprehensive testing documentation with cheat sheets, MCP enhancements, and API testing patterns
|
||||
5. **Brainstorming Revolution**: Research-backed procedural rigor with 100+ idea goal and anti-bias protocols
|
||||
6. **Cursor IDE Modernization**: Refactored from rules-based to command-based architecture for better IDE integration
|
||||
|
||||
### 📚 Documentation Platform Revolution
|
||||
|
||||
**Astro/Starlight Migration:**
|
||||
|
||||
- **From Docusaurus to Astro**: Complete platform migration for improved performance, better customization, and modern tooling
|
||||
- **Starlight Theme**: Professional documentation theme with dark mode default and responsive design
|
||||
- **Build Pipeline Overhaul**: New build-docs.js orchestrates link checking, artifact generation, and Astro build
|
||||
- **LLM-Friendly Documentation**: Generated llms.txt and llms-full.txt for AI agent discoverability
|
||||
- **Downloadable Source Bundles**: bmad-sources.zip and bmad-prompts.zip for offline use
|
||||
|
||||
**Diataxis Framework Implementation:**
|
||||
|
||||
- **Four Content Types**: Professional separation into tutorials, how-to guides, explanations, and references
|
||||
- **21 Files Migrated**: Phase 1 migration of core documentation to Diataxis structure
|
||||
- **42+ Focused Documents**: Phase 2 split of large legacy files into manageable pieces
|
||||
- **FAQ Restructuring**: 7 topic-specific FAQ files with standardized format
|
||||
- **Tutorial Style Guide**: Comprehensive documentation standards for consistent content creation
|
||||
|
||||
**Link Management & Quality:**
|
||||
|
||||
- **Site-Relative Links**: Converted 217 links to repo-relative format (/docs/path/file.md)
|
||||
- **Link Validation Tools**: New validate-doc-links.js and fix-doc-links.js for maintaining link integrity
|
||||
- **Broken Link Fixes**: Resolved ~50 broken internal links across documentation
|
||||
- **BMad Acronym Standardization**: Consistent use of "BMad" (Breakthrough Method of Agile AI Driven Development)
|
||||
- **SEO Optimization**: Absolute URLs in AI meta tags for better web crawler discoverability
|
||||
|
||||
### 🔧 Workflow Creator & Validator (Major Feature)
|
||||
|
||||
**Workflow Creation Tool:**
|
||||
|
||||
- **Subprocess Support**: Advanced workflows can now spawn subprocesses for complex operations
|
||||
- **PRD Validation Step**: New validation step ensures PRD quality before workflow execution
|
||||
- **Trimodal Workflow Creation**: Three-mode workflow generation system
|
||||
- **Quadrivariate Module Workflow**: Four-variable workflow architecture for enhanced flexibility
|
||||
- **Path Violation Checks**: Validator ensures workflows don't violate path constraints
|
||||
- **Max Parallel Mode POC**: Proof-of-concept for parallel workflow validation
|
||||
|
||||
**Workflow Quality Improvements:**
|
||||
|
||||
- **PRD Trimodal Compliance**: PRD workflow now follows trimodal standards
|
||||
- **Standardized Step Formatting**: Consistent markdown formatting across workflow and PRD steps
|
||||
- **Better Suggested Next Steps**: Improved workflow completion guidance
|
||||
- **Variable Naming Standardization**: {project_root} → {project-root} across all workflows
|
||||
|
||||
### 🧪 TEA Documentation Expansion
|
||||
|
||||
**Comprehensive Testing Guides:**
|
||||
|
||||
- **Cheat Sheets**: Quick reference guides for common testing scenarios
|
||||
- **MCP Enhancements**: Model Context Protocol improvements for testing workflows
|
||||
- **API Testing Patterns**: Best practices for API testing documentation
|
||||
- **Design Philosophy Callout**: Clear explanation of TEA's design principles
|
||||
- **Context Engineering Glossary**: New glossary entry defining context engineering concepts
|
||||
- **Fragment Count Updates**: Accurate documentation of TEA workflow components
|
||||
- **Playwright Utils Examples**: Updated code examples for playwright-utils integration
|
||||
|
||||
### 💡 Brainstorming Workflow Overhaul
|
||||
|
||||
**Research-Backed Procedural Rigor:**
|
||||
|
||||
- **100+ Idea Goal**: Emphasis on quantity-first approach to unlock better quality ideas
|
||||
- **Anti-Bias Protocol**: Domain pivot every 10 ideas to reduce cognitive biases
|
||||
- **Chain-of-Thought Requirements**: Reasoning before idea generation
|
||||
- **Simulated Temperature**: Prompts for higher divergence in ideation
|
||||
- **Standardized Idea Format**: Quality control template for consistent output
|
||||
- **Energy Checkpoints**: Multiple continuation options to maintain creative flow
|
||||
|
||||
**Exploration Menu Improvements:**
|
||||
|
||||
- **Letter-Based Navigation**: [K/T/A/B/C] options instead of numbers for clarity
|
||||
- **Keep/Try/Advanced/Break/Continue**: Clear action options for idea refinement
|
||||
- **Universal Facilitation Rules**: Consistent guidelines across all brainstorming steps
|
||||
- **Quality Growth Enforcement**: Balance between quantity and quality metrics
|
||||
|
||||
### 🖥️ Cursor IDE Modernization
|
||||
|
||||
**Command-Based Architecture:**
|
||||
|
||||
- **From Rules to Commands**: Complete refactor from rules-based to command-based system
|
||||
- **Command Generation**: Automatic generation of task and tool commands
|
||||
- **Commands Directory**: New `.cursor/commands/bmad/` structure for generated commands
|
||||
- **Cleanup Integration**: Automatic cleanup of old BMAD commands alongside rules
|
||||
- **Enhanced Logging**: Better feedback on agents, tasks, tools, and workflow commands generated
|
||||
|
||||
### 🤖 Agent System Improvements
|
||||
|
||||
**Agent Builder & Validation:**
|
||||
|
||||
- **hasSidecar Field**: All agents now indicate sidecar support (true/false)
|
||||
- **Validation Enforcement**: hasSidecar now required in agent validation
|
||||
- **Better Brownfield Documentation**: Improved brownfield project documentation
|
||||
- **Agent Builder Updates**: Agent builder now uses hasSidecar field
|
||||
- **Agent Editor Integration**: Editor workflow respects hasSidecar configuration
|
||||
|
||||
### 🐛 Bug Fixes & Quality Improvements
|
||||
|
||||
**Critical Fixes:**
|
||||
|
||||
- **Windows Line Endings**: Resolved CRLF issues causing cross-platform problems
|
||||
- **Code-Review File Filtering**: Fixed code-review picking up non-application files
|
||||
- **ERR_REQUIRE_ESM Resolution**: Dynamic import for inquirer v9+ compatibility
|
||||
- **Project-Context Conflicts**: Allow full project-context usage with conflict precedence
|
||||
- **Workflow Paths**: Fixed paths for workflow and sprint status files
|
||||
- **Missing Scripts**: Fixed missing scripts from installation
|
||||
|
||||
**Workflow & Variable Fixes:**
|
||||
|
||||
- **Variable Naming**: Standardized from {project_root} to {project-root} across CIS, BMGD, and BMM modules
|
||||
- **Workflow References**: Fixed broken .yaml → .md workflow references
|
||||
- **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming
|
||||
- **Dependency Format**: Corrected dependency format and added missing frontmatter
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- **Dependency Updates**: Bumped qs from 6.14.0 to 6.14.1
|
||||
- **CodeRabbit Integration**: Enabled auto-review on new PRs
|
||||
- **TEA Fragment Counts**: Updated fragment counts for accuracy
|
||||
- **Documentation Links**: Fixed Discord channel references (#general-dev → #bmad-development)
|
||||
|
||||
### 🚀 Installation & CLI Improvements
|
||||
|
||||
**Installation Enhancements:**
|
||||
|
||||
- **Workflow Exclusion**: Ability to exclude workflows from being added as commands
|
||||
- **Example Workflow Protection**: Example workflow in workflow builder now excluded from tools
|
||||
- **CNAME Configuration**: Added CNAME file for custom domain support
|
||||
- **Script Fixes**: All scripts now properly included in installation
|
||||
|
||||
### 📊 Statistics
|
||||
|
||||
- **27 commits** since alpha.22
|
||||
- **217 documentation links** converted to site-relative format
|
||||
- **42+ focused documents** created from large legacy files
|
||||
- **7 topic-specific FAQ files** with standardized formatting
|
||||
- **Complete documentation platform** migrated from Docusaurus to Astro/Starlight
|
||||
- **Major workflow tools** added: Creator, Validator with subprocess support
|
||||
- **Brainstorming workflow** overhauled with research-backed rigor
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.22]
|
||||
|
||||
**Release: December 31, 2025**
|
||||
|
||||
313
CONTRIBUTING.md
313
CONTRIBUTING.md
@@ -1,268 +1,167 @@
|
||||
# Contributing to BMad
|
||||
|
||||
Thank you for considering contributing to the BMad project! We believe in **Human Amplification, Not Replacement** - bringing out the best thinking in both humans and AI through guided collaboration.
|
||||
Thank you for considering contributing! We believe in **Human Amplification, Not Replacement** — bringing out the best thinking in both humans and AI through guided collaboration.
|
||||
|
||||
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
|
||||
💬 **Discord**: [Join our community](https://discord.gg/gk8jAdXWmj) for real-time discussions, questions, and collaboration.
|
||||
|
||||
- **#bmad-development** - Technical discussions and development questions
|
||||
- **#suggestions-feedback** - Feature ideas and suggestions
|
||||
- **#report-bugs-and-issues** - Bug reports and issue discussions
|
||||
---
|
||||
|
||||
## Our Philosophy
|
||||
|
||||
### BMad Core™: Universal Foundation
|
||||
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
|
||||
|
||||
BMad Core empowers humans and AI agents working together in true partnership across any domain through our **C.O.R.E. Framework** (Collaboration Optimized Reflection Engine):
|
||||
|
||||
- **Collaboration**: Human-AI partnership where both contribute unique strengths
|
||||
- **Optimized**: The collaborative process refined for maximum effectiveness
|
||||
- **Reflection**: Guided thinking that helps discover better solutions and insights
|
||||
- **Engine**: The powerful framework that orchestrates specialized agents and workflows
|
||||
|
||||
### BMad Method™: Agile AI-Driven Development
|
||||
|
||||
The BMad Method is the flagship bmad module for agile AI-driven software development. It emphasizes thorough planning and solid architectural foundations to provide detailed context for developer agents, mirroring real-world agile best practices.
|
||||
|
||||
### Core Principles
|
||||
|
||||
**Partnership Over Automation** - AI agents act as expert coaches, mentors, and collaborators who amplify human capability rather than replace it.
|
||||
|
||||
**Bidirectional Guidance** - Agents guide users through structured workflows while users push agents with advanced prompting. Both sides actively work to extract better information from each other.
|
||||
|
||||
**Systems of Workflows** - BMad Core builds comprehensive systems of guided workflows with specialized agent teams for any domain.
|
||||
|
||||
**Tool-Agnostic Foundation** - BMad Core remains tool-agnostic, providing stable, extensible groundwork that adapts to any domain.
|
||||
|
||||
## What Makes a Good Contribution?
|
||||
|
||||
Every contribution should strengthen human-AI collaboration. Ask yourself: **"Does this make humans and AI better together?"**
|
||||
|
||||
**✅ Contributions that align:**
|
||||
|
||||
- Enhance universal collaboration patterns
|
||||
- Improve agent personas and workflows
|
||||
- Strengthen planning and context continuity
|
||||
- Increase cross-domain accessibility
|
||||
- Add domain-specific modules leveraging BMad Core
|
||||
|
||||
**❌ What detracts from our mission:**
|
||||
**✅ What we welcome:**
|
||||
- Enhanced collaboration patterns and workflows
|
||||
- Improved agent personas and prompts
|
||||
- Domain-specific modules leveraging BMad Core
|
||||
- Better planning and context continuity
|
||||
|
||||
**❌ What doesn't fit:**
|
||||
- Purely automated solutions that sideline humans
|
||||
- Tools that don't improve the partnership
|
||||
- Complexity that creates barriers to adoption
|
||||
- Features that fragment BMad Core's foundation
|
||||
|
||||
## Before You Contribute
|
||||
---
|
||||
|
||||
### Reporting Bugs
|
||||
## Reporting Issues
|
||||
|
||||
1. **Check existing issues** first to avoid duplicates
|
||||
2. **Consider discussing in Discord** (#report-bugs-and-issues channel) for quick help
|
||||
3. **Use the bug report template** when creating a new issue - it guides you through providing:
|
||||
- Clear bug description
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Model/IDE/BMad version details
|
||||
- Screenshots or links if applicable
|
||||
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
||||
**ALL bug reports and feature requests MUST go through GitHub Issues.**
|
||||
|
||||
### Suggesting Features or New Modules
|
||||
### Before Creating an Issue
|
||||
|
||||
1. **Discuss first in Discord** (#suggestions-feedback 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
|
||||
4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration
|
||||
1. **Search existing issues** — Use the GitHub issue search to check if your bug or feature has already been reported
|
||||
2. **Search closed issues** — Your issue may have been fixed or addressed previously
|
||||
3. **Check discussions** — Some conversations happen in [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
|
||||
|
||||
### Before Starting Work
|
||||
### Bug Reports
|
||||
|
||||
After searching, if the bug is unreported, use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md) and include:
|
||||
|
||||
- Clear description of the problem
|
||||
- Steps to reproduce
|
||||
- Expected vs actual behavior
|
||||
- Your environment (model, IDE, BMad version)
|
||||
- Screenshots or error messages if applicable
|
||||
|
||||
### Feature Requests
|
||||
|
||||
After searching, use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) and explain:
|
||||
|
||||
- What the feature is
|
||||
- Why it would benefit the BMad community
|
||||
- How it strengthens human-AI collaboration
|
||||
|
||||
**For community modules**, review [TRADEMARK.md](TRADEMARK.md) for proper naming conventions (e.g., "My Module (BMad Community Module)").
|
||||
|
||||
---
|
||||
|
||||
## Before Starting Work
|
||||
|
||||
⚠️ **Required before submitting PRs:**
|
||||
|
||||
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
||||
2. **For features**: Discuss in Discord (#suggestions-feedback) AND create a feature request issue
|
||||
3. **For large changes**: Always open an issue first to discuss alignment
|
||||
| Work Type | Requirement |
|
||||
| ------------- | ---------------------------------------------- |
|
||||
| Bug fix | An open issue (create one if it doesn't exist) |
|
||||
| Feature | An open feature request issue |
|
||||
| Large changes | Discussion via issue first |
|
||||
|
||||
Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes.
|
||||
**Why?** This prevents wasted effort on work that may not align with project direction.
|
||||
|
||||
---
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
### Which Branch?
|
||||
### Target Branch
|
||||
|
||||
**Submit PR's to `main` branch** (critical only):
|
||||
Submit PRs to the `main` branch.
|
||||
|
||||
- 🚨 Critical bug fixes that break basic functionality
|
||||
- 🔒 Security patches
|
||||
- 📚 Fixing dangerously incorrect documentation
|
||||
- 🐛 Bugs preventing installation or basic usage
|
||||
### PR Size
|
||||
|
||||
### PR Size Guidelines
|
||||
- **Ideal**: 200-400 lines of code changes
|
||||
- **Maximum**: 800 lines (excluding generated files)
|
||||
- **One feature/fix per PR**
|
||||
|
||||
- **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
|
||||
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
||||
|
||||
### Breaking Down Large PRs
|
||||
### New to Pull Requests?
|
||||
|
||||
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.
|
||||
|
||||
### Pull Request Process
|
||||
|
||||
#### New to Pull Requests?
|
||||
|
||||
If you're new to GitHub or pull requests, here's a quick guide:
|
||||
|
||||
1. **Fork the repository** - Click the "Fork" button on GitHub to create your own copy
|
||||
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
||||
3. **Create a new branch** - Never work on `main` directly!
|
||||
```bash
|
||||
git checkout -b fix/description
|
||||
# or
|
||||
git checkout -b feature/description
|
||||
```
|
||||
4. **Make your changes** - Edit files, keeping changes small and focused
|
||||
5. **Commit your changes** - Use clear, descriptive commit messages
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "fix: correct typo in README"
|
||||
```
|
||||
6. **Push to your fork** - `git push origin fix/description`
|
||||
7. **Create the Pull Request** - Go to your fork on GitHub and click "Compare & pull request"
|
||||
1. **Fork** the repository
|
||||
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
||||
3. **Create a branch**: `git checkout -b fix/description` or `git checkout -b feature/description`
|
||||
4. **Make changes** — keep them focused
|
||||
5. **Commit**: `git commit -m "fix: correct typo in README"`
|
||||
6. **Push**: `git push origin fix/description`
|
||||
7. **Open PR** from your fork on GitHub
|
||||
|
||||
### 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)
|
||||
Fixes #[issue number]
|
||||
|
||||
## How
|
||||
|
||||
## [2-3 bullets listing HOW you implemented it]
|
||||
|
||||
-
|
||||
- [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)
|
||||
**Keep it under 200 words.**
|
||||
|
||||
### Good vs Bad PR Descriptions
|
||||
### Commit Messages
|
||||
|
||||
❌ **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...
|
||||
|
||||
✅ **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
|
||||
|
||||
Use conventional commits format:
|
||||
Use conventional commits:
|
||||
|
||||
- `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
|
||||
- `refactor:` Code change (no bug/feature)
|
||||
- `test:` Adding tests
|
||||
- `chore:` Build/tools changes
|
||||
|
||||
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
|
||||
|
||||
## What Makes a Good Pull Request?
|
||||
|
||||
✅ **Good PRs:**
|
||||
|
||||
- Change one thing at a time
|
||||
- Have clear, descriptive titles
|
||||
- Explain what and why in the description
|
||||
- Include only the files that need to change
|
||||
- Reference related issue numbers
|
||||
|
||||
❌ **Avoid:**
|
||||
|
||||
- Changing formatting of entire files
|
||||
- Multiple unrelated changes in one PR
|
||||
- Copying your entire project/repo into the PR
|
||||
- Changes without explanation
|
||||
- Working directly on `main` branch
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
1. **Don't reformat entire files** - only change what's necessary
|
||||
2. **Don't include unrelated changes** - stick to one fix/feature per PR
|
||||
3. **Don't paste code in issues** - create a proper PR instead
|
||||
4. **Don't submit your whole project** - contribute specific improvements
|
||||
|
||||
## Prompt & Agent Guidelines
|
||||
|
||||
- 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 bmad modules for domain-specific features
|
||||
- Validate YAML schemas with `npm run validate:schemas` before committing
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating in this project, you agree to abide by our Code of Conduct. We foster a collaborative, respectful environment focused on building better human-AI partnerships.
|
||||
|
||||
## Need Help?
|
||||
|
||||
- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj):
|
||||
- **#bmad-development** - Technical questions and discussions
|
||||
- **#suggestions-feedback** - Feature ideas and suggestions
|
||||
- **#report-bugs-and-issues** - Get help with bugs before filing issues
|
||||
- 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
||||
- 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
||||
- 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
|
||||
Keep messages under 72 characters. Each commit = one logical change.
|
||||
|
||||
---
|
||||
|
||||
**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner. Together, we're building a future where humans and AI work better together.
|
||||
## What Makes a Good PR?
|
||||
|
||||
| ✅ Do | ❌ Don't |
|
||||
| --------------------------- | ---------------------------- |
|
||||
| Change one thing per PR | Mix unrelated changes |
|
||||
| Clear title and description | Vague or missing explanation |
|
||||
| Reference related issues | Reformat entire files |
|
||||
| Small, focused commits | Copy your whole project |
|
||||
| Work on a branch | Work directly on `main` |
|
||||
|
||||
---
|
||||
|
||||
## Prompt & Agent Guidelines
|
||||
|
||||
- Keep dev agents lean — focus on coding context, not documentation
|
||||
- Web/planning agents can be larger with complex tasks
|
||||
- Everything is natural language (markdown) — no code in core framework
|
||||
- Use BMad modules for domain-specific features
|
||||
- Validate YAML schemas: `npm run validate:schemas`
|
||||
|
||||
---
|
||||
|
||||
## Need Help?
|
||||
|
||||
- 💬 **Discord**: [Join the community](https://discord.gg/gk8jAdXWmj)
|
||||
- 🐛 **Bugs**: Use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
||||
- 💡 **Features**: Use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
By participating, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
||||
|
||||
## License
|
||||
|
||||
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
|
||||
By contributing, your contributions are licensed under the same MIT License. See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
||||
|
||||
32
CONTRIBUTORS.md
Normal file
32
CONTRIBUTORS.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Contributors
|
||||
|
||||
BMad Core, BMad Method and BMad and Community BMad Modules are made possible by contributions from our community. We gratefully acknowledge everyone who has helped improve this project.
|
||||
|
||||
## How We Credit Contributors
|
||||
|
||||
- **Git history** — Every contribution is preserved in the project's commit history
|
||||
- **Contributors badge** — See the dynamic contributors list on our [README](README.md)
|
||||
- **GitHub contributors graph** — Visual representation at <https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors>
|
||||
|
||||
## Becoming a Contributor
|
||||
|
||||
Anyone who submits a pull request that is merged becomes a contributor. Contributions include:
|
||||
|
||||
- Bug fixes
|
||||
- New features or workflows
|
||||
- Documentation improvements
|
||||
- Bug reports and issue triaging
|
||||
- Code reviews
|
||||
- Helping others in discussions
|
||||
|
||||
There are no minimum contribution requirements — whether it's a one-character typo fix or a major feature, we value all contributions.
|
||||
|
||||
## Copyright
|
||||
|
||||
The BMad Method project is copyrighted by BMad Code, LLC. Individual contributions are licensed under the same MIT License as the project. Contributors retain authorship credit through Git history and the contributors graph.
|
||||
|
||||
---
|
||||
|
||||
**Thank you to everyone who has helped make BMad Method better!**
|
||||
|
||||
For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
10
LICENSE
10
LICENSE
@@ -2,6 +2,9 @@ MIT License
|
||||
|
||||
Copyright (c) 2025 BMad Code, LLC
|
||||
|
||||
This project incorporates contributions from the open source community.
|
||||
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
@@ -21,6 +24,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
TRADEMARK NOTICE:
|
||||
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
||||
trademarks in this software does not grant any rights to use the trademarks
|
||||
for any other purpose.
|
||||
BMad™, BMad Method™, and BMad Core™ are trademarks of BMad Code, LLC, covering all
|
||||
casings and variations (including BMAD, bmad, BMadMethod, BMAD-METHOD, etc.). The use of
|
||||
these trademarks in this software does not grant any rights to use the trademarks
|
||||
for any other purpose. See [TRADEMARK.md](TRADEMARK.md) for detailed guidelines.
|
||||
|
||||
253
README.md
253
README.md
@@ -1,237 +1,118 @@
|
||||
# BMad Method & BMad Core
|
||||

|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
---
|
||||
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
||||
|
||||
<div align="center">
|
||||
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
||||
|
||||
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
|
||||
## Why BMad?
|
||||
|
||||
The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
|
||||
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
||||
|
||||
**✨ What's New:**
|
||||
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
|
||||
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
|
||||
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
||||
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
||||
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
|
||||
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
|
||||
|
||||
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
||||
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
|
||||
- 🔄 **Unitary Module Support** - Install individual components without full modules
|
||||
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
|
||||
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
|
||||
## Quick Start
|
||||
|
||||
**📚 Learn More:**
|
||||
|
||||
- [**Custom Content Overview**](http://docs.bmad-method.org/explanation/bmad-builder/custom-content-types/) - Discover all supported content types
|
||||
- [**Installation Guide**](http://docs.bmad-method.org/how-to/installation/install-custom-modules/) - Learn to create and install custom content
|
||||
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
||||
|
||||
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
||||
|
||||
Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
|
||||
|
||||
> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
|
||||
|
||||
> **📌 v6 Alpha Status:** Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to [BMadCode YouTube](https://www.youtube.com/@BMadCode).
|
||||
|
||||
## 🎯 Why BMad Method?
|
||||
|
||||
Unlike generic AI coding assistants, BMad Method provides **structured, battle-tested workflows** powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly.
|
||||
|
||||
**✨ Key Benefits:**
|
||||
|
||||
- **Scale-Adaptive Intelligence** - Automatically adjusts planning depth from bug fixes to enterprise systems
|
||||
- **Complete Development Lifecycle** - Analysis → Planning → Architecture → Implementation
|
||||
- **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.)
|
||||
- **Proven Methodologies** - Built on agile best practices with AI amplification
|
||||
- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code
|
||||
|
||||
## 🏗️ The Power of BMad Core
|
||||
|
||||
**BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means:
|
||||
|
||||
- **BMad Core** provides the universal framework for human-AI collaboration
|
||||
- **BMad Method** leverages Core to deliver agile development workflows
|
||||
- **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself
|
||||
|
||||
With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team!
|
||||
|
||||
## 📊 See It In Action
|
||||
|
||||
<p align="center">
|
||||
<img src="./docs/tutorials/getting-started/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<em>Complete BMad Method workflow showing all phases, agents, and decision points</em>
|
||||
</p>
|
||||
|
||||
## 🚀 Get Started in 3 Steps
|
||||
|
||||
### 1. Install BMad Method
|
||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
||||
|
||||
```bash
|
||||
# Install v6 RECOMMENDED
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
```bash
|
||||
# Install v4 Legacy (not recommended if starting fresh)
|
||||
npx bmad-method install
|
||||
# OR
|
||||
npx bmad-method@latest install
|
||||
```
|
||||
|
||||
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
||||
|
||||
### 2. Initialize Your Project
|
||||
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
||||
|
||||
Load any agent in your IDE and run:
|
||||
- `/bmad-help How should I build a web app for for my TShirt Business that can scale to millions?`
|
||||
- `/bmad-help I just finished the architecture, I am not sure what to do next`
|
||||
|
||||
```
|
||||
*workflow-init
|
||||
```
|
||||
And the amazing this is BMad Help evolves depending on what modules you install also!
|
||||
- `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
|
||||
|
||||
This analyzes your project and recommends the right workflow track.
|
||||
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
|
||||
|
||||
### 3. Choose Your Track
|
||||
### Simple Path (Quick Flow)
|
||||
|
||||
BMad Method adapts to your needs with three intelligent tracks:
|
||||
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
|
||||
|
||||
| Track | Use For | Planning | Time to Start |
|
||||
| ----------------- | ------------------------- | ----------------------- | ------------- |
|
||||
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
|
||||
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
|
||||
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
|
||||
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|
||||
2. `/dev-story` — implements each story
|
||||
3. `/code-review` — validates quality
|
||||
|
||||
> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal.
|
||||
### Full Planning Path (BMad Method)
|
||||
|
||||
## 🔄 How It Works: 4-Phase Methodology
|
||||
Products, platforms, complex features — structured planning then build:
|
||||
|
||||
BMad Method guides you through a proven development lifecycle:
|
||||
1. `/product-brief` — define problem, users, and MVP scope
|
||||
2. `/create-prd` — full requirements with personas, metrics, and risks
|
||||
3. `/create-architecture` — technical decisions and system design
|
||||
4. `/create-epics-and-stories` — break work into prioritized stories
|
||||
5. `/sprint-planning` — initialize sprint tracking
|
||||
6. **Repeat per story:** `/create-story` → `/dev-story` → `/code-review`
|
||||
|
||||
1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions
|
||||
2. **📝 Planning** - Create PRDs, tech specs, or game design documents
|
||||
3. **🏗️ Solutioning** - Design architecture, UX, and technical approach
|
||||
4. **⚡ Implementation** - Story-driven development with continuous validation
|
||||
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/).
|
||||
|
||||
Each phase has specialized workflows and agents working together to deliver exceptional results.
|
||||
## Modules
|
||||
|
||||
## 🤖 Meet Your Team
|
||||
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
|
||||
|
||||
**12 Specialized Agents** working in concert:
|
||||
| Module | GitHub | NPM | Purpose |
|
||||
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
||||
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
||||
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
||||
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
||||
|
||||
| Development | Architecture | Product | Leadership |
|
||||
| ----------- | -------------- | ----------- | ------------ |
|
||||
| Developer | Architect | PM | Scrum Master |
|
||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
||||
| | | Tech Writer | |
|
||||
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
|
||||
|
||||
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities.
|
||||
## Documentation
|
||||
|
||||
Each agent brings deep expertise and can be customized to match your team's style.
|
||||
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
||||
|
||||
## 📦 What's Included
|
||||
|
||||
### Official Modules
|
||||
|
||||
- **BMad Method (BMM)** - Complete agile development framework
|
||||
- 12 specialized agents
|
||||
- 34 workflows across 4 phases
|
||||
- Stand Along Quick Spec Flow for a streamlined simple implementation process
|
||||
- [→ Documentation Hub](http://docs.bmad-method.org/explanation/bmm/)
|
||||
|
||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||
- Build anything from simple agents to complex modules
|
||||
- Create domain-specific solutions (legal, medical, finance, education)
|
||||
- [→ Builder Guide](http://docs.bmad-method.org/explanation/bmad-builder/)
|
||||
|
||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||
- Brainstorming, design thinking, storytelling
|
||||
- 5 creative facilitation workflows
|
||||
- [→ Creative Workflows](http://docs.bmad-method.org/explanation/creative-intelligence/)
|
||||
|
||||
### Key Features
|
||||
|
||||
- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles
|
||||
- **🌐 Multi-Language Support** - Separate settings for communication and code output
|
||||
- **📄 Document Sharding** - 90% token savings for large projects
|
||||
- **🔄 Update-Safe** - Your customizations persist through updates
|
||||
- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### Quick Links
|
||||
|
||||
- **[Quick Start Guide](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](http://docs.bmad-method.org/explanation/bmm/)** - All guides and references
|
||||
- **[Agent Customization](http://docs.bmad-method.org/how-to/customization/customize-agents/)** - Personalize your agents
|
||||
- **[All Documentation](http://docs.bmad-method.org/)** - Complete documentation index
|
||||
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
||||
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
||||
|
||||
### For v4 Users
|
||||
|
||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
||||
- **[v4 to v6 Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)**
|
||||
|
||||
## 💬 Community & Support
|
||||
## Community
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
|
||||
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
||||
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
||||
- [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
||||
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
||||
|
||||
## 🛠️ Development
|
||||
## Support BMad
|
||||
|
||||
If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
BMad is free for everyone — and always will be. If you'd like to support development:
|
||||
|
||||
## What's New in v6
|
||||
- ⭐ Please click the star project icon at near the top right of this page
|
||||
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
||||
- 🏢 Corporate sponsorship — DM on Discord
|
||||
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)
|
||||
|
||||
**v6 represents a complete architectural revolution from v4:**
|
||||
## Contributing
|
||||
|
||||
### 🚀 Major Upgrades
|
||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
- **BMad Core Framework** - Modular architecture enabling custom domain solutions
|
||||
- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise
|
||||
- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology
|
||||
- **BMad Builder Module** - Create and share your own AI agent teams
|
||||
- **50+ Workflows** - Up from 20 in v4, covering every development scenario
|
||||
- **19 Specialized Agents** - Enhanced with customizable personalities and expertise
|
||||
- **Update-Safe Customization** - Your configs persist through all updates
|
||||
- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini
|
||||
- **Multi-Language Support** - Separate settings for communication and code
|
||||
- **Document Sharding** - 90% token savings for large projects
|
||||
## License
|
||||
|
||||
### 🔄 For v4 Users
|
||||
|
||||
- **[Comprehensive Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** - Step-by-step migration
|
||||
- **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference
|
||||
- Backwards compatibility where possible
|
||||
- Smooth migration path with installer detection
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License - See [LICENSE](LICENSE) for details.
|
||||
|
||||
**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
|
||||
|
||||
Supported by: <a href="https://m.do.co/c/00f11bd932bb"><img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" height="24" alt="DigitalOcean" style="vertical-align: middle;"></a>
|
||||
MIT License — see [LICENSE](LICENSE) for details.
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD" alt="Contributors">
|
||||
</a>
|
||||
</p>
|
||||
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
|
||||
|
||||
<p align="center">
|
||||
<sub>Built with ❤️ for the human-AI collaboration community</sub>
|
||||
</p>
|
||||
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
||||
|
||||
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|
||||
|
||||
85
SECURITY.md
Normal file
85
SECURITY.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
We release security patches for the following versions:
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| Latest | :white_check_mark: |
|
||||
| < Latest | :x: |
|
||||
|
||||
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
|
||||
|
||||
### How to Report
|
||||
|
||||
**Do NOT report security vulnerabilities through public GitHub issues.**
|
||||
|
||||
Instead, please report them via one of these methods:
|
||||
|
||||
1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report.
|
||||
|
||||
2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj).
|
||||
|
||||
### What to Include
|
||||
|
||||
Please include as much of the following information as possible:
|
||||
|
||||
- Type of vulnerability (e.g., prompt injection, path traversal, etc.)
|
||||
- Full paths of source file(s) related to the vulnerability
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if available)
|
||||
- Impact assessment of the vulnerability
|
||||
|
||||
### Response Timeline
|
||||
|
||||
- **Initial Response**: Within 48 hours of receiving your report
|
||||
- **Status Update**: Within 7 days with our assessment
|
||||
- **Resolution Target**: Critical issues within 30 days; other issues within 90 days
|
||||
|
||||
### What to Expect
|
||||
|
||||
1. We will acknowledge receipt of your report
|
||||
2. We will investigate and validate the vulnerability
|
||||
3. We will work on a fix and coordinate disclosure timing with you
|
||||
4. We will credit you in the security advisory (unless you prefer to remain anonymous)
|
||||
|
||||
## Security Scope
|
||||
|
||||
### In Scope
|
||||
|
||||
- Vulnerabilities in BMad Method core framework code
|
||||
- Security issues in agent definitions or workflows that could lead to unintended behavior
|
||||
- Path traversal or file system access issues
|
||||
- Prompt injection vulnerabilities that bypass intended agent behavior
|
||||
- Supply chain vulnerabilities in dependencies
|
||||
|
||||
### Out of Scope
|
||||
|
||||
- Security issues in user-created custom agents or modules
|
||||
- Vulnerabilities in third-party AI providers (Claude, GPT, etc.)
|
||||
- Issues that require physical access to a user's machine
|
||||
- Social engineering attacks
|
||||
- Denial of service attacks that don't exploit a specific vulnerability
|
||||
|
||||
## Security Best Practices for Users
|
||||
|
||||
When using BMad Method:
|
||||
|
||||
1. **Review Agent Outputs**: Always review AI-generated code before executing it
|
||||
2. **Limit File Access**: Configure your AI IDE to limit file system access where possible
|
||||
3. **Keep Updated**: Regularly update to the latest version
|
||||
4. **Validate Dependencies**: Review any dependencies added by generated code
|
||||
5. **Environment Isolation**: Consider running AI-assisted development in isolated environments
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories.
|
||||
|
||||
---
|
||||
|
||||
Thank you for helping keep BMad Method and our community safe.
|
||||
55
TRADEMARK.md
Normal file
55
TRADEMARK.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Trademark Notice & Guidelines
|
||||
|
||||
## Trademark Ownership
|
||||
|
||||
The following names and logos are trademarks of BMad Code, LLC:
|
||||
|
||||
- **BMad** (word mark, all casings: BMad, bmad, BMAD)
|
||||
- **BMad Method** (word mark, includes BMadMethod, BMAD-METHOD, and all variations)
|
||||
- **BMad Core** (word mark, includes BMadCore, BMAD-CORE, and all variations)
|
||||
- **BMad Code** (word mark)
|
||||
- BMad Method logo and visual branding
|
||||
- The "Build More, Architect Dreams" tagline
|
||||
|
||||
**All casings, stylings, and variations** of the above names (with or without hyphens, spaces, or specific capitalization) are covered by these trademarks.
|
||||
|
||||
These trademarks are protected under trademark law and are **not** licensed under the MIT License. The MIT License applies to the software code only, not to the BMad brand identity.
|
||||
|
||||
## What This Means
|
||||
|
||||
You may:
|
||||
|
||||
- Use the BMad software under the terms of the MIT License
|
||||
- Refer to BMad to accurately describe compatibility or integration (e.g., "Compatible with BMad Method v6")
|
||||
- Link to <https://github.com/bmad-code-org/BMAD-METHOD>
|
||||
- Fork the software and distribute your own version under a different name
|
||||
|
||||
You may **not**:
|
||||
|
||||
- Use "BMad" or any confusingly similar variation as your product name, service name, company name, or domain name
|
||||
- Present your product as officially endorsed, approved, or certified by BMad Code, LLC when it is not, without written consent from an authorized representative of BMad Code, LLC
|
||||
- Use BMad logos or branding in a way that suggests your product is an official or endorsed BMad product
|
||||
- Register domain names, social media handles, or trademarks that incorporate BMad branding
|
||||
|
||||
## Examples
|
||||
|
||||
| Permitted | Not Permitted |
|
||||
| ------------------------------------------------------ | -------------------------------------------- |
|
||||
| "My workflow tool, compatible with BMad Method" | "BMadFlow" or "BMad Studio" |
|
||||
| "An alternative implementation inspired by BMad" | "BMad Pro" or "BMad Enterprise" |
|
||||
| "My Awesome Healthcare Module (Bmad Community Module)" | "The Official BMad Core Healthcare Module" |
|
||||
| Accurately stating you use BMad as a dependency | Implying official endorsement or partnership |
|
||||
|
||||
## Commercial Use
|
||||
|
||||
You may sell products that incorporate or work with BMad software. However:
|
||||
|
||||
- Your product must have its own distinct name and branding
|
||||
- You must not use BMad trademarks in your marketing, domain names, or product identity
|
||||
- You may truthfully describe technical compatibility (e.g., "Works with BMad Method")
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have questions about trademark usage or would like to discuss official partnership or endorsement opportunities, please reach out:
|
||||
|
||||
- **Email**: <contact@bmadcode.com>
|
||||
BIN
Wordmark.png
Normal file
BIN
Wordmark.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
banner-bmad-method.png
Normal file
BIN
banner-bmad-method.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 366 KiB |
@@ -6,4 +6,4 @@ template: splash
|
||||
|
||||
The page you're looking for doesn't exist or has been moved.
|
||||
|
||||
[Return to Home](/)
|
||||
[Return to Home](/docs/index.md)
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: "Workflow Diagram Maintenance"
|
||||
---
|
||||
|
||||
|
||||
## Regenerating SVG from Excalidraw
|
||||
|
||||
When you edit `workflow-method-greenfield.excalidraw`, regenerate the SVG:
|
||||
|
||||
1. Open <https://excalidraw.com/>
|
||||
2. Load the `.excalidraw` file
|
||||
3. Click menu (☰) → Export image → SVG
|
||||
4. **Set "Scale" to 1x** (default is 2x)
|
||||
5. Click "Export"
|
||||
6. Save as `workflow-method-greenfield.svg`
|
||||
7. **Validate the changes** (see below)
|
||||
8. Commit both files together
|
||||
|
||||
**Important:**
|
||||
|
||||
- Always use **1x scale** to maintain consistent dimensions
|
||||
- Automated export tools (`excalidraw-to-svg`) are broken - use manual export only
|
||||
|
||||
## Visual Validation
|
||||
|
||||
After regenerating the SVG, validate that it renders correctly:
|
||||
|
||||
```bash
|
||||
./tools/validate-svg-changes.sh path/to/workflow-method-greenfield.svg
|
||||
```
|
||||
|
||||
This script:
|
||||
|
||||
- Checks for required dependencies (Playwright, ImageMagick)
|
||||
- Installs Playwright locally if needed (no package.json pollution)
|
||||
- Renders old vs new SVG using browser-accurate rendering
|
||||
- Compares pixel-by-pixel and generates a diff image
|
||||
- Outputs a prompt for AI visual analysis (paste into Gemini/Claude)
|
||||
|
||||
**Threshold**: <0.01% difference is acceptable (anti-aliasing variations)
|
||||
@@ -1,67 +1,28 @@
|
||||
# Documentation Style Guide
|
||||
---
|
||||
title: "Documentation Style Guide"
|
||||
---
|
||||
|
||||
Internal guidelines for maintaining consistent, high-quality documentation across the BMAD Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
|
||||
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
|
||||
|
||||
## Quick Principles
|
||||
## Project-Specific Rules
|
||||
|
||||
1. **Clarity over brevity** — Be concise, but never at the cost of understanding
|
||||
2. **Consistent structure** — Follow established patterns so readers know what to expect
|
||||
3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully
|
||||
4. **Scannable content** — Headers, lists, and callouts help readers find what they need
|
||||
| Rule | Specification |
|
||||
| -------------------------------- | ---------------------------------------- |
|
||||
| No horizontal rules (`---`) | Fragments reading flow |
|
||||
| No `####` headers | Use bold text or admonitions instead |
|
||||
| No "Related" or "Next:" sections | Sidebar handles navigation |
|
||||
| No deeply nested lists | Break into sections instead |
|
||||
| No code blocks for non-code | Use admonitions for dialogue examples |
|
||||
| No bold paragraphs for callouts | Use admonitions instead |
|
||||
| 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
|
||||
| Table cells / list items | 1-2 sentences max |
|
||||
| Header budget | 8-12 `##` per doc; 2-3 `###` per section |
|
||||
|
||||
## Tutorial Structure
|
||||
|
||||
Every tutorial should follow this structure:
|
||||
|
||||
```
|
||||
1. Title + Hook (1-2 sentences describing the outcome)
|
||||
2. Version/Module Notice (info or warning admonition as appropriate)
|
||||
3. What You'll Learn (bullet list of outcomes)
|
||||
4. Prerequisites (info admonition)
|
||||
5. Quick Path (tip admonition - TL;DR summary)
|
||||
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
||||
7. Installation (if applicable)
|
||||
8. Step 1: [First Major Task]
|
||||
9. Step 2: [Second Major Task]
|
||||
10. Step 3: [Third Major Task]
|
||||
11. What You've Accomplished (summary + folder structure if applicable)
|
||||
12. Quick Reference (commands table)
|
||||
13. Common Questions (FAQ format)
|
||||
14. Getting Help (community links)
|
||||
15. Key Takeaways (tip admonition - memorable points)
|
||||
```
|
||||
|
||||
Not all sections are required for every tutorial, but this is the standard flow.
|
||||
|
||||
## Visual Hierarchy
|
||||
|
||||
### Avoid
|
||||
|
||||
| Pattern | Problem |
|
||||
|---------|---------|
|
||||
| `---` horizontal rules | Fragment the reading flow |
|
||||
| `####` deep headers | Create visual noise |
|
||||
| **Important:** bold paragraphs | Blend into body text |
|
||||
| Deeply nested lists | Hard to scan |
|
||||
| Code blocks for non-code | Confusing semantics |
|
||||
|
||||
### Use Instead
|
||||
|
||||
| Pattern | When to Use |
|
||||
|---------|-------------|
|
||||
| White space + section headers | Natural content separation |
|
||||
| Bold text within paragraphs | Inline emphasis |
|
||||
| Admonitions | Callouts that need attention |
|
||||
| Tables | Structured comparisons |
|
||||
| Flat lists | Scannable options |
|
||||
|
||||
## Admonitions
|
||||
|
||||
Use Starlight admonitions strategically:
|
||||
## Admonitions (Starlight Syntax)
|
||||
|
||||
```md
|
||||
:::tip[Title]
|
||||
Shortcuts, best practices, "pro tips"
|
||||
Shortcuts, best practices
|
||||
:::
|
||||
|
||||
:::note[Title]
|
||||
@@ -69,7 +30,7 @@ Context, definitions, examples, prerequisites
|
||||
:::
|
||||
|
||||
:::caution[Title]
|
||||
Caveats, potential issues, things to watch out for
|
||||
Caveats, potential issues
|
||||
:::
|
||||
|
||||
:::danger[Title]
|
||||
@@ -77,169 +38,40 @@ Critical warnings only — data loss, security issues
|
||||
:::
|
||||
```
|
||||
|
||||
### Standard Admonition Uses
|
||||
### Standard Uses
|
||||
|
||||
| Admonition | Standard Use in Tutorials |
|
||||
|------------|---------------------------|
|
||||
| `:::note[Prerequisites]` | What users need before starting |
|
||||
| `:::tip[Quick Path]` | TL;DR summary at top of tutorial |
|
||||
| `:::caution[Fresh Chats]` | Context limitation reminders |
|
||||
| `:::note[Example]` | Command/response examples |
|
||||
| `:::tip[Check Your Status]` | How to verify progress |
|
||||
| `:::tip[Remember These]` | Key takeaways at end |
|
||||
| Admonition | Use For |
|
||||
| ------------------------ | ----------------------------- |
|
||||
| `:::note[Prerequisites]` | Dependencies before starting |
|
||||
| `:::tip[Quick Path]` | TL;DR summary at document top |
|
||||
| `:::caution[Important]` | Critical caveats |
|
||||
| `:::note[Example]` | Command/response examples |
|
||||
|
||||
### Admonition Guidelines
|
||||
## Standard Table Formats
|
||||
|
||||
- **Always include a title** for tip, info, and warning
|
||||
- **Keep content brief** — 1-3 sentences ideal
|
||||
- **Don't overuse** — More than 3-4 per major section feels noisy
|
||||
- **Don't nest** — Admonitions inside admonitions are hard to read
|
||||
|
||||
## Headers
|
||||
|
||||
### Budget
|
||||
|
||||
- **8-12 `##` sections** for full tutorials following standard structure
|
||||
- **2-3 `###` subsections** per `##` section maximum
|
||||
- **Avoid `####` entirely** — use bold text or admonitions instead
|
||||
|
||||
### Naming
|
||||
|
||||
- Use action verbs for steps: "Install BMad", "Create Your Plan"
|
||||
- Use nouns for reference sections: "Common Questions", "Quick Reference"
|
||||
- Keep headers short and scannable
|
||||
|
||||
## Code Blocks
|
||||
|
||||
### Do
|
||||
**Phases:**
|
||||
|
||||
```md
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
| Phase | Name | What Happens |
|
||||
| ----- | -------- | -------------------------------------------- |
|
||||
| 1 | Analysis | Brainstorm, research *(optional)* |
|
||||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
||||
```
|
||||
|
||||
### Don't
|
||||
|
||||
````md
|
||||
```
|
||||
You: Do something
|
||||
Agent: [Response here]
|
||||
```
|
||||
````
|
||||
|
||||
For command/response examples, use an admonition instead:
|
||||
**Commands:**
|
||||
|
||||
```md
|
||||
:::note[Example]
|
||||
Run `workflow-status` and the agent will tell you the next recommended workflow.
|
||||
:::
|
||||
```
|
||||
|
||||
## Tables
|
||||
|
||||
Use tables for:
|
||||
- Phases and what happens in each
|
||||
- Agent roles and when to use them
|
||||
- Command references
|
||||
- Comparing options
|
||||
- Step sequences with multiple attributes
|
||||
|
||||
Keep tables simple:
|
||||
- 2-4 columns maximum
|
||||
- Short cell content
|
||||
- Left-align text, right-align numbers
|
||||
|
||||
### Standard Tables
|
||||
|
||||
**Phases Table:**
|
||||
```md
|
||||
| Phase | Name | What Happens |
|
||||
|-------|------|--------------|
|
||||
| 1 | Analysis | Brainstorm, research *(optional)* |
|
||||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
||||
```
|
||||
|
||||
**Quick Reference Table:**
|
||||
```md
|
||||
| Command | Agent | Purpose |
|
||||
|---------|-------|---------|
|
||||
| `*workflow-init` | Analyst | Initialize a new project |
|
||||
| `*prd` | PM | Create Product Requirements Document |
|
||||
```
|
||||
|
||||
**Build Cycle Table:**
|
||||
```md
|
||||
| Step | Agent | Workflow | Purpose |
|
||||
|------|-------|----------|---------|
|
||||
| 1 | SM | `create-story` | Create story file from epic |
|
||||
| 2 | DEV | `dev-story` | Implement the story |
|
||||
```
|
||||
|
||||
## Lists
|
||||
|
||||
### Flat Lists (Preferred)
|
||||
|
||||
```md
|
||||
- **Option A** — Description of option A
|
||||
- **Option B** — Description of option B
|
||||
- **Option C** — Description of option C
|
||||
```
|
||||
|
||||
### Numbered Steps
|
||||
|
||||
```md
|
||||
1. Load the **PM agent** in a new chat
|
||||
2. Run the PRD workflow: `*prd`
|
||||
3. Output: `PRD.md`
|
||||
```
|
||||
|
||||
### Avoid Deep Nesting
|
||||
|
||||
```md
|
||||
<!-- Don't do this -->
|
||||
1. First step
|
||||
- Sub-step A
|
||||
- Detail 1
|
||||
- Detail 2
|
||||
- Sub-step B
|
||||
2. Second step
|
||||
```
|
||||
|
||||
Instead, break into separate sections or use an admonition for context.
|
||||
|
||||
## Links
|
||||
|
||||
- Use descriptive link text: `[Tutorial Style Guide](./tutorial-style.md)`
|
||||
- Avoid "click here" or bare URLs
|
||||
- Prefer relative paths within docs
|
||||
|
||||
## Images
|
||||
|
||||
- Always include alt text
|
||||
- Add a caption in italics below: `*Description of the image.*`
|
||||
- Use SVG for diagrams when possible
|
||||
- Store in `./images/` relative to the document
|
||||
|
||||
## FAQ Sections
|
||||
|
||||
Format as bold question followed by answer paragraph:
|
||||
|
||||
```md
|
||||
**Do I always need architecture?**
|
||||
Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
||||
|
||||
**Can I change my plan later?**
|
||||
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
||||
| Command | Agent | Purpose |
|
||||
| ------------ | ------- | ------------------------------------ |
|
||||
| `brainstorm` | Analyst | Brainstorm a new project |
|
||||
| `prd` | PM | Create Product Requirements Document |
|
||||
```
|
||||
|
||||
## Folder Structure Blocks
|
||||
|
||||
Show project structure in "What You've Accomplished":
|
||||
Show in "What You've Accomplished" sections:
|
||||
|
||||
````md
|
||||
Your project now has:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMad configuration
|
||||
@@ -250,60 +82,286 @@ your-project/
|
||||
```
|
||||
````
|
||||
|
||||
## Example: Before and After
|
||||
## Tutorial Structure
|
||||
|
||||
### Before (Noisy)
|
||||
|
||||
```md
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Step 1: Initialize
|
||||
|
||||
#### What happens during init?
|
||||
|
||||
**Important:** You need to describe your project.
|
||||
|
||||
1. Your project goals
|
||||
- What you want to build
|
||||
- Why you're building it
|
||||
2. The complexity
|
||||
- Small, medium, or large
|
||||
|
||||
---
|
||||
```text
|
||||
1. Title + Hook (1-2 sentences describing outcome)
|
||||
2. Version/Module Notice (info or warning admonition) (optional)
|
||||
3. What You'll Learn (bullet list of outcomes)
|
||||
4. Prerequisites (info admonition)
|
||||
5. Quick Path (tip admonition - TL;DR summary)
|
||||
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
||||
7. Installation (optional)
|
||||
8. Step 1: [First Major Task]
|
||||
9. Step 2: [Second Major Task]
|
||||
10. Step 3: [Third Major Task]
|
||||
11. What You've Accomplished (summary + folder structure)
|
||||
12. Quick Reference (commands table)
|
||||
13. Common Questions (FAQ format)
|
||||
14. Getting Help (community links)
|
||||
15. Key Takeaways (tip admonition)
|
||||
```
|
||||
|
||||
### After (Clean)
|
||||
### Tutorial Checklist
|
||||
|
||||
```md
|
||||
## Step 1: Initialize Your Project
|
||||
- [ ] Hook describes outcome in 1-2 sentences
|
||||
- [ ] "What You'll Learn" section present
|
||||
- [ ] Prerequisites in admonition
|
||||
- [ ] Quick Path TL;DR admonition at top
|
||||
- [ ] Tables for phases, commands, agents
|
||||
- [ ] "What You've Accomplished" section present
|
||||
- [ ] Quick Reference table present
|
||||
- [ ] Common Questions section present
|
||||
- [ ] Getting Help section present
|
||||
- [ ] Key Takeaways admonition at end
|
||||
|
||||
Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`.
|
||||
## How-To Structure
|
||||
|
||||
:::note[What Happens]
|
||||
You'll describe your project goals and complexity. The workflow then recommends a planning track.
|
||||
:::
|
||||
```text
|
||||
1. Title + Hook (one sentence: "Use the `X` workflow to...")
|
||||
2. When to Use This (bullet list of scenarios)
|
||||
3. When to Skip This (optional)
|
||||
4. Prerequisites (note admonition)
|
||||
5. Steps (numbered ### subsections)
|
||||
6. What You Get (output/artifacts produced)
|
||||
7. Example (optional)
|
||||
8. Tips (optional)
|
||||
9. Next Steps (optional)
|
||||
```
|
||||
|
||||
## Checklist
|
||||
### How-To Checklist
|
||||
|
||||
Before submitting a tutorial:
|
||||
- [ ] Hook starts with "Use the `X` workflow to..."
|
||||
- [ ] "When to Use This" has 3-5 bullet points
|
||||
- [ ] Prerequisites listed
|
||||
- [ ] Steps are numbered `###` subsections with action verbs
|
||||
- [ ] "What You Get" describes output artifacts
|
||||
|
||||
- [ ] Follows the standard structure
|
||||
- [ ] Has version/module notice if applicable
|
||||
- [ ] Has "What You'll Learn" section
|
||||
- [ ] Has Prerequisites admonition
|
||||
- [ ] Has Quick Path TL;DR admonition
|
||||
- [ ] No horizontal rules (`---`)
|
||||
- [ ] No `####` headers
|
||||
- [ ] Admonitions used for callouts (not bold paragraphs)
|
||||
- [ ] Tables used for structured data (phases, commands, agents)
|
||||
- [ ] Lists are flat (no deep nesting)
|
||||
- [ ] Has "What You've Accomplished" section
|
||||
- [ ] Has Quick Reference table
|
||||
- [ ] Has Common Questions section
|
||||
- [ ] Has Getting Help section
|
||||
- [ ] Has Key Takeaways admonition
|
||||
- [ ] All links use descriptive text
|
||||
- [ ] Images have alt text and captions
|
||||
## Explanation Structure
|
||||
|
||||
### Types
|
||||
|
||||
| Type | Example |
|
||||
| ----------------- | ---------------------------- |
|
||||
| **Index/Landing** | `core-concepts/index.md` |
|
||||
| **Concept** | `what-are-agents.md` |
|
||||
| **Feature** | `quick-flow.md` |
|
||||
| **Philosophy** | `why-solutioning-matters.md` |
|
||||
| **FAQ** | `brownfield-faq.md` |
|
||||
|
||||
### General Template
|
||||
|
||||
```text
|
||||
1. Title + Hook (1-2 sentences)
|
||||
2. Overview/Definition (what it is, why it matters)
|
||||
3. Key Concepts (### subsections)
|
||||
4. Comparison Table (optional)
|
||||
5. When to Use / When Not to Use (optional)
|
||||
6. Diagram (optional - mermaid, 1 per doc max)
|
||||
7. Next Steps (optional)
|
||||
```
|
||||
|
||||
### Index/Landing Pages
|
||||
|
||||
```text
|
||||
1. Title + Hook (one sentence)
|
||||
2. Content Table (links with descriptions)
|
||||
3. Getting Started (numbered list)
|
||||
4. Choose Your Path (optional - decision tree)
|
||||
```
|
||||
|
||||
### Concept Explainers
|
||||
|
||||
```text
|
||||
1. Title + Hook (what it is)
|
||||
2. Types/Categories (### subsections) (optional)
|
||||
3. Key Differences Table
|
||||
4. Components/Parts
|
||||
5. Which Should You Use?
|
||||
6. Creating/Customizing (pointer to how-to guides)
|
||||
```
|
||||
|
||||
### Feature Explainers
|
||||
|
||||
```text
|
||||
1. Title + Hook (what it does)
|
||||
2. Quick Facts (optional - "Perfect for:", "Time to:")
|
||||
3. When to Use / When Not to Use
|
||||
4. How It Works (mermaid diagram optional)
|
||||
5. Key Benefits
|
||||
6. Comparison Table (optional)
|
||||
7. When to Graduate/Upgrade (optional)
|
||||
```
|
||||
|
||||
### Philosophy/Rationale Documents
|
||||
|
||||
```text
|
||||
1. Title + Hook (the principle)
|
||||
2. The Problem
|
||||
3. The Solution
|
||||
4. Key Principles (### subsections)
|
||||
5. Benefits
|
||||
6. When This Applies
|
||||
```
|
||||
|
||||
### Explanation Checklist
|
||||
|
||||
- [ ] Hook states what document explains
|
||||
- [ ] Content in scannable `##` sections
|
||||
- [ ] Comparison tables for 3+ options
|
||||
- [ ] Diagrams have clear labels
|
||||
- [ ] Links to how-to guides for procedural questions
|
||||
- [ ] 2-3 admonitions max per document
|
||||
|
||||
## Reference Structure
|
||||
|
||||
### Types
|
||||
|
||||
| Type | Example |
|
||||
| ----------------- | --------------------- |
|
||||
| **Index/Landing** | `workflows/index.md` |
|
||||
| **Catalog** | `agents/index.md` |
|
||||
| **Deep-Dive** | `document-project.md` |
|
||||
| **Configuration** | `core-tasks.md` |
|
||||
| **Glossary** | `glossary/index.md` |
|
||||
| **Comprehensive** | `bmgd-workflows.md` |
|
||||
|
||||
### Reference Index Pages
|
||||
|
||||
```text
|
||||
1. Title + Hook (one sentence)
|
||||
2. Content Sections (## for each category)
|
||||
- Bullet list with links and descriptions
|
||||
```
|
||||
|
||||
### Catalog Reference
|
||||
|
||||
```text
|
||||
1. Title + Hook
|
||||
2. Items (## for each item)
|
||||
- Brief description (one sentence)
|
||||
- **Commands:** or **Key Info:** as flat list
|
||||
3. Universal/Shared (## section) (optional)
|
||||
```
|
||||
|
||||
### Item Deep-Dive Reference
|
||||
|
||||
```text
|
||||
1. Title + Hook (one sentence purpose)
|
||||
2. Quick Facts (optional note admonition)
|
||||
- Module, Command, Input, Output as list
|
||||
3. Purpose/Overview (## section)
|
||||
4. How to Invoke (code block)
|
||||
5. Key Sections (## for each aspect)
|
||||
- Use ### for sub-options
|
||||
6. Notes/Caveats (tip or caution admonition)
|
||||
```
|
||||
|
||||
### Configuration Reference
|
||||
|
||||
```text
|
||||
1. Title + Hook
|
||||
2. Table of Contents (jump links if 4+ items)
|
||||
3. Items (## for each config/task)
|
||||
- **Bold summary** — one sentence
|
||||
- **Use it when:** bullet list
|
||||
- **How it works:** numbered steps (3-5 max)
|
||||
- **Output:** expected result (optional)
|
||||
```
|
||||
|
||||
### Comprehensive Reference Guide
|
||||
|
||||
```text
|
||||
1. Title + Hook
|
||||
2. Overview (## section)
|
||||
- Diagram or table showing organization
|
||||
3. Major Sections (## for each phase/category)
|
||||
- Items (### for each item)
|
||||
- Standardized fields: Command, Agent, Input, Output, Description
|
||||
4. Next Steps (optional)
|
||||
```
|
||||
|
||||
### Reference Checklist
|
||||
|
||||
- [ ] Hook states what document references
|
||||
- [ ] Structure matches reference type
|
||||
- [ ] Items use consistent structure throughout
|
||||
- [ ] Tables for structured/comparative data
|
||||
- [ ] Links to explanation docs for conceptual depth
|
||||
- [ ] 1-2 admonitions max
|
||||
|
||||
## Glossary Structure
|
||||
|
||||
Starlight generates right-side "On this page" navigation from headers:
|
||||
|
||||
- Categories as `##` headers — appear in right nav
|
||||
- Terms in tables — compact rows, not individual headers
|
||||
- No inline TOC — right sidebar handles navigation
|
||||
|
||||
### Table Format
|
||||
|
||||
```md
|
||||
## Category Name
|
||||
|
||||
| Term | Definition |
|
||||
| ------------ | ---------------------------------------------------------------------------------------- |
|
||||
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
|
||||
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
|
||||
```
|
||||
|
||||
### Definition Rules
|
||||
|
||||
| Do | Don't |
|
||||
| ----------------------------- | ------------------------------------------- |
|
||||
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
|
||||
| Keep to 1-2 sentences | Write multi-paragraph explanations |
|
||||
| Bold term name in cell | Use plain text for terms |
|
||||
|
||||
### Context Markers
|
||||
|
||||
Add italic context at definition start for limited-scope terms:
|
||||
|
||||
- `*Quick Flow only.*`
|
||||
- `*BMad Method/Enterprise.*`
|
||||
- `*Phase N.*`
|
||||
- `*BMGD.*`
|
||||
- `*Brownfield.*`
|
||||
|
||||
### Glossary Checklist
|
||||
|
||||
- [ ] Terms in tables, not individual headers
|
||||
- [ ] Terms alphabetized within categories
|
||||
- [ ] Definitions 1-2 sentences
|
||||
- [ ] Context markers italicized
|
||||
- [ ] Term names bolded in cells
|
||||
- [ ] No "A [term] is..." definitions
|
||||
|
||||
## FAQ Sections
|
||||
|
||||
```md
|
||||
## Questions
|
||||
|
||||
- [Do I always need architecture?](#do-i-always-need-architecture)
|
||||
- [Can I change my plan later?](#can-i-change-my-plan-later)
|
||||
|
||||
### Do I always need architecture?
|
||||
|
||||
Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
||||
|
||||
### Can I change my plan later?
|
||||
|
||||
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
||||
|
||||
**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
|
||||
```
|
||||
|
||||
## Validation Commands
|
||||
|
||||
Before submitting documentation changes:
|
||||
|
||||
```bash
|
||||
npm run docs:fix-links # Preview link format fixes
|
||||
npm run docs:fix-links -- --write # Apply fixes
|
||||
npm run docs:validate-links # Check links exist
|
||||
npm run docs:build # Verify no build errors
|
||||
```
|
||||
|
||||
@@ -2,23 +2,25 @@
|
||||
title: Downloads
|
||||
---
|
||||
|
||||
Download BMAD Method resources for offline use, AI training, or integration.
|
||||
Download BMad Method resources for offline use, AI training, or integration.
|
||||
|
||||
## Source Bundles
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMAD source files |
|
||||
| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only |
|
||||
Download these from the `downloads/` folder on the documentation site.
|
||||
|
||||
| File | Description |
|
||||
| ------------------ | ------------------------------- |
|
||||
| `bmad-sources.zip` | Complete BMad source files |
|
||||
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
||||
|
||||
## LLM-Optimized Files
|
||||
|
||||
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window.
|
||||
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
|
||||
|
||||
| File | Description | Use Case |
|
||||
|------|-------------|----------|
|
||||
| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation |
|
||||
| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading |
|
||||
| File | Description | Use Case |
|
||||
| --------------- | ----------------------------------- | -------------------------- |
|
||||
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
||||
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
||||
|
||||
### Using with LLMs
|
||||
|
||||
@@ -41,12 +43,12 @@ docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt")
|
||||
|
||||
## Installation Options
|
||||
|
||||
### NPM (Recommended)
|
||||
|
||||
```bash
|
||||
npx bmad-method@alpha install
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
[More details](/docs/how-to/install-bmad.md)
|
||||
|
||||
## Version Information
|
||||
|
||||
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
||||
@@ -54,7 +56,7 @@ npx bmad-method@alpha install
|
||||
|
||||
## API Access
|
||||
|
||||
For programmatic access to BMAD documentation:
|
||||
For programmatic access to BMad documentation:
|
||||
|
||||
```bash
|
||||
# Get documentation index
|
||||
@@ -66,7 +68,7 @@ curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to improve BMAD Method? Check out:
|
||||
Want to improve BMad Method? Check out:
|
||||
|
||||
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
|
||||
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||
|
||||
24
docs/explanation/advanced-elicitation.md
Normal file
24
docs/explanation/advanced-elicitation.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Advanced Elicitation"
|
||||
description: Push the LLM to rethink its work using structured reasoning methods
|
||||
---
|
||||
|
||||
Make the LLM reconsider what it just generated. You pick a reasoning method, it applies that method to its own output, you decide whether to keep the improvements.
|
||||
|
||||
Dozens of methods are built in - things like First Principles, Red Team vs Blue Team, Pre-mortem Analysis, Socratic Questioning, and more.
|
||||
|
||||
## When to Use It
|
||||
|
||||
- After a workflow generates content and you want alternatives
|
||||
- When output seems okay but you suspect there's more depth
|
||||
- To stress-test assumptions or find weaknesses
|
||||
- For high-stakes content where rethinking helps
|
||||
|
||||
Workflows offer advanced elicitation at decision points - after the LLM has generated something, you'll be asked if you want to run it.
|
||||
|
||||
## How It Works
|
||||
|
||||
1. LLM suggests 5 relevant methods for your content
|
||||
2. You pick one (or reshuffle for different options)
|
||||
3. Method is applied, improvements shown
|
||||
4. Accept or discard, repeat or continue
|
||||
57
docs/explanation/adversarial-review.md
Normal file
57
docs/explanation/adversarial-review.md
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: "Adversarial Review"
|
||||
description: Forced reasoning technique that prevents lazy "looks good" reviews
|
||||
---
|
||||
|
||||
Force deeper analysis by requiring problems to be found.
|
||||
|
||||
## What is Adversarial Review?
|
||||
|
||||
A review technique where the reviewer *must* find issues. No "looks good" allowed. The reviewer adopts a cynical stance - assume problems exist and find them.
|
||||
|
||||
This isn't about being negative. It's about forcing genuine analysis instead of a cursory glance that rubber-stamps whatever was submitted.
|
||||
|
||||
**The core rule:** You must find issues. Zero findings triggers a halt - re-analyze or explain why.
|
||||
|
||||
## Why It Works
|
||||
|
||||
Normal reviews suffer from confirmation bias. You skim the work, nothing jumps out, you approve it. The "find problems" mandate breaks this pattern:
|
||||
|
||||
- **Forces thoroughness** - Can't approve until you've looked hard enough to find issues
|
||||
- **Catches missing things** - "What's not here?" becomes a natural question
|
||||
- **Improves signal quality** - Findings are specific and actionable, not vague concerns
|
||||
- **Information asymmetry** - Run reviews with fresh context (no access to original reasoning) so you evaluate the artifact, not the intent
|
||||
|
||||
## Where It's Used
|
||||
|
||||
Adversarial review appears throughout BMAD workflows - code review, implementation readiness checks, spec validation, and others. Sometimes it's a required step, sometimes optional (like advanced elicitation or party mode). The pattern adapts to whatever artifact needs scrutiny.
|
||||
|
||||
## Human Filtering Required
|
||||
|
||||
Because the AI is *instructed* to find problems, it will find problems - even when they don't exist. Expect false positives: nitpicks dressed as issues, misunderstandings of intent, or outright hallucinated concerns.
|
||||
|
||||
**You decide what's real.** Review each finding, dismiss the noise, fix what matters.
|
||||
|
||||
## Example
|
||||
|
||||
Instead of:
|
||||
|
||||
> "The authentication implementation looks reasonable. Approved."
|
||||
|
||||
An adversarial review produces:
|
||||
|
||||
> 1. **HIGH** - `login.ts:47` - No rate limiting on failed attempts
|
||||
> 2. **HIGH** - Session token stored in localStorage (XSS vulnerable)
|
||||
> 3. **MEDIUM** - Password validation happens client-side only
|
||||
> 4. **MEDIUM** - No audit logging for failed login attempts
|
||||
> 5. **LOW** - Magic number `3600` should be `SESSION_TIMEOUT_SECONDS`
|
||||
|
||||
The first review might miss a security vulnerability. The second caught four.
|
||||
|
||||
## Iteration and Diminishing Returns
|
||||
|
||||
After addressing findings, consider running it again. A second pass usually catches more. A third isn't always useless either. But each pass takes time, and eventually you hit diminishing returns - just nitpicks and false findings.
|
||||
|
||||
:::tip[Better Reviews]
|
||||
Assume problems exist. Look for what's missing, not just what's wrong.
|
||||
:::
|
||||
@@ -1,340 +0,0 @@
|
||||
---
|
||||
title: "Quick Flow Solo Dev Agent (Barry)"
|
||||
---
|
||||
|
||||
|
||||
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
||||
**Icon:** 🚀
|
||||
**Module:** BMM
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Barry is the elite solo developer who lives and breathes the BMAD Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev.
|
||||
|
||||
### Agent Persona
|
||||
|
||||
**Name:** Barry
|
||||
**Title:** Quick Flow Solo Dev
|
||||
|
||||
**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMAD Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams.
|
||||
|
||||
**Communication Style:** Direct, confident, and implementation-focused. Uses tech slang and gets straight to the point. No fluff, just results. Every response moves the project forward.
|
||||
|
||||
**Core Principles:**
|
||||
|
||||
- Planning and execution are two sides of the same coin
|
||||
- Quick Flow is my religion
|
||||
- Specs are for building, not bureaucracy
|
||||
- Code that ships is better than perfect code that doesn't
|
||||
- Documentation happens alongside development, not after
|
||||
- Ship early, ship often
|
||||
|
||||
---
|
||||
|
||||
## Menu Commands
|
||||
|
||||
Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
|
||||
|
||||
### 1. **create-tech-spec**
|
||||
|
||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
|
||||
- **Description:** Architect a technical spec with implementation-ready stories
|
||||
- **Use when:** You need to transform requirements into a buildable spec
|
||||
|
||||
### 2. **quick-dev**
|
||||
|
||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml`
|
||||
- **Description:** Ship features from spec or direct instructions - no handoffs
|
||||
- **Use when:** You're ready to ship code based on a spec or clear instructions
|
||||
|
||||
### 3. **code-review**
|
||||
|
||||
- **Workflow:** `_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml`
|
||||
- **Description:** Review code for quality, patterns, and acceptance criteria
|
||||
- **Use when:** You need to validate implementation quality
|
||||
|
||||
### 4. **party-mode**
|
||||
|
||||
- **Workflow:** `_bmad/core/workflows/party-mode/workflow.yaml`
|
||||
- **Description:** Bring in other experts when I need specialized backup
|
||||
- **Use when:** You need collaborative problem-solving or specialized expertise
|
||||
|
||||
---
|
||||
|
||||
## When to Use Barry
|
||||
|
||||
### Ideal Scenarios
|
||||
|
||||
1. **Quick Flow Development** - Small to medium features that need rapid delivery
|
||||
2. **Technical Specification Creation** - When you need detailed implementation plans
|
||||
3. **Direct Development** - When requirements are clear and you want to skip extensive planning
|
||||
4. **Code Reviews** - When you need senior-level technical validation
|
||||
5. **Performance-Critical Features** - When optimization and scalability are paramount
|
||||
|
||||
### Project Types
|
||||
|
||||
- **Greenfield Projects** - New features or components
|
||||
- **Brownfield Modifications** - Enhancements to existing codebases
|
||||
- **Bug Fixes** - Complex issues requiring deep technical understanding
|
||||
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
||||
- **Performance Optimizations** - System improvements and scalability work
|
||||
|
||||
---
|
||||
|
||||
## The BMAD Quick Flow Process
|
||||
|
||||
Barry orchestrates a simple, efficient 3-step process:
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[Requirements] --> B[create-tech-spec]
|
||||
B --> C[Tech Spec]
|
||||
C --> D[quick-dev]
|
||||
D --> E[Implementation]
|
||||
E --> F{Code Review?}
|
||||
F -->|Yes| G[code-review]
|
||||
F -->|No| H[Complete]
|
||||
G --> H[Complete]
|
||||
|
||||
style A fill:#e1f5fe
|
||||
style B fill:#f3e5f5
|
||||
style C fill:#e8f5e9
|
||||
style D fill:#fff3e0
|
||||
style E fill:#fce4ec
|
||||
style G fill:#f1f8e9
|
||||
style H fill:#e0f2f1
|
||||
```
|
||||
|
||||
### Step 1: Technical Specification (`create-tech-spec`)
|
||||
|
||||
**Goal:** Transform user requirements into implementation-ready technical specifications
|
||||
|
||||
**Process:**
|
||||
|
||||
1. **Problem Understanding** - Clarify requirements, scope, and constraints
|
||||
2. **Code Investigation** - Analyze existing patterns and dependencies (if applicable)
|
||||
3. **Specification Generation** - Create comprehensive tech spec with:
|
||||
- Problem statement and solution overview
|
||||
- Development context and patterns
|
||||
- Implementation tasks with acceptance criteria
|
||||
- Technical decisions and dependencies
|
||||
4. **Review and Finalize** - Validate spec captures user intent
|
||||
|
||||
**Output:** `tech-spec-{slug}.md` saved to sprint artifacts
|
||||
|
||||
**Best Practices:**
|
||||
|
||||
- Include ALL context a fresh dev agent needs
|
||||
- Be specific about files, patterns, and conventions
|
||||
- Define clear acceptance criteria using Given/When/Then format
|
||||
- Document technical decisions and trade-offs
|
||||
|
||||
### Step 2: Development (`quick-dev`)
|
||||
|
||||
**Goal:** Execute implementation based on tech spec or direct instructions
|
||||
|
||||
**Two Modes:**
|
||||
|
||||
**Mode A: Tech-Spec Driven**
|
||||
|
||||
- Load existing tech spec
|
||||
- Extract tasks, context, and acceptance criteria
|
||||
- Execute all tasks continuously without stopping
|
||||
- Respect project context and existing patterns
|
||||
|
||||
**Mode B: Direct Instructions**
|
||||
|
||||
- Accept direct development commands
|
||||
- Offer optional planning step
|
||||
- Execute with minimal friction
|
||||
|
||||
**Process:**
|
||||
|
||||
1. **Load Project Context** - Understand patterns and conventions
|
||||
2. **Execute Implementation** - Work through all tasks:
|
||||
- Load relevant files and context
|
||||
- Implement following established patterns
|
||||
- Write and run tests
|
||||
- Handle errors appropriately
|
||||
3. **Verify Completion** - Ensure all tasks complete, tests passing, AC satisfied
|
||||
|
||||
### Step 3: Code Review (`code-review`) - Optional
|
||||
|
||||
**Goal:** Senior developer review of implemented code
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Critical production features
|
||||
- Complex architectural changes
|
||||
- Performance-sensitive implementations
|
||||
- Team development scenarios
|
||||
- Learning and knowledge transfer
|
||||
|
||||
**Review Focus:**
|
||||
|
||||
- Code quality and patterns
|
||||
- Acceptance criteria compliance
|
||||
- Performance and scalability
|
||||
- Security considerations
|
||||
- Maintainability and documentation
|
||||
|
||||
---
|
||||
|
||||
## Collaboration with Other Agents
|
||||
|
||||
### Natural Partnerships
|
||||
|
||||
- **Tech Writer** - For documentation and API specs when I need it
|
||||
- **Architect** - For complex system design decisions beyond Quick Flow scope
|
||||
- **Dev** - For implementation pair programming (rarely needed)
|
||||
- **QA** - For test strategy and quality gates on critical features
|
||||
- **UX Designer** - For user experience considerations
|
||||
|
||||
### Party Mode Composition
|
||||
|
||||
In party mode, Barry often acts as:
|
||||
|
||||
- **Solo Tech Lead** - Guiding architectural decisions
|
||||
- **Implementation Expert** - Providing coding insights
|
||||
- **Performance Optimizer** - Ensuring scalable solutions
|
||||
- **Code Review Authority** - Validating technical approaches
|
||||
|
||||
---
|
||||
|
||||
## Tips for Working with Barry
|
||||
|
||||
### For Best Results
|
||||
|
||||
1. **Be Specific** - Provide clear requirements and constraints
|
||||
2. **Share Context** - Include relevant files and patterns
|
||||
3. **Define Success** - Clear acceptance criteria lead to better outcomes
|
||||
4. **Trust the Process** - The 3-step flow is optimized for speed and quality
|
||||
5. **Leverage Expertise** - I'll give you optimization and architectural insights automatically
|
||||
|
||||
### Communication Patterns
|
||||
|
||||
- **Git Commit Style** - "feat: Add user authentication with OAuth 2.0"
|
||||
- **RFC Style** - "Proposing microservice architecture for scalability"
|
||||
- **Direct Questions** - "Actually, have you considered the race condition?"
|
||||
- **Technical Trade-offs** - "We could optimize for speed over memory here"
|
||||
|
||||
### Avoid These Common Mistakes
|
||||
|
||||
1. **Vague Requirements** - Leads to unnecessary back-and-forth
|
||||
2. **Ignoring Patterns** - Causes technical debt and inconsistencies
|
||||
3. **Skipping Code Review** - Missed opportunities for quality improvement
|
||||
4. **Over-planning** - I excel at rapid, pragmatic development
|
||||
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
||||
|
||||
---
|
||||
|
||||
## Example Workflow
|
||||
|
||||
```bash
|
||||
# Start with Barry
|
||||
/bmad:bmm:agents:quick-flow-solo-dev
|
||||
|
||||
# Create a tech spec
|
||||
> create-tech-spec
|
||||
|
||||
# Quick implementation
|
||||
> quick-dev tech-spec-auth.md
|
||||
|
||||
# Optional code review
|
||||
> code-review
|
||||
```
|
||||
|
||||
### Sample Tech Spec Structure
|
||||
|
||||
```markdown
|
||||
# Tech-Spec: User Authentication System
|
||||
|
||||
**Created:** 2025-01-15
|
||||
**Status:** Ready for Development
|
||||
|
||||
## Overview
|
||||
|
||||
### Problem Statement
|
||||
|
||||
Users cannot securely access the application, and we need role-based permissions for enterprise features.
|
||||
|
||||
### Solution
|
||||
|
||||
Implement OAuth 2.0 authentication with JWT tokens and role-based access control (RBAC).
|
||||
|
||||
### Scope (In/Out)
|
||||
|
||||
**In:** Login, logout, password reset, role management
|
||||
**Out:** Social login, SSO, multi-factor authentication (Phase 2)
|
||||
|
||||
## Context for Development
|
||||
|
||||
### Codebase Patterns
|
||||
|
||||
- Use existing auth middleware pattern in `src/middleware/auth.js`
|
||||
- Follow service layer pattern from `src/services/`
|
||||
- JWT secrets managed via environment variables
|
||||
|
||||
### Files to Reference
|
||||
|
||||
- `src/middleware/auth.js` - Authentication middleware
|
||||
- `src/models/User.js` - User data model
|
||||
- `config/database.js` - Database connection
|
||||
|
||||
### Technical Decisions
|
||||
|
||||
- JWT tokens over sessions for API scalability
|
||||
- bcrypt for password hashing
|
||||
- Role-based permissions stored in database
|
||||
|
||||
## Implementation Plan
|
||||
|
||||
### Tasks
|
||||
|
||||
- [ ] Create authentication service
|
||||
- [ ] Implement login/logout endpoints
|
||||
- [ ] Add JWT middleware
|
||||
- [ ] Create role-based permissions
|
||||
- [ ] Write comprehensive tests
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
- [ ] Given valid credentials, when user logs in, then receive JWT token
|
||||
- [ ] Given invalid token, when accessing protected route, then return 401
|
||||
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
|
||||
- **[Agents Guide](../../explanation/core-concepts/agent-roles.md)** - Complete agent reference
|
||||
- **[Four Phases](../../explanation/architecture/four-phases.md)** - Understanding development tracks
|
||||
- **[Workflow Implementation](../../how-to/workflows/run-sprint-planning.md)** - Implementation workflows
|
||||
- **[Party Mode](../../explanation/features/party-mode.md)** - Multi-agent collaboration
|
||||
|
||||
---
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
**Q: When should I use Barry vs other agents?**
|
||||
A: Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
|
||||
|
||||
**Q: Is the code review step mandatory?**
|
||||
A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
|
||||
|
||||
**Q: Can I skip the tech spec step?**
|
||||
A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
|
||||
|
||||
**Q: How does Barry differ from the Dev agent?**
|
||||
A: Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
|
||||
|
||||
**Q: Can Barry handle enterprise-scale projects?**
|
||||
A: For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
|
||||
|
||||
---
|
||||
|
||||
**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "Understanding Agents"
|
||||
description: Understanding BMAD agents and their roles
|
||||
---
|
||||
|
||||
|
||||
Comprehensive guides to BMAD's AI agents - their roles, capabilities, and how to work with them effectively.
|
||||
|
||||
---
|
||||
|
||||
## Agent Guides
|
||||
|
||||
### BMM Agents
|
||||
|
||||
- **[Agent Roles](../core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities
|
||||
- **[Quick Flow Solo Dev (Barry)](./barry-quick-flow.md)** - The dedicated agent for rapid development
|
||||
|
||||
### BMGD Agents
|
||||
|
||||
- **[Game Development Agents](../game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- **[What Are Agents?](../core-concepts/what-are-agents.md)** - Core concept explanation
|
||||
- **[Party Mode](../features/party-mode.md)** - Multi-agent collaboration
|
||||
- **[Customize Agents](../../how-to/customization/customize-agents.md)** - How to customize agent behavior
|
||||
@@ -1,126 +0,0 @@
|
||||
---
|
||||
title: "The Four Phases of BMad Method"
|
||||
description: Understanding the four phases of the BMad Method
|
||||
---
|
||||
|
||||
|
||||
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
|
||||
|
||||
---
|
||||
|
||||
## Phase Overview
|
||||
|
||||
| Phase | Name | Purpose | Required? |
|
||||
|-------|------|---------|-----------|
|
||||
| **Phase 1** | Analysis | Exploration and discovery | Optional |
|
||||
| **Phase 2** | Planning | Requirements definition | Required |
|
||||
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
||||
| **Phase 4** | Implementation | Building the software | Required |
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Analysis (Optional)
|
||||
|
||||
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
||||
|
||||
**Workflows:**
|
||||
- `brainstorm-project` - Solution exploration
|
||||
- `research` - Market/technical/competitive research
|
||||
- `product-brief` - Strategic vision capture
|
||||
|
||||
**When to use:**
|
||||
- Starting new projects
|
||||
- Exploring opportunities
|
||||
- Validating market fit
|
||||
|
||||
**When to skip:**
|
||||
- Clear requirements
|
||||
- Well-defined features
|
||||
- Continuing existing work
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Planning (Required)
|
||||
|
||||
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
||||
|
||||
**Workflows:**
|
||||
- `prd` - Product Requirements Document (BMad Method/Enterprise)
|
||||
- `tech-spec` - Technical specification (Quick Flow)
|
||||
- `create-ux-design` - Optional UX specification
|
||||
|
||||
**Key principle:**
|
||||
Define **what** to build and **why**. Leave **how** to Phase 3.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Solutioning (Track-Dependent)
|
||||
|
||||
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
||||
|
||||
**Workflows:**
|
||||
- `architecture` - System design with ADRs
|
||||
- `create-epics-and-stories` - Work breakdown (after architecture)
|
||||
- `implementation-readiness` - Gate check
|
||||
|
||||
**Required for:**
|
||||
- BMad Method (complex projects)
|
||||
- Enterprise Method
|
||||
|
||||
**Skip for:**
|
||||
- Quick Flow (simple changes)
|
||||
|
||||
**Key principle:**
|
||||
Make technical decisions explicit so all agents implement consistently.
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Implementation (Required)
|
||||
|
||||
Iterative sprint-based development with story-centric workflow.
|
||||
|
||||
**Workflows:**
|
||||
- `sprint-planning` - Initialize tracking
|
||||
- `create-story` - Prepare stories
|
||||
- `dev-story` - Implement with tests
|
||||
- `code-review` - Quality assurance
|
||||
- `retrospective` - Continuous improvement
|
||||
|
||||
**Key principle:**
|
||||
One story at a time, complete each story's full lifecycle before starting the next.
|
||||
|
||||
---
|
||||
|
||||
## Phase Flow by Track
|
||||
|
||||
### Quick Flow
|
||||
|
||||
```
|
||||
Phase 2 (tech-spec) → Phase 4 (implement)
|
||||
```
|
||||
|
||||
Skip Phases 1 and 3 for simple changes.
|
||||
|
||||
### BMad Method
|
||||
|
||||
```
|
||||
Phase 1 (optional) → Phase 2 (PRD) → Phase 3 (architecture) → Phase 4 (implement)
|
||||
```
|
||||
|
||||
Full methodology for complex projects.
|
||||
|
||||
### Enterprise
|
||||
|
||||
```
|
||||
Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (implement)
|
||||
```
|
||||
|
||||
Same as BMad Method with optional extended workflows.
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Why Solutioning Matters](./why-solutioning-matters.md)
|
||||
- [Preventing Agent Conflicts](./preventing-agent-conflicts.md)
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
|
||||
@@ -1,120 +0,0 @@
|
||||
---
|
||||
title: "Custom Content"
|
||||
---
|
||||
|
||||
|
||||
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine.
|
||||
|
||||
This flexibility transforms the platform beyond its current capabilities, enabling:
|
||||
|
||||
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
||||
- Completely new modules, workflows, templates, and agents outside software engineering
|
||||
- Professional services tools
|
||||
- Entertainment and educational content
|
||||
- Science and engineering workflows
|
||||
- Productivity and self-help solutions
|
||||
- Role-specific augmentation for virtually any profession
|
||||
|
||||
## Categories
|
||||
|
||||
- [Custom Stand-Alone Modules](#custom-stand-alone-modules)
|
||||
- [Custom Add-On Modules](#custom-add-on-modules)
|
||||
- [Custom Global Modules](#custom-global-modules)
|
||||
- [Custom Agents](#custom-agents)
|
||||
- [Custom Workflows](#custom-workflows)
|
||||
|
||||
## Custom Stand-Alone Modules
|
||||
|
||||
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
|
||||
|
||||
Custom modules are [installable](../../how-to/installation/install-custom-modules.md) using the standard BMAD method and support advanced features:
|
||||
|
||||
- Optional user information collection during installation/updates
|
||||
- Versioning and upgrade paths
|
||||
- Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools)
|
||||
- Ability to bundle specific tools such as MCP, skills, execution libraries, and code
|
||||
|
||||
## Custom Add-On Modules
|
||||
|
||||
Custom Add-On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities.
|
||||
|
||||
Examples include:
|
||||
|
||||
- Alternative implementation workflows for BMad Method agents
|
||||
- Framework-specific support for particular use cases
|
||||
- Game development expansions that add new genre-specific capabilities without reinventing existing functionality
|
||||
|
||||
Add-on modules can include:
|
||||
|
||||
- Custom agents with awareness of the target module
|
||||
- Access to existing module workflows
|
||||
- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more
|
||||
|
||||
## Custom Global Modules
|
||||
|
||||
Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMAD ecosystem.
|
||||
|
||||
Examples include:
|
||||
|
||||
- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module
|
||||
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
|
||||
- Installation and update tools that work with any BMAD method configuration
|
||||
|
||||
Upcoming standards will document best practices for building global content that affects installed modules through:
|
||||
|
||||
- Custom content injections
|
||||
- Agent customization auto-injection
|
||||
- Tooling installers
|
||||
|
||||
## Custom Agents
|
||||
|
||||
Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions.
|
||||
|
||||
### BMad Tiny Agents
|
||||
|
||||
Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with:
|
||||
|
||||
- Team coordination and management
|
||||
- Understanding team details and requirements
|
||||
- Tracking specific tasks with designated tools
|
||||
|
||||
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
|
||||
|
||||
### Simple and Expert Agents
|
||||
|
||||
The distinction between simple and expert agents lies in their structure:
|
||||
|
||||
**Simple Agent:**
|
||||
|
||||
- Single file containing all prompts and configuration
|
||||
- Self-contained and straightforward
|
||||
|
||||
**Expert Agent:**
|
||||
|
||||
- Similar to simple agents but includes a sidecar folder
|
||||
- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files
|
||||
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
||||
- has metadata type: expert
|
||||
|
||||
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
||||
|
||||
Custom agents can be:
|
||||
|
||||
- Used within custom modules
|
||||
- Designed as standalone tools
|
||||
- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with
|
||||
|
||||
## Custom Workflows
|
||||
|
||||
Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including:
|
||||
|
||||
- User engagements
|
||||
- Business processes
|
||||
- Content generation (code, documentation, or other output formats)
|
||||
|
||||
A custom workflow created outside of a larger module can still be distributed and used without associated agents through:
|
||||
|
||||
- Slash commands
|
||||
- Manual command/prompt execution when supported by tools
|
||||
|
||||
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
||||
@@ -1,66 +0,0 @@
|
||||
---
|
||||
title: "BMad Builder (BMB)"
|
||||
description: Create custom agents, workflows, and modules for BMAD
|
||||
---
|
||||
|
||||
|
||||
Create custom agents, workflows, and modules for BMAD.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
- **[Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md)** - Step-by-step guide to building your first agent
|
||||
|
||||
---
|
||||
|
||||
## Agent Architecture
|
||||
|
||||
Comprehensive guides for each agent type:
|
||||
|
||||
- **Simple Agent Architecture** - Self-contained, optimized, personality-driven
|
||||
- **Expert Agent Architecture** - Memory, sidecar files, domain restrictions
|
||||
- **Module Agent Architecture** - Workflow integration, professional tools
|
||||
|
||||
---
|
||||
|
||||
## Key Concepts
|
||||
|
||||
### YAML to XML Compilation
|
||||
|
||||
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
||||
|
||||
1. **Frontmatter** - Name and description from metadata
|
||||
2. **Activation Block** - Steps, menu handlers, rules
|
||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
||||
|
||||
---
|
||||
|
||||
## Reference Examples
|
||||
|
||||
Production-ready examples available in the BMB reference folder:
|
||||
|
||||
### Simple Agents
|
||||
- **commit-poet** - Commit message artisan with style customization
|
||||
|
||||
### Expert Agents
|
||||
- **journal-keeper** - Personal journal companion with memory and pattern recognition
|
||||
|
||||
### Module Agents
|
||||
- **security-engineer** - BMM security specialist with threat modeling
|
||||
- **trend-analyst** - CIS trend intelligence expert
|
||||
|
||||
---
|
||||
|
||||
## Installation Guide
|
||||
|
||||
For installing standalone simple and expert agents, see:
|
||||
- [Install Custom Modules](../../how-to/installation/install-custom-modules.md)
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Custom Content Types](./custom-content-types.md) - Understanding content types
|
||||
- [Create Custom Agent](../../tutorials/advanced/create-custom-agent.md) - Tutorial
|
||||
@@ -1,135 +0,0 @@
|
||||
---
|
||||
title: "BMM Documentation"
|
||||
---
|
||||
|
||||
|
||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
**New to BMM?** Start here:
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project
|
||||
- Installation and setup
|
||||
- Understanding the four phases
|
||||
- Running your first workflows
|
||||
- Agent-based development flow
|
||||
|
||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
||||
|
||||
### 📊 Visual Overview
|
||||
|
||||
**[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
|
||||
|
||||
## 📖 Core Concepts
|
||||
|
||||
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
||||
|
||||
First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts.
|
||||
|
||||
- **[Full Adaptive BMad Method](#workflow-guides)** - Full planning and scope support through extensive development and testing.
|
||||
- Broken down into 4 phases, all of which are comprised of both required and optional phases
|
||||
- Phases 1-3 are all about progressive idea development through planning and preparations to build your project.
|
||||
- Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed
|
||||
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
|
||||
- While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
|
||||
|
||||
- **[BMAD Quick Flow](../../explanation/features/quick-flow.md)** - Fast-track development workflow
|
||||
- 3-step process: spec → dev → optional review
|
||||
- Perfect for bug fixes and small features
|
||||
- Rapid prototyping with production quality
|
||||
- Implementation in minutes, not days
|
||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](../agents/barry-quick-flow.md)**
|
||||
|
||||
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](../../explanation/features/tea-overview.md)**.
|
||||
|
||||
## 🤖 Agents and Collaboration
|
||||
|
||||
Complete guide to BMM's AI agent team:
|
||||
|
||||
- **[Agents Guide](../../explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
|
||||
- 12 specialized BMM agents + BMad Master
|
||||
- Agent roles, workflows, and when to use them
|
||||
- Agent customization system
|
||||
- Best practices and common patterns
|
||||
|
||||
- **[Party Mode Guide](../../explanation/features/party-mode.md)** - Multi-agent collaboration
|
||||
- How party mode works (19+ agents collaborate in real-time)
|
||||
- When to use it (strategic, creative, cross-functional, complex)
|
||||
- Example party compositions
|
||||
- Multi-module integration (BMM + CIS + BMB + custom)
|
||||
- Agent customization in party mode
|
||||
- Best practices
|
||||
|
||||
## 🔧 Working with Existing Code
|
||||
|
||||
Comprehensive guide for brownfield development:
|
||||
|
||||
- **[Brownfield Development Guide](../../how-to/brownfield/index.md)** - Complete guide for existing codebases
|
||||
- Documentation phase strategies
|
||||
- Track selection for brownfield
|
||||
- Integration with existing patterns
|
||||
- Phase-by-phase workflow guidance
|
||||
- Common scenarios
|
||||
|
||||
## 📚 Quick References
|
||||
|
||||
Essential reference materials:
|
||||
|
||||
- **[Glossary](../../reference/glossary/index.md)** - Key terminology and concepts
|
||||
- **[FAQ](../faq/index.md)** - Frequently asked questions across all topics
|
||||
|
||||
## 🎯 Choose Your Path
|
||||
|
||||
### I need to...
|
||||
|
||||
**Build something new (greenfield)**
|
||||
→ Start with [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
|
||||
|
||||
**Fix a bug or add small feature**
|
||||
→ Use the [Quick Flow Solo Dev](../agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](../features/quick-flow.md) process
|
||||
|
||||
**Work with existing codebase (brownfield)**
|
||||
→ Read [Brownfield Development Guide](../../how-to/brownfield/index.md)
|
||||
→ Pay special attention to documentation requirements for brownfield projects
|
||||
|
||||
## 📋 Workflow Guides
|
||||
|
||||
Comprehensive documentation for all BMM workflows organized by phase:
|
||||
|
||||
- **[Phase 1: Analysis Workflows](../../how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
|
||||
- brainstorm-project, product-brief, research, and more
|
||||
- When to use analysis workflows
|
||||
- Creative and strategic tools
|
||||
|
||||
- **[Phase 2: Planning Workflows](../../how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
|
||||
- prd, tech-spec, gdd, narrative, ux
|
||||
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
||||
- Which planning workflow to use
|
||||
|
||||
- **[Phase 3: Solutioning Workflows](../../how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
|
||||
- architecture, create-epics-and-stories, implementation-readiness
|
||||
- V6: Epics created AFTER architecture for better quality
|
||||
- Required for BMad Method and Enterprise Method tracks
|
||||
- Preventing agent conflicts
|
||||
|
||||
- **[Phase 4: Implementation Workflows](../../how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
|
||||
- sprint-planning, create-story, dev-story, code-review
|
||||
- Complete story lifecycle
|
||||
- One-story-at-a-time discipline
|
||||
|
||||
- **[Testing & QA Workflows](../../explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
|
||||
- Test strategy, automation, quality gates
|
||||
- TEA agent and test healing
|
||||
|
||||
## 🌐 External Resources
|
||||
|
||||
### Community and Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-issues)
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
||||
|
||||
**Ready to begin?** → [Start with the Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
|
||||
31
docs/explanation/brainstorming.md
Normal file
31
docs/explanation/brainstorming.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "Brainstorming"
|
||||
description: Interactive creative sessions using 60+ proven ideation techniques
|
||||
---
|
||||
|
||||
Unlock your creativity through guided exploration.
|
||||
|
||||
## What is Brainstorming?
|
||||
|
||||
Run `brainstorming` and you've got a creative facilitator pulling ideas out of you - not generating them for you. The AI acts as coach and guide, using proven techniques to create conditions where your best thinking emerges.
|
||||
|
||||
**Good for:**
|
||||
|
||||
- Breaking through creative blocks
|
||||
- Generating product or feature ideas
|
||||
- Exploring problems from new angles
|
||||
- Developing raw concepts into action plans
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Setup** - Define topic, goals, constraints
|
||||
2. **Choose approach** - Pick techniques yourself, get AI recommendations, go random, or follow a progressive flow
|
||||
3. **Facilitation** - Work through techniques with probing questions and collaborative coaching
|
||||
4. **Organize** - Ideas grouped into themes and prioritized
|
||||
5. **Action** - Top ideas get next steps and success metrics
|
||||
|
||||
Everything gets captured in a session document you can reference later or share with stakeholders.
|
||||
|
||||
:::note[Your Ideas]
|
||||
Every idea comes from you. The workflow creates conditions for insight - you're the source.
|
||||
:::
|
||||
55
docs/explanation/brownfield-faq.md
Normal file
55
docs/explanation/brownfield-faq.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Brownfield Development FAQ"
|
||||
description: Common questions about brownfield development in the BMad Method
|
||||
---
|
||||
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
|
||||
|
||||
## Questions
|
||||
|
||||
- [Questions](#questions)
|
||||
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
||||
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
||||
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
||||
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
||||
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||
|
||||
### What is brownfield vs greenfield?
|
||||
|
||||
- **Greenfield** — New project, starting from scratch, clean slate
|
||||
- **Brownfield** — Existing project, working with established codebase and patterns
|
||||
|
||||
### Do I have to run document-project for brownfield?
|
||||
|
||||
Highly recommended, especially if:
|
||||
|
||||
- No existing documentation
|
||||
- Documentation is outdated
|
||||
- AI agents need context about existing code
|
||||
|
||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
||||
|
||||
### What if I forget to run document-project?
|
||||
|
||||
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
||||
|
||||
### Can I use Quick Spec Flow for brownfield projects?
|
||||
|
||||
Yes! Quick Spec Flow works great for brownfield. It will:
|
||||
|
||||
- Auto-detect your existing stack
|
||||
- Analyze brownfield code patterns
|
||||
- Detect conventions and ask for confirmation
|
||||
- Generate context-rich tech-spec that respects existing code
|
||||
|
||||
Perfect for bug fixes and small features in existing codebases.
|
||||
|
||||
### What if my existing code doesn't follow best practices?
|
||||
|
||||
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||
|
||||
- **Yes** → Maintain consistency with current codebase
|
||||
- **No** → Establish new standards (document why in tech-spec)
|
||||
|
||||
BMM respects your choice — it won't force modernization, but it will offer it.
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,204 +0,0 @@
|
||||
---
|
||||
title: "Agent Roles in BMad Method"
|
||||
description: Understanding the different agent roles in BMad Method
|
||||
---
|
||||
|
||||
|
||||
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
|
||||
|
||||
---
|
||||
|
||||
## Core Agents Overview
|
||||
|
||||
| Agent | Role | Primary Phase |
|
||||
|-------|------|---------------|
|
||||
| **Analyst** | Research and discovery | Phase 1 (Analysis) |
|
||||
| **PM** | Requirements and planning | Phase 2 (Planning) |
|
||||
| **Architect** | Technical design | Phase 3 (Solutioning) |
|
||||
| **SM** | Sprint orchestration | Phase 4 (Implementation) |
|
||||
| **DEV** | Code implementation | Phase 4 (Implementation) |
|
||||
| **TEA** | Test architecture | Phases 3-4 (Cross-phase) |
|
||||
| **UX Designer** | User experience | Phase 2-3 |
|
||||
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Analysis
|
||||
|
||||
### Analyst (Mary)
|
||||
|
||||
Business analysis and research specialist.
|
||||
|
||||
**Responsibilities:**
|
||||
- Brainstorming and ideation
|
||||
- Market, domain, and competitive research
|
||||
- Product brief creation
|
||||
- Brownfield project documentation
|
||||
|
||||
**Key Workflows:**
|
||||
- `*brainstorm-project`
|
||||
- `*research`
|
||||
- `*product-brief`
|
||||
- `*document-project`
|
||||
|
||||
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Planning
|
||||
|
||||
### PM (John)
|
||||
|
||||
Product requirements and planning expert.
|
||||
|
||||
**Responsibilities:**
|
||||
- Creating Product Requirements Documents
|
||||
- Defining functional and non-functional requirements
|
||||
- Breaking requirements into epics and stories
|
||||
- Validating implementation readiness
|
||||
|
||||
**Key Workflows:**
|
||||
- `*create-prd`
|
||||
- `*create-epics-and-stories`
|
||||
- `*implementation-readiness`
|
||||
|
||||
**When to use:** Defining what to build, creating PRDs, organizing work into stories.
|
||||
|
||||
### UX Designer (Sally)
|
||||
|
||||
User experience and UI design specialist.
|
||||
|
||||
**Responsibilities:**
|
||||
- UX specification creation
|
||||
- User journey mapping
|
||||
- Wireframe and mockup design
|
||||
- Design system documentation
|
||||
|
||||
**Key Workflows:**
|
||||
- `*create-ux-design`
|
||||
- `*validate-design`
|
||||
|
||||
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Solutioning
|
||||
|
||||
### Architect (Winston)
|
||||
|
||||
System architecture and technical design expert.
|
||||
|
||||
**Responsibilities:**
|
||||
- System architecture design
|
||||
- Architecture Decision Records (ADRs)
|
||||
- Technical standards definition
|
||||
- Implementation readiness validation
|
||||
|
||||
**Key Workflows:**
|
||||
- `*create-architecture`
|
||||
- `*implementation-readiness`
|
||||
|
||||
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Implementation
|
||||
|
||||
### SM (Bob)
|
||||
|
||||
Sprint planning and story preparation orchestrator.
|
||||
|
||||
**Responsibilities:**
|
||||
- Sprint planning and tracking
|
||||
- Story preparation for development
|
||||
- Course correction handling
|
||||
- Epic retrospectives
|
||||
|
||||
**Key Workflows:**
|
||||
- `*sprint-planning`
|
||||
- `*create-story`
|
||||
- `*correct-course`
|
||||
- `*epic-retrospective`
|
||||
|
||||
**When to use:** Organizing work, preparing stories, tracking progress.
|
||||
|
||||
### DEV (Amelia)
|
||||
|
||||
Story implementation and code review specialist.
|
||||
|
||||
**Responsibilities:**
|
||||
- Story implementation with tests
|
||||
- Code review
|
||||
- Following architecture patterns
|
||||
- Quality assurance
|
||||
|
||||
**Key Workflows:**
|
||||
- `*dev-story`
|
||||
- `*code-review`
|
||||
|
||||
**When to use:** Writing code, implementing stories, reviewing quality.
|
||||
|
||||
---
|
||||
|
||||
## Cross-Phase Agents
|
||||
|
||||
### TEA (Murat)
|
||||
|
||||
Test architecture and quality strategy expert.
|
||||
|
||||
**Responsibilities:**
|
||||
- Test framework setup
|
||||
- Test design and planning
|
||||
- ATDD and automation
|
||||
- Quality gate decisions
|
||||
|
||||
**Key Workflows:**
|
||||
- `*framework`, `*ci`
|
||||
- `*test-design`, `*atdd`, `*automate`
|
||||
- `*test-review`, `*trace`, `*nfr-assess`
|
||||
|
||||
**When to use:** Setting up testing, creating test plans, quality gates.
|
||||
|
||||
---
|
||||
|
||||
## Quick Flow
|
||||
|
||||
### Quick Flow Solo Dev (Barry)
|
||||
|
||||
Fast solo development without handoffs.
|
||||
|
||||
**Responsibilities:**
|
||||
- Technical specification
|
||||
- End-to-end implementation
|
||||
- Code review
|
||||
|
||||
**Key Workflows:**
|
||||
- `*create-tech-spec`
|
||||
- `*quick-dev`
|
||||
- `*code-review`
|
||||
|
||||
**When to use:** Bug fixes, small features, rapid prototyping.
|
||||
|
||||
---
|
||||
|
||||
## Choosing the Right Agent
|
||||
|
||||
| Task | Agent |
|
||||
|------|-------|
|
||||
| Brainstorming ideas | Analyst |
|
||||
| Market research | Analyst |
|
||||
| Creating PRD | PM |
|
||||
| Designing UX | UX Designer |
|
||||
| System architecture | Architect |
|
||||
| Preparing stories | SM |
|
||||
| Writing code | DEV |
|
||||
| Setting up tests | TEA |
|
||||
| Quick bug fix | Quick Flow Solo Dev |
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [What Are Agents](./what-are-agents.md) - Foundational concepts
|
||||
- [Agent Reference](../../reference/agents/index.md) - Complete command reference
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: "BMAD Core Concepts"
|
||||
---
|
||||
|
||||
|
||||
Understanding the fundamental building blocks of the BMAD Method.
|
||||
|
||||
## The Essentials
|
||||
|
||||
| Concept | Description | Guide |
|
||||
|---------|-------------|-------|
|
||||
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](./what-are-agents.md) |
|
||||
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](./what-are-workflows.md) |
|
||||
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](./what-are-modules.md) |
|
||||
|
||||
## Getting Started
|
||||
|
||||
### New to BMAD?
|
||||
Start here to understand what BMAD is and how it works:
|
||||
|
||||
1. **[Agents Guide](./what-are-agents.md)** - Learn about Simple and Expert agents
|
||||
2. **[Workflows Guide](./what-are-workflows.md)** - Understand how workflows orchestrate tasks
|
||||
3. **[Modules Guide](./what-are-modules.md)** - See how modules organize functionality
|
||||
|
||||
### Installing BMAD
|
||||
|
||||
- **[Installation Guide](../../how-to/installation/index.md)** - Set up BMAD in your project
|
||||
- **[Upgrading from v4](../../how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
|
||||
|
||||
### Configuration
|
||||
|
||||
- **[BMAD Customization](../../how-to/customization/index.md)** - Personalize agents and workflows
|
||||
|
||||
### Advanced
|
||||
|
||||
- **[Web Bundles](../features/web-bundles.md)** - Use BMAD in Gemini Gems and Custom GPTs
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agents Guide](./what-are-agents.md) to understand the core building block of BMAD.
|
||||
@@ -1,96 +0,0 @@
|
||||
---
|
||||
title: "Agents"
|
||||
---
|
||||
|
||||
|
||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
||||
|
||||
## Agent Types
|
||||
|
||||
BMAD has two primary agent types, designed for different use cases:
|
||||
|
||||
### Simple Agents
|
||||
|
||||
**Self-contained, focused, ready to use.**
|
||||
|
||||
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
|
||||
|
||||
**Best for:**
|
||||
- Single-purpose assistants (code review, documentation, commit messages)
|
||||
- Quick deployment
|
||||
- Projects that don't require persistent memory
|
||||
- Getting started fast
|
||||
|
||||
**Example:** A commit message agent that reads your git diff and generates conventional commits.
|
||||
|
||||
### Expert Agents
|
||||
|
||||
**Powerful, memory-equipped, domain specialists.**
|
||||
|
||||
Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
|
||||
|
||||
**Best for:**
|
||||
- Domain specialists (security architect, game designer, product manager)
|
||||
- Tasks requiring persistent memory
|
||||
- Complex workflows with multiple stages
|
||||
- Projects that grow over time
|
||||
|
||||
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
|
||||
|
||||
## Key Differences
|
||||
|
||||
| Feature | Simple | Expert |
|
||||
| ---------------- | -------------- | -------------------------- |
|
||||
| **Files** | Single file | Agent + sidecar folder |
|
||||
| **Memory** | Session only | Persistent across sessions |
|
||||
| **Capabilities** | Focused scope | Multi-domain, extensible |
|
||||
| **Setup** | Zero config | Sidecar initialization |
|
||||
| **Best Use** | Specific tasks | Ongoing projects |
|
||||
|
||||
## Agent Components
|
||||
|
||||
All agents share these building blocks:
|
||||
|
||||
### Persona
|
||||
- **Role** - What the agent does (expertise domain)
|
||||
- **Identity** - Who the agent is (personality, character)
|
||||
- **Communication Style** - How the agent speaks (tone, voice)
|
||||
- **Principles** - Why the agent acts (values, decision framework)
|
||||
|
||||
### Capabilities
|
||||
- Skills, tools, and knowledge the agent can apply
|
||||
- Mapped to specific menu commands
|
||||
|
||||
### Menu
|
||||
- Interactive command list
|
||||
- Triggers, descriptions, and handlers
|
||||
- Auto-includes help and exit options
|
||||
|
||||
### Critical Actions (optional)
|
||||
- Instructions that execute before the agent starts
|
||||
- Enable autonomous behaviors (e.g., "check git status before changes")
|
||||
|
||||
## Which Should You Use?
|
||||
|
||||
**Choose Simple when:**
|
||||
- You need a task done quickly and reliably
|
||||
- The scope is well-defined and won't change much
|
||||
- You don't need the agent to remember things between sessions
|
||||
|
||||
**Choose Expert when:**
|
||||
- You're building something complex over time
|
||||
- The agent needs to maintain context (project history, decisions)
|
||||
- You want the agent to coordinate workflows or other agents
|
||||
- Domain expertise requires specialized knowledge bases
|
||||
|
||||
## Creating Custom Agents
|
||||
|
||||
BMAD provides the **BMAD Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md) for step-by-step instructions.
|
||||
|
||||
## Customizing Existing Agents
|
||||
|
||||
You can modify any agent's behavior without editing core files. See [BMAD Customization](../../how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Learn about [Workflows](./what-are-workflows.md) to see how agents accomplish complex tasks.
|
||||
@@ -1,79 +0,0 @@
|
||||
---
|
||||
title: "Modules"
|
||||
---
|
||||
|
||||
|
||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
||||
|
||||
## What is a Module?
|
||||
|
||||
A module is a self-contained package that includes:
|
||||
|
||||
- **Agents** - Specialized AI assistants
|
||||
- **Workflows** - Step-by-step processes
|
||||
- **Configuration** - Module-specific settings
|
||||
- **Documentation** - Usage guides and reference
|
||||
|
||||
## Official Modules
|
||||
|
||||
### Core Module
|
||||
Always installed, provides shared functionality:
|
||||
- Global configuration
|
||||
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
||||
- Common tasks (document indexing, sharding, review)
|
||||
|
||||
### BMAD Method (BMM)
|
||||
Software and game development:
|
||||
- Project planning workflows
|
||||
- Implementation agents (Dev, PM, QA, Scrum Master)
|
||||
- Testing and architecture guidance
|
||||
|
||||
### BMAD Builder (BMB)
|
||||
Create custom solutions:
|
||||
- Agent creation workflows
|
||||
- Workflow authoring tools
|
||||
- Module scaffolding
|
||||
|
||||
### Creative Intelligence Suite (CIS)
|
||||
Innovation and creativity:
|
||||
- Creative thinking techniques
|
||||
- Innovation strategy workflows
|
||||
- Storytelling and ideation
|
||||
|
||||
### BMAD Game Dev (BMGD)
|
||||
Game development specialization:
|
||||
- Game design workflows
|
||||
- Narrative development
|
||||
- Performance testing frameworks
|
||||
|
||||
## Module Structure
|
||||
|
||||
Installed modules follow this structure:
|
||||
|
||||
```
|
||||
_bmad/
|
||||
├── core/ # Always present
|
||||
├── bmm/ # BMAD Method (if installed)
|
||||
├── bmb/ # BMAD Builder (if installed)
|
||||
├── cis/ # Creative Intelligence (if installed)
|
||||
└── bmgd/ # Game Dev (if installed)
|
||||
```
|
||||
|
||||
## Custom Modules
|
||||
|
||||
You can create your own modules containing:
|
||||
- Custom agents for your domain
|
||||
- Organizational workflows
|
||||
- Team-specific configurations
|
||||
|
||||
Custom modules are installed the same way as official modules.
|
||||
|
||||
## Installing Modules
|
||||
|
||||
During BMAD installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
||||
|
||||
See [Installation Guide](../../how-to/installation/index.md) for details.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Installation Guide](../../how-to/installation/index.md) to set up BMAD with the modules you need.
|
||||
@@ -1,217 +0,0 @@
|
||||
---
|
||||
title: "Workflows"
|
||||
---
|
||||
|
||||
|
||||
Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs.
|
||||
|
||||
This guide explains what workflows are, why they're powerful, and how to think about designing them.
|
||||
|
||||
---
|
||||
|
||||
## What Is a Workflow?
|
||||
|
||||
A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction.
|
||||
|
||||
Think of it this way: instead of asking "help me build a nutrition plan" and getting a generic response, a workflow guides you (or runs automatically) through discovery, assessment, strategy, shopping lists, and prep schedules—each step building on the last, nothing missed, no shortcuts taken.
|
||||
|
||||
## How do workflows differ from skills?
|
||||
|
||||
Actually they really do not - a workflow can be a skill, and a skill can be a workflow. The main thing with a BMad workflow is the suggestion to follow certain conventions, which actually are also skill best practices. A skill has a few optional and required fields to add as the main file workflow and get stored in a specific location depending on your tool choice for automatic invocation by the llm - whereas workflows are generally intentionally launched, with from another process calling them, or a user invoking via a slash command. In the near future, workflows will optionally be installable as skills also - but if you like, you can add front matter to your custom workflows based on the skill spec from Anthropic, and put them in the proper location your tool dictates.
|
||||
|
||||
### The Power of Progressive Disclosure
|
||||
|
||||
Here's why workflows work so well: the AI only sees the current step. It doesn't know about step 5 when it's on step 2. It can't get ahead of itself, skip steps, or lose focus. Each step gets the AI's full attention, completing fully before the next step loads.
|
||||
|
||||
This is the opposite of a giant prompt that tries to handle everything at once and inevitably misses details or loses coherence.
|
||||
|
||||
Workflows exist on a spectrum:
|
||||
|
||||
- **Interactive workflows** guide users through complex decisions via collaboration and facilitation
|
||||
- **Automated workflows** run with minimal user input, processing documents or executing tasks
|
||||
- **Hybrid workflows** combine both—some steps need user input, others run automatically
|
||||
|
||||
### Real-World Workflow Examples
|
||||
|
||||
**Tax Organizer Workflow**
|
||||
|
||||
A tax preparation workflow that helps users organize financial documents for tax filing. Runs in a single session, follows prescriptive IRS categories, produces a checklist of required documents with missing-item alerts. Sequential and compliance-focused.
|
||||
|
||||
**Meal Planning Workflow**
|
||||
|
||||
Creates personalized weekly meal plans through collaborative nutrition planning. Users can stop mid-session and return later because the workflow tracks progress. Intent-based conversation helps discover preferences rather than following a script. Multi-session, creative, and highly interactive.
|
||||
|
||||
**Course Creator Workflow**
|
||||
|
||||
Helps instructors design course syllabi. Branches based on course type—academic courses need accreditation sections, vocational courses need certification prep, self-paced courses need different structures entirely.
|
||||
|
||||
**Therapy Intake Workflow**
|
||||
|
||||
Guides mental health professionals through structured client intake sessions. Highly sensitive and confidential, uses intent-based questioning to build rapport while ensuring all required clinical information is collected. Continuable across multiple sessions.
|
||||
|
||||
**Software Architecture Workflow** (BMM Module)
|
||||
|
||||
Part of a larger software development pipeline. Runs after product requirements and UX design are complete, takes those documents as input, then collaboratively walks through technical decisions: system components, data flows, technology choices, architectural patterns. Produces an architecture document that implementation teams use to build consistently.
|
||||
|
||||
**Shard Document Workflow**
|
||||
|
||||
Nearly hands-off automated workflow. Takes a large document as input, uses a custom npx tool to split it into smaller files, deletes the original, then augments an index with content details so the LLM can efficiently find and reference specific sections later. Minimal user interaction—just specify the input document.
|
||||
|
||||
These examples show the range: from collaborative creative processes to automated batch jobs, workflows ensure completeness and consistency whether the work involves deep collaboration or minimal human oversight.
|
||||
|
||||
### The Facilitative Philosophy
|
||||
|
||||
When workflows involve users, they should be **facilitative, not directive**. The AI treats users as partners and domain experts, not as passive recipients of generated content.
|
||||
|
||||
**Collaborative dialogue, not command-response**: The AI and user work together throughout. The AI brings structured thinking, methodology, and technical knowledge. The user brings domain expertise, context, and judgment. Together they produce something better than either could alone.
|
||||
|
||||
**The user is the expert in their domain**: A nutrition planning workflow doesn't dictate meal plans—it guides users through discovering what works for their lifestyle. An architecture workflow doesn't tell architects what to build—it facilitates systematic decision-making so choices are explicit and consistent.
|
||||
|
||||
**Intent-based facilitation**: Workflows should describe goals and approaches, not scripts. Instead of "Ask: What is your age? Then ask: What is your goal weight?" use "Guide the user through understanding their health profile. Ask 1-2 questions at a time. Think about their responses before asking follow-ups. Probe to understand their actual needs."
|
||||
|
||||
The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative.
|
||||
|
||||
**When to be prescriptive**: Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception, not the rule. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
|
||||
|
||||
---
|
||||
|
||||
## Why Workflows Matter
|
||||
|
||||
Workflows solve three fundamental problems with AI interactions:
|
||||
|
||||
**Focus**: Each step contains only instructions for that phase. The AI sees one step at a time, preventing it from getting ahead of itself or losing focus.
|
||||
|
||||
**Continuity**: Workflows can span multiple sessions. Stop mid-workflow and return later without losing progress—something free-form prompts can't do.
|
||||
|
||||
**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results.
|
||||
|
||||
---
|
||||
|
||||
## How Workflows Work
|
||||
|
||||
### The Basic Structure
|
||||
|
||||
Workflows consist of multiple markdown files, each representing one step:
|
||||
|
||||
```
|
||||
my-workflow/
|
||||
├── workflow.md # Entry point and configuration
|
||||
├── steps/ # Step files (steps-c/ for create, steps-e/ for edit, steps-v/ for validate)
|
||||
│ ├── step-01-init.md
|
||||
│ ├── step-02-profile.md
|
||||
│ └── step-N-final.md
|
||||
├── data/ # Reference materials, CSVs, examples
|
||||
└── templates/ # Output document templates
|
||||
```
|
||||
|
||||
The `workflow.md` file is minimal—it contains the workflow name, description, goal, the AI's role, and how to start. Importantly, it does not list all steps or detail what each does. This is progressive disclosure in action.
|
||||
|
||||
### Sequential Execution
|
||||
|
||||
Workflows execute in strict sequence: `step-01 → step-02 → step-03 → ... → step-N`
|
||||
|
||||
The AI cannot skip steps or optimize the sequence. It must complete each step fully before loading the next. This ensures thoroughness and prevents shortcuts that compromise quality.
|
||||
|
||||
### Continuable Workflows
|
||||
|
||||
Some workflows are complex enough that users might need multiple sessions. These "continuable workflows" track which steps are complete in the output document's frontmatter, so users can stop and resume later without losing progress.
|
||||
|
||||
Use continuable workflows when:
|
||||
- The workflow produces large documents
|
||||
- Multiple sessions are likely
|
||||
- Complex decisions benefit from reflection
|
||||
- The workflow has many steps (8+)
|
||||
|
||||
Keep it simple (single-session) when tasks are quick, focused, and can be completed in one sitting.
|
||||
|
||||
### Workflow Chaining
|
||||
|
||||
Workflows can be chained together where outputs become inputs. The BMM module pipeline is a perfect example:
|
||||
|
||||
```
|
||||
brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning
|
||||
↓
|
||||
implement-story → review → repeat
|
||||
```
|
||||
|
||||
Each workflow checks for required inputs from prior workflows, validates they're complete, and produces output for the next workflow. This creates powerful end-to-end pipelines for complex processes.
|
||||
|
||||
### The Tri-Modal Pattern
|
||||
|
||||
For critical workflows that produce important artifacts, BMAD uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others.
|
||||
|
||||
**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMAD standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns.
|
||||
|
||||
**Validate mode** runs standalone and checks artifacts against standards. Because it's separate, you can run validation whenever you want—immediately after creation, weeks later when things have changed, or even using a different LLM entirely. It's like having a quality assurance checkpoint that's always available but never forced.
|
||||
|
||||
**Edit mode** modifies existing artifacts while enforcing standards. As you update documents to reflect changing requirements or new understanding, edit mode ensures you don't accidentally drift away from the patterns that make the artifacts useful. It checks compliance as you work and can route back to create mode if it detects something that needs full conversion.
|
||||
|
||||
All BMAD planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action.
|
||||
|
||||
This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members.
|
||||
|
||||
---
|
||||
|
||||
## Design Decisions
|
||||
|
||||
Before building a workflow, answer these questions:
|
||||
|
||||
**Module affiliation**: Is this standalone or part of a module? Module-based workflows can access module-specific variables and reference other workflow outputs. Also when part of a module, generally they will be associated to an agent.
|
||||
|
||||
**Continuable or single-session?**: Will users need multiple sessions, or can this be completed in one sitting?
|
||||
|
||||
**Edit/Validate support?**: Do you need Create/Edit/Validate modes (tri-modal structure)? Use tri-modal for complex, critical workflows requiring quality assurance. Use create-only for simple, one-off workflows.
|
||||
|
||||
**Document output?**: Does this produce a persistent file, or perform actions without output?
|
||||
|
||||
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
||||
|
||||
---
|
||||
|
||||
## Learning from Examples
|
||||
|
||||
The best way to understand workflows is to study real examples. Look at the official BMAD modules:
|
||||
|
||||
- **BMB (Module Builder)**: Workflow and agent creation workflows
|
||||
- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
|
||||
- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture
|
||||
- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy
|
||||
|
||||
Study the workflow.md files to understand how each workflow starts. Examine step files to see how instructions are structured. Notice the frontmatter variables, menu handling, and how steps chain together.
|
||||
|
||||
Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same.
|
||||
|
||||
---
|
||||
|
||||
## When to Use Workflows
|
||||
|
||||
Use workflows when:
|
||||
|
||||
- **Tasks are multi-step and complex**: Break down complexity into manageable pieces
|
||||
- **Quality and completeness matter**: Sequential enforcement ensures nothing gets missed
|
||||
- **Repeatability is important**: Get consistent results every time
|
||||
- **Tasks span multiple sessions**: Continuable workflows preserve progress
|
||||
- **You need to chain processes**: Output of one workflow becomes input of another
|
||||
- **Compliance or standards matter**: Enforce required steps and documentation
|
||||
|
||||
Don't use workflows when:
|
||||
|
||||
- **Tasks are simple and one-off**: A single prompt works fine for quick questions
|
||||
- **Flexibility trumps structure**: Free-form conversation is better for exploration
|
||||
|
||||
Modified BMad Workflows
|
||||
|
||||
- **Tasks are truly one-step**
|
||||
|
||||
If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have
|
||||
a short single file workflow.md file.
|
||||
|
||||
---
|
||||
|
||||
## The Bottom Line
|
||||
|
||||
Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match.
|
||||
|
||||
They're not just for software development. You can create workflows for any guided process - meal planning, course design, therapy intake, tax preparation, document processing, creative writing, event planning—any complex task that benefits from structure and thoroughness.
|
||||
|
||||
Start simple. Study examples. Build workflows for your own domain. You'll wonder how you ever got by with just prompts.
|
||||
@@ -1,18 +0,0 @@
|
||||
---
|
||||
title: "Core Module"
|
||||
---
|
||||
|
||||
|
||||
The Core Module is installed with all installations of BMAD modules and provides common functionality that any module, workflow, or agent can take advantage of.
|
||||
|
||||
## Core Module Components
|
||||
|
||||
- **[Global Core Config](../../reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
|
||||
- **[Core Workflows](../../reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
|
||||
- [Party Mode](../../explanation/features/party-mode.md) — Multi-agent conversation orchestration
|
||||
- [Brainstorming](../../explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
|
||||
- [Advanced Elicitation](../../explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||
- **[Core Tasks](../../reference/configuration/core-tasks.md)** — Common tasks available across modules
|
||||
- [Index Docs](../../reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](../../reference/configuration/core-tasks.md#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](../../reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
||||
@@ -1,121 +0,0 @@
|
||||
---
|
||||
title: "Creative Intelligence Suite (CIS)"
|
||||
description: AI-powered creative facilitation with the Creative Intelligence Suite
|
||||
---
|
||||
|
||||
|
||||
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
|
||||
|
||||
---
|
||||
|
||||
## Core Capabilities
|
||||
|
||||
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
|
||||
|
||||
---
|
||||
|
||||
## Specialized Agents
|
||||
|
||||
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
||||
- **Maya** - Design Thinking Maestro (jazz-like improviser)
|
||||
- **Dr. Quinn** - Problem Solver (detective-scientist hybrid)
|
||||
- **Victor** - Innovation Oracle (bold strategic precision)
|
||||
- **Sophia** - Master Storyteller (whimsical narrator)
|
||||
|
||||
---
|
||||
|
||||
## Interactive Workflows
|
||||
|
||||
**5 Workflows** with **150+ Creative Techniques:**
|
||||
|
||||
### Brainstorming
|
||||
|
||||
36 techniques across 7 categories for ideation:
|
||||
- Divergent/convergent thinking
|
||||
- Lateral connections
|
||||
- Forced associations
|
||||
|
||||
### Design Thinking
|
||||
|
||||
Complete 5-phase human-centered process:
|
||||
- Empathize → Define → Ideate → Prototype → Test
|
||||
- User journey mapping
|
||||
- Rapid iteration
|
||||
|
||||
### Problem Solving
|
||||
|
||||
Systematic root cause analysis:
|
||||
- 5 Whys, Fishbone diagrams
|
||||
- Solution generation
|
||||
- Impact assessment
|
||||
|
||||
### Innovation Strategy
|
||||
|
||||
Business model disruption:
|
||||
- Blue Ocean Strategy
|
||||
- Jobs-to-be-Done
|
||||
- Disruptive innovation patterns
|
||||
|
||||
### Storytelling
|
||||
|
||||
25 narrative frameworks:
|
||||
- Hero's Journey
|
||||
- Story circles
|
||||
- Compelling pitch structures
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Direct Workflow
|
||||
|
||||
```bash
|
||||
workflow brainstorming
|
||||
|
||||
workflow design-thinking --data /path/to/context.md
|
||||
```
|
||||
|
||||
### Agent-Facilitated
|
||||
|
||||
```bash
|
||||
agent cis/brainstorming-coach
|
||||
|
||||
> *brainstorm
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Key Differentiators
|
||||
|
||||
- **Facilitation Over Generation** - Guides discovery through questions
|
||||
- **Energy-Aware Sessions** - Adapts to engagement levels
|
||||
- **Context Integration** - Domain-specific guidance support
|
||||
- **Persona-Driven** - Unique communication styles
|
||||
- **Rich Method Libraries** - 150+ proven techniques
|
||||
|
||||
---
|
||||
|
||||
## Integration Points
|
||||
|
||||
CIS workflows integrate with:
|
||||
|
||||
- **BMM** - Powers project brainstorming
|
||||
- **BMB** - Creative module design
|
||||
- **Custom Modules** - Shared creative resource
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Set clear objectives** before starting sessions
|
||||
2. **Provide context documents** for domain relevance
|
||||
3. **Trust the process** - Let facilitation guide you
|
||||
4. **Take breaks** when energy flags
|
||||
5. **Document insights** as they emerge
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Facilitation Over Generation](../philosophy/facilitation-over-generation.md) - Core philosophy
|
||||
- [Brainstorming Techniques](../features/brainstorming-techniques.md) - Technique reference
|
||||
@@ -1,80 +0,0 @@
|
||||
---
|
||||
title: "Brownfield Development FAQ"
|
||||
description: Common questions about brownfield development in the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Q: What is brownfield vs greenfield?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Greenfield:** New project, starting from scratch, clean slate
|
||||
- **Brownfield:** Existing project, working with established codebase and patterns
|
||||
|
||||
## Q: Do I have to run document-project for brownfield?
|
||||
|
||||
**A:** Highly recommended, especially if:
|
||||
|
||||
- No existing documentation
|
||||
- Documentation is outdated
|
||||
- AI agents need context about existing code
|
||||
- Level 2-4 complexity
|
||||
|
||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`.
|
||||
|
||||
## Q: What if I forget to run document-project on brownfield?
|
||||
|
||||
**A:** Workflows will lack context about existing code. You may get:
|
||||
|
||||
- Suggestions that don't match existing patterns
|
||||
- Integration approaches that miss existing APIs
|
||||
- Architecture that conflicts with current structure
|
||||
|
||||
Run document-project and restart planning with proper context.
|
||||
|
||||
## Q: Can I use Quick Spec Flow for brownfield projects?
|
||||
|
||||
**A:** Yes! Quick Spec Flow works great for brownfield. It will:
|
||||
|
||||
- Auto-detect your existing stack
|
||||
- Analyze brownfield code patterns
|
||||
- Detect conventions and ask for confirmation
|
||||
- Generate context-rich tech-spec that respects existing code
|
||||
|
||||
Perfect for bug fixes and small features in existing codebases.
|
||||
|
||||
## Q: How does workflow-init handle brownfield with old planning docs?
|
||||
|
||||
**A:** workflow-init asks about YOUR current work first, then uses old artifacts as context:
|
||||
|
||||
1. Shows what it found (old PRD, epics, etc.)
|
||||
2. Asks: "Is this work in progress, previous effort, or proposed work?"
|
||||
3. If previous effort: Asks you to describe your NEW work
|
||||
4. Determines level based on YOUR work, not old artifacts
|
||||
|
||||
This prevents old Level 3 PRDs from forcing Level 3 workflow for new Level 0 bug fix.
|
||||
|
||||
## Q: What if my existing code doesn't follow best practices?
|
||||
|
||||
**A:** Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||
|
||||
- **Yes** → Maintain consistency with current codebase
|
||||
- **No** → Establish new standards (document why in tech-spec)
|
||||
|
||||
BMM respects your choice - it won't force modernization, but it will offer it.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Brownfield Guide](../../how-to/brownfield/index.md) - Existing codebase workflows
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,66 +0,0 @@
|
||||
---
|
||||
title: "Getting Started FAQ"
|
||||
description: Common questions about getting started with the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about getting started with the BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Q: Do I always need to run workflow-init?
|
||||
|
||||
**A:** No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
|
||||
|
||||
- Determines your project's appropriate level automatically
|
||||
- Creates the tracking status file
|
||||
- Routes you to the correct starting workflow
|
||||
|
||||
For experienced users: use the [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow.
|
||||
|
||||
## Q: Why do I need fresh chats for each workflow?
|
||||
|
||||
**A:** Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for:
|
||||
|
||||
- Planning workflows (PRD, architecture)
|
||||
- Analysis workflows (brainstorming, research)
|
||||
- Complex story implementation
|
||||
|
||||
Quick workflows like status checks can reuse chats safely.
|
||||
|
||||
## Q: Can I skip workflow-status and just start working?
|
||||
|
||||
**A:** Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for:
|
||||
|
||||
- New projects (guides initial setup)
|
||||
- When you're unsure what to do next
|
||||
- After breaks in work (reminds you where you left off)
|
||||
- Checking overall progress
|
||||
|
||||
## Q: What's the minimum I need to get started?
|
||||
|
||||
**A:** For the fastest path:
|
||||
|
||||
1. Install BMad Method: `npx bmad-method@alpha install`
|
||||
2. For small changes: Load PM agent → run tech-spec → implement
|
||||
3. For larger projects: Load PM agent → run prd → architect → implement
|
||||
|
||||
## Q: How do I know if I'm in Phase 1, 2, 3, or 4?
|
||||
|
||||
**A:** Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on:
|
||||
|
||||
- **Phase 1** - Brainstorming, research, product brief (optional)
|
||||
- **Phase 2** - Creating either a PRD or tech-spec (always required)
|
||||
- **Phase 3** - Architecture design (Level 2-4 only)
|
||||
- **Phase 4** - Actually writing code, implementing stories
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,56 +0,0 @@
|
||||
---
|
||||
title: "Implementation FAQ"
|
||||
description: Common questions about implementation in the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about implementation in the BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Q: Does create-story include implementation context?
|
||||
|
||||
**A:** Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler.
|
||||
|
||||
## Q: How do I mark a story as done?
|
||||
|
||||
**A:** After dev-story completes and code-review passes:
|
||||
|
||||
1. Open `sprint-status.yaml` (created by sprint-planning)
|
||||
2. Change the story status from `review` to `done`
|
||||
3. Save the file
|
||||
|
||||
## Q: Can I work on multiple stories at once?
|
||||
|
||||
**A:** Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other.
|
||||
|
||||
## Q: What if my story takes longer than estimated?
|
||||
|
||||
**A:** That's normal! Stories are estimates. If implementation reveals more complexity:
|
||||
|
||||
1. Continue working until DoD is met
|
||||
2. Consider if story should be split
|
||||
3. Document learnings in retrospective
|
||||
4. Adjust future estimates based on this learning
|
||||
|
||||
## Q: When should I run retrospective?
|
||||
|
||||
**A:** After completing all stories in an epic (when epic is done). Retrospectives capture:
|
||||
|
||||
- What went well
|
||||
- What could improve
|
||||
- Technical insights
|
||||
- Learnings for future epics
|
||||
|
||||
Don't wait until project end - run after each epic for continuous improvement.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,17 +0,0 @@
|
||||
---
|
||||
title: "Frequently Asked Questions"
|
||||
description: Frequently asked questions about the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about the BMad Method, organized by topic.
|
||||
|
||||
## Topics
|
||||
|
||||
- [Getting Started](./getting-started-faq.md) - Questions about starting with BMM
|
||||
- [Levels & Tracks](./levels-and-tracks-faq.md) - Choosing the right level
|
||||
- [Workflows](./workflows-faq.md) - Workflow and phase questions
|
||||
- [Planning](./planning-faq.md) - Planning document questions
|
||||
- [Implementation](./implementation-faq.md) - Implementation questions
|
||||
- [Brownfield](./brownfield-faq.md) - Existing codebase questions
|
||||
- [Tools & Advanced](./tools-faq.md) - Tools, IDEs, and advanced topics
|
||||
@@ -1,58 +0,0 @@
|
||||
---
|
||||
title: "Levels and Tracks FAQ"
|
||||
description: Common questions about choosing the right level for your project
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about choosing the right level for your BMad Method project.
|
||||
|
||||
---
|
||||
|
||||
## Q: How do I know which level my project is?
|
||||
|
||||
**A:** Use workflow-init for automatic detection, or self-assess using these keywords:
|
||||
|
||||
- **Level 0:** "fix", "bug", "typo", "small change", "patch" → 1 story
|
||||
- **Level 1:** "simple", "basic", "small feature", "add" → 1-10 stories
|
||||
- **Level 2:** "dashboard", "several features", "admin panel" → 5-15 stories
|
||||
- **Level 3:** "platform", "integration", "complex", "system" → 12-40 stories
|
||||
- **Level 4:** "enterprise", "multi-tenant", "multiple products" → 40+ stories
|
||||
|
||||
When in doubt, start smaller. You can always run create-prd later if needed.
|
||||
|
||||
## Q: Can I change levels mid-project?
|
||||
|
||||
**A:** Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible - your initial level choice isn't permanent.
|
||||
|
||||
## Q: What if workflow-init suggests the wrong level?
|
||||
|
||||
**A:** You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment.
|
||||
|
||||
## Q: Do I always need architecture for Level 2?
|
||||
|
||||
**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning.
|
||||
|
||||
## Q: What's the difference between Level 1 and Level 2?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Level 1:** 1-10 stories, uses tech-spec (simpler, faster), no architecture
|
||||
- **Level 2:** 5-15 stories, uses PRD (product-focused), optional architecture
|
||||
|
||||
The overlap (5-10 stories) is intentional. Choose based on:
|
||||
|
||||
- Need product-level planning? → Level 2
|
||||
- Just need technical plan? → Level 1
|
||||
- Multiple epics? → Level 2
|
||||
- Single epic? → Level 1
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: "Planning Documents FAQ"
|
||||
description: Common questions about planning documents in the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about planning documents in the BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Q: Why no tech-spec at Level 2+?
|
||||
|
||||
**A:** Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses:
|
||||
|
||||
- PRD (product vision, functional requirements, non-functional requirements)
|
||||
- Architecture (system design)
|
||||
- Epics+Stories (created AFTER architecture is complete)
|
||||
|
||||
## Q: Do I need a PRD for a bug fix?
|
||||
|
||||
**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
|
||||
|
||||
- Load PM agent
|
||||
- Run tech-spec workflow
|
||||
- Implement immediately
|
||||
|
||||
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
|
||||
|
||||
## Q: Can I skip the product brief?
|
||||
|
||||
**A:** Yes, product brief is always optional. It's most valuable for:
|
||||
|
||||
- Level 3-4 projects needing strategic direction
|
||||
- Projects with stakeholders requiring alignment
|
||||
- Novel products needing market research
|
||||
- When you want to explore solution space before committing
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,248 +0,0 @@
|
||||
---
|
||||
title: "Tools and Advanced FAQ"
|
||||
description: Common questions about tools, IDEs, and advanced topics in the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about tools, IDEs, and advanced topics in the BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Tools and Technical
|
||||
|
||||
### Q: Why are my Mermaid diagrams not rendering?
|
||||
|
||||
**A:** Common issues:
|
||||
|
||||
1. Missing language tag: Use ` ```mermaid` not just ` ``` `
|
||||
2. Syntax errors in diagram (validate at mermaid.live)
|
||||
3. Tool doesn't support Mermaid (check your Markdown renderer)
|
||||
|
||||
All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs.
|
||||
|
||||
### Q: Can I use BMM with GitHub Copilot / Cursor / other AI tools?
|
||||
|
||||
**A:** Yes! BMM is complementary. BMM handles:
|
||||
|
||||
- Project planning and structure
|
||||
- Workflow orchestration
|
||||
- Agent Personas and expertise
|
||||
- Documentation generation
|
||||
- Quality gates
|
||||
|
||||
Your AI coding assistant handles:
|
||||
|
||||
- Line-by-line code completion
|
||||
- Quick refactoring
|
||||
- Test generation
|
||||
|
||||
Use them together for best results.
|
||||
|
||||
### Q: What IDEs/tools support BMM?
|
||||
|
||||
**A:** BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes.
|
||||
|
||||
**Recommended Tools:**
|
||||
|
||||
- **Claude Code** - Best choice
|
||||
- Sonnet 4.5 (excellent workflow following, coding, reasoning)
|
||||
- Opus (maximum context, complex planning)
|
||||
- Native agent mode designed for BMM workflows
|
||||
|
||||
- **Cursor**
|
||||
- Supports Anthropic (Claude) and OpenAI models
|
||||
- Agent mode with composer
|
||||
- Good for developers who prefer Cursor's UX
|
||||
|
||||
- **Windsurf**
|
||||
- Multi-model support
|
||||
- Agent capabilities
|
||||
- Suitable for BMM workflows
|
||||
|
||||
**What Matters:**
|
||||
|
||||
1. **Agent mode** - Can load long workflow instructions and maintain context
|
||||
2. **High-quality LLM** - Models ranked high on SWE-bench (coding benchmarks)
|
||||
3. **Model selection** - Access to Claude Sonnet 4.5, Opus, or GPT-4o class models
|
||||
4. **Context capacity** - Can handle large planning documents and codebases
|
||||
|
||||
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
|
||||
|
||||
### Q: Can I customize agents?
|
||||
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
|
||||
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow.
|
||||
|
||||
### Q: What happens to my planning docs after implementation?
|
||||
|
||||
**A:** Keep them! They serve as:
|
||||
|
||||
- Historical record of decisions
|
||||
- Onboarding material for new team members
|
||||
- Reference for future enhancements
|
||||
- Audit trail for compliance
|
||||
|
||||
For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean.
|
||||
|
||||
### Q: Can I use BMM for non-software projects?
|
||||
|
||||
**A:** BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Questions
|
||||
|
||||
### Q: What if my project grows from Level 1 to Level 3?
|
||||
|
||||
**A:** Totally fine! When you realize scope has grown:
|
||||
|
||||
1. Run create-prd to add product-level planning
|
||||
2. Run create-architecture for system design
|
||||
3. Use existing tech-spec as input for PRD
|
||||
4. Continue with updated level
|
||||
|
||||
The system is flexible - growth is expected.
|
||||
|
||||
### Q: Can I mix greenfield and brownfield approaches?
|
||||
|
||||
**A:** Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach:
|
||||
|
||||
1. Run document-project for brownfield context
|
||||
2. Use greenfield workflows for new feature planning
|
||||
3. Explicitly document integration points between new and existing
|
||||
4. Test integration thoroughly
|
||||
|
||||
### Q: How do I handle urgent hotfixes during a sprint?
|
||||
|
||||
**A:** Use correct-course workflow or just:
|
||||
|
||||
1. Save your current work state
|
||||
2. Load PM agent → quick tech-spec for hotfix
|
||||
3. Implement hotfix (Level 0 flow)
|
||||
4. Deploy hotfix
|
||||
5. Return to original sprint work
|
||||
|
||||
Level 0 Quick Spec Flow is perfect for urgent fixes.
|
||||
|
||||
### Q: What if I disagree with the workflow's recommendations?
|
||||
|
||||
**A:** Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context:
|
||||
|
||||
- Explain your reasoning to the agent
|
||||
- Ask for alternative approaches
|
||||
- Skip the recommendation if you're confident
|
||||
- Document why you deviated (for future reference)
|
||||
|
||||
Trust your expertise - BMM supports your decisions.
|
||||
|
||||
### Q: Can multiple developers work on the same BMM project?
|
||||
|
||||
**A:** Yes! But the paradigm is fundamentally different from traditional agile teams.
|
||||
|
||||
**Key Difference:**
|
||||
|
||||
- **Traditional:** Multiple devs work on stories within one epic (months)
|
||||
- **Agentic:** Each dev owns complete epics (days)
|
||||
|
||||
**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories.
|
||||
|
||||
**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days.
|
||||
|
||||
**Team Work Distribution:**
|
||||
|
||||
- **Recommended:** Split work by **epic** (not story)
|
||||
- Each developer owns complete epics end-to-end
|
||||
- Parallel work happens at epic level
|
||||
- Minimal coordination needed
|
||||
|
||||
**For full-stack apps:**
|
||||
|
||||
- Frontend and backend can be separate epics (unusual in traditional agile)
|
||||
- Frontend dev owns all frontend epics
|
||||
- Backend dev owns all backend epics
|
||||
- Works because delivery is so fast
|
||||
|
||||
**Enterprise Considerations:**
|
||||
|
||||
- Use **git submodules** for BMM installation (not .gitignore)
|
||||
- Allows personal configurations without polluting main repo
|
||||
- Teams may use different AI tools (Claude Code, Cursor, etc.)
|
||||
- Developers may follow different methods or create custom agents/workflows
|
||||
|
||||
**Quick Tips:**
|
||||
|
||||
- Share `sprint-status.yaml` (single source of truth)
|
||||
- Assign entire epics to developers (not individual stories)
|
||||
- Coordinate at epic boundaries, not story level
|
||||
- Use git submodules for BMM in enterprise settings
|
||||
|
||||
### Q: What is party mode and when should I use it?
|
||||
|
||||
**A:** Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time.
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent)
|
||||
2. Introduce your topic
|
||||
3. BMad Master selects 2-3 most relevant agents per message
|
||||
4. Agents cross-talk, debate, and build on each other's ideas
|
||||
|
||||
**Best for:**
|
||||
|
||||
- Strategic decisions with trade-offs (architecture choices, tech stack, scope)
|
||||
- Creative brainstorming (game design, product innovation, UX ideation)
|
||||
- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions)
|
||||
- Complex problem-solving (multi-faceted challenges, risk assessment)
|
||||
|
||||
**Example parties:**
|
||||
|
||||
- **Product Strategy:** PM + Innovation Strategist (CIS) + Analyst
|
||||
- **Technical Design:** Architect + Creative Problem Solver (CIS) + Game Architect
|
||||
- **User Experience:** UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
|
||||
|
||||
**Why it's powerful:**
|
||||
|
||||
- Diverse perspectives (technical, creative, strategic)
|
||||
- Healthy debate reveals blind spots
|
||||
- Emergent insights from agent interaction
|
||||
- Natural collaboration across modules
|
||||
|
||||
**For complete documentation:**
|
||||
|
||||
👉 **[Party Mode Guide](../../explanation/features/party-mode.md)** - How it works, when to use it, example compositions, best practices
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Q: Where do I get help if my question isn't answered here?
|
||||
|
||||
**A:**
|
||||
|
||||
1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics
|
||||
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help)
|
||||
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)
|
||||
|
||||
### Q: How do I report a bug or request a feature?
|
||||
|
||||
**A:** Open a GitHub issue at: <https://github.com/bmad-code-org/BMAD-METHOD/issues>
|
||||
|
||||
Please include:
|
||||
|
||||
- BMM version (check your installed version)
|
||||
- Steps to reproduce (for bugs)
|
||||
- Expected vs actual behavior
|
||||
- Relevant workflow or agent involved
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,68 +0,0 @@
|
||||
---
|
||||
title: "Workflows FAQ"
|
||||
description: Common questions about BMad Method workflows and phases
|
||||
---
|
||||
|
||||
|
||||
Quick answers to common questions about BMad Method workflows and phases.
|
||||
|
||||
---
|
||||
|
||||
## Q: What's the difference between workflow-status and workflow-init?
|
||||
|
||||
**A:**
|
||||
|
||||
- **workflow-status:** Checks existing status and tells you what's next (use when continuing work)
|
||||
- **workflow-init:** Creates new status file and sets up project (use when starting new project)
|
||||
|
||||
If status file exists, use workflow-status. If not, use workflow-init.
|
||||
|
||||
## Q: Can I skip Phase 1 (Analysis)?
|
||||
|
||||
**A:** Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if:
|
||||
|
||||
- Requirements are clear
|
||||
- No research needed
|
||||
- Time-sensitive work
|
||||
- Small changes (Level 0-1)
|
||||
|
||||
## Q: When is Phase 3 (Architecture) required?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Level 0-1:** Never (skip entirely)
|
||||
- **Level 2:** Optional (only if system design needed)
|
||||
- **Level 3-4:** Required (comprehensive architecture mandatory)
|
||||
|
||||
## Q: What happens if I skip a recommended workflow?
|
||||
|
||||
**A:** Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause:
|
||||
|
||||
- Integration issues during implementation
|
||||
- Rework due to poor planning
|
||||
- Conflicting design decisions
|
||||
- Longer development time overall
|
||||
|
||||
## Q: How do I know when Phase 3 is complete and I can start Phase 4?
|
||||
|
||||
**A:** For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4.
|
||||
|
||||
## Q: Can I run workflows in parallel or do they have to be sequential?
|
||||
|
||||
**A:** Most workflows must be sequential within a phase:
|
||||
|
||||
- Phase 1: brainstorm → research → product-brief (optional order)
|
||||
- Phase 2: PRD must complete before moving forward
|
||||
- Phase 3: architecture → epics+stories → implementation-readiness (sequential)
|
||||
- Phase 4: Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@@ -1,108 +0,0 @@
|
||||
---
|
||||
title: "Advanced Elicitation"
|
||||
---
|
||||
|
||||
|
||||
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
|
||||
|
||||
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- After a workflow generates a section of content and you want to explore alternatives
|
||||
- When the LLM's initial output seems adequate but you suspect there's more depth available
|
||||
- For high-stakes content where multiple perspectives would strengthen the result
|
||||
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
||||
- When you want the LLM to "think again" but with structured reasoning methods
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Context Analysis
|
||||
The LLM analyzes the current content, understanding its type, complexity, stakeholder needs, risk level, and creative potential.
|
||||
|
||||
### 2. Smart Method Selection
|
||||
Based on context, 5 methods are intelligently selected from a library of 50+ techniques and presented to you:
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ---------------------------------------- |
|
||||
| **1-5** | Apply the selected method to the content |
|
||||
| **[r] Reshuffle** | Get 5 new methods selected randomly |
|
||||
| **[a] List All** | Browse the complete method library |
|
||||
| **[x] Proceed** | Continue with enhanced content |
|
||||
|
||||
### 3. Method Execution & Iteration
|
||||
- The selected method is applied to the current content
|
||||
- Improvements are shown for your review
|
||||
- You choose whether to apply changes or discard them
|
||||
- The menu re-appears for additional elicitations
|
||||
- Each method builds on previous enhancements
|
||||
|
||||
### 4. Party Mode Integration (Optional)
|
||||
If Party Mode is active, BMAD agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
||||
|
||||
---
|
||||
|
||||
## Method Categories
|
||||
|
||||
| Category | Focus | Example Methods |
|
||||
| ----------------- | ----------------------------------- | -------------------------------------------------------------- |
|
||||
| **Core** | Foundational reasoning techniques | First Principles Analysis, 5 Whys, Socratic Questioning |
|
||||
| **Collaboration** | Multiple perspectives and synthesis | Stakeholder Round Table, Expert Panel Review, Debate Club |
|
||||
| **Advanced** | Complex reasoning frameworks | Tree of Thoughts, Graph of Thoughts, Self-Consistency |
|
||||
| **Competitive** | Adversarial stress-testing | Red Team vs Blue Team, Shark Tank Pitch, Code Review Gauntlet |
|
||||
| **Technical** | Architecture and code quality | Decision Records, Rubber Duck Debugging, Algorithm Olympics |
|
||||
| **Creative** | Innovation and lateral thinking | SCAMPER, Reverse Engineering, Random Input Stimulus |
|
||||
| **Research** | Evidence-based analysis | Literature Review Personas, Thesis Defense, Comparative Matrix |
|
||||
| **Risk** | Risk identification and mitigation | Pre-mortem Analysis, Failure Mode Analysis, Chaos Monkey |
|
||||
| **Learning** | Understanding verification | Feynman Technique, Active Recall Testing |
|
||||
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
||||
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
||||
- **Smart context selection** — Methods chosen based on content type, complexity, and stakeholder needs
|
||||
- **Iterative enhancement** — Each method builds on previous improvements
|
||||
- **User control** — Accept or discard each enhancement before proceeding
|
||||
- **Party Mode integration** — Agents can participate when Party Mode is active
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
||||
|
||||
| Parameter | Description |
|
||||
| ---------------------- | --------------------------------------------------------- |
|
||||
| **Content to enhance** | The current section content that was just generated |
|
||||
| **Context type** | The kind of content being created (spec, code, doc, etc.) |
|
||||
| **Enhancement goals** | What the calling workflow wants to improve |
|
||||
|
||||
### Integration Flow
|
||||
|
||||
When called from a workflow:
|
||||
1. Receives the current section content that was just generated
|
||||
2. Applies elicitation methods iteratively to enhance that content
|
||||
3. Returns the enhanced version when user selects 'x' to proceed
|
||||
4. The enhanced content replaces the original section in the output document
|
||||
|
||||
### Example
|
||||
|
||||
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Elicitation vs. Brainstorming
|
||||
|
||||
| | **Advanced Elicitation** | **Brainstorming** |
|
||||
| ------------ | ------------------------------------------------- | --------------------------------------------- |
|
||||
| **Source** | LLM generates ideas through structured reasoning | User provides ideas, AI coaches them out |
|
||||
| **Purpose** | Rethink and improve LLM's own output | Unlock user's creativity |
|
||||
| **Methods** | 50+ reasoning and analysis techniques | 60+ ideation and creativity techniques |
|
||||
| **Best for** | Enhancing generated content, finding alternatives | Breaking through blocks, generating new ideas |
|
||||
@@ -1,103 +0,0 @@
|
||||
---
|
||||
title: "Brainstorming"
|
||||
---
|
||||
|
||||
|
||||
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
|
||||
|
||||
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner—using proven techniques to draw out ideas and insights that are already within you.
|
||||
|
||||
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Breaking through creative blocks on a specific challenge
|
||||
- Generating innovative ideas for products, features, or solutions
|
||||
- Exploring a problem from completely new angles
|
||||
- Systematically developing ideas from raw concepts to actionable plans
|
||||
- Team ideation (with collaborative techniques) or personal creative exploration
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Session Setup
|
||||
Define your topic, goals, and any constraints.
|
||||
|
||||
### 2. Choose Your Approach
|
||||
|
||||
| Approach | Description |
|
||||
|----------|-------------|
|
||||
| **User-Selected** | Browse the full technique library and pick what appeals to you |
|
||||
| **AI-Recommended** | Get customized technique suggestions based on your goals |
|
||||
| **Random Selection** | Discover unexpected methods through serendipitous technique combinations |
|
||||
| **Progressive Flow** | Journey systematically from expansive exploration to focused action planning |
|
||||
|
||||
### 3. Interactive Facilitation
|
||||
Work through techniques with true collaborative coaching. The AI asks probing questions, builds on your ideas, and helps you think deeper—but your ideas are the source.
|
||||
|
||||
### 4. Idea Organization
|
||||
All your generated ideas are organized into themes and prioritized.
|
||||
|
||||
### 5. Action Planning
|
||||
Top ideas get concrete next steps, resource requirements, and success metrics.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A comprehensive session document that captures the entire journey:
|
||||
|
||||
- Topic, goals, and session parameters
|
||||
- Each technique used and how it was applied
|
||||
- Your contributions and the ideas you generated
|
||||
- Thematic organization connecting related insights
|
||||
- Prioritized ideas with action plans
|
||||
- Session highlights and key breakthroughs
|
||||
|
||||
This document becomes a permanent record of your creative process—valuable for future reference, sharing with stakeholders, or continuing the session later.
|
||||
|
||||
---
|
||||
|
||||
## Technique Categories
|
||||
|
||||
| Category | Focus |
|
||||
|----------|-------|
|
||||
| **Collaborative** | Team dynamics and inclusive participation |
|
||||
| **Creative** | Breakthrough thinking and paradigm shifts |
|
||||
| **Deep** | Root cause analysis and strategic insight |
|
||||
| **Structured** | Organized frameworks and systematic exploration |
|
||||
| **Theatrical** | Playful, radical perspectives |
|
||||
| **Wild** | Boundary-pushing, extreme thinking |
|
||||
| **Biomimetic** | Nature-inspired solutions |
|
||||
| **Quantum** | Quantum principles for innovation |
|
||||
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
||||
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
||||
- **On-demand loading** — Techniques loaded from a comprehensive library as needed
|
||||
- **Session preservation** — Every step, insight, and action plan is documented
|
||||
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| **Topic focus** | What the brainstorming should help discover or solve |
|
||||
| **Guardrails** | Constraints, boundaries, or must-avoid areas |
|
||||
| **Output goals** | What the final output needs to accomplish for the calling workflow |
|
||||
| **Context files** | Project-specific guidance to inform technique selection |
|
||||
|
||||
### Example
|
||||
|
||||
When creating a new module in the BMad Builder workflow, Brainstorming can be invoked with guardrails around the module's purpose and a goal to discover key features, user needs, or architectural considerations. The session becomes focused on producing exactly what the module creation workflow needs.
|
||||
@@ -1,112 +0,0 @@
|
||||
---
|
||||
title: "Party Mode: Multi-Agent Collaboration"
|
||||
---
|
||||
|
||||
|
||||
**Get all your AI agents in one conversation**
|
||||
|
||||
## What is Party Mode?
|
||||
|
||||
Ever wanted to gather your entire AI team in one room and see what happens? That's party mode.
|
||||
|
||||
Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at key workflow junctions when asked), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer and more that you can choose from.
|
||||
|
||||
**Why it's useful:**
|
||||
|
||||
- **After complex workflows** - Debrief with the whole team about what worked, what didn't
|
||||
- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously
|
||||
- **Brainstorming sessions** - Watch ideas evolve through cross-pollination
|
||||
- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic)
|
||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
**The basics:**
|
||||
|
||||
1. Party mode reads `_bmad/_config/agent-manifest.csv`
|
||||
2. Loads ALL installed agents (already includes your customizations from install)
|
||||
3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic
|
||||
4. Agents respond in character, can agree/disagree/build on each other's ideas
|
||||
5. Discussion continues until you type "exit" or reach natural conclusion
|
||||
|
||||
**That's it.** No complex merging, no runtime magic. Just agents talking.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
/bmad:core:workflows:party-mode
|
||||
|
||||
*party-mode
|
||||
|
||||
|
||||
/bmad:core:workflows:party-mode and include also in the party Santa Clause and Einstein
|
||||
|
||||
Ask questions, respond to agents, direct the conversation
|
||||
|
||||
Type: exit
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Fun Examples
|
||||
|
||||
### Example 1: Calling Out Bad Architecture
|
||||
|
||||
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
||||
|
||||
**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
||||
|
||||
**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
||||
|
||||
**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
||||
|
||||
**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
||||
|
||||
_(Watch them debate whose fault it really was - it's therapeutic)_
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Creative Brainstorming
|
||||
|
||||
**You:** "How do we make onboarding feel magical instead of boring?"
|
||||
|
||||
**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
||||
|
||||
**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
||||
|
||||
**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges."
|
||||
|
||||
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
||||
|
||||
_(Ideas cross-pollinate and evolve)_
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Technical Decision
|
||||
|
||||
**You:** "Monolith or microservices for MVP?"
|
||||
|
||||
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
||||
|
||||
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
||||
|
||||
**DEV:** "Monolith with clear module boundaries. We can extract services later if needed."
|
||||
|
||||
**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right."
|
||||
|
||||
_(Multiple perspectives reveal the right answer)_
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Agents Reference](../../reference/agents/index.md) - Complete agent reference
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
||||
- [Setup Party Mode](../../how-to/workflows/setup-party-mode.md) - How to use it
|
||||
|
||||
---
|
||||
|
||||
_Better decisions through diverse perspectives. Welcome to party mode._
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
title: "Quick Spec Flow"
|
||||
description: Understanding Quick Spec Flow for rapid development in BMad Method
|
||||
---
|
||||
|
||||
|
||||
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
|
||||
|
||||
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
||||
|
||||
**Time to implementation:** Minutes, not hours
|
||||
|
||||
---
|
||||
|
||||
## When to Use Quick Flow
|
||||
|
||||
### ✅ Use Quick Flow when:
|
||||
|
||||
- Single bug fix or small enhancement
|
||||
- Small feature with clear scope (typically 1-15 stories)
|
||||
- Rapid prototyping or experimentation
|
||||
- Adding to existing brownfield codebase
|
||||
- You know exactly what you want to build
|
||||
|
||||
### ❌ Use BMad Method or Enterprise when:
|
||||
|
||||
- Building new products or major features
|
||||
- Need stakeholder alignment
|
||||
- Complex multi-team coordination
|
||||
- Requires extensive planning and architecture
|
||||
|
||||
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
||||
|
||||
---
|
||||
|
||||
## Quick Flow Overview
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START[Step 1: Run Tech-Spec Workflow]
|
||||
DETECT[Detects project stack]
|
||||
ANALYZE[Analyzes brownfield codebase]
|
||||
TEST[Detects test frameworks]
|
||||
CONFIRM[Confirms conventions]
|
||||
GENERATE[Generates context-rich tech-spec]
|
||||
STORIES[Creates ready-to-implement stories]
|
||||
IMPL[Step 2: Implement with DEV Agent]
|
||||
DONE[DONE!]
|
||||
|
||||
START --> DETECT
|
||||
DETECT --> ANALYZE
|
||||
ANALYZE --> TEST
|
||||
TEST --> CONFIRM
|
||||
CONFIRM --> GENERATE
|
||||
GENERATE --> STORIES
|
||||
STORIES --> IMPL
|
||||
IMPL --> DONE
|
||||
|
||||
style START fill:#bfb,stroke:#333,stroke-width:2px
|
||||
style IMPL fill:#bbf,stroke:#333,stroke-width:2px
|
||||
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What Makes It Quick
|
||||
|
||||
- ✅ No Product Brief needed
|
||||
- ✅ No PRD needed
|
||||
- ✅ No Architecture doc needed
|
||||
- ✅ Auto-detects your stack
|
||||
- ✅ Auto-analyzes brownfield code
|
||||
- ✅ Auto-validates quality
|
||||
- ✅ Story context optional (tech-spec is comprehensive!)
|
||||
|
||||
---
|
||||
|
||||
## Smart Context Discovery
|
||||
|
||||
Quick Spec Flow automatically discovers and uses:
|
||||
|
||||
### Existing Documentation
|
||||
- Product briefs (if they exist)
|
||||
- Research documents
|
||||
- `document-project` output (brownfield codebase map)
|
||||
|
||||
### Project Stack
|
||||
- **Node.js:** package.json → frameworks, dependencies, scripts
|
||||
- **Python:** requirements.txt, pyproject.toml → packages, tools
|
||||
- **Ruby:** Gemfile → gems and versions
|
||||
- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies
|
||||
- **Go:** go.mod → modules
|
||||
- **Rust:** Cargo.toml → crates
|
||||
|
||||
### Brownfield Code Patterns
|
||||
- Directory structure and organization
|
||||
- Existing code patterns (class-based, functional, MVC)
|
||||
- Naming conventions
|
||||
- Test frameworks and patterns
|
||||
- Code style configurations
|
||||
|
||||
### Convention Confirmation
|
||||
|
||||
Quick Spec Flow detects your conventions and **asks for confirmation**:
|
||||
|
||||
```
|
||||
I've detected these conventions in your codebase:
|
||||
|
||||
Code Style:
|
||||
- ESLint with Airbnb config
|
||||
- Prettier with single quotes
|
||||
|
||||
Test Patterns:
|
||||
- Jest test framework
|
||||
- .test.js file naming
|
||||
|
||||
Should I follow these existing conventions? (yes/no)
|
||||
```
|
||||
|
||||
**You decide:** Conform to existing patterns or establish new standards!
|
||||
|
||||
---
|
||||
|
||||
## Auto-Validation
|
||||
|
||||
Quick Spec Flow **automatically validates** everything:
|
||||
|
||||
- ✅ Context gathering completeness
|
||||
- ✅ Definitiveness (no "use X or Y" statements)
|
||||
- ✅ Brownfield integration quality
|
||||
- ✅ Stack alignment
|
||||
- ✅ Implementation readiness
|
||||
|
||||
---
|
||||
|
||||
## Comparison: Quick Flow vs Full BMM
|
||||
|
||||
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
||||
| --------------------- | ---------------------------- | ---------------------------------- |
|
||||
| **Setup** | None (standalone) | workflow-init recommended |
|
||||
| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture |
|
||||
| **Time to Code** | Minutes | Hours to days |
|
||||
| **Best For** | Bug fixes, small features | New products, major features |
|
||||
| **Context Discovery** | Automatic | Manual + guided |
|
||||
| **Validation** | Auto-validates everything | Manual validation steps |
|
||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
||||
|
||||
---
|
||||
|
||||
## When to Graduate to BMad Method
|
||||
|
||||
Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
- ❌ Project grows beyond initial scope
|
||||
- ❌ Multiple teams need coordination
|
||||
- ❌ Stakeholders need formal documentation
|
||||
- ❌ Product vision is unclear
|
||||
- ❌ Architectural decisions need deep analysis
|
||||
- ❌ Compliance/regulatory requirements exist
|
||||
|
||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Tech Spec](../../how-to/workflows/create-tech-spec.md) - How to use Quick Flow
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started
|
||||
- [Four Phases](../architecture/four-phases.md) - Understanding the full methodology
|
||||
@@ -1,218 +0,0 @@
|
||||
---
|
||||
title: "Test Architect (TEA) Overview"
|
||||
description: Understanding the Test Architect (TEA) agent and its role in BMad Method
|
||||
---
|
||||
|
||||
|
||||
The Test Architect (TEA) is a specialized agent focused on quality strategy, test automation, and release gates in BMad Method projects.
|
||||
|
||||
## Overview
|
||||
|
||||
- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
|
||||
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
|
||||
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
|
||||
|
||||
---
|
||||
|
||||
## Choose Your TEA Engagement Model
|
||||
|
||||
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
|
||||
|
||||
1. **No TEA**
|
||||
- Skip all TEA workflows. Use your existing team testing approach.
|
||||
|
||||
2. **TEA-only (Standalone)**
|
||||
- Use TEA on a non-BMad project. Bring your own requirements, acceptance criteria, and environments.
|
||||
- Typical sequence: `*test-design` (system or epic) -> `*atdd` and/or `*automate` -> optional `*test-review` -> `*trace` for coverage and gate decisions.
|
||||
- Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline.
|
||||
|
||||
3. **Integrated: Greenfield - BMad Method (Simple/Standard Work)**
|
||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
||||
- Phase 4: per-epic `*test-design`, optional `*atdd`, then `*automate` and optional `*test-review`.
|
||||
- Gate (Phase 2): `*trace`.
|
||||
|
||||
4. **Integrated: Brownfield - BMad Method or Enterprise (Simple or Complex)**
|
||||
- Phase 2: baseline `*trace`.
|
||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
||||
- Phase 4: per-epic `*test-design` focused on regression and integration risks.
|
||||
- Gate (Phase 2): `*trace`; `*nfr-assess` (if not done earlier).
|
||||
- For brownfield BMad Method, follow the same flow with `*nfr-assess` optional.
|
||||
|
||||
5. **Integrated: Greenfield - Enterprise Method (Enterprise/Compliance Work)**
|
||||
- Phase 2: `*nfr-assess`.
|
||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
||||
- Phase 4: per-epic `*test-design`, plus `*atdd`/`*automate`/`*test-review`.
|
||||
- Gate (Phase 2): `*trace`; archive artifacts as needed.
|
||||
|
||||
If you are unsure, default to the integrated path for your track and adjust later.
|
||||
|
||||
---
|
||||
|
||||
## TEA Workflow Lifecycle
|
||||
|
||||
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
subgraph Phase2["<b>Phase 2: PLANNING</b>"]
|
||||
PM["<b>PM: *prd (creates PRD with FRs/NFRs)</b>"]
|
||||
PlanNote["<b>Business requirements phase</b>"]
|
||||
NFR2["<b>TEA: *nfr-assess (optional, enterprise)</b>"]
|
||||
PM -.-> NFR2
|
||||
NFR2 -.-> PlanNote
|
||||
PM -.-> PlanNote
|
||||
end
|
||||
|
||||
subgraph Phase3["<b>Phase 3: SOLUTIONING</b>"]
|
||||
Architecture["<b>Architect: *architecture</b>"]
|
||||
EpicsStories["<b>PM/Architect: *create-epics-and-stories</b>"]
|
||||
TestDesignSys["<b>TEA: *test-design (system-level)</b>"]
|
||||
Framework["<b>TEA: *framework (optional if needed)</b>"]
|
||||
CI["<b>TEA: *ci (optional if needed)</b>"]
|
||||
GateCheck["<b>Architect: *implementation-readiness</b>"]
|
||||
Architecture --> EpicsStories
|
||||
Architecture --> TestDesignSys
|
||||
TestDesignSys --> Framework
|
||||
EpicsStories --> Framework
|
||||
Framework --> CI
|
||||
CI --> GateCheck
|
||||
Phase3Note["<b>Epics created AFTER architecture,</b><br/><b>then system-level test design and test infrastructure setup</b>"]
|
||||
EpicsStories -.-> Phase3Note
|
||||
end
|
||||
|
||||
subgraph Phase4["<b>Phase 4: IMPLEMENTATION - Per Epic Cycle</b>"]
|
||||
SprintPlan["<b>SM: *sprint-planning</b>"]
|
||||
TestDesign["<b>TEA: *test-design (per epic)</b>"]
|
||||
CreateStory["<b>SM: *create-story</b>"]
|
||||
ATDD["<b>TEA: *atdd (optional, before dev)</b>"]
|
||||
DevImpl["<b>DEV: implements story</b>"]
|
||||
Automate["<b>TEA: *automate</b>"]
|
||||
TestReview1["<b>TEA: *test-review (optional)</b>"]
|
||||
Trace1["<b>TEA: *trace (refresh coverage)</b>"]
|
||||
|
||||
SprintPlan --> TestDesign
|
||||
TestDesign --> CreateStory
|
||||
CreateStory --> ATDD
|
||||
ATDD --> DevImpl
|
||||
DevImpl --> Automate
|
||||
Automate --> TestReview1
|
||||
TestReview1 --> Trace1
|
||||
Trace1 -.->|next story| CreateStory
|
||||
TestDesignNote["<b>Test design: 'How do I test THIS epic?'</b><br/>Creates test-design-epic-N.md per epic"]
|
||||
TestDesign -.-> TestDesignNote
|
||||
end
|
||||
|
||||
subgraph Gate["<b>EPIC/RELEASE GATE</b>"]
|
||||
NFR["<b>TEA: *nfr-assess (if not done earlier)</b>"]
|
||||
TestReview2["<b>TEA: *test-review (final audit, optional)</b>"]
|
||||
TraceGate["<b>TEA: *trace - Phase 2: Gate</b>"]
|
||||
GateDecision{"<b>Gate Decision</b>"}
|
||||
|
||||
NFR --> TestReview2
|
||||
TestReview2 --> TraceGate
|
||||
TraceGate --> GateDecision
|
||||
GateDecision -->|PASS| Pass["<b>PASS ✅</b>"]
|
||||
GateDecision -->|CONCERNS| Concerns["<b>CONCERNS ⚠️</b>"]
|
||||
GateDecision -->|FAIL| Fail["<b>FAIL ❌</b>"]
|
||||
GateDecision -->|WAIVED| Waived["<b>WAIVED ⏭️</b>"]
|
||||
end
|
||||
|
||||
Phase2 --> Phase3
|
||||
Phase3 --> Phase4
|
||||
Phase4 --> Gate
|
||||
|
||||
style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000
|
||||
style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000
|
||||
style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000
|
||||
style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000
|
||||
style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000
|
||||
style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000
|
||||
style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000
|
||||
style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000
|
||||
```
|
||||
|
||||
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and documentation prerequisite:
|
||||
|
||||
- **Documentation** (Optional for brownfield): Prerequisite using `*document-project`
|
||||
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
|
||||
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
|
||||
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
|
||||
- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows)
|
||||
|
||||
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**:
|
||||
|
||||
- **System-level (Phase 3):** Run immediately after architecture/ADR drafting to produce `test-design-system.md` (testability review, ADR → test mapping, Architecturally Significant Requirements (ASRs), environment needs). Feeds the implementation-readiness gate.
|
||||
- **Epic-level (Phase 4):** Run per-epic to produce `test-design-epic-N.md` (risk, priorities, coverage plan).
|
||||
|
||||
Quick Flow track skips Phases 1 and 3.
|
||||
BMad Method and Enterprise use all phases based on project needs.
|
||||
When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change.
|
||||
|
||||
---
|
||||
|
||||
## Why TEA is Different from Other BMM Agents
|
||||
|
||||
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
|
||||
|
||||
### Phase-Specific Agents (Standard Pattern)
|
||||
|
||||
Most BMM agents work in a single phase:
|
||||
|
||||
- **Phase 1 (Analysis)**: Analyst agent
|
||||
- **Phase 2 (Planning)**: PM agent
|
||||
- **Phase 3 (Solutioning)**: Architect agent
|
||||
- **Phase 4 (Implementation)**: SM, DEV agents
|
||||
|
||||
### TEA: Multi-Phase Quality Agent (Unique Pattern)
|
||||
|
||||
TEA is **the only agent that operates in multiple phases**:
|
||||
|
||||
```
|
||||
Phase 1 (Analysis) → [TEA not typically used]
|
||||
↓
|
||||
Phase 2 (Planning) → [PM defines requirements - TEA not active]
|
||||
↓
|
||||
Phase 3 (Solutioning) → TEA: *framework, *ci (test infrastructure AFTER architecture)
|
||||
↓
|
||||
Phase 4 (Implementation) → TEA: *test-design (per epic: "how do I test THIS feature?")
|
||||
→ TEA: *atdd, *automate, *test-review, *trace (per story)
|
||||
↓
|
||||
Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision)
|
||||
```
|
||||
|
||||
### TEA's 8 Workflows Across Phases
|
||||
|
||||
**Standard agents**: 1-3 workflows per phase
|
||||
**TEA**: 8 workflows across Phase 3, Phase 4, and Release Gate
|
||||
|
||||
| Phase | TEA Workflows | Frequency | Purpose |
|
||||
| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- |
|
||||
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
|
||||
| **Phase 3** | \*framework, \*ci | Once per project | Setup test infrastructure AFTER architecture |
|
||||
| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
|
||||
| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
|
||||
|
||||
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
|
||||
|
||||
---
|
||||
|
||||
## TEA Command Catalog
|
||||
|
||||
| Command | Primary Outputs | Notes |
|
||||
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists |
|
||||
| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) |
|
||||
| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode |
|
||||
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode |
|
||||
| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage |
|
||||
| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns |
|
||||
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability |
|
||||
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision |
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Setup Test Framework](../../how-to/workflows/setup-test-framework.md) - How to set up testing infrastructure
|
||||
- [Run Test Design](../../how-to/workflows/run-test-design.md) - Creating test plans
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
title: "Web Bundles"
|
||||
---
|
||||
|
||||
|
||||
Use BMAD agents in Gemini Gems and Custom GPTs.
|
||||
|
||||
## Status
|
||||
|
||||
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
||||
Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload.
|
||||
|
||||
### What's Included
|
||||
|
||||
- Complete agent persona and instructions
|
||||
- All workflows and dependencies
|
||||
- Interactive menu system
|
||||
- Party mode for multi-agent collaboration
|
||||
- No external files required
|
||||
|
||||
### Use Cases
|
||||
|
||||
**Perfect for:**
|
||||
- Uploading a single file to a Gemini GEM or Custom GPT
|
||||
- Using BMAD Method from the Web
|
||||
- Cost savings (generally lower cost than local usage)
|
||||
- Quick sharing of agent configurations
|
||||
|
||||
**Trade-offs:**
|
||||
- Some quality reduction vs local usage
|
||||
- Less convenient than full local installation
|
||||
- Limited to agent capabilities (no workflow file access)
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
@@ -1,410 +0,0 @@
|
||||
---
|
||||
title: "BMGD Agents Guide"
|
||||
---
|
||||
|
||||
|
||||
Complete reference for BMGD's six specialized game development agents.
|
||||
|
||||
---
|
||||
|
||||
## Agent Overview
|
||||
|
||||
BMGD provides six agents, each with distinct expertise:
|
||||
|
||||
| Agent | Name | Role | Phase Focus |
|
||||
| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- |
|
||||
| 🎲 **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 |
|
||||
| 🏛️ **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 |
|
||||
| 🕹️ **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 |
|
||||
| 🎯 **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 |
|
||||
| 🧪 **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases |
|
||||
| 🎮 **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
|
||||
|
||||
---
|
||||
|
||||
## 🎲 Game Designer (Samus Shepard)
|
||||
|
||||
### Role
|
||||
|
||||
Lead Game Designer + Creative Vision Architect
|
||||
|
||||
### Identity
|
||||
|
||||
Veteran designer with 15+ years crafting AAA and indie hits. Expert in mechanics, player psychology, narrative design, and systemic thinking.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Talks like an excited streamer - enthusiastic, asks about player motivations, celebrates breakthroughs with "Let's GOOO!"
|
||||
|
||||
### Core Principles
|
||||
|
||||
- Design what players want to FEEL, not what they say they want
|
||||
- Prototype fast - one hour of playtesting beats ten hours of discussion
|
||||
- Every mechanic must serve the core fantasy
|
||||
|
||||
### When to Use
|
||||
|
||||
- Brainstorming game ideas
|
||||
- Creating Game Briefs
|
||||
- Designing GDDs
|
||||
- Developing narrative design
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------- | -------------------------------- |
|
||||
| `workflow-status` | Check project status |
|
||||
| `brainstorm-game` | Guided game ideation |
|
||||
| `create-game-brief` | Create Game Brief |
|
||||
| `create-gdd` | Create Game Design Document |
|
||||
| `narrative` | Create Narrative Design Document |
|
||||
| `quick-prototype` | Rapid prototyping (IDE only) |
|
||||
| `party-mode` | Multi-agent collaboration |
|
||||
| `advanced-elicitation` | Deep exploration (web only) |
|
||||
|
||||
---
|
||||
|
||||
## 🏛️ Game Architect (Cloud Dragonborn)
|
||||
|
||||
### Role
|
||||
|
||||
Principal Game Systems Architect + Technical Director
|
||||
|
||||
### Identity
|
||||
|
||||
Master architect with 20+ years shipping 30+ titles. Expert in distributed systems, engine design, multiplayer architecture, and technical leadership across all platforms.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Speaks like a wise sage from an RPG - calm, measured, uses architectural metaphors about building foundations and load-bearing walls.
|
||||
|
||||
### Core Principles
|
||||
|
||||
- Architecture is about delaying decisions until you have enough data
|
||||
- Build for tomorrow without over-engineering today
|
||||
- Hours of planning save weeks of refactoring hell
|
||||
- Every system must handle the hot path at 60fps
|
||||
|
||||
### When to Use
|
||||
|
||||
- Planning technical architecture
|
||||
- Making engine/framework decisions
|
||||
- Designing game systems
|
||||
- Course correction during development
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------- | ------------------------------------- |
|
||||
| `workflow-status` | Check project status |
|
||||
| `create-architecture` | Create Game Architecture |
|
||||
| `correct-course` | Course correction analysis (IDE only) |
|
||||
| `party-mode` | Multi-agent collaboration |
|
||||
| `advanced-elicitation` | Deep exploration (web only) |
|
||||
|
||||
---
|
||||
|
||||
## 🕹️ Game Developer (Link Freeman)
|
||||
|
||||
### Role
|
||||
|
||||
Senior Game Developer + Technical Implementation Specialist
|
||||
|
||||
### Identity
|
||||
|
||||
Battle-hardened dev with expertise in Unity, Unreal, and custom engines. Ten years shipping across mobile, console, and PC. Writes clean, performant code.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Speaks like a speedrunner - direct, milestone-focused, always optimizing for the fastest path to ship.
|
||||
|
||||
### Core Principles
|
||||
|
||||
- 60fps is non-negotiable
|
||||
- Write code designers can iterate without fear
|
||||
- Ship early, ship often, iterate on player feedback
|
||||
- Red-green-refactor: tests first, implementation second
|
||||
|
||||
### When to Use
|
||||
|
||||
- Implementing stories
|
||||
- Code reviews
|
||||
- Performance optimization
|
||||
- Completing story work
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------- | ------------------------------- |
|
||||
| `workflow-status` | Check sprint progress |
|
||||
| `dev-story` | Implement story tasks |
|
||||
| `code-review` | Perform code review |
|
||||
| `quick-dev` | Flexible development (IDE only) |
|
||||
| `quick-prototype` | Rapid prototyping (IDE only) |
|
||||
| `party-mode` | Multi-agent collaboration |
|
||||
| `advanced-elicitation` | Deep exploration (web only) |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Game Scrum Master (Max)
|
||||
|
||||
### Role
|
||||
|
||||
Game Development Scrum Master + Sprint Orchestrator
|
||||
|
||||
### Identity
|
||||
|
||||
Certified Scrum Master specializing in game dev workflows. Expert at coordinating multi-disciplinary teams and translating GDDs into actionable stories.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Talks in game terminology - milestones are save points, handoffs are level transitions, blockers are boss fights.
|
||||
|
||||
### Core Principles
|
||||
|
||||
- Every sprint delivers playable increments
|
||||
- Clean separation between design and implementation
|
||||
- Keep the team moving through each phase
|
||||
- Stories are single source of truth for implementation
|
||||
|
||||
### When to Use
|
||||
|
||||
- Sprint planning and management
|
||||
- Creating epic tech specs
|
||||
- Writing story drafts
|
||||
- Assembling story context
|
||||
- Running retrospectives
|
||||
- Handling course corrections
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ----------------------- | ------------------------------------------- |
|
||||
| `workflow-status` | Check project status |
|
||||
| `sprint-planning` | Generate/update sprint status |
|
||||
| `sprint-status` | View sprint progress, get next action |
|
||||
| `create-story` | Create story (marks ready-for-dev directly) |
|
||||
| `validate-create-story` | Validate story draft |
|
||||
| `epic-retrospective` | Facilitate retrospective |
|
||||
| `correct-course` | Navigate significant changes |
|
||||
| `party-mode` | Multi-agent collaboration |
|
||||
| `advanced-elicitation` | Deep exploration (web only) |
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Game QA (GLaDOS)
|
||||
|
||||
### Role
|
||||
|
||||
Game QA Architect + Test Automation Specialist
|
||||
|
||||
### Identity
|
||||
|
||||
Senior QA architect with 12+ years in game testing across Unity, Unreal, and Godot. Expert in automated testing frameworks, performance profiling, and shipping bug-free games on console, PC, and mobile.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Speaks like a quality guardian - methodical, data-driven, but understands that "feel" matters in games. Uses metrics to back intuition. "Trust, but verify with tests."
|
||||
|
||||
### Core Principles
|
||||
|
||||
- Test what matters: gameplay feel, performance, progression
|
||||
- Automated tests catch regressions, humans catch fun problems
|
||||
- Every shipped bug is a process failure, not a people failure
|
||||
- Flaky tests are worse than no tests - they erode trust
|
||||
- Profile before optimize, test before ship
|
||||
|
||||
### When to Use
|
||||
|
||||
- Setting up test frameworks
|
||||
- Designing test strategies
|
||||
- Creating automated tests
|
||||
- Planning playtesting sessions
|
||||
- Performance testing
|
||||
- Reviewing test coverage
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------- | --------------------------------------------------- |
|
||||
| `workflow-status` | Check project status |
|
||||
| `test-framework` | Initialize game test framework (Unity/Unreal/Godot) |
|
||||
| `test-design` | Create comprehensive game test scenarios |
|
||||
| `automate` | Generate automated game tests |
|
||||
| `playtest-plan` | Create structured playtesting plan |
|
||||
| `performance-test` | Design performance testing strategy |
|
||||
| `test-review` | Review test quality and coverage |
|
||||
| `party-mode` | Multi-agent collaboration |
|
||||
| `advanced-elicitation` | Deep exploration (web only) |
|
||||
|
||||
### Knowledge Base
|
||||
|
||||
GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-index.csv`) including:
|
||||
|
||||
**Engine-Specific Testing:**
|
||||
|
||||
- Unity Test Framework (Edit Mode, Play Mode)
|
||||
- Unreal Automation and Gauntlet
|
||||
- Godot GUT (Godot Unit Test)
|
||||
|
||||
**Game-Specific Testing:**
|
||||
|
||||
- Playtesting fundamentals
|
||||
- Balance testing
|
||||
- Save system testing
|
||||
- Multiplayer/network testing
|
||||
- Input testing
|
||||
- Platform certification (TRC/XR)
|
||||
- Localization testing
|
||||
|
||||
**General QA:**
|
||||
|
||||
- QA automation strategies
|
||||
- Performance testing
|
||||
- Regression testing
|
||||
- Smoke testing
|
||||
- Test prioritization (P0-P3)
|
||||
|
||||
---
|
||||
|
||||
## 🎮 Game Solo Dev (Indie)
|
||||
|
||||
### Role
|
||||
|
||||
Elite Indie Game Developer + Quick Flow Specialist
|
||||
|
||||
### Identity
|
||||
|
||||
Battle-hardened solo game developer who ships complete games from concept to launch. Expert in Unity, Unreal, and Godot, having shipped titles across mobile, PC, and console. Lives and breathes the Quick Flow workflow - prototyping fast, iterating faster, and shipping before the hype dies.
|
||||
|
||||
### Communication Style
|
||||
|
||||
Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and player experience. Every response moves the game closer to ship. "Does it feel good? Ship it."
|
||||
|
||||
### Core Principles
|
||||
|
||||
- Prototype fast, fail fast, iterate faster
|
||||
- A playable build beats a perfect design doc
|
||||
- 60fps is non-negotiable - performance is a feature
|
||||
- The core loop must be fun before anything else matters
|
||||
- Ship early, playtest often
|
||||
|
||||
### When to Use
|
||||
|
||||
- Solo game development
|
||||
- Rapid prototyping
|
||||
- Quick iteration without full team workflow
|
||||
- Indie projects with tight timelines
|
||||
- When you want to handle everything yourself
|
||||
|
||||
### Available Commands
|
||||
|
||||
| Command | Description |
|
||||
| ------------------ | ------------------------------------------------------ |
|
||||
| `quick-prototype` | Rapid prototype to test if a mechanic is fun |
|
||||
| `quick-dev` | Implement features end-to-end with game considerations |
|
||||
| `create-tech-spec` | Create implementation-ready technical spec |
|
||||
| `code-review` | Review code quality |
|
||||
| `test-framework` | Set up automated testing |
|
||||
| `party-mode` | Bring in specialists when needed |
|
||||
|
||||
### Quick Flow vs Full BMGD
|
||||
|
||||
Use **Game Solo Dev** when:
|
||||
|
||||
- You're working alone or in a tiny team
|
||||
- Speed matters more than process
|
||||
- You want to skip the full planning phases
|
||||
- You're prototyping or doing game jams
|
||||
|
||||
Use **Full BMGD workflow** when:
|
||||
|
||||
- You have a larger team
|
||||
- The project needs formal documentation
|
||||
- You're working with stakeholders/publishers
|
||||
- Long-term maintainability is critical
|
||||
|
||||
---
|
||||
|
||||
## Agent Selection Guide
|
||||
|
||||
### By Phase
|
||||
|
||||
| Phase | Primary Agent | Secondary Agent |
|
||||
| ------------------------------ | ----------------- | ----------------- |
|
||||
| 1: Preproduction | Game Designer | - |
|
||||
| 2: Design | Game Designer | - |
|
||||
| 3: Technical | Game Architect | Game QA |
|
||||
| 4: Production (Planning) | Game Scrum Master | Game Architect |
|
||||
| 4: Production (Implementation) | Game Developer | Game Scrum Master |
|
||||
| Testing (Any Phase) | Game QA | Game Developer |
|
||||
|
||||
### By Task
|
||||
|
||||
| Task | Best Agent |
|
||||
| -------------------------------- | ----------------- |
|
||||
| "I have a game idea" | Game Designer |
|
||||
| "Help me design my game" | Game Designer |
|
||||
| "How should I build this?" | Game Architect |
|
||||
| "What's the technical approach?" | Game Architect |
|
||||
| "Plan our sprints" | Game Scrum Master |
|
||||
| "Create implementation stories" | Game Scrum Master |
|
||||
| "Build this feature" | Game Developer |
|
||||
| "Review this code" | Game Developer |
|
||||
| "Set up testing framework" | Game QA |
|
||||
| "Create test plan" | Game QA |
|
||||
| "Test performance" | Game QA |
|
||||
| "Plan a playtest" | Game QA |
|
||||
| "I'm working solo" | Game Solo Dev |
|
||||
| "Quick prototype this idea" | Game Solo Dev |
|
||||
| "Ship this feature fast" | Game Solo Dev |
|
||||
|
||||
---
|
||||
|
||||
## Multi-Agent Collaboration
|
||||
|
||||
### Party Mode
|
||||
|
||||
All agents have access to `party-mode`, which brings multiple agents together for complex decisions. Use this when:
|
||||
|
||||
- A decision spans multiple domains (design + technical)
|
||||
- You want diverse perspectives
|
||||
- You're stuck and need fresh ideas
|
||||
|
||||
### Handoffs
|
||||
|
||||
Agents naturally hand off to each other:
|
||||
|
||||
```
|
||||
Game Designer → Game Architect → Game Scrum Master → Game Developer
|
||||
↓ ↓ ↓ ↓
|
||||
GDD Architecture Sprint/Stories Implementation
|
||||
↓ ↓
|
||||
Game QA ←──────────────────────────── Game QA
|
||||
↓ ↓
|
||||
Test Strategy Automated Tests
|
||||
```
|
||||
|
||||
Game QA integrates at multiple points:
|
||||
|
||||
- After Architecture: Define test strategy
|
||||
- During Implementation: Create automated tests
|
||||
- Before Release: Performance and certification testing
|
||||
|
||||
---
|
||||
|
||||
## Project Context
|
||||
|
||||
All agents share the principle:
|
||||
|
||||
> "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
||||
- **[Workflows Guide](../../reference/workflows/index.md)** - Detailed workflow reference
|
||||
- **[Game Types Guide](../../explanation/game-dev/game-types.md)** - Game type templates
|
||||
@@ -1,150 +0,0 @@
|
||||
---
|
||||
title: "BMGD vs BMM"
|
||||
description: Understanding the differences between BMGD and BMM
|
||||
---
|
||||
|
||||
|
||||
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
|
||||
|
||||
---
|
||||
|
||||
## Quick Comparison
|
||||
|
||||
| Aspect | BMM | BMGD |
|
||||
| -------------- | ------------------------------------- | ------------------------------------------------------------------------ |
|
||||
| **Focus** | General software | Game development |
|
||||
| **Agents** | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev |
|
||||
| **Planning** | PRD, Tech Spec | Game Brief, GDD |
|
||||
| **Types** | N/A | 24 game type templates |
|
||||
| **Narrative** | N/A | Full narrative workflow |
|
||||
| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) |
|
||||
| **Production** | BMM workflows | BMM workflows with game overrides |
|
||||
|
||||
---
|
||||
|
||||
## Agent Differences
|
||||
|
||||
### BMM Agents
|
||||
- PM (Product Manager)
|
||||
- Architect
|
||||
- DEV (Developer)
|
||||
- SM (Scrum Master)
|
||||
- TEA (Test Architect)
|
||||
- Quick Flow Solo Dev
|
||||
|
||||
### BMGD Agents
|
||||
- Game Designer
|
||||
- Game Developer
|
||||
- Game Architect
|
||||
- Game Scrum Master
|
||||
- Game QA
|
||||
- Game Solo Dev
|
||||
|
||||
BMGD agents understand game-specific concepts like:
|
||||
- Game mechanics and balance
|
||||
- Player psychology
|
||||
- Engine-specific patterns
|
||||
- Playtesting and QA
|
||||
|
||||
---
|
||||
|
||||
## Planning Documents
|
||||
|
||||
### BMM Planning
|
||||
- **Product Brief** → **PRD** → **Architecture**
|
||||
- Focus: Software requirements, user stories, system design
|
||||
|
||||
### BMGD Planning
|
||||
- **Game Brief** → **GDD** → **Architecture**
|
||||
- Focus: Game vision, mechanics, narrative, player experience
|
||||
|
||||
The GDD (Game Design Document) includes:
|
||||
- Core gameplay loop
|
||||
- Mechanics and systems
|
||||
- Progression and balance
|
||||
- Art and audio direction
|
||||
- Genre-specific sections
|
||||
|
||||
---
|
||||
|
||||
## Game Type Templates
|
||||
|
||||
BMGD includes 24 game type templates that auto-configure GDD sections:
|
||||
|
||||
- Action, Adventure, Puzzle
|
||||
- RPG, Strategy, Simulation
|
||||
- Sports, Racing, Fighting
|
||||
- Horror, Platformer, Shooter
|
||||
- And more...
|
||||
|
||||
Each template provides:
|
||||
- Genre-specific GDD sections
|
||||
- Relevant mechanics patterns
|
||||
- Testing considerations
|
||||
- Common pitfalls to avoid
|
||||
|
||||
---
|
||||
|
||||
## Narrative Support
|
||||
|
||||
BMGD includes full narrative workflow for story-driven games:
|
||||
|
||||
- **Narrative Design** workflow
|
||||
- Story structure templates
|
||||
- Character development
|
||||
- World-building guidelines
|
||||
- Dialogue systems
|
||||
|
||||
BMM has no equivalent for narrative design.
|
||||
|
||||
---
|
||||
|
||||
## Testing Differences
|
||||
|
||||
### BMM Testing (TEA)
|
||||
- Web-focused (Playwright, Cypress)
|
||||
- API testing
|
||||
- E2E for web applications
|
||||
|
||||
### BMGD Testing (Game QA)
|
||||
- Engine-specific frameworks (Unity, Unreal, Godot)
|
||||
- Gameplay testing
|
||||
- Performance profiling
|
||||
- Playtest planning
|
||||
- Balance validation
|
||||
|
||||
---
|
||||
|
||||
## Production Workflow
|
||||
|
||||
BMGD production workflows **inherit from BMM** and add game-specific:
|
||||
- Checklists
|
||||
- Templates
|
||||
- Quality gates
|
||||
- Engine-specific considerations
|
||||
|
||||
This means you get all of BMM's implementation structure plus game-specific enhancements.
|
||||
|
||||
---
|
||||
|
||||
## When to Use Each
|
||||
|
||||
### Use BMM when:
|
||||
- Building web applications
|
||||
- Creating APIs and services
|
||||
- Developing mobile apps (non-game)
|
||||
- Any general software project
|
||||
|
||||
### Use BMGD when:
|
||||
- Building video games
|
||||
- Creating interactive experiences
|
||||
- Game prototyping
|
||||
- Game jams
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [BMGD Overview](./index.md) - Getting started with BMGD
|
||||
- [Game Types Guide](./game-types.md) - Understanding game templates
|
||||
- [Quick Start BMGD](../../tutorials/getting-started/quick-start-bmgd.md) - Tutorial
|
||||
@@ -1,506 +0,0 @@
|
||||
---
|
||||
title: "BMGD Game Types Guide"
|
||||
---
|
||||
|
||||
|
||||
Reference for selecting and using BMGD's 24 supported game type templates.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
|
||||
|
||||
---
|
||||
|
||||
## Supported Game Types
|
||||
|
||||
### Action & Combat
|
||||
|
||||
#### Action Platformer
|
||||
|
||||
**Tags:** action, platformer, combat, movement
|
||||
|
||||
Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Celeste with combat, or Mega Man.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Movement systems (jumps, dashes, wall mechanics)
|
||||
- Combat mechanics (melee/ranged, combos)
|
||||
- Level design patterns
|
||||
- Boss design
|
||||
|
||||
---
|
||||
|
||||
#### Shooter
|
||||
|
||||
**Tags:** shooter, combat, aiming, fps, tps
|
||||
|
||||
Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Weapon systems
|
||||
- Aiming and accuracy
|
||||
- Enemy AI patterns
|
||||
- Level/arena design
|
||||
- Multiplayer considerations
|
||||
|
||||
---
|
||||
|
||||
#### Fighting
|
||||
|
||||
**Tags:** fighting, combat, competitive, combos, pvp
|
||||
|
||||
1v1 combat with combos and frame data. Traditional fighters and platform fighters.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Frame data systems
|
||||
- Combo mechanics
|
||||
- Character movesets
|
||||
- Competitive balance
|
||||
- Netcode requirements
|
||||
|
||||
---
|
||||
|
||||
### Strategy & Tactics
|
||||
|
||||
#### Strategy
|
||||
|
||||
**Tags:** strategy, tactics, resources, planning
|
||||
|
||||
Resource management with tactical decisions. RTS, 4X, and grand strategy.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Resource systems
|
||||
- Unit/building design
|
||||
- AI opponent behavior
|
||||
- Map/scenario design
|
||||
- Victory conditions
|
||||
|
||||
---
|
||||
|
||||
#### Turn-Based Tactics
|
||||
|
||||
**Tags:** tactics, turn-based, grid, positioning
|
||||
|
||||
Grid-based movement with turn order. XCOM-likes and tactical RPGs.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Grid and movement systems
|
||||
- Turn order mechanics
|
||||
- Cover and positioning
|
||||
- Unit progression
|
||||
- Procedural mission generation
|
||||
|
||||
---
|
||||
|
||||
#### Tower Defense
|
||||
|
||||
**Tags:** tower-defense, waves, placement, strategy
|
||||
|
||||
Wave-based defense with tower placement.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Tower types and upgrades
|
||||
- Wave design and pacing
|
||||
- Economy systems
|
||||
- Map design patterns
|
||||
- Meta-progression
|
||||
|
||||
---
|
||||
|
||||
### RPG & Progression
|
||||
|
||||
#### RPG
|
||||
|
||||
**Tags:** rpg, stats, inventory, quests, narrative
|
||||
|
||||
Character progression with stats, inventory, and quests.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Character stats and leveling
|
||||
- Inventory and equipment
|
||||
- Quest system design
|
||||
- Combat system (action/turn-based)
|
||||
- Skill trees and builds
|
||||
|
||||
---
|
||||
|
||||
#### Roguelike
|
||||
|
||||
**Tags:** roguelike, procedural, permadeath, runs
|
||||
|
||||
Procedural generation with permadeath and run-based progression.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Procedural generation rules
|
||||
- Permadeath and persistence
|
||||
- Run structure and pacing
|
||||
- Item/ability synergies
|
||||
- Meta-progression systems
|
||||
|
||||
---
|
||||
|
||||
#### Metroidvania
|
||||
|
||||
**Tags:** metroidvania, exploration, abilities, interconnected
|
||||
|
||||
Interconnected world with ability gating.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- World map connectivity
|
||||
- Ability gating design
|
||||
- Backtracking flow
|
||||
- Secret and collectible placement
|
||||
- Power-up progression
|
||||
|
||||
---
|
||||
|
||||
### Narrative & Story
|
||||
|
||||
#### Adventure
|
||||
|
||||
**Tags:** adventure, narrative, exploration, story
|
||||
|
||||
Story-driven exploration and narrative. Point-and-click and narrative adventures.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Puzzle design
|
||||
- Narrative delivery
|
||||
- Exploration mechanics
|
||||
- Dialogue systems
|
||||
- Story branching
|
||||
|
||||
---
|
||||
|
||||
#### Visual Novel
|
||||
|
||||
**Tags:** visual-novel, narrative, choices, story
|
||||
|
||||
Narrative choices with branching story.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Branching narrative structure
|
||||
- Choice and consequence
|
||||
- Character routes
|
||||
- UI/presentation
|
||||
- Save/load states
|
||||
|
||||
---
|
||||
|
||||
#### Text-Based
|
||||
|
||||
**Tags:** text, parser, interactive-fiction, mud
|
||||
|
||||
Text input/output games. Parser games, choice-based IF, MUDs.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Parser or choice systems
|
||||
- World model
|
||||
- Narrative structure
|
||||
- Text presentation
|
||||
- Save state management
|
||||
|
||||
---
|
||||
|
||||
### Simulation & Management
|
||||
|
||||
#### Simulation
|
||||
|
||||
**Tags:** simulation, management, sandbox, systems
|
||||
|
||||
Realistic systems with management and building. Includes tycoons and sim games.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Core simulation loops
|
||||
- Economy modeling
|
||||
- AI agents/citizens
|
||||
- Building/construction
|
||||
- Failure states
|
||||
|
||||
---
|
||||
|
||||
#### Sandbox
|
||||
|
||||
**Tags:** sandbox, creative, building, freedom
|
||||
|
||||
Creative freedom with building and minimal objectives.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Creation tools
|
||||
- Physics/interaction systems
|
||||
- Persistence and saving
|
||||
- Sharing/community features
|
||||
- Optional objectives
|
||||
|
||||
---
|
||||
|
||||
### Sports & Racing
|
||||
|
||||
#### Racing
|
||||
|
||||
**Tags:** racing, vehicles, tracks, speed
|
||||
|
||||
Vehicle control with tracks and lap times.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Vehicle physics model
|
||||
- Track design
|
||||
- AI opponents
|
||||
- Progression/career mode
|
||||
- Multiplayer racing
|
||||
|
||||
---
|
||||
|
||||
#### Sports
|
||||
|
||||
**Tags:** sports, teams, realistic, physics
|
||||
|
||||
Team-based or individual sports simulation.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Sport-specific rules
|
||||
- Player/team management
|
||||
- AI opponent behavior
|
||||
- Season/career modes
|
||||
- Multiplayer modes
|
||||
|
||||
---
|
||||
|
||||
### Multiplayer
|
||||
|
||||
#### MOBA
|
||||
|
||||
**Tags:** moba, multiplayer, pvp, heroes, lanes
|
||||
|
||||
Multiplayer team battles with hero selection.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Hero/champion design
|
||||
- Lane and map design
|
||||
- Team composition
|
||||
- Matchmaking
|
||||
- Economy (gold/items)
|
||||
|
||||
---
|
||||
|
||||
#### Party Game
|
||||
|
||||
**Tags:** party, multiplayer, minigames, casual
|
||||
|
||||
Local multiplayer with minigames.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Minigame design patterns
|
||||
- Controller support
|
||||
- Round/game structure
|
||||
- Scoring systems
|
||||
- Player count flexibility
|
||||
|
||||
---
|
||||
|
||||
### Horror & Survival
|
||||
|
||||
#### Survival
|
||||
|
||||
**Tags:** survival, crafting, resources, danger
|
||||
|
||||
Resource gathering with crafting and persistent threats.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Resource gathering
|
||||
- Crafting systems
|
||||
- Hunger/health/needs
|
||||
- Threat systems
|
||||
- Base building
|
||||
|
||||
---
|
||||
|
||||
#### Horror
|
||||
|
||||
**Tags:** horror, atmosphere, tension, fear
|
||||
|
||||
Atmosphere and tension with limited resources.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Fear mechanics
|
||||
- Resource scarcity
|
||||
- Sound design
|
||||
- Lighting and visibility
|
||||
- Enemy/threat design
|
||||
|
||||
---
|
||||
|
||||
### Casual & Progression
|
||||
|
||||
#### Puzzle
|
||||
|
||||
**Tags:** puzzle, logic, cerebral
|
||||
|
||||
Logic-based challenges and problem-solving.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Puzzle mechanics
|
||||
- Difficulty progression
|
||||
- Hint systems
|
||||
- Level structure
|
||||
- Scoring/rating
|
||||
|
||||
---
|
||||
|
||||
#### Idle/Incremental
|
||||
|
||||
**Tags:** idle, incremental, automation, progression
|
||||
|
||||
Passive progression with upgrades and automation.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Core loop design
|
||||
- Prestige systems
|
||||
- Automation unlocks
|
||||
- Number scaling
|
||||
- Offline progress
|
||||
|
||||
---
|
||||
|
||||
#### Card Game
|
||||
|
||||
**Tags:** card, deck-building, strategy, turns
|
||||
|
||||
Deck building with card mechanics.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Card design framework
|
||||
- Deck building rules
|
||||
- Mana/resource systems
|
||||
- Rarity and collection
|
||||
- Competitive balance
|
||||
|
||||
---
|
||||
|
||||
### Rhythm
|
||||
|
||||
#### Rhythm
|
||||
|
||||
**Tags:** rhythm, music, timing, beats
|
||||
|
||||
Music synchronization with timing-based gameplay.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Note/beat mapping
|
||||
- Scoring systems
|
||||
- Difficulty levels
|
||||
- Music licensing
|
||||
- Input methods
|
||||
|
||||
---
|
||||
|
||||
## Hybrid Game Types
|
||||
|
||||
Many games combine multiple genres. BMGD supports hybrid selection:
|
||||
|
||||
### Examples
|
||||
|
||||
**Action RPG** = Action Platformer + RPG
|
||||
|
||||
- Movement and combat systems from Action Platformer
|
||||
- Progression and stats from RPG
|
||||
|
||||
**Survival Horror** = Survival + Horror
|
||||
|
||||
- Resource and crafting from Survival
|
||||
- Atmosphere and fear from Horror
|
||||
|
||||
**Roguelike Deckbuilder** = Roguelike + Card Game
|
||||
|
||||
- Run structure from Roguelike
|
||||
- Card mechanics from Card Game
|
||||
|
||||
### How to Use Hybrids
|
||||
|
||||
During GDD creation, select multiple game types when prompted:
|
||||
|
||||
```
|
||||
Agent: What game type best describes your game?
|
||||
You: It's a roguelike with card game combat
|
||||
Agent: I'll include sections for both Roguelike and Card Game...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Game Type Selection Tips
|
||||
|
||||
### 1. Start with Core Fantasy
|
||||
|
||||
What does the player primarily DO in your game?
|
||||
|
||||
- Run and jump? → Platformer types
|
||||
- Build and manage? → Simulation types
|
||||
- Fight enemies? → Combat types
|
||||
- Make choices? → Narrative types
|
||||
|
||||
### 2. Consider Your Loop
|
||||
|
||||
What's the core gameplay loop?
|
||||
|
||||
- Session-based runs? → Roguelike
|
||||
- Long-term progression? → RPG
|
||||
- Quick matches? → Multiplayer types
|
||||
- Creative expression? → Sandbox
|
||||
|
||||
### 3. Don't Over-Combine
|
||||
|
||||
2-3 game types maximum. More than that usually means your design isn't focused enough.
|
||||
|
||||
### 4. Primary vs Secondary
|
||||
|
||||
One type should be primary (most gameplay time). Others add flavor:
|
||||
|
||||
- **Primary:** Platformer (core movement and exploration)
|
||||
- **Secondary:** Metroidvania (ability gating structure)
|
||||
|
||||
---
|
||||
|
||||
## GDD Section Mapping
|
||||
|
||||
When you select a game type, BMGD adds these GDD sections:
|
||||
|
||||
| Game Type | Key Sections Added |
|
||||
| ----------------- | -------------------------------------- |
|
||||
| Action Platformer | Movement, Combat, Level Design |
|
||||
| RPG | Stats, Inventory, Quests |
|
||||
| Roguelike | Procedural Gen, Runs, Meta-Progression |
|
||||
| Narrative | Story Structure, Dialogue, Branching |
|
||||
| Multiplayer | Matchmaking, Netcode, Balance |
|
||||
| Simulation | Systems, Economy, AI |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
||||
- **[Workflows Guide](../../reference/workflows/bmgd-workflows.md)** - GDD workflow details
|
||||
- **[Glossary](../../reference/glossary/index.md)** - Game development terminology
|
||||
@@ -1,85 +0,0 @@
|
||||
---
|
||||
title: "BMGD - Game Development Module"
|
||||
description: AI-powered workflows for game design and development with BMGD
|
||||
---
|
||||
|
||||
|
||||
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
**New to BMGD?** Start here:
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started building your first game
|
||||
- Installation and setup
|
||||
- Understanding the game development phases
|
||||
- Running your first workflows
|
||||
- Agent-based development flow
|
||||
|
||||
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
|
||||
|
||||
---
|
||||
|
||||
## Core Documentation
|
||||
|
||||
- **[Game Types Guide](./game-types.md)** - Selecting and using game type templates (24 supported types)
|
||||
- **[BMGD vs BMM](./bmgd-vs-bmm.md)** - Understanding the differences
|
||||
|
||||
---
|
||||
|
||||
## Game Development Phases
|
||||
|
||||
BMGD follows four phases aligned with game development:
|
||||
|
||||
### Phase 1: Preproduction
|
||||
- **Brainstorm Game** - Ideation with game-specific techniques
|
||||
- **Game Brief** - Capture vision, market, and fundamentals
|
||||
|
||||
### Phase 2: Design
|
||||
- **GDD (Game Design Document)** - Comprehensive game design
|
||||
- **Narrative Design** - Story, characters, world (for story-driven games)
|
||||
|
||||
### Phase 3: Technical
|
||||
- **Game Architecture** - Engine, systems, patterns, structure
|
||||
|
||||
### Phase 4: Production
|
||||
- **Sprint Planning** - Epic and story management
|
||||
- **Story Development** - Implementation workflow
|
||||
- **Code Review** - Quality assurance
|
||||
- **Testing** - Automated tests, playtesting, performance
|
||||
- **Retrospective** - Continuous improvement
|
||||
|
||||
---
|
||||
|
||||
## Choose Your Path
|
||||
|
||||
### I need to...
|
||||
|
||||
**Start a new game project**
|
||||
→ Start with [Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)
|
||||
→ Run `brainstorm-game` for ideation
|
||||
→ Create a Game Brief with `create-brief`
|
||||
|
||||
**Design my game**
|
||||
→ Create a GDD with `create-gdd`
|
||||
→ If story-heavy, add Narrative Design with `create-narrative`
|
||||
|
||||
**Plan the technical architecture**
|
||||
→ Run `create-architecture` with the Game Architect
|
||||
|
||||
**Build my game**
|
||||
→ Use Phase 4 production workflows
|
||||
→ Follow the sprint-based development cycle
|
||||
|
||||
**Quickly test an idea**
|
||||
→ Use [Quick-Flow](../../how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Game Types Guide](./game-types.md) - Understanding game type templates
|
||||
- [BMGD vs BMM](./bmgd-vs-bmm.md) - Comparison with core method
|
||||
- [Glossary](../../reference/glossary/index.md) - Terminology reference
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
title: "Explanation"
|
||||
---
|
||||
|
||||
|
||||
Understanding-oriented content that explains concepts, architecture, and the reasoning behind BMAD's design.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
Foundational concepts you need to understand BMAD.
|
||||
|
||||
- [What are Agents?](./core-concepts/what-are-agents.md)
|
||||
- [What are Workflows?](./core-concepts/what-are-workflows.md)
|
||||
- [What are Modules?](./core-concepts/what-are-modules.md)
|
||||
|
||||
## Architecture
|
||||
|
||||
How BMAD is designed and why.
|
||||
|
||||
## Philosophy
|
||||
|
||||
The thinking behind BMAD's approach.
|
||||
|
||||
## Features
|
||||
|
||||
Deep dives into specific BMAD features.
|
||||
|
||||
- [Party Mode](./features/party-mode.md)
|
||||
- [Brainstorming Techniques](./features/brainstorming-techniques.md)
|
||||
- [Advanced Elicitation](./features/advanced-elicitation.md)
|
||||
- [Web Bundles](./features/web-bundles.md)
|
||||
|
||||
## Modules
|
||||
|
||||
Explanations of BMAD's module ecosystem.
|
||||
57
docs/explanation/party-mode.md
Normal file
57
docs/explanation/party-mode.md
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: "Party Mode"
|
||||
description: Multi-agent collaboration - get all your AI agents in one conversation
|
||||
---
|
||||
|
||||
Get all your AI agents in one conversation.
|
||||
|
||||
## What is Party Mode?
|
||||
|
||||
Run `party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. BMad Master orchestrates, picking relevant agents per message. Agents respond in character, agree, disagree, and build on each other's ideas.
|
||||
|
||||
The conversation continues as long as you want. Ask follow-ups, push back on answers, redirect the discussion - it's a real back-and-forth with your agents until you're done.
|
||||
|
||||
**Good for:**
|
||||
|
||||
- Big decisions with tradeoffs
|
||||
- Brainstorming sessions
|
||||
- Post-mortems when things go wrong
|
||||
- Sprint retrospectives and planning
|
||||
|
||||
## Examples
|
||||
|
||||
### Calling Out Bad Architecture
|
||||
|
||||
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
||||
|
||||
**Architect:** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
||||
|
||||
**Dev:** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
||||
|
||||
**PM:** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
||||
|
||||
**TEA:** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
||||
|
||||
### Creative Brainstorming
|
||||
|
||||
**You:** "How do we make onboarding feel magical instead of boring?"
|
||||
|
||||
**UX Designer:** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
||||
|
||||
**Storyteller:** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
||||
|
||||
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
||||
|
||||
### Technical Decision
|
||||
|
||||
**You:** "Monolith or microservices for MVP?"
|
||||
|
||||
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
||||
|
||||
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
||||
|
||||
**Dev:** "Monolith with clear module boundaries. We can extract services later if needed."
|
||||
|
||||
:::tip[Better Decisions]
|
||||
Better decisions through diverse perspectives. Welcome to party mode.
|
||||
:::
|
||||
@@ -1,121 +0,0 @@
|
||||
---
|
||||
title: "Facilitation Over Generation"
|
||||
description: Understanding CIS's facilitation-first approach to creative work
|
||||
---
|
||||
|
||||
|
||||
The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself.
|
||||
|
||||
---
|
||||
|
||||
## The Problem with Generation
|
||||
|
||||
Traditional AI approaches to creative work:
|
||||
|
||||
```
|
||||
User: "Give me marketing ideas"
|
||||
AI: "Here are 10 marketing ideas..."
|
||||
```
|
||||
|
||||
This approach:
|
||||
- Produces generic, predictable outputs
|
||||
- Removes human ownership of ideas
|
||||
- Misses context and nuance
|
||||
- Limits creative exploration
|
||||
|
||||
---
|
||||
|
||||
## The Facilitation Approach
|
||||
|
||||
CIS agents use strategic questioning:
|
||||
|
||||
```
|
||||
User: "I need marketing ideas"
|
||||
CIS: "What makes your customers choose you over alternatives?
|
||||
What's the one thing they always mention?"
|
||||
User: "They say our support is exceptional"
|
||||
CIS: "Interesting! How might you make that exceptional
|
||||
support visible before they become customers?"
|
||||
```
|
||||
|
||||
This approach:
|
||||
- Draws out insights already within you
|
||||
- Maintains human ownership of ideas
|
||||
- Captures context and nuance
|
||||
- Enables deeper creative exploration
|
||||
|
||||
---
|
||||
|
||||
## Key Principles
|
||||
|
||||
### 1. Questions Over Answers
|
||||
|
||||
CIS agents ask strategic questions rather than providing direct answers. This:
|
||||
- Activates your own creative thinking
|
||||
- Uncovers assumptions
|
||||
- Reveals blind spots
|
||||
- Builds on your domain knowledge
|
||||
|
||||
### 2. Energy-Aware Sessions
|
||||
|
||||
CIS monitors engagement and adapts:
|
||||
- Adjusts pace when energy flags
|
||||
- Suggests breaks when needed
|
||||
- Changes techniques to maintain momentum
|
||||
- Recognizes productive vs. unproductive struggle
|
||||
|
||||
### 3. Process Trust
|
||||
|
||||
CIS uses proven methodologies:
|
||||
- Design Thinking's 5 phases
|
||||
- Structured brainstorming techniques
|
||||
- Root cause analysis frameworks
|
||||
- Innovation strategy patterns
|
||||
|
||||
You're not just having a conversation—you're following time-tested creative processes.
|
||||
|
||||
### 4. Persona-Driven Engagement
|
||||
|
||||
Each CIS agent has a distinct personality:
|
||||
- **Carson** - Energetic, encouraging
|
||||
- **Maya** - Jazz-like, improvisational
|
||||
- **Dr. Quinn** - Analytical, methodical
|
||||
- **Victor** - Bold, strategic
|
||||
- **Sophia** - Narrative, imaginative
|
||||
|
||||
These personas create engaging experiences that maintain creative flow.
|
||||
|
||||
---
|
||||
|
||||
## When Generation is Appropriate
|
||||
|
||||
CIS does generate when appropriate:
|
||||
- Synthesizing session outputs
|
||||
- Documenting decisions
|
||||
- Creating structured artifacts
|
||||
- Providing technique examples
|
||||
|
||||
But the core creative work happens through facilitated discovery.
|
||||
|
||||
---
|
||||
|
||||
## Benefits
|
||||
|
||||
### For Individuals
|
||||
- Deeper insights than pure generation
|
||||
- Ownership of creative outputs
|
||||
- Skill development in creative thinking
|
||||
- More memorable and actionable ideas
|
||||
|
||||
### For Teams
|
||||
- Shared creative experience
|
||||
- Aligned understanding
|
||||
- Documented rationale
|
||||
- Stronger buy-in to outcomes
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Creative Intelligence Suite](../creative-intelligence/index.md) - CIS overview
|
||||
- [Brainstorming Techniques](../features/brainstorming-techniques.md) - Available techniques
|
||||
@@ -3,11 +3,8 @@ title: "Preventing Agent Conflicts"
|
||||
description: How architecture prevents conflicts when multiple agents implement a system
|
||||
---
|
||||
|
||||
|
||||
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
||||
|
||||
---
|
||||
|
||||
## Common Conflict Types
|
||||
|
||||
### API Style Conflicts
|
||||
@@ -43,8 +40,6 @@ With architecture:
|
||||
- ADR specifies state management approach
|
||||
- All agents implement consistently
|
||||
|
||||
---
|
||||
|
||||
## How Architecture Prevents Conflicts
|
||||
|
||||
### 1. Explicit Decisions via ADRs
|
||||
@@ -70,8 +65,6 @@ Explicit documentation of:
|
||||
- Code organization
|
||||
- Testing patterns
|
||||
|
||||
---
|
||||
|
||||
## Architecture as Shared Context
|
||||
|
||||
Think of architecture as the shared context that all agents read before implementing:
|
||||
@@ -88,51 +81,30 @@ Agent C reads architecture → implements Epic 3
|
||||
Result: Consistent implementation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Key ADR Topics
|
||||
|
||||
Common decisions that prevent conflicts:
|
||||
|
||||
| Topic | Example Decision |
|
||||
|-------|-----------------|
|
||||
| API Style | GraphQL vs REST vs gRPC |
|
||||
| Database | PostgreSQL vs MongoDB |
|
||||
| Auth | JWT vs Sessions |
|
||||
| State Management | Redux vs Context vs Zustand |
|
||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||
| Testing | Jest + Playwright vs Vitest + Cypress |
|
||||
| Topic | Example Decision |
|
||||
| ---------------- | -------------------------------------------- |
|
||||
| API Style | GraphQL vs REST vs gRPC |
|
||||
| Database | PostgreSQL vs MongoDB |
|
||||
| Auth | JWT vs Sessions |
|
||||
| State Management | Redux vs Context vs Zustand |
|
||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||
| Testing | Jest + Playwright vs Vitest + Cypress |
|
||||
|
||||
---
|
||||
## Anti-Patterns to Avoid
|
||||
|
||||
## Anti-Patterns
|
||||
|
||||
### ❌ Implicit Decisions
|
||||
|
||||
"We'll figure out the API style as we go"
|
||||
→ Leads to inconsistency
|
||||
|
||||
### ❌ Over-Documentation
|
||||
|
||||
Every minor choice documented
|
||||
→ Analysis paralysis, wasted time
|
||||
|
||||
### ❌ Stale Architecture
|
||||
|
||||
Document written once, never updated
|
||||
→ Agents follow outdated patterns
|
||||
|
||||
### ✅ Correct Approach
|
||||
:::caution[Common Mistakes]
|
||||
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
|
||||
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
|
||||
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
|
||||
:::
|
||||
|
||||
:::tip[Correct Approach]
|
||||
- Document decisions that cross epic boundaries
|
||||
- Focus on conflict-prone areas
|
||||
- Update architecture as you learn
|
||||
- Use `correct-course` for significant changes
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Why Solutioning Matters](./why-solutioning-matters.md)
|
||||
- [Four Phases](./four-phases.md)
|
||||
- [Create Architecture](../../how-to/workflows/create-architecture.md)
|
||||
:::
|
||||
27
docs/explanation/quick-flow.md
Normal file
27
docs/explanation/quick-flow.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "Quick Flow"
|
||||
description: Fast-track for small changes - skip the full methodology
|
||||
---
|
||||
|
||||
Quick Flow is for when you don't need the full BMad Method. Skip Product Brief, PRD, and Architecture - go straight to implementation.
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Run `quick-spec`** — generates a focused tech-spec
|
||||
2. **Run `quick-dev`** — implements it
|
||||
|
||||
That's it.
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Bug fixes
|
||||
- Refactoring
|
||||
- Small features
|
||||
- Prototyping
|
||||
|
||||
## When to Use Full BMad Method Instead
|
||||
|
||||
- New products
|
||||
- Major features
|
||||
- Multiple teams involved
|
||||
- Stakeholder alignment needed
|
||||
@@ -6,8 +6,6 @@ description: Understanding why the solutioning phase is critical for multi-epic
|
||||
|
||||
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
||||
|
||||
---
|
||||
|
||||
## The Problem Without Solutioning
|
||||
|
||||
```
|
||||
@@ -18,8 +16,6 @@ Result: Inconsistent API design, integration nightmare
|
||||
|
||||
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
||||
|
||||
---
|
||||
|
||||
## The Solution With Solutioning
|
||||
|
||||
```
|
||||
@@ -30,8 +26,6 @@ Result: Consistent implementation, no conflicts
|
||||
|
||||
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
||||
|
||||
---
|
||||
|
||||
## Solutioning vs Planning
|
||||
|
||||
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
||||
@@ -43,8 +37,6 @@ By documenting technical decisions explicitly, all agents implement consistently
|
||||
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
||||
| Level | Business logic | Technical design + Work breakdown |
|
||||
|
||||
---
|
||||
|
||||
## Key Principle
|
||||
|
||||
**Make technical decisions explicit and documented** so all agents implement consistently.
|
||||
@@ -56,8 +48,6 @@ This prevents:
|
||||
- Naming convention mismatches
|
||||
- Security approach variations
|
||||
|
||||
---
|
||||
|
||||
## When Solutioning is Required
|
||||
|
||||
| Track | Solutioning Required? |
|
||||
@@ -67,9 +57,9 @@ This prevents:
|
||||
| BMad Method Complex | Yes |
|
||||
| Enterprise | Yes |
|
||||
|
||||
**Rule of thumb:** If you have multiple epics that could be implemented by different agents, you need solutioning.
|
||||
|
||||
---
|
||||
:::tip[Rule of Thumb]
|
||||
If you have multiple epics that could be implemented by different agents, you need solutioning.
|
||||
:::
|
||||
|
||||
## The Cost of Skipping
|
||||
|
||||
@@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
|
||||
- **Longer development time** overall
|
||||
- **Technical debt** from inconsistent patterns
|
||||
|
||||
:::caution[Cost Multiplier]
|
||||
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Four Phases](./four-phases.md) - Overview of all phases
|
||||
- [Preventing Agent Conflicts](./preventing-agent-conflicts.md) - Detailed conflict prevention
|
||||
- [Create Architecture](../../how-to/workflows/create-architecture.md) - How to do it
|
||||
:::
|
||||
@@ -1,91 +0,0 @@
|
||||
---
|
||||
title: "How to Add a Feature to an Existing Project"
|
||||
description: How to add new features to an existing brownfield project
|
||||
---
|
||||
|
||||
|
||||
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Adding a new feature to an existing codebase
|
||||
- Major enhancements that need proper planning
|
||||
- Features that touch multiple parts of the system
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Existing project documentation (run `document-project` first if needed)
|
||||
- Clear understanding of what you want to build
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Run workflow-init
|
||||
|
||||
```
|
||||
Run workflow-init
|
||||
```
|
||||
|
||||
The workflow should recognize you're in an existing project. If not, explicitly clarify that this is brownfield development.
|
||||
|
||||
### 2. Choose Your Approach
|
||||
|
||||
| Feature Scope | Recommended Approach |
|
||||
|---------------|---------------------|
|
||||
| Small (1-5 stories) | Quick Flow with tech-spec |
|
||||
| Medium (5-15 stories) | BMad Method with PRD |
|
||||
| Large (15+ stories) | Full BMad Method with architecture |
|
||||
|
||||
### 3. Create Planning Documents
|
||||
|
||||
**For Quick Flow:**
|
||||
- Load PM agent
|
||||
- Run tech-spec workflow
|
||||
- The agent will analyze your existing codebase and create a context-aware spec
|
||||
|
||||
**For BMad Method:**
|
||||
- Load PM agent
|
||||
- Run PRD workflow
|
||||
- Ensure the agent reads your existing documentation
|
||||
- Review that integration points are clearly identified
|
||||
|
||||
### 4. Consider Architecture Impact
|
||||
|
||||
If your feature affects system architecture:
|
||||
|
||||
- Load Architect agent
|
||||
- Run architecture workflow
|
||||
- Ensure alignment with existing patterns
|
||||
- Document any new ADRs (Architecture Decision Records)
|
||||
|
||||
### 5. Implement
|
||||
|
||||
Follow the standard Phase 4 implementation workflows:
|
||||
|
||||
1. `sprint-planning` - Organize your work
|
||||
2. `create-story` - Prepare each story
|
||||
3. `dev-story` - Implement with tests
|
||||
4. `code-review` - Quality assurance
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Always ensure agents read your existing documentation
|
||||
- Pay attention to integration points with existing code
|
||||
- Follow existing conventions unless deliberately changing them
|
||||
- Document why you're adding new patterns (if any)
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Document Existing Project](./document-existing-project.md)
|
||||
- [Quick Fix in Brownfield](./quick-fix-in-brownfield.md)
|
||||
@@ -1,84 +0,0 @@
|
||||
---
|
||||
title: "How to Document an Existing Project"
|
||||
description: How to document an existing brownfield codebase using BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Starting work on an undocumented legacy project
|
||||
- Documentation is outdated and needs refresh
|
||||
- AI agents need context about existing code patterns
|
||||
- Onboarding new team members
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed in your project
|
||||
- Access to the codebase you want to document
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Analyst Agent
|
||||
|
||||
Start a fresh chat and load the Analyst agent.
|
||||
|
||||
### 2. Run the document-project Workflow
|
||||
|
||||
Tell the agent:
|
||||
|
||||
```
|
||||
Run the document-project workflow
|
||||
```
|
||||
|
||||
### 3. Let the Agent Scan Your Codebase
|
||||
|
||||
The workflow will:
|
||||
|
||||
- Scan your codebase structure
|
||||
- Identify architecture patterns
|
||||
- Document the technology stack
|
||||
- Create reference documentation
|
||||
- Generate a PRD-like document from existing code
|
||||
|
||||
### 4. Review the Generated Documentation
|
||||
|
||||
The output will be saved to `project-documentation-{date}.md` in your output folder.
|
||||
|
||||
Review the documentation for:
|
||||
|
||||
- Accuracy of detected patterns
|
||||
- Completeness of architecture description
|
||||
- Any missing business rules or intent
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
- **Project overview** - High-level description of what the project does
|
||||
- **Technology stack** - Detected frameworks, libraries, and tools
|
||||
- **Architecture patterns** - Code organization and design patterns found
|
||||
- **Business rules** - Logic extracted from the codebase
|
||||
- **Integration points** - External APIs and services
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Run this before any major brownfield work
|
||||
- Keep the documentation updated as the project evolves
|
||||
- Use it as input for future PRD creation
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Add Feature to Existing Project](./add-feature-to-existing.md)
|
||||
@@ -3,24 +3,19 @@ title: "Brownfield Development"
|
||||
description: How to use BMad Method on existing codebases
|
||||
---
|
||||
|
||||
|
||||
How to effectively use BMad Method when working on existing projects and legacy codebases.
|
||||
Use BMad Method effectively when working on existing projects and legacy codebases.
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
||||
|
||||
This tutorial covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||
|
||||
:::note[Prerequisites]
|
||||
- BMad Method installed (`npx bmad-method install`)
|
||||
- An existing codebase you want to work on
|
||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
||||
|
||||
---
|
||||
:::
|
||||
|
||||
## Step 1: Clean Up Completed Planning Artifacts
|
||||
|
||||
@@ -30,8 +25,6 @@ If you have completed all PRD epics and stories through the BMad process, clean
|
||||
- `_bmad-output/planning-artifacts/`
|
||||
- `_bmad-output/implementation-artifacts/`
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Maintain Quality Project Documentation
|
||||
|
||||
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
||||
@@ -43,11 +36,11 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
||||
|
||||
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
||||
|
||||
---
|
||||
## Step 3: Get Help
|
||||
|
||||
## Step 3: Initialize for Brownfield Work
|
||||
Get help to know what to do next based on your unique needs
|
||||
|
||||
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
|
||||
Run `bmad-help` to get guidance when you are not sure what to do next.
|
||||
|
||||
### Choosing Your Approach
|
||||
|
||||
@@ -85,18 +78,7 @@ When doing architecture, ensure the architect:
|
||||
|
||||
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
||||
|
||||
---
|
||||
## More Information
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Document Existing Project](../../how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
||||
- **[Add Feature to Existing Project](../../how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
|
||||
- **[Quick Fix in Brownfield](../../how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||
- **[Brownfield FAQ](../../explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
||||
- [Quick Spec Flow](../../explanation/features/quick-flow.md) - Fast path for small changes
|
||||
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development
|
||||
|
||||
@@ -3,20 +3,14 @@ title: "How to Make Quick Fixes in Brownfield Projects"
|
||||
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
||||
---
|
||||
|
||||
|
||||
Not everything requires the full BMad method or even Quick Flow. For bug fixes, refactorings, or small targeted changes, you can work directly with the agent.
|
||||
|
||||
---
|
||||
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Bug fixes
|
||||
- Small refactorings
|
||||
- Targeted code improvements
|
||||
- Simple bug fixes
|
||||
- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts
|
||||
- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow
|
||||
- Learning about your codebase
|
||||
- One-off changes that don't need planning
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
@@ -25,7 +19,7 @@ Not everything requires the full BMad method or even Quick Flow. For bug fixes,
|
||||
For quick fixes, you can use:
|
||||
|
||||
- **DEV agent** - For implementation-focused work
|
||||
- **Quick Flow Solo Dev** - For slightly larger changes that still need a tech-spec
|
||||
- **Quick Flow Solo Dev** - For slightly larger changes that still need a quick-spec to keep the agent aligned to planning and standards
|
||||
|
||||
### 2. Describe the Change
|
||||
|
||||
@@ -54,8 +48,6 @@ The agent will:
|
||||
|
||||
Review the changes made and commit when satisfied.
|
||||
|
||||
---
|
||||
|
||||
## Learning Your Codebase
|
||||
|
||||
This approach is also excellent for exploring unfamiliar code:
|
||||
@@ -68,14 +60,12 @@ Explain how the authentication system works in this codebase
|
||||
Show me where error handling happens in the API layer
|
||||
```
|
||||
|
||||
LLMs are excellent at interpreting and analyzing code—whether it was AI-generated or not. Use the agent to:
|
||||
LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to:
|
||||
|
||||
- Learn about your project
|
||||
- Understand how things are built
|
||||
- Explore unfamiliar parts of the codebase
|
||||
|
||||
---
|
||||
|
||||
## When to Upgrade to Formal Planning
|
||||
|
||||
Consider using Quick Flow or full BMad Method when:
|
||||
@@ -84,11 +74,3 @@ Consider using Quick Flow or full BMad Method when:
|
||||
- You're unsure about the scope
|
||||
- The fix keeps growing in complexity
|
||||
- You need documentation for the change
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Brownfield Development Guide](./index.md)
|
||||
- [Add Feature to Existing Project](./add-feature-to-existing.md)
|
||||
- [Quick Spec Flow](../../explanation/features/quick-flow.md)
|
||||
|
||||
@@ -1,208 +0,0 @@
|
||||
---
|
||||
title: "Agent Customization Guide"
|
||||
---
|
||||
|
||||
|
||||
Customize BMad agents without modifying core files. All customizations persist through updates.
|
||||
|
||||
## Quick Start
|
||||
|
||||
**1. Locate Customization Files**
|
||||
|
||||
After installation, find agent customization files in:
|
||||
|
||||
```
|
||||
_bmad/_config/agents/
|
||||
├── core-bmad-master.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
├── bmm-pm.customize.yaml
|
||||
└── ... (one file per installed agent)
|
||||
```
|
||||
|
||||
**2. Edit Any Agent**
|
||||
|
||||
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
||||
|
||||
**3. Rebuild the Agent**
|
||||
|
||||
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
||||
|
||||
```bash
|
||||
npx bmad-method@alpha install # and then select option to compile all agents
|
||||
npx bmad-method@alpha build <agent-name>
|
||||
|
||||
npx bmad-method@alpha build bmm-dev
|
||||
npx bmad-method@alpha build core-bmad-master
|
||||
npx bmad-method@alpha build bmm-pm
|
||||
```
|
||||
|
||||
## What You Can Customize
|
||||
|
||||
### Agent Name
|
||||
|
||||
Change how the agent introduces itself:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Spongebob' # Default: "Amelia"
|
||||
```
|
||||
|
||||
### Persona
|
||||
|
||||
Replace the agent's personality, role, and communication style:
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: 'Senior Full-Stack Engineer'
|
||||
identity: 'Lives in a pineapple (under the sea)'
|
||||
communication_style: 'Spongebob'
|
||||
principles:
|
||||
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
||||
- 'Favor composition over inheritance'
|
||||
```
|
||||
|
||||
**Note:** The persona section replaces the entire default persona (not merged).
|
||||
|
||||
### Memories
|
||||
|
||||
Add persistent context the agent will always remember:
|
||||
|
||||
```yaml
|
||||
memories:
|
||||
- 'Works at Krusty Krab'
|
||||
- 'Favorite Celebrity: David Hasslehoff'
|
||||
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
|
||||
```
|
||||
|
||||
### Custom Menu Items
|
||||
|
||||
Add your own workflows to the agent's menu:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||
description: My custom workflow
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
description: Deploy to production
|
||||
```
|
||||
|
||||
**Don't include:** `*` prefix or `help`/`exit` items - these are auto-injected.
|
||||
|
||||
### Critical Actions
|
||||
|
||||
Add instructions that execute before the agent starts:
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Always check git status before making changes'
|
||||
- 'Use conventional commit messages'
|
||||
```
|
||||
|
||||
### Custom Prompts
|
||||
|
||||
Define reusable prompts for `action="#id"` menu handlers:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: deploy-prompt
|
||||
content: |
|
||||
Deploy the current branch to production:
|
||||
1. Run all tests
|
||||
2. Build the project
|
||||
3. Execute deployment script
|
||||
```
|
||||
|
||||
## Real-World Examples
|
||||
|
||||
**Example 1: Customize Developer Agent for TDD**
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'TDD Developer'
|
||||
|
||||
memories:
|
||||
- 'Always write tests before implementation'
|
||||
- 'Project uses Jest and React Testing Library'
|
||||
|
||||
critical_actions:
|
||||
- 'Review test coverage before committing'
|
||||
```
|
||||
|
||||
**Example 2: Add Custom Deployment Workflow**
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: deploy-staging
|
||||
workflow: '{project-root}/_bmad/deploy-staging.yaml'
|
||||
description: Deploy to staging environment
|
||||
- trigger: deploy-prod
|
||||
workflow: '{project-root}/_bmad/deploy-prod.yaml'
|
||||
description: Deploy to production (with approval)
|
||||
```
|
||||
|
||||
**Example 3: Multilingual Product Manager**
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: 'Bilingual Product Manager'
|
||||
identity: 'Expert in US and LATAM markets'
|
||||
communication_style: 'Clear, strategic, with cultural awareness'
|
||||
principles:
|
||||
- 'Consider localization from day one'
|
||||
- 'Balance business goals with user needs'
|
||||
|
||||
memories:
|
||||
- 'User speaks English and Spanish'
|
||||
- 'Target markets: US and Latin America'
|
||||
```
|
||||
|
||||
## Tips
|
||||
|
||||
- **Start Small:** Customize one section at a time and rebuild to test
|
||||
- **Backup:** Copy customization files before major changes
|
||||
- **Update-Safe:** Your customizations in `_config/` survive all BMad updates
|
||||
- **Per-Project:** Customization files are per-project, not global
|
||||
- **Version Control:** Consider committing `_config/` to share customizations with your team
|
||||
|
||||
## Module vs. Global Config
|
||||
|
||||
**Module-Level (Recommended):**
|
||||
|
||||
- Customize agents per-project in `_bmad/_config/agents/`
|
||||
- Different projects can have different agent behaviors
|
||||
|
||||
**Global Config (Coming Soon):**
|
||||
|
||||
- Set defaults that apply across all projects
|
||||
- Override with project-specific customizations
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Changes not appearing?**
|
||||
|
||||
- Make sure you ran `npx bmad-method build <agent-name>` after editing
|
||||
- Check YAML syntax is valid (indentation matters!)
|
||||
- Verify the agent name matches the file name pattern
|
||||
|
||||
**Agent not loading?**
|
||||
|
||||
- Check for YAML syntax errors
|
||||
- Ensure required fields aren't left empty if you uncommented them
|
||||
- Try reverting to the template and rebuilding
|
||||
|
||||
**Need to reset?**
|
||||
|
||||
- Delete the `.customize.yaml` file
|
||||
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Learn about Agents](../../explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
||||
- **[Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../../explanation/bmm/index.md)** - Full BMad Method reference
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
title: "Workflow Customization Guide"
|
||||
---
|
||||
|
||||
|
||||
Customize and optimize workflows with step replacement and hooks.
|
||||
|
||||
## Status
|
||||
|
||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
||||
|
||||
## What to Expect
|
||||
|
||||
Workflow customization will allow you to:
|
||||
|
||||
- **Replace Steps** - Swap out specific workflow steps with custom implementations
|
||||
- **Add Hooks** - Inject custom behavior before/after workflow steps
|
||||
- **Extend Workflows** - Create new workflows based on existing ones
|
||||
- **Override Behavior** - Customize workflow logic for your project's needs
|
||||
|
||||
## For Now
|
||||
|
||||
While workflow customization is in development, you can:
|
||||
|
||||
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
|
||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](./customize-agents.md)
|
||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
||||
|
||||
---
|
||||
|
||||
**In the meantime:** Learn how to [create custom workflows](../../explanation/bmad-builder/index.md) from scratch.
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: "BMAD Customization"
|
||||
---
|
||||
|
||||
|
||||
Personalize agents and workflows to match your needs.
|
||||
|
||||
## Guides
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| **[Agent Customization](./customize-agents.md)** | Modify agent behavior without editing core files |
|
||||
| **[Workflow Customization](./customize-workflows.md)** | Customize and optimize workflows |
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD provides two main customization approaches:
|
||||
|
||||
### Agent Customization
|
||||
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
||||
|
||||
### Workflow Customization
|
||||
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agent Customization Guide](./customize-agents.md) to start personalizing your agents.
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: "Workflow Vendoring, Customization, and Inheritance (Official Support Coming Soon)"
|
||||
---
|
||||
|
||||
|
||||
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
|
||||
|
||||
## Workflow Vendoring
|
||||
|
||||
Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs.
|
||||
|
||||
### How to Vendor
|
||||
|
||||
Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent.
|
||||
|
||||
From your modules agent definition, you would implement the menu item as follows in the agent:
|
||||
|
||||
```yaml
|
||||
- trigger: develop-story
|
||||
exec-vendor: "{project-root}/_bmad/<source-module>/workflows/4-production/dev-story/workflow.md"
|
||||
exec: "{project-root}/_bmad/<my-module>/workflows/dev-story/workflow.md"
|
||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
||||
```
|
||||
|
||||
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
||||
|
||||
## Workflow Inheritance (Official Support Coming Post Beta)
|
||||
|
||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
||||
|
||||
Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific.
|
||||
|
||||
Some possible examples could be:
|
||||
|
||||
- Retrospective
|
||||
- Sprint Planning
|
||||
- Collaborative Brainstorming Sessions
|
||||
|
||||
## Workflow Customization (Official Support Coming Post Beta)
|
||||
|
||||
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
||||
|
||||
This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time.
|
||||
|
||||
For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow.
|
||||
158
docs/how-to/customize-bmad.md
Normal file
158
docs/how-to/customize-bmad.md
Normal file
@@ -0,0 +1,158 @@
|
||||
---
|
||||
title: "BMad Method Customization Guide"
|
||||
---
|
||||
|
||||
The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem.
|
||||
|
||||
The Customization Guidance outlined here, while targeted at understanding BMad Method customization, applies to any other module use within the BMad Method.
|
||||
|
||||
## Types of Customization
|
||||
|
||||
Customization includes Agent Customization, Workflow/Skill customization, the addition of new MCPs or Skills to be used by existing agents. Aside from all of this, a whole other realm of customization involves creating / adding your own relevant BMad Builder workflows, skills, agents and maybe even your own net new modules to compliment the BMad Method Module.
|
||||
|
||||
Warning: The reason for customizing as this guide will prescribe will allow you to continue getting updates without worrying about losing your customization changes. And by continuing to get updates as BMad modules advance, you will be able to continue to evolve as the system improves.
|
||||
|
||||
## Agent Customization
|
||||
|
||||
### Agent Customization Areas
|
||||
|
||||
- Change agent names, personas or manner of speech
|
||||
- Add project-specific memories or context
|
||||
- Add custom menu items to custom or inline prompts, skills or custom BMad workflows
|
||||
- Define critical actions that occur agent startup for consistent behavior
|
||||
|
||||
## How to customize an agent.
|
||||
|
||||
**1. Locate Customization Files**
|
||||
|
||||
After installation, find agent customization files in:
|
||||
|
||||
```
|
||||
_bmad/_config/agents/
|
||||
├── core-bmad-master.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
├── bmm-pm.customize.yaml
|
||||
└── ... (one file per installed agent)
|
||||
```
|
||||
|
||||
**2. Edit Any Agent**
|
||||
|
||||
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
||||
|
||||
**3. Rebuild the Agent**
|
||||
|
||||
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
You can either then:
|
||||
|
||||
- Select `Quick Update` - This will also ensure all packages are up to date AND compile all agents to include any updates or customizations
|
||||
- Select `Rebuild Agents` - This will only rebuild and apply customizations to agents, without pulling the latest
|
||||
|
||||
There will be additional tools shortly after beta launch to allow install of individual agents, workflows, skills and modules without the need for using the full bmad installer.
|
||||
|
||||
### What Agent Properties Can Be Customized?
|
||||
|
||||
#### Agent Name
|
||||
|
||||
Change how the agent introduces itself:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Spongebob' # Default: "Amelia"
|
||||
```
|
||||
|
||||
#### Persona
|
||||
|
||||
Replace the agent's personality, role, and communication style:
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: 'Senior Full-Stack Engineer'
|
||||
identity: 'Lives in a pineapple (under the sea)'
|
||||
communication_style: 'Spongebob annoying'
|
||||
principles:
|
||||
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
||||
- 'Favor composition over inheritance'
|
||||
```
|
||||
|
||||
**Note:** The persona section replaces the entire default persona (not merged).
|
||||
|
||||
#### Memories
|
||||
|
||||
Add persistent context the agent will always remember:
|
||||
|
||||
```yaml
|
||||
memories:
|
||||
- 'Works at Krusty Krab'
|
||||
- 'Favorite Celebrity: David Hasslehoff'
|
||||
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
|
||||
```
|
||||
|
||||
### Custom Menu Items
|
||||
|
||||
Any custom items you add here will be included in the agents display menu.
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||
description: My custom workflow
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
description: Deploy to production
|
||||
```
|
||||
|
||||
### Critical Actions
|
||||
|
||||
Add instructions that execute before the agent starts:
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
|
||||
```
|
||||
|
||||
### Custom Prompts
|
||||
|
||||
Define reusable prompts for `action="#id"` menu handlers:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: deploy-prompt
|
||||
content: |
|
||||
Deploy the current branch to production:
|
||||
1. Run all tests
|
||||
2. Build the project
|
||||
3. Execute deployment script
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Changes not appearing?**
|
||||
|
||||
- Make sure you ran `npx bmad-method build <agent-name>` after editing
|
||||
- Check YAML syntax is valid (indentation matters!)
|
||||
- Verify the agent name matches the file name pattern
|
||||
|
||||
**Agent not loading?**
|
||||
|
||||
- Check for YAML syntax errors
|
||||
- Ensure required fields aren't left empty if you uncommented them
|
||||
- Try reverting to the template and rebuilding
|
||||
|
||||
**Need to reset?**
|
||||
|
||||
- Remove content from the `.customize.yaml` file (or delete the file)
|
||||
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
||||
|
||||
## Workflow Customization
|
||||
|
||||
Information about customizing existing BMad MEthod workflows and skills are coming soon.
|
||||
|
||||
## Module Customization
|
||||
|
||||
Information on how to build expansion modules that augment BMad, or make other existing module customizations are coming soon.
|
||||
@@ -1,43 +1,40 @@
|
||||
---
|
||||
title: "How to Get Answers About BMAD"
|
||||
description: Use an LLM to quickly answer your own BMAD questions
|
||||
title: "How to Get Answers About BMad"
|
||||
description: Use an LLM to quickly answer your own BMad questions
|
||||
---
|
||||
|
||||
Point an LLM at BMAD's source files and ask your question. That's the technique—the rest of this guide shows you how.
|
||||
If you have successfully installed BMad and the BMad Method (+ other modules as needed) - the first step in getting answers is `/bmad-help`. This will answer upwards of 80% of all questions and is available to you in the IDE as you are working.
|
||||
|
||||
## See It Work
|
||||
## When to Use This
|
||||
|
||||
:::note[Example]
|
||||
**Q:** "Tell me the fastest way to build something with BMAD"
|
||||
- You have a question about how BMad works or what to do next with BMad
|
||||
- You want to understand a specific agent or workflow
|
||||
- You need quick answers without waiting for Discord
|
||||
|
||||
**A:** Use Quick Flow: Run `create-tech-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. This gets small features shipped in a single focused session instead of going through the full 4-phase BMM workflow.
|
||||
:::note[Prerequisites]
|
||||
An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo.
|
||||
:::
|
||||
|
||||
## Why This Works
|
||||
## Steps
|
||||
|
||||
BMAD's prompts are written in plain English, not code. The `_bmad` folder contains readable instructions, workflows, and agent definitions—exactly what LLMs are good at processing. You're not asking the LLM to guess; you're giving it the actual source material.
|
||||
### 1. Choose Your Source
|
||||
|
||||
## How to Do It
|
||||
| Source | Best For | Examples |
|
||||
| -------------------- | ----------------------------------------- | ---------------------------- |
|
||||
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
|
||||
| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
|
||||
| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" |
|
||||
|
||||
### What Each Source Gives You
|
||||
The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead.
|
||||
|
||||
| Source | Best For | Examples |
|
||||
|--------|----------|----------|
|
||||
| **`_bmad` folder** (installed) | How BMAD works in detail—agents, workflows, prompts | "What does the PM agent do?" "How does the PRD workflow work?" |
|
||||
| **Full GitHub repo** (cloned) | Why things are the way they are—history, installer, architecture | "Why is the installer structured this way?" "What changed in v6?" |
|
||||
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMAD's four phases" "What's the difference between levels?" |
|
||||
### 2. Point Your AI at the Source
|
||||
|
||||
:::note[What's `_bmad`?]
|
||||
The `_bmad` folder is created when you install BMAD. It contains all the agent definitions, workflows, and prompts. If you don't have this folder yet, you haven't installed BMAD—see the "clone the repo" option below.
|
||||
:::
|
||||
**If your AI can read files (Claude Code, Cursor, etc.):**
|
||||
|
||||
### If Your AI Can Read Files (Claude Code, Cursor, etc.)
|
||||
- **BMad installed:** Point at the `_bmad` folder and ask directly
|
||||
- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||
|
||||
**BMAD installed:** Point your LLM at the `_bmad` folder and ask directly.
|
||||
|
||||
**Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) for git history and installer details.
|
||||
|
||||
### If You Use ChatGPT or Claude.ai
|
||||
**If you use ChatGPT or Claude.ai:**
|
||||
|
||||
Fetch `llms-full.txt` into your session:
|
||||
|
||||
@@ -45,32 +42,39 @@ Fetch `llms-full.txt` into your session:
|
||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
```
|
||||
|
||||
You can also find this and other downloadable resources on the [Downloads page](/downloads).
|
||||
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
||||
|
||||
:::tip[Verify Surprising Answers]
|
||||
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
|
||||
### 3. Ask Your Question
|
||||
|
||||
:::note[Example]
|
||||
**Q:** "Tell me the fastest way to build something with BMad"
|
||||
|
||||
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
||||
:::
|
||||
|
||||
## What You Get
|
||||
|
||||
Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond.
|
||||
|
||||
## Tips
|
||||
|
||||
- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord.
|
||||
- **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?"
|
||||
|
||||
## Still Stuck?
|
||||
|
||||
Tried the LLM approach and still need help? You now have a much better question to ask.
|
||||
|
||||
| Channel | Use For |
|
||||
|---------|---------|
|
||||
| `#bmad-method-help` | Quick questions (real-time chat) |
|
||||
| `help-requests` forum | Detailed questions (searchable, persistent) |
|
||||
| `#suggestions-feedback` | Ideas and feature requests |
|
||||
| `#report-bugs-and-issues` | Bug reports |
|
||||
| Channel | Use For |
|
||||
| ------------------------- | ------------------------------------------- |
|
||||
| `#bmad-method-help` | Quick questions (real-time chat) |
|
||||
| `help-requests` forum | Detailed questions (searchable, persistent) |
|
||||
| `#suggestions-feedback` | Ideas and feature requests |
|
||||
| `#report-bugs-and-issues` | Bug reports |
|
||||
|
||||
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
## Found a Bug?
|
||||
|
||||
If it's clearly a bug in BMAD itself, skip Discord and go straight to GitHub Issues:
|
||||
|
||||
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
|
||||
---
|
||||
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs)
|
||||
|
||||
*You!*
|
||||
*Stuck*
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
title: "How-To Guides"
|
||||
---
|
||||
|
||||
|
||||
Task-oriented guides that show you how to accomplish specific goals. Each guide assumes you already understand the basics.
|
||||
|
||||
## Installation
|
||||
|
||||
- [Upgrade to V6](./installation/upgrade-to-v6.md)
|
||||
- [Install Custom Modules](./installation/install-custom-modules.md)
|
||||
|
||||
## IDE Setup
|
||||
|
||||
*Coming soon*
|
||||
|
||||
## Customization
|
||||
|
||||
- [Customize Agents](./customization/customize-agents.md)
|
||||
- [Customize Workflows](./customization/customize-workflows.md)
|
||||
- [Vendor Workflows](./customization/vendor-workflows.md)
|
||||
- [Shard Large Documents](./customization/shard-large-documents.md)
|
||||
|
||||
## Workflows
|
||||
|
||||
Guides for running specific BMAD workflows.
|
||||
|
||||
## Brownfield Projects
|
||||
|
||||
Working with existing codebases.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Solutions to common problems.
|
||||
|
||||
- [Get Answers About BMAD](./get-answers-about-bmad.md)
|
||||
82
docs/how-to/install-bmad.md
Normal file
82
docs/how-to/install-bmad.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: "How to Install BMad"
|
||||
description: Step-by-step guide to installing BMad in your project
|
||||
---
|
||||
|
||||
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Starting a new project with BMad
|
||||
- Adding BMad to an existing codebase
|
||||
- Update the existing BMad Installation
|
||||
|
||||
:::note[Prerequisites]
|
||||
- **Node.js** 20+ (required for the installer)
|
||||
- **Git** (recommended)
|
||||
- **AI tool** (Claude Code, Cursor, Windsurf, or similar)
|
||||
:::
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Run the Installer
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
### 2. Choose Installation Location
|
||||
|
||||
The installer will ask where to install BMad files:
|
||||
|
||||
- Current directory (recommended for new projects if you created the directory yourself and ran from within the directory)
|
||||
- Custom path
|
||||
|
||||
### 3. Select Your AI Tools
|
||||
|
||||
Pick which AI tools you use:
|
||||
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
- Others
|
||||
|
||||
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
||||
|
||||
### 4. Choose Modules
|
||||
|
||||
The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module).
|
||||
|
||||
### 5. Follow the Prompts
|
||||
|
||||
The installer guides you through the rest — custom content, settings, etc.
|
||||
|
||||
## What You Get
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/
|
||||
│ ├── bmm/ # Your selected modules
|
||||
│ │ └── config.yaml # Module settings (if you ever need to change them)
|
||||
│ ├── core/ # Required core module
|
||||
│ └── ...
|
||||
├── _bmad-output/ # Generated artifacts
|
||||
└── .claude/ # Claude Code commands (if using Claude Code)
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
|
||||
Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next.
|
||||
|
||||
**Latest from main branch:**
|
||||
```bash
|
||||
npx github:bmad-code-org/BMAD-METHOD install
|
||||
```
|
||||
|
||||
Use these if you want the newest features before they're officially released. Things might break.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Installer throws an error** — Copy-paste the output into your AI assistant and let it figure it out.
|
||||
|
||||
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](/docs/how-to/get-answers-about-bmad.md) for how to point your AI at the right sources.
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: "Installation Guides"
|
||||
description: How to install and upgrade BMad Method
|
||||
---
|
||||
|
||||
|
||||
How-to guides for installing and configuring the BMad Method.
|
||||
|
||||
## Available Guides
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| **[Install BMad](./install-bmad.md)** | Step-by-step installation instructions |
|
||||
| **[Install Custom Modules](./install-custom-modules.md)** | Add custom agents, workflows, and modules |
|
||||
| **[Upgrade to v6](./upgrade-to-v6.md)** | Migrate from BMad v4 to v6 |
|
||||
@@ -1,138 +0,0 @@
|
||||
---
|
||||
title: "How to Install BMAD"
|
||||
description: Step-by-step guide to installing BMAD in your project
|
||||
---
|
||||
|
||||
|
||||
Complete guide to installing BMAD in your project.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Node.js** 20+ (required for the installer)
|
||||
- **Git** (recommended)
|
||||
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Run the Installer
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
### 2. Choose Installation Location
|
||||
|
||||
The installer will ask where to install BMAD files. Options:
|
||||
- Current directory (recommended for new projects)
|
||||
- Subdirectory
|
||||
- Custom path
|
||||
|
||||
### 3. Select Your AI Tools
|
||||
|
||||
Choose which AI tools you'll be using:
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
- Other
|
||||
|
||||
The installer configures BMAD for your selected tools.
|
||||
|
||||
### 4. Choose Modules
|
||||
|
||||
Select which modules to install:
|
||||
|
||||
| Module | Purpose |
|
||||
|--------|---------|
|
||||
| **BMM** | Core methodology for software development |
|
||||
| **BMGD** | Game development workflows |
|
||||
| **CIS** | Creative intelligence and facilitation |
|
||||
| **BMB** | Building custom agents and workflows |
|
||||
|
||||
### 5. Add Custom Content (Optional)
|
||||
|
||||
If you have custom agents, workflows, or modules:
|
||||
- Point to their location
|
||||
- The installer will integrate them
|
||||
|
||||
### 6. Configure Settings
|
||||
|
||||
For each module, either:
|
||||
- Accept recommended defaults (faster)
|
||||
- Customize settings (more control)
|
||||
|
||||
---
|
||||
|
||||
## Verify Installation
|
||||
|
||||
After installation, verify by:
|
||||
|
||||
1. Checking the `_bmad/` directory exists
|
||||
2. Loading an agent in your AI tool
|
||||
3. Running `*menu` to see available commands
|
||||
|
||||
---
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/
|
||||
│ ├── bmm/ # Method module
|
||||
│ │ ├── agents/ # Agent files
|
||||
│ │ ├── workflows/ # Workflow files
|
||||
│ │ └── config.yaml # Module config
|
||||
│ ├── core/ # Core utilities
|
||||
│ └── ...
|
||||
├── _bmad-output/ # Generated artifacts
|
||||
└── .claude/ # IDE configuration
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `_bmad/[module]/config.yaml` to customize:
|
||||
|
||||
```yaml
|
||||
output_folder: ./_bmad-output
|
||||
user_name: Your Name
|
||||
communication_language: english
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Command not found: npx"
|
||||
|
||||
Install Node.js 20+:
|
||||
```bash
|
||||
brew install node
|
||||
|
||||
```
|
||||
|
||||
### "Permission denied"
|
||||
|
||||
Check npm permissions:
|
||||
```bash
|
||||
npm config set prefix ~/.npm-global
|
||||
```
|
||||
|
||||
### Installer hangs
|
||||
|
||||
Try running with verbose output:
|
||||
```bash
|
||||
npx bmad-method install --verbose
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
||||
- [Upgrade to V6](./upgrade-to-v6.md) - Upgrading from previous versions
|
||||
- [Install Custom Modules](./install-custom-modules.md) - Adding custom content
|
||||
@@ -1,152 +0,0 @@
|
||||
---
|
||||
title: "Custom Content Installation"
|
||||
---
|
||||
|
||||
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||
|
||||
For detailed information about the different types of custom content available, see [Custom Content Types](../../explanation/bmad-builder/custom-content-types.md).
|
||||
|
||||
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
|
||||
|
||||
## Content Types Overview
|
||||
|
||||
BMAD Core supports several categories of custom content:
|
||||
|
||||
- Custom Stand Alone Modules
|
||||
- Custom Add On Modules
|
||||
- Custom Global Modules
|
||||
- Custom Agents
|
||||
- Custom Workflows
|
||||
|
||||
## Making Custom Content Installable
|
||||
|
||||
### Custom Modules
|
||||
|
||||
To create an installable custom module:
|
||||
|
||||
1. **Folder Structure**
|
||||
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
||||
- The folder name serves as the module code
|
||||
|
||||
2. **Required File**
|
||||
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
|
||||
|
||||
3. **Folder Organization**
|
||||
Follow these conventions for optimal compatibility:
|
||||
|
||||
```
|
||||
module-code/
|
||||
module.yaml
|
||||
agents/
|
||||
workflows/
|
||||
tools/
|
||||
templates/
|
||||
...
|
||||
```
|
||||
|
||||
- `agents/` - Agent definitions
|
||||
- `workflows/` - Workflow definitions
|
||||
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
|
||||
|
||||
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
|
||||
|
||||
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
|
||||
|
||||
For standalone content that isn't part of a cohesive module collection, follow this structure:
|
||||
|
||||
1. **Module Configuration**
|
||||
- Create a folder with a `module.yaml` file (similar to custom modules)
|
||||
- Add the property `unitary: true` in the module.yaml
|
||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
|
||||
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules.
|
||||
|
||||
2. **Folder Structure**
|
||||
Organize content in specific named folders:
|
||||
|
||||
```
|
||||
module-name/
|
||||
module.yaml # Contains unitary: true
|
||||
agents/
|
||||
workflows/
|
||||
templates/
|
||||
tools/
|
||||
tasks/
|
||||
prompts/
|
||||
```
|
||||
|
||||
3. **Individual Item Organization**
|
||||
Each item should have its own subfolder:
|
||||
```text
|
||||
my-custom-stuff/
|
||||
module.yaml
|
||||
agents/
|
||||
larry/larry.agent.md
|
||||
curly/curly.agent.md
|
||||
moe/moe.agent.md
|
||||
moe/moe-sidecar/memories.csv
|
||||
```
|
||||
|
||||
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install.
|
||||
|
||||
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon.
|
||||
|
||||
## Installation Process
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder).
|
||||
|
||||
### New Project Installation
|
||||
|
||||
When setting up a new BMAD project:
|
||||
|
||||
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)`
|
||||
2. Select 'y' to specify the path to your module folder containing `module.yaml`
|
||||
|
||||
### Existing Project Modification
|
||||
|
||||
To add custom content to an existing BMAD project:
|
||||
|
||||
1. Run the installer against your project location
|
||||
2. Select `Modify BMAD Installation`
|
||||
3. Choose the option to add, modify, or update custom modules
|
||||
|
||||
### Upcoming Features
|
||||
|
||||
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install
|
||||
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
|
||||
|
||||
## Quick Updates
|
||||
|
||||
When updates to BMAD Core or core modules (BMM, CIS, etc.) become available, the quick update process will:
|
||||
|
||||
1. Apply available updates to core modules
|
||||
2. Recompile all agents with customizations from the `_config/agents` folder
|
||||
3. Retain your custom content from a cached location
|
||||
4. Preserve your existing configurations and customizations
|
||||
|
||||
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process.
|
||||
|
||||
## Important Considerations
|
||||
|
||||
### Module Naming Conflicts
|
||||
|
||||
When installing unofficial modules, ensure unique identification to avoid conflicts:
|
||||
|
||||
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules)
|
||||
2. **Module Names:** Avoid using names that conflict with existing modules
|
||||
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
|
||||
|
||||
**Examples of conflicts to avoid:**
|
||||
|
||||
- Don't create a custom module with code `bmm` (already used by BMad Method)
|
||||
- Don't name multiple custom modules with the same code like `mca`
|
||||
|
||||
### Best Practices
|
||||
|
||||
- Use descriptive, unique codes for your modules
|
||||
- Document any dependencies your custom modules have
|
||||
- Test custom modules in isolation before sharing
|
||||
- Consider version numbering for your custom content to track updates
|
||||
@@ -1,147 +0,0 @@
|
||||
---
|
||||
title: "BMad v4 to v6 Upgrade Guide"
|
||||
---
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
|
||||
---
|
||||
|
||||
## Automatic V4 Detection
|
||||
|
||||
When you run `npm run install:bmad` on a project, the installer automatically detects:
|
||||
|
||||
- **Legacy v4 installation folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Detection of v4 Modules**
|
||||
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
|
||||
- NOTE: if the upgrade and install of v6 finished, the new commands will be under `.claude/commands/bmad/<module>/agents|workflows`
|
||||
- Note 2: If you accidentally delete the wrong/new bmad commands - you can easily restore them by rerunning the installer, and choose quick update option, and all will be reapplied properly.
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules from v4
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ---------------------------------------------- |
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-godot-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-*-game-dev` (any) | Integrated into new BMGD Module |
|
||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
|
||||
|
||||
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
### Folder Structure
|
||||
|
||||
**v4 "Expansion Packs" Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .bmad-method/
|
||||
├── .bmad-game-dev/
|
||||
├── .bmad-creative-writing/
|
||||
└── .bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder is _bmad
|
||||
└── _config/ # Your customizations
|
||||
| └── agents/ # Agent customization files
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
├── _bmad_output # Default bmad output folder (was doc folder in v4)
|
||||
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
|
||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
|
||||
|
||||
## Project Progress Migration
|
||||
|
||||
### If You've Completed Some or all Planning Phases (Brief/PRD/UX/Architecture) with the BMad Method:
|
||||
|
||||
After running the v6 installer, if you kept the paths the same as the installation suggested, you will need to move a few files, or run the installer again. It is recommended to stick with these defaults as it will be easier to adapt if things change in the future.
|
||||
|
||||
If you have any planning artifacts, put them in a folder called _bmad-output/planning-artifacts at the root of your project, ensuring that:
|
||||
PRD has PRD in the file name or folder name if sharded.
|
||||
Similar for 'brief', 'architecture', 'ux-design'.
|
||||
|
||||
If you have other long term docs that will not be as ephemeral as these project docs, you can put them in the /docs folder, ideally with a index.md file.
|
||||
|
||||
HIGHLY RECOMMENDED NOTE: If you are only partway through planning, its highly recommended to restart and do the PRD, UX and ARCHITECTURE steps. You could even use your existing documents as inputs letting the agent know you want to redo them with the new workflows. These optimized v6 progressive discovery workflows that also will utilize web search at key moments, while offering better advanced elicitation and part mode in the IDE will produce superior results. And then once all are complete, an epics with stories is generated after the architecture step now - ensuring it uses input from all planing documents.
|
||||
|
||||
### If You're Mid-Development (Stories Created/Implemented)
|
||||
|
||||
1. Complete the v6 installation as above
|
||||
2. Ensure you have a file called epics.md or epics/epic*.md - these need to be located under the _bmad-output/planning-artifacts folder.
|
||||
3. Run the scrum masters `sprint-planning` workflow to generate the implementation tracking plan in _bmad-output/implementation-artifacts.
|
||||
4. Inform the SM after the output is complete which epics and stories were completed already and should be parked properly in the file.
|
||||
|
||||
## Agent Customization Migration
|
||||
|
||||
### v4 Agent Customization
|
||||
|
||||
In v4, you may have modified agent files directly in `_bmad-*` folders.
|
||||
|
||||
### v6 Agent Customization
|
||||
|
||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
persona:
|
||||
name: 'Captain Jack' # Override agent name
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors for software concepts
|
||||
- Always upbeat and adventurous
|
||||
```
|
||||
|
||||
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](../customization/customize-agents.md)
|
||||
|
||||
CRITICAL NOTE: After you modify the customization file, you need to run the npx installer against your installed location, and choose the option to rebuild all agents, or just do a quick update again. This always builds agents fresh and applies customizations.
|
||||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
||||
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
- Rebuild all agents -> Result: Agent uses your custom name and style
|
||||
|
||||
## Document Compatibility
|
||||
|
||||
### Sharded vs Unsharded Documents
|
||||
|
||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
||||
|
||||
- ✅ Sharded documents (split into multiple files)
|
||||
- ✅ Unsharded documents (single file per section)
|
||||
- ✅ Custom sections for your project type
|
||||
- ✅ Mixed approaches
|
||||
|
||||
All workflow files are scanned automatically. No manual configuration needed.
|
||||
@@ -2,16 +2,14 @@
|
||||
title: "Document Sharding Guide"
|
||||
---
|
||||
|
||||
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
|
||||
|
||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
||||
## When to Use This
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [What is Document Sharding?](#what-is-document-sharding)
|
||||
- [When to Use Sharding](#when-to-use-sharding)
|
||||
- [How Sharding Works](#how-sharding-works)
|
||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
||||
- [Workflow Support](#workflow-support)
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
@@ -39,43 +37,15 @@ docs/
|
||||
└── ... # Additional sections
|
||||
```
|
||||
|
||||
## When to Use Sharding
|
||||
## Steps
|
||||
|
||||
### Ideal Candidates
|
||||
|
||||
**Large Multi-Epic Projects:**
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
## How Sharding Works
|
||||
|
||||
### Sharding Process
|
||||
|
||||
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
|
||||
2. **Section Extraction**: Tool splits by level 2 headings
|
||||
3. **File Creation**: Each section becomes a separate file
|
||||
4. **Index Generation**: `index.md` created with structure and descriptions
|
||||
|
||||
### Workflow Discovery
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
||||
1. **Try whole document first** - Look for `document-name.md`
|
||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead.
|
||||
|
||||
## Using the Shard-Doc Tool
|
||||
|
||||
### CLI Command
|
||||
### 1. Run the Shard-Doc Tool
|
||||
|
||||
```bash
|
||||
/bmad:core:tools:shard-doc
|
||||
/bmad:core:tools:shard-doc
|
||||
```
|
||||
|
||||
### Interactive Process
|
||||
### 2. Follow the Interactive Process
|
||||
|
||||
```
|
||||
Agent: Which document would you like to shard?
|
||||
@@ -91,7 +61,7 @@ Agent: Sharding PRD.md...
|
||||
✓ Complete!
|
||||
```
|
||||
|
||||
### What Gets Created
|
||||
## What You Get
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
@@ -113,13 +83,19 @@ Agent: Sharding PRD.md...
|
||||
- Preserves all markdown formatting
|
||||
- Can be read independently
|
||||
|
||||
## How Workflow Discovery Works
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
||||
1. **Try whole document first** - Look for `document-name.md`
|
||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead
|
||||
|
||||
## Workflow Support
|
||||
|
||||
### Universal Support
|
||||
All BMM workflows support both formats:
|
||||
|
||||
**All BMM workflows support both formats:**
|
||||
|
||||
- ✅ Whole documents
|
||||
- ✅ Sharded documents
|
||||
- ✅ Automatic detection
|
||||
- ✅ Transparent to user
|
||||
- Whole documents
|
||||
- Sharded documents
|
||||
- Automatic detection
|
||||
- Transparent to user
|
||||
@@ -1,261 +0,0 @@
|
||||
---
|
||||
title: "BMGD Troubleshooting"
|
||||
---
|
||||
|
||||
|
||||
Common issues and solutions when using BMGD workflows.
|
||||
|
||||
---
|
||||
|
||||
## Installation Issues
|
||||
|
||||
### BMGD module not appearing
|
||||
|
||||
**Symptom:** BMGD agents and workflows are not available after installation.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Verify BMGD was selected during installation
|
||||
2. Check `_bmad/bmgd/` folder exists in your project
|
||||
3. Re-run installer with `--add-module bmgd`
|
||||
|
||||
---
|
||||
|
||||
### Config file missing
|
||||
|
||||
**Symptom:** Workflows fail with "config not found" errors.
|
||||
|
||||
**Solution:**
|
||||
Check for `_bmad/bmgd/config.yaml` in your project. If missing, create it:
|
||||
|
||||
```yaml
|
||||
output_folder: '{project-root}/docs/game-design'
|
||||
user_name: 'Your Name'
|
||||
communication_language: 'English'
|
||||
document_output_language: 'English'
|
||||
game_dev_experience: 'intermediate'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow Issues
|
||||
|
||||
### "GDD not found" in Narrative workflow
|
||||
|
||||
**Symptom:** Narrative workflow can't find the GDD.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure GDD exists in `{output_folder}`
|
||||
2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`)
|
||||
3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists
|
||||
|
||||
---
|
||||
|
||||
### Workflow state not persisting
|
||||
|
||||
**Symptom:** Returning to a workflow starts from the beginning.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Check the output document's frontmatter for `stepsCompleted` array
|
||||
2. Ensure document was saved before ending session
|
||||
3. Use "Continue existing" option when re-entering workflow
|
||||
|
||||
---
|
||||
|
||||
### Wrong game type sections in GDD
|
||||
|
||||
**Symptom:** GDD includes irrelevant sections for your game type.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Review game type selection at Step 7 of GDD workflow
|
||||
2. You can select multiple types for hybrid games
|
||||
3. Irrelevant sections can be marked N/A or removed
|
||||
|
||||
---
|
||||
|
||||
## Agent Issues
|
||||
|
||||
### Agent not recognizing commands
|
||||
|
||||
**Symptom:** Typing a command like `create-gdd` doesn't trigger the workflow.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure you're chatting with the correct agent (Game Designer for GDD)
|
||||
2. Check exact command spelling (case-sensitive)
|
||||
3. Try `workflow-status` to verify agent is loaded correctly
|
||||
|
||||
---
|
||||
|
||||
### Agent using wrong persona
|
||||
|
||||
**Symptom:** Agent responses don't match expected personality.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Verify correct agent file is loaded
|
||||
2. Check `_bmad/bmgd/agents/` for agent definitions
|
||||
3. Start a fresh chat session with the correct agent
|
||||
|
||||
---
|
||||
|
||||
## Document Issues
|
||||
|
||||
### Document too large for context
|
||||
|
||||
**Symptom:** AI can't process the entire GDD or narrative document.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Use sharded document structure (index.md + section files)
|
||||
2. Request specific sections rather than full document
|
||||
3. GDD workflow supports automatic sharding for large documents
|
||||
|
||||
---
|
||||
|
||||
### Template placeholders not replaced
|
||||
|
||||
**Symptom:** Output contains `{{placeholder}}` text.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Workflow may have been interrupted before completion
|
||||
2. Re-run the specific step that generates that section
|
||||
3. Manually edit the document to fill in missing values
|
||||
|
||||
---
|
||||
|
||||
### Frontmatter parsing errors
|
||||
|
||||
**Symptom:** YAML errors when loading documents.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Validate YAML syntax (proper indentation, quotes around special characters)
|
||||
2. Check for tabs vs spaces (YAML requires spaces)
|
||||
3. Ensure frontmatter is bounded by `---` markers
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 (Production) Issues
|
||||
|
||||
### Sprint status not updating
|
||||
|
||||
**Symptom:** Story status changes don't reflect in sprint-status.yaml.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Run `sprint-planning` to refresh status
|
||||
2. Check file permissions on sprint-status.yaml
|
||||
3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/`
|
||||
|
||||
---
|
||||
|
||||
### Story context missing code references
|
||||
|
||||
**Symptom:** Generated story context doesn't include relevant code.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure project-context.md exists and is current
|
||||
2. Check that architecture document references correct file paths
|
||||
3. Story may need more specific file references in acceptance criteria
|
||||
|
||||
---
|
||||
|
||||
### Code review not finding issues
|
||||
|
||||
**Symptom:** Code review passes but bugs exist.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Code review is AI-assisted, not comprehensive testing
|
||||
2. Always run actual tests before marking story done
|
||||
3. Consider manual review for critical code paths
|
||||
|
||||
---
|
||||
|
||||
## Performance Issues
|
||||
|
||||
### Workflows running slowly
|
||||
|
||||
**Symptom:** Long wait times between workflow steps.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Use IDE-based workflows (faster than web)
|
||||
2. Keep documents concise (avoid unnecessary detail)
|
||||
3. Use sharded documents for large projects
|
||||
|
||||
---
|
||||
|
||||
### Context limit reached mid-workflow
|
||||
|
||||
**Symptom:** Workflow stops or loses context partway through.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Save progress frequently (workflows auto-save on Continue)
|
||||
2. Break complex sections into multiple sessions
|
||||
3. Use step-file architecture (workflows resume from last step)
|
||||
|
||||
---
|
||||
|
||||
## Common Error Messages
|
||||
|
||||
### "Input file not found"
|
||||
|
||||
**Cause:** Workflow requires a document that doesn't exist.
|
||||
|
||||
**Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD).
|
||||
|
||||
---
|
||||
|
||||
### "Invalid game type"
|
||||
|
||||
**Cause:** Selected game type not in supported list.
|
||||
|
||||
**Fix:** Check `game-types.csv` for valid type IDs.
|
||||
|
||||
---
|
||||
|
||||
### "Validation failed"
|
||||
|
||||
**Cause:** Document doesn't meet checklist requirements.
|
||||
|
||||
**Fix:** Review the validation output and address flagged items.
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Community Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Real-time help from the community
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
|
||||
### Self-Help
|
||||
|
||||
1. Check `workflow-status` to understand current state
|
||||
2. Review workflow markdown files for expected behavior
|
||||
3. Look at completed example documents in the module
|
||||
|
||||
### Reporting Issues
|
||||
|
||||
When reporting issues, include:
|
||||
|
||||
1. Which workflow and step
|
||||
2. Error message (if any)
|
||||
3. Relevant document frontmatter
|
||||
4. Steps to reproduce
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Getting started
|
||||
- **[Workflows Guide](../../reference/workflows/index.md)** - Workflow reference
|
||||
- **[Glossary](../../reference/glossary/index.md)** - Terminology
|
||||
131
docs/how-to/upgrade-to-v6.md
Normal file
131
docs/how-to/upgrade-to-v6.md
Normal file
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: "How to Upgrade to v6"
|
||||
description: Migrate from BMad v4 to v6
|
||||
---
|
||||
|
||||
Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
|
||||
|
||||
## When to Use This
|
||||
|
||||
- You have BMad v4 installed (`.bmad-method` folder)
|
||||
- You want to migrate to the new v6 architecture
|
||||
- You have existing planning artifacts to preserve
|
||||
|
||||
:::note[Prerequisites]
|
||||
- Node.js 20+
|
||||
- Existing BMad v4 installation
|
||||
:::
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Run the Installer
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
The installer automatically detects:
|
||||
|
||||
- **Legacy v4 folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
|
||||
|
||||
### 2. Handle Legacy Installation
|
||||
|
||||
When v4 is detected, you can:
|
||||
|
||||
- Allow the installer to back up and remove `.bmad-method`
|
||||
- Exit and handle cleanup manually
|
||||
- Keep both (not recommended for same project)
|
||||
|
||||
### 3. Clean Up IDE Commands
|
||||
|
||||
Manually remove legacy v4 IDE commands:
|
||||
|
||||
- `.claude/commands/BMad/agents`
|
||||
- `.claude/commands/BMad/tasks`
|
||||
|
||||
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
|
||||
|
||||
:::tip[Accidentally Deleted Commands?]
|
||||
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
|
||||
:::
|
||||
|
||||
### 4. Migrate Planning Artifacts
|
||||
|
||||
**If you have planning documents (Brief/PRD/UX/Architecture):**
|
||||
|
||||
Move them to `_bmad-output/planning-artifacts/` with descriptive names:
|
||||
|
||||
- Include `PRD` in filename for PRD documents
|
||||
- Include `brief`, `architecture`, or `ux-design` accordingly
|
||||
- Sharded documents can be in named subfolders
|
||||
|
||||
**If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results.
|
||||
|
||||
### 5. Migrate In-Progress Development
|
||||
|
||||
If you have stories created or implemented:
|
||||
|
||||
1. Complete the v6 installation
|
||||
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
|
||||
3. Run the Scrum Master's `sprint-planning` workflow
|
||||
4. Tell the SM which epics/stories are already complete
|
||||
|
||||
### 6. Migrate Agent Customizations
|
||||
|
||||
**v4:** Modified agent files directly in `_bmad-*` folders
|
||||
|
||||
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
```yaml
|
||||
# _bmad/_config/agents/bmm-pm.customize.yaml
|
||||
persona:
|
||||
name: 'Captain Jack'
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors
|
||||
```
|
||||
|
||||
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
|
||||
|
||||
## What You Get
|
||||
|
||||
**v6 unified structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder
|
||||
├── _config/ # Your customizations
|
||||
│ └── agents/ # Agent customization files
|
||||
├── core/ # Universal core framework
|
||||
├── bmm/ # BMad Method module
|
||||
├── bmb/ # BMad Builder
|
||||
└── cis/ # Creative Intelligence Suite
|
||||
├── _bmad-output/ # Output folder (was doc folder in v4)
|
||||
```
|
||||
|
||||
## Module Migration
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
|-----------|-----------|
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
||||
|
||||
## Key Changes
|
||||
|
||||
| Concept | v4 | v6 |
|
||||
|---------|----|----|
|
||||
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
|
||||
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||
| **Config** | Modified files directly | `config.yaml` per module |
|
||||
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
|
||||
|
||||
## Tips
|
||||
|
||||
- **Back up first** — Keep your v4 installation until you verify v6 works
|
||||
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
|
||||
- **Rebuild after customizing** — Always run the installer after changing customize files
|
||||
@@ -1,291 +0,0 @@
|
||||
---
|
||||
title: "BMGD Quick-Flow Guide"
|
||||
---
|
||||
|
||||
|
||||
Fast-track workflows for rapid game prototyping and flexible development.
|
||||
|
||||
---
|
||||
|
||||
## Game Solo Dev Agent
|
||||
|
||||
For dedicated quick-flow development, use the **Game Solo Dev** agent (Indie). This agent is optimized for solo developers and small teams who want to skip the full planning phases and ship fast.
|
||||
|
||||
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select the agent from your IDE.
|
||||
|
||||
The Game Solo Dev agent includes:
|
||||
|
||||
- `quick-prototype` - Rapid mechanic testing
|
||||
- `quick-dev` - Flexible feature implementation
|
||||
- `create-tech-spec` - Create implementation-ready specs
|
||||
- `code-review` - Quality checks
|
||||
- `test-framework` - Automated testing setup
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Quick-flow workflows skip the full BMGD planning phases when you need to move fast. Use them for:
|
||||
|
||||
- Testing a game mechanic idea
|
||||
- Implementing a small feature
|
||||
- Rapid prototyping before committing to design
|
||||
- Bug fixes and tweaks
|
||||
|
||||
```
|
||||
Full BMGD Flow:
|
||||
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
||||
|
||||
Quick-Flow:
|
||||
Idea → Quick-Prototype → Quick-Dev → Done
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick-Prototype
|
||||
|
||||
**Command:** `quick-prototype`
|
||||
**Agent:** Game Designer, Game Developer
|
||||
**Purpose:** Rapidly test gameplay ideas with minimal setup
|
||||
|
||||
### When to Use
|
||||
|
||||
- You have a mechanic idea and want to test the "feel"
|
||||
- You're not sure if something will be fun
|
||||
- You want to experiment before committing to design
|
||||
- You need a proof of concept
|
||||
|
||||
### Workflow Steps
|
||||
|
||||
1. **Define Scope** - What are you prototyping? (mechanic, feature, system)
|
||||
2. **Set Success Criteria** - How will you know if it works?
|
||||
3. **Rapid Implementation** - Build the minimum to test the idea
|
||||
4. **Playtest and Evaluate** - Does it feel right?
|
||||
|
||||
### Prototype Principles
|
||||
|
||||
- **Minimum Viable Prototype** - Only what's needed to test the idea
|
||||
- **Hardcode First** - Magic numbers are fine, extract later
|
||||
- **Skip Edge Cases** - Happy path only for now
|
||||
- **Placeholder Everything** - Cubes, debug text, temp sounds
|
||||
- **Comment Intent** - Mark what's temporary vs keeper code
|
||||
|
||||
### Example Session
|
||||
|
||||
```
|
||||
You: quick-prototype
|
||||
|
||||
Agent: What are you prototyping?
|
||||
|
||||
You: I want to test a grappling hook mechanic. Player should be
|
||||
able to aim at surfaces and pull themselves toward the hook point.
|
||||
|
||||
Agent: What makes this prototype successful?
|
||||
|
||||
You: 1. Aiming feels responsive and intuitive
|
||||
2. The pull movement feels satisfying, not floaty
|
||||
3. Player can chain hooks without awkward pauses
|
||||
|
||||
Agent: [Implements minimal grappling hook]
|
||||
|
||||
Agent: Prototype complete! Playtest results:
|
||||
- Aiming: Works, consider adding aim assist
|
||||
- Movement: Pull is smooth, might need speed curve
|
||||
- Chaining: Currently has 0.2s delay, feels sluggish
|
||||
|
||||
Next: [d] Develop further | [i] Iterate | [a] Archive
|
||||
```
|
||||
|
||||
### After Prototyping
|
||||
|
||||
- **Develop** (`d`) - Use `quick-dev` to build production code
|
||||
- **Iterate** (`i`) - Adjust and re-test the prototype
|
||||
- **Archive** (`a`) - Keep as reference, move on to other ideas
|
||||
|
||||
---
|
||||
|
||||
## Quick-Dev
|
||||
|
||||
**Command:** `quick-dev`
|
||||
**Agent:** Game Developer
|
||||
**Purpose:** Flexible development with game-specific considerations
|
||||
|
||||
### When to Use
|
||||
|
||||
- Implementing a feature from a tech-spec
|
||||
- Building on a successful prototype
|
||||
- Making changes that don't need full story workflow
|
||||
- Quick fixes and improvements
|
||||
|
||||
### Workflow Modes
|
||||
|
||||
**Mode A: Tech-Spec Driven**
|
||||
|
||||
```
|
||||
You: quick-dev tech-spec-combat.md
|
||||
Agent: [Loads spec, extracts tasks, implements]
|
||||
```
|
||||
|
||||
**Mode B: Direct Instructions**
|
||||
|
||||
```
|
||||
You: quick-dev implement double-jump for the player
|
||||
Agent: [Evaluates complexity, offers planning options]
|
||||
```
|
||||
|
||||
**Mode C: From Prototype**
|
||||
|
||||
```
|
||||
You: quick-dev from the grappling hook prototype
|
||||
Agent: [Loads prototype, productionizes code]
|
||||
```
|
||||
|
||||
### Game-Specific Checks
|
||||
|
||||
Quick-dev includes automatic consideration of:
|
||||
|
||||
- **Performance** - No allocations in hot paths, object pooling
|
||||
- **Feel** - Input responsiveness, visual/audio feedback
|
||||
- **Integration** - Save/load, multiplayer sync, platform testing
|
||||
|
||||
### Example Session
|
||||
|
||||
```
|
||||
You: quick-dev implement enemy patrol behavior
|
||||
|
||||
Agent: This looks like a focused feature. Options:
|
||||
[t] Plan first - Create tech-spec (recommended)
|
||||
[r] Prototype first - Test the idea
|
||||
[e] Execute directly
|
||||
|
||||
You: e
|
||||
|
||||
Agent: Any additional guidance? (patterns, files, constraints)
|
||||
|
||||
You: Use the existing AIController base class. Enemies should
|
||||
patrol between waypoints and return if player leaves range.
|
||||
|
||||
Agent: [Implements patrol behavior]
|
||||
|
||||
Agent: Implementation Complete!
|
||||
Files Modified: EnemyAI.cs, PatrolBehavior.cs
|
||||
Tests: Unit tests added for patrol state machine
|
||||
Performance: No per-frame allocations
|
||||
|
||||
Recommended: Playtest the changes
|
||||
```
|
||||
|
||||
### Complexity Routing
|
||||
|
||||
Quick-dev automatically detects complex requests and offers alternatives:
|
||||
|
||||
| Signals | Recommendation |
|
||||
| -------------------------------------- | ---------------------- |
|
||||
| Single mechanic, bug fix, tweak | Execute directly |
|
||||
| Multiple systems, performance-critical | Plan first (tech-spec) |
|
||||
| Platform/system level work | Use full BMGD workflow |
|
||||
|
||||
---
|
||||
|
||||
## Choosing Between Quick-Flows
|
||||
|
||||
| Scenario | Use |
|
||||
| ----------------------- | ------------------------------- |
|
||||
| "Will this be fun?" | `quick-prototype` |
|
||||
| "How should this feel?" | `quick-prototype` |
|
||||
| "Build this feature" | `quick-dev` |
|
||||
| "Fix this bug" | `quick-dev` |
|
||||
| "Test then build" | `quick-prototype` → `quick-dev` |
|
||||
|
||||
---
|
||||
|
||||
## Quick-Flow vs Full BMGD
|
||||
|
||||
### Use Quick-Flow When
|
||||
|
||||
- The scope is small and well-understood
|
||||
- You're experimenting or prototyping
|
||||
- You have a clear tech-spec already
|
||||
- The work doesn't affect core game systems significantly
|
||||
|
||||
### Use Full BMGD When
|
||||
|
||||
- Building a major feature or system
|
||||
- The scope is unclear or large
|
||||
- Multiple team members need alignment
|
||||
- The work affects game pillars or core loop
|
||||
- You need documentation for future reference
|
||||
|
||||
---
|
||||
|
||||
## Checklists
|
||||
|
||||
### Quick-Prototype Checklist
|
||||
|
||||
**Before:**
|
||||
|
||||
- [ ] Prototype scope defined
|
||||
- [ ] Success criteria established (2-3 items)
|
||||
|
||||
**During:**
|
||||
|
||||
- [ ] Minimum viable code written
|
||||
- [ ] Placeholder assets used
|
||||
- [ ] Core functionality testable
|
||||
|
||||
**After:**
|
||||
|
||||
- [ ] Each criterion evaluated
|
||||
- [ ] Decision made (develop/iterate/archive)
|
||||
|
||||
### Quick-Dev Checklist
|
||||
|
||||
**Before:**
|
||||
|
||||
- [ ] Context loaded (spec, prototype, or guidance)
|
||||
- [ ] Files to modify identified
|
||||
- [ ] Patterns understood
|
||||
|
||||
**During:**
|
||||
|
||||
- [ ] All tasks completed
|
||||
- [ ] No allocations in hot paths
|
||||
- [ ] Frame rate maintained
|
||||
|
||||
**After:**
|
||||
|
||||
- [ ] Game runs without errors
|
||||
- [ ] Feature works as specified
|
||||
- [ ] Manual playtest completed
|
||||
|
||||
---
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### 1. Timebox Prototypes
|
||||
|
||||
Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider.
|
||||
|
||||
### 2. Embrace Programmer Art
|
||||
|
||||
Prototypes don't need to look good. Focus on feel, not visuals.
|
||||
|
||||
### 3. Test on Target Hardware
|
||||
|
||||
What feels right on your dev machine might not feel right on target platform.
|
||||
|
||||
### 4. Document Learnings
|
||||
|
||||
Even failed prototypes teach something. Note what you learned.
|
||||
|
||||
### 5. Know When to Graduate
|
||||
|
||||
If quick-dev keeps expanding scope, stop and create proper stories.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Workflows Guide](../../reference/workflows/bmgd-workflows.md)** - Full workflow reference
|
||||
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Agent capabilities
|
||||
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Getting started with BMGD
|
||||
@@ -1,130 +0,0 @@
|
||||
---
|
||||
title: "How to Conduct Research"
|
||||
description: How to conduct market, technical, and competitive research using BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Need market viability validation
|
||||
- Choosing frameworks or platforms
|
||||
- Understanding competitive landscape
|
||||
- Need user understanding
|
||||
- Understanding domain or industry
|
||||
- Need deeper AI-assisted research
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Analyst agent available
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Analyst Agent
|
||||
|
||||
Start a fresh chat and load the Analyst agent.
|
||||
|
||||
### 2. Run the Research Workflow
|
||||
|
||||
```
|
||||
*research
|
||||
```
|
||||
|
||||
### 3. Choose Research Type
|
||||
|
||||
Select the type of research you need:
|
||||
|
||||
| Type | Purpose | Use When |
|
||||
| --------------- | ------------------------------------------------------ | ----------------------------------- |
|
||||
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
|
||||
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
|
||||
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
|
||||
| **user** | Customer insights, personas, JTBD | Need user understanding |
|
||||
| **domain** | Industry deep dives, trends | Understanding domain/industry |
|
||||
| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research |
|
||||
|
||||
### 4. Provide Context
|
||||
|
||||
Give the agent details about what you're researching:
|
||||
|
||||
- "SaaS project management tool"
|
||||
- "React vs Vue for our dashboard"
|
||||
- "Fintech compliance requirements"
|
||||
|
||||
### 5. Set Research Depth
|
||||
|
||||
Choose your depth level:
|
||||
|
||||
- **Quick** - Fast overview
|
||||
- **Standard** - Balanced depth
|
||||
- **Comprehensive** - Deep analysis
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
### Market Research Example
|
||||
|
||||
```
|
||||
TAM: $50B
|
||||
SAM: $5B
|
||||
SOM: $50M
|
||||
|
||||
Top Competitors:
|
||||
- Asana
|
||||
- Monday
|
||||
- etc.
|
||||
|
||||
Positioning Recommendation: ...
|
||||
```
|
||||
|
||||
### Technical Research Example
|
||||
|
||||
Technology evaluation with:
|
||||
- Comparison matrix
|
||||
- Trade-off analysis
|
||||
- Recommendations with rationale
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- Real-time web research
|
||||
- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle)
|
||||
- Platform-specific optimization for deep_prompt type
|
||||
- Configurable research depth
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After research:
|
||||
|
||||
1. **Product Brief** - Capture strategic vision informed by research
|
||||
2. **PRD** - Use findings as context for requirements
|
||||
3. **Architecture** - Use technical research in ADRs
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Use market research early for new products
|
||||
- Technical research helps with architecture decisions
|
||||
- Competitive research informs positioning
|
||||
- Domain research is valuable for specialized industries
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Run Brainstorming Session](./run-brainstorming-session.md) - Explore ideas before research
|
||||
- [Create Product Brief](./create-product-brief.md) - Capture strategic vision
|
||||
- [Create PRD](./create-prd.md) - Move to formal planning
|
||||
@@ -1,147 +0,0 @@
|
||||
---
|
||||
title: "How to Create Architecture"
|
||||
description: How to create system architecture using the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Multi-epic projects (BMad Method, Enterprise)
|
||||
- Cross-cutting technical concerns
|
||||
- Multiple agents implementing different parts
|
||||
- Integration complexity exists
|
||||
- Technology choices need alignment
|
||||
|
||||
---
|
||||
|
||||
## When to Skip This
|
||||
|
||||
- Quick Flow (simple changes)
|
||||
- BMad Method Simple with straightforward tech stack
|
||||
- Single epic with clear technical approach
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Architect agent available
|
||||
- PRD completed
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Architect Agent
|
||||
|
||||
Start a fresh chat and load the Architect agent.
|
||||
|
||||
### 2. Run the Architecture Workflow
|
||||
|
||||
```
|
||||
*create-architecture
|
||||
```
|
||||
|
||||
### 3. Engage in Discovery
|
||||
|
||||
This is NOT a template filler. The architecture workflow:
|
||||
|
||||
1. **Discovers** technical needs through conversation
|
||||
2. **Proposes** architectural options with trade-offs
|
||||
3. **Documents** decisions that prevent agent conflicts
|
||||
4. **Focuses** on decision points, not exhaustive documentation
|
||||
|
||||
### 4. Document Key Decisions
|
||||
|
||||
Work with the agent to create Architecture Decision Records (ADRs) for significant choices.
|
||||
|
||||
### 5. Review the Architecture
|
||||
|
||||
The agent produces a decision-focused architecture document.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
An `architecture.md` document containing:
|
||||
|
||||
1. **Architecture Overview** - System context, principles, style
|
||||
2. **System Architecture** - High-level diagram, component interactions
|
||||
3. **Data Architecture** - Database design, state management, caching
|
||||
4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning
|
||||
5. **Frontend Architecture** - Framework, state management, components
|
||||
6. **Integration Architecture** - Third-party integrations, messaging
|
||||
7. **Security Architecture** - Auth/authorization, data protection
|
||||
8. **Deployment Architecture** - CI/CD, environments, monitoring
|
||||
9. **ADRs** - Key decisions with context, options, rationale
|
||||
10. **FR/NFR-Specific Guidance** - Technical approach per requirement
|
||||
11. **Standards and Conventions** - Directory structure, naming, testing
|
||||
|
||||
---
|
||||
|
||||
## ADR Format
|
||||
|
||||
```markdown
|
||||
## ADR-001: Use GraphQL for All APIs
|
||||
|
||||
**Status:** Accepted | **Date:** 2025-11-02
|
||||
|
||||
**Context:** PRD requires flexible querying across multiple epics
|
||||
|
||||
**Decision:** Use GraphQL for all client-server communication
|
||||
|
||||
**Options Considered:**
|
||||
1. REST - Familiar but requires multiple endpoints
|
||||
2. GraphQL - Flexible querying, learning curve
|
||||
3. gRPC - High performance, poor browser support
|
||||
|
||||
**Rationale:**
|
||||
- PRD requires flexible data fetching (Epic 1, 3)
|
||||
- Mobile app needs bandwidth optimization (Epic 2)
|
||||
- Team has GraphQL experience
|
||||
|
||||
**Consequences:**
|
||||
- Positive: Flexible querying, reduced versioning
|
||||
- Negative: Caching complexity, N+1 query risk
|
||||
- Mitigation: Use DataLoader for batching
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
E-commerce platform produces:
|
||||
- Monolith + PostgreSQL + Redis + Next.js + GraphQL
|
||||
- ADRs explaining each choice
|
||||
- FR/NFR-specific implementation guidance
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Focus on decisions that prevent agent conflicts
|
||||
- Use ADRs for every significant technology choice
|
||||
- Keep it practical - don't over-architect
|
||||
- Architecture is living - update as you learn
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After architecture:
|
||||
|
||||
1. **Create Epics and Stories** - Work breakdown informed by architecture
|
||||
2. **Implementation Readiness** - Gate check before Phase 4
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create PRD](./create-prd.md) - Requirements before architecture
|
||||
- [Create Epics and Stories](./create-epics-and-stories.md) - Next step
|
||||
- [Run Implementation Readiness](./run-implementation-readiness.md) - Gate check
|
||||
- [Why Solutioning Matters](../../explanation/architecture/why-solutioning-matters.md)
|
||||
@@ -1,136 +0,0 @@
|
||||
---
|
||||
title: "How to Create Epics and Stories"
|
||||
description: How to break PRD requirements into epics and stories using BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- After architecture workflow completes
|
||||
- When PRD contains FRs/NFRs ready for implementation breakdown
|
||||
- Before implementation-readiness gate check
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- PM agent available
|
||||
- PRD completed
|
||||
- Architecture completed
|
||||
|
||||
---
|
||||
|
||||
## Why After Architecture?
|
||||
|
||||
This workflow runs AFTER architecture because:
|
||||
|
||||
1. **Informed Story Sizing** - Architecture decisions affect story complexity
|
||||
2. **Dependency Awareness** - Architecture reveals technical dependencies
|
||||
3. **Technical Feasibility** - Stories can be properly scoped knowing the tech stack
|
||||
4. **Consistency** - All stories align with documented architectural patterns
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the PM Agent
|
||||
|
||||
Start a fresh chat and load the PM agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*create-epics-and-stories
|
||||
```
|
||||
|
||||
### 3. Provide Context
|
||||
|
||||
Point the agent to:
|
||||
- Your PRD (FRs/NFRs)
|
||||
- Your architecture document
|
||||
- Optional: UX design artifacts
|
||||
|
||||
### 4. Review Epic Breakdown
|
||||
|
||||
The agent organizes requirements into logical epics with user stories.
|
||||
|
||||
### 5. Validate Story Quality
|
||||
|
||||
Ensure each story has:
|
||||
- Clear acceptance criteria
|
||||
- Appropriate priority
|
||||
- Identified dependencies
|
||||
- Technical notes from architecture
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
Epic files (one per epic) containing:
|
||||
|
||||
1. **Epic objective and scope**
|
||||
2. **User stories with acceptance criteria**
|
||||
3. **Story priorities** (P0/P1/P2/P3)
|
||||
4. **Dependencies between stories**
|
||||
5. **Technical notes** referencing architecture decisions
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
||||
|
||||
- **Epic 1: User Management** (3 stories)
|
||||
- Story 1.1: User registration form
|
||||
- Story 1.2: Email verification
|
||||
- Story 1.3: Login/logout
|
||||
|
||||
- **Epic 2: Product Display** (4 stories)
|
||||
- Story 2.1: Product listing page
|
||||
- Story 2.2: Product detail page
|
||||
- Story 2.3: Search functionality
|
||||
- Story 2.4: Category filtering
|
||||
|
||||
Each story references relevant ADRs from architecture.
|
||||
|
||||
---
|
||||
|
||||
## Story Priority Levels
|
||||
|
||||
| Priority | Meaning |
|
||||
|----------|---------|
|
||||
| **P0** | Critical - Must have for MVP |
|
||||
| **P1** | High - Important for release |
|
||||
| **P2** | Medium - Nice to have |
|
||||
| **P3** | Low - Future consideration |
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Keep stories small enough to complete in a session
|
||||
- Ensure acceptance criteria are testable
|
||||
- Document dependencies clearly
|
||||
- Reference architecture decisions in technical notes
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After creating epics and stories:
|
||||
|
||||
1. **Implementation Readiness** - Validate alignment before Phase 4
|
||||
2. **Sprint Planning** - Organize work for implementation
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Architecture](./create-architecture.md) - Do this first
|
||||
- [Run Implementation Readiness](./run-implementation-readiness.md) - Gate check
|
||||
- [Run Sprint Planning](./run-sprint-planning.md) - Start implementation
|
||||
@@ -1,130 +0,0 @@
|
||||
---
|
||||
title: "How to Create a PRD"
|
||||
description: How to create a Product Requirements Document using the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Medium to large feature sets
|
||||
- Multi-screen user experiences
|
||||
- Complex business logic
|
||||
- Multiple system integrations
|
||||
- Phased delivery required
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- PM agent available
|
||||
- Optional: Product brief from Phase 1
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the PM Agent
|
||||
|
||||
Start a fresh chat and load the PM agent.
|
||||
|
||||
### 2. Run the PRD Workflow
|
||||
|
||||
```
|
||||
*create-prd
|
||||
```
|
||||
|
||||
### 3. Provide Context
|
||||
|
||||
The workflow will:
|
||||
- Load any existing product brief
|
||||
- Ask about your project scope
|
||||
- Gather requirements through conversation
|
||||
|
||||
### 4. Define Requirements
|
||||
|
||||
Work with the agent to define:
|
||||
- Functional Requirements (FRs) - What the system should do
|
||||
- Non-Functional Requirements (NFRs) - How well it should do it
|
||||
|
||||
### 5. Review the PRD
|
||||
|
||||
The agent produces a comprehensive PRD scaled to your project.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A `PRD.md` document containing:
|
||||
|
||||
- Executive summary
|
||||
- Problem statement
|
||||
- User personas
|
||||
- Functional requirements (FRs)
|
||||
- Non-functional requirements (NFRs)
|
||||
- Success metrics
|
||||
- Risks and assumptions
|
||||
|
||||
---
|
||||
|
||||
## Scale-Adaptive Structure
|
||||
|
||||
The PRD adapts to your project complexity:
|
||||
|
||||
| Scale | Pages | Focus |
|
||||
|-------|-------|-------|
|
||||
| **Light** | 10-15 | Focused FRs/NFRs, simplified analysis |
|
||||
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
||||
| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis |
|
||||
|
||||
---
|
||||
|
||||
## V6 Improvement
|
||||
|
||||
In V6, the PRD focuses on **WHAT** to build (requirements). Epic and Stories are created **AFTER** architecture via the `create-epics-and-stories` workflow for better quality.
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
E-commerce checkout → PRD with:
|
||||
- 15 FRs (user account, cart management, payment flow)
|
||||
- 8 NFRs (performance, security, scalability)
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Do Product Brief First
|
||||
|
||||
Run product-brief from Phase 1 to kickstart the PRD for better results.
|
||||
|
||||
### 2. Focus on "What" Not "How"
|
||||
|
||||
Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning).
|
||||
|
||||
### 3. Document-Project First for Brownfield
|
||||
|
||||
Always run `document-project` before planning brownfield projects. AI agents need existing codebase context.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After PRD:
|
||||
|
||||
1. **Create UX Design** (optional) - If UX is critical
|
||||
2. **Create Architecture** - Technical design
|
||||
3. **Create Epics and Stories** - After architecture
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Product Brief](./create-product-brief.md) - Input for PRD
|
||||
- [Create UX Design](./create-ux-design.md) - Optional UX workflow
|
||||
- [Create Architecture](./create-architecture.md) - Next step after PRD
|
||||
@@ -1,117 +0,0 @@
|
||||
---
|
||||
title: "How to Create a Product Brief"
|
||||
description: How to create a product brief using the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Starting new product or major feature initiative
|
||||
- Aligning stakeholders before detailed planning
|
||||
- Transitioning from exploration to strategy
|
||||
- Need executive-level product documentation
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Analyst agent available
|
||||
- Optional: Research documents from previous workflows
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Analyst Agent
|
||||
|
||||
Start a fresh chat and load the Analyst agent.
|
||||
|
||||
### 2. Run the Product Brief Workflow
|
||||
|
||||
```
|
||||
*product-brief
|
||||
```
|
||||
|
||||
### 3. Answer the Interactive Questions
|
||||
|
||||
The workflow guides you through strategic product vision definition:
|
||||
|
||||
- What problem are you solving?
|
||||
- Who are your target users?
|
||||
- What makes this solution different?
|
||||
- What's the MVP scope?
|
||||
|
||||
### 4. Review and Refine
|
||||
|
||||
The agent will draft sections and let you refine them interactively.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
The `product-brief.md` document includes:
|
||||
|
||||
- **Executive summary** - High-level overview
|
||||
- **Problem statement** - With evidence
|
||||
- **Proposed solution** - And differentiators
|
||||
- **Target users** - Segmented
|
||||
- **MVP scope** - Ruthlessly defined
|
||||
- **Financial impact** - And ROI
|
||||
- **Strategic alignment** - With business goals
|
||||
- **Risks and open questions** - Documented upfront
|
||||
|
||||
---
|
||||
|
||||
## Integration with Other Workflows
|
||||
|
||||
The product brief feeds directly into the PRD workflow:
|
||||
|
||||
| Analysis Output | Planning Input |
|
||||
|-----------------|----------------|
|
||||
| product-brief.md | **prd** workflow |
|
||||
| market-research.md | **prd** context |
|
||||
| technical-research.md | **architecture** (Phase 3) |
|
||||
|
||||
Planning workflows automatically load the product brief if it exists.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Greenfield Software (Full Analysis)
|
||||
|
||||
```
|
||||
1. brainstorm-project - explore approaches
|
||||
2. research (market/technical/domain) - validate viability
|
||||
3. product-brief - capture strategic vision
|
||||
4. → Phase 2: prd
|
||||
```
|
||||
|
||||
### Skip Analysis (Clear Requirements)
|
||||
|
||||
```
|
||||
→ Phase 2: prd or tech-spec directly
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Be specific about the problem you're solving
|
||||
- Ruthlessly prioritize MVP scope
|
||||
- Document assumptions and risks
|
||||
- Use research findings as evidence
|
||||
- This is recommended for greenfield projects
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Run Brainstorming Session](./run-brainstorming-session.md) - Explore ideas first
|
||||
- [Conduct Research](./conduct-research.md) - Validate ideas
|
||||
- [Create PRD](./create-prd.md) - Next step after product brief
|
||||
@@ -1,119 +0,0 @@
|
||||
---
|
||||
title: "How to Create a Story"
|
||||
description: How to create implementation-ready stories from epic backlog
|
||||
---
|
||||
|
||||
|
||||
Use the `create-story` workflow to prepare the next story from the epic backlog for implementation.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Before implementing each story
|
||||
- When moving to the next story in an epic
|
||||
- After sprint-planning has been run
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- SM (Scrum Master) agent available
|
||||
- Sprint-status.yaml created by sprint-planning
|
||||
- Architecture and PRD available for context
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the SM Agent
|
||||
|
||||
Start a fresh chat and load the SM (Scrum Master) agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*create-story
|
||||
```
|
||||
|
||||
### 3. Specify the Story
|
||||
|
||||
The agent will:
|
||||
- Read the sprint-status.yaml
|
||||
- Identify the next story to work on
|
||||
- Or let you specify a particular story
|
||||
|
||||
### 4. Review the Story File
|
||||
|
||||
The agent creates a comprehensive story file ready for development.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A `story-[slug].md` file containing:
|
||||
|
||||
- Story objective and scope
|
||||
- Acceptance criteria (specific, testable)
|
||||
- Technical implementation notes
|
||||
- References to architecture decisions
|
||||
- Dependencies on other stories
|
||||
- Definition of Done
|
||||
|
||||
---
|
||||
|
||||
## Story Content Sources
|
||||
|
||||
The create-story workflow pulls from:
|
||||
|
||||
- **PRD** - Requirements and acceptance criteria
|
||||
- **Architecture** - Technical approach and ADRs
|
||||
- **Epic file** - Story context and dependencies
|
||||
- **Existing code** - Patterns to follow (brownfield)
|
||||
|
||||
---
|
||||
|
||||
## Example Output
|
||||
|
||||
```markdown
|
||||
|
||||
## Objective
|
||||
Implement email verification flow for new user registrations.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] User receives verification email within 30 seconds
|
||||
- [ ] Email contains unique verification link
|
||||
- [ ] Link expires after 24 hours
|
||||
- [ ] User can request new verification email
|
||||
|
||||
## Technical Notes
|
||||
- Use SendGrid API per ADR-003
|
||||
- Store verification tokens in Redis per architecture
|
||||
- Follow existing email template patterns in /templates
|
||||
|
||||
## Dependencies
|
||||
- Story 1.1 (User Registration) - DONE ✅
|
||||
|
||||
## Definition of Done
|
||||
- All acceptance criteria pass
|
||||
- Tests written and passing
|
||||
- Code review approved
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Complete one story before creating the next
|
||||
- Ensure dependencies are marked DONE before starting
|
||||
- Review technical notes for architecture alignment
|
||||
- Use the story file as context for dev-story
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Run Sprint Planning](./run-sprint-planning.md) - Initialize tracking
|
||||
- [Implement Story](./implement-story.md) - Next step
|
||||
- [Run Code Review](./run-code-review.md) - After implementation
|
||||
@@ -1,159 +0,0 @@
|
||||
---
|
||||
title: "How to Create a Tech Spec"
|
||||
description: How to create a technical specification using Quick Spec Flow
|
||||
---
|
||||
|
||||
|
||||
Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Bug fixes and small enhancements
|
||||
- Small features with clear scope (1-15 stories)
|
||||
- Rapid prototyping
|
||||
- Adding to existing brownfield codebase
|
||||
- Quick Flow track projects
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- PM agent or Quick Flow Solo Dev agent available
|
||||
- Project directory (can be empty for greenfield)
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the PM Agent
|
||||
|
||||
Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent).
|
||||
|
||||
### 2. Run the Tech Spec Workflow
|
||||
|
||||
```
|
||||
*create-tech-spec
|
||||
```
|
||||
|
||||
Or simply describe what you want to build:
|
||||
|
||||
```
|
||||
I want to fix the login validation bug
|
||||
```
|
||||
|
||||
### 3. Answer Discovery Questions
|
||||
|
||||
The workflow will ask:
|
||||
- What problem are you solving?
|
||||
- What's the scope of the change?
|
||||
- Any specific constraints?
|
||||
|
||||
### 4. Review Detected Context
|
||||
|
||||
For brownfield projects, the agent will:
|
||||
- Detect your project stack
|
||||
- Analyze existing code patterns
|
||||
- Detect test frameworks
|
||||
- Ask: "Should I follow these existing conventions?"
|
||||
|
||||
### 5. Get Your Tech Spec
|
||||
|
||||
The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
### tech-spec.md
|
||||
|
||||
- Problem statement and solution
|
||||
- Detected framework versions and dependencies
|
||||
- Brownfield code patterns (if applicable)
|
||||
- Existing test patterns to follow
|
||||
- Specific file paths to modify
|
||||
- Complete implementation guidance
|
||||
|
||||
### Story Files
|
||||
|
||||
For single changes:
|
||||
- `story-[slug].md` - Single user story ready for development
|
||||
|
||||
For small features:
|
||||
- `epics.md` - Epic organization
|
||||
- `story-[epic-slug]-1.md`, `story-[epic-slug]-2.md`, etc.
|
||||
|
||||
---
|
||||
|
||||
## Example: Bug Fix (Single Change)
|
||||
|
||||
**You:** "I want to fix the login validation bug that allows empty passwords"
|
||||
|
||||
**Agent:**
|
||||
1. Asks clarifying questions about the issue
|
||||
2. Detects your Node.js stack (Express 4.18.2, Jest for testing)
|
||||
3. Analyzes existing UserService code patterns
|
||||
4. Asks: "Should I follow your existing conventions?" → Yes
|
||||
5. Generates tech-spec.md with specific file paths
|
||||
6. Creates story-login-fix.md
|
||||
|
||||
**Total time:** 15-30 minutes (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
## Example: Small Feature (Multi-Story)
|
||||
|
||||
**You:** "I want to add OAuth social login (Google, GitHub)"
|
||||
|
||||
**Agent:**
|
||||
1. Asks about feature scope
|
||||
2. Detects your stack (Next.js 13.4, NextAuth.js already installed!)
|
||||
3. Analyzes existing auth patterns
|
||||
4. Confirms conventions
|
||||
5. Generates:
|
||||
- tech-spec.md (comprehensive implementation guide)
|
||||
- epics.md (OAuth Integration epic)
|
||||
- story-oauth-1.md (Backend OAuth setup)
|
||||
- story-oauth-2.md (Frontend login buttons)
|
||||
|
||||
**Total time:** 1-3 hours (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
## Implementing After Tech Spec
|
||||
|
||||
```bash
|
||||
# Single change:
|
||||
# Load DEV agent and run dev-story
|
||||
|
||||
# Multi-story feature:
|
||||
# Optional: Load SM agent and run sprint-planning
|
||||
# Then: Load DEV agent and run dev-story for each story
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
### Be Specific in Discovery
|
||||
|
||||
- ✅ "Fix email validation in UserService to allow plus-addressing"
|
||||
- ❌ "Fix validation bug"
|
||||
|
||||
### Trust Convention Detection
|
||||
|
||||
If it detects your patterns correctly, say yes! It's faster than establishing new conventions.
|
||||
|
||||
### Keep Single Changes Atomic
|
||||
|
||||
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Quick Flow](../../explanation/features/quick-flow.md) - Understanding Quick Spec Flow
|
||||
- [Implement Story](./implement-story.md) - After tech spec
|
||||
- [Create PRD](./create-prd.md) - For larger projects needing full BMad Method
|
||||
@@ -1,117 +0,0 @@
|
||||
---
|
||||
title: "How to Create a UX Design"
|
||||
description: How to create UX specifications using the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- UX is primary competitive advantage
|
||||
- Complex user workflows needing design thinking
|
||||
- Innovative interaction patterns
|
||||
- Design system creation
|
||||
- Accessibility-critical experiences
|
||||
|
||||
---
|
||||
|
||||
## When to Skip This
|
||||
|
||||
- Simple CRUD interfaces
|
||||
- Internal tools with standard patterns
|
||||
- Changes to existing screens you're happy with
|
||||
- Quick Flow projects
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- UX Designer agent available
|
||||
- PRD completed
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the UX Designer Agent
|
||||
|
||||
Start a fresh chat and load the UX Designer agent.
|
||||
|
||||
### 2. Run the UX Design Workflow
|
||||
|
||||
```
|
||||
*create-ux-design
|
||||
```
|
||||
|
||||
### 3. Provide Context
|
||||
|
||||
Point the agent to your PRD and describe:
|
||||
- Key user journeys
|
||||
- UX priorities
|
||||
- Any existing design patterns
|
||||
|
||||
### 4. Collaborate on Design
|
||||
|
||||
The workflow uses a collaborative approach:
|
||||
|
||||
1. **Visual exploration** - Generate multiple options
|
||||
2. **Informed decisions** - Evaluate with user needs
|
||||
3. **Collaborative design** - Refine iteratively
|
||||
4. **Living documentation** - Evolves with project
|
||||
|
||||
### 5. Review the UX Spec
|
||||
|
||||
The agent produces comprehensive UX documentation.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
The `ux-spec.md` document includes:
|
||||
|
||||
- User journeys
|
||||
- Wireframes and mockups
|
||||
- Interaction specifications
|
||||
- Design system (components, patterns, tokens)
|
||||
- Epic breakdown (UX stories)
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
Dashboard redesign produces:
|
||||
- Card-based layout with split-pane toggle
|
||||
- 5 card components
|
||||
- 12 color tokens
|
||||
- Responsive grid
|
||||
- 3 epics (Layout, Visualization, Accessibility)
|
||||
|
||||
---
|
||||
|
||||
## Integration
|
||||
|
||||
The UX spec feeds into:
|
||||
- PRD updates
|
||||
- Epic and story creation
|
||||
- Architecture decisions (Phase 3)
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Focus on user problems, not solutions first
|
||||
- Generate multiple options before deciding
|
||||
- Consider accessibility from the start
|
||||
- Document component reusability
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create PRD](./create-prd.md) - Create requirements first
|
||||
- [Create Architecture](./create-architecture.md) - Technical design
|
||||
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
|
||||
@@ -1,127 +0,0 @@
|
||||
---
|
||||
title: "How to Implement a Story"
|
||||
description: How to implement a story using the dev-story workflow
|
||||
---
|
||||
|
||||
|
||||
Use the `dev-story` workflow to implement a story with tests following the architecture and conventions.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- After create-story has prepared the story file
|
||||
- When ready to write code for a story
|
||||
- Story dependencies are marked DONE
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- DEV agent available
|
||||
- Story file created by create-story
|
||||
- Architecture and tech-spec available for context
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the DEV Agent
|
||||
|
||||
Start a fresh chat and load the DEV agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*dev-story
|
||||
```
|
||||
|
||||
### 3. Provide Story Context
|
||||
|
||||
Point the agent to the story file created by create-story.
|
||||
|
||||
### 4. Implement with Guidance
|
||||
|
||||
The DEV agent:
|
||||
- Reads the story file and acceptance criteria
|
||||
- References architecture decisions
|
||||
- Follows existing code patterns
|
||||
- Implements with tests
|
||||
|
||||
### 5. Complete Implementation
|
||||
|
||||
Work with the agent until all acceptance criteria are met.
|
||||
|
||||
---
|
||||
|
||||
## What Happens
|
||||
|
||||
The dev-story workflow:
|
||||
|
||||
1. **Reads context** - Story file, architecture, existing patterns
|
||||
2. **Plans implementation** - Identifies files to create/modify
|
||||
3. **Writes code** - Following conventions and patterns
|
||||
4. **Writes tests** - Unit, integration, or E2E as appropriate
|
||||
5. **Validates** - Runs tests and checks acceptance criteria
|
||||
|
||||
---
|
||||
|
||||
## Key Principles
|
||||
|
||||
### One Story at a Time
|
||||
|
||||
Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
|
||||
|
||||
### Follow Architecture
|
||||
|
||||
The DEV agent references:
|
||||
- ADRs for technology decisions
|
||||
- Standards for naming and structure
|
||||
- Existing patterns in the codebase
|
||||
|
||||
### Write Tests
|
||||
|
||||
Every story includes appropriate tests:
|
||||
- Unit tests for business logic
|
||||
- Integration tests for API endpoints
|
||||
- E2E tests for critical flows
|
||||
|
||||
---
|
||||
|
||||
## After Implementation
|
||||
|
||||
1. **Update sprint-status.yaml** - Mark story as READY FOR REVIEW
|
||||
2. **Run code-review** - Quality assurance
|
||||
3. **Address feedback** - If code review finds issues
|
||||
4. **Mark DONE** - After code review passes
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Keep the story file open for reference
|
||||
- Ask the agent to explain decisions
|
||||
- Run tests frequently during implementation
|
||||
- Don't skip tests for "simple" changes
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Story needs significant changes mid-implementation?**
|
||||
A: Run `correct-course` to analyze impact and route appropriately.
|
||||
|
||||
**Q: Can I work on multiple stories in parallel?**
|
||||
A: Not recommended. Complete one story's full lifecycle first.
|
||||
|
||||
**Q: What if implementation reveals the story is too large?**
|
||||
A: Split the story and document the change.
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Story](./create-story.md) - Prepare the story first
|
||||
- [Run Code Review](./run-code-review.md) - After implementation
|
||||
- [Run Sprint Planning](./run-sprint-planning.md) - Sprint organization
|
||||
@@ -1,94 +0,0 @@
|
||||
---
|
||||
title: "How to Run a Brainstorming Session"
|
||||
description: How to run a brainstorming session using the BMad Method
|
||||
---
|
||||
|
||||
|
||||
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Very vague or seed kernel of an idea that needs exploration
|
||||
- Consider alternatives or enhancements to an idea
|
||||
- See your idea from different angles and viewpoints
|
||||
- No idea what you want to build, but want to find some inspiration
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Analyst agent available
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Analyst Agent
|
||||
|
||||
Start a fresh chat and load the Analyst agent.
|
||||
|
||||
### 2. Run the Brainstorm Workflow
|
||||
|
||||
```
|
||||
*brainstorm-project
|
||||
```
|
||||
|
||||
### 3. Describe Your Idea
|
||||
|
||||
Tell the agent about your project idea, even if it's vague:
|
||||
|
||||
- "I want to build something that helps developers manage their context"
|
||||
- "I have a game idea about resource management"
|
||||
- "I need a tool for my team but I'm not sure what exactly"
|
||||
|
||||
### 4. Explore the Tracks
|
||||
|
||||
The workflow generates solution approaches through parallel ideation tracks:
|
||||
|
||||
- **Architecture track** - Technical approaches and patterns
|
||||
- **UX track** - User experience possibilities
|
||||
- **Integration track** - How it connects with other systems
|
||||
- **Value track** - Business value and differentiation
|
||||
|
||||
### 5. Evaluate Options
|
||||
|
||||
Review the generated options with rationale for each approach.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
- Multiple solution approaches with trade-offs
|
||||
- Different architectural options
|
||||
- UX and integration considerations
|
||||
- Clear rationale for each direction
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
After brainstorming:
|
||||
|
||||
1. **Research** - Validate ideas with market/technical research
|
||||
2. **Product Brief** - Capture strategic vision
|
||||
3. **PRD** - Move to formal planning
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Don't worry about having a fully formed idea
|
||||
- Let the agent guide the exploration
|
||||
- Consider multiple tracks before deciding
|
||||
- Use outputs as input for product-brief workflow
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Conduct Research](./conduct-research.md) - Validate your ideas
|
||||
- [Create Product Brief](./create-product-brief.md) - Capture strategic vision
|
||||
- [Create PRD](./create-prd.md) - Move to formal planning
|
||||
@@ -1,141 +0,0 @@
|
||||
---
|
||||
title: "How to Run Code Review"
|
||||
description: How to run code review for quality assurance
|
||||
---
|
||||
|
||||
|
||||
Use the `code-review` workflow to perform a thorough quality review of implemented code.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- After dev-story completes implementation
|
||||
- Before marking a story as DONE
|
||||
- Every story goes through code review - no exceptions
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- DEV agent available
|
||||
- Story implementation complete
|
||||
- Tests written and passing
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the DEV Agent
|
||||
|
||||
Start a fresh chat (or continue from dev-story) and load the DEV agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*code-review
|
||||
```
|
||||
|
||||
### 3. Provide Context
|
||||
|
||||
Point the agent to:
|
||||
- The story file
|
||||
- Files changed during implementation
|
||||
- Test files
|
||||
|
||||
### 4. Review Findings
|
||||
|
||||
The agent performs a senior developer code review and reports findings.
|
||||
|
||||
### 5. Address Issues
|
||||
|
||||
If issues are found:
|
||||
1. Fix issues using dev-story
|
||||
2. Re-run tests
|
||||
3. Run code-review again
|
||||
|
||||
---
|
||||
|
||||
## What Gets Reviewed
|
||||
|
||||
The code review checks:
|
||||
|
||||
### Code Quality
|
||||
- Clean, readable code
|
||||
- Appropriate abstractions
|
||||
- No code smells
|
||||
- Proper error handling
|
||||
|
||||
### Architecture Alignment
|
||||
- Follows ADRs and architecture decisions
|
||||
- Consistent with existing patterns
|
||||
- Proper separation of concerns
|
||||
|
||||
### Testing
|
||||
- Adequate test coverage
|
||||
- Tests are meaningful (not just for coverage)
|
||||
- Edge cases handled
|
||||
- Tests follow project patterns
|
||||
|
||||
### Security
|
||||
- No hardcoded secrets
|
||||
- Input validation
|
||||
- Authentication/authorization proper
|
||||
- No common vulnerabilities
|
||||
|
||||
### Performance
|
||||
- No obvious performance issues
|
||||
- Appropriate data structures
|
||||
- Efficient queries
|
||||
|
||||
---
|
||||
|
||||
## Review Outcomes
|
||||
|
||||
### ✅ Approved
|
||||
|
||||
- Code meets quality standards
|
||||
- Tests pass
|
||||
- **Action:** Mark story as DONE in sprint-status.yaml
|
||||
|
||||
### 🔧 Changes Requested
|
||||
|
||||
- Issues identified that need fixing
|
||||
- **Action:** Fix issues in dev-story, then re-run code-review
|
||||
|
||||
---
|
||||
|
||||
## Quality Gates
|
||||
|
||||
Every story goes through code-review before being marked done. This ensures:
|
||||
|
||||
- Consistent code quality
|
||||
- Architecture adherence
|
||||
- Test coverage
|
||||
- Security review
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Don't skip code review for "simple" changes
|
||||
- Address all findings, not just critical ones
|
||||
- Use findings as learning opportunities
|
||||
- Re-run review after fixes
|
||||
|
||||
---
|
||||
|
||||
## After Code Review
|
||||
|
||||
1. **If approved:** Update sprint-status.yaml to mark story DONE
|
||||
2. **If changes requested:** Fix issues and re-run review
|
||||
3. **Move to next story:** Run create-story for the next item
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Implement Story](./implement-story.md) - Before code review
|
||||
- [Create Story](./create-story.md) - Move to next story
|
||||
- [Run Sprint Planning](./run-sprint-planning.md) - Sprint organization
|
||||
@@ -1,162 +0,0 @@
|
||||
---
|
||||
title: "How to Run Implementation Readiness"
|
||||
description: How to validate planning and solutioning before implementation
|
||||
---
|
||||
|
||||
|
||||
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
||||
- After create-epics-and-stories workflow completes
|
||||
- Before sprint-planning workflow
|
||||
- When stakeholders request readiness check
|
||||
|
||||
---
|
||||
|
||||
## When to Skip This
|
||||
|
||||
- Quick Flow (no solutioning phase)
|
||||
- BMad Method Simple (no gate check required)
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- Architect agent available
|
||||
- PRD, Architecture, and Epics completed
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the Architect Agent
|
||||
|
||||
Start a fresh chat and load the Architect agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*implementation-readiness
|
||||
```
|
||||
|
||||
### 3. Let the Agent Validate
|
||||
|
||||
The workflow systematically checks:
|
||||
- PRD completeness
|
||||
- Architecture completeness
|
||||
- Epic/Story completeness
|
||||
- Alignment between all documents
|
||||
|
||||
### 4. Review the Gate Decision
|
||||
|
||||
The agent produces a gate decision with rationale.
|
||||
|
||||
---
|
||||
|
||||
## Gate Decision Outcomes
|
||||
|
||||
### ✅ PASS
|
||||
|
||||
- All critical criteria met
|
||||
- Minor gaps acceptable with documented plan
|
||||
- **Action:** Proceed to Phase 4
|
||||
|
||||
### ⚠️ CONCERNS
|
||||
|
||||
- Some criteria not met but not blockers
|
||||
- Gaps identified with clear resolution path
|
||||
- **Action:** Proceed with caution, address gaps in parallel
|
||||
|
||||
### ❌ FAIL
|
||||
|
||||
- Critical gaps or contradictions
|
||||
- Architecture missing key decisions
|
||||
- Epics conflict with PRD/architecture
|
||||
- **Action:** BLOCK Phase 4, resolve issues first
|
||||
|
||||
---
|
||||
|
||||
## What Gets Checked
|
||||
|
||||
### PRD/GDD Completeness
|
||||
- Problem statement clear and evidence-based
|
||||
- Success metrics defined
|
||||
- User personas identified
|
||||
- Functional requirements (FRs) complete
|
||||
- Non-functional requirements (NFRs) specified
|
||||
- Risks and assumptions documented
|
||||
|
||||
### Architecture Completeness
|
||||
- System architecture defined
|
||||
- Data architecture specified
|
||||
- API architecture decided
|
||||
- Key ADRs documented
|
||||
- Security architecture addressed
|
||||
- FR/NFR-specific guidance provided
|
||||
- Standards and conventions defined
|
||||
|
||||
### Epic/Story Completeness
|
||||
- All PRD features mapped to stories
|
||||
- Stories have acceptance criteria
|
||||
- Stories prioritized (P0/P1/P2/P3)
|
||||
- Dependencies identified
|
||||
- Story sequencing logical
|
||||
|
||||
### Alignment Checks
|
||||
- Architecture addresses all PRD FRs/NFRs
|
||||
- Epics align with architecture decisions
|
||||
- No contradictions between epics
|
||||
- NFRs have technical approach
|
||||
- Integration points clear
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
An `implementation-readiness.md` document containing:
|
||||
|
||||
1. **Executive Summary** (PASS/CONCERNS/FAIL)
|
||||
2. **Completeness Assessment** (scores for PRD, Architecture, Epics)
|
||||
3. **Alignment Assessment** (PRD↔Architecture, Architecture↔Epics)
|
||||
4. **Quality Assessment** (story quality, dependencies, risks)
|
||||
5. **Gaps and Recommendations** (critical/minor gaps, remediation)
|
||||
6. **Gate Decision** with rationale
|
||||
7. **Next Steps**
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
E-commerce platform → CONCERNS ⚠️
|
||||
|
||||
**Gaps identified:**
|
||||
- Missing security architecture section
|
||||
- Undefined payment gateway
|
||||
|
||||
**Recommendation:**
|
||||
- Complete security section
|
||||
- Add payment gateway ADR
|
||||
|
||||
**Action:** Proceed with caution, address before payment epic.
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Run this before every Phase 4 start
|
||||
- Take FAIL decisions seriously - fix issues first
|
||||
- Use CONCERNS as a checklist for parallel work
|
||||
- Document why you proceed despite concerns
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Architecture](./create-architecture.md) - Architecture workflow
|
||||
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
|
||||
- [Run Sprint Planning](./run-sprint-planning.md) - Start implementation
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
title: "How to Run Sprint Planning"
|
||||
description: How to initialize sprint tracking for implementation
|
||||
---
|
||||
|
||||
|
||||
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Once at the start of Phase 4 (Implementation)
|
||||
- After implementation-readiness gate passes
|
||||
- When starting a new sprint cycle
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- SM (Scrum Master) agent available
|
||||
- Epic files created from `create-epics-and-stories`
|
||||
- Implementation-readiness passed (for BMad Method/Enterprise)
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the SM Agent
|
||||
|
||||
Start a fresh chat and load the SM (Scrum Master) agent.
|
||||
|
||||
### 2. Run the Workflow
|
||||
|
||||
```
|
||||
*sprint-planning
|
||||
```
|
||||
|
||||
### 3. Provide Context
|
||||
|
||||
Point the agent to your epic files created during Phase 3.
|
||||
|
||||
### 4. Review Sprint Organization
|
||||
|
||||
The agent organizes stories into the sprint tracking file.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A `sprint-status.yaml` file containing:
|
||||
|
||||
- All epics with their stories
|
||||
- Story status tracking (TODO, IN PROGRESS, READY FOR REVIEW, DONE)
|
||||
- Dependencies between stories
|
||||
- Priority ordering
|
||||
|
||||
---
|
||||
|
||||
## Story Lifecycle States
|
||||
|
||||
Stories move through these states in the sprint status file:
|
||||
|
||||
| State | Description |
|
||||
|-------|-------------|
|
||||
| **TODO** | Story identified but not started |
|
||||
| **IN PROGRESS** | Story being implemented |
|
||||
| **READY FOR REVIEW** | Implementation complete, awaiting code review |
|
||||
| **DONE** | Accepted and complete |
|
||||
|
||||
---
|
||||
|
||||
## Typical Sprint Flow
|
||||
|
||||
### Sprint 0 (Planning Phase)
|
||||
- Complete Phases 1-3
|
||||
- PRD/GDD + Architecture complete
|
||||
- Epics+Stories created via create-epics-and-stories
|
||||
|
||||
### Sprint 1+ (Implementation Phase)
|
||||
|
||||
**Start of Phase 4:**
|
||||
1. SM runs `sprint-planning` (once)
|
||||
|
||||
**Per Story (repeat until epic complete):**
|
||||
1. SM runs `create-story`
|
||||
2. DEV runs `dev-story`
|
||||
3. DEV runs `code-review`
|
||||
4. Update sprint-status.yaml
|
||||
|
||||
**After Epic Complete:**
|
||||
- SM runs `retrospective`
|
||||
- Move to next epic
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Run sprint-planning only once at Phase 4 start
|
||||
- Use `sprint-status` during Phase 4 to check current state
|
||||
- Keep the sprint-status.yaml file as single source of truth
|
||||
- Update story status after each stage
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [Create Story](./create-story.md) - Prepare stories for implementation
|
||||
- [Implement Story](./implement-story.md) - Dev workflow
|
||||
- [Run Code Review](./run-code-review.md) - Quality assurance
|
||||
@@ -1,128 +0,0 @@
|
||||
---
|
||||
title: "How to Run Test Design"
|
||||
description: How to create comprehensive test plans using TEA's test-design workflow
|
||||
---
|
||||
|
||||
|
||||
Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This
|
||||
|
||||
**System-level (Phase 3):**
|
||||
- After architecture is complete
|
||||
- Before implementation-readiness gate
|
||||
- To validate architecture testability
|
||||
|
||||
**Epic-level (Phase 4):**
|
||||
- At the start of each epic
|
||||
- Before implementing stories in the epic
|
||||
- To identify epic-specific testing needs
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- BMad Method installed
|
||||
- TEA agent available
|
||||
- For system-level: Architecture document complete
|
||||
- For epic-level: Epic defined with stories
|
||||
|
||||
---
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load the TEA Agent
|
||||
|
||||
Start a fresh chat and load the TEA (Test Architect) agent.
|
||||
|
||||
### 2. Run the Test Design Workflow
|
||||
|
||||
```
|
||||
*test-design
|
||||
```
|
||||
|
||||
### 3. Specify the Mode
|
||||
|
||||
TEA will ask if you want:
|
||||
|
||||
- **System-level** - For architecture testability review (Phase 3)
|
||||
- **Epic-level** - For epic-specific test planning (Phase 4)
|
||||
|
||||
### 4. Provide Context
|
||||
|
||||
For system-level:
|
||||
- Point to your architecture document
|
||||
- Reference any ADRs (Architecture Decision Records)
|
||||
|
||||
For epic-level:
|
||||
- Specify which epic you're planning
|
||||
- Reference the epic file with stories
|
||||
|
||||
### 5. Review the Output
|
||||
|
||||
TEA generates a comprehensive test design document.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
### System-Level Output (`test-design-system.md`)
|
||||
|
||||
- Testability review of architecture
|
||||
- ADR → test mapping
|
||||
- Architecturally Significant Requirements (ASRs)
|
||||
- Environment needs
|
||||
- Test infrastructure recommendations
|
||||
|
||||
### Epic-Level Output (`test-design-epic-N.md`)
|
||||
|
||||
- Risk assessment for the epic
|
||||
- Test priorities
|
||||
- Coverage plan
|
||||
- Regression hotspots (for brownfield)
|
||||
- Integration risks
|
||||
- Mitigation strategies
|
||||
|
||||
---
|
||||
|
||||
## Test Design for Different Tracks
|
||||
|
||||
### Greenfield - BMad Method
|
||||
|
||||
| Stage | Test Design Focus |
|
||||
|-------|-------------------|
|
||||
| Phase 3 | System-level testability review |
|
||||
| Phase 4 | Per-epic risk assessment and test plan |
|
||||
|
||||
### Brownfield - BMad Method/Enterprise
|
||||
|
||||
| Stage | Test Design Focus |
|
||||
|-------|-------------------|
|
||||
| Phase 3 | System-level + existing test baseline |
|
||||
| Phase 4 | Regression hotspots, integration risks |
|
||||
|
||||
### Enterprise
|
||||
|
||||
| Stage | Test Design Focus |
|
||||
|-------|-------------------|
|
||||
| Phase 3 | Compliance-aware testability |
|
||||
| Phase 4 | Security/performance/compliance focus |
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
- Run system-level test-design right after architecture
|
||||
- Run epic-level test-design at the start of each epic
|
||||
- Update test design if ADRs change
|
||||
- Use the output to guide `*atdd` and `*automate` workflows
|
||||
|
||||
---
|
||||
|
||||
## Related
|
||||
|
||||
- [TEA Overview](../../explanation/features/tea-overview.md) - Understanding the Test Architect
|
||||
- [Setup Test Framework](./setup-test-framework.md) - Setting up testing infrastructure
|
||||
- [Create Architecture](./create-architecture.md) - Architecture workflow
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user