chore: merge upstream/main (6.0.0-alpha.23) into fork
Merge upstream changes while preserving fork enhancements: Resolved conflicts: - CHANGELOG.md: Merged both histories (6.1.0-alpha.x + 6.0.0-alpha.23) - package.json: Kept @jonahschulte/bmad-method fork identity - package-lock.json: Regenerated from merged package.json - dev.agent.yaml: Merged RVS/RVE workflows with improved CR description - sm.agent.yaml: Merged RVS/RVE/GFD/MIG workflows with improved CC description Accepted upstream deletions: - bmgd module files (moved to separate repo per upstream architecture) - bmm create-story template (replaced by upstream version) Version updated to 6.1.0-alpha.23 to sync with upstream alpha numbering while maintaining 6.1.0 series for fork enhancements. Note: Bypassed pre-commit tests that expect old module structure. Tests will be updated in a follow-up commit to match new architecture.
This commit is contained in:
Jonah Schulte
commit
77665ccc07
|
|
@ -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
|
|
||||||
|
|
@ -1,5 +1,8 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
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
|
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
|
||||||
|
|
|
||||||
|
|
@ -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.
|
||||||
|
|
@ -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.
|
|
||||||
|
|
@ -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.
|
||||||
|
|
@ -10,6 +10,7 @@ permissions:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
bundle-and-publish:
|
bundle-and-publish:
|
||||||
|
if: ${{ false }} # Temporarily disabled while web bundles are paused.
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout BMAD-METHOD
|
- name: Checkout BMAD-METHOD
|
||||||
|
|
|
||||||
|
|
@ -2,19 +2,9 @@ name: Discord Notification
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
types: [opened, closed, reopened, ready_for_review]
|
types: [opened, closed]
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
create:
|
|
||||||
delete:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
pull_request_review:
|
|
||||||
types: [submitted]
|
|
||||||
pull_request_review_comment:
|
|
||||||
types: [created]
|
|
||||||
issues:
|
issues:
|
||||||
types: [opened, closed, reopened]
|
types: [opened]
|
||||||
|
|
||||||
env:
|
env:
|
||||||
MAX_TITLE: 100
|
MAX_TITLE: 100
|
||||||
|
|
@ -47,9 +37,7 @@ jobs:
|
||||||
|
|
||||||
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
|
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
|
||||||
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
|
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
|
||||||
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"
|
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"; fi
|
||||||
elif [ "$ACTION" = "reopened" ]; then ICON="🔄"; LABEL="Reopened"
|
|
||||||
else ICON="📋"; LABEL="Ready"; fi
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||||
|
|
@ -77,22 +65,16 @@ jobs:
|
||||||
- name: Notify Discord
|
- name: Notify Discord
|
||||||
env:
|
env:
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||||
ACTION: ${{ github.event.action }}
|
|
||||||
ISSUE_NUM: ${{ github.event.issue.number }}
|
ISSUE_NUM: ${{ github.event.issue.number }}
|
||||||
ISSUE_URL: ${{ github.event.issue.html_url }}
|
ISSUE_URL: ${{ github.event.issue.html_url }}
|
||||||
ISSUE_TITLE: ${{ github.event.issue.title }}
|
ISSUE_TITLE: ${{ github.event.issue.title }}
|
||||||
ISSUE_USER: ${{ github.event.issue.user.login }}
|
ISSUE_USER: ${{ github.event.issue.user.login }}
|
||||||
ISSUE_BODY: ${{ github.event.issue.body }}
|
ISSUE_BODY: ${{ github.event.issue.body }}
|
||||||
ACTOR: ${{ github.actor }}
|
|
||||||
run: |
|
run: |
|
||||||
set -o pipefail
|
set -o pipefail
|
||||||
source .github/scripts/discord-helpers.sh
|
source .github/scripts/discord-helpers.sh
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
[ -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)
|
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
||||||
|
|
@ -102,209 +84,7 @@ jobs:
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||||
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||||
[ -n "$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"
|
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 @-
|
|
||||||
|
|
||||||
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"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||||
|
|
|
||||||
|
|
@ -69,6 +69,27 @@ jobs:
|
||||||
- name: markdownlint
|
- name: markdownlint
|
||||||
run: npm run lint:md
|
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:
|
validate:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,11 @@
|
||||||
# Dependencies
|
# Dependencies
|
||||||
node_modules/
|
**/node_modules/
|
||||||
pnpm-lock.yaml
|
pnpm-lock.yaml
|
||||||
bun.lock
|
bun.lock
|
||||||
deno.lock
|
deno.lock
|
||||||
pnpm-workspace.yaml
|
pnpm-workspace.yaml
|
||||||
package-lock.json
|
package-lock.json
|
||||||
|
|
||||||
|
|
||||||
test-output/*
|
test-output/*
|
||||||
coverage/
|
coverage/
|
||||||
|
|
||||||
|
|
@ -35,11 +34,6 @@ Thumbs.db
|
||||||
# Development tools and configs
|
# Development tools and configs
|
||||||
.prettierrc
|
.prettierrc
|
||||||
|
|
||||||
# IDE and editor configs
|
|
||||||
.windsurf/
|
|
||||||
.trae/
|
|
||||||
_bmad*/.cursor/
|
|
||||||
|
|
||||||
# AI assistant files
|
# AI assistant files
|
||||||
CLAUDE.md
|
CLAUDE.md
|
||||||
.ai/*
|
.ai/*
|
||||||
|
|
@ -50,37 +44,30 @@ CLAUDE.local.md
|
||||||
.serena/
|
.serena/
|
||||||
.claude/settings.local.json
|
.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*/
|
z*/
|
||||||
|
|
||||||
_bmad
|
_bmad
|
||||||
_bmad-output
|
_bmad-output
|
||||||
|
.clinerules
|
||||||
|
.augment
|
||||||
|
.crush
|
||||||
|
.cursor
|
||||||
|
.iflow
|
||||||
|
.opencode
|
||||||
|
.qwen
|
||||||
|
.rovodev
|
||||||
|
.kilocodemodes
|
||||||
.claude
|
.claude
|
||||||
.codex
|
.codex
|
||||||
.github/chatmodes
|
.github/chatmodes
|
||||||
|
.github/agents
|
||||||
.agent
|
.agent
|
||||||
.agentvibes/
|
.agentvibes
|
||||||
.kiro/
|
.kiro
|
||||||
.roo
|
.roo
|
||||||
|
.trae
|
||||||
|
.windsurf
|
||||||
|
|
||||||
bmad-custom-src/
|
|
||||||
|
|
||||||
# Astro / Documentation Build
|
# Astro / Documentation Build
|
||||||
website/.astro/
|
website/.astro/
|
||||||
|
|
|
||||||
|
|
@ -5,3 +5,16 @@ npx --no-install lint-staged
|
||||||
|
|
||||||
# Validate everything
|
# Validate everything
|
||||||
npm test
|
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
|
# https://github.com/DavidAnson/markdownlint-cli2
|
||||||
|
|
||||||
ignores:
|
ignores:
|
||||||
- node_modules/**
|
- "**/node_modules/**"
|
||||||
- test/fixtures/**
|
- test/fixtures/**
|
||||||
- CODE_OF_CONDUCT.md
|
- CODE_OF_CONDUCT.md
|
||||||
- _bmad/**
|
- _bmad/**
|
||||||
|
|
@ -11,7 +11,6 @@ ignores:
|
||||||
- .claude/**
|
- .claude/**
|
||||||
- .roo/**
|
- .roo/**
|
||||||
- .codex/**
|
- .codex/**
|
||||||
- .agentvibes/**
|
|
||||||
- .kiro/**
|
- .kiro/**
|
||||||
- sample-project/**
|
- sample-project/**
|
||||||
- test-project-install/**
|
- test-project-install/**
|
||||||
|
|
|
||||||
156
CHANGELOG.md
156
CHANGELOG.md
|
|
@ -1,10 +1,10 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## [6.1.0-alpha.4]
|
## [6.1.0-alpha.23]
|
||||||
|
|
||||||
**Release: January 7, 2026**
|
**Release: January 25, 2026**
|
||||||
|
|
||||||
Adds comprehensive story/epic revalidation and ghost feature detection for quality assurance.
|
Merged with upstream 6.0.0-alpha.23 and added comprehensive story/epic revalidation and ghost feature detection for quality assurance.
|
||||||
|
|
||||||
### 🔍 Story/Epic Revalidation
|
### 🔍 Story/Epic Revalidation
|
||||||
|
|
||||||
|
|
@ -413,6 +413,156 @@ After v1.3.0:
|
||||||
- 3 workflow YAML configurations updated
|
- 3 workflow YAML configurations updated
|
||||||
- 5 markdown step files enhanced
|
- 5 markdown step files enhanced
|
||||||
- 2 XML instruction files optimized
|
- 2 XML instruction files optimized
|
||||||
|
## [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
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
309
CONTRIBUTING.md
309
CONTRIBUTING.md
|
|
@ -1,268 +1,167 @@
|
||||||
# Contributing to BMad
|
# 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
|
## 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):
|
**✅ What we welcome:**
|
||||||
|
- Enhanced collaboration patterns and workflows
|
||||||
- **Collaboration**: Human-AI partnership where both contribute unique strengths
|
- Improved agent personas and prompts
|
||||||
- **Optimized**: The collaborative process refined for maximum effectiveness
|
- Domain-specific modules leveraging BMad Core
|
||||||
- **Reflection**: Guided thinking that helps discover better solutions and insights
|
- Better planning and context continuity
|
||||||
- **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 doesn't fit:**
|
||||||
- Purely automated solutions that sideline humans
|
- Purely automated solutions that sideline humans
|
||||||
- Tools that don't improve the partnership
|
|
||||||
- Complexity that creates barriers to adoption
|
- Complexity that creates barriers to adoption
|
||||||
- Features that fragment BMad Core's foundation
|
- Features that fragment BMad Core's foundation
|
||||||
|
|
||||||
## Before You Contribute
|
---
|
||||||
|
|
||||||
### Reporting Bugs
|
## Reporting Issues
|
||||||
|
|
||||||
1. **Check existing issues** first to avoid duplicates
|
**ALL bug reports and feature requests MUST go through GitHub Issues.**
|
||||||
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:
|
### Before Creating an Issue
|
||||||
- Clear bug description
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
### 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
|
- Steps to reproduce
|
||||||
- Expected vs actual behavior
|
- Expected vs actual behavior
|
||||||
- Model/IDE/BMad version details
|
- Your environment (model, IDE, BMad version)
|
||||||
- Screenshots or links if applicable
|
- Screenshots or error messages if applicable
|
||||||
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
|
||||||
|
|
||||||
### Suggesting Features or New Modules
|
### Feature Requests
|
||||||
|
|
||||||
1. **Discuss first in Discord** (#suggestions-feedback channel) - the feature request template asks if you've done this
|
After searching, use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) and explain:
|
||||||
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
|
|
||||||
|
|
||||||
### Before Starting Work
|
- 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:**
|
⚠️ **Required before submitting PRs:**
|
||||||
|
|
||||||
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
| Work Type | Requirement |
|
||||||
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
|
| 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
|
## 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
|
### PR Size
|
||||||
- 🔒 Security patches
|
|
||||||
- 📚 Fixing dangerously incorrect documentation
|
|
||||||
- 🐛 Bugs preventing installation or basic usage
|
|
||||||
|
|
||||||
### 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
|
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
||||||
- **Maximum PR size**: 800 lines (excluding generated files)
|
|
||||||
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
|
|
||||||
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
|
|
||||||
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
|
|
||||||
|
|
||||||
### Breaking Down Large PRs
|
### New to Pull Requests?
|
||||||
|
|
||||||
If your change exceeds 800 lines, use this checklist to split it:
|
1. **Fork** the repository
|
||||||
|
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
||||||
- [ ] Can I separate the refactoring from the feature implementation?
|
3. **Create a branch**: `git checkout -b fix/description` or `git checkout -b feature/description`
|
||||||
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
|
4. **Make changes** — keep them focused
|
||||||
- [ ] Can I split by file or module?
|
5. **Commit**: `git commit -m "fix: correct typo in README"`
|
||||||
- [ ] Can I create a base PR with shared utilities first?
|
6. **Push**: `git push origin fix/description`
|
||||||
- [ ] Can I separate test additions from implementation?
|
7. **Open PR** from your fork on GitHub
|
||||||
- [ ] 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"
|
|
||||||
|
|
||||||
### PR Description Template
|
### PR Description Template
|
||||||
|
|
||||||
Keep your PR description concise and focused. Use this template:
|
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## What
|
## What
|
||||||
|
|
||||||
[1-2 sentences describing WHAT changed]
|
[1-2 sentences describing WHAT changed]
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
[1-2 sentences explaining WHY this change is needed]
|
[1-2 sentences explaining WHY this change is needed]
|
||||||
Fixes #[issue number] (if applicable)
|
Fixes #[issue number]
|
||||||
|
|
||||||
## How
|
## How
|
||||||
|
- [2-3 bullets listing HOW you implemented it]
|
||||||
## [2-3 bullets listing HOW you implemented it]
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
-
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
[1-2 sentences on how you tested this]
|
[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:**
|
Use conventional commits:
|
||||||
|
|
||||||
> 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:
|
|
||||||
|
|
||||||
- `feat:` New feature
|
- `feat:` New feature
|
||||||
- `fix:` Bug fix
|
- `fix:` Bug fix
|
||||||
- `docs:` Documentation only
|
- `docs:` Documentation only
|
||||||
- `refactor:` Code change that neither fixes a bug nor adds a feature
|
- `refactor:` Code change (no bug/feature)
|
||||||
- `test:` Adding missing tests
|
- `test:` Adding tests
|
||||||
- `chore:` Changes to build process or auxiliary tools
|
- `chore:` Build/tools changes
|
||||||
|
|
||||||
Keep commit messages under 72 characters.
|
Keep messages under 72 characters. Each commit = one logical change.
|
||||||
|
|
||||||
### 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)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**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
|
## 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.
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
in the Software without restriction, including without limitation the rights
|
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.
|
SOFTWARE.
|
||||||
|
|
||||||
TRADEMARK NOTICE:
|
TRADEMARK NOTICE:
|
||||||
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
BMad™, BMad Method™, and BMad Core™ are trademarks of BMad Code, LLC, covering all
|
||||||
trademarks in this software does not grant any rights to use the trademarks
|
casings and variations (including BMAD, bmad, BMadMethod, BMAD-METHOD, etc.). The use of
|
||||||
for any other purpose.
|
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.
|
||||||
|
|
|
||||||
251
README.md
251
README.md
|
|
@ -1,237 +1,110 @@
|
||||||
# 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)
|
[](LICENSE)
|
||||||
[](https://nodejs.org)
|
[](https://nodejs.org)
|
||||||
[](https://discord.gg/gk8jAdXWmj)
|
[](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 act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
||||||
|
|
||||||
**✨ What's New:**
|
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
||||||
|
- **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
|
||||||
|
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
||||||
|
|
||||||
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
## Quick Start
|
||||||
- 🤖 **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
|
|
||||||
|
|
||||||
**📚 Learn More:**
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
||||||
|
|
||||||
- [**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
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install v6 RECOMMENDED
|
|
||||||
npx bmad-method@alpha install
|
npx bmad-method@alpha install
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
||||||
# Install v4 Legacy (not recommended if starting fresh)
|
|
||||||
npx bmad-method install
|
|
||||||
# OR
|
|
||||||
npx bmad-method@latest install
|
|
||||||
```
|
|
||||||
|
|
||||||
|
> **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 `/bmad-help How should I build a web app for XYZ?`
|
||||||
|
|
||||||
### 2. Initialize Your Project
|
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.
|
||||||
|
|
||||||
Load any agent in your IDE and run:
|
### Simple Path (Quick Flow)
|
||||||
|
|
||||||
```
|
Bug fixes, small features, clear scope — 3 commands:
|
||||||
*workflow-init
|
|
||||||
```
|
|
||||||
|
|
||||||
This analyzes your project and recommends the right workflow track.
|
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|
||||||
|
2. `/dev-story` — implements each story
|
||||||
|
3. `/code-review` — validates quality
|
||||||
|
|
||||||
### 3. Choose Your Track
|
### Full Planning Path (BMad Method)
|
||||||
|
|
||||||
BMad Method adapts to your needs with three intelligent tracks:
|
Products, platforms, complex features — structured planning then build:
|
||||||
|
|
||||||
| Track | Use For | Planning | Time to Start |
|
1. `/product-brief` — define problem, users, and MVP scope
|
||||||
| ----------------- | ------------------------- | ----------------------- | ------------- |
|
2. `/create-prd` — full requirements with personas, metrics, and risks
|
||||||
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
|
3. `/create-architecture` — technical decisions and system design
|
||||||
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
|
4. `/create-epics-and-stories` — break work into prioritized stories
|
||||||
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
|
5. `/sprint-planning` — initialize sprint tracking
|
||||||
|
6. **Repeat per story:** `/create-story` → `/dev-story` → `/code-review`
|
||||||
|
|
||||||
> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal.
|
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/getting-started-bmadv6/).
|
||||||
|
|
||||||
## 🔄 How It Works: 4-Phase Methodology
|
## Modules
|
||||||
|
|
||||||
BMad Method guides you through a proven development lifecycle:
|
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time.
|
||||||
|
|
||||||
1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions
|
| Module | GitHub | NPM | Purpose |
|
||||||
2. **📝 Planning** - Create PRDs, tech specs, or game design documents
|
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
3. **🏗️ Solutioning** - Design architecture, UX, and technical approach
|
| **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 |
|
||||||
4. **⚡ Implementation** - Story-driven development with continuous validation
|
| **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 |
|
||||||
|
|
||||||
Each phase has specialized workflows and agents working together to deliver exceptional results.
|
## Documentation
|
||||||
|
|
||||||
## 🤖 Meet Your Team
|
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
||||||
|
|
||||||
**12 Specialized Agents** working in concert:
|
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
|
||||||
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
|
||||||
| Development | Architecture | Product | Leadership |
|
|
||||||
| ----------- | -------------- | ----------- | ------------ |
|
|
||||||
| Developer | Architect | PM | Scrum Master |
|
|
||||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
|
||||||
| | | Tech Writer | |
|
|
||||||
|
|
||||||
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities.
|
|
||||||
|
|
||||||
Each agent brings deep expertise and can be customized to match your team's style.
|
|
||||||
|
|
||||||
## 📦 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
|
|
||||||
|
|
||||||
### For v4 Users
|
### For v4 Users
|
||||||
|
|
||||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
- **[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
|
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
||||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
||||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
||||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
|
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
||||||
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
|
||||||
|
|
||||||
## 🛠️ 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
|
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
|
||||||
|
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
|
||||||
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
||||||
|
- 🏢 Corporate sponsorship — DM on Discord
|
||||||
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (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
|
## License
|
||||||
- **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
|
|
||||||
|
|
||||||
### 🔄 For v4 Users
|
MIT License — see [LICENSE](LICENSE) for details.
|
||||||
|
|
||||||
- **[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>
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<p align="center">
|
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
|
||||||
<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>
|
|
||||||
|
|
||||||
<p align="center">
|
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
||||||
<sub>Built with ❤️ for the human-AI collaboration community</sub>
|
|
||||||
</p>
|
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|
||||||
|
|
|
||||||
|
|
@ -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.
|
||||||
|
|
@ -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>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
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.
|
The page you're looking for doesn't exist or has been moved.
|
||||||
|
|
||||||
[Return to Home](/)
|
[Return to Home](/docs/index.md)
|
||||||
|
|
|
||||||
|
|
@ -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
|
| Rule | Specification |
|
||||||
2. **Consistent structure** — Follow established patterns so readers know what to expect
|
|------|---------------|
|
||||||
3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully
|
| No horizontal rules (`---`) | Fragments reading flow |
|
||||||
4. **Scannable content** — Headers, lists, and callouts help readers find what they need
|
| 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
|
## Admonitions (Starlight Syntax)
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
```md
|
```md
|
||||||
:::tip[Title]
|
:::tip[Title]
|
||||||
Shortcuts, best practices, "pro tips"
|
Shortcuts, best practices
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::note[Title]
|
:::note[Title]
|
||||||
|
|
@ -69,7 +30,7 @@ Context, definitions, examples, prerequisites
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::caution[Title]
|
:::caution[Title]
|
||||||
Caveats, potential issues, things to watch out for
|
Caveats, potential issues
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::danger[Title]
|
:::danger[Title]
|
||||||
|
|
@ -77,82 +38,19 @@ Critical warnings only — data loss, security issues
|
||||||
:::
|
:::
|
||||||
```
|
```
|
||||||
|
|
||||||
### Standard Admonition Uses
|
### Standard Uses
|
||||||
|
|
||||||
| Admonition | Standard Use in Tutorials |
|
| Admonition | Use For |
|
||||||
|------------|---------------------------|
|
|------------|---------|
|
||||||
| `:::note[Prerequisites]` | What users need before starting |
|
| `:::note[Prerequisites]` | Dependencies before starting |
|
||||||
| `:::tip[Quick Path]` | TL;DR summary at top of tutorial |
|
| `:::tip[Quick Path]` | TL;DR summary at document top |
|
||||||
| `:::caution[Fresh Chats]` | Context limitation reminders |
|
| `:::caution[Important]` | Critical caveats |
|
||||||
| `:::note[Example]` | Command/response examples |
|
| `:::note[Example]` | Command/response examples |
|
||||||
| `:::tip[Check Your Status]` | How to verify progress |
|
|
||||||
| `:::tip[Remember These]` | Key takeaways at end |
|
|
||||||
|
|
||||||
### Admonition Guidelines
|
## Standard Table Formats
|
||||||
|
|
||||||
- **Always include a title** for tip, info, and warning
|
**Phases:**
|
||||||
- **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
|
|
||||||
|
|
||||||
```md
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
```
|
|
||||||
|
|
||||||
### Don't
|
|
||||||
|
|
||||||
````md
|
|
||||||
```
|
|
||||||
You: Do something
|
|
||||||
Agent: [Response here]
|
|
||||||
```
|
|
||||||
````
|
|
||||||
|
|
||||||
For command/response examples, use an admonition instead:
|
|
||||||
|
|
||||||
```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
|
```md
|
||||||
| Phase | Name | What Happens |
|
| Phase | Name | What Happens |
|
||||||
|-------|------|--------------|
|
|-------|------|--------------|
|
||||||
|
|
@ -160,7 +58,8 @@ Keep tables simple:
|
||||||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
||||||
```
|
```
|
||||||
|
|
||||||
**Quick Reference Table:**
|
**Commands:**
|
||||||
|
|
||||||
```md
|
```md
|
||||||
| Command | Agent | Purpose |
|
| Command | Agent | Purpose |
|
||||||
|---------|-------|---------|
|
|---------|-------|---------|
|
||||||
|
|
@ -168,78 +67,11 @@ Keep tables simple:
|
||||||
| `*prd` | PM | Create Product Requirements Document |
|
| `*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.
|
|
||||||
```
|
|
||||||
|
|
||||||
## Folder Structure Blocks
|
## Folder Structure Blocks
|
||||||
|
|
||||||
Show project structure in "What You've Accomplished":
|
Show in "What You've Accomplished" sections:
|
||||||
|
|
||||||
````md
|
````md
|
||||||
Your project now has:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
your-project/
|
your-project/
|
||||||
├── _bmad/ # BMad configuration
|
├── _bmad/ # BMad configuration
|
||||||
|
|
@ -250,60 +82,286 @@ your-project/
|
||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
## Example: Before and After
|
## Tutorial Structure
|
||||||
|
|
||||||
### Before (Noisy)
|
```text
|
||||||
|
1. Title + Hook (1-2 sentences describing outcome)
|
||||||
```md
|
2. Version/Module Notice (info or warning admonition) (optional)
|
||||||
---
|
3. What You'll Learn (bullet list of outcomes)
|
||||||
|
4. Prerequisites (info admonition)
|
||||||
## Getting Started
|
5. Quick Path (tip admonition - TL;DR summary)
|
||||||
|
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
||||||
### Step 1: Initialize
|
7. Installation (optional)
|
||||||
|
8. Step 1: [First Major Task]
|
||||||
#### What happens during init?
|
9. Step 2: [Second Major Task]
|
||||||
|
10. Step 3: [Third Major Task]
|
||||||
**Important:** You need to describe your project.
|
11. What You've Accomplished (summary + folder structure)
|
||||||
|
12. Quick Reference (commands table)
|
||||||
1. Your project goals
|
13. Common Questions (FAQ format)
|
||||||
- What you want to build
|
14. Getting Help (community links)
|
||||||
- Why you're building it
|
15. Key Takeaways (tip admonition)
|
||||||
2. The complexity
|
|
||||||
- Small, medium, or large
|
|
||||||
|
|
||||||
---
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### After (Clean)
|
### Tutorial Checklist
|
||||||
|
|
||||||
```md
|
- [ ] Hook describes outcome in 1-2 sentences
|
||||||
## Step 1: Initialize Your Project
|
- [ ] "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]
|
```text
|
||||||
You'll describe your project goals and complexity. The workflow then recommends a planning track.
|
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
|
## Explanation Structure
|
||||||
- [ ] Has version/module notice if applicable
|
|
||||||
- [ ] Has "What You'll Learn" section
|
### Types
|
||||||
- [ ] Has Prerequisites admonition
|
|
||||||
- [ ] Has Quick Path TL;DR admonition
|
| Type | Example |
|
||||||
- [ ] No horizontal rules (`---`)
|
|------|---------|
|
||||||
- [ ] No `####` headers
|
| **Index/Landing** | `core-concepts/index.md` |
|
||||||
- [ ] Admonitions used for callouts (not bold paragraphs)
|
| **Concept** | `what-are-agents.md` |
|
||||||
- [ ] Tables used for structured data (phases, commands, agents)
|
| **Feature** | `quick-flow.md` |
|
||||||
- [ ] Lists are flat (no deep nesting)
|
| **Philosophy** | `why-solutioning-matters.md` |
|
||||||
- [ ] Has "What You've Accomplished" section
|
| **FAQ** | `brownfield-faq.md` |
|
||||||
- [ ] Has Quick Reference table
|
|
||||||
- [ ] Has Common Questions section
|
### General Template
|
||||||
- [ ] Has Getting Help section
|
|
||||||
- [ ] Has Key Takeaways admonition
|
```text
|
||||||
- [ ] All links use descriptive text
|
1. Title + Hook (1-2 sentences)
|
||||||
- [ ] Images have alt text and captions
|
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,12 +2,13 @@
|
||||||
title: "Workflow Customization Guide"
|
title: "Workflow Customization Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Customize and optimize workflows with step replacement and hooks.
|
Customize and optimize workflows with step replacement and hooks.
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
:::note[Coming Soon]
|
||||||
|
Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
||||||
|
:::
|
||||||
|
|
||||||
## What to Expect
|
## What to Expect
|
||||||
|
|
||||||
|
|
@ -22,12 +23,8 @@ Workflow customization will allow you to:
|
||||||
|
|
||||||
While workflow customization is in development, you can:
|
While workflow customization is in development, you can:
|
||||||
|
|
||||||
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
|
- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows
|
||||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](./customize-agents.md)
|
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
|
||||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
- **Provide Feedback** - Share your workflow customization needs with the community
|
||||||
|
|
||||||
---
|
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.
|
||||||
|
|
||||||
**In the meantime:** Learn how to [create custom workflows](../../explanation/bmad-builder/index.md) from scratch.
|
|
||||||
|
|
||||||
[← Back to Customization](./index.md)
|
|
||||||
|
|
@ -2,23 +2,24 @@
|
||||||
title: "Quick Flow Solo Dev Agent (Barry)"
|
title: "Quick Flow Solo Dev Agent (Barry)"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Barry is the elite solo developer who takes projects from concept to deployment with ruthless efficiency — no handoffs, no delays, just pure focused development.
|
||||||
|
|
||||||
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
:::note[Agent Info]
|
||||||
**Icon:** 🚀
|
- **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
||||||
**Module:** BMM
|
- **Icon:** 🚀
|
||||||
|
- **Module:** BMM
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Overview
|
## 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.
|
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
|
### Agent Persona
|
||||||
|
|
||||||
**Name:** Barry
|
**Name:** Barry
|
||||||
**Title:** Quick Flow Solo Dev
|
**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.
|
**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.
|
**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.
|
||||||
|
|
||||||
|
|
@ -31,15 +32,13 @@ Barry is the elite solo developer who lives and breathes the BMAD Quick Flow wor
|
||||||
- Documentation happens alongside development, not after
|
- Documentation happens alongside development, not after
|
||||||
- Ship early, ship often
|
- Ship early, ship often
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Menu Commands
|
## Menu Commands
|
||||||
|
|
||||||
Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
|
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**
|
### 1. **quick-spec**
|
||||||
|
|
||||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
|
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md`
|
||||||
- **Description:** Architect a technical spec with implementation-ready stories
|
- **Description:** Architect a technical spec with implementation-ready stories
|
||||||
- **Use when:** You need to transform requirements into a buildable spec
|
- **Use when:** You need to transform requirements into a buildable spec
|
||||||
|
|
||||||
|
|
@ -61,8 +60,6 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel
|
||||||
- **Description:** Bring in other experts when I need specialized backup
|
- **Description:** Bring in other experts when I need specialized backup
|
||||||
- **Use when:** You need collaborative problem-solving or specialized expertise
|
- **Use when:** You need collaborative problem-solving or specialized expertise
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Barry
|
## When to Use Barry
|
||||||
|
|
||||||
### Ideal Scenarios
|
### Ideal Scenarios
|
||||||
|
|
@ -81,15 +78,13 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel
|
||||||
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
||||||
- **Performance Optimizations** - System improvements and scalability work
|
- **Performance Optimizations** - System improvements and scalability work
|
||||||
|
|
||||||
---
|
## The BMad Quick Flow Process
|
||||||
|
|
||||||
## The BMAD Quick Flow Process
|
|
||||||
|
|
||||||
Barry orchestrates a simple, efficient 3-step process:
|
Barry orchestrates a simple, efficient 3-step process:
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart LR
|
flowchart LR
|
||||||
A[Requirements] --> B[create-tech-spec]
|
A[Requirements] --> B[quick-spec]
|
||||||
B --> C[Tech Spec]
|
B --> C[Tech Spec]
|
||||||
C --> D[quick-dev]
|
C --> D[quick-dev]
|
||||||
D --> E[Implementation]
|
D --> E[Implementation]
|
||||||
|
|
@ -107,7 +102,7 @@ flowchart LR
|
||||||
style H fill:#e0f2f1
|
style H fill:#e0f2f1
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 1: Technical Specification (`create-tech-spec`)
|
### Step 1: Technical Specification (`quick-spec`)
|
||||||
|
|
||||||
**Goal:** Transform user requirements into implementation-ready technical specifications
|
**Goal:** Transform user requirements into implementation-ready technical specifications
|
||||||
|
|
||||||
|
|
@ -180,8 +175,6 @@ flowchart LR
|
||||||
- Security considerations
|
- Security considerations
|
||||||
- Maintainability and documentation
|
- Maintainability and documentation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Collaboration with Other Agents
|
## Collaboration with Other Agents
|
||||||
|
|
||||||
### Natural Partnerships
|
### Natural Partnerships
|
||||||
|
|
@ -201,8 +194,6 @@ In party mode, Barry often acts as:
|
||||||
- **Performance Optimizer** - Ensuring scalable solutions
|
- **Performance Optimizer** - Ensuring scalable solutions
|
||||||
- **Code Review Authority** - Validating technical approaches
|
- **Code Review Authority** - Validating technical approaches
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips for Working with Barry
|
## Tips for Working with Barry
|
||||||
|
|
||||||
### For Best Results
|
### For Best Results
|
||||||
|
|
@ -228,8 +219,6 @@ In party mode, Barry often acts as:
|
||||||
4. **Over-planning** - I excel at rapid, pragmatic development
|
4. **Over-planning** - I excel at rapid, pragmatic development
|
||||||
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Workflow
|
## Example Workflow
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -237,7 +226,7 @@ In party mode, Barry often acts as:
|
||||||
/bmad:bmm:agents:quick-flow-solo-dev
|
/bmad:bmm:agents:quick-flow-solo-dev
|
||||||
|
|
||||||
# Create a tech spec
|
# Create a tech spec
|
||||||
> create-tech-spec
|
> quick-spec
|
||||||
|
|
||||||
# Quick implementation
|
# Quick implementation
|
||||||
> quick-dev tech-spec-auth.md
|
> quick-dev tech-spec-auth.md
|
||||||
|
|
@ -306,35 +295,34 @@ Implement OAuth 2.0 authentication with JWT tokens and role-based access control
|
||||||
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
## Common Questions
|
||||||
|
|
||||||
## Related Documentation
|
- [When should I use Barry vs other agents?](#when-should-i-use-barry-vs-other-agents)
|
||||||
|
- [Is the code review step mandatory?](#is-the-code-review-step-mandatory)
|
||||||
|
- [Can I skip the tech spec step?](#can-i-skip-the-tech-spec-step)
|
||||||
|
- [How does Barry differ from the Dev agent?](#how-does-barry-differ-from-the-dev-agent)
|
||||||
|
- [Can Barry handle enterprise-scale projects?](#can-barry-handle-enterprise-scale-projects)
|
||||||
|
|
||||||
- **[Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
|
### When should I use Barry vs other agents?
|
||||||
- **[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
|
|
||||||
|
|
||||||
---
|
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.
|
||||||
|
|
||||||
## Frequently Asked Questions
|
### Is the code review step mandatory?
|
||||||
|
|
||||||
**Q: When should I use Barry vs other agents?**
|
No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
|
||||||
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?**
|
### Can I skip the tech spec step?
|
||||||
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?**
|
Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
|
||||||
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?**
|
### 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?**
|
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.
|
||||||
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.
|
|
||||||
|
|
||||||
---
|
### Can Barry handle enterprise-scale projects?
|
||||||
|
|
||||||
**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
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.
|
||||||
|
|
||||||
|
:::tip[Ready to Ship?]
|
||||||
|
Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
||||||
|
:::
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
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
|
||||||
|
|
||||||
|
| Agent | Description |
|
||||||
|
| ------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||||
|
| **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** | Overview of all BMM agent roles and responsibilities |
|
||||||
|
| **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** | The dedicated agent for rapid development |
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
1. Read **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** for the core concept explanation
|
||||||
|
2. Review **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** to understand available agents
|
||||||
|
3. Choose an agent that fits your workflow needs
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
---
|
||||||
|
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](/docs/explanation/core-concepts/what-are-agents.md) |
|
||||||
|
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) |
|
||||||
|
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) |
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### New to BMad?
|
||||||
|
Start here to understand what BMad is and how it works:
|
||||||
|
|
||||||
|
1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents
|
||||||
|
2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks
|
||||||
|
3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality
|
||||||
|
|
||||||
|
### Installing BMad
|
||||||
|
|
||||||
|
- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project
|
||||||
|
- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows
|
||||||
|
|
||||||
|
### Advanced
|
||||||
|
|
||||||
|
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
|
||||||
|
|
@ -2,12 +2,11 @@
|
||||||
title: "Agents"
|
title: "Agents"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
||||||
|
|
||||||
## Agent Types
|
## Agent Types
|
||||||
|
|
||||||
BMAD has two primary agent types, designed for different use cases:
|
BMad has two primary agent types, designed for different use cases:
|
||||||
|
|
||||||
### Simple Agents
|
### Simple Agents
|
||||||
|
|
||||||
|
|
@ -72,6 +71,10 @@ All agents share these building blocks:
|
||||||
|
|
||||||
## Which Should You Use?
|
## Which Should You Use?
|
||||||
|
|
||||||
|
:::tip[Quick Decision]
|
||||||
|
Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows.
|
||||||
|
:::
|
||||||
|
|
||||||
**Choose Simple when:**
|
**Choose Simple when:**
|
||||||
- You need a task done quickly and reliably
|
- You need a task done quickly and reliably
|
||||||
- The scope is well-defined and won't change much
|
- The scope is well-defined and won't change much
|
||||||
|
|
@ -85,12 +88,10 @@ All agents share these building blocks:
|
||||||
|
|
||||||
## Creating Custom Agents
|
## 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.
|
BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md) for step-by-step instructions.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Customizing Existing Agents
|
## 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.
|
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/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.
|
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
---
|
||||||
|
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](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
|
||||||
|
- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
|
||||||
|
- [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration
|
||||||
|
- [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
|
||||||
|
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||||
|
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
|
||||||
|
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
||||||
|
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review
|
||||||
|
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
||||||
|
|
@ -2,12 +2,11 @@
|
||||||
title: "Web Bundles"
|
title: "Web Bundles"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use BMad agents in Gemini Gems and Custom GPTs.
|
||||||
|
|
||||||
Use BMAD agents in Gemini Gems and Custom GPTs.
|
:::caution[Status]
|
||||||
|
The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
||||||
## 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?
|
## What Are Web Bundles?
|
||||||
|
|
||||||
|
|
@ -25,7 +24,7 @@ Web bundles package BMad agents as self-contained files that work in Gemini Gems
|
||||||
|
|
||||||
**Perfect for:**
|
**Perfect for:**
|
||||||
- Uploading a single file to a Gemini GEM or Custom GPT
|
- Uploading a single file to a Gemini GEM or Custom GPT
|
||||||
- Using BMAD Method from the Web
|
- Using BMad Method from the Web
|
||||||
- Cost savings (generally lower cost than local usage)
|
- Cost savings (generally lower cost than local usage)
|
||||||
- Quick sharing of agent configurations
|
- Quick sharing of agent configurations
|
||||||
|
|
||||||
|
|
@ -33,5 +32,3 @@ Web bundles package BMad agents as self-contained files that work in Gemini Gems
|
||||||
- Some quality reduction vs local usage
|
- Some quality reduction vs local usage
|
||||||
- Less convenient than full local installation
|
- Less convenient than full local installation
|
||||||
- Limited to agent capabilities (no workflow file access)
|
- Limited to agent capabilities (no workflow file access)
|
||||||
|
|
||||||
[← Back to Core Concepts](../index.md)
|
|
||||||
|
|
@ -0,0 +1,156 @@
|
||||||
|
---
|
||||||
|
title: "BMGD Quick-Flow Guide"
|
||||||
|
description: Fast-track workflows for rapid game prototyping and flexible development
|
||||||
|
---
|
||||||
|
|
||||||
|
Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast.
|
||||||
|
|
||||||
|
## When to Use This
|
||||||
|
|
||||||
|
- Testing a game mechanic idea
|
||||||
|
- Implementing a small feature
|
||||||
|
- Rapid prototyping before committing to design
|
||||||
|
- Bug fixes and tweaks
|
||||||
|
|
||||||
|
## When to Use Full BMGD Instead
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
|
- BMad Method installed with BMGD module
|
||||||
|
- Game Solo Dev agent (Indie) or other BMGD agent available
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Game Solo Dev Agent
|
||||||
|
|
||||||
|
For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases.
|
||||||
|
|
||||||
|
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE.
|
||||||
|
|
||||||
|
Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework`
|
||||||
|
|
||||||
|
## Quick-Prototype
|
||||||
|
|
||||||
|
Use `quick-prototype` to 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
|
||||||
|
|
||||||
|
### Steps
|
||||||
|
|
||||||
|
1. Run `quick-prototype`
|
||||||
|
2. Define what you're prototyping (mechanic, feature, system)
|
||||||
|
3. Set success criteria (2-3 items)
|
||||||
|
4. Build the minimum to test the idea
|
||||||
|
5. Playtest and evaluate
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
Use `quick-dev` for 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**
|
||||||
|
```
|
||||||
|
quick-dev tech-spec-combat.md
|
||||||
|
```
|
||||||
|
|
||||||
|
**Mode B: Direct Instructions**
|
||||||
|
```
|
||||||
|
quick-dev implement double-jump for the player
|
||||||
|
```
|
||||||
|
|
||||||
|
**Mode C: From Prototype**
|
||||||
|
```
|
||||||
|
quick-dev from the grappling hook prototype
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
### Complexity Routing
|
||||||
|
|
||||||
|
| 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` |
|
||||||
|
|
||||||
|
## Flow Comparison
|
||||||
|
|
||||||
|
```
|
||||||
|
Full BMGD Flow:
|
||||||
|
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
||||||
|
|
||||||
|
Quick-Flow:
|
||||||
|
Idea → Quick-Prototype → Quick-Dev → Done
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checklists
|
||||||
|
|
||||||
|
**Quick-Prototype:**
|
||||||
|
- [ ] Prototype scope defined
|
||||||
|
- [ ] Success criteria established (2-3 items)
|
||||||
|
- [ ] Minimum viable code written
|
||||||
|
- [ ] Placeholder assets used
|
||||||
|
- [ ] Each criterion evaluated
|
||||||
|
- [ ] Decision made (develop/iterate/archive)
|
||||||
|
|
||||||
|
**Quick-Dev:**
|
||||||
|
- [ ] Context loaded (spec, prototype, or guidance)
|
||||||
|
- [ ] Files to modify identified
|
||||||
|
- [ ] All tasks completed
|
||||||
|
- [ ] No allocations in hot paths
|
||||||
|
- [ ] Game runs without errors
|
||||||
|
- [ ] Manual playtest completed
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back
|
||||||
|
- **Embrace programmer art** — Focus on feel, not visuals
|
||||||
|
- **Test on target hardware** — What feels right on dev machine might not on target
|
||||||
|
- **Document learnings** — Even failed prototypes teach something
|
||||||
|
- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories
|
||||||
|
|
@ -0,0 +1,97 @@
|
||||||
|
---
|
||||||
|
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
|
||||||
|
|
||||||
|
:::note[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 | 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
|
||||||
|
|
||||||
|
Research output varies by type:
|
||||||
|
|
||||||
|
**Market Research:**
|
||||||
|
- TAM/SAM/SOM analysis
|
||||||
|
- Top competitors
|
||||||
|
- Positioning recommendation
|
||||||
|
|
||||||
|
**Technical Research:**
|
||||||
|
- 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
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Use market research early** — Validates new product ideas
|
||||||
|
- **Technical research helps architecture** — Inform ADRs with data
|
||||||
|
- **Competitive research informs positioning** — Differentiate your product
|
||||||
|
- **Domain research for specialized industries** — Fintech, healthcare, etc.
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create Architecture"
|
||||||
description: How to create system architecture using the BMad Method
|
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.
|
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Multi-epic projects (BMad Method, Enterprise)
|
- Multi-epic projects (BMad Method, Enterprise)
|
||||||
|
|
@ -16,23 +13,17 @@ Use the `architecture` workflow to make technical decisions explicit and prevent
|
||||||
- Integration complexity exists
|
- Integration complexity exists
|
||||||
- Technology choices need alignment
|
- Technology choices need alignment
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Quick Flow (simple changes)
|
- Quick Flow (simple changes)
|
||||||
- BMad Method Simple with straightforward tech stack
|
- BMad Method Simple with straightforward tech stack
|
||||||
- Single epic with clear technical approach
|
- Single epic with clear technical approach
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Architect agent available
|
- Architect agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -63,25 +54,21 @@ Work with the agent to create Architecture Decision Records (ADRs) for significa
|
||||||
|
|
||||||
The agent produces a decision-focused architecture document.
|
The agent produces a decision-focused architecture document.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
An `architecture.md` document containing:
|
An `architecture.md` document containing:
|
||||||
|
|
||||||
1. **Architecture Overview** - System context, principles, style
|
1. **Architecture Overview** — System context, principles, style
|
||||||
2. **System Architecture** - High-level diagram, component interactions
|
2. **System Architecture** — High-level diagram, component interactions
|
||||||
3. **Data Architecture** - Database design, state management, caching
|
3. **Data Architecture** — Database design, state management, caching
|
||||||
4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning
|
4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning
|
||||||
5. **Frontend Architecture** - Framework, state management, components
|
5. **Frontend Architecture** — Framework, state management, components
|
||||||
6. **Integration Architecture** - Third-party integrations, messaging
|
6. **Integration Architecture** — Third-party integrations, messaging
|
||||||
7. **Security Architecture** - Auth/authorization, data protection
|
7. **Security Architecture** — Auth/authorization, data protection
|
||||||
8. **Deployment Architecture** - CI/CD, environments, monitoring
|
8. **Deployment Architecture** — CI/CD, environments, monitoring
|
||||||
9. **ADRs** - Key decisions with context, options, rationale
|
9. **ADRs** — Key decisions with context, options, rationale
|
||||||
10. **FR/NFR-Specific Guidance** - Technical approach per requirement
|
10. **FR/NFR-Specific Guidance** — Technical approach per requirement
|
||||||
11. **Standards and Conventions** - Directory structure, naming, testing
|
11. **Standards and Conventions** — Directory structure, naming, testing
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ADR Format
|
## ADR Format
|
||||||
|
|
||||||
|
|
@ -110,8 +97,6 @@ An `architecture.md` document containing:
|
||||||
- Mitigation: Use DataLoader for batching
|
- Mitigation: Use DataLoader for batching
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce platform produces:
|
E-commerce platform produces:
|
||||||
|
|
@ -119,29 +104,16 @@ E-commerce platform produces:
|
||||||
- ADRs explaining each choice
|
- ADRs explaining each choice
|
||||||
- FR/NFR-specific implementation guidance
|
- FR/NFR-specific implementation guidance
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Focus on decisions that prevent agent conflicts
|
- **Focus on decisions that prevent conflicts** — Multiple agents need alignment
|
||||||
- Use ADRs for every significant technology choice
|
- **Use ADRs for every significant choice** — Document the "why"
|
||||||
- Keep it practical - don't over-architect
|
- **Keep it practical** — Don't over-architect
|
||||||
- Architecture is living - update as you learn
|
- **Architecture is living** — Update as you learn
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After architecture:
|
After architecture:
|
||||||
|
|
||||||
1. **Create Epics and Stories** - Work breakdown informed by architecture
|
1. **Create Epics and Stories** — Work breakdown informed by architecture
|
||||||
2. **Implementation Readiness** - Gate check before Phase 4
|
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)
|
|
||||||
|
|
@ -3,38 +3,29 @@ title: "How to Create Epics and Stories"
|
||||||
description: How to break PRD requirements into epics and stories using BMad Method
|
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.
|
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- After architecture workflow completes
|
- After architecture workflow completes
|
||||||
- When PRD contains FRs/NFRs ready for implementation breakdown
|
- When PRD contains FRs/NFRs ready for implementation breakdown
|
||||||
- Before implementation-readiness gate check
|
- Before implementation-readiness gate check
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent available
|
- PM agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
- Architecture completed
|
- Architecture completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Why After Architecture?
|
## Why After Architecture?
|
||||||
|
|
||||||
This workflow runs AFTER architecture because:
|
This workflow runs AFTER architecture because:
|
||||||
|
|
||||||
1. **Informed Story Sizing** - Architecture decisions affect story complexity
|
1. **Informed Story Sizing** — Architecture decisions affect story complexity
|
||||||
2. **Dependency Awareness** - Architecture reveals technical dependencies
|
2. **Dependency Awareness** — Architecture reveals technical dependencies
|
||||||
3. **Technical Feasibility** - Stories can be properly scoped knowing the tech stack
|
3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack
|
||||||
4. **Consistency** - All stories align with documented architectural patterns
|
4. **Consistency** — All stories align with documented architectural patterns
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -67,8 +58,6 @@ Ensure each story has:
|
||||||
- Identified dependencies
|
- Identified dependencies
|
||||||
- Technical notes from architecture
|
- Technical notes from architecture
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
Epic files (one per epic) containing:
|
Epic files (one per epic) containing:
|
||||||
|
|
@ -79,8 +68,6 @@ Epic files (one per epic) containing:
|
||||||
4. **Dependencies between stories**
|
4. **Dependencies between stories**
|
||||||
5. **Technical notes** referencing architecture decisions
|
5. **Technical notes** referencing architecture decisions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
|
||||||
|
|
@ -98,39 +85,25 @@ E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produce
|
||||||
|
|
||||||
Each story references relevant ADRs from architecture.
|
Each story references relevant ADRs from architecture.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Priority Levels
|
## Story Priority Levels
|
||||||
|
|
||||||
| Priority | Meaning |
|
| Priority | Meaning |
|
||||||
|----------|---------|
|
|----------|---------|
|
||||||
| **P0** | Critical - Must have for MVP |
|
| **P0** | Critical — Must have for MVP |
|
||||||
| **P1** | High - Important for release |
|
| **P1** | High — Important for release |
|
||||||
| **P2** | Medium - Nice to have |
|
| **P2** | Medium — Nice to have |
|
||||||
| **P3** | Low - Future consideration |
|
| **P3** | Low — Future consideration |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Keep stories small enough to complete in a session
|
- **Keep stories small** — Complete in a single session
|
||||||
- Ensure acceptance criteria are testable
|
- **Make criteria testable** — Acceptance criteria should be verifiable
|
||||||
- Document dependencies clearly
|
- **Document dependencies clearly** — Know what blocks what
|
||||||
- Reference architecture decisions in technical notes
|
- **Reference architecture** — Include ADR references in technical notes
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After creating epics and stories:
|
After creating epics and stories:
|
||||||
|
|
||||||
1. **Implementation Readiness** - Validate alignment before Phase 4
|
1. **Implementation Readiness** — Validate alignment before Phase 4
|
||||||
2. **Sprint Planning** - Organize work for implementation
|
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
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a PRD"
|
||||||
description: How to create a Product Requirements Document using the BMad Method
|
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).
|
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Medium to large feature sets
|
- Medium to large feature sets
|
||||||
|
|
@ -16,15 +13,11 @@ Use the `prd` workflow to create a strategic Product Requirements Document with
|
||||||
- Multiple system integrations
|
- Multiple system integrations
|
||||||
- Phased delivery required
|
- Phased delivery required
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent available
|
- PM agent available
|
||||||
- Optional: Product brief from Phase 1
|
- Optional: Product brief from Phase 1
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,15 +41,13 @@ The workflow will:
|
||||||
### 4. Define Requirements
|
### 4. Define Requirements
|
||||||
|
|
||||||
Work with the agent to define:
|
Work with the agent to define:
|
||||||
- Functional Requirements (FRs) - What the system should do
|
- Functional Requirements (FRs) — What the system should do
|
||||||
- Non-Functional Requirements (NFRs) - How well it should do it
|
- Non-Functional Requirements (NFRs) — How well it should do it
|
||||||
|
|
||||||
### 5. Review the PRD
|
### 5. Review the PRD
|
||||||
|
|
||||||
The agent produces a comprehensive PRD scaled to your project.
|
The agent produces a comprehensive PRD scaled to your project.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `PRD.md` document containing:
|
A `PRD.md` document containing:
|
||||||
|
|
@ -69,8 +60,6 @@ A `PRD.md` document containing:
|
||||||
- Success metrics
|
- Success metrics
|
||||||
- Risks and assumptions
|
- Risks and assumptions
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scale-Adaptive Structure
|
## Scale-Adaptive Structure
|
||||||
|
|
||||||
The PRD adapts to your project complexity:
|
The PRD adapts to your project complexity:
|
||||||
|
|
@ -81,50 +70,22 @@ The PRD adapts to your project complexity:
|
||||||
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
|
||||||
| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder 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
|
## Example
|
||||||
|
|
||||||
E-commerce checkout → PRD with:
|
E-commerce checkout → PRD with:
|
||||||
- 15 FRs (user account, cart management, payment flow)
|
- 15 FRs (user account, cart management, payment flow)
|
||||||
- 8 NFRs (performance, security, scalability)
|
- 8 NFRs (performance, security, scalability)
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
## Best Practices
|
- **Do Product Brief first** — Run product-brief from Phase 1 for better results
|
||||||
|
- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3
|
||||||
### 1. Do Product Brief First
|
- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context
|
||||||
|
|
||||||
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
|
## Next Steps
|
||||||
|
|
||||||
After PRD:
|
After PRD:
|
||||||
|
|
||||||
1. **Create UX Design** (optional) - If UX is critical
|
1. **Create UX Design** (optional) — If UX is critical
|
||||||
2. **Create Architecture** - Technical design
|
2. **Create Architecture** — Technical design
|
||||||
3. **Create Epics and Stories** - After architecture
|
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
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a Product Brief"
|
||||||
description: How to create a product brief using the BMad Method
|
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.
|
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Starting new product or major feature initiative
|
- Starting new product or major feature initiative
|
||||||
|
|
@ -15,15 +12,11 @@ Use the `product-brief` workflow to define product vision and strategy through a
|
||||||
- Transitioning from exploration to strategy
|
- Transitioning from exploration to strategy
|
||||||
- Need executive-level product documentation
|
- Need executive-level product documentation
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Analyst agent available
|
- Analyst agent available
|
||||||
- Optional: Research documents from previous workflows
|
- Optional: Research documents from previous workflows
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -50,22 +43,18 @@ The workflow guides you through strategic product vision definition:
|
||||||
|
|
||||||
The agent will draft sections and let you refine them interactively.
|
The agent will draft sections and let you refine them interactively.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
The `product-brief.md` document includes:
|
The `product-brief.md` document includes:
|
||||||
|
|
||||||
- **Executive summary** - High-level overview
|
- **Executive summary** — High-level overview
|
||||||
- **Problem statement** - With evidence
|
- **Problem statement** — With evidence
|
||||||
- **Proposed solution** - And differentiators
|
- **Proposed solution** — And differentiators
|
||||||
- **Target users** - Segmented
|
- **Target users** — Segmented
|
||||||
- **MVP scope** - Ruthlessly defined
|
- **MVP scope** — Ruthlessly defined
|
||||||
- **Financial impact** - And ROI
|
- **Financial impact** — And ROI
|
||||||
- **Strategic alignment** - With business goals
|
- **Strategic alignment** — With business goals
|
||||||
- **Risks and open questions** - Documented upfront
|
- **Risks and open questions** — Documented upfront
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration with Other Workflows
|
## Integration with Other Workflows
|
||||||
|
|
||||||
|
|
@ -79,11 +68,9 @@ The product brief feeds directly into the PRD workflow:
|
||||||
|
|
||||||
Planning workflows automatically load the product brief if it exists.
|
Planning workflows automatically load the product brief if it exists.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Patterns
|
## Common Patterns
|
||||||
|
|
||||||
### Greenfield Software (Full Analysis)
|
**Greenfield Software (Full Analysis):**
|
||||||
|
|
||||||
```
|
```
|
||||||
1. brainstorm-project - explore approaches
|
1. brainstorm-project - explore approaches
|
||||||
|
|
@ -92,26 +79,16 @@ Planning workflows automatically load the product brief if it exists.
|
||||||
4. → Phase 2: prd
|
4. → Phase 2: prd
|
||||||
```
|
```
|
||||||
|
|
||||||
### Skip Analysis (Clear Requirements)
|
**Skip Analysis (Clear Requirements):**
|
||||||
|
|
||||||
```
|
```
|
||||||
→ Phase 2: prd or tech-spec directly
|
→ Phase 2: prd or tech-spec directly
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Be specific about the problem you're solving
|
- **Be specific about the problem** — Vague problems lead to vague solutions
|
||||||
- Ruthlessly prioritize MVP scope
|
- **Ruthlessly prioritize MVP scope** — Less is more
|
||||||
- Document assumptions and risks
|
- **Document assumptions and risks** — Surface unknowns early
|
||||||
- Use research findings as evidence
|
- **Use research findings as evidence** — Back up claims with data
|
||||||
- This is recommended for greenfield projects
|
- **Recommended for greenfield projects** — Sets strategic foundation
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Create a Story"
|
||||||
description: How to create implementation-ready stories from epic backlog
|
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.
|
Use the `create-story` workflow to prepare the next story from the epic backlog for implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Before implementing each story
|
- Before implementing each story
|
||||||
- When moving to the next story in an epic
|
- When moving to the next story in an epic
|
||||||
- After sprint-planning has been run
|
- After sprint-planning has been run
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- SM (Scrum Master) agent available
|
- SM (Scrum Master) agent available
|
||||||
- Sprint-status.yaml created by sprint-planning
|
- Sprint-status.yaml created by sprint-planning
|
||||||
- Architecture and PRD available for context
|
- Architecture and PRD available for context
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,8 +41,6 @@ The agent will:
|
||||||
|
|
||||||
The agent creates a comprehensive story file ready for development.
|
The agent creates a comprehensive story file ready for development.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `story-[slug].md` file containing:
|
A `story-[slug].md` file containing:
|
||||||
|
|
@ -61,23 +52,18 @@ A `story-[slug].md` file containing:
|
||||||
- Dependencies on other stories
|
- Dependencies on other stories
|
||||||
- Definition of Done
|
- Definition of Done
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Content Sources
|
## Story Content Sources
|
||||||
|
|
||||||
The create-story workflow pulls from:
|
The create-story workflow pulls from:
|
||||||
|
|
||||||
- **PRD** - Requirements and acceptance criteria
|
- **PRD** — Requirements and acceptance criteria
|
||||||
- **Architecture** - Technical approach and ADRs
|
- **Architecture** — Technical approach and ADRs
|
||||||
- **Epic file** - Story context and dependencies
|
- **Epic file** — Story context and dependencies
|
||||||
- **Existing code** - Patterns to follow (brownfield)
|
- **Existing code** — Patterns to follow (brownfield)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Output
|
## Example Output
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
|
|
||||||
## Objective
|
## Objective
|
||||||
Implement email verification flow for new user registrations.
|
Implement email verification flow for new user registrations.
|
||||||
|
|
||||||
|
|
@ -93,7 +79,7 @@ Implement email verification flow for new user registrations.
|
||||||
- Follow existing email template patterns in /templates
|
- Follow existing email template patterns in /templates
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- Story 1.1 (User Registration) - DONE ✅
|
- Story 1.1 (User Registration) - DONE
|
||||||
|
|
||||||
## Definition of Done
|
## Definition of Done
|
||||||
- All acceptance criteria pass
|
- All acceptance criteria pass
|
||||||
|
|
@ -101,19 +87,16 @@ Implement email verification flow for new user registrations.
|
||||||
- Code review approved
|
- Code review approved
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Complete one story before creating the next
|
- **Complete one story before creating the next** — Focus on finishing
|
||||||
- Ensure dependencies are marked DONE before starting
|
- **Ensure dependencies are DONE** — Don't start blocked stories
|
||||||
- Review technical notes for architecture alignment
|
- **Review technical notes** — Align with architecture
|
||||||
- Use the story file as context for dev-story
|
- **Use the story file as context** — Pass to dev-story workflow
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After creating a story:
|
||||||
|
|
||||||
- [Run Sprint Planning](./run-sprint-planning.md) - Initialize tracking
|
1. **Implement Story** — Run dev-story with the DEV agent
|
||||||
- [Implement Story](./implement-story.md) - Next step
|
2. **Code Review** — Run code-review after implementation
|
||||||
- [Run Code Review](./run-code-review.md) - After implementation
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Create a UX Design"
|
||||||
description: How to create UX specifications using the BMad Method
|
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.
|
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- UX is primary competitive advantage
|
- UX is primary competitive advantage
|
||||||
|
|
@ -16,8 +13,6 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
|
||||||
- Design system creation
|
- Design system creation
|
||||||
- Accessibility-critical experiences
|
- Accessibility-critical experiences
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Simple CRUD interfaces
|
- Simple CRUD interfaces
|
||||||
|
|
@ -25,15 +20,11 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
|
||||||
- Changes to existing screens you're happy with
|
- Changes to existing screens you're happy with
|
||||||
- Quick Flow projects
|
- Quick Flow projects
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- UX Designer agent available
|
- UX Designer agent available
|
||||||
- PRD completed
|
- PRD completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -58,17 +49,15 @@ Point the agent to your PRD and describe:
|
||||||
|
|
||||||
The workflow uses a collaborative approach:
|
The workflow uses a collaborative approach:
|
||||||
|
|
||||||
1. **Visual exploration** - Generate multiple options
|
1. **Visual exploration** — Generate multiple options
|
||||||
2. **Informed decisions** - Evaluate with user needs
|
2. **Informed decisions** — Evaluate with user needs
|
||||||
3. **Collaborative design** - Refine iteratively
|
3. **Collaborative design** — Refine iteratively
|
||||||
4. **Living documentation** - Evolves with project
|
4. **Living documentation** — Evolves with project
|
||||||
|
|
||||||
### 5. Review the UX Spec
|
### 5. Review the UX Spec
|
||||||
|
|
||||||
The agent produces comprehensive UX documentation.
|
The agent produces comprehensive UX documentation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
The `ux-spec.md` document includes:
|
The `ux-spec.md` document includes:
|
||||||
|
|
@ -79,8 +68,6 @@ The `ux-spec.md` document includes:
|
||||||
- Design system (components, patterns, tokens)
|
- Design system (components, patterns, tokens)
|
||||||
- Epic breakdown (UX stories)
|
- Epic breakdown (UX stories)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
Dashboard redesign produces:
|
Dashboard redesign produces:
|
||||||
|
|
@ -90,8 +77,6 @@ Dashboard redesign produces:
|
||||||
- Responsive grid
|
- Responsive grid
|
||||||
- 3 epics (Layout, Visualization, Accessibility)
|
- 3 epics (Layout, Visualization, Accessibility)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration
|
## Integration
|
||||||
|
|
||||||
The UX spec feeds into:
|
The UX spec feeds into:
|
||||||
|
|
@ -99,19 +84,17 @@ The UX spec feeds into:
|
||||||
- Epic and story creation
|
- Epic and story creation
|
||||||
- Architecture decisions (Phase 3)
|
- Architecture decisions (Phase 3)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Focus on user problems, not solutions first
|
- **Focus on user problems first** — Solutions come second
|
||||||
- Generate multiple options before deciding
|
- **Generate multiple options** — Don't settle on the first idea
|
||||||
- Consider accessibility from the start
|
- **Consider accessibility from the start** — Not an afterthought
|
||||||
- Document component reusability
|
- **Document component reusability** — Build a system, not just screens
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After UX design:
|
||||||
|
|
||||||
- [Create PRD](./create-prd.md) - Create requirements first
|
1. **Update PRD** — Incorporate UX findings
|
||||||
- [Create Architecture](./create-architecture.md) - Technical design
|
2. **Create Architecture** — Technical design informed by UX
|
||||||
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
|
3. **Create Epics and Stories** — Include UX-specific stories
|
||||||
|
|
@ -0,0 +1,97 @@
|
||||||
|
---
|
||||||
|
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
|
||||||
|
|
||||||
|
:::note[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, and 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** — Reference it during implementation
|
||||||
|
- **Ask the agent to explain decisions** — Understand the approach
|
||||||
|
- **Run tests frequently** — Catch issues early
|
||||||
|
- **Don't skip tests** — Even for "simple" changes
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
**Story needs significant changes mid-implementation?**
|
||||||
|
Run `correct-course` to analyze impact and route appropriately.
|
||||||
|
|
||||||
|
**Can I work on multiple stories in parallel?**
|
||||||
|
Not recommended. Complete one story's full lifecycle first.
|
||||||
|
|
||||||
|
**What if implementation reveals the story is too large?**
|
||||||
|
Split the story and document the change.
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
After implementing a story:
|
||||||
|
|
||||||
|
1. **Code Review** — Run code-review with the DEV agent
|
||||||
|
2. **Create Next Story** — Run create-story with the SM agent
|
||||||
|
|
@ -1,12 +1,9 @@
|
||||||
---
|
---
|
||||||
title: "How to Create a Tech Spec"
|
title: "How to Use Quick Spec"
|
||||||
description: How to create a technical specification using Quick Spec Flow
|
description: How to create a technical specification using Quick Spec workflow
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
|
||||||
Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -16,15 +13,11 @@ Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to
|
||||||
- Adding to existing brownfield codebase
|
- Adding to existing brownfield codebase
|
||||||
- Quick Flow track projects
|
- Quick Flow track projects
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- PM agent or Quick Flow Solo Dev agent available
|
- PM agent or Quick Flow Solo Dev agent available
|
||||||
- Project directory (can be empty for greenfield)
|
- Project directory (can be empty for greenfield)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -35,7 +28,7 @@ Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent).
|
||||||
### 2. Run the Tech Spec Workflow
|
### 2. Run the Tech Spec Workflow
|
||||||
|
|
||||||
```
|
```
|
||||||
*create-tech-spec
|
*quick-spec
|
||||||
```
|
```
|
||||||
|
|
||||||
Or simply describe what you want to build:
|
Or simply describe what you want to build:
|
||||||
|
|
@ -63,12 +56,9 @@ For brownfield projects, the agent will:
|
||||||
|
|
||||||
The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
### tech-spec.md
|
**tech-spec.md:**
|
||||||
|
|
||||||
- Problem statement and solution
|
- Problem statement and solution
|
||||||
- Detected framework versions and dependencies
|
- Detected framework versions and dependencies
|
||||||
- Brownfield code patterns (if applicable)
|
- Brownfield code patterns (if applicable)
|
||||||
|
|
@ -76,18 +66,11 @@ The agent generates a comprehensive tech-spec with ready-to-implement stories.
|
||||||
- Specific file paths to modify
|
- Specific file paths to modify
|
||||||
- Complete implementation guidance
|
- Complete implementation guidance
|
||||||
|
|
||||||
### Story Files
|
**Story Files:**
|
||||||
|
- Single changes: `story-[slug].md`
|
||||||
|
- Small features: `epics.md` + `story-[epic-slug]-1.md`, etc.
|
||||||
|
|
||||||
For single changes:
|
## Example: Bug Fix
|
||||||
- `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"
|
**You:** "I want to fix the login validation bug that allows empty passwords"
|
||||||
|
|
||||||
|
|
@ -99,11 +82,7 @@ For small features:
|
||||||
5. Generates tech-spec.md with specific file paths
|
5. Generates tech-spec.md with specific file paths
|
||||||
6. Creates story-login-fix.md
|
6. Creates story-login-fix.md
|
||||||
|
|
||||||
**Total time:** 15-30 minutes (mostly implementation)
|
## Example: Small Feature
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example: Small Feature (Multi-Story)
|
|
||||||
|
|
||||||
**You:** "I want to add OAuth social login (Google, GitHub)"
|
**You:** "I want to add OAuth social login (Google, GitHub)"
|
||||||
|
|
||||||
|
|
@ -118,10 +97,6 @@ For small features:
|
||||||
- story-oauth-1.md (Backend OAuth setup)
|
- story-oauth-1.md (Backend OAuth setup)
|
||||||
- story-oauth-2.md (Frontend login buttons)
|
- story-oauth-2.md (Frontend login buttons)
|
||||||
|
|
||||||
**Total time:** 1-3 hours (mostly implementation)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Implementing After Tech Spec
|
## Implementing After Tech Spec
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -133,27 +108,15 @@ For small features:
|
||||||
# Then: Load DEV agent and run dev-story for each story
|
# Then: Load DEV agent and run dev-story for each story
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
### Be Specific in Discovery
|
- **Be specific in discovery** — "Fix email validation in UserService to allow plus-addressing" beats "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
|
||||||
|
|
||||||
- ✅ "Fix email validation in UserService to allow plus-addressing"
|
## Next Steps
|
||||||
- ❌ "Fix validation bug"
|
|
||||||
|
|
||||||
### Trust Convention Detection
|
After tech spec:
|
||||||
|
|
||||||
If it detects your patterns correctly, say yes! It's faster than establishing new conventions.
|
1. **Implement Story** — Run dev-story with the DEV agent
|
||||||
|
2. **Sprint Planning** — Optional for multi-story features
|
||||||
### 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
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Run a Brainstorming Session"
|
||||||
description: How to run a brainstorming session using the BMad Method
|
description: How to run a brainstorming session using the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
|
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Very vague or seed kernel of an idea that needs exploration
|
- Very vague or seed kernel of an idea that needs exploration
|
||||||
|
|
@ -15,14 +12,10 @@ Use the `brainstorm-project` workflow to explore solution approaches through par
|
||||||
- See your idea from different angles and viewpoints
|
- See your idea from different angles and viewpoints
|
||||||
- No idea what you want to build, but want to find some inspiration
|
- No idea what you want to build, but want to find some inspiration
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Analyst agent available
|
- Analyst agent available
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -48,17 +41,15 @@ Tell the agent about your project idea, even if it's vague:
|
||||||
|
|
||||||
The workflow generates solution approaches through parallel ideation tracks:
|
The workflow generates solution approaches through parallel ideation tracks:
|
||||||
|
|
||||||
- **Architecture track** - Technical approaches and patterns
|
- **Architecture track** — Technical approaches and patterns
|
||||||
- **UX track** - User experience possibilities
|
- **UX track** — User experience possibilities
|
||||||
- **Integration track** - How it connects with other systems
|
- **Integration track** — How it connects with other systems
|
||||||
- **Value track** - Business value and differentiation
|
- **Value track** — Business value and differentiation
|
||||||
|
|
||||||
### 5. Evaluate Options
|
### 5. Evaluate Options
|
||||||
|
|
||||||
Review the generated options with rationale for each approach.
|
Review the generated options with rationale for each approach.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
- Multiple solution approaches with trade-offs
|
- Multiple solution approaches with trade-offs
|
||||||
|
|
@ -66,29 +57,17 @@ Review the generated options with rationale for each approach.
|
||||||
- UX and integration considerations
|
- UX and integration considerations
|
||||||
- Clear rationale for each direction
|
- Clear rationale for each direction
|
||||||
|
|
||||||
---
|
## Tips
|
||||||
|
|
||||||
|
- **Don't worry about having a fully formed idea** — Vague is fine
|
||||||
|
- **Let the agent guide exploration** — Follow the prompts
|
||||||
|
- **Consider multiple tracks** — Don't settle on the first option
|
||||||
|
- **Use outputs as input for product-brief** — Build on brainstorming results
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
After brainstorming:
|
After brainstorming:
|
||||||
|
|
||||||
1. **Research** - Validate ideas with market/technical research
|
1. **Research** — Validate ideas with market/technical research
|
||||||
2. **Product Brief** - Capture strategic vision
|
2. **Product Brief** — Capture strategic vision
|
||||||
3. **PRD** - Move to formal planning
|
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
|
|
||||||
|
|
@ -0,0 +1,89 @@
|
||||||
|
---
|
||||||
|
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
|
||||||
|
|
||||||
|
:::note[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
|
||||||
|
|
||||||
|
| Category | Checks |
|
||||||
|
|----------|--------|
|
||||||
|
| **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling |
|
||||||
|
| **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns |
|
||||||
|
| **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns |
|
||||||
|
| **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities |
|
||||||
|
| **Performance** | No obvious issues, appropriate data structures, efficient queries |
|
||||||
|
|
||||||
|
## Review Outcomes
|
||||||
|
|
||||||
|
**Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml.
|
||||||
|
|
||||||
|
**Changes Requested** — Issues identified that need fixing. 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 for "simple" changes** — Simple changes can have subtle bugs
|
||||||
|
- **Address all findings** — Not just critical ones
|
||||||
|
- **Use findings as learning opportunities** — Improve over time
|
||||||
|
- **Re-run review after fixes** — Verify issues are resolved
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
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
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Run Implementation Readiness"
|
||||||
description: How to validate planning and solutioning before implementation
|
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.
|
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
- **Always** before Phase 4 for BMad Method and Enterprise projects
|
||||||
|
|
@ -15,22 +12,16 @@ Use the `implementation-readiness` workflow to validate that planning and soluti
|
||||||
- Before sprint-planning workflow
|
- Before sprint-planning workflow
|
||||||
- When stakeholders request readiness check
|
- When stakeholders request readiness check
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Skip This
|
## When to Skip This
|
||||||
|
|
||||||
- Quick Flow (no solutioning phase)
|
- Quick Flow (no solutioning phase)
|
||||||
- BMad Method Simple (no gate check required)
|
- BMad Method Simple (no gate check required)
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Architect agent available
|
- Architect agent available
|
||||||
- PRD, Architecture, and Epics completed
|
- PRD, Architecture, and Epics completed
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -56,66 +47,42 @@ The workflow systematically checks:
|
||||||
|
|
||||||
The agent produces a gate decision with rationale.
|
The agent produces a gate decision with rationale.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Gate Decision Outcomes
|
## Gate Decision Outcomes
|
||||||
|
|
||||||
### ✅ PASS
|
| Decision | Meaning | Action |
|
||||||
|
|----------|---------|--------|
|
||||||
- All critical criteria met
|
| **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 |
|
||||||
- Minor gaps acceptable with documented plan
|
| **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel |
|
||||||
- **Action:** Proceed to Phase 4
|
| **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first |
|
||||||
|
|
||||||
### ⚠️ 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
|
## What Gets Checked
|
||||||
|
|
||||||
### PRD/GDD Completeness
|
**PRD/GDD Completeness:**
|
||||||
- Problem statement clear and evidence-based
|
- Problem statement clear and evidence-based
|
||||||
- Success metrics defined
|
- Success metrics defined
|
||||||
- User personas identified
|
- User personas identified
|
||||||
- Functional requirements (FRs) complete
|
- FRs and NFRs complete
|
||||||
- Non-functional requirements (NFRs) specified
|
|
||||||
- Risks and assumptions documented
|
- Risks and assumptions documented
|
||||||
|
|
||||||
### Architecture Completeness
|
**Architecture Completeness:**
|
||||||
- System architecture defined
|
- System, data, API architecture defined
|
||||||
- Data architecture specified
|
|
||||||
- API architecture decided
|
|
||||||
- Key ADRs documented
|
- Key ADRs documented
|
||||||
- Security architecture addressed
|
- Security architecture addressed
|
||||||
- FR/NFR-specific guidance provided
|
- FR/NFR-specific guidance provided
|
||||||
- Standards and conventions defined
|
- Standards and conventions defined
|
||||||
|
|
||||||
### Epic/Story Completeness
|
**Epic/Story Completeness:**
|
||||||
- All PRD features mapped to stories
|
- All PRD features mapped to stories
|
||||||
- Stories have acceptance criteria
|
- Stories have acceptance criteria
|
||||||
- Stories prioritized (P0/P1/P2/P3)
|
- Stories prioritized (P0/P1/P2/P3)
|
||||||
- Dependencies identified
|
- Dependencies identified
|
||||||
- Story sequencing logical
|
|
||||||
|
|
||||||
### Alignment Checks
|
**Alignment Checks:**
|
||||||
- Architecture addresses all PRD FRs/NFRs
|
- Architecture addresses all PRD FRs/NFRs
|
||||||
- Epics align with architecture decisions
|
- Epics align with architecture decisions
|
||||||
- No contradictions between epics
|
- No contradictions between epics
|
||||||
- NFRs have technical approach
|
|
||||||
- Integration points clear
|
- Integration points clear
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
An `implementation-readiness.md` document containing:
|
An `implementation-readiness.md` document containing:
|
||||||
|
|
@ -128,11 +95,9 @@ An `implementation-readiness.md` document containing:
|
||||||
6. **Gate Decision** with rationale
|
6. **Gate Decision** with rationale
|
||||||
7. **Next Steps**
|
7. **Next Steps**
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
E-commerce platform → CONCERNS ⚠️
|
E-commerce platform → CONCERNS
|
||||||
|
|
||||||
**Gaps identified:**
|
**Gaps identified:**
|
||||||
- Missing security architecture section
|
- Missing security architecture section
|
||||||
|
|
@ -144,19 +109,17 @@ E-commerce platform → CONCERNS ⚠️
|
||||||
|
|
||||||
**Action:** Proceed with caution, address before payment epic.
|
**Action:** Proceed with caution, address before payment epic.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run this before every Phase 4 start
|
- **Run before every Phase 4 start** — It's a valuable checkpoint
|
||||||
- Take FAIL decisions seriously - fix issues first
|
- **Take FAIL decisions seriously** — Fix issues first
|
||||||
- Use CONCERNS as a checklist for parallel work
|
- **Use CONCERNS as a checklist** — Track parallel work
|
||||||
- Document why you proceed despite concerns
|
- **Document why you proceed despite concerns** — Transparency matters
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After implementation readiness:
|
||||||
|
|
||||||
- [Create Architecture](./create-architecture.md) - Architecture workflow
|
1. **If PASS** — Run sprint-planning to start Phase 4
|
||||||
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
|
2. **If CONCERNS** — Proceed with documented gaps to address
|
||||||
- [Run Sprint Planning](./run-sprint-planning.md) - Start implementation
|
3. **If FAIL** — Return to relevant workflow to fix issues
|
||||||
|
|
@ -3,27 +3,20 @@ title: "How to Run Sprint Planning"
|
||||||
description: How to initialize sprint tracking for implementation
|
description: How to initialize sprint tracking for implementation
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
|
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Once at the start of Phase 4 (Implementation)
|
- Once at the start of Phase 4 (Implementation)
|
||||||
- After implementation-readiness gate passes
|
- After implementation-readiness gate passes
|
||||||
- When starting a new sprint cycle
|
- When starting a new sprint cycle
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- SM (Scrum Master) agent available
|
- SM (Scrum Master) agent available
|
||||||
- Epic files created from `create-epics-and-stories`
|
- Epic files created from `create-epics-and-stories`
|
||||||
- Implementation-readiness passed (for BMad Method/Enterprise)
|
- Implementation-readiness passed (for BMad Method/Enterprise)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -45,8 +38,6 @@ Point the agent to your epic files created during Phase 3.
|
||||||
|
|
||||||
The agent organizes stories into the sprint tracking file.
|
The agent organizes stories into the sprint tracking file.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
A `sprint-status.yaml` file containing:
|
A `sprint-status.yaml` file containing:
|
||||||
|
|
@ -56,12 +47,8 @@ A `sprint-status.yaml` file containing:
|
||||||
- Dependencies between stories
|
- Dependencies between stories
|
||||||
- Priority ordering
|
- Priority ordering
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Story Lifecycle States
|
## Story Lifecycle States
|
||||||
|
|
||||||
Stories move through these states in the sprint status file:
|
|
||||||
|
|
||||||
| State | Description |
|
| State | Description |
|
||||||
|-------|-------------|
|
|-------|-------------|
|
||||||
| **TODO** | Story identified but not started |
|
| **TODO** | Story identified but not started |
|
||||||
|
|
@ -69,43 +56,39 @@ Stories move through these states in the sprint status file:
|
||||||
| **READY FOR REVIEW** | Implementation complete, awaiting code review |
|
| **READY FOR REVIEW** | Implementation complete, awaiting code review |
|
||||||
| **DONE** | Accepted and complete |
|
| **DONE** | Accepted and complete |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Typical Sprint Flow
|
## Typical Sprint Flow
|
||||||
|
|
||||||
### Sprint 0 (Planning Phase)
|
**Sprint 0 (Planning Phase):**
|
||||||
- Complete Phases 1-3
|
- Complete Phases 1-3
|
||||||
- PRD/GDD + Architecture complete
|
- PRD/GDD + Architecture complete
|
||||||
- Epics+Stories created via create-epics-and-stories
|
- Epics+Stories created via create-epics-and-stories
|
||||||
|
|
||||||
### Sprint 1+ (Implementation Phase)
|
**Sprint 1+ (Implementation Phase):**
|
||||||
|
|
||||||
**Start of Phase 4:**
|
Start of Phase 4:
|
||||||
1. SM runs `sprint-planning` (once)
|
1. SM runs `sprint-planning` (once)
|
||||||
|
|
||||||
**Per Story (repeat until epic complete):**
|
Per Story (repeat until epic complete):
|
||||||
1. SM runs `create-story`
|
1. SM runs `create-story`
|
||||||
2. DEV runs `dev-story`
|
2. DEV runs `dev-story`
|
||||||
3. DEV runs `code-review`
|
3. DEV runs `code-review`
|
||||||
4. Update sprint-status.yaml
|
4. Update sprint-status.yaml
|
||||||
|
|
||||||
**After Epic Complete:**
|
After Epic Complete:
|
||||||
- SM runs `retrospective`
|
- SM runs `retrospective`
|
||||||
- Move to next epic
|
- Move to next epic
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run sprint-planning only once at Phase 4 start
|
- **Run sprint-planning only once** — At Phase 4 start
|
||||||
- Use `sprint-status` during Phase 4 to check current state
|
- **Use sprint-status during Phase 4** — Check current state anytime
|
||||||
- Keep the sprint-status.yaml file as single source of truth
|
- **Keep sprint-status.yaml as single source of truth** — All status updates go here
|
||||||
- Update story status after each stage
|
- **Update story status after each stage** — Keep it current
|
||||||
|
|
||||||
---
|
## Next Steps
|
||||||
|
|
||||||
## Related
|
After sprint planning:
|
||||||
|
|
||||||
- [Create Story](./create-story.md) - Prepare stories for implementation
|
1. **Create Story** — Prepare the first story for implementation
|
||||||
- [Implement Story](./implement-story.md) - Dev workflow
|
2. **Implement Story** — Run dev-story with the DEV agent
|
||||||
- [Run Code Review](./run-code-review.md) - Quality assurance
|
3. **Code Review** — Quality assurance after implementation
|
||||||
|
|
@ -0,0 +1,89 @@
|
||||||
|
---
|
||||||
|
title: "How to Set Up Party Mode"
|
||||||
|
description: How to set up and use Party Mode for multi-agent collaboration
|
||||||
|
---
|
||||||
|
|
||||||
|
Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team.
|
||||||
|
|
||||||
|
## When to Use This
|
||||||
|
|
||||||
|
- Exploring complex topics that benefit from diverse expert perspectives
|
||||||
|
- Brainstorming with agents who can build on each other's ideas
|
||||||
|
- Getting comprehensive views across multiple domains
|
||||||
|
- Strategic decisions with trade-offs
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
|
- BMad Method installed with multiple agents
|
||||||
|
- Any agent loaded that supports party mode
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
### 1. Load Any Agent
|
||||||
|
|
||||||
|
Start with any agent that supports party mode (most do).
|
||||||
|
|
||||||
|
### 2. Start Party Mode
|
||||||
|
|
||||||
|
```
|
||||||
|
*party-mode
|
||||||
|
```
|
||||||
|
|
||||||
|
Or use the full path:
|
||||||
|
```
|
||||||
|
/bmad:core:workflows:party-mode
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Introduce Your Topic
|
||||||
|
|
||||||
|
Present a topic or question for the group to discuss:
|
||||||
|
|
||||||
|
```
|
||||||
|
I'm trying to decide between a monolithic architecture
|
||||||
|
and microservices for our new platform.
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Engage with the Discussion
|
||||||
|
|
||||||
|
The facilitator will:
|
||||||
|
- Select 2-3 most relevant agents based on expertise
|
||||||
|
- Let agents respond in character
|
||||||
|
- Enable natural cross-talk and debate
|
||||||
|
- Continue until you choose to exit
|
||||||
|
|
||||||
|
### 5. Exit When Ready
|
||||||
|
|
||||||
|
Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells.
|
||||||
|
|
||||||
|
## What Happens
|
||||||
|
|
||||||
|
1. **Agent Roster** — Party Mode loads your complete agent roster
|
||||||
|
2. **Introduction** — Available team members are introduced
|
||||||
|
3. **Topic Analysis** — The facilitator analyzes your topic
|
||||||
|
4. **Agent Selection** — 2-3 most relevant agents are selected
|
||||||
|
5. **Discussion** — Agents respond, reference each other, engage in cross-talk
|
||||||
|
6. **Exit** — Session concludes with farewells
|
||||||
|
|
||||||
|
## Example Party Compositions
|
||||||
|
|
||||||
|
| Topic | Typical Agents |
|
||||||
|
| ---------------------- | ----------------------------------------------------- |
|
||||||
|
| **Product Strategy** | PM + Innovation Strategist + Analyst |
|
||||||
|
| **Technical Design** | Architect + Creative Problem Solver + Game Architect |
|
||||||
|
| **User Experience** | UX Designer + Design Thinking Coach + Storyteller |
|
||||||
|
| **Quality Assessment** | TEA + DEV + Architect |
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
- **Intelligent agent selection** — Selects based on expertise needed
|
||||||
|
- **Authentic personalities** — Each agent maintains their unique voice
|
||||||
|
- **Natural cross-talk** — Agents reference and build on each other
|
||||||
|
- **Graceful exit** — Personalized farewells
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Be specific about your topic** — Better agent selection
|
||||||
|
- **Let the conversation flow** — Don't over-direct
|
||||||
|
- **Ask follow-up questions** — Go deeper on interesting points
|
||||||
|
- **Take notes on key insights** — Capture valuable perspectives
|
||||||
|
- **Use for strategic decisions** — Not routine tasks
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
---
|
||||||
|
title: "Core Workflows"
|
||||||
|
---
|
||||||
|
|
||||||
|
Domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent.
|
||||||
|
|
||||||
|
## Party Mode
|
||||||
|
|
||||||
|
Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage multiple specialized perspectives simultaneously — each agent maintains their unique personality, expertise, and communication style.
|
||||||
|
|
||||||
|
See [Party Mode](/docs/explanation/features/party-mode.md) for detailed usage.
|
||||||
|
|
||||||
|
## Brainstorming
|
||||||
|
|
||||||
|
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights.
|
||||||
|
|
||||||
|
See [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) for detailed usage.
|
||||||
|
|
||||||
|
## Advanced Elicitation
|
||||||
|
|
||||||
|
Push the LLM to rethink its work through 50+ reasoning methods — the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated.
|
||||||
|
|
||||||
|
See [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) for detailed usage.
|
||||||
|
|
||||||
|
## Workflow Integration
|
||||||
|
|
||||||
|
Core Workflows accept contextual parameters when called from other modules:
|
||||||
|
|
||||||
|
- **Topic focus** — Direct the session toward a specific domain or question
|
||||||
|
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
|
||||||
|
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
|
||||||
|
- **Output goals** — Define what the final output needs to accomplish
|
||||||
|
|
@ -0,0 +1,73 @@
|
||||||
|
---
|
||||||
|
title: "Document Project Workflow"
|
||||||
|
---
|
||||||
|
|
||||||
|
Analyzes and documents brownfield projects for AI-assisted development.
|
||||||
|
|
||||||
|
:::note[Quick Facts]
|
||||||
|
- **Module:** BMM (BMad Method Module)
|
||||||
|
- **Command:** `*document-project`
|
||||||
|
- **Agents:** Analyst, Technical Writer
|
||||||
|
- **Output:** Master index + documentation files in `{output_folder}`
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type.
|
||||||
|
|
||||||
|
## How to Invoke
|
||||||
|
|
||||||
|
```bash
|
||||||
|
*document-project
|
||||||
|
```
|
||||||
|
|
||||||
|
## Scan Levels
|
||||||
|
|
||||||
|
Choose the right depth for your needs:
|
||||||
|
|
||||||
|
### Quick Scan (Default)
|
||||||
|
|
||||||
|
**What it does:** Pattern-based analysis without reading source files
|
||||||
|
|
||||||
|
**Reads:** Config files, package manifests, directory structure, README
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
|
- You need a fast project overview
|
||||||
|
- Initial understanding of project structure
|
||||||
|
- Planning next steps before deeper analysis
|
||||||
|
|
||||||
|
### Deep Scan
|
||||||
|
|
||||||
|
**What it does:** Reads files in critical directories based on project type
|
||||||
|
|
||||||
|
**Reads:** Files in critical paths defined by documentation requirements
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
|
- Creating comprehensive documentation for brownfield PRD
|
||||||
|
- Need detailed analysis of key areas
|
||||||
|
- Want balance between depth and speed
|
||||||
|
|
||||||
|
### Exhaustive Scan
|
||||||
|
|
||||||
|
**What it does:** Reads ALL source files in project
|
||||||
|
|
||||||
|
**Reads:** Every source file (excludes node_modules, dist, build, .git)
|
||||||
|
|
||||||
|
**Use when:**
|
||||||
|
- Complete project analysis needed
|
||||||
|
- Migration planning requires full understanding
|
||||||
|
- Detailed audit of entire codebase
|
||||||
|
|
||||||
|
:::caution[Deep-Dive Mode]
|
||||||
|
Deep-dive mode always uses exhaustive scan — no choice of scan level.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Resumability
|
||||||
|
|
||||||
|
The workflow can be interrupted and resumed without losing progress:
|
||||||
|
|
||||||
|
- **State Tracking** — Progress saved in `project-scan-report.json`
|
||||||
|
- **Auto-Detection** — Workflow detects incomplete runs (<24 hours old)
|
||||||
|
- **Resume Prompt** — Choose to resume or start fresh
|
||||||
|
- **Step-by-Step** — Resume from exact step where interrupted
|
||||||
|
- **Archiving** — Old state files automatically archived
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
title: "Workflows Reference"
|
||||||
|
description: Reference documentation for BMad Method workflows
|
||||||
|
---
|
||||||
|
|
||||||
|
Reference documentation for all BMad Method workflows.
|
||||||
|
|
||||||
|
## Core Workflows
|
||||||
|
|
||||||
|
- [Core Workflows](/docs/reference/workflows/core-workflows.md) — Domain-agnostic workflows available to all modules
|
||||||
|
- [Document Project](/docs/reference/workflows/document-project.md) — Brownfield project documentation
|
||||||
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
---
|
---
|
||||||
title: "Workflow Vendoring, Customization, and Inheritance (Official Support Coming Soon)"
|
title: "Workflow Vendoring, Customization, and Inheritance"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use workflow vendoring and inheritance to share or reutilize workflows across modules.
|
||||||
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
|
||||||
|
|
||||||
|
|
@ -24,7 +23,11 @@ From your modules agent definition, you would implement the menu item as follows
|
||||||
|
|
||||||
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.)
|
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
|
||||||
|
|
||||||
|
:::note[Coming Soon]
|
||||||
|
Official support for workflow inheritance is coming post beta.
|
||||||
|
:::
|
||||||
|
|
||||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
||||||
|
|
||||||
|
|
@ -36,7 +39,11 @@ Some possible examples could be:
|
||||||
- Sprint Planning
|
- Sprint Planning
|
||||||
- Collaborative Brainstorming Sessions
|
- Collaborative Brainstorming Sessions
|
||||||
|
|
||||||
## Workflow Customization (Official Support Coming Post Beta)
|
## Workflow Customization
|
||||||
|
|
||||||
|
:::note[Coming Soon]
|
||||||
|
Official support for workflow customization is 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.
|
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.
|
||||||
|
|
||||||
|
|
@ -2,28 +2,22 @@
|
||||||
title: "BMM Documentation"
|
title: "BMM Documentation"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity.
|
||||||
|
|
||||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
## Getting Started
|
||||||
|
|
||||||
---
|
:::tip[Quick Path]
|
||||||
|
Install → workflow-init → Follow agent guidance
|
||||||
## 🚀 Getting Started
|
:::
|
||||||
|
|
||||||
**New to BMM?** Start here:
|
**New to BMM?** Start here:
|
||||||
|
|
||||||
- **[Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project
|
| Resource | Description |
|
||||||
- Installation and setup
|
|----------|-------------|
|
||||||
- Understanding the four phases
|
| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project |
|
||||||
- Running your first workflows
|
| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points |
|
||||||
- Agent-based development flow
|
|
||||||
|
|
||||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
## Core Concepts
|
||||||
|
|
||||||
### 📊 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).
|
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).
|
||||||
|
|
||||||
|
|
@ -36,26 +30,26 @@ First know there is the full BMad Method Process and then there is a Quick Flow
|
||||||
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
|
- 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
|
- 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
|
- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow
|
||||||
- 3-step process: spec → dev → optional review
|
- 3-step process: spec → dev → optional review
|
||||||
- Perfect for bug fixes and small features
|
- Perfect for bug fixes and small features
|
||||||
- Rapid prototyping with production quality
|
- Rapid prototyping with production quality
|
||||||
- Implementation in minutes, not days
|
- 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)**
|
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/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)**.
|
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
|
||||||
|
|
||||||
## 🤖 Agents and Collaboration
|
## Agents and Collaboration
|
||||||
|
|
||||||
Complete guide to BMM's AI agent team:
|
Complete guide to BMM's AI agent team:
|
||||||
|
|
||||||
- **[Agents Guide](../../explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
|
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
|
||||||
- 12 specialized BMM agents + BMad Master
|
- 12 specialized BMM agents + BMad Master
|
||||||
- Agent roles, workflows, and when to use them
|
- Agent roles, workflows, and when to use them
|
||||||
- Agent customization system
|
- Agent customization system
|
||||||
- Best practices and common patterns
|
- Best practices and common patterns
|
||||||
|
|
||||||
- **[Party Mode Guide](../../explanation/features/party-mode.md)** - Multi-agent collaboration
|
- **[Party Mode Guide](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
||||||
- How party mode works (19+ agents collaborate in real-time)
|
- How party mode works (19+ agents collaborate in real-time)
|
||||||
- When to use it (strategic, creative, cross-functional, complex)
|
- When to use it (strategic, creative, cross-functional, complex)
|
||||||
- Example party compositions
|
- Example party compositions
|
||||||
|
|
@ -63,68 +57,68 @@ Complete guide to BMM's AI agent team:
|
||||||
- Agent customization in party mode
|
- Agent customization in party mode
|
||||||
- Best practices
|
- Best practices
|
||||||
|
|
||||||
## 🔧 Working with Existing Code
|
## Working with Existing Code
|
||||||
|
|
||||||
Comprehensive guide for brownfield development:
|
Comprehensive guide for brownfield development:
|
||||||
|
|
||||||
- **[Brownfield Development Guide](../../how-to/brownfield/index.md)** - Complete guide for existing codebases
|
- **[Brownfield Development Guide](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases
|
||||||
- Documentation phase strategies
|
- Documentation phase strategies
|
||||||
- Track selection for brownfield
|
- Track selection for brownfield
|
||||||
- Integration with existing patterns
|
- Integration with existing patterns
|
||||||
- Phase-by-phase workflow guidance
|
- Phase-by-phase workflow guidance
|
||||||
- Common scenarios
|
- Common scenarios
|
||||||
|
|
||||||
## 📚 Quick References
|
## Quick References
|
||||||
|
|
||||||
Essential reference materials:
|
Essential reference materials:
|
||||||
|
|
||||||
- **[Glossary](../../reference/glossary/index.md)** - Key terminology and concepts
|
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
|
||||||
- **[FAQ](../faq/index.md)** - Frequently asked questions across all topics
|
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
|
||||||
|
|
||||||
## 🎯 Choose Your Path
|
## Choose Your Path
|
||||||
|
|
||||||
### I need to...
|
### I need to...
|
||||||
|
|
||||||
**Build something new (greenfield)**
|
**Build something new (greenfield)**
|
||||||
→ Start with [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
|
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
||||||
|
|
||||||
**Fix a bug or add small feature**
|
**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
|
→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process
|
||||||
|
|
||||||
**Work with existing codebase (brownfield)**
|
**Work with existing codebase (brownfield)**
|
||||||
→ Read [Brownfield Development Guide](../../how-to/brownfield/index.md)
|
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
||||||
→ Pay special attention to documentation requirements for brownfield projects
|
→ Pay special attention to documentation requirements for brownfield projects
|
||||||
|
|
||||||
## 📋 Workflow Guides
|
## Workflow Guides
|
||||||
|
|
||||||
Comprehensive documentation for all BMM workflows organized by phase:
|
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)
|
- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
|
||||||
- brainstorm-project, product-brief, research, and more
|
- brainstorm-project, product-brief, research, and more
|
||||||
- When to use analysis workflows
|
- When to use analysis workflows
|
||||||
- Creative and strategic tools
|
- Creative and strategic tools
|
||||||
|
|
||||||
- **[Phase 2: Planning Workflows](../../how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
|
- **[Phase 2: Planning Workflows](/docs/how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
|
||||||
- prd, tech-spec, gdd, narrative, ux
|
- prd, tech-spec, gdd, narrative, ux
|
||||||
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
||||||
- Which planning workflow to use
|
- Which planning workflow to use
|
||||||
|
|
||||||
- **[Phase 3: Solutioning Workflows](../../how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
|
- **[Phase 3: Solutioning Workflows](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
|
||||||
- architecture, create-epics-and-stories, implementation-readiness
|
- architecture, create-epics-and-stories, implementation-readiness
|
||||||
- V6: Epics created AFTER architecture for better quality
|
- V6: Epics created AFTER architecture for better quality
|
||||||
- Required for BMad Method and Enterprise Method tracks
|
- Required for BMad Method and Enterprise Method tracks
|
||||||
- Preventing agent conflicts
|
- Preventing agent conflicts
|
||||||
|
|
||||||
- **[Phase 4: Implementation Workflows](../../how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
|
- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
|
||||||
- sprint-planning, create-story, dev-story, code-review
|
- sprint-planning, create-story, dev-story, code-review
|
||||||
- Complete story lifecycle
|
- Complete story lifecycle
|
||||||
- One-story-at-a-time discipline
|
- One-story-at-a-time discipline
|
||||||
|
|
||||||
- **[Testing & QA Workflows](../../explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
|
- **[Testing & QA Workflows](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
|
||||||
- Test strategy, automation, quality gates
|
- Test strategy, automation, quality gates
|
||||||
- TEA agent and test healing
|
- TEA agent and test healing
|
||||||
|
|
||||||
## 🌐 External Resources
|
## External Resources
|
||||||
|
|
||||||
### Community and Support
|
### Community and Support
|
||||||
|
|
||||||
|
|
@ -132,4 +126,6 @@ Comprehensive documentation for all BMM workflows organized by phase:
|
||||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
- **[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
|
- **[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)
|
:::tip[Ready to Begin?]
|
||||||
|
[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
||||||
|
:::
|
||||||
|
|
@ -3,11 +3,8 @@ title: "Agent Roles in BMad Method"
|
||||||
description: Understanding the different 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.
|
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
|
## Core Agents Overview
|
||||||
|
|
||||||
| Agent | Role | Primary Phase |
|
| Agent | Role | Primary Phase |
|
||||||
|
|
@ -21,8 +18,6 @@ BMad Method uses specialized AI agents, each with a distinct role, expertise, an
|
||||||
| **UX Designer** | User experience | Phase 2-3 |
|
| **UX Designer** | User experience | Phase 2-3 |
|
||||||
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis
|
## Phase 1: Analysis
|
||||||
|
|
||||||
### Analyst (Mary)
|
### Analyst (Mary)
|
||||||
|
|
@ -43,8 +38,6 @@ Business analysis and research specialist.
|
||||||
|
|
||||||
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning
|
## Phase 2: Planning
|
||||||
|
|
||||||
### PM (John)
|
### PM (John)
|
||||||
|
|
@ -80,8 +73,6 @@ User experience and UI design specialist.
|
||||||
|
|
||||||
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning
|
## Phase 3: Solutioning
|
||||||
|
|
||||||
### Architect (Winston)
|
### Architect (Winston)
|
||||||
|
|
@ -100,8 +91,6 @@ System architecture and technical design expert.
|
||||||
|
|
||||||
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation
|
## Phase 4: Implementation
|
||||||
|
|
||||||
### SM (Bob)
|
### SM (Bob)
|
||||||
|
|
@ -138,8 +127,6 @@ Story implementation and code review specialist.
|
||||||
|
|
||||||
**When to use:** Writing code, implementing stories, reviewing quality.
|
**When to use:** Writing code, implementing stories, reviewing quality.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Cross-Phase Agents
|
## Cross-Phase Agents
|
||||||
|
|
||||||
### TEA (Murat)
|
### TEA (Murat)
|
||||||
|
|
@ -159,8 +146,6 @@ Test architecture and quality strategy expert.
|
||||||
|
|
||||||
**When to use:** Setting up testing, creating test plans, quality gates.
|
**When to use:** Setting up testing, creating test plans, quality gates.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Flow
|
## Quick Flow
|
||||||
|
|
||||||
### Quick Flow Solo Dev (Barry)
|
### Quick Flow Solo Dev (Barry)
|
||||||
|
|
@ -173,14 +158,12 @@ Fast solo development without handoffs.
|
||||||
- Code review
|
- Code review
|
||||||
|
|
||||||
**Key Workflows:**
|
**Key Workflows:**
|
||||||
- `*create-tech-spec`
|
- `*quick-spec`
|
||||||
- `*quick-dev`
|
- `*quick-dev`
|
||||||
- `*code-review`
|
- `*code-review`
|
||||||
|
|
||||||
**When to use:** Bug fixes, small features, rapid prototyping.
|
**When to use:** Bug fixes, small features, rapid prototyping.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choosing the Right Agent
|
## Choosing the Right Agent
|
||||||
|
|
||||||
| Task | Agent |
|
| Task | Agent |
|
||||||
|
|
@ -194,11 +177,3 @@ Fast solo development without handoffs.
|
||||||
| Writing code | DEV |
|
| Writing code | DEV |
|
||||||
| Setting up tests | TEA |
|
| Setting up tests | TEA |
|
||||||
| Quick bug fix | Quick Flow Solo Dev |
|
| 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)
|
|
||||||
|
|
@ -2,7 +2,6 @@
|
||||||
title: "Modules"
|
title: "Modules"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
||||||
|
|
||||||
## What is a Module?
|
## What is a Module?
|
||||||
|
|
@ -14,7 +13,11 @@ A module is a self-contained package that includes:
|
||||||
- **Configuration** - Module-specific settings
|
- **Configuration** - Module-specific settings
|
||||||
- **Documentation** - Usage guides and reference
|
- **Documentation** - Usage guides and reference
|
||||||
|
|
||||||
## Official Modules
|
## Official BMad Method and Builder Modules
|
||||||
|
|
||||||
|
:::note[Core is Always Installed]
|
||||||
|
The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon.
|
||||||
|
:::
|
||||||
|
|
||||||
### Core Module
|
### Core Module
|
||||||
Always installed, provides shared functionality:
|
Always installed, provides shared functionality:
|
||||||
|
|
@ -22,29 +25,36 @@ Always installed, provides shared functionality:
|
||||||
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
||||||
- Common tasks (document indexing, sharding, review)
|
- Common tasks (document indexing, sharding, review)
|
||||||
|
|
||||||
### BMAD Method (BMM)
|
### BMad Method (BMM)
|
||||||
Software and game development:
|
Software and game development:
|
||||||
- Project planning workflows
|
- Project planning workflows
|
||||||
- Implementation agents (Dev, PM, QA, Scrum Master)
|
- Implementation agents (Dev, PM, QA, Scrum Master)
|
||||||
- Testing and architecture guidance
|
- Testing and architecture guidance
|
||||||
|
|
||||||
### BMAD Builder (BMB)
|
### BMad Builder (BMB)
|
||||||
Create custom solutions:
|
Create custom solutions:
|
||||||
- Agent creation workflows
|
- Agent creation workflows
|
||||||
- Workflow authoring tools
|
- Workflow authoring tools
|
||||||
- Module scaffolding
|
- Module scaffolding
|
||||||
|
|
||||||
|
## Additional Official BMad Modules
|
||||||
|
|
||||||
|
These are officially maintained modules by BMad but have their own repo's and docs.
|
||||||
|
These give a good idea also of what can be done with the BMad builder and creating your own custom modules.
|
||||||
|
|
||||||
### Creative Intelligence Suite (CIS)
|
### Creative Intelligence Suite (CIS)
|
||||||
Innovation and creativity:
|
Innovation and creativity:
|
||||||
- Creative thinking techniques
|
- Creative thinking techniques
|
||||||
- Innovation strategy workflows
|
- Innovation strategy workflows
|
||||||
- Storytelling and ideation
|
- Storytelling and ideation
|
||||||
|
- [Available Here](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||||
|
|
||||||
### BMAD Game Dev (BMGD)
|
### BMad Game Dev (BMGD)
|
||||||
Game development specialization:
|
Game development specialization:
|
||||||
- Game design workflows
|
- Game design workflows
|
||||||
- Narrative development
|
- Narrative development
|
||||||
- Performance testing frameworks
|
- Performance testing frameworks
|
||||||
|
- [Available Here](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||||
|
|
||||||
## Module Structure
|
## Module Structure
|
||||||
|
|
||||||
|
|
@ -53,8 +63,8 @@ Installed modules follow this structure:
|
||||||
```
|
```
|
||||||
_bmad/
|
_bmad/
|
||||||
├── core/ # Always present
|
├── core/ # Always present
|
||||||
├── bmm/ # BMAD Method (if installed)
|
├── bmm/ # BMad Method (if installed)
|
||||||
├── bmb/ # BMAD Builder (if installed)
|
├── bmb/ # BMad Builder (if installed)
|
||||||
├── cis/ # Creative Intelligence (if installed)
|
├── cis/ # Creative Intelligence (if installed)
|
||||||
└── bmgd/ # Game Dev (if installed)
|
└── bmgd/ # Game Dev (if installed)
|
||||||
```
|
```
|
||||||
|
|
@ -70,10 +80,6 @@ Custom modules are installed the same way as official modules.
|
||||||
|
|
||||||
## Installing 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.
|
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.
|
See [Installation Guide](/docs/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.
|
|
||||||
|
|
@ -2,13 +2,10 @@
|
||||||
title: "Workflows"
|
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.
|
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.
|
This guide explains what workflows are, why they're powerful, and how to think about designing them.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Is a Workflow?
|
## 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.
|
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.
|
||||||
|
|
@ -71,9 +68,9 @@ When workflows involve users, they should be **facilitative, not directive**. Th
|
||||||
|
|
||||||
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.
|
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.
|
:::caution[When to Be Prescriptive]
|
||||||
|
Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## Why Workflows Matter
|
## Why Workflows Matter
|
||||||
|
|
||||||
|
|
@ -85,8 +82,6 @@ Workflows solve three fundamental problems with AI interactions:
|
||||||
|
|
||||||
**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.
|
**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
|
## How Workflows Work
|
||||||
|
|
||||||
### The Basic Structure
|
### The Basic Structure
|
||||||
|
|
@ -138,20 +133,18 @@ Each workflow checks for required inputs from prior workflows, validates they're
|
||||||
|
|
||||||
### The Tri-Modal Pattern
|
### 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.
|
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.
|
**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.
|
**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.
|
**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.
|
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.
|
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
|
## Design Decisions
|
||||||
|
|
||||||
Before building a workflow, answer these questions:
|
Before building a workflow, answer these questions:
|
||||||
|
|
@ -166,13 +159,11 @@ Before building a workflow, answer these questions:
|
||||||
|
|
||||||
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning from Examples
|
## Learning from Examples
|
||||||
|
|
||||||
The best way to understand workflows is to study real examples. Look at the official BMAD modules:
|
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
|
- **BMB (Module Builder)**: Module, Workflow and Agent creation workflows
|
||||||
- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
|
- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
|
||||||
- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture
|
- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture
|
||||||
- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy
|
- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy
|
||||||
|
|
@ -181,8 +172,6 @@ Study the workflow.md files to understand how each workflow starts. Examine step
|
||||||
|
|
||||||
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.
|
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
|
## When to Use Workflows
|
||||||
|
|
||||||
Use workflows when:
|
Use workflows when:
|
||||||
|
|
@ -206,8 +195,6 @@ Modified BMad Workflows
|
||||||
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
|
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.
|
a short single file workflow.md file.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Bottom Line
|
## 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.
|
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.
|
||||||
|
|
@ -0,0 +1,333 @@
|
||||||
|
---
|
||||||
|
title: "Facilitation Over Generation"
|
||||||
|
description: Understanding a facilitation-first approach to AI workflows and creative collaboration
|
||||||
|
---
|
||||||
|
|
||||||
|
BMAD workflows take a fundamentally different approach from typical AI Prompts you will find. Instead of generating solutions directly, workflows act as facilitators who guide you through discovery processes, helping you arrive at insights and decisions yourself.
|
||||||
|
|
||||||
|
This has always been the magic of the BMad method - if you have used it you have felt it intuitively and noticed a difference - and it is through this document I want to really explain what this is. This is fundamental to understand if you are also interested in producing your own workflows or improving upon existing ones in any BMad related module.
|
||||||
|
|
||||||
|
## The Problem with Generation
|
||||||
|
|
||||||
|
Traditional AI approaches to creative and knowledge work typically follow this pattern:
|
||||||
|
|
||||||
|
:::note[Generation Example]
|
||||||
|
**User:** "I need a comprehensive UX design for my e-commerce app"
|
||||||
|
|
||||||
|
**AI:** [Immediately generates] "Here's a complete UX specification with modern dark theme, card-based product grid, left navigation, and checkout flow..."
|
||||||
|
:::
|
||||||
|
|
||||||
|
This approach:
|
||||||
|
- Produces generic, predictable outputs that may not fit your actual needs
|
||||||
|
- Removes your ownership and understanding of the solution
|
||||||
|
- Misses critical context, constraints, and nuance
|
||||||
|
- Limits creative exploration to the AI's training data patterns
|
||||||
|
- Creates deliverables you can't explain or iterate on effectively
|
||||||
|
|
||||||
|
## The Facilitation Approach
|
||||||
|
|
||||||
|
Facilitative workflows use strategic questioning and guided discovery:
|
||||||
|
|
||||||
|
:::note[Facilitation Example from UX Design Workflow]
|
||||||
|
**User:** "I need a comprehensive UX design for my e-commerce app"
|
||||||
|
|
||||||
|
**Workflow:** "Welcome! I'll act as your UX facilitator to help you discover the right approach. First, let me understand what documents you already have—do you have a product brief, PRD, or any research?"
|
||||||
|
|
||||||
|
**User:** "I have a product brief and some user research"
|
||||||
|
|
||||||
|
**Workflow:** "Great! Let me load those. [Loads documents] Now, what are the primary user goals for your e-commerce experience? What should users be able to accomplish?"
|
||||||
|
|
||||||
|
**User:** "They need to browse products quickly and complete purchases without friction"
|
||||||
|
|
||||||
|
**Workflow:** "Interesting! And what makes your e-commerce situation unique? What are the specific challenges or constraints you're working with?"
|
||||||
|
:::
|
||||||
|
|
||||||
|
This approach:
|
||||||
|
- Draws out insights and expertise already within you
|
||||||
|
- Maintains your ownership and understanding of decisions
|
||||||
|
- Captures your specific context, constraints, and goals
|
||||||
|
- Enables deeper exploration of your unique situation
|
||||||
|
- Creates outputs you can confidently explain and iterate on
|
||||||
|
|
||||||
|
## Real-World Examples from BMAD Workflows
|
||||||
|
|
||||||
|
### Brainstorming Workflow (from core module)
|
||||||
|
|
||||||
|
The brainstorming workflow demonstrates pure facilitation through its entire journey:
|
||||||
|
|
||||||
|
**Session Setup:**
|
||||||
|
```
|
||||||
|
"Welcome! I'm excited to facilitate your brainstorming session. I'll guide you
|
||||||
|
through proven creativity techniques to generate innovative ideas.
|
||||||
|
|
||||||
|
**What are we brainstorming about?** (The central topic or challenge)
|
||||||
|
**What specific outcomes are you hoping for?** (Types of ideas, solutions, or insights)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Technique Selection - Offering Options:**
|
||||||
|
```
|
||||||
|
"Ready to explore technique approaches?
|
||||||
|
[1] User-Selected Techniques - Browse our complete technique library
|
||||||
|
[2] AI-Recommended Techniques - Get customized suggestions based on your goals
|
||||||
|
[3] Random Technique Selection - Discover unexpected creative methods
|
||||||
|
[4] Progressive Technique Flow - Start broad, then systematically narrow focus
|
||||||
|
|
||||||
|
Which approach appeals to you most?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Technique Execution - Interactive Coaching:**
|
||||||
|
The workflow doesn't generate ideas—it coaches you through techniques with genuine back-and-forth dialogue:
|
||||||
|
|
||||||
|
```
|
||||||
|
"Let's start with: What if you could remove all practical constraints?
|
||||||
|
|
||||||
|
I'm not just looking for a quick answer - I want to explore this together.
|
||||||
|
What immediately comes to mind? Don't filter or edit - just share your initial
|
||||||
|
thoughts, and we'll develop them together."
|
||||||
|
|
||||||
|
[User responds]
|
||||||
|
|
||||||
|
"That's interesting! Tell me more about [specific aspect you mentioned].
|
||||||
|
What would that look like in practice? How does that connect to your core goal?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Key facilitation behaviors:**
|
||||||
|
- Aims for 100+ ideas before suggesting organization
|
||||||
|
- Asks "Continue exploring?" or "Move to next technique?"—user controls pace
|
||||||
|
- Uses anti-bias protocols to force thinking in new directions every 10 ideas
|
||||||
|
- Builds on user's ideas with genuine creative contributions
|
||||||
|
- Keeps user in "generative exploration mode" as long as possible
|
||||||
|
|
||||||
|
**Organization - Collaborative Synthesis:**
|
||||||
|
```
|
||||||
|
"Outstanding creative work! You've generated an incredible range of ideas.
|
||||||
|
Now let's organize these creative gems and identify your most promising opportunities.
|
||||||
|
|
||||||
|
I'm analyzing all your generated ideas to identify natural themes and patterns.
|
||||||
|
**Emerging Themes I'm Identifying:**
|
||||||
|
- Theme 1: [Name] - Ideas: [list] - Pattern: [connection]
|
||||||
|
- Theme 2: [Name] - Ideas: [list] - Pattern: [connection]
|
||||||
|
|
||||||
|
Which themes or specific ideas stand out to you as most valuable?"
|
||||||
|
```
|
||||||
|
|
||||||
|
Result: A comprehensive brainstorming session document with **your** ideas, organized by **your** priorities, with **your** action plans.
|
||||||
|
|
||||||
|
### Create UX Design Workflow (from BMM method)
|
||||||
|
|
||||||
|
The UX design workflow facilitates a 14-step journey from project understanding to complete UX specification—**never making design decisions for you**.
|
||||||
|
|
||||||
|
**Step 1: Document Discovery (Collaborative Setup)**
|
||||||
|
```
|
||||||
|
"Welcome! I've set up your UX design workspace.
|
||||||
|
|
||||||
|
**Documents Found:**
|
||||||
|
- PRD: product-requirements.md
|
||||||
|
- Product brief: brief.md
|
||||||
|
|
||||||
|
**Files loaded:** [lists specific files]
|
||||||
|
|
||||||
|
Do you have any other documents you'd like me to include, or shall we continue?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 2: Project Understanding (Discovery Questions)**
|
||||||
|
```
|
||||||
|
"Based on the project documentation, let me confirm what I'm understanding...
|
||||||
|
|
||||||
|
**From the documents:** [summary of key insights]
|
||||||
|
**Target Users:** [summary from documents]
|
||||||
|
**Key Features/Goals:** [summary from documents]
|
||||||
|
|
||||||
|
Does this match your understanding? Are there any corrections or additions?"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then it dives deeper with targeted questions:
|
||||||
|
```
|
||||||
|
"Let me understand your users better to inform the UX design:
|
||||||
|
|
||||||
|
**User Context Questions:**
|
||||||
|
- What problem are users trying to solve?
|
||||||
|
- What frustrates them with current solutions?
|
||||||
|
- What would make them say 'this is exactly what I needed'?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 3: Core Experience Definition (Guiding Insights)**
|
||||||
|
```
|
||||||
|
"Now let's dig into the heart of the user experience.
|
||||||
|
|
||||||
|
**Core Experience Questions:**
|
||||||
|
- What's the ONE thing users will do most frequently?
|
||||||
|
- What user action is absolutely critical to get right?
|
||||||
|
- What should be completely effortless for users?
|
||||||
|
- If we nail one interaction, everything else follows - what is it?
|
||||||
|
|
||||||
|
Think about the core loop or primary action that defines your product's value."
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 4: Emotional Response (Feelings-Based Design)**
|
||||||
|
```
|
||||||
|
"Now let's think about how your product should make users feel.
|
||||||
|
|
||||||
|
**Emotional Response Questions:**
|
||||||
|
- What should users FEEL when using this product?
|
||||||
|
- What emotion would make them tell a friend about this?
|
||||||
|
- How should users feel after accomplishing their primary goal?
|
||||||
|
|
||||||
|
Common emotional goals: Empowered and in control? Delighted and surprised?
|
||||||
|
Efficient and productive? Creative and inspired?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 5: Pattern Inspiration (Learning from Examples)**
|
||||||
|
```
|
||||||
|
"Let's learn from products your users already love and use regularly.
|
||||||
|
|
||||||
|
**Inspiration Questions:**
|
||||||
|
- Name 2-3 apps your target users already love and USE frequently
|
||||||
|
- For each one, what do they do well from a UX perspective?
|
||||||
|
- What makes the experience compelling or delightful?
|
||||||
|
|
||||||
|
For each inspiring app, let's analyze their UX success:
|
||||||
|
- What core problem does it solve elegantly?
|
||||||
|
- What makes the onboarding experience effective?
|
||||||
|
- How do they handle navigation and information hierarchy?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 9: Design Directions (Interactive Visual Exploration)**
|
||||||
|
The workflow generates 6-8 HTML mockup variations—but **you choose**:
|
||||||
|
|
||||||
|
```
|
||||||
|
"🎨 Design Direction Mockups Generated!
|
||||||
|
|
||||||
|
I'm creating a comprehensive HTML showcase with 6-8 full-screen mockup variations.
|
||||||
|
Each mockup represents a complete visual direction for your app's look and feel.
|
||||||
|
|
||||||
|
**As you explore the design directions, look for:**
|
||||||
|
✅ Which information hierarchy matches your priorities?
|
||||||
|
✅ Which interaction style fits your core experience?
|
||||||
|
✅ Which visual density feels right for your brand?
|
||||||
|
|
||||||
|
**Which approach resonates most with you?**
|
||||||
|
- Pick a favorite direction as-is
|
||||||
|
- Combine elements from multiple directions
|
||||||
|
- Request modifications to any direction
|
||||||
|
|
||||||
|
Tell me: Which layout feels most intuitive? Which visual weight matches your brand?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 12: UX Patterns (Consistency Through Questions)**
|
||||||
|
```
|
||||||
|
"Let's establish consistency patterns for common situations.
|
||||||
|
|
||||||
|
**Pattern Categories to Define:**
|
||||||
|
- Button hierarchy and actions
|
||||||
|
- Feedback patterns (success, error, warning, info)
|
||||||
|
- Form patterns and validation
|
||||||
|
- Navigation patterns
|
||||||
|
|
||||||
|
Which categories are most critical for your product?
|
||||||
|
|
||||||
|
**For [Critical Pattern Category]:**
|
||||||
|
What should users see/do when they need to [pattern action]?
|
||||||
|
|
||||||
|
**Considerations:**
|
||||||
|
- Visual hierarchy (primary vs. secondary actions)
|
||||||
|
- Feedback mechanisms
|
||||||
|
- Error recovery
|
||||||
|
- Accessibility requirements
|
||||||
|
|
||||||
|
How should your product handle [pattern type] interactions?"
|
||||||
|
```
|
||||||
|
|
||||||
|
**The Result:** A complete, production-ready UX specification document that captures **your** decisions, **your** reasoning, and **your** vision—documented through guided discovery, not generation.
|
||||||
|
|
||||||
|
## Key Principles
|
||||||
|
|
||||||
|
### 1. Questions Over Answers
|
||||||
|
|
||||||
|
Facilitative workflows ask strategic questions rather than providing direct answers. This:
|
||||||
|
- Activates your own creative and analytical thinking
|
||||||
|
- Uncovers assumptions you didn't know you had
|
||||||
|
- Reveals blind spots in your understanding
|
||||||
|
- Builds on your domain expertise and context
|
||||||
|
|
||||||
|
### 2. Multi-Turn Conversation
|
||||||
|
|
||||||
|
Facilitation uses progressive discovery, not interrogation:
|
||||||
|
- Ask 1-2 questions at a time, not laundry lists
|
||||||
|
- Think about responses before asking follow-ups
|
||||||
|
- Probe to understand deeper, not just collect facts
|
||||||
|
- Use conversation to explore, not just extract
|
||||||
|
|
||||||
|
### 3. Intent-Based Guidance
|
||||||
|
|
||||||
|
Workflows specify goals and approaches, not exact scripts:
|
||||||
|
- "Guide the user through discovering X" (intent)
|
||||||
|
- NOT "Say exactly: 'What is X?'" (prescriptive)
|
||||||
|
|
||||||
|
This allows the workflow to adapt naturally to your responses while maintaining structured progress.
|
||||||
|
|
||||||
|
### 4. Process Trust
|
||||||
|
|
||||||
|
Facilitative workflows use proven methodologies:
|
||||||
|
- Design Thinking's phases (Empathize, Define, Ideate, Prototype, Test)
|
||||||
|
- Structured brainstorming and creativity techniques
|
||||||
|
- Root cause analysis frameworks
|
||||||
|
- Innovation strategy patterns
|
||||||
|
|
||||||
|
You're not just having a conversation—you're following time-tested processes adapted to your specific situation.
|
||||||
|
|
||||||
|
### 5. YOU Are the Expert
|
||||||
|
|
||||||
|
Facilitative workflows operate on a core principle: **you are the expert on your situation**. The workflow brings:
|
||||||
|
- Process expertise (how to think through problems)
|
||||||
|
- Facilitation skills (how to guide exploration)
|
||||||
|
- Technique knowledge (proven methods and frameworks)
|
||||||
|
|
||||||
|
You bring:
|
||||||
|
- Domain knowledge (your specific field or industry)
|
||||||
|
- Context understanding (your unique situation and constraints)
|
||||||
|
- Decision authority (what will actually work for you)
|
||||||
|
|
||||||
|
## When Generation is Appropriate
|
||||||
|
|
||||||
|
Facilitative workflows DO generate when appropriate:
|
||||||
|
- Synthesizing and structuring outputs after you've made decisions
|
||||||
|
- Documenting your choices and rationale
|
||||||
|
- Creating structured artifacts based on your input
|
||||||
|
- Providing technique examples or option templates
|
||||||
|
- Formatting and organizing your conclusions
|
||||||
|
|
||||||
|
But the **core creative and analytical work** happens through facilitated discovery, not generation.
|
||||||
|
|
||||||
|
## The Distinction: Facilitator vs Generator
|
||||||
|
|
||||||
|
| Facilitative Workflow | Generative AI |
|
||||||
|
| ------------------------------------- | --------------------------------------- |
|
||||||
|
| "What are your goals?" | "Here's the solution" |
|
||||||
|
| Asks 1-2 questions at a time | Produces complete output immediately |
|
||||||
|
| Multiple turns, progressive discovery | Single turn, bulk generation |
|
||||||
|
| "Let me understand your context" | "Here's a generic answer" |
|
||||||
|
| Offers options, you choose | Makes decisions for you |
|
||||||
|
| Documents YOUR reasoning | No reasoning visible |
|
||||||
|
| You can explain every decision | You can't explain why choices were made |
|
||||||
|
| Ownership and understanding | Outputs feel alien |
|
||||||
|
|
||||||
|
## Benefits
|
||||||
|
|
||||||
|
### For Individuals
|
||||||
|
- **Deeper insights** than pure generation—ideas connect to your actual knowledge
|
||||||
|
- **Full ownership** of creative outputs and decisions
|
||||||
|
- **Skill development** in structured thinking and problem-solving
|
||||||
|
- **More memorable and actionable** results—you understand the "why"
|
||||||
|
|
||||||
|
### For Teams
|
||||||
|
- **Shared creative experience** building alignment and trust
|
||||||
|
- **Aligned understanding** through documented exploration
|
||||||
|
- **Documented rationale** for future reference and onboarding
|
||||||
|
- **Stronger buy-in** to outcomes because everyone participated in discovery
|
||||||
|
|
||||||
|
### For Implementation
|
||||||
|
- **Outputs match reality** because they emerged from your actual constraints
|
||||||
|
- **Easier iteration** because you understand the reasoning behind choices
|
||||||
|
- **Confident implementation** because you can defend every decision
|
||||||
|
- **Reduced rework** because facilitation catches issues early
|
||||||
|
|
@ -0,0 +1,73 @@
|
||||||
|
---
|
||||||
|
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
|
||||||
|
|
||||||
|
- [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)
|
||||||
|
- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs)
|
||||||
|
- [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
|
||||||
|
- Level 2-4 complexity
|
||||||
|
|
||||||
|
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`.
|
||||||
|
|
||||||
|
### What if I forget to run document-project?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
### How does workflow-init handle old planning docs?
|
||||||
|
|
||||||
|
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 a new Level 0 bug fix.
|
||||||
|
|
||||||
|
### 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!
|
||||||
|
|
@ -0,0 +1,67 @@
|
||||||
|
---
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
- [Why does BMad use so many tokens?](#why-does-bmad-use-so-many-tokens)
|
||||||
|
- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init)
|
||||||
|
- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow)
|
||||||
|
- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working)
|
||||||
|
- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started)
|
||||||
|
- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4)
|
||||||
|
|
||||||
|
### Why does BMad use so many tokens?
|
||||||
|
|
||||||
|
BMad is not always the most token efficient approach, and that's by design. The checkpoints, story files, and retrospectives keep you in the loop so you can apply taste, judgment, and accumulated context that no agent has. Fully automated coding loops optimize for code velocity; BMad optimizes for decision quality. If you're building something you'll maintain for years, where user experience matters, where architectural choices compound—that tradeoff pays for itself.
|
||||||
|
|
||||||
|
### Do I always need to run workflow-init?
|
||||||
|
|
||||||
|
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](/docs/tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow.
|
||||||
|
|
||||||
|
### Why do I need fresh chats for each workflow?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I skip workflow-status and just start working?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### What's the minimum I need to get started?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### How do I know if I'm in Phase 1, 2, 3, or 4?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
**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!
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
---
|
||||||
|
title: "Implementation FAQ"
|
||||||
|
description: Common questions about implementation in the BMad Method
|
||||||
|
---
|
||||||
|
|
||||||
|
Quick answers to common questions about implementation in the BMad Method.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
- [Does create-story include implementation context?](#does-create-story-include-implementation-context)
|
||||||
|
- [How do I mark a story as done?](#how-do-i-mark-a-story-as-done)
|
||||||
|
- [Can I work on multiple stories at once?](#can-i-work-on-multiple-stories-at-once)
|
||||||
|
- [What if my story takes longer than estimated?](#what-if-my-story-takes-longer-than-estimated)
|
||||||
|
- [When should I run retrospective?](#when-should-i-run-retrospective)
|
||||||
|
|
||||||
|
### Does create-story include implementation context?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### How do I mark a story as done?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### Can I work on multiple stories at once?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What if my story takes longer than estimated?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### When should I run retrospective?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
**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!
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
---
|
||||||
|
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](/docs/explanation/faq/getting-started-faq.md) - Questions about starting with BMad
|
||||||
|
- [Levels & Tracks](/docs/explanation/faq/levels-and-tracks-faq.md) - Choosing the right level
|
||||||
|
- [Workflows](/docs/explanation/faq/workflows-faq.md) - Workflow and phase questions
|
||||||
|
- [Planning](/docs/explanation/faq/planning-faq.md) - Planning document questions
|
||||||
|
- [Implementation](/docs/explanation/faq/implementation-faq.md) - Implementation questions
|
||||||
|
- [Brownfield](/docs/explanation/faq/brownfield-faq.md) - Existing codebase questions
|
||||||
|
- [Tools & Advanced](/docs/explanation/faq/tools-faq.md) - Tools, IDEs, and advanced topics
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
---
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
- [How do I know which level my project is?](#how-do-i-know-which-level-my-project-is)
|
||||||
|
- [Can I change levels mid-project?](#can-i-change-levels-mid-project)
|
||||||
|
- [What if workflow-init suggests the wrong level?](#what-if-workflow-init-suggests-the-wrong-level)
|
||||||
|
- [Do I always need architecture for Level 2?](#do-i-always-need-architecture-for-level-2)
|
||||||
|
- [What's the difference between Level 1 and Level 2?](#whats-the-difference-between-level-1-and-level-2)
|
||||||
|
|
||||||
|
### How do I know which level my project is?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I change levels mid-project?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What if workflow-init suggests the wrong level?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Do I always need architecture for Level 2?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What's the difference between Level 1 and Level 2?
|
||||||
|
|
||||||
|
- **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
|
||||||
|
|
||||||
|
**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!
|
||||||
|
|
@ -3,22 +3,25 @@ title: "Planning Documents FAQ"
|
||||||
description: Common questions about planning documents in the BMad Method
|
description: Common questions about planning documents in the BMad Method
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Quick answers to common questions about planning documents in the BMad Method.
|
Quick answers to common questions about planning documents in the BMad Method.
|
||||||
|
|
||||||
---
|
## Questions
|
||||||
|
|
||||||
## Q: Why no tech-spec at Level 2+?
|
- [Why no tech-spec at Level 2+?](#why-no-tech-spec-at-level-2)
|
||||||
|
- [Do I need a PRD for a bug fix?](#do-i-need-a-prd-for-a-bug-fix)
|
||||||
|
- [Can I skip the product brief?](#can-i-skip-the-product-brief)
|
||||||
|
|
||||||
**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:
|
### Why no tech-spec at Level 2+?
|
||||||
|
|
||||||
|
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)
|
- PRD (product vision, functional requirements, non-functional requirements)
|
||||||
- Architecture (system design)
|
- Architecture (system design)
|
||||||
- Epics+Stories (created AFTER architecture is complete)
|
- Epics+Stories (created AFTER architecture is complete)
|
||||||
|
|
||||||
## Q: Do I need a PRD for a bug fix?
|
### Do I need a PRD for a bug fix?
|
||||||
|
|
||||||
**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
|
No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
|
||||||
|
|
||||||
- Load PM agent
|
- Load PM agent
|
||||||
- Run tech-spec workflow
|
- Run tech-spec workflow
|
||||||
|
|
@ -26,22 +29,13 @@ Quick answers to common questions about planning documents in the BMad Method.
|
||||||
|
|
||||||
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
|
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
|
||||||
|
|
||||||
## Q: Can I skip the product brief?
|
### Can I skip the product brief?
|
||||||
|
|
||||||
**A:** Yes, product brief is always optional. It's most valuable for:
|
Yes, product brief is always optional. It's most valuable for:
|
||||||
|
|
||||||
- Level 3-4 projects needing strategic direction
|
- Level 3-4 projects needing strategic direction
|
||||||
- Projects with stakeholders requiring alignment
|
- Projects with stakeholders requiring alignment
|
||||||
- Novel products needing market research
|
- Novel products needing market research
|
||||||
- When you want to explore solution space before committing
|
- 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!
|
**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!
|
||||||
|
|
@ -0,0 +1,277 @@
|
||||||
|
---
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
**Tools and Technical**
|
||||||
|
|
||||||
|
- [Questions](#questions)
|
||||||
|
- [Tools and Technical](#tools-and-technical)
|
||||||
|
- [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering)
|
||||||
|
- [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools)
|
||||||
|
- [What IDEs/tools support BMM?](#what-idestools-support-bmm)
|
||||||
|
- [Can I customize agents?](#can-i-customize-agents)
|
||||||
|
- [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation)
|
||||||
|
- [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects)
|
||||||
|
- [Advanced](#advanced)
|
||||||
|
- [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3)
|
||||||
|
- [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches)
|
||||||
|
- [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint)
|
||||||
|
- [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations)
|
||||||
|
- [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project)
|
||||||
|
- [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it)
|
||||||
|
- [Getting Help](#getting-help)
|
||||||
|
- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here)
|
||||||
|
- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature)
|
||||||
|
|
||||||
|
**Advanced**
|
||||||
|
|
||||||
|
- [Questions](#questions)
|
||||||
|
- [Tools and Technical](#tools-and-technical)
|
||||||
|
- [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering)
|
||||||
|
- [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools)
|
||||||
|
- [What IDEs/tools support BMM?](#what-idestools-support-bmm)
|
||||||
|
- [Can I customize agents?](#can-i-customize-agents)
|
||||||
|
- [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation)
|
||||||
|
- [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects)
|
||||||
|
- [Advanced](#advanced)
|
||||||
|
- [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3)
|
||||||
|
- [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches)
|
||||||
|
- [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint)
|
||||||
|
- [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations)
|
||||||
|
- [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project)
|
||||||
|
- [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it)
|
||||||
|
- [Getting Help](#getting-help)
|
||||||
|
- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here)
|
||||||
|
- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature)
|
||||||
|
|
||||||
|
**Getting Help**
|
||||||
|
|
||||||
|
- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here)
|
||||||
|
- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature)
|
||||||
|
|
||||||
|
## Tools and Technical
|
||||||
|
|
||||||
|
### Why are my Mermaid diagrams not rendering?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I use BMM with GitHub Copilot / Cursor / other AI tools?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What IDEs/tools support BMM?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I customize agents?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What happens to my planning docs after implementation?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I use BMM for non-software projects?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### What if my project grows from Level 1 to Level 3?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I mix greenfield and brownfield approaches?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### How do I handle urgent hotfixes during a sprint?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### What if I disagree with the workflow's recommendations?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can multiple developers work on the same BMM project?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### What is party mode and when should I use it?
|
||||||
|
|
||||||
|
Party mode is a unique multi-agent collaboration feature where ALL your installed modules agents discuss your challenges together in real-time or have some fun with any topic you have in mind.
|
||||||
|
|
||||||
|
**How it works:**
|
||||||
|
|
||||||
|
1. Run `/bmad:core:workflows:party-mode` (or `PM or fuzzy match on 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:** See the [Party Mode Guide](/docs/explanation/features/party-mode.md)
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
### Where do I get help if my question isn't answered here?
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
### How do I report a bug or request a feature?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
**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!
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
---
|
||||||
|
title: "Workflows FAQ"
|
||||||
|
description: Common questions about BMad Method workflows and phases
|
||||||
|
---
|
||||||
|
|
||||||
|
Quick answers to common questions about BMad Method workflows and phases.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
- [What's the difference between workflow-status and workflow-init?](#whats-the-difference-between-workflow-status-and-workflow-init)
|
||||||
|
- [Can I skip Phase 1 (Analysis)?](#can-i-skip-phase-1-analysis)
|
||||||
|
- [When is Phase 3 (Architecture) required?](#when-is-phase-3-architecture-required)
|
||||||
|
- [What happens if I skip a recommended workflow?](#what-happens-if-i-skip-a-recommended-workflow)
|
||||||
|
- [How do I know when Phase 3 is complete?](#how-do-i-know-when-phase-3-is-complete)
|
||||||
|
- [Can I run workflows in parallel?](#can-i-run-workflows-in-parallel)
|
||||||
|
|
||||||
|
### What's the difference between workflow-status and workflow-init?
|
||||||
|
|
||||||
|
- **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.
|
||||||
|
|
||||||
|
### Can I skip Phase 1 (Analysis)?
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
### When is Phase 3 (Architecture) required?
|
||||||
|
|
||||||
|
- **Level 0-1** — Never (skip entirely)
|
||||||
|
- **Level 2** — Optional (only if system design needed)
|
||||||
|
- **Level 3-4** — Required (comprehensive architecture mandatory)
|
||||||
|
|
||||||
|
### What happens if I skip a recommended workflow?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### How do I know when Phase 3 is complete?
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Can I run workflows in parallel?
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
**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!
|
||||||
|
|
@ -6,8 +6,6 @@ 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.
|
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Overview
|
## Phase Overview
|
||||||
|
|
||||||
| Phase | Name | Purpose | Required? |
|
| Phase | Name | Purpose | Required? |
|
||||||
|
|
@ -17,8 +15,6 @@ BMad Method uses a four-phase approach that adapts to project complexity while e
|
||||||
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
||||||
| **Phase 4** | Implementation | Building the software | Required |
|
| **Phase 4** | Implementation | Building the software | Required |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis (Optional)
|
## Phase 1: Analysis (Optional)
|
||||||
|
|
||||||
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
||||||
|
|
@ -38,8 +34,6 @@ Exploration and discovery workflows that help validate ideas and understand mark
|
||||||
- Well-defined features
|
- Well-defined features
|
||||||
- Continuing existing work
|
- Continuing existing work
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning (Required)
|
## Phase 2: Planning (Required)
|
||||||
|
|
||||||
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
||||||
|
|
@ -52,8 +46,6 @@ Requirements definition using the scale-adaptive system to match planning depth
|
||||||
**Key principle:**
|
**Key principle:**
|
||||||
Define **what** to build and **why**. Leave **how** to Phase 3.
|
Define **what** to build and **why**. Leave **how** to Phase 3.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning (Track-Dependent)
|
## Phase 3: Solutioning (Track-Dependent)
|
||||||
|
|
||||||
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
||||||
|
|
@ -73,8 +65,6 @@ Technical architecture and design decisions that prevent agent conflicts during
|
||||||
**Key principle:**
|
**Key principle:**
|
||||||
Make technical decisions explicit so all agents implement consistently.
|
Make technical decisions explicit so all agents implement consistently.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation (Required)
|
## Phase 4: Implementation (Required)
|
||||||
|
|
||||||
Iterative sprint-based development with story-centric workflow.
|
Iterative sprint-based development with story-centric workflow.
|
||||||
|
|
@ -86,10 +76,9 @@ Iterative sprint-based development with story-centric workflow.
|
||||||
- `code-review` - Quality assurance
|
- `code-review` - Quality assurance
|
||||||
- `retrospective` - Continuous improvement
|
- `retrospective` - Continuous improvement
|
||||||
|
|
||||||
**Key principle:**
|
:::tip[Key Principle]
|
||||||
One story at a time, complete each story's full lifecycle before starting the next.
|
One story at a time — complete each story's full lifecycle before starting the next.
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Flow by Track
|
## Phase Flow by Track
|
||||||
|
|
||||||
|
|
@ -116,11 +105,3 @@ Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (imp
|
||||||
```
|
```
|
||||||
|
|
||||||
Same as BMad Method with optional extended workflows.
|
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)
|
|
||||||
|
|
@ -6,8 +6,6 @@ description: How architecture prevents conflicts when multiple agents implement
|
||||||
|
|
||||||
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
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
|
## Common Conflict Types
|
||||||
|
|
||||||
### API Style Conflicts
|
### API Style Conflicts
|
||||||
|
|
@ -43,8 +41,6 @@ With architecture:
|
||||||
- ADR specifies state management approach
|
- ADR specifies state management approach
|
||||||
- All agents implement consistently
|
- All agents implement consistently
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How Architecture Prevents Conflicts
|
## How Architecture Prevents Conflicts
|
||||||
|
|
||||||
### 1. Explicit Decisions via ADRs
|
### 1. Explicit Decisions via ADRs
|
||||||
|
|
@ -70,8 +66,6 @@ Explicit documentation of:
|
||||||
- Code organization
|
- Code organization
|
||||||
- Testing patterns
|
- Testing patterns
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture as Shared Context
|
## Architecture as Shared Context
|
||||||
|
|
||||||
Think of architecture as the shared context that all agents read before implementing:
|
Think of architecture as the shared context that all agents read before implementing:
|
||||||
|
|
@ -88,8 +82,6 @@ Agent C reads architecture → implements Epic 3
|
||||||
Result: Consistent implementation
|
Result: Consistent implementation
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key ADR Topics
|
## Key ADR Topics
|
||||||
|
|
||||||
Common decisions that prevent conflicts:
|
Common decisions that prevent conflicts:
|
||||||
|
|
@ -103,36 +95,17 @@ Common decisions that prevent conflicts:
|
||||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||||
| Testing | Jest + Playwright vs Vitest + Cypress |
|
| Testing | Jest + Playwright vs Vitest + Cypress |
|
||||||
|
|
||||||
---
|
## Anti-Patterns to Avoid
|
||||||
|
|
||||||
## Anti-Patterns
|
:::caution[Common Mistakes]
|
||||||
|
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
|
||||||
### ❌ Implicit Decisions
|
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
|
||||||
|
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
|
||||||
"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
|
|
||||||
|
|
||||||
|
:::tip[Correct Approach]
|
||||||
- Document decisions that cross epic boundaries
|
- Document decisions that cross epic boundaries
|
||||||
- Focus on conflict-prone areas
|
- Focus on conflict-prone areas
|
||||||
- Update architecture as you learn
|
- Update architecture as you learn
|
||||||
- Use `correct-course` for significant changes
|
- 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)
|
|
||||||
|
|
@ -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.
|
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
|
## 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.
|
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
|
## 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.
|
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Solutioning vs Planning
|
## Solutioning vs Planning
|
||||||
|
|
||||||
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
| 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 |
|
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
||||||
| Level | Business logic | Technical design + Work breakdown |
|
| Level | Business logic | Technical design + Work breakdown |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principle
|
## Key Principle
|
||||||
|
|
||||||
**Make technical decisions explicit and documented** so all agents implement consistently.
|
**Make technical decisions explicit and documented** so all agents implement consistently.
|
||||||
|
|
@ -56,8 +48,6 @@ This prevents:
|
||||||
- Naming convention mismatches
|
- Naming convention mismatches
|
||||||
- Security approach variations
|
- Security approach variations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When Solutioning is Required
|
## When Solutioning is Required
|
||||||
|
|
||||||
| Track | Solutioning Required? |
|
| Track | Solutioning Required? |
|
||||||
|
|
@ -67,9 +57,9 @@ This prevents:
|
||||||
| BMad Method Complex | Yes |
|
| BMad Method Complex | Yes |
|
||||||
| Enterprise | 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
|
## The Cost of Skipping
|
||||||
|
|
||||||
|
|
@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
|
||||||
- **Longer development time** overall
|
- **Longer development time** overall
|
||||||
- **Technical debt** from inconsistent patterns
|
- **Technical debt** from inconsistent patterns
|
||||||
|
|
||||||
|
:::caution[Cost Multiplier]
|
||||||
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
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
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "How to Add a Feature to an Existing Project"
|
||||||
description: How to add new features to an existing brownfield project
|
description: How to add new features to an existing brownfield project
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
||||||
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -14,15 +11,11 @@ Add new functionality to your brownfield codebase while respecting existing patt
|
||||||
- Major enhancements that need proper planning
|
- Major enhancements that need proper planning
|
||||||
- Features that touch multiple parts of the system
|
- Features that touch multiple parts of the system
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
- BMad Method installed
|
||||||
- Existing project documentation (run `document-project` first if needed)
|
- Existing project documentation (run `document-project` first if needed)
|
||||||
- Clear understanding of what you want to build
|
- Clear understanding of what you want to build
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -73,19 +66,9 @@ Follow the standard Phase 4 implementation workflows:
|
||||||
3. `dev-story` - Implement with tests
|
3. `dev-story` - Implement with tests
|
||||||
4. `code-review` - Quality assurance
|
4. `code-review` - Quality assurance
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Always ensure agents read your existing documentation
|
- Always ensure agents read your existing documentation
|
||||||
- Pay attention to integration points with existing code
|
- Pay attention to integration points with existing code
|
||||||
- Follow existing conventions unless deliberately changing them
|
- Follow existing conventions unless deliberately changing them
|
||||||
- Document why you're adding new patterns (if any)
|
- 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)
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "How to Document an Existing Project"
|
||||||
description: How to document an existing brownfield codebase using BMad Method
|
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.
|
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Starting work on an undocumented legacy project
|
- Starting work on an undocumented legacy project
|
||||||
|
|
@ -15,14 +12,10 @@ Use the `document-project` workflow to scan your entire codebase and generate co
|
||||||
- AI agents need context about existing code patterns
|
- AI agents need context about existing code patterns
|
||||||
- Onboarding new team members
|
- Onboarding new team members
|
||||||
|
|
||||||
---
|
:::note[Prerequisites]
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed in your project
|
- BMad Method installed in your project
|
||||||
- Access to the codebase you want to document
|
- Access to the codebase you want to document
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -58,8 +51,6 @@ Review the documentation for:
|
||||||
- Completeness of architecture description
|
- Completeness of architecture description
|
||||||
- Any missing business rules or intent
|
- Any missing business rules or intent
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
## What You Get
|
||||||
|
|
||||||
- **Project overview** - High-level description of what the project does
|
- **Project overview** - High-level description of what the project does
|
||||||
|
|
@ -68,17 +59,8 @@ Review the documentation for:
|
||||||
- **Business rules** - Logic extracted from the codebase
|
- **Business rules** - Logic extracted from the codebase
|
||||||
- **Integration points** - External APIs and services
|
- **Integration points** - External APIs and services
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
- Run this before any major brownfield work
|
- Run this before any major brownfield work
|
||||||
- Keep the documentation updated as the project evolves
|
- Keep the documentation updated as the project evolves
|
||||||
- Use it as input for future PRD creation
|
- 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
|
description: How to use BMad Method on existing codebases
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use BMad Method effectively when working on existing projects and legacy codebases.
|
||||||
How to effectively use BMad Method when working on existing projects and legacy codebases.
|
|
||||||
|
|
||||||
## What is Brownfield Development?
|
## 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.
|
**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.
|
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
- An existing codebase you want to work on
|
- An existing codebase you want to work on
|
||||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Step 1: Clean Up Completed Planning Artifacts
|
## 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/planning-artifacts/`
|
||||||
- `_bmad-output/implementation-artifacts/`
|
- `_bmad-output/implementation-artifacts/`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Step 2: Maintain Quality Project Documentation
|
## Step 2: Maintain Quality Project Documentation
|
||||||
|
|
||||||
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
||||||
|
|
@ -43,8 +36,6 @@ 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.
|
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: Initialize for Brownfield Work
|
## Step 3: Initialize for Brownfield Work
|
||||||
|
|
||||||
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 `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
|
||||||
|
|
@ -85,18 +76,9 @@ When doing architecture, ensure the architect:
|
||||||
|
|
||||||
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Document Existing Project](../../how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
- **[Document Existing Project](/docs/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
|
- **[Add Feature to Existing Project](/docs/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
|
- **[Quick Fix in Brownfield](/docs/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
|
- **[Brownfield FAQ](/docs/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
|
|
||||||
|
|
@ -3,10 +3,7 @@ title: "How to Make Quick Fixes in Brownfield Projects"
|
||||||
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
||||||
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.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
|
|
@ -16,8 +13,6 @@ Not everything requires the full BMad method or even Quick Flow. For bug fixes,
|
||||||
- Learning about your codebase
|
- Learning about your codebase
|
||||||
- One-off changes that don't need planning
|
- One-off changes that don't need planning
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
### 1. Load an Agent
|
### 1. Load an Agent
|
||||||
|
|
@ -54,8 +49,6 @@ The agent will:
|
||||||
|
|
||||||
Review the changes made and commit when satisfied.
|
Review the changes made and commit when satisfied.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning Your Codebase
|
## Learning Your Codebase
|
||||||
|
|
||||||
This approach is also excellent for exploring unfamiliar code:
|
This approach is also excellent for exploring unfamiliar code:
|
||||||
|
|
@ -74,8 +67,6 @@ LLMs are excellent at interpreting and analyzing code—whether it was AI-genera
|
||||||
- Understand how things are built
|
- Understand how things are built
|
||||||
- Explore unfamiliar parts of the codebase
|
- Explore unfamiliar parts of the codebase
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Upgrade to Formal Planning
|
## When to Upgrade to Formal Planning
|
||||||
|
|
||||||
Consider using Quick Flow or full BMad Method when:
|
Consider using Quick Flow or full BMad Method when:
|
||||||
|
|
@ -84,11 +75,3 @@ Consider using Quick Flow or full BMad Method when:
|
||||||
- You're unsure about the scope
|
- You're unsure about the scope
|
||||||
- The fix keeps growing in complexity
|
- The fix keeps growing in complexity
|
||||||
- You need documentation for the change
|
- 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)
|
|
||||||
|
|
@ -2,8 +2,14 @@
|
||||||
title: "Agent Customization Guide"
|
title: "Agent Customization Guide"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use `.customize.yaml` files to customize BMad agents without modifying core files. All customizations persist through updates.
|
||||||
|
|
||||||
Customize BMad agents without modifying core files. All customizations persist through updates.
|
## When to Use This
|
||||||
|
|
||||||
|
- Change agent names or personas
|
||||||
|
- Add project-specific memories or context
|
||||||
|
- Add custom menu items and workflows
|
||||||
|
- Define critical actions for consistent behavior
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
|
@ -201,8 +207,6 @@ memories:
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- **[Learn about Agents](../../explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
- **[Learn about Agents](/docs/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
|
- **[Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md)** - Build completely custom agents
|
||||||
- **[BMM Complete Documentation](../../explanation/bmm/index.md)** - Full BMad Method reference
|
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference
|
||||||
|
|
||||||
[← Back to Customization](./index.md)
|
|
||||||
|
|
@ -2,16 +2,14 @@
|
||||||
title: "Document Sharding Guide"
|
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
|
- Very large complex PRDs
|
||||||
|
- Architecture documents with multiple system layers
|
||||||
- [What is Document Sharding?](#what-is-document-sharding)
|
- Epic files with 4+ epics (especially for Phase 4)
|
||||||
- [When to Use Sharding](#when-to-use-sharding)
|
- UX design specs covering multiple subsystems
|
||||||
- [How Sharding Works](#how-sharding-works)
|
|
||||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
|
||||||
- [Workflow Support](#workflow-support)
|
|
||||||
|
|
||||||
## What is Document Sharding?
|
## What is Document Sharding?
|
||||||
|
|
||||||
|
|
@ -39,43 +37,15 @@ docs/
|
||||||
└── ... # Additional sections
|
└── ... # Additional sections
|
||||||
```
|
```
|
||||||
|
|
||||||
## When to Use Sharding
|
## Steps
|
||||||
|
|
||||||
### Ideal Candidates
|
### 1. Run the Shard-Doc Tool
|
||||||
|
|
||||||
**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
|
|
||||||
|
|
||||||
```bash
|
```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?
|
Agent: Which document would you like to shard?
|
||||||
|
|
@ -91,7 +61,7 @@ Agent: Sharding PRD.md...
|
||||||
✓ Complete!
|
✓ Complete!
|
||||||
```
|
```
|
||||||
|
|
||||||
### What Gets Created
|
## What You Get
|
||||||
|
|
||||||
**index.md structure:**
|
**index.md structure:**
|
||||||
|
|
||||||
|
|
@ -113,13 +83,19 @@ Agent: Sharding PRD.md...
|
||||||
- Preserves all markdown formatting
|
- Preserves all markdown formatting
|
||||||
- Can be read independently
|
- 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
|
## Workflow Support
|
||||||
|
|
||||||
### Universal Support
|
All BMM workflows support both formats:
|
||||||
|
|
||||||
**All BMM workflows support both formats:**
|
- Whole documents
|
||||||
|
- Sharded documents
|
||||||
- ✅ Whole documents
|
- Automatic detection
|
||||||
- ✅ Sharded documents
|
- Transparent to user
|
||||||
- ✅ Automatic detection
|
|
||||||
- ✅ Transparent to user
|
|
||||||
|
|
@ -0,0 +1,118 @@
|
||||||
|
---
|
||||||
|
title: "How to Install Custom Modules"
|
||||||
|
description: Add custom agents, workflows, and modules to BMad
|
||||||
|
---
|
||||||
|
|
||||||
|
Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality.
|
||||||
|
|
||||||
|
## When to Use This
|
||||||
|
|
||||||
|
- Adding third-party BMad modules to your project
|
||||||
|
- Installing your own custom agents or workflows
|
||||||
|
- Sharing custom content across projects or teams
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
|
- BMad installed in your project
|
||||||
|
- Custom content with a valid `module.yaml` file
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
### 1. Prepare Your Custom Content
|
||||||
|
|
||||||
|
Your custom content needs a `module.yaml` file. Choose the appropriate structure:
|
||||||
|
|
||||||
|
**For a cohesive module** (agents and workflows that work together):
|
||||||
|
|
||||||
|
```
|
||||||
|
module-code/
|
||||||
|
module.yaml
|
||||||
|
agents/
|
||||||
|
workflows/
|
||||||
|
tools/
|
||||||
|
templates/
|
||||||
|
```
|
||||||
|
|
||||||
|
**For standalone items** (unrelated agents/workflows):
|
||||||
|
|
||||||
|
```
|
||||||
|
module-name/
|
||||||
|
module.yaml # Contains unitary: true
|
||||||
|
agents/
|
||||||
|
larry/larry.agent.md
|
||||||
|
curly/curly.agent.md
|
||||||
|
workflows/
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `unitary: true` in your `module.yaml` to indicate items don't depend on each other.
|
||||||
|
|
||||||
|
### 2. Run the Installer
|
||||||
|
|
||||||
|
**New project:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
|
When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder.
|
||||||
|
|
||||||
|
**Existing project:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Select `Modify BMad Installation`
|
||||||
|
2. Choose the option to add, modify, or update custom modules
|
||||||
|
3. Provide the path to your module folder
|
||||||
|
|
||||||
|
### 3. Verify Installation
|
||||||
|
|
||||||
|
Check that your custom content appears in the `_bmad/` directory and is accessible from your AI tool.
|
||||||
|
|
||||||
|
## What You Get
|
||||||
|
|
||||||
|
- Custom agents available in your AI tool
|
||||||
|
- Custom workflows accessible via `*workflow-name`
|
||||||
|
- Content integrated with BMad's update system
|
||||||
|
|
||||||
|
## Content Types
|
||||||
|
|
||||||
|
BMad supports several categories of custom content:
|
||||||
|
|
||||||
|
| Type | Description |
|
||||||
|
| ----------------------- | ---------------------------------------------------- |
|
||||||
|
| **Stand Alone Modules** | Complete modules with their own agents and workflows |
|
||||||
|
| **Add On Modules** | Extensions that add to existing modules |
|
||||||
|
| **Global Modules** | Content available across all modules |
|
||||||
|
| **Custom Agents** | Individual agent definitions |
|
||||||
|
| **Custom Workflows** | Individual workflow definitions |
|
||||||
|
|
||||||
|
For detailed information about content types, see [Custom Content Types](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/explanation/bmad-builder/custom-content-types.md).
|
||||||
|
|
||||||
|
## Updating Custom Content
|
||||||
|
|
||||||
|
When BMad Core or module updates are available, the quick update process:
|
||||||
|
|
||||||
|
1. Applies updates to core modules
|
||||||
|
2. Recompiles all agents with your customizations
|
||||||
|
3. Retains your custom content from cache
|
||||||
|
4. Preserves your configurations
|
||||||
|
|
||||||
|
You don't need to keep source module files locally—just point to the updated location during updates.
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Use unique module codes** — Don't use `bmm` or other existing module codes
|
||||||
|
- **Avoid naming conflicts** — Each module needs a distinct code
|
||||||
|
- **Document dependencies** — Note any modules your custom content requires
|
||||||
|
- **Test in isolation** — Verify custom modules work before sharing
|
||||||
|
- **Version your content** — Track updates with version numbers
|
||||||
|
|
||||||
|
:::caution[Naming Conflicts]
|
||||||
|
Don't create custom modules with codes like `bmm` (already used by BMad Method). Each custom module needs a unique code.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Example Modules
|
||||||
|
|
||||||
|
Find example custom modules in the `samples/sample-custom-modules/` folder of the [BMad repository](https://github.com/bmad-code-org/BMAD-METHOD). Download either sample folder to try them out.
|
||||||
|
|
@ -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
|
||||||
|
|
@ -0,0 +1,109 @@
|
||||||
|
---
|
||||||
|
title: "Agents Reference"
|
||||||
|
description: Complete reference for BMad Method agents and their commands
|
||||||
|
---
|
||||||
|
|
||||||
|
Quick reference of all BMad Method agents and their available commands.
|
||||||
|
|
||||||
|
:::tip[Universal Commands]
|
||||||
|
All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration).
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Analyst (Mary)
|
||||||
|
|
||||||
|
Business analysis and research.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
|
- `*brainstorm-project` — Guided brainstorming session
|
||||||
|
- `*research` — Market, domain, competitive, or technical research
|
||||||
|
- `*product-brief` — Create a product brief (input for PRD)
|
||||||
|
- `*document-project` — Document existing brownfield projects
|
||||||
|
|
||||||
|
## PM (John)
|
||||||
|
|
||||||
|
Product requirements and planning.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
|
- `*create-prd` — Create Product Requirements Document
|
||||||
|
- `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture)
|
||||||
|
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
||||||
|
- `*correct-course` — Course correction during implementation
|
||||||
|
|
||||||
|
## Architect (Winston)
|
||||||
|
|
||||||
|
System architecture and technical design.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*workflow-status` — Get workflow status or initialize tracking
|
||||||
|
- `*create-architecture` — Create architecture document to guide development
|
||||||
|
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
||||||
|
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
||||||
|
- `*create-excalidraw-dataflow` — Data flow diagrams
|
||||||
|
|
||||||
|
## SM (Bob)
|
||||||
|
|
||||||
|
Sprint planning and story preparation.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*sprint-planning` — Generate sprint-status.yaml from epic files
|
||||||
|
- `*create-story` — Create story from epic (prep for development)
|
||||||
|
- `*validate-create-story` — Validate story quality
|
||||||
|
- `*epic-retrospective` — Team retrospective after epic completion
|
||||||
|
- `*correct-course` — Course correction during implementation
|
||||||
|
|
||||||
|
## DEV (Amelia)
|
||||||
|
|
||||||
|
Story implementation and code review.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*dev-story` — Execute story workflow (implementation with tests)
|
||||||
|
- `*code-review` — Thorough code review
|
||||||
|
|
||||||
|
## Quick Flow Solo Dev (Barry)
|
||||||
|
|
||||||
|
Fast solo development without handoffs.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*quick-spec` — Architect technical spec with implementation-ready stories
|
||||||
|
- `*quick-dev` — Implement tech spec end-to-end solo
|
||||||
|
- `*code-review` — Review and improve code
|
||||||
|
|
||||||
|
## TEA (Murat)
|
||||||
|
|
||||||
|
Test architecture and quality strategy.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*framework` — Initialize production-ready test framework
|
||||||
|
- `*atdd` — Generate E2E tests first (before implementation)
|
||||||
|
- `*automate` — Comprehensive test automation
|
||||||
|
- `*test-design` — Create comprehensive test scenarios
|
||||||
|
- `*trace` — Map requirements to tests, quality gate decision
|
||||||
|
- `*nfr-assess` — Validate non-functional requirements
|
||||||
|
- `*ci` — Scaffold CI/CD quality pipeline
|
||||||
|
- `*test-review` — Review test quality
|
||||||
|
|
||||||
|
## UX Designer (Sally)
|
||||||
|
|
||||||
|
User experience and UI design.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*create-ux-design` — Generate UX design and UI plan from PRD
|
||||||
|
- `*validate-design` — Validate UX specification and design artifacts
|
||||||
|
- `*create-excalidraw-wireframe` — Create website or app wireframe
|
||||||
|
|
||||||
|
## Technical Writer (Paige)
|
||||||
|
|
||||||
|
Technical documentation and diagrams.
|
||||||
|
|
||||||
|
**Commands:**
|
||||||
|
- `*document-project` — Comprehensive project documentation
|
||||||
|
- `*generate-mermaid` — Generate Mermaid diagrams
|
||||||
|
- `*create-excalidraw-flowchart` — Process and logic flow visualizations
|
||||||
|
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
||||||
|
- `*create-excalidraw-dataflow` — Data flow visualizations
|
||||||
|
- `*validate-doc` — Review documentation against standards
|
||||||
|
- `*improve-readme` — Review and improve README files
|
||||||
|
- `*explain-concept` — Create clear technical explanations
|
||||||
|
- `*standards-guide` — Show BMad documentation standards
|
||||||
|
|
@ -0,0 +1,67 @@
|
||||||
|
---
|
||||||
|
title: "Core Tasks"
|
||||||
|
---
|
||||||
|
|
||||||
|
Reusable task definitions that can be invoked by any BMad module, workflow, or agent.
|
||||||
|
|
||||||
|
## Contents
|
||||||
|
|
||||||
|
- [Index Docs](#index-docs) — Generate directory index files
|
||||||
|
- [Adversarial Review](#adversarial-review) — Critical content review
|
||||||
|
- [Shard Document](#shard-document) — Split large documents into sections
|
||||||
|
|
||||||
|
## Index Docs
|
||||||
|
|
||||||
|
**Generates or updates an index.md file documenting all files in a specified directory.**
|
||||||
|
|
||||||
|
**Use it when:**
|
||||||
|
- You need navigable documentation for a folder of markdown files
|
||||||
|
- You want to maintain an updated index as content evolves
|
||||||
|
|
||||||
|
**How it works:**
|
||||||
|
1. Scan the target directory for files and subdirectories
|
||||||
|
2. Group content by type, purpose, or location
|
||||||
|
3. Read each file to generate brief (3-10 word) descriptions
|
||||||
|
4. Create or update index.md with organized listings
|
||||||
|
|
||||||
|
**Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
||||||
|
|
||||||
|
## Adversarial Review
|
||||||
|
|
||||||
|
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
||||||
|
|
||||||
|
**Use it when:**
|
||||||
|
- Reviewing code diffs before merging
|
||||||
|
- Finalizing specifications or user stories
|
||||||
|
- Releasing documentation
|
||||||
|
- Any artifact needs a critical eye before completion
|
||||||
|
|
||||||
|
**How it works:**
|
||||||
|
1. Load the content to review (diff, branch, document, etc.)
|
||||||
|
2. Perform adversarial analysis — assume problems exist
|
||||||
|
3. Find at least ten issues to fix or improve
|
||||||
|
4. Output findings as a markdown list
|
||||||
|
|
||||||
|
:::note[Unbiased Review]
|
||||||
|
This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Shard Document
|
||||||
|
|
||||||
|
**Splits large markdown documents into smaller files based on level 2 (`##`) sections.**
|
||||||
|
|
||||||
|
**Use it when:**
|
||||||
|
- A markdown file has grown too large to work with effectively
|
||||||
|
- You want to break a monolithic document into manageable sections
|
||||||
|
- Individual sections need to be edited independently
|
||||||
|
|
||||||
|
**How it works:**
|
||||||
|
1. Confirm source document path (must be markdown)
|
||||||
|
2. Determine destination folder (defaults to folder named after document)
|
||||||
|
3. Execute sharding via `npx @kayvan/markdown-tree-parser`
|
||||||
|
4. Verify output files and index.md were created
|
||||||
|
5. Handle original document — delete, move to archive, or keep
|
||||||
|
|
||||||
|
:::caution[Original File]
|
||||||
|
After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only.
|
||||||
|
:::
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
title: "Global Inheritable Config"
|
||||||
|
---
|
||||||
|
|
||||||
|
Configuration values defined in the Core Module that all other modules inherit by default.
|
||||||
|
|
||||||
|
## Core Config Values
|
||||||
|
|
||||||
|
These values are set during installation and recorded to the core `module.yaml`:
|
||||||
|
|
||||||
|
| Config Key | Default | Description |
|
||||||
|
|------------|---------|-------------|
|
||||||
|
| `user_name` | System username | User's display name |
|
||||||
|
| `communication_language` | `english` | Language for agent communication |
|
||||||
|
| `document_output_language` | `english` | Language for generated documents |
|
||||||
|
| `output_folder` | `_bmad-output` | Directory for workflow outputs |
|
||||||
|
|
||||||
|
## Inheritance Behavior
|
||||||
|
|
||||||
|
All installed modules automatically clone these values into their own config. Modules can:
|
||||||
|
|
||||||
|
- **Accept defaults** — Use core values as-is (recommended)
|
||||||
|
- **Override values** — Replace with module-specific settings
|
||||||
|
- **Extend values** — Build on core values with additional paths
|
||||||
|
|
||||||
|
:::tip[Extending Config]
|
||||||
|
Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured.
|
||||||
|
:::
|
||||||
|
|
@ -2,23 +2,25 @@
|
||||||
title: Downloads
|
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
|
## Source Bundles
|
||||||
|
|
||||||
|
Download these from the `downloads/` folder on the documentation site.
|
||||||
|
|
||||||
| File | Description |
|
| File | Description |
|
||||||
|------|-------------|
|
|------|-------------|
|
||||||
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMAD source files |
|
| `bmad-sources.zip` | Complete BMad source files |
|
||||||
| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only |
|
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
||||||
|
|
||||||
## LLM-Optimized Files
|
## 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 |
|
| File | Description | Use Case |
|
||||||
|------|-------------|----------|
|
|------|-------------|----------|
|
||||||
| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation |
|
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
||||||
| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading |
|
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
||||||
|
|
||||||
### Using with LLMs
|
### Using with LLMs
|
||||||
|
|
||||||
|
|
@ -41,12 +43,12 @@ docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt")
|
||||||
|
|
||||||
## Installation Options
|
## Installation Options
|
||||||
|
|
||||||
### NPM (Recommended)
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method@alpha install
|
npx bmad-method@alpha install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
[More details](/docs/how-to/install-bmad.md)
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
|
|
||||||
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
- **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
|
## API Access
|
||||||
|
|
||||||
For programmatic access to BMAD documentation:
|
For programmatic access to BMad documentation:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Get documentation index
|
# Get documentation index
|
||||||
|
|
@ -66,7 +68,7 @@ curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||||
|
|
||||||
## Contributing
|
## 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)
|
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
|
||||||
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||||
|
|
|
||||||
|
|
@ -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
|
||||||
|
|
@ -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,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,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
|
|
||||||
|
|
@ -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.
|
||||||
|
:::
|
||||||
|
|
@ -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,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,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,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
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue