mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
Compare commits
150 Commits
v6.0.0-alp
...
6.0.0-alph
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8b92e5ee59 | ||
|
|
9f53d896b7 | ||
|
|
b46409e71d | ||
|
|
8cffd09fb7 | ||
|
|
2b89ee1302 | ||
|
|
b72c810a1f | ||
|
|
484990de50 | ||
|
|
b8836ced24 | ||
|
|
c7fcf16eae | ||
|
|
529d4a8c95 | ||
|
|
f0520c39d9 | ||
|
|
ff0517f4d0 | ||
|
|
b509fb9a1e | ||
|
|
e0090e5602 | ||
|
|
8d679b177b | ||
|
|
ea421adbf9 | ||
|
|
2a8a4388a9 | ||
|
|
d4a94df29a | ||
|
|
949cf64d3b | ||
|
|
aba9d11c88 | ||
|
|
208f27dcdb | ||
|
|
c15ad174ed | ||
|
|
24cedea690 | ||
|
|
bdb6bde9b5 | ||
|
|
cfdffe3f7a | ||
|
|
7b5b7afdc0 | ||
|
|
59a0eec2e2 | ||
|
|
1f16bb7413 | ||
|
|
b1d1242fcf | ||
|
|
47a0ebda4f | ||
|
|
1a1a806d99 | ||
|
|
19df17b261 | ||
|
|
925b715d4f | ||
|
|
e4a4f47a1e | ||
|
|
4195eb3b30 | ||
|
|
c0f5d33c61 | ||
|
|
3f76c2de74 | ||
|
|
45ff3840a8 | ||
|
|
dcaa892ce1 | ||
|
|
00a380a03f | ||
|
|
12dd97fe9b | ||
|
|
00ad756acf | ||
|
|
021936eaa9 | ||
|
|
da21790531 | ||
|
|
34cfdddd3a | ||
|
|
1e721f7fd0 | ||
|
|
9c268f8190 | ||
|
|
e59c7b79ed | ||
|
|
a20198b94b | ||
|
|
4271fe5f2b | ||
|
|
b276d5a387 | ||
|
|
7b762fe211 | ||
|
|
e39aa33eea | ||
|
|
2da9aebaa8 | ||
|
|
5c756b6404 | ||
|
|
23f650ff4d | ||
|
|
363915b0c6 | ||
|
|
f36369512b | ||
|
|
ccb64623bc | ||
|
|
e37edf098c | ||
|
|
e3eb374218 | ||
|
|
83b0df0f21 | ||
|
|
00a3af3eb0 | ||
|
|
d0e0a0963a | ||
|
|
32615afaf9 | ||
|
|
59e4cc7b82 | ||
|
|
c24821b6ed | ||
|
|
2c4c2d9717 | ||
|
|
901b39de9a | ||
|
|
4d8d1f84f7 | ||
|
|
48795d46de | ||
|
|
bbda7171bd | ||
|
|
08f05cf9a4 | ||
|
|
c7827bf031 | ||
|
|
5716282898 | ||
|
|
60238d2854 | ||
|
|
6513c77d1b | ||
|
|
3cbe330b8e | ||
|
|
ecc2901649 | ||
|
|
d4eccf07cf | ||
|
|
1da7705821 | ||
|
|
7f742d4af6 | ||
|
|
9fe79882b2 | ||
|
|
ebb20f675f | ||
|
|
82cc10824a | ||
|
|
4c65f3a006 | ||
|
|
401e8e481c | ||
|
|
cba7cf223f | ||
|
|
add789a408 | ||
|
|
ae9851acab | ||
|
|
ac5fa5c23f | ||
|
|
8642553bd7 | ||
|
|
ce42d56fdd | ||
|
|
25c79e3fe5 | ||
|
|
0c873638ab | ||
|
|
e6f911d791 | ||
|
|
f11be2b2e2 | ||
|
|
572074d2a6 | ||
|
|
0ed546619f | ||
|
|
c3b54c5fc6 | ||
|
|
e34f53d6f8 | ||
|
|
ebbb44f961 | ||
|
|
76185937c6 | ||
|
|
7a9f1d4a3c | ||
|
|
7d6aae1b78 | ||
|
|
ed0defbe08 | ||
|
|
3bc485d0ed | ||
|
|
0f5a9cf0dd | ||
|
|
e2d9d35ce9 | ||
|
|
82e6433b69 | ||
|
|
be7e07cc1a | ||
|
|
079f79aba5 | ||
|
|
b4d7e1adef | ||
|
|
6e9fe6c9a2 | ||
|
|
d2d9010a8e | ||
|
|
6d5a1084eb | ||
|
|
978a93ed33 | ||
|
|
ec90699016 | ||
|
|
0f06ef724b | ||
|
|
26e47562dd | ||
|
|
3256bda42f | ||
|
|
3d2727e190 | ||
|
|
446a0359ab | ||
|
|
45a97b070a | ||
|
|
a2d01813f0 | ||
|
|
b9ba98d3f8 | ||
|
|
5971a88553 | ||
|
|
08642a0420 | ||
|
|
ec73e44097 | ||
|
|
d55f518a96 | ||
|
|
cf50f4935d | ||
|
|
55cb4681bc | ||
|
|
eb4325fab9 | ||
|
|
57ceaf9fa9 | ||
|
|
1513b2d478 | ||
|
|
2da016f797 | ||
|
|
6947851393 | ||
|
|
9d7b09d065 | ||
|
|
86f2786dde | ||
|
|
a638f062b9 | ||
|
|
738237b4ae | ||
|
|
6430173738 | ||
|
|
baaa984a90 | ||
|
|
38e65abd83 | ||
|
|
ff9a085dd0 | ||
|
|
d5c687d99d | ||
|
|
b68e5c0225 | ||
|
|
987f81ff64 | ||
|
|
0c2afdd2bb | ||
|
|
a65ff90b44 |
40
.coderabbit.yaml
Normal file
40
.coderabbit.yaml
Normal file
@@ -0,0 +1,40 @@
|
||||
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
|
||||
|
||||
language: "en-US"
|
||||
early_access: true
|
||||
reviews:
|
||||
profile: chill
|
||||
high_level_summary: false # don't post summary until explicitly invoked
|
||||
request_changes_workflow: false
|
||||
review_status: false
|
||||
commit_status: false
|
||||
walkthrough: false
|
||||
poem: false
|
||||
auto_review:
|
||||
enabled: false
|
||||
drafts: true # Can review drafts. Since it's manually triggered, it's fine.
|
||||
auto_incremental_review: false # always review the whole PR, not just new commits
|
||||
base_branches:
|
||||
- main
|
||||
path_filters:
|
||||
- "!**/node_modules/**"
|
||||
path_instructions:
|
||||
- path: "**/*"
|
||||
instructions: |
|
||||
Focus on inconsistencies, contradictions, edge cases and serious issues.
|
||||
Avoid commenting on minor issues such as linting, formatting and style issues.
|
||||
When providing code suggestions, use GitHub's suggestion format:
|
||||
```suggestion
|
||||
<code changes>
|
||||
```
|
||||
- path: "**/*.js"
|
||||
instructions: |
|
||||
CLI tooling code. Check for: missing error handling on fs operations,
|
||||
path.join vs string concatenation, proper cleanup in error paths.
|
||||
Flag any process.exit() without error message.
|
||||
chat:
|
||||
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
||||
issue_enrichment:
|
||||
auto_enrich:
|
||||
enabled: false # don't auto-comment on issues
|
||||
|
||||
@@ -60,7 +60,7 @@ representative at an online or offline event.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
the official BMAD Discord server (https://discord.com/invite/gk8jAdXWmj) - DM a moderator or flag a post.
|
||||
the official BMAD Discord server (<https://discord.com/invite/gk8jAdXWmj>) - DM a moderator or flag a post.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
@@ -116,7 +116,7 @@ the community.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
@@ -124,5 +124,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
<https://www.contributor-covenant.org/faq>. Translations are available at
|
||||
<https://www.contributor-covenant.org/translations>.
|
||||
23
.github/scripts/discord-helpers.sh
vendored
23
.github/scripts/discord-helpers.sh
vendored
@@ -2,8 +2,21 @@
|
||||
# Discord notification helper functions
|
||||
|
||||
# Escape markdown special chars and @mentions for safe Discord display
|
||||
# Bracket expression: ] must be first, then other chars. In POSIX bracket expr, \ is literal.
|
||||
esc() { sed -e 's/[][\*_()~`>]/\\&/g' -e 's/@/@ /g'; }
|
||||
# Skips content inside <URL> wrappers to preserve URLs intact
|
||||
esc() {
|
||||
awk '{
|
||||
result = ""; in_url = 0; n = length($0)
|
||||
for (i = 1; i <= n; i++) {
|
||||
c = substr($0, i, 1)
|
||||
if (c == "<" && substr($0, i, 8) ~ /^<https?:/) in_url = 1
|
||||
if (in_url) { result = result c; if (c == ">") in_url = 0 }
|
||||
else if (c == "@") result = result "@ "
|
||||
else if (index("[]\\*_()~`", c) > 0) result = result "\\" c
|
||||
else result = result c
|
||||
}
|
||||
print result
|
||||
}'
|
||||
}
|
||||
|
||||
# Truncate to $1 chars (or 80 if wall-of-text with <3 spaces)
|
||||
trunc() {
|
||||
@@ -13,3 +26,9 @@ trunc() {
|
||||
[ "$spaces" -lt 3 ] && [ ${#txt} -gt 80 ] && txt=$(printf '%s' "$txt" | cut -c1-80)
|
||||
printf '%s' "$txt"
|
||||
}
|
||||
|
||||
# Remove incomplete URL at end of truncated text (incomplete URLs are useless)
|
||||
strip_trailing_url() { sed -E 's~<?https?://[^[:space:]]*$~~'; }
|
||||
|
||||
# Wrap URLs in <> to suppress Discord embeds (keeps links clickable)
|
||||
wrap_urls() { sed -E 's~https?://[^[:space:]<>]+~<&>~g'; }
|
||||
|
||||
38
.github/workflows/discord.yaml
vendored
38
.github/workflows/discord.yaml
vendored
@@ -53,7 +53,11 @@ jobs:
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$PR_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$PR_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$PR_BODY" ] && [ ${#PR_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
USER=$(printf '%s' "$PR_USER" | esc)
|
||||
@@ -91,7 +95,11 @@ jobs:
|
||||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY | esc)
|
||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
||||
if [ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ]; then
|
||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
||||
fi
|
||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||
USER=$(printf '%s' "$USER" | esc)
|
||||
@@ -126,7 +134,11 @@ jobs:
|
||||
|
||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY | esc)
|
||||
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)
|
||||
|
||||
@@ -162,7 +174,11 @@ jobs:
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$REVIEW_BODY" | trunc $MAX_BODY | esc)
|
||||
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)
|
||||
@@ -194,7 +210,11 @@ jobs:
|
||||
|
||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY | esc)
|
||||
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)
|
||||
|
||||
@@ -224,7 +244,11 @@ jobs:
|
||||
|
||||
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 | esc)
|
||||
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)
|
||||
@@ -275,7 +299,7 @@ jobs:
|
||||
run: |
|
||||
set -o pipefail
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
esc() { sed -e 's/[][\*_()~`>]/\\&/g' -e 's/@/@ /g'; }
|
||||
esc() { sed -e 's/[][\*_()~`]/\\&/g' -e 's/@/@ /g'; }
|
||||
trunc() { tr '\n\r' ' ' | cut -c1-"$1"; }
|
||||
|
||||
REF_TRUNC=$(printf '%s' "$REF" | trunc 100)
|
||||
|
||||
72
.github/workflows/docs.yaml
vendored
Normal file
72
.github/workflows/docs.yaml
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
name: Deploy Documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "src/modules/*/docs/**"
|
||||
- "website/**"
|
||||
- "tools/build-docs.js"
|
||||
- ".github/workflows/docs.yaml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "20"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Determine site URL
|
||||
id: site-url
|
||||
run: |
|
||||
if [ "${{ github.repository }}" = "bmad-code-org/BMAD-METHOD" ]; then
|
||||
echo "url=https://bmad-code-org.github.io/BMAD-METHOD" >> $GITHUB_OUTPUT
|
||||
else
|
||||
OWNER="${{ github.repository_owner }}"
|
||||
REPO="${{ github.event.repository.name }}"
|
||||
echo "url=https://${OWNER}.github.io/${REPO}" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Build documentation
|
||||
env:
|
||||
SITE_URL: ${{ steps.site-url.outputs.url }}
|
||||
run: npm run docs:build
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: build/site
|
||||
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
54
.github/workflows/manual-release.yaml
vendored
54
.github/workflows/manual-release.yaml
vendored
@@ -6,9 +6,11 @@ on:
|
||||
version_bump:
|
||||
description: Version bump type
|
||||
required: true
|
||||
default: patch
|
||||
default: alpha
|
||||
type: choice
|
||||
options:
|
||||
- alpha
|
||||
- beta
|
||||
- patch
|
||||
- minor
|
||||
- major
|
||||
@@ -49,7 +51,11 @@ jobs:
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
- name: Bump version
|
||||
run: npm run version:${{ github.event.inputs.version_bump }}
|
||||
run: |
|
||||
case "${{ github.event.inputs.version_bump }}" in
|
||||
alpha|beta) npm version prerelease --no-git-tag-version --preid=${{ github.event.inputs.version_bump }} ;;
|
||||
*) npm version ${{ github.event.inputs.version_bump }} --no-git-tag-version ;;
|
||||
esac
|
||||
|
||||
- name: Get new version and previous tag
|
||||
id: version
|
||||
@@ -61,34 +67,9 @@ jobs:
|
||||
run: |
|
||||
sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
|
||||
|
||||
- name: Generate web bundles
|
||||
run: npm run bundle
|
||||
|
||||
- name: Package bundles for release
|
||||
run: |
|
||||
mkdir -p dist/release-bundles
|
||||
|
||||
# Copy web bundles
|
||||
cp -r web-bundles dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}
|
||||
|
||||
# Verify bundles exist
|
||||
if [ ! "$(ls -A dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }})" ]; then
|
||||
echo "❌ ERROR: No bundles found"
|
||||
echo "This likely means 'npm run bundle' failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Count and display bundles per module
|
||||
for module in bmm bmb cis bmgd; do
|
||||
if [ -d "dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}/$module/agents" ]; then
|
||||
COUNT=$(find dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}/$module/agents -name '*.xml' 2>/dev/null | wc -l)
|
||||
echo "✅ $module: $COUNT agents"
|
||||
fi
|
||||
done
|
||||
|
||||
# Create archive
|
||||
tar -czf dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }}.tar.gz \
|
||||
-C dist/release-bundles/bmad-bundles-v${{ steps.version.outputs.new_version }} .
|
||||
# TODO: Re-enable web bundles once tools/cli/bundlers/ is restored
|
||||
# - name: Generate web bundles
|
||||
# run: npm run bundle
|
||||
|
||||
- name: Commit version bump
|
||||
run: |
|
||||
@@ -185,25 +166,15 @@ jobs:
|
||||
npm publish --tag latest
|
||||
fi
|
||||
|
||||
- name: Create GitHub Release with Bundles
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: v${{ steps.version.outputs.new_version }}
|
||||
name: "BMad Method v${{ steps.version.outputs.new_version }}"
|
||||
body: |
|
||||
${{ steps.release_notes.outputs.RELEASE_NOTES }}
|
||||
|
||||
## 📦 Web Bundles
|
||||
|
||||
Download XML bundles for use in AI platforms (Claude Projects, ChatGPT, Gemini):
|
||||
|
||||
- `bmad-bundles-v${{ steps.version.outputs.new_version }}.tar.gz` - All modules (BMM, BMB, CIS, BMGD)
|
||||
|
||||
**Browse online** (bleeding edge): https://bmad-code-org.github.io/bmad-bundles/
|
||||
draft: false
|
||||
prerelease: ${{ contains(steps.version.outputs.new_version, 'alpha') || contains(steps.version.outputs.new_version, 'beta') }}
|
||||
files: |
|
||||
dist/release-bundles/*.tar.gz
|
||||
|
||||
- name: Summary
|
||||
run: |
|
||||
@@ -212,7 +183,6 @@ jobs:
|
||||
echo "### 📦 Distribution" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **NPM**: Published with @latest tag" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **GitHub Release**: https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v${{ steps.version.outputs.new_version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Web Bundles**: Attached to GitHub Release (4 archives)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### ✅ Installation" >> $GITHUB_STEP_SUMMARY
|
||||
echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
3
.github/workflows/quality.yaml
vendored
3
.github/workflows/quality.yaml
vendored
@@ -92,6 +92,3 @@ jobs:
|
||||
|
||||
- name: Test agent compilation components
|
||||
run: npm run test:install
|
||||
|
||||
- name: Validate web bundles
|
||||
run: npm run validate:bundles
|
||||
|
||||
17
.gitignore
vendored
17
.gitignore
vendored
@@ -31,7 +31,7 @@ Thumbs.db
|
||||
# IDE and editor configs
|
||||
.windsurf/
|
||||
.trae/
|
||||
.bmad*/.cursor/
|
||||
_bmad*/.cursor/
|
||||
|
||||
# AI assistant files
|
||||
CLAUDE.md
|
||||
@@ -44,10 +44,8 @@ CLAUDE.local.md
|
||||
.claude/settings.local.json
|
||||
|
||||
# Project-specific
|
||||
.bmad-core
|
||||
.bmad-creator-tools
|
||||
test-project-install/*
|
||||
sample-project/*
|
||||
_bmad-core
|
||||
_bmad-creator-tools
|
||||
flattened-codebase.xml
|
||||
*.stats.md
|
||||
.internal-docs/
|
||||
@@ -65,7 +63,8 @@ src/modules/bmgd/sub-modules/
|
||||
shared-modules
|
||||
z*/
|
||||
|
||||
.bmad
|
||||
_bmad
|
||||
_bmad-output
|
||||
.claude
|
||||
.codex
|
||||
.github/chatmodes
|
||||
@@ -74,4 +73,8 @@ z*/
|
||||
.kiro/
|
||||
.roo
|
||||
|
||||
bmad-custom-src/
|
||||
bmad-custom-src/
|
||||
|
||||
# Docusaurus / Documentation Build
|
||||
.docusaurus/
|
||||
build/
|
||||
|
||||
@@ -5,8 +5,8 @@ ignores:
|
||||
- node_modules/**
|
||||
- test/fixtures/**
|
||||
- CODE_OF_CONDUCT.md
|
||||
- .bmad/**
|
||||
- .bmad*/**
|
||||
- _bmad/**
|
||||
- _bmad*/**
|
||||
- .agent/**
|
||||
- .claude/**
|
||||
- .roo/**
|
||||
|
||||
@@ -5,5 +5,5 @@ test/fixtures/**
|
||||
CODE_OF_CONDUCT.md
|
||||
|
||||
# BMAD runtime folders (user-specific, not in repo)
|
||||
.bmad/
|
||||
.bmad*/
|
||||
_bmad/
|
||||
_bmad*/
|
||||
|
||||
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@@ -57,6 +57,7 @@
|
||||
"tileset",
|
||||
"tmpl",
|
||||
"Trae",
|
||||
"Unsharded",
|
||||
"VNET",
|
||||
"webskip"
|
||||
],
|
||||
@@ -73,7 +74,7 @@
|
||||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"[javascript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "vscode.typescript-language-features"
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "vscode.json-language-features"
|
||||
|
||||
1163
CHANGELOG.md
1163
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@@ -236,10 +236,8 @@ Each commit should represent one logical change:
|
||||
3. **Don't paste code in issues** - create a proper PR instead
|
||||
4. **Don't submit your whole project** - contribute specific improvements
|
||||
|
||||
## Code Style
|
||||
## Prompt & Agent Guidelines
|
||||
|
||||
- Follow the existing code style and conventions
|
||||
- Write clear comments for complex logic
|
||||
- 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
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -21,6 +21,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
TRADEMARK NOTICE:
|
||||
BMAD™, BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
||||
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
||||
trademarks in this software does not grant any rights to use the trademarks
|
||||
for any other purpose.
|
||||
|
||||
101
README.md
101
README.md
@@ -6,9 +6,37 @@
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
|
||||
|
||||
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!
|
||||
|
||||
**✨ What's New:**
|
||||
|
||||
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
|
||||
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
|
||||
- 🔄 **Unitary Module Support** - Install individual components without full modules
|
||||
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
|
||||
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
|
||||
|
||||
**📚 Learn More:**
|
||||
|
||||
- [**Custom Content Overview**](docs/modules/bmb-bmad-builder/custom-content.md) - Discover all supported content types
|
||||
- [**Installation Guide**](docs/modules/bmb-bmad-builder/custom-content-installation.md) - 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 **19 specialized AI agents** and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms.
|
||||
**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)
|
||||
|
||||
@@ -39,7 +67,7 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
||||
## 📊 See It In Action
|
||||
|
||||
<p align="center">
|
||||
<img src="./src/modules/bmm/docs/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||
<img src="./docs/modules/bmm-bmad-method/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -51,13 +79,18 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
||||
### 1. Install BMad Method
|
||||
|
||||
```bash
|
||||
# Install v6 Alpha (recommended)
|
||||
# Install v6 RECOMMENDED
|
||||
npx bmad-method@alpha install
|
||||
|
||||
# Or stable v4 for production
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
```bash
|
||||
# Install v4 Legacy (not recommended if starting fresh)
|
||||
npx bmad-method install
|
||||
# OR
|
||||
npx bmad-method@latest install
|
||||
```
|
||||
|
||||
|
||||
### 2. Initialize Your Project
|
||||
|
||||
Load any agent in your IDE and run:
|
||||
@@ -72,8 +105,8 @@ This analyzes your project and recommends the right workflow track.
|
||||
|
||||
BMad Method adapts to your needs with three intelligent tracks:
|
||||
|
||||
| Track | Use For | Planning | Time to Start |
|
||||
| ------------------ | ------------------------- | ----------------------- | ------------- |
|
||||
| Track | Use For | Planning | Time to Start |
|
||||
| ----------------- | ------------------------- | ----------------------- | ------------- |
|
||||
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
|
||||
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
|
||||
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
|
||||
@@ -95,36 +128,35 @@ Each phase has specialized workflows and agents working together to deliver exce
|
||||
|
||||
**12 Specialized Agents** working in concert:
|
||||
|
||||
| Development | Architecture | Product | Leadership |
|
||||
| ----------- | -------------- | ------------- | -------------- |
|
||||
| Developer | Architect | PM | Scrum Master |
|
||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
||||
| Tech Writer | Game Architect | Game Designer | Game Developer |
|
||||
| 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 fixture-based utilities.
|
||||
**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
|
||||
|
||||
### Core Modules
|
||||
### Official Modules
|
||||
|
||||
- **BMad Method (BMM)** - Complete agile development framework
|
||||
- 12 specialized agents
|
||||
- 34 workflows across 4 phases
|
||||
- Scale-adaptive planning
|
||||
- [→ Documentation Hub](./src/modules/bmm/docs/README.md)
|
||||
- Stand Along Quick Spec Flow for a streamlined simple implementation process
|
||||
- [→ Documentation Hub](./docs/modules/bmm-bmad-method/index.md)
|
||||
|
||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||
- Build anything from simple agents to complex modules
|
||||
- Create domain-specific solutions (legal, medical, finance, education)
|
||||
- Share your creations in the upcoming community marketplace
|
||||
- [→ Builder Guide](./src/modules/bmb/README.md)
|
||||
- [→ Builder Guide](./docs/modules/bmb-bmad-builder/index.md)
|
||||
|
||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||
- Brainstorming, design thinking, storytelling
|
||||
- 5 creative facilitation workflows
|
||||
- [→ Creative Workflows](./src/modules/cis/README.md)
|
||||
- [→ Creative Workflows](./docs/modules/cis-creative-intelligence-suite/index.md)
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -138,14 +170,14 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
||||
|
||||
### Quick Links
|
||||
|
||||
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](./src/modules/bmm/docs/README.md)** - All guides and references
|
||||
- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
|
||||
- **[Quick Start Guide](./docs/modules/bmm-bmad-method/quick-start.md)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](./docs/modules/bmm-bmad-method/index.md)** - All guides and references
|
||||
- **[Agent Customization](docs/bmad-customization/agent-customization-guide.md)** - Personalize your agents
|
||||
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
||||
|
||||
### For v4 Users
|
||||
|
||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
|
||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
||||
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
|
||||
|
||||
## 💬 Community & Support
|
||||
@@ -153,23 +185,12 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
|
||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
|
||||
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
For contributors working on the BMad codebase:
|
||||
|
||||
```bash
|
||||
# Run all quality checks
|
||||
npm test
|
||||
|
||||
# Development commands
|
||||
npm run lint:fix # Fix code style
|
||||
npm run format:fix # Auto-format code
|
||||
npm run bundle # Build web bundles
|
||||
```
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
|
||||
## What's New in v6
|
||||
|
||||
@@ -199,7 +220,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
|
||||
MIT License - See [LICENSE](LICENSE) for details.
|
||||
|
||||
**Trademarks:** BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
|
||||
**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>
|
||||
|
||||
---
|
||||
|
||||
|
||||
93
docs/bmad-core-concepts/agents.md
Normal file
93
docs/bmad-core-concepts/agents.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Agents
|
||||
|
||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
||||
|
||||
## Agent Types
|
||||
|
||||
BMAD has two primary agent types, designed for different use cases:
|
||||
|
||||
### Simple Agents
|
||||
|
||||
**Self-contained, focused, ready to use.**
|
||||
|
||||
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
|
||||
|
||||
**Best for:**
|
||||
- Single-purpose assistants (code review, documentation, commit messages)
|
||||
- Quick deployment
|
||||
- Projects that don't require persistent memory
|
||||
- Getting started fast
|
||||
|
||||
**Example:** A commit message agent that reads your git diff and generates conventional commits.
|
||||
|
||||
### Expert Agents
|
||||
|
||||
**Powerful, memory-equipped, domain specialists.**
|
||||
|
||||
Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
|
||||
|
||||
**Best for:**
|
||||
- Domain specialists (security architect, game designer, product manager)
|
||||
- Tasks requiring persistent memory
|
||||
- Complex workflows with multiple stages
|
||||
- Projects that grow over time
|
||||
|
||||
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
|
||||
|
||||
## Key Differences
|
||||
|
||||
| Feature | Simple | Expert |
|
||||
| ---------------- | -------------- | -------------------------- |
|
||||
| **Files** | Single file | Agent + sidecar folder |
|
||||
| **Memory** | Session only | Persistent across sessions |
|
||||
| **Capabilities** | Focused scope | Multi-domain, extensible |
|
||||
| **Setup** | Zero config | Sidecar initialization |
|
||||
| **Best Use** | Specific tasks | Ongoing projects |
|
||||
|
||||
## Agent Components
|
||||
|
||||
All agents share these building blocks:
|
||||
|
||||
### Persona
|
||||
- **Role** - What the agent does (expertise domain)
|
||||
- **Identity** - Who the agent is (personality, character)
|
||||
- **Communication Style** - How the agent speaks (tone, voice)
|
||||
- **Principles** - Why the agent acts (values, decision framework)
|
||||
|
||||
### Capabilities
|
||||
- Skills, tools, and knowledge the agent can apply
|
||||
- Mapped to specific menu commands
|
||||
|
||||
### Menu
|
||||
- Interactive command list
|
||||
- Triggers, descriptions, and handlers
|
||||
- Auto-includes help and exit options
|
||||
|
||||
### Critical Actions (optional)
|
||||
- Instructions that execute before the agent starts
|
||||
- Enable autonomous behaviors (e.g., "check git status before changes")
|
||||
|
||||
## Which Should You Use?
|
||||
|
||||
**Choose Simple when:**
|
||||
- You need a task done quickly and reliably
|
||||
- The scope is well-defined and won't change much
|
||||
- You don't need the agent to remember things between sessions
|
||||
|
||||
**Choose Expert when:**
|
||||
- You're building something complex over time
|
||||
- The agent needs to maintain context (project history, decisions)
|
||||
- You want the agent to coordinate workflows or other agents
|
||||
- Domain expertise requires specialized knowledge bases
|
||||
|
||||
## Creating Custom Agents
|
||||
|
||||
BMAD provides the **BMAD Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](../modules/bmb-bmad-builder/agent-creation-guide.md) for step-by-step instructions.
|
||||
|
||||
## Customizing Existing Agents
|
||||
|
||||
You can modify any agent's behavior without editing core files. See [BMAD Customization](./bmad-customization/) 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](./workflows.md) to see how agents accomplish complex tasks.
|
||||
@@ -9,7 +9,7 @@ Customize BMad agents without modifying core files. All customizations persist t
|
||||
After installation, find agent customization files in:
|
||||
|
||||
```
|
||||
{bmad_folder}/_cfg/agents/
|
||||
_bmad/_config/agents/
|
||||
├── core-bmad-master.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
├── bmm-pm.customize.yaml
|
||||
@@ -81,7 +81,7 @@ Add your own workflows to the agent's menu:
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: '{project-root}/custom/my-workflow.yaml'
|
||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||
description: My custom workflow
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
@@ -119,7 +119,7 @@ prompts:
|
||||
**Example 1: Customize Developer Agent for TDD**
|
||||
|
||||
```yaml
|
||||
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
|
||||
# _bmad/_config/agents/bmm-dev.customize.yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'TDD Developer'
|
||||
@@ -135,20 +135,20 @@ critical_actions:
|
||||
**Example 2: Add Custom Deployment Workflow**
|
||||
|
||||
```yaml
|
||||
# {bmad_folder}/_cfg/agents/bmm-dev.customize.yaml
|
||||
# _bmad/_config/agents/bmm-dev.customize.yaml
|
||||
menu:
|
||||
- trigger: deploy-staging
|
||||
workflow: '{project-root}/{bmad_folder}/deploy-staging.yaml'
|
||||
workflow: '{project-root}/_bmad/deploy-staging.yaml'
|
||||
description: Deploy to staging environment
|
||||
- trigger: deploy-prod
|
||||
workflow: '{project-root}/{bmad_folder}/deploy-prod.yaml'
|
||||
workflow: '{project-root}/_bmad/deploy-prod.yaml'
|
||||
description: Deploy to production (with approval)
|
||||
```
|
||||
|
||||
**Example 3: Multilingual Product Manager**
|
||||
|
||||
```yaml
|
||||
# {bmad_folder}/_cfg/agents/bmm-pm.customize.yaml
|
||||
# _bmad/_config/agents/bmm-pm.customize.yaml
|
||||
persona:
|
||||
role: 'Bilingual Product Manager'
|
||||
identity: 'Expert in US and LATAM markets'
|
||||
@@ -166,15 +166,15 @@ memories:
|
||||
|
||||
- **Start Small:** Customize one section at a time and rebuild to test
|
||||
- **Backup:** Copy customization files before major changes
|
||||
- **Update-Safe:** Your customizations in `_cfg/` survive all BMad updates
|
||||
- **Update-Safe:** Your customizations in `_config/` survive all BMad updates
|
||||
- **Per-Project:** Customization files are per-project, not global
|
||||
- **Version Control:** Consider committing `_cfg/` to share customizations with your team
|
||||
- **Version Control:** Consider committing `_config/` to share customizations with your team
|
||||
|
||||
## Module vs. Global Config
|
||||
|
||||
**Module-Level (Recommended):**
|
||||
|
||||
- Customize agents per-project in `{bmad_folder}/_cfg/agents/`
|
||||
- Customize agents per-project in `_bmad/_config/agents/`
|
||||
- Different projects can have different agent behaviors
|
||||
|
||||
**Global Config (Coming Soon):**
|
||||
@@ -203,6 +203,8 @@ memories:
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about all 12 BMad Method agents
|
||||
- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference
|
||||
- **[Learn about Agents](../agents.md)** - Understand Simple vs Expert agents
|
||||
- **[Agent Creation Guide](../../modules/bmb-bmad-builder/agent-creation-guide.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../../modules/bmm-bmad-method/index)** - Full BMad Method reference
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
26
docs/bmad-core-concepts/bmad-customization/index.md
Normal file
26
docs/bmad-core-concepts/bmad-customization/index.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# BMAD Customization
|
||||
|
||||
Personalize agents and workflows to match your needs.
|
||||
|
||||
## Guides
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| **[Agent Customization](./agents.md)** | Modify agent behavior without editing core files |
|
||||
| **[Workflow Customization](./workflows.md)** | Customize and optimize workflows |
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD provides two main customization approaches:
|
||||
|
||||
### Agent Customization
|
||||
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
||||
|
||||
### Workflow Customization
|
||||
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agent Customization Guide](./agents.md) to start personalizing your agents.
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
30
docs/bmad-core-concepts/bmad-customization/workflows.md
Normal file
30
docs/bmad-core-concepts/bmad-customization/workflows.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Workflow Customization Guide
|
||||
|
||||
Customize and optimize workflows with step replacement and hooks.
|
||||
|
||||
## Status
|
||||
|
||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
||||
|
||||
## What to Expect
|
||||
|
||||
Workflow customization will allow you to:
|
||||
|
||||
- **Replace Steps** - Swap out specific workflow steps with custom implementations
|
||||
- **Add Hooks** - Inject custom behavior before/after workflow steps
|
||||
- **Extend Workflows** - Create new workflows based on existing ones
|
||||
- **Override Behavior** - Customize workflow logic for your project's needs
|
||||
|
||||
## For Now
|
||||
|
||||
While workflow customization is in development, you can:
|
||||
|
||||
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
|
||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](./agents.md)
|
||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
||||
|
||||
---
|
||||
|
||||
**In the meantime:** Learn how to [create custom workflows](../../modules/bmb-bmad-builder/index) from scratch.
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
37
docs/bmad-core-concepts/index.md
Normal file
37
docs/bmad-core-concepts/index.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# 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](./agents.md) |
|
||||
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](./workflows.md) |
|
||||
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](./modules.md) |
|
||||
|
||||
## Getting Started
|
||||
|
||||
### New to BMAD?
|
||||
Start here to understand what BMAD is and how it works:
|
||||
|
||||
1. **[Agents Guide](./agents.md)** - Learn about Simple and Expert agents
|
||||
2. **[Workflows Guide](./workflows.md)** - Understand how workflows orchestrate tasks
|
||||
3. **[Modules Guide](./modules.md)** - See how modules organize functionality
|
||||
|
||||
### Installing BMAD
|
||||
|
||||
- **[Installation Guide](./installing/)** - Set up BMAD in your project
|
||||
- **[Upgrading from v4](./installing/upgrading.md)** - Migrate from earlier versions
|
||||
|
||||
### Configuration
|
||||
|
||||
- **[BMAD Customization](./bmad-customization/)** - Personalize agents and workflows
|
||||
|
||||
### Advanced
|
||||
|
||||
- **[Web Bundles](./web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agents Guide](./agents.md) to understand the core building block of BMAD.
|
||||
77
docs/bmad-core-concepts/installing/index.md
Normal file
77
docs/bmad-core-concepts/installing/index.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Installation
|
||||
|
||||
Get BMAD up and running in your project.
|
||||
|
||||
## Upgrading?
|
||||
|
||||
If you're upgrading from v4, see the [Upgrade Guide](./upgrading.md).
|
||||
|
||||
---
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
This interactive installer will:
|
||||
|
||||
1. Let you choose a location to install to
|
||||
2. Let you choose which Agentic LLM Tools you would like to use (Such as Claude Code, Cursor, Windsurf, etc...)
|
||||
3. Let you choose which official modules to install (BMad Method, Creative Intelligence suite, BMad Builder)
|
||||
4. Let you choose any custom local modules, workflows or agents to install
|
||||
5. Let you configure each module or quickly accept the default recommended settings for each selected model
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Node.js** 20+ (for the installer)
|
||||
- **Git** (recommended for version control)
|
||||
- An **AI-powered Agent and/or IDE** or access to Claude/ChatGPT/Gemini
|
||||
|
||||
## Module Options
|
||||
|
||||
During installation, you'll choose which modules to install:
|
||||
|
||||
| Module | Description | Best For |
|
||||
| -------- | -------------------- | ----------------------------------------------------- |
|
||||
| **BMM** | BMAD Method Core | Software development projects |
|
||||
| **BMGD** | Game Development | Game projects with specialized workflows |
|
||||
| **CIS** | Creative Intel Suite | Creativity Unlocking Suite, not software dev specific |
|
||||
| **BMB** | Builder | Creating custom agents and workflows |
|
||||
|
||||
You will also be asked if you would like to install custom content (agents, workflows or modules) you have created with the BMB, or shared from others in the community.
|
||||
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMAD configuration and agents
|
||||
│ ├── bmm/ # Method module (if installed)
|
||||
│ ├── bmgd/ # Game dev module (if installed)
|
||||
│ ├── core/ # Always installed, includes party mode, advanced elicitation, and other core generic utils
|
||||
│ ├── {others}/ # etc...
|
||||
├── _bmad-output/ # BMAD default output folder - configurable during install
|
||||
├── .claude/ # IDE-specific setup (varies by IDE)
|
||||
└── ... your code # maybe nothing else yet if a fresh new folder
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Read the [Quick Start Guide](../../modules/bmm-bmad-method/quick-start)** to build your first feature
|
||||
2. **Explore [Workflows](../../modules/bmm-bmad-method/index#-workflow-guides)** to understand the methodology
|
||||
3. **Learn about [Agents](../agents.md)** to understand BMAD's core building blocks
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**"Command not found: npx"**
|
||||
: Install Node.js 20+ from [nodejs.org](https://nodejs.org)
|
||||
|
||||
**"Permission denied"**
|
||||
: Run with appropriate permissions or check your npm configuration
|
||||
|
||||
For more help, join our [Discord](https://discord.gg/bmad).
|
||||
144
docs/bmad-core-concepts/installing/upgrading.md
Normal file
144
docs/bmad-core-concepts/installing/upgrading.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# BMad v4 to v6 Upgrade Guide
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
|
||||
---
|
||||
|
||||
## Automatic V4 Detection
|
||||
|
||||
When you run `npm run install:bmad` on a project, the installer automatically detects:
|
||||
|
||||
- **Legacy v4 installation folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Detection of v4 Modules**
|
||||
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
|
||||
- NOTE: if the upgrade and install of v6 finished, the new commands will be under `.claude/commands/bmad/<module>/agents|workflows`
|
||||
- Note 2: If you accidentally delete the wrong/new bmad commands - you can easily restore them by rerunning the installer, and choose quick update option, and all will be reapplied properly.
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules from v4
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ---------------------------------------------- |
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-godot-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-*-game-dev` (any) | Integrated into new BMGD Module |
|
||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
|
||||
|
||||
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
### Folder Structure
|
||||
|
||||
**v4 "Expansion Packs" Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .bmad-method/
|
||||
├── .bmad-game-dev/
|
||||
├── .bmad-creative-writing/
|
||||
└── .bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder is _bmad
|
||||
└── _config/ # Your customizations
|
||||
| └── agents/ # Agent customization files
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
├── _bmad_output # Default bmad output folder (was doc folder in v4)
|
||||
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
|
||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
|
||||
|
||||
## Project Progress Migration
|
||||
|
||||
### If You've Completed Some or all Planning Phases (Brief/PRD/UX/Architecture) with the BMad Method:
|
||||
|
||||
After running the v6 installer, if you kept the paths the same as the installation suggested, you will need to move a few files, or run the installer again. It is recommended to stick with these defaults as it will be easier to adapt if things change in the future.
|
||||
|
||||
If you have any planning artifacts, put them in a folder called _bmad-output/planning-artifacts at the root of your project, ensuring that:
|
||||
PRD has PRD in the file name or folder name if sharded.
|
||||
Similar for 'brief', 'architecture', 'ux-design'.
|
||||
|
||||
If you have other long term docs that will not be as ephemeral as these project docs, you can put them in the /docs folder, ideally with a index.md file.
|
||||
|
||||
HIGHLY RECOMMENDED NOTE: If you are only partway through planning, its highly recommended to restart and do the PRD, UX and ARCHITECTURE steps. You could even use your existing documents as inputs letting the agent know you want to redo them with the new workflows. These optimized v6 progressive discovery workflows that also will utilize web search at key moments, while offering better advanced elicitation and part mode in the IDE will produce superior results. And then once all are complete, an epics with stories is generated after the architecture step now - ensuring it uses input from all planing documents.
|
||||
|
||||
### If You're Mid-Development (Stories Created/Implemented)
|
||||
|
||||
1. Complete the v6 installation as above
|
||||
2. Ensure you have a file called epics.md or epics/epic*.md - these need to be located under the _bmad-output/planning-artifacts folder.
|
||||
3. Run the scrum masters `sprint-planning` workflow to generate the implementation tracking plan in _bmad-output/implementation-artifacts.
|
||||
4. Inform the SM after the output is complete which epics and stories were completed already and should be parked properly in the file.
|
||||
|
||||
## Agent Customization Migration
|
||||
|
||||
### v4 Agent Customization
|
||||
|
||||
In v4, you may have modified agent files directly in `_bmad-*` folders.
|
||||
|
||||
### v6 Agent Customization
|
||||
|
||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
persona:
|
||||
name: 'Captain Jack' # Override agent name
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors for software concepts
|
||||
- Always upbeat and adventurous
|
||||
```
|
||||
|
||||
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](../bmad-customization/agents.md)
|
||||
|
||||
CRITICAL NOTE: After you modify the customization file, you need to run the npx installer against your installed location, and choose the option to rebuild all agents, or just do a quick update again. This always builds agents fresh and applies customizations.
|
||||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
||||
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
- Rebuild all agents -> Result: Agent uses your custom name and style
|
||||
|
||||
## Document Compatibility
|
||||
|
||||
### Sharded vs Unsharded Documents
|
||||
|
||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
||||
|
||||
- ✅ Sharded documents (split into multiple files)
|
||||
- ✅ Unsharded documents (single file per section)
|
||||
- ✅ Custom sections for your project type
|
||||
- ✅ Mixed approaches
|
||||
|
||||
All workflow files are scanned automatically. No manual configuration needed.
|
||||
76
docs/bmad-core-concepts/modules.md
Normal file
76
docs/bmad-core-concepts/modules.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Modules
|
||||
|
||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
||||
|
||||
## What is a Module?
|
||||
|
||||
A module is a self-contained package that includes:
|
||||
|
||||
- **Agents** - Specialized AI assistants
|
||||
- **Workflows** - Step-by-step processes
|
||||
- **Configuration** - Module-specific settings
|
||||
- **Documentation** - Usage guides and reference
|
||||
|
||||
## Official Modules
|
||||
|
||||
### Core Module
|
||||
Always installed, provides shared functionality:
|
||||
- Global configuration
|
||||
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
||||
- Common tasks (document indexing, sharding, review)
|
||||
|
||||
### BMAD Method (BMM)
|
||||
Software and game development:
|
||||
- Project planning workflows
|
||||
- Implementation agents (Dev, PM, QA, Scrum Master)
|
||||
- Testing and architecture guidance
|
||||
|
||||
### BMAD Builder (BMB)
|
||||
Create custom solutions:
|
||||
- Agent creation workflows
|
||||
- Workflow authoring tools
|
||||
- Module scaffolding
|
||||
|
||||
### Creative Intelligence Suite (CIS)
|
||||
Innovation and creativity:
|
||||
- Creative thinking techniques
|
||||
- Innovation strategy workflows
|
||||
- Storytelling and ideation
|
||||
|
||||
### BMAD Game Dev (BMGD)
|
||||
Game development specialization:
|
||||
- Game design workflows
|
||||
- Narrative development
|
||||
- Performance testing frameworks
|
||||
|
||||
## Module Structure
|
||||
|
||||
Installed modules follow this structure:
|
||||
|
||||
```
|
||||
_bmad/
|
||||
├── core/ # Always present
|
||||
├── bmm/ # BMAD Method (if installed)
|
||||
├── bmb/ # BMAD Builder (if installed)
|
||||
├── cis/ # Creative Intelligence (if installed)
|
||||
└── bmgd/ # Game Dev (if installed)
|
||||
```
|
||||
|
||||
## Custom Modules
|
||||
|
||||
You can create your own modules containing:
|
||||
- Custom agents for your domain
|
||||
- Organizational workflows
|
||||
- Team-specific configurations
|
||||
|
||||
Custom modules are installed the same way as official modules.
|
||||
|
||||
## Installing Modules
|
||||
|
||||
During BMAD installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
||||
|
||||
See [Installation Guide](./installing/) for details.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Installation Guide](./installing/) to set up BMAD with the modules you need.
|
||||
34
docs/bmad-core-concepts/web-bundles/index.md
Normal file
34
docs/bmad-core-concepts/web-bundles/index.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Web Bundles
|
||||
|
||||
Use BMAD agents in Gemini Gems and Custom GPTs.
|
||||
|
||||
## Status
|
||||
|
||||
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
||||
Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload.
|
||||
|
||||
### What's Included
|
||||
|
||||
- Complete agent persona and instructions
|
||||
- All workflows and dependencies
|
||||
- Interactive menu system
|
||||
- Party mode for multi-agent collaboration
|
||||
- No external files required
|
||||
|
||||
### Use Cases
|
||||
|
||||
**Perfect for:**
|
||||
- Uploading a single file to a Gemini GEM or Custom GPT
|
||||
- Using BMAD Method from the Web
|
||||
- Cost savings (generally lower cost than local usage)
|
||||
- Quick sharing of agent configurations
|
||||
|
||||
**Trade-offs:**
|
||||
- Some quality reduction vs local usage
|
||||
- Less convenient than full local installation
|
||||
- Limited to agent capabilities (no workflow file access)
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
89
docs/bmad-core-concepts/workflows.md
Normal file
89
docs/bmad-core-concepts/workflows.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Workflows
|
||||
|
||||
Workflows are structured processes that guide agents through complex tasks. Think of them as recipes that ensure consistent, high-quality outcomes.
|
||||
|
||||
## What is a Workflow?
|
||||
|
||||
A workflow is a step-by-step process that agents follow to accomplish specific objectives. A workflow can be a single file if small enough, but more than likely is comprized of a very small workflow or skill definition file with multiple steps and data files that are loaded as needed on demand. Each step file:
|
||||
|
||||
- Defines a clear goal
|
||||
- Provides instructions for the agent
|
||||
- May include decision points or user interactions
|
||||
- Produces specific outputs
|
||||
- Progressively at a specific point can load the next proper step.
|
||||
|
||||
## How Workflows Work
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Step 1 │ → │ Step 2 │ → │ Step 3 │ → │ Complete │
|
||||
│ Discover │ │ Define │ │ Build │ │ Output │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Key characteristics:**
|
||||
- **Progressive** - Each step builds on the previous
|
||||
- **Interactive** - Workflows can pause for user input
|
||||
- **Reusable** - The same workflow produces consistent results
|
||||
- **Composable** - Workflow steps can call other workflow steps, or whole other workflows!
|
||||
- **LLM Reinforcement** - Some rules or info is repeated in each step file ensuring certain rules are always top of agent mind, even during context heavy processes or very long workflows!
|
||||
|
||||
## Workflow Types
|
||||
|
||||
### Planning Workflows
|
||||
|
||||
Generate project artifacts like requirements, architecture, and task breakdowns.
|
||||
|
||||
**Examples:** Brief creation, PRD authoring, architecture design, sprint planning
|
||||
|
||||
### Execution Workflows
|
||||
|
||||
Guide implementation of specific tasks or features.
|
||||
|
||||
**Examples:** Code implementation, code review, testing, deployment
|
||||
|
||||
### Support Workflows
|
||||
|
||||
Handle cross-cutting concerns and creative processes.
|
||||
|
||||
**Examples:** Brainstorming, retrospectives, root cause analysis
|
||||
|
||||
## Progressive Disclosure
|
||||
|
||||
BMAD workflows use **progressive disclosure** - each step only knows about its immediate next step and what it is currently meant to do. This:
|
||||
|
||||
- Reduces cognitive load on the AI
|
||||
- Ensures each step gets full attention
|
||||
- Allows for conditional routing based on previous outcomes
|
||||
- Makes workflows easier to debug and modify
|
||||
|
||||
## Menu-Driven Interaction
|
||||
|
||||
Most workflows use interactive menus with standard options:
|
||||
|
||||
| Option | Purpose |
|
||||
| ---------------- | -------------------------------------------------- |
|
||||
| **[A] Advanced** | Invoke deeper reasoning techniques |
|
||||
| **[P] Party** | Get multiple agent perspectives |
|
||||
| **[C] Continue** | Proceed to next step after all writes are complete |
|
||||
|
||||
## Workflow Files
|
||||
|
||||
Workflows are markdown files with structured frontmatter - this front matter also allows them to easily work as skills and also slash command loaded:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: 'my-workflow'
|
||||
description: 'What this workflow does and when it should be used or loaded automatically (or call out if it should be requested to run explicitly by the user)'
|
||||
---
|
||||
```
|
||||
|
||||
The content in the workflow file is very minimal, sets up the reinforcement of the agent persona and reminder that it is a facilitator working with a user, lays out rules of processing steps only when told to do a specific step, loads all config file variables needed by the workflow, and then routes to step 1. No other info about other steps should be in this workflow file. Keeping it as small and lean as possible help in compilation as a skill, as overall size of the skill main file (workflow.md) is critical to keep small.
|
||||
|
||||
## Creating Custom Workflows
|
||||
|
||||
The **BMAD Builder (BMB)** module includes workflows for creating custom workflows. See [BMB Documentation](../modules/bmb-bmad-builder/) for details.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Learn about [Modules](./modules.md) to see how agents and workflows are organized.
|
||||
@@ -1,137 +0,0 @@
|
||||
# Custom Agent Installation
|
||||
|
||||
BMAD agents and workflows are now installed through the main CLI installer using a `custom.yaml` configuration file or by having an installer file.
|
||||
|
||||
## Quick Start
|
||||
|
||||
Create a `custom.yaml` file in the root of your agent/workflow folder:
|
||||
|
||||
```yaml
|
||||
code: my-custom-agent
|
||||
name: 'My Custom Agent'
|
||||
default_selected: true
|
||||
```
|
||||
|
||||
Then run the BMAD installer from your project directory:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
Or if you have bmad-cli installed globally:
|
||||
|
||||
```bash
|
||||
bmad install
|
||||
```
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: Stand-alone Folder with custom.yaml
|
||||
|
||||
Place your agent or workflow in a folder with a `custom.yaml` file at the root:
|
||||
|
||||
```
|
||||
my-agent/
|
||||
├── custom.yaml # Required configuration file
|
||||
├── my-agent.agent.yaml
|
||||
└── sidecar/ # Optional
|
||||
└── instructions.md
|
||||
```
|
||||
|
||||
### Method 2: Installer File
|
||||
|
||||
For more complex installations, include an `installer.js` or `installer.yaml` file in your agent/workflow folder:
|
||||
|
||||
```
|
||||
my-workflow/
|
||||
├── workflow.md
|
||||
└── installer.yaml # Custom installation logic
|
||||
```
|
||||
|
||||
## What It Does
|
||||
|
||||
1. **Discovers** available agents and workflows from folders with `custom.yaml`
|
||||
2. **Installs** to your project's `.bmad/custom/` directory
|
||||
3. **Creates** IDE commands for all your configured IDEs (Claude Code, Codex, Cursor, etc.)
|
||||
4. **Registers** the agent/workflow in the BMAD system
|
||||
|
||||
## Example custom.yaml
|
||||
|
||||
```yaml
|
||||
code: my-custom-agent
|
||||
name: 'My Custom Agent'
|
||||
default_selected: true
|
||||
```
|
||||
|
||||
## Installing Reference Agents
|
||||
|
||||
The BMAD source includes example agents you can install. **You must copy them to your project first.**
|
||||
|
||||
### Step 1: Copy the Agent Template
|
||||
|
||||
**For simple agents** (single file):
|
||||
|
||||
```bash
|
||||
# From your project root
|
||||
mkdir -p .bmad/custom/agents/my-agent
|
||||
cp node_modules/bmad-method/src/modules/bmb/reference/agents/stand-alone/commit-poet.agent.yaml \
|
||||
.bmad/custom/agents/my-agent/
|
||||
```
|
||||
|
||||
**For expert agents** (folder with sidecar files):
|
||||
|
||||
```bash
|
||||
# Copy the entire folder
|
||||
cp -r node_modules/bmad-method/src/modules/bmb/reference/agents/agent-with-memory/journal-keeper \
|
||||
.bmad/custom/agents/
|
||||
```
|
||||
|
||||
### Step 2: Create custom.yaml
|
||||
|
||||
```bash
|
||||
# In the agent folder, create custom.yaml
|
||||
cat > .bmad/custom/agents/my-agent/custom.yaml << EOF
|
||||
code: my-agent
|
||||
name: "My Custom Agent"
|
||||
default_selected: true
|
||||
EOF
|
||||
```
|
||||
|
||||
### Step 3: Install
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# or: bmad install (if BMAD installed locally)
|
||||
```
|
||||
|
||||
The installer will:
|
||||
|
||||
1. Find the agent with its `custom.yaml`
|
||||
2. Install it to the appropriate location
|
||||
3. Create IDE commands for immediate use
|
||||
|
||||
### Available Reference Agents
|
||||
|
||||
**Simple (standalone file):**
|
||||
|
||||
- `commit-poet.agent.yaml` - Commit message artisan with style preferences
|
||||
|
||||
**Expert (folder with sidecar):**
|
||||
|
||||
- `journal-keeper/` - Personal journal companion with memory and pattern recognition
|
||||
|
||||
Find these in the BMAD source:
|
||||
|
||||
```
|
||||
src/modules/bmb/reference/agents/
|
||||
├── stand-alone/
|
||||
│ └── commit-poet.agent.yaml
|
||||
└── agent-with-memory/
|
||||
└── journal-keeper/
|
||||
├── journal-keeper.agent.yaml
|
||||
└── journal-keeper-sidecar/
|
||||
```
|
||||
|
||||
## Creating Your Own
|
||||
|
||||
Use the BMB agent builder to craft your agents. Once ready to use, place your `.agent.yaml` files or folders with `custom.yaml` in `.bmad/custom/agents/` or `.bmad/custom/workflows/`.
|
||||
@@ -1,449 +0,0 @@
|
||||
# Document Sharding Guide
|
||||
|
||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [What is Document Sharding?](#what-is-document-sharding)
|
||||
- [When to Use Sharding](#when-to-use-sharding)
|
||||
- [How Sharding Works](#how-sharding-works)
|
||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
||||
- [Workflow Support](#workflow-support)
|
||||
- [Best Practices](#best-practices)
|
||||
- [Examples](#examples)
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
||||
|
||||
- **Selective Loading** - Workflows load only the sections they need
|
||||
- **Reduced Token Usage** - Massive efficiency gains for large projects
|
||||
- **Better Organization** - Logical section-based file structure
|
||||
- **Maintained Context** - Index file preserves document structure
|
||||
|
||||
### Architecture
|
||||
|
||||
```
|
||||
Before Sharding:
|
||||
docs/
|
||||
└── PRD.md (large 50k token file)
|
||||
|
||||
After Sharding:
|
||||
docs/
|
||||
└── prd/
|
||||
├── index.md # Table of contents with descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Additional sections
|
||||
```
|
||||
|
||||
## When to Use Sharding
|
||||
|
||||
### Ideal Candidates
|
||||
|
||||
**Large Multi-Epic Projects:**
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
**Token Thresholds:**
|
||||
|
||||
- **Consider sharding**: Documents > 20k tokens
|
||||
- **Strongly recommended**: Documents > 40k tokens
|
||||
- **Critical for efficiency**: Documents > 60k tokens
|
||||
|
||||
### When NOT to Shard
|
||||
|
||||
**Small Projects:**
|
||||
|
||||
- Single epic projects
|
||||
- Level 0-1 projects (tech-spec only)
|
||||
- Documents under 10k tokens
|
||||
- Quick prototypes
|
||||
|
||||
**Frequently Updated Docs:**
|
||||
|
||||
- Active work-in-progress documents
|
||||
- Documents updated daily
|
||||
- Documents where whole-file context is essential
|
||||
|
||||
## 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
|
||||
|
||||
### Loading Strategies
|
||||
|
||||
**Full Load (Phase 1-3 workflows):**
|
||||
|
||||
```
|
||||
If sharded:
|
||||
- Read index.md
|
||||
- Read ALL section files
|
||||
- Treat as single combined document
|
||||
```
|
||||
|
||||
**Selective Load (Phase 4 workflows):**
|
||||
|
||||
```
|
||||
If sharded epics and working on Epic 3:
|
||||
- Read epics/index.md
|
||||
- Load ONLY epics/epic-3.md
|
||||
- Skip all other epic files
|
||||
- 90%+ token savings!
|
||||
```
|
||||
|
||||
## Using the Shard-Doc Tool
|
||||
|
||||
### CLI Command
|
||||
|
||||
```bash
|
||||
# Activate bmad-master or analyst agent, then:
|
||||
/shard-doc
|
||||
```
|
||||
|
||||
### Interactive Process
|
||||
|
||||
```
|
||||
Agent: Which document would you like to shard?
|
||||
User: docs/PRD.md
|
||||
|
||||
Agent: Default destination: docs/prd/
|
||||
Accept default? [y/n]
|
||||
User: y
|
||||
|
||||
Agent: Sharding PRD.md...
|
||||
✓ Created 12 section files
|
||||
✓ Generated index.md
|
||||
✓ Complete!
|
||||
```
|
||||
|
||||
### What Gets Created
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
```markdown
|
||||
# PRD - Index
|
||||
|
||||
## Sections
|
||||
|
||||
1. [Overview](./overview.md) - Project vision and objectives
|
||||
2. [User Requirements](./user-requirements.md) - Feature specifications
|
||||
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
|
||||
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
|
||||
...
|
||||
```
|
||||
|
||||
**Individual section files:**
|
||||
|
||||
- Named from heading text (kebab-case)
|
||||
- Contains complete section content
|
||||
- Preserves all markdown formatting
|
||||
- Can be read independently
|
||||
|
||||
## Workflow Support
|
||||
|
||||
### Universal Support
|
||||
|
||||
**All BMM workflows support both formats:**
|
||||
|
||||
- ✅ Whole documents
|
||||
- ✅ Sharded documents
|
||||
- ✅ Automatic detection
|
||||
- ✅ Transparent to user
|
||||
|
||||
### Workflow-Specific Patterns
|
||||
|
||||
#### Phase 1-3 (Full Load)
|
||||
|
||||
Workflows load entire sharded documents:
|
||||
|
||||
- `product-brief` - Research, brainstorming docs
|
||||
- `prd` - Product brief, research
|
||||
- `gdd` - Game brief, research
|
||||
- `create-ux-design` - PRD, brief, architecture (if available)
|
||||
- `tech-spec` - Brief, research
|
||||
- `architecture` - PRD, UX design (if available)
|
||||
- `create-epics-and-stories` - PRD, architecture
|
||||
- `implementation-readiness` - All planning docs
|
||||
|
||||
#### Phase 4 (Selective Load)
|
||||
|
||||
Workflows load only needed sections:
|
||||
|
||||
**sprint-planning** (Full Load):
|
||||
|
||||
- Needs ALL epics to build complete status
|
||||
|
||||
**create-story, code-review** (Selective):
|
||||
|
||||
```
|
||||
Working on Epic 3, Story 2:
|
||||
✓ Load epics/epic-3.md only
|
||||
✗ Skip epics/epic-1.md, epic-2.md, epic-4.md, etc.
|
||||
|
||||
Result: 90%+ token reduction for 10-epic projects!
|
||||
```
|
||||
|
||||
### Input File Patterns
|
||||
|
||||
Workflows use standardized patterns:
|
||||
|
||||
```yaml
|
||||
input_file_patterns:
|
||||
prd:
|
||||
whole: '{output_folder}/*prd*.md'
|
||||
sharded: '{output_folder}/*prd*/index.md'
|
||||
|
||||
epics:
|
||||
whole: '{output_folder}/*epic*.md'
|
||||
sharded_index: '{output_folder}/*epic*/index.md'
|
||||
sharded_single: '{output_folder}/*epic*/epic-{{epic_num}}.md'
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Sharding Strategy
|
||||
|
||||
**Do:**
|
||||
|
||||
- ✅ Shard after planning phase complete
|
||||
- ✅ Keep level 2 headings well-organized
|
||||
- ✅ Use descriptive section names
|
||||
- ✅ Shard before Phase 4 implementation
|
||||
- ✅ Keep original file as backup initially
|
||||
|
||||
**Don't:**
|
||||
|
||||
- ❌ Shard work-in-progress documents
|
||||
- ❌ Shard small documents (<20k tokens)
|
||||
- ❌ Mix sharded and whole versions
|
||||
- ❌ Manually edit index.md structure
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
**Good Section Names:**
|
||||
|
||||
```markdown
|
||||
## Epic 1: User Authentication
|
||||
|
||||
## Technical Requirements
|
||||
|
||||
## System Architecture
|
||||
|
||||
## UX Design Principles
|
||||
```
|
||||
|
||||
**Poor Section Names:**
|
||||
|
||||
```markdown
|
||||
## Section 1
|
||||
|
||||
## Part A
|
||||
|
||||
## Details
|
||||
|
||||
## More Info
|
||||
```
|
||||
|
||||
### File Management
|
||||
|
||||
**When to Re-shard:**
|
||||
|
||||
- Significant structural changes to document
|
||||
- Adding/removing major sections
|
||||
- After major refactoring
|
||||
|
||||
**Updating Sharded Docs:**
|
||||
|
||||
1. Edit individual section files directly
|
||||
2. OR edit original, delete sharded folder, re-shard
|
||||
3. Don't manually edit index.md
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Large PRD
|
||||
|
||||
**Scenario:** 15-epic project, PRD is 45k tokens
|
||||
|
||||
**Before Sharding:**
|
||||
|
||||
```
|
||||
Every workflow loads entire 45k token PRD
|
||||
Architecture workflow: 45k tokens
|
||||
UX design workflow: 45k tokens
|
||||
```
|
||||
|
||||
**After Sharding:**
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/PRD.md
|
||||
Destination: docs/prd/
|
||||
|
||||
Created:
|
||||
prd/index.md
|
||||
prd/overview.md (3k tokens)
|
||||
prd/functional-requirements.md (8k tokens)
|
||||
prd/non-functional-requirements.md (6k tokens)
|
||||
prd/user-personas.md (4k tokens)
|
||||
...additional FR/NFR sections
|
||||
```
|
||||
|
||||
**Result:**
|
||||
|
||||
```
|
||||
Architecture workflow: Can load specific sections needed
|
||||
UX design workflow: Can load specific sections needed
|
||||
Significant token reduction for large requirement docs!
|
||||
```
|
||||
|
||||
### Example 2: Sharding Epics File
|
||||
|
||||
**Scenario:** 8 epics with detailed stories, 35k tokens total
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/bmm-epics.md
|
||||
Destination: docs/epics/
|
||||
|
||||
Created:
|
||||
epics/index.md
|
||||
epics/epic-1.md
|
||||
epics/epic-2.md
|
||||
...
|
||||
epics/epic-8.md
|
||||
```
|
||||
|
||||
**Efficiency Gain:**
|
||||
|
||||
```
|
||||
Working on Epic 5 stories:
|
||||
Old: Load all 8 epics (35k tokens)
|
||||
New: Load epic-5.md only (4k tokens)
|
||||
Savings: 88% reduction
|
||||
```
|
||||
|
||||
### Example 3: Architecture Document
|
||||
|
||||
**Scenario:** Multi-layer system architecture, 28k tokens
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/architecture.md
|
||||
Destination: docs/architecture/
|
||||
|
||||
Created:
|
||||
architecture/index.md
|
||||
architecture/system-overview.md
|
||||
architecture/frontend-architecture.md
|
||||
architecture/backend-services.md
|
||||
architecture/data-layer.md
|
||||
architecture/infrastructure.md
|
||||
architecture/security-architecture.md
|
||||
```
|
||||
|
||||
**Benefit:** Code-review workflow can reference specific architectural layers without loading entire architecture doc.
|
||||
|
||||
## Custom Workflow Integration
|
||||
|
||||
### For Workflow Builders
|
||||
|
||||
When creating custom workflows that load large documents:
|
||||
|
||||
**1. Add input_file_patterns to workflow.yaml:**
|
||||
|
||||
```yaml
|
||||
input_file_patterns:
|
||||
your_document:
|
||||
whole: '{output_folder}/*your-doc*.md'
|
||||
sharded: '{output_folder}/*your-doc*/index.md'
|
||||
```
|
||||
|
||||
**2. Add discovery instructions to instructions.md:**
|
||||
|
||||
```markdown
|
||||
## Document Discovery
|
||||
|
||||
1. Search for whole document: _your-doc_.md
|
||||
2. Check for sharded version: _your-doc_/index.md
|
||||
3. If sharded: Read index + ALL sections (or specific sections if selective load)
|
||||
4. Priority: Whole document first
|
||||
```
|
||||
|
||||
**3. Choose loading strategy:**
|
||||
|
||||
- **Full Load**: Read all sections when sharded
|
||||
- **Selective Load**: Read only relevant sections (requires section identification logic)
|
||||
|
||||
### Pattern Templates
|
||||
|
||||
**Full Load Pattern:**
|
||||
|
||||
```xml
|
||||
<action>Search for document: {output_folder}/*doc-name*.md</action>
|
||||
<action>If not found, check for sharded: {output_folder}/*doc-name*/index.md</action>
|
||||
<action if="sharded found">Read index.md to understand structure</action>
|
||||
<action if="sharded found">Read ALL section files listed in index</action>
|
||||
<action if="sharded found">Combine content as single document</action>
|
||||
```
|
||||
|
||||
**Selective Load Pattern (with section ID):**
|
||||
|
||||
```xml
|
||||
<action>Determine section needed (e.g., epic_num = 3)</action>
|
||||
<action>Check for sharded version: {output_folder}/*doc-name*/index.md</action>
|
||||
<action if="sharded found">Read ONLY the specific section file needed</action>
|
||||
<action if="sharded found">Skip all other section files</action>
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Both whole and sharded exist:**
|
||||
|
||||
- Workflows will use whole document (priority rule)
|
||||
- Delete or archive the one you don't want
|
||||
|
||||
**Index.md out of sync:**
|
||||
|
||||
- Delete sharded folder
|
||||
- Re-run shard-doc on original
|
||||
|
||||
**Workflow can't find document:**
|
||||
|
||||
- Check file naming matches patterns (`*prd*.md`, `*epic*.md`, etc.)
|
||||
- Verify index.md exists in sharded folder
|
||||
- Check output_folder path in config
|
||||
|
||||
**Sections too granular:**
|
||||
|
||||
- Combine sections in original document
|
||||
- Use fewer level 2 headings
|
||||
- Re-shard
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
|
||||
- [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Workflow overview
|
||||
- [Workflow Creation Guide](../src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md) - Custom workflow patterns
|
||||
|
||||
---
|
||||
|
||||
**Document sharding is optional but powerful** - use it when efficiency matters for large projects!
|
||||
@@ -1,31 +0,0 @@
|
||||
# BMAD Method - Auggie CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents can be installed in multiple locations based on your setup.
|
||||
|
||||
### Common Locations
|
||||
|
||||
- User Home: `~/.augment/commands/`
|
||||
- Project: `.augment/commands/`
|
||||
- Custom paths you selected
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `@{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates
|
||||
3. **Tasks**: Use `@task-{task-name}` for tasks
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@dev - Activate development agent
|
||||
@architect - Activate architect agent
|
||||
@task-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Agents can be in multiple locations
|
||||
- Check your installation paths
|
||||
- Activation syntax same across all locations
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Claude Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as slash commands in `.claude/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Slash Command**: Start with `/` to see available commands
|
||||
2. **Select Agent**: Type `/bmad-{agent-name}` (e.g., `/bmad-dev`)
|
||||
3. **Execute**: Press Enter to activate that agent persona
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/bmad:bmm:agents:dev - Activate development agent
|
||||
/bmad:bmm:agents:architect - Activate architect agent
|
||||
/bmad:bmm:workflows:dev-story - Execute dev-story workflow
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands are autocompleted when you type `/`
|
||||
- Agent remains active for the conversation
|
||||
- Start a new conversation to switch agents
|
||||
@@ -1,31 +0,0 @@
|
||||
# BMAD Method - Cline Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as **toggleable rules** in `.clinerules/` directory.
|
||||
|
||||
### Important: Rules are OFF by default
|
||||
|
||||
- Rules are NOT automatically loaded to avoid context pollution
|
||||
- You must manually enable the agent you want to use
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Rules Panel**: Click the rules icon below the chat input
|
||||
2. **Enable an Agent**: Toggle ON the specific agent rule you need (e.g., `01-core-dev`)
|
||||
3. **Activate in Chat**: Type `@{agent-name}` to activate that persona
|
||||
4. **Disable When Done**: Toggle OFF to free up context
|
||||
|
||||
### Best Practices
|
||||
|
||||
- Only enable 1-2 agents at a time to preserve context
|
||||
- Disable agents when switching tasks
|
||||
- Rules are numbered (01-, 02-) for organization, not priority
|
||||
|
||||
### Example
|
||||
|
||||
```
|
||||
Toggle ON: 01-core-dev.md
|
||||
In chat: "@dev help me refactor this code"
|
||||
When done: Toggle OFF the rule
|
||||
```
|
||||
@@ -1,21 +0,0 @@
|
||||
# BMAD Method - Codex Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents, tasks and workflows are installed as custom prompts in
|
||||
`$CODEX_HOME/prompts/bmad-*.md` files. If `CODEX_HOME` is not set, it
|
||||
defaults to `$HOME/.codex/`.
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/bmad-bmm-agents-dev - Activate development agent
|
||||
/bmad-bmm-agents-architect - Activate architect agent
|
||||
/bmad-bmm-workflows-dev-story - Execute dev-story workflow
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
Prompts are autocompleted when you type /
|
||||
Agent remains active for the conversation
|
||||
Start a new conversation to switch agents
|
||||
@@ -1,30 +0,0 @@
|
||||
# BMAD Method - Crush Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as commands in `.crush/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Command Palette**: Use Crush command interface
|
||||
2. **Navigate**: Browse to `{bmad_folder}/{module}/agents/`
|
||||
3. **Select Agent**: Choose the agent command
|
||||
4. **Execute**: Run to activate agent persona
|
||||
|
||||
### Command Structure
|
||||
|
||||
```
|
||||
.crush/commands/bmad/
|
||||
├── agents/ # All agents
|
||||
├── tasks/ # All tasks
|
||||
├── core/ # Core module
|
||||
│ ├── agents/
|
||||
│ └── tasks/
|
||||
└── {module}/ # Other modules
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands organized by module
|
||||
- Can browse hierarchically
|
||||
- Agent activates for session
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Cursor Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Reference in Chat**: Use `@{bmad_folder}/{module}/agents/{agent-name}`
|
||||
2. **Include Entire Module**: Use `@{bmad_folder}/{module}`
|
||||
3. **Reference Index**: Use `@{bmad_folder}/index` for all available agents
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@{bmad_folder}/core/agents/dev - Activate dev agent
|
||||
@{bmad_folder}/bmm/agents/architect - Activate architect agent
|
||||
@{bmad_folder}/core - Include all core agents/tasks
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Rules are Manual type - only loaded when explicitly referenced
|
||||
- No automatic context pollution
|
||||
- Can combine multiple agents: `@{bmad_folder}/core/agents/dev @{bmad_folder}/core/agents/test`
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Gemini CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are concatenated in `.gemini/bmad-method/GEMINI.md`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `*{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates from the concatenated file
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
*dev - Activate development agent
|
||||
*architect - Activate architect agent
|
||||
*test - Activate test agent
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- All agents loaded from single GEMINI.md file
|
||||
- Triggers with asterisk: `*{agent-name}`
|
||||
- Context includes all agents (may be large)
|
||||
@@ -1,26 +0,0 @@
|
||||
# BMAD Method - GitHub Copilot Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as chat modes in `.github/chatmodes/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Chat View**: Click Copilot icon in VS Code sidebar
|
||||
2. **Select Mode**: Click mode selector (top of chat)
|
||||
3. **Choose Agent**: Select the BMAD agent from dropdown
|
||||
4. **Chat**: Agent is now active for this session
|
||||
|
||||
### VS Code Settings
|
||||
|
||||
Configured in `.vscode/settings.json`:
|
||||
|
||||
- Max requests per session
|
||||
- Auto-fix enabled
|
||||
- MCP discovery enabled
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist for the chat session
|
||||
- Switch modes anytime via dropdown
|
||||
- Multiple agents available in mode selector
|
||||
@@ -1,33 +0,0 @@
|
||||
# BMAD Method - iFlow CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as commands in `.iflow/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Access Commands**: Use iFlow command interface
|
||||
2. **Navigate**: Browse to `{bmad_folder}/agents/` or `{bmad_folder}/tasks/`
|
||||
3. **Select**: Choose the agent or task command
|
||||
4. **Execute**: Run to activate
|
||||
|
||||
### Command Structure
|
||||
|
||||
```
|
||||
.iflow/commands/bmad/
|
||||
├── agents/ # Agent commands
|
||||
└── tasks/ # Task commands
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/{bmad_folder}/agents/core-dev - Activate dev agent
|
||||
/{bmad_folder}/tasks/core-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands organized by type (agents/tasks)
|
||||
- Agent activates for session
|
||||
- Similar to Crush command structure
|
||||
@@ -1,24 +0,0 @@
|
||||
# BMAD Method - KiloCode Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as custom modes in `.kilocodemodes`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Project**: Modes auto-load when project opens
|
||||
2. **Select Mode**: Use mode selector in KiloCode interface
|
||||
3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode
|
||||
4. **Activate**: Mode is now active
|
||||
|
||||
### Mode Format
|
||||
|
||||
- Mode name: `bmad-{module}-{agent}`
|
||||
- Display: `{icon} {title}`
|
||||
- Example: `bmad-core-dev` shows as `🤖 Dev`
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist until changed
|
||||
- Similar to Roo Code mode system
|
||||
- Icon shows in mode selector
|
||||
@@ -1,24 +0,0 @@
|
||||
# BMAD Method - OpenCode Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_name}` and workflow commands in `.opencode/command/BMAD/{module_name}`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Switch Agents**: Press **Tab** to cycle through primary agents or select using the `/agents`
|
||||
2. **Activate Agent**: Once the Agent is selected say `hello` or any prompt to activate that agent persona
|
||||
3. **Execute Commands**: Type `/bmad` to see and execute bmad workflow commands (commands allow for fuzzy matching)
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/agents - to see a list of agents and switch between them
|
||||
/{bmad_folder}/bmm/workflows/workflow-init - Activate the workflow-init command
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Press **Tab** to switch between primary agents (Analyst, Architect, Dev, etc.)
|
||||
- Commands are autocompleted when you type `/` and allow for fuzzy matching
|
||||
- Workflow commands execute in current agent context, make sure you have the right agent activated before running a command
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Qwen Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are concatenated in `.qwen/bmad-method/QWEN.md`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `*{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates from the concatenated file
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
*dev - Activate development agent
|
||||
*architect - Activate architect agent
|
||||
*test - Activate test agent
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- All agents loaded from single QWEN.md file
|
||||
- Triggers with asterisk: `*{agent-name}`
|
||||
- Similar to Gemini CLI setup
|
||||
@@ -1,27 +0,0 @@
|
||||
# BMAD Method - Roo Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as custom modes in `.roomodes`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Project**: Modes auto-load when project opens
|
||||
2. **Select Mode**: Use mode selector in Roo interface
|
||||
3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode
|
||||
4. **Activate**: Mode is now active with configured permissions
|
||||
|
||||
### Permission Levels
|
||||
|
||||
Modes are configured with file edit permissions:
|
||||
|
||||
- Development files only
|
||||
- Configuration files only
|
||||
- Documentation files only
|
||||
- All files (if configured)
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist until changed
|
||||
- Each mode has specific file access rights
|
||||
- Icon shows in mode selector for easy identification
|
||||
@@ -1,388 +0,0 @@
|
||||
# Rovo Dev IDE Integration
|
||||
|
||||
This document describes how BMAD-METHOD integrates with [Atlassian Rovo Dev](https://www.atlassian.com/rovo-dev), an AI-powered software development assistant.
|
||||
|
||||
## Overview
|
||||
|
||||
Rovo Dev is designed to integrate deeply with developer workflows and organizational knowledge bases. When you install BMAD-METHOD in a Rovo Dev project, it automatically installs BMAD agents, workflows, tasks, and tools just like it does for other IDEs (Cursor, VS Code, etc.).
|
||||
|
||||
BMAD-METHOD provides:
|
||||
|
||||
- **Agents**: Specialized subagents for various development tasks
|
||||
- **Workflows**: Multi-step workflow guides and coordinators
|
||||
- **Tasks & Tools**: Reference documentation for BMAD tasks and tools
|
||||
|
||||
### What are Rovo Dev Subagents?
|
||||
|
||||
Subagents are specialized agents that Rovo Dev can delegate tasks to. They are defined as Markdown files with YAML frontmatter stored in the `.rovodev/subagents/` directory. Rovo Dev automatically discovers these files and makes them available through the `@subagent-name` syntax.
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
### Automatic Installation
|
||||
|
||||
When you run the BMAD-METHOD installer and select Rovo Dev as your IDE:
|
||||
|
||||
```bash
|
||||
bmad install
|
||||
```
|
||||
|
||||
The installer will:
|
||||
|
||||
1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
|
||||
2. Convert BMAD agents into Rovo Dev subagent format
|
||||
3. Write subagent files with the naming pattern: `bmad-<module>-<agent-name>.md`
|
||||
|
||||
### File Structure
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
project-root/
|
||||
├── .rovodev/
|
||||
│ ├── subagents/
|
||||
│ │ ├── bmad-core-code-reviewer.md
|
||||
│ │ ├── bmad-bmm-pm.md
|
||||
│ │ ├── bmad-bmm-dev.md
|
||||
│ │ └── ... (more agents from selected modules)
|
||||
│ ├── workflows/
|
||||
│ │ ├── bmad-brainstorming.md
|
||||
│ │ ├── bmad-prd-creation.md
|
||||
│ │ └── ... (workflow guides)
|
||||
│ ├── references/
|
||||
│ │ ├── bmad-task-core-code-review.md
|
||||
│ │ ├── bmad-tool-core-analysis.md
|
||||
│ │ └── ... (task/tool references)
|
||||
│ ├── config.yml (Rovo Dev configuration)
|
||||
│ ├── prompts.yml (Optional: reusable prompts)
|
||||
│ └── ...
|
||||
├── .bmad/ (BMAD installation directory)
|
||||
└── ...
|
||||
```
|
||||
|
||||
**Directory Structure Explanation:**
|
||||
|
||||
- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
|
||||
- **workflows/**: Multi-step workflow guides and instructions
|
||||
- **references/**: Documentation for available tasks and tools in BMAD
|
||||
|
||||
## Subagent File Format
|
||||
|
||||
BMAD agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
|
||||
|
||||
### Basic Structure
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: bmad-module-agent-name
|
||||
description: One sentence description of what this agent does
|
||||
tools:
|
||||
- bash
|
||||
- open_files
|
||||
- grep
|
||||
- expand_code_chunks
|
||||
model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
|
||||
load_memory: true # Optional
|
||||
---
|
||||
|
||||
You are a specialized agent for [specific task].
|
||||
|
||||
## Your Role
|
||||
|
||||
Describe the agent's role and responsibilities...
|
||||
|
||||
## Key Instructions
|
||||
|
||||
1. First instruction
|
||||
2. Second instruction
|
||||
3. Third instruction
|
||||
|
||||
## When to Use This Agent
|
||||
|
||||
Explain when and how to use this agent...
|
||||
```
|
||||
|
||||
### YAML Frontmatter Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | string | Yes | Unique identifier for the subagent (kebab-case, no spaces) |
|
||||
| `description` | string | Yes | One-line description of the subagent's purpose |
|
||||
| `tools` | array | No | List of tools the subagent can use. If not specified, uses parent agent's tools |
|
||||
| `model` | string | No | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
|
||||
| `load_memory` | boolean | No | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true` |
|
||||
|
||||
### System Prompt
|
||||
|
||||
The content after the closing `---` is the subagent's system prompt. This defines:
|
||||
|
||||
- The agent's persona and role
|
||||
- Its capabilities and constraints
|
||||
- Step-by-step instructions for task execution
|
||||
- Examples of expected behavior
|
||||
|
||||
## Using BMAD Components in Rovo Dev
|
||||
|
||||
### Invoking a Subagent (Agent)
|
||||
|
||||
In Rovo Dev, you can invoke a BMAD agent as a subagent using the `@` syntax:
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Please review this PR for potential issues
|
||||
@bmad-bmm-pm Help plan this feature release
|
||||
@bmad-bmm-dev Implement this feature
|
||||
```
|
||||
|
||||
### Accessing Workflows
|
||||
|
||||
Workflow guides are available in `.rovodev/workflows/` directory:
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/bmad-brainstorming.md
|
||||
```
|
||||
|
||||
Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
|
||||
|
||||
### Accessing Tasks and Tools
|
||||
|
||||
Task and tool documentation is available in `.rovodev/references/` directory. These provide:
|
||||
|
||||
- Task execution instructions
|
||||
- Tool capabilities and usage
|
||||
- Integration examples
|
||||
- Parameter documentation
|
||||
|
||||
### Example Usage Scenarios
|
||||
|
||||
#### Code Review
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Review the changes in src/components/Button.tsx
|
||||
for best practices, performance, and potential bugs
|
||||
```
|
||||
|
||||
#### Documentation
|
||||
|
||||
```
|
||||
@bmad-core-documentation-writer Generate API documentation for the new
|
||||
user authentication module
|
||||
```
|
||||
|
||||
#### Feature Design
|
||||
|
||||
```
|
||||
@bmad-module-feature-designer Design a solution for implementing
|
||||
dark mode support across the application
|
||||
```
|
||||
|
||||
## Customizing BMAD Subagents
|
||||
|
||||
You can customize BMAD subagents after installation by editing their files directly in `.rovodev/subagents/`.
|
||||
|
||||
### Example: Adding Tool Restrictions
|
||||
|
||||
By default, BMAD subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: bmad-core-code-reviewer
|
||||
description: Reviews code and suggests improvements
|
||||
tools:
|
||||
- open_files
|
||||
- expand_code_chunks
|
||||
- grep
|
||||
---
|
||||
```
|
||||
|
||||
### Example: Using a Specific Model
|
||||
|
||||
Some agents might benefit from using a different model. You can specify this:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: bmad-core-documentation-writer
|
||||
description: Writes clear and comprehensive documentation
|
||||
model: anthropic.claude-3-5-sonnet-20241022-v2:0
|
||||
---
|
||||
```
|
||||
|
||||
### Example: Enhancing the System Prompt
|
||||
|
||||
You can add additional context to a subagent's system prompt:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: bmad-core-code-reviewer
|
||||
description: Reviews code and suggests improvements
|
||||
---
|
||||
|
||||
You are a specialized code review agent for our project.
|
||||
|
||||
## Project Context
|
||||
|
||||
Our codebase uses:
|
||||
|
||||
- React 18 for frontend
|
||||
- Node.js 18+ for backend
|
||||
- TypeScript for type safety
|
||||
- Jest for testing
|
||||
|
||||
## Review Checklist
|
||||
|
||||
1. Type safety and TypeScript correctness
|
||||
2. React best practices and hooks usage
|
||||
3. Performance considerations
|
||||
4. Test coverage
|
||||
5. Documentation and comments
|
||||
|
||||
...rest of original system prompt...
|
||||
```
|
||||
|
||||
## Memory and Context
|
||||
|
||||
By default, BMAD subagents have `load_memory: true`, which means they will load memory files from your project:
|
||||
|
||||
- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
|
||||
- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
|
||||
|
||||
These files can contain:
|
||||
|
||||
- Project guidelines and conventions
|
||||
- Common patterns and best practices
|
||||
- Recent decisions and context
|
||||
- Custom instructions for all agents
|
||||
|
||||
### Creating Project Memory
|
||||
|
||||
Create `.rovodev/AGENTS.md` in your project:
|
||||
|
||||
```markdown
|
||||
# Project Guidelines
|
||||
|
||||
## Code Style
|
||||
|
||||
- Use 2-space indentation
|
||||
- Use camelCase for variables
|
||||
- Use PascalCase for classes
|
||||
|
||||
## Architecture
|
||||
|
||||
- Follow modular component structure
|
||||
- Use dependency injection for services
|
||||
- Implement proper error handling
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
- Minimum 80% code coverage
|
||||
- Write tests before implementation
|
||||
- Use descriptive test names
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Subagents Not Appearing in Rovo Dev
|
||||
|
||||
1. **Verify files exist**: Check that `.rovodev/subagents/bmad-*.md` files are present
|
||||
2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
|
||||
3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
|
||||
4. **Check file permissions**: Ensure files are readable by Rovo Dev
|
||||
|
||||
### Agent Name Conflicts
|
||||
|
||||
If you have custom subagents with the same names as BMAD agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
|
||||
|
||||
### Tools Not Available
|
||||
|
||||
If a subagent's tools aren't working:
|
||||
|
||||
1. Verify the tool names match Rovo Dev's available tools
|
||||
2. Check that the parent Rovo Dev agent has access to those tools
|
||||
3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
|
||||
|
||||
## Advanced: Tool Configuration
|
||||
|
||||
Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
|
||||
|
||||
- `bash`: Execute shell commands
|
||||
- `open_files`: View file contents
|
||||
- `grep`: Search across files
|
||||
- `expand_code_chunks`: View specific code sections
|
||||
- `find_and_replace_code`: Modify files
|
||||
- `create_file`: Create new files
|
||||
- `delete_file`: Delete files
|
||||
- `move_file`: Rename or move files
|
||||
|
||||
### MCP Servers
|
||||
|
||||
Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
|
||||
|
||||
- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
|
||||
- **Code Analysis**: Custom code analysis and metrics
|
||||
- **External Services**: APIs and third-party integrations
|
||||
|
||||
Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
|
||||
|
||||
## Integration with Other IDE Handlers
|
||||
|
||||
BMAD-METHOD supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
|
||||
|
||||
For example:
|
||||
|
||||
- Rovo Dev agents: `.rovodev/subagents/bmad-*.md`
|
||||
- Cursor rules: `.cursor/rules/bmad/`
|
||||
- Claude Code: `.claude/rules/bmad/`
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
- BMAD subagent files are typically small (1-5 KB each)
|
||||
- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
|
||||
- System prompts are cached by Rovo Dev after first load
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
|
||||
2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
|
||||
3. **Customize Tool Restrictions**: Give subagents only the tools they need
|
||||
4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
|
||||
5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
|
||||
6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
|
||||
- [BMAD-METHOD Installation Guide](./installation.md)
|
||||
- [IDE Handler Architecture](./ide-handlers.md)
|
||||
- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Code Review Workflow
|
||||
|
||||
```
|
||||
User: @bmad-core-code-reviewer Review src/auth/login.ts for security issues
|
||||
Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
|
||||
Subagent output: Security vulnerabilities found, recommendations provided
|
||||
```
|
||||
|
||||
### Example 2: Documentation Generation
|
||||
|
||||
```
|
||||
User: @bmad-core-documentation-writer Generate API docs for the new payment module
|
||||
Rovo Dev → Subagent: Analyzes code structure, generates documentation
|
||||
Subagent output: Markdown documentation with examples and API reference
|
||||
```
|
||||
|
||||
### Example 3: Architecture Design
|
||||
|
||||
```
|
||||
User: @bmad-module-feature-designer Design a caching strategy for the database layer
|
||||
Rovo Dev → Subagent: Reviews current architecture, proposes design
|
||||
Subagent output: Detailed architecture proposal with implementation plan
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions about:
|
||||
|
||||
- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
|
||||
- **BMAD-METHOD**: See [BMAD-METHOD README](../README.md)
|
||||
- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Trae Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as rules in `.trae/rules/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `@{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates automatically
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@dev - Activate development agent
|
||||
@architect - Activate architect agent
|
||||
@task-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Rules auto-load from `.trae/rules/` directory
|
||||
- Multiple agents can be referenced: `@dev and @test`
|
||||
- Agent follows YAML configuration in rule file
|
||||
@@ -1,22 +0,0 @@
|
||||
# BMAD Method - Windsurf Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as workflows in `.windsurf/workflows/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Workflows**: Access via Windsurf menu or command palette
|
||||
2. **Select Workflow**: Choose the agent/task workflow
|
||||
3. **Execute**: Run to activate that agent persona
|
||||
|
||||
### Workflow Types
|
||||
|
||||
- **Agent workflows**: `{module}-{agent}.md` (auto_execution_mode: 3)
|
||||
- **Task workflows**: `task-{module}-{task}.md` (auto_execution_mode: 2)
|
||||
|
||||
### Notes
|
||||
|
||||
- Agents run with higher autonomy (mode 3)
|
||||
- Tasks run with guided execution (mode 2)
|
||||
- Workflows persist for the session
|
||||
169
docs/index.md
169
docs/index.md
@@ -1,152 +1,111 @@
|
||||
# BMad Documentation Index
|
||||
# BMAD Documentation
|
||||
|
||||
Complete map of all BMad Method v6 documentation with recommended reading paths.
|
||||
Complete documentation for the BMAD Method.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### New to BMAD?
|
||||
Start with the core concepts to understand how BMAD works:
|
||||
|
||||
- **[Core Concepts](./bmad-core-concepts/)** - Agents, workflows, and modules explained
|
||||
- **[Installation Guide](./bmad-core-concepts/installing/)** - Set up BMAD in your project
|
||||
- **[Quick Start Guide](./modules/bmm-bmad-method/quick-start)** - Build your first feature
|
||||
|
||||
### Upgrading from v4?
|
||||
- **[v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md)** - Migration path for v4 users
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Getting Started (Start Here!)
|
||||
## Module Documentation
|
||||
|
||||
**New users:** Start with one of these based on your situation:
|
||||
|
||||
| Your Situation | Start Here | Then Read |
|
||||
| ---------------------- | --------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **Brand new to BMad** | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) |
|
||||
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) |
|
||||
| **Brownfield project** | [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Core Documentation
|
||||
|
||||
### Project-Level Docs (Root)
|
||||
|
||||
- **[README.md](../README.md)** - Main project overview, feature summary, and module introductions
|
||||
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
|
||||
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history and breaking changes
|
||||
- **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project
|
||||
|
||||
### Installation & Setup
|
||||
|
||||
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
|
||||
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
|
||||
- **[Web Bundles](./USING_WEB_BUNDLES.md)** - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation
|
||||
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Module Documentation
|
||||
|
||||
### BMad Method (BMM) - Software & Game Development
|
||||
### BMAD Method (BMM) - Software & Game Development
|
||||
|
||||
The flagship module for agile AI-driven development.
|
||||
|
||||
- **[BMM Module README](../src/modules/bmm/README.md)** - Module overview, agents, and complete documentation index
|
||||
- **[BMM Documentation](../src/modules/bmm/docs/)** - All BMM-specific guides and references:
|
||||
- [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Step-by-step guide to building your first project
|
||||
- [Quick Spec Flow](../src/modules/bmm/docs/quick-spec-flow.md) - Rapid Level 0-1 development
|
||||
- [Scale Adaptive System](../src/modules/bmm/docs/scale-adaptive-system.md) - Understanding the 5-level system
|
||||
- [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING**
|
||||
- **[Test Architect Guide](../src/modules/bmm/testarch/README.md)** - Testing strategy and quality assurance
|
||||
- **[BMM Module Index](./modules/bmm-bmad-method/index)** - Module overview, agents, and documentation
|
||||
- [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Step-by-step guide
|
||||
- [Quick Spec Flow](./modules/bmm-bmad-method/quick-spec-flow) - Rapid Level 0-1 development
|
||||
- [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides)** - Essential reading
|
||||
|
||||
### BMad Builder (BMB) - Create Custom Solutions
|
||||
### BMAD Builder (BMB) - Create Custom Solutions
|
||||
|
||||
Build your own agents, workflows, and modules.
|
||||
|
||||
- **[BMB Module README](../src/modules/bmb/README.md)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
|
||||
- **[BMB Module Overview](./modules/bmb-bmad-builder/index)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md)** - Create custom agents
|
||||
- **[Custom Content Installation](./modules/bmb-bmad-builder/custom-content-installation.md)** - Share and install custom creations
|
||||
|
||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||
|
||||
AI-powered creative thinking and brainstorming.
|
||||
- **[CIS Documentation](./modules/cis-creative-intelligence-suite/index)**
|
||||
|
||||
- **[CIS Module README](../src/modules/cis/README.md)** - Module overview and workflows
|
||||
### BMAD Game Dev (BMGD)
|
||||
|
||||
- **[BMGD Documentation](./modules/bmgd-bmad-game-dev/index)** - Game development workflows
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ IDE-Specific Guides
|
||||
## Core Module
|
||||
|
||||
Instructions for loading agents and running workflows in your development environment.
|
||||
### Global Core Entities
|
||||
|
||||
**Popular IDEs:**
|
||||
|
||||
- [Claude Code](./ide-info/claude-code.md)
|
||||
- [Cursor](./ide-info/cursor.md)
|
||||
- [VS Code](./ide-info/windsurf.md)
|
||||
|
||||
**Other Supported IDEs:**
|
||||
|
||||
- [Augment](./ide-info/auggie.md)
|
||||
- [Cline](./ide-info/cline.md)
|
||||
- [Codex](./ide-info/codex.md)
|
||||
- [Crush](./ide-info/crush.md)
|
||||
- [Gemini](./ide-info/gemini.md)
|
||||
- [GitHub Copilot](./ide-info/github-copilot.md)
|
||||
- [IFlow](./ide-info/iflow.md)
|
||||
- [Kilo](./ide-info/kilo.md)
|
||||
- [OpenCode](./ide-info/opencode.md)
|
||||
- [Qwen](./ide-info/qwen.md)
|
||||
- [Roo](./ide-info/roo.md)
|
||||
- [Rovo Dev](./ide-info/rovo-dev.md)
|
||||
- [Trae](./ide-info/trae.md)
|
||||
|
||||
**Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions.
|
||||
- **[Core Module Index](./modules/core/index)** - Shared functionality available to all modules
|
||||
- [Global Core Config](./modules/core/global-core-config.md) - Inheritable configuration
|
||||
- [Core Workflows](./modules/core/core-workflows.md) - Domain-agnostic workflows
|
||||
- [Party Mode](./modules/core/party-mode.md) - Multi-agent conversations
|
||||
- [Brainstorming](./modules/core/brainstorming.md) - Structured creative sessions
|
||||
- [Advanced Elicitation](./modules/core/advanced-elicitation.md) - LLM reasoning techniques
|
||||
- [Core Tasks](./modules/core/core-tasks.md) - Common tasks across modules
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Advanced Topics
|
||||
## Advanced Topics
|
||||
|
||||
### Custom Agents
|
||||
### Customization
|
||||
|
||||
- **[Custom Agent Installation](./custom-agent-installation.md)** - Install and personalize agents with `bmad agent-install`
|
||||
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
||||
- **[BMAD Customization](./bmad-core-concepts/bmad-customization/)** - Modify agents and workflows
|
||||
|
||||
### Installation & Bundling
|
||||
### Platform Guides
|
||||
|
||||
- [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
|
||||
- [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
|
||||
- [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles
|
||||
- **[Web Bundles](./bmad-core-concepts/web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Recommended Reading Paths
|
||||
## Recommended Reading Paths
|
||||
|
||||
### Path 1: Brand New to BMad (Software Project)
|
||||
### Path 1: Brand New to BMAD (Software Project)
|
||||
|
||||
1. [README.md](../README.md) - Understand the vision
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on
|
||||
3. [BMM Module README](../src/modules/bmm/README.md) - Understand agents
|
||||
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
||||
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
||||
3. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
|
||||
4. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||
|
||||
### Path 2: Game Development Project
|
||||
|
||||
1. [README.md](../README.md) - Understand the vision
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on
|
||||
3. [BMM Module README](../src/modules/bmm/README.md) - Game agents are included
|
||||
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Game workflows
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
||||
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
||||
3. [BMGD Workflows Guide](./modules/bmgd-bmad-game-dev/workflows-guide) - Game-specific workflows
|
||||
|
||||
### Path 3: Upgrading from v4
|
||||
|
||||
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Reorient yourself
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Learn new v6 workflows
|
||||
1. [v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md) - Understand what changed
|
||||
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Reorient yourself
|
||||
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Learn new v6 workflows
|
||||
|
||||
### Path 4: Working with Existing Codebase (Brownfield)
|
||||
|
||||
1. [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Approach for legacy code
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Follow the process
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
|
||||
1. [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Approach for legacy code
|
||||
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Follow the process
|
||||
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||
|
||||
### Path 5: Building Custom Solutions
|
||||
### Path 5: Building Custom Agents
|
||||
|
||||
1. [BMB Module README](../src/modules/bmb/README.md) - Understand capabilities
|
||||
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
|
||||
1. [Core Concepts: Agents](./bmad-core-concepts/agents.md) - Understand Simple vs Expert
|
||||
2. [Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md) - Build your first agent
|
||||
3. [Agent Architecture](./modules/bmb-bmad-builder/index) - Deep technical details
|
||||
|
||||
### Path 6: Contributing to BMad
|
||||
### Path 6: Contributing to BMAD
|
||||
|
||||
1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
|
||||
1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
|
||||
2. Relevant module README - Understand the area you're contributing to
|
||||
3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards
|
||||
|
||||
@@ -1,186 +0,0 @@
|
||||
# IDE Content Injection Standard
|
||||
|
||||
## Overview
|
||||
|
||||
This document defines the standard for IDE-specific content injection in BMAD modules. Each IDE can inject its own specific content into BMAD templates during installation without polluting the source files with IDE-specific code. The installation process is interactive, allowing users to choose what IDE-specific features they want to install.
|
||||
|
||||
## Architecture
|
||||
|
||||
### 1. Injection Points
|
||||
|
||||
Files that support IDE-specific content define injection points using HTML comments:
|
||||
|
||||
```xml
|
||||
<!-- IDE-INJECT-POINT: unique-point-name -->
|
||||
```
|
||||
|
||||
### 2. Module Structure
|
||||
|
||||
Each module that needs IDE-specific content creates a sub-module folder:
|
||||
|
||||
```
|
||||
src/modules/{module-name}/sub-modules/{ide-name}/
|
||||
├── injections.yaml # Injection configuration
|
||||
├── sub-agents/ # IDE-specific subagents (if applicable)
|
||||
└── config.yaml # Other IDE-specific config
|
||||
```
|
||||
|
||||
### 3. Injection Configuration Format
|
||||
|
||||
The `injections.yaml` file defines what content to inject where:
|
||||
|
||||
```yaml
|
||||
# injections.yaml structure
|
||||
injections:
|
||||
- file: 'relative/path/to/file.md' # Path relative to installation root
|
||||
point: 'injection-point-name' # Must match IDE-INJECT-POINT name
|
||||
requires: 'subagent-name' # Which subagent must be selected (or "any")
|
||||
content: | # Content to inject (preserves formatting)
|
||||
<llm>
|
||||
<i>Instructions specific to this IDE</i>
|
||||
</llm>
|
||||
|
||||
# Subagents available for installation
|
||||
subagents:
|
||||
source: 'sub-agents' # Source folder relative to this config
|
||||
target: '.claude/agents' # Claude's expected location (don't change)
|
||||
files:
|
||||
- 'agent1.md'
|
||||
- 'agent2.md'
|
||||
```
|
||||
|
||||
### 4. Interactive Installation Process
|
||||
|
||||
For Claude Code specifically, the installer will:
|
||||
|
||||
1. **Detect available subagents** from the module's `injections.yaml`
|
||||
2. **Ask the user** about subagent installation:
|
||||
- Install all subagents (default)
|
||||
- Select specific subagents
|
||||
- Skip subagent installation
|
||||
3. **Ask installation location** (if subagents selected):
|
||||
- Project level: `.claude/agents/`
|
||||
- User level: `~/.claude/agents/`
|
||||
4. **Copy selected subagents** to the chosen location
|
||||
5. **Inject only relevant content** based on selected subagents
|
||||
|
||||
Other IDEs can implement their own installation logic appropriate to their architecture.
|
||||
|
||||
## Implementation
|
||||
|
||||
### IDE Installer Responsibilities
|
||||
|
||||
Each IDE installer (e.g., `claude-code.js`) must:
|
||||
|
||||
1. **Check for sub-modules**: Look for `sub-modules/{ide-name}/` in each installed module
|
||||
2. **Load injection config**: Parse `injections.yaml` if present
|
||||
3. **Process injections**: Replace injection points with configured content
|
||||
4. **Copy additional files**: Handle subagents or other IDE-specific files
|
||||
|
||||
### Example Implementation (Claude Code)
|
||||
|
||||
```javascript
|
||||
async processModuleInjections(projectDir, bmadDir, options) {
|
||||
for (const moduleName of options.selectedModules) {
|
||||
const configPath = path.join(
|
||||
bmadDir, 'src/modules', moduleName,
|
||||
'sub-modules/claude-code/injections.yaml'
|
||||
);
|
||||
|
||||
if (exists(configPath)) {
|
||||
const config = yaml.load(configPath);
|
||||
|
||||
// Interactive: Ask user about subagent installation
|
||||
const choices = await this.promptSubagentInstallation(config.subagents);
|
||||
|
||||
if (choices.install !== 'none') {
|
||||
// Ask where to install
|
||||
const location = await this.promptInstallLocation();
|
||||
|
||||
// Process injections based on selections
|
||||
for (const injection of config.injections) {
|
||||
if (this.shouldInject(injection, choices)) {
|
||||
await this.injectContent(projectDir, injection, choices);
|
||||
}
|
||||
}
|
||||
|
||||
// Copy selected subagents
|
||||
await this.copySelectedSubagents(projectDir, config.subagents, choices, location);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **Clean Source Files**: No IDE-specific conditionals in source
|
||||
2. **Modular**: Each IDE manages its own injections
|
||||
3. **Scalable**: Easy to add support for new IDEs
|
||||
4. **Maintainable**: IDE-specific content lives with IDE config
|
||||
5. **Flexible**: Different modules can inject different content
|
||||
|
||||
## Adding Support for a New IDE
|
||||
|
||||
1. Create sub-module folder: `src/modules/{module}/sub-modules/{new-ide}/`
|
||||
2. Add `injections.yaml` with IDE-specific content
|
||||
3. Update IDE installer to process injections using this standard
|
||||
4. Test installation with and without the IDE selected
|
||||
|
||||
## Example: BMM Module with Claude Code
|
||||
|
||||
### File Structure
|
||||
|
||||
```
|
||||
src/modules/bmm/
|
||||
├── agents/pm.md # Has injection point
|
||||
├── templates/prd.md # Has multiple injection points
|
||||
└── sub-modules/
|
||||
└── claude-code/
|
||||
├── injections.yaml # Defines what to inject
|
||||
└── sub-agents/ # Claude Code specific subagents
|
||||
├── market-researcher.md
|
||||
├── requirements-analyst.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
### Injection Point in pm.md
|
||||
|
||||
```xml
|
||||
<agent>
|
||||
<persona>...</persona>
|
||||
<!-- IDE-INJECT-POINT: pm-agent-instructions -->
|
||||
<cmds>...</cmds>
|
||||
</agent>
|
||||
```
|
||||
|
||||
### Injection Configuration
|
||||
|
||||
```yaml
|
||||
injections:
|
||||
- file: '{bmad_folder}/bmm/agents/pm.md'
|
||||
point: 'pm-agent-instructions'
|
||||
requires: 'any' # Injected if ANY subagent is selected
|
||||
content: |
|
||||
<llm critical="true">
|
||||
<i>Use 'market-researcher' subagent for analysis</i>
|
||||
</llm>
|
||||
|
||||
- file: '{bmad_folder}/bmm/templates/prd.md'
|
||||
point: 'prd-goals-context-delegation'
|
||||
requires: 'market-researcher' # Only if this specific subagent selected
|
||||
content: |
|
||||
<i>DELEGATE: Use 'market-researcher' subagent...</i>
|
||||
```
|
||||
|
||||
### Result After Installation
|
||||
|
||||
```xml
|
||||
<agent>
|
||||
<persona>...</persona>
|
||||
<llm critical="true">
|
||||
<i>Use 'market-researcher' subagent for analysis</i>
|
||||
</llm>
|
||||
<cmds>...</cmds>
|
||||
</agent>
|
||||
```
|
||||
@@ -1,388 +0,0 @@
|
||||
# BMAD Installation & Module System Reference
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Overview](#overview)
|
||||
2. [Quick Start](#quick-start)
|
||||
3. [Architecture](#architecture)
|
||||
4. [Modules](#modules)
|
||||
5. [Configuration System](#configuration-system)
|
||||
6. [Platform Integration](#platform-integration)
|
||||
7. [Development Guide](#development-guide)
|
||||
8. [Troubleshooting](#troubleshooting)
|
||||
|
||||
## Overview
|
||||
|
||||
BMad Core is a modular AI agent framework with intelligent installation, platform-agnostic support, and configuration inheritance.
|
||||
|
||||
### Key Features
|
||||
|
||||
- **Modular Design**: Core + optional modules (BMB, BMM, CIS)
|
||||
- **Smart Installation**: Interactive configuration with dependency resolution
|
||||
- **Clean Architecture**: Centralized `{bmad_folder}` directory add to project, no source pollution with multiple folders added
|
||||
|
||||
## Architecture
|
||||
|
||||
### Directory Structure upon installation
|
||||
|
||||
```
|
||||
project-root/
|
||||
├── {bmad_folder}/ # Centralized installation
|
||||
│ ├── _cfg/ # Configuration
|
||||
│ │ ├── agents/ # Agent configs
|
||||
│ │ └── agent-manifest.csv # Agent manifest
|
||||
│ ├── core/ # Core module
|
||||
│ │ ├── agents/
|
||||
│ │ ├── tasks/
|
||||
│ │ └── config.yaml
|
||||
│ ├── bmm/ # BMad Method module
|
||||
│ │ ├── agents/
|
||||
│ │ ├── tasks/
|
||||
│ │ ├── workflows/
|
||||
│ │ └── config.yaml
|
||||
│ └── cis/ # Creative Innovation Studio
|
||||
│ └── ...
|
||||
└── .claude/ # Platform-specific (example)
|
||||
└── agents/
|
||||
```
|
||||
|
||||
### Installation Flow
|
||||
|
||||
1. **Detection**: Check existing installation
|
||||
2. **Selection**: Choose modules interactively or via CLI
|
||||
3. **Configuration**: Collect module-specific settings
|
||||
4. **Installation**: Compile Process and copy files
|
||||
5. **Generation**: Create config files with inheritance
|
||||
6. **Post-Install**: Run module installers
|
||||
7. **Manifest**: Track installed components
|
||||
|
||||
### Key Exclusions
|
||||
|
||||
- `_module-installer/` directories are never copied to destination
|
||||
- `localskip="true"` agents are filtered out
|
||||
- Source `config.yaml` templates are replaced with generated configs
|
||||
|
||||
## Modules
|
||||
|
||||
### Core Module (Required)
|
||||
|
||||
Foundation framework with C.O.R.E. (Collaboration Optimized Reflection Engine)
|
||||
|
||||
- **Components**: Base agents, activation system, advanced elicitation
|
||||
- **Config**: `user_name`, `communication_language`
|
||||
|
||||
### BMM Module
|
||||
|
||||
BMad Method for software development workflows
|
||||
|
||||
- **Components**: PM agent, dev tasks, PRD templates, story generation
|
||||
- **Config**: `project_name`, `tech_docs`, `output_folder`, `story_location`
|
||||
- **Dependencies**: Core
|
||||
|
||||
### CIS Module
|
||||
|
||||
Creative Innovation Studio for design workflows
|
||||
|
||||
- **Components**: Design agents, creative tasks
|
||||
- **Config**: `output_folder`, design preferences
|
||||
- **Dependencies**: Core
|
||||
|
||||
### Module Structure
|
||||
|
||||
```
|
||||
src/modules/{module}/
|
||||
├── _module-installer/ # Not copied to destination
|
||||
│ ├── installer.js # Post-install logic
|
||||
│ └── install-config.yaml
|
||||
├── agents/
|
||||
├── tasks/
|
||||
├── templates/
|
||||
└── sub-modules/ # Platform-specific content
|
||||
└── {platform}/
|
||||
├── injections.yaml
|
||||
└── sub-agents/
|
||||
```
|
||||
|
||||
## Configuration System
|
||||
|
||||
### Collection Process
|
||||
|
||||
Modules define prompts in `install-config.yaml`:
|
||||
|
||||
```yaml
|
||||
project_name:
|
||||
prompt: 'Project title?'
|
||||
default: 'My Project'
|
||||
result: '{value}'
|
||||
|
||||
output_folder:
|
||||
prompt: 'Output location?'
|
||||
default: 'docs'
|
||||
result: '{project-root}/{value}'
|
||||
|
||||
tools:
|
||||
prompt: 'Select tools:'
|
||||
multi-select:
|
||||
- 'Tool A'
|
||||
- 'Tool B'
|
||||
```
|
||||
|
||||
### Configuration Inheritance
|
||||
|
||||
Core values cascade to ALL modules automatically:
|
||||
|
||||
```yaml
|
||||
# core/config.yaml
|
||||
user_name: "Jane"
|
||||
communication_language: "English"
|
||||
|
||||
# bmm/config.yaml (generated)
|
||||
project_name: "My App"
|
||||
tech_docs: "/path/to/docs"
|
||||
# Core Configuration Values (inherited)
|
||||
user_name: "Jane"
|
||||
communication_language: "English"
|
||||
```
|
||||
|
||||
**Reserved Keys**: Core configuration keys cannot be redefined by other modules.
|
||||
|
||||
### Path Placeholders
|
||||
|
||||
- `{project-root}`: Project directory path
|
||||
- `{value}`: User input
|
||||
- `{module}`: Module name
|
||||
- `{core:field}`: Reference core config value
|
||||
|
||||
### Config Generation Rules
|
||||
|
||||
1. ALL installed modules get a `config.yaml` (even without prompts)
|
||||
2. Core values are ALWAYS included in module configs
|
||||
3. Module-specific values come first, core values appended
|
||||
4. Source templates are never copied, only generated configs
|
||||
|
||||
## Platform Integration
|
||||
|
||||
### Supported Platforms
|
||||
|
||||
**Preferred** (Full Integration):
|
||||
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
|
||||
**Additional**:
|
||||
Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlow
|
||||
|
||||
### Platform Features
|
||||
|
||||
1. **Setup Handler** (`tools/cli/installers/lib/ide/{platform}.js`)
|
||||
- Directory creation
|
||||
- Configuration generation
|
||||
- Agent processing
|
||||
|
||||
2. **Content Injection** (`sub-modules/{platform}/injections.yaml`)
|
||||
|
||||
```yaml
|
||||
injections:
|
||||
- file: '{bmad_folder}/bmm/agents/pm.md'
|
||||
point: 'pm-agent-instructions'
|
||||
content: |
|
||||
<i>Platform-specific instruction</i>
|
||||
|
||||
subagents:
|
||||
source: 'sub-agents'
|
||||
target: '.claude/agents'
|
||||
files: ['agent.md']
|
||||
```
|
||||
|
||||
3. **Interactive Config**
|
||||
- Subagent selection
|
||||
- Installation scope (project/user)
|
||||
- Feature toggles
|
||||
|
||||
### Injection System
|
||||
|
||||
Platform-specific content without source modification:
|
||||
|
||||
- Inject points marked in source: `<!-- IDE-INJECT-POINT:name -->`
|
||||
- Content added during installation only
|
||||
- Source files remain clean
|
||||
|
||||
## Development Guide
|
||||
|
||||
### Creating a Module
|
||||
|
||||
1. **Structure**
|
||||
|
||||
```
|
||||
src/modules/mymod/
|
||||
├── _module-installer/
|
||||
│ ├── installer.js
|
||||
│ └── install-config.yaml
|
||||
├── agents/
|
||||
└── tasks/
|
||||
```
|
||||
|
||||
2. **Configuration** (`install-config.yaml`)
|
||||
|
||||
```yaml
|
||||
code: mymod
|
||||
name: 'My Module'
|
||||
prompt: 'Welcome message'
|
||||
|
||||
setting_name:
|
||||
prompt: 'Configure X?'
|
||||
default: 'value'
|
||||
```
|
||||
|
||||
3. **Installer** (`installer.js`)
|
||||
```javascript
|
||||
async function install(options) {
|
||||
const { projectRoot, config, installedIDEs, logger } = options;
|
||||
// Custom logic
|
||||
return true;
|
||||
}
|
||||
module.exports = { install };
|
||||
```
|
||||
|
||||
### Adding Platform Support
|
||||
|
||||
1. Create handler: `tools/cli/installers/lib/ide/myplatform.js`
|
||||
2. Extend `BaseIdeSetup` class
|
||||
3. Add sub-module: `src/modules/{mod}/sub-modules/myplatform/`
|
||||
4. Define injections and platform agents
|
||||
|
||||
### Agent Configuration
|
||||
|
||||
Extractable config nodes:
|
||||
|
||||
```xml
|
||||
<agent>
|
||||
<setting agentConfig="true">
|
||||
Default value
|
||||
</setting>
|
||||
</agent>
|
||||
```
|
||||
|
||||
Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
| Issue | Solution |
|
||||
| ----------------------- | -------------------------------------------- |
|
||||
| Existing installation | Use `bmad update` or remove `{bmad_folder}/` |
|
||||
| Module not found | Check `src/modules/` exists |
|
||||
| Config not applied | Verify `{bmad_folder}/{module}/config.yaml` |
|
||||
| Missing config.yaml | Fixed: All modules now get configs |
|
||||
| Agent unavailable | Check for `localskip="true"` |
|
||||
| module-installer copied | Fixed: Now excluded from copy |
|
||||
|
||||
### Debug Commands
|
||||
|
||||
```bash
|
||||
bmad install -v # Verbose installation
|
||||
bmad status -v # Detailed status
|
||||
```
|
||||
|
||||
### Best Practices
|
||||
|
||||
1. Run from project root
|
||||
2. Backup `{bmad_folder}/_cfg/` before updates
|
||||
3. Use interactive mode for guidance
|
||||
4. Review generated configs post-install
|
||||
|
||||
## Migration from v4
|
||||
|
||||
| v4 | v6 |
|
||||
| ------------------- | ---------------------------- |
|
||||
| Scattered files | Centralized `{bmad_folder}/` |
|
||||
| Monolithic | Modular |
|
||||
| Manual config | Interactive setup |
|
||||
| Limited IDE support | 15+ platforms |
|
||||
| Source modification | Clean injection |
|
||||
|
||||
## Technical Notes
|
||||
|
||||
### Dependency Resolution
|
||||
|
||||
- Direct dependencies (module → module)
|
||||
- Agent references (cross-module)
|
||||
- Template dependencies
|
||||
- Partial module installation (only required files)
|
||||
- Workflow vendoring for standalone module operation
|
||||
|
||||
## Workflow Vendoring
|
||||
|
||||
**Problem**: Modules that reference workflows from other modules create dependencies, forcing users to install multiple modules even when they only need one.
|
||||
|
||||
**Solution**: Workflow vendoring allows modules to copy workflows from other modules during installation, making them fully standalone.
|
||||
|
||||
### How It Works
|
||||
|
||||
Agents can specify both `workflow` (source location) and `workflow-install` (destination location) in their menu items:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: create-story
|
||||
workflow: '{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml'
|
||||
workflow-install: '{project-root}/{bmad_folder}/bmgd/workflows/4-production/create-story/workflow.yaml'
|
||||
description: 'Create a game feature story'
|
||||
```
|
||||
|
||||
**During Installation:**
|
||||
|
||||
1. **Vendoring Phase**: Before copying module files, the installer:
|
||||
- Scans source agent YAML files for `workflow-install` attributes
|
||||
- Copies entire workflow folders from `workflow` path to `workflow-install` path
|
||||
- Updates vendored `workflow.yaml` files to reference target module's config
|
||||
|
||||
2. **Compilation Phase**: When compiling agents:
|
||||
- If `workflow-install` exists, uses its value for the `workflow` attribute
|
||||
- `workflow-install` is build-time metadata only, never appears in final XML
|
||||
- Compiled agent references vendored workflow location
|
||||
|
||||
3. **Config Update**: Vendored workflows get their `config_source` updated:
|
||||
|
||||
```yaml
|
||||
# Source workflow (in bmm):
|
||||
config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
|
||||
|
||||
# Vendored workflow (in bmgd):
|
||||
config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
|
||||
```
|
||||
|
||||
**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.
|
||||
|
||||
### Example Use Case: BMGD Module
|
||||
|
||||
The BMad Game Development module vendors implementation workflows from BMM:
|
||||
|
||||
- Game Dev Scrum Master agent references BMM workflows
|
||||
- During installation, workflows are copied to `bmgd/workflows/4-production/`
|
||||
- Vendored workflows use BMGD's config (with game-specific settings)
|
||||
- BMGD can be installed without BMM dependency
|
||||
|
||||
### Benefits
|
||||
|
||||
✅ **Module Independence** - No forced dependencies
|
||||
✅ **Clean Namespace** - Workflows live in their module
|
||||
✅ **Config Isolation** - Each module uses its own configuration
|
||||
✅ **Customization Ready** - Vendored workflows can be modified independently
|
||||
✅ **No User Confusion** - Avoid partial module installations
|
||||
|
||||
### File Processing
|
||||
|
||||
- Filters `localskip="true"` agents
|
||||
- Excludes `_module-installer/` directories
|
||||
- Replaces path placeholders at runtime
|
||||
- Injects activation blocks
|
||||
- Vendors cross-module workflows (see Workflow Vendoring below)
|
||||
|
||||
### Web Bundling
|
||||
|
||||
```bash
|
||||
bmad bundle --web # Filter for web deployment
|
||||
npm run validate:bundles # Validate bundles
|
||||
```
|
||||
166
docs/modules/bmb-bmad-builder/agent-creation-guide.md
Normal file
166
docs/modules/bmb-bmad-builder/agent-creation-guide.md
Normal file
@@ -0,0 +1,166 @@
|
||||
# Agent Creation Guide
|
||||
|
||||
Create your own custom agents using the BMAD Builder workflow.
|
||||
|
||||
## Overview
|
||||
|
||||
The BMAD Builder (BMB) module provides an interactive workflow that guides you through creating a custom agent from concept to completion. You define the agent's purpose, personality, capabilities, and menu - then the workflow generates a complete, ready-to-use agent file.
|
||||
|
||||
## Before You Start
|
||||
|
||||
**Prerequisites:**
|
||||
- BMAD installed with the BMB module
|
||||
- An idea for what you want your agent to do
|
||||
- About 15-30 minutes for your first agent
|
||||
|
||||
**Know Before You Go:**
|
||||
- What problem should your agent solve?
|
||||
- Who will use this agent?
|
||||
- What should the agent be able to do?
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Start the Workflow
|
||||
|
||||
In your IDE (Claude Code, Cursor, etc.), invoke the create-agent workflow:
|
||||
|
||||
```
|
||||
"Run the BMAD Builder create-agent workflow"
|
||||
```
|
||||
|
||||
Or trigger it via the BMAD Master menu.
|
||||
|
||||
### 2. Follow the Steps
|
||||
|
||||
The workflow guides you through:
|
||||
|
||||
| Step | What You'll Do |
|
||||
|------|----------------|
|
||||
| **Brainstorm** (optional) | Explore ideas with creative techniques |
|
||||
| **Discovery** | Define the agent's purpose and goals |
|
||||
| **Type & Metadata** | Choose Simple or Expert, name your agent |
|
||||
| **Persona** | Craft the agent's personality and principles |
|
||||
| **Commands** | Define what the agent can do |
|
||||
| **Activation** | Set up autonomous behaviors (optional) |
|
||||
| **Build** | Generate the agent file |
|
||||
| **Validation** | Review and verify everything works |
|
||||
|
||||
### 3. Install Your Agent
|
||||
|
||||
Once created, package your agent for installation:
|
||||
|
||||
```
|
||||
my-custom-stuff/
|
||||
├── module.yaml # Contains: unitary: true
|
||||
├── agents/
|
||||
│ └── {agent-name}/
|
||||
│ ├── {agent-name}.agent.yaml
|
||||
│ └── _memory/ # Expert agents only
|
||||
│ └── {sidecar-folder}/
|
||||
└── workflows/ # Optional: custom workflows
|
||||
```
|
||||
|
||||
See [Custom Content Installation](./custom-content-installation.md) for details.
|
||||
|
||||
## Choosing Your Agent Type
|
||||
|
||||
The workflow will help you decide, but here's the quick reference:
|
||||
|
||||
### Choose Simple Agent When:
|
||||
|
||||
- Task is well-defined and focused
|
||||
- Don't need persistent memory
|
||||
- Want fast setup and deployment
|
||||
- Single-purpose assistant (e.g., commit messages, code review)
|
||||
|
||||
**Example:** A "Code Commenter" that reads files and adds helpful comments.
|
||||
|
||||
### Choose Expert Agent When:
|
||||
|
||||
- Domain requires specialized knowledge
|
||||
- Need persistent memory across sessions
|
||||
- Agent coordinates complex workflows
|
||||
- Building ongoing project infrastructure
|
||||
|
||||
**Example:** A "Security Architect" that remembers your design decisions and maintains security standards across the project.
|
||||
|
||||
### Choose Module Agent When:
|
||||
|
||||
- Agent builds other agents or workflows
|
||||
- Need integration with module system
|
||||
- Creating professional tooling
|
||||
|
||||
**Example:** A "Team Builder" that helps set up agents for new team members.
|
||||
|
||||
## The Persona System
|
||||
|
||||
Your agent's personality is defined by four fields:
|
||||
|
||||
| Field | Purpose | Example |
|
||||
|-------|---------|---------|
|
||||
| **Role** | What they do | "Senior code reviewer who catches bugs and suggests improvements" |
|
||||
| **Identity** | Who they are | "Friendly but exacting, believes clean code is a craft" |
|
||||
| **Communication Style** | How they speak | "Direct, constructive, explains the 'why' behind suggestions" |
|
||||
| **Principles** | Why they act | "Security first, clarity over cleverness, test what you fix" |
|
||||
|
||||
**Key:** Keep each field focused on its purpose. The role isn't personality; the identity isn't job description.
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### Start Small
|
||||
|
||||
Your first agent should solve **one problem well**. You can always add more capabilities later.
|
||||
|
||||
### Learn by Example
|
||||
|
||||
Study the reference agents in `src/modules/bmb/reference/agents/`:
|
||||
- **Simple:** [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)
|
||||
- **Expert:** [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper)
|
||||
|
||||
### Write Great Principles
|
||||
|
||||
The first principle should "activate" the agent's expertise:
|
||||
|
||||
❌ **Weak:** "Be helpful and accurate"
|
||||
✅ **Strong:** "Channel decades of security expertise: threat modeling begins with trust boundaries, never trust client input, defense in depth is non-negotiable"
|
||||
|
||||
### Use the Menu System
|
||||
|
||||
The workflow provides options at each step:
|
||||
- **[A] Advanced** - Get deeper insights and reasoning
|
||||
- **[P] Party** - Get multiple agent perspectives
|
||||
- **[C] Continue** - Move to the next step
|
||||
|
||||
Use these when you need extra input or creative options.
|
||||
|
||||
## After Creation
|
||||
|
||||
### Test Your Agent
|
||||
|
||||
1. Install your custom module using the BMAD installer
|
||||
2. Invoke your new agent in your IDE
|
||||
3. Try each menu command
|
||||
4. Verify the personality feels right
|
||||
|
||||
### Iterate
|
||||
|
||||
If something isn't right:
|
||||
1. Edit the agent YAML directly, or
|
||||
2. Edit the customization file in `_bmad/_config/agents/`
|
||||
3. Rebuild using `npx bmad-method build <agent-name>`
|
||||
|
||||
### Share
|
||||
|
||||
Package your agent as a standalone module (see [Installation Guide](../../bmad-core-concepts/installing/)) and share it with your team or the community.
|
||||
|
||||
## Further Reading
|
||||
|
||||
- **[Agent Architecture](./index.md)** - Deep technical details on agent types
|
||||
- **[Agent Customization](../../bmad-core-concepts/agent-customization/)** - Modify agents without editing core files
|
||||
- **[Custom Content Installation](./custom-content-installation.md)** - Package and distribute your agents
|
||||
|
||||
---
|
||||
|
||||
**Ready?** Start the workflow and create your first agent!
|
||||
|
||||
[← Back to BMB Documentation](./index.md)
|
||||
149
docs/modules/bmb-bmad-builder/custom-content-installation.md
Normal file
149
docs/modules/bmb-bmad-builder/custom-content-installation.md
Normal file
@@ -0,0 +1,149 @@
|
||||
# Custom Content Installation
|
||||
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||
|
||||
For detailed information about the different types of custom content available, see [Custom Content](modules/bmb-bmad-builder/custom-content.md).
|
||||
|
||||
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
|
||||
|
||||
## Content Types Overview
|
||||
|
||||
BMAD Core supports several categories of custom content:
|
||||
|
||||
- Custom Stand Alone Modules
|
||||
- Custom Add On Modules
|
||||
- Custom Global Modules
|
||||
- Custom Agents
|
||||
- Custom Workflows
|
||||
|
||||
## Making Custom Content Installable
|
||||
|
||||
### Custom Modules
|
||||
|
||||
To create an installable custom module:
|
||||
|
||||
1. **Folder Structure**
|
||||
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
||||
- The folder name serves as the module code
|
||||
|
||||
2. **Required File**
|
||||
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
|
||||
|
||||
3. **Folder Organization**
|
||||
Follow these conventions for optimal compatibility:
|
||||
|
||||
```
|
||||
module-code/
|
||||
module.yaml
|
||||
agents/
|
||||
workflows/
|
||||
tools/
|
||||
templates/
|
||||
...
|
||||
```
|
||||
|
||||
- `agents/` - Agent definitions
|
||||
- `workflows/` - Workflow definitions
|
||||
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
|
||||
|
||||
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
|
||||
|
||||
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
|
||||
|
||||
For standalone content that isn't part of a cohesive module collection, follow this structure:
|
||||
|
||||
1. **Module Configuration**
|
||||
- Create a folder with a `module.yaml` file (similar to custom modules)
|
||||
- Add the property `unitary: true` in the module.yaml
|
||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
|
||||
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules (See [Workflow Vendoring, Customization, and Inheritance](workflow-vendoring-customization-inheritance.md)).
|
||||
|
||||
2. **Folder Structure**
|
||||
Organize content in specific named folders:
|
||||
|
||||
```
|
||||
module-name/
|
||||
module.yaml # Contains unitary: true
|
||||
agents/
|
||||
workflows/
|
||||
templates/
|
||||
tools/
|
||||
tasks/
|
||||
prompts/
|
||||
```
|
||||
|
||||
3. **Individual Item Organization**
|
||||
Each item should have its own subfolder:
|
||||
```text
|
||||
my-custom-stuff/
|
||||
module.yaml
|
||||
agents/
|
||||
larry/larry.agent.md
|
||||
curly/curly.agent.md
|
||||
moe/moe.agent.md
|
||||
moe/moe-sidecar/memories.csv
|
||||
```
|
||||
|
||||
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install.
|
||||
|
||||
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon.
|
||||
|
||||
## Installation Process
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder).
|
||||
|
||||
### New Project Installation
|
||||
|
||||
When setting up a new BMAD project:
|
||||
|
||||
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)`
|
||||
2. Select 'y' to specify the path to your module folder containing `module.yaml`
|
||||
|
||||
### Existing Project Modification
|
||||
|
||||
To add custom content to an existing BMAD project:
|
||||
|
||||
1. Run the installer against your project location
|
||||
2. Select `Modify BMAD Installation`
|
||||
3. Choose the option to add, modify, or update custom modules
|
||||
|
||||
### Upcoming Features
|
||||
|
||||
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install
|
||||
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
|
||||
|
||||
## Quick Updates
|
||||
|
||||
When updates to BMAD Core or core modules (BMM, CIS, etc.) become available, the quick update process will:
|
||||
|
||||
1. Apply available updates to core modules
|
||||
2. Recompile all agents with customizations from the `_config/agents` folder
|
||||
3. Retain your custom content from a cached location
|
||||
4. Preserve your existing configurations and customizations
|
||||
|
||||
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process.
|
||||
|
||||
## Important Considerations
|
||||
|
||||
### Module Naming Conflicts
|
||||
|
||||
When installing unofficial modules, ensure unique identification to avoid conflicts:
|
||||
|
||||
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules)
|
||||
2. **Module Names:** Avoid using names that conflict with existing modules
|
||||
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
|
||||
|
||||
**Examples of conflicts to avoid:**
|
||||
|
||||
- Don't create a custom module with code `bmm` (already used by BMad Method)
|
||||
- Don't name multiple custom modules with the same code like `mca`
|
||||
|
||||
### Best Practices
|
||||
|
||||
- Use descriptive, unique codes for your modules
|
||||
- Document any dependencies your custom modules have
|
||||
- Test custom modules in isolation before sharing
|
||||
- Consider version numbering for your custom content to track updates
|
||||
121
docs/modules/bmb-bmad-builder/custom-content.md
Normal file
121
docs/modules/bmb-bmad-builder/custom-content.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# 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 Content](#custom-content)
|
||||
- [Categories](#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)
|
||||
- [BMad Tiny Agents](#bmad-tiny-agents)
|
||||
- [Simple and Expert Agents](#simple-and-expert-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](./custom-content-installation.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.
|
||||
60
docs/modules/bmb-bmad-builder/index.md
Normal file
60
docs/modules/bmb-bmad-builder/index.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# BMB Module Documentation
|
||||
|
||||
Create custom agents, workflows, and modules for BMAD.
|
||||
|
||||
## Quick Start
|
||||
|
||||
- **[Agent Creation Guide](./agent-creation-guide.md)** - Step-by-step guide to building your first agent
|
||||
- **[Understanding Agent Types](./understanding-agent-types.md)** - Learn the differences between Simple and Expert agents
|
||||
|
||||
## Agent Architecture
|
||||
|
||||
Comprehensive guides for each agent type (choose based on use case):
|
||||
|
||||
- [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways"
|
||||
- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven
|
||||
- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions
|
||||
- Module Agent Architecture _(TODO)_ - Workflow integration, professional tools
|
||||
|
||||
## Agent Design Patterns
|
||||
|
||||
- [Agent Menu Patterns](./agent-menu-patterns.md) - Menu handlers, triggers, prompts, organization
|
||||
- [Agent Compilation](./agent-compilation.md) - What compiler auto-injects (AVOID DUPLICATION)
|
||||
|
||||
## Reference Examples
|
||||
|
||||
Production-ready examples in [bmb/reference/agents/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents):
|
||||
|
||||
**Simple Agents** ([simple-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples))
|
||||
|
||||
- [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) - Commit message artisan with style customization
|
||||
|
||||
**Expert Agents** ([expert-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples))
|
||||
|
||||
- [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) - Personal journal companion with memory and pattern recognition
|
||||
|
||||
**Module Agents** ([module-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/module-examples))
|
||||
|
||||
- [security-engineer.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml) - BMM security specialist with threat modeling
|
||||
- [trend-analyst.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml) - CIS trend intelligence expert
|
||||
|
||||
## Installation Guide
|
||||
|
||||
For installing standalone simple and expert agents, see:
|
||||
|
||||
- [Custom Agent Installation](/docs/modules/bmb-bmad-builder/custom-content-installation.md)
|
||||
|
||||
## 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 (YOU don't write this)
|
||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
||||
|
||||
**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content.
|
||||
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
@@ -0,0 +1,42 @@
|
||||
# Workflow Vendoring, Customization, and Inheritance (Official Support Consing Soon)
|
||||
|
||||
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
|
||||
|
||||
## Workflow Vendoring
|
||||
|
||||
Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs.
|
||||
|
||||
### How to Vendor
|
||||
|
||||
Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent.
|
||||
|
||||
From your modules agent definition, you would implement the menu item as follows in the agent:
|
||||
|
||||
```yaml
|
||||
- trigger: develop-story
|
||||
exec-vendor: "{project-root}/_bmad/<source-module>/workflows/4-production/dev-story/workflow.md"
|
||||
exec: "{project-root}/_bmad/<my-module>/workflows/dev-story/workflow.md"
|
||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
||||
```
|
||||
|
||||
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
||||
|
||||
## Workflow Inheritance (Official Support Coming Post Beta)
|
||||
|
||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
||||
|
||||
Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific.
|
||||
|
||||
Some possible examples could be:
|
||||
|
||||
- Retrospective
|
||||
- Sprint Planning
|
||||
- Collaborative Brainstorming Sessions
|
||||
|
||||
## Workflow Customization (Official Support Coming Post Beta)
|
||||
|
||||
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
||||
|
||||
This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time.
|
||||
|
||||
For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow.
|
||||
407
docs/modules/bmgd-bmad-game-dev/agents-guide.md
Normal file
407
docs/modules/bmgd-bmad-game-dev/agents-guide.md
Normal file
@@ -0,0 +1,407 @@
|
||||
# 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](./quick-start.md)** - Get started with BMGD
|
||||
- **[Workflows Guide](./workflows-guide.md)** - Detailed workflow reference
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Game type templates
|
||||
503
docs/modules/bmgd-bmad-game-dev/game-types-guide.md
Normal file
503
docs/modules/bmgd-bmad-game-dev/game-types-guide.md
Normal file
@@ -0,0 +1,503 @@
|
||||
# BMGD Game Types Guide
|
||||
|
||||
Reference for selecting and using BMGD's 24 supported game type templates.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
|
||||
|
||||
---
|
||||
|
||||
## Supported Game Types
|
||||
|
||||
### Action & Combat
|
||||
|
||||
#### Action Platformer
|
||||
|
||||
**Tags:** action, platformer, combat, movement
|
||||
|
||||
Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Celeste with combat, or Mega Man.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Movement systems (jumps, dashes, wall mechanics)
|
||||
- Combat mechanics (melee/ranged, combos)
|
||||
- Level design patterns
|
||||
- Boss design
|
||||
|
||||
---
|
||||
|
||||
#### Shooter
|
||||
|
||||
**Tags:** shooter, combat, aiming, fps, tps
|
||||
|
||||
Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Weapon systems
|
||||
- Aiming and accuracy
|
||||
- Enemy AI patterns
|
||||
- Level/arena design
|
||||
- Multiplayer considerations
|
||||
|
||||
---
|
||||
|
||||
#### Fighting
|
||||
|
||||
**Tags:** fighting, combat, competitive, combos, pvp
|
||||
|
||||
1v1 combat with combos and frame data. Traditional fighters and platform fighters.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Frame data systems
|
||||
- Combo mechanics
|
||||
- Character movesets
|
||||
- Competitive balance
|
||||
- Netcode requirements
|
||||
|
||||
---
|
||||
|
||||
### Strategy & Tactics
|
||||
|
||||
#### Strategy
|
||||
|
||||
**Tags:** strategy, tactics, resources, planning
|
||||
|
||||
Resource management with tactical decisions. RTS, 4X, and grand strategy.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Resource systems
|
||||
- Unit/building design
|
||||
- AI opponent behavior
|
||||
- Map/scenario design
|
||||
- Victory conditions
|
||||
|
||||
---
|
||||
|
||||
#### Turn-Based Tactics
|
||||
|
||||
**Tags:** tactics, turn-based, grid, positioning
|
||||
|
||||
Grid-based movement with turn order. XCOM-likes and tactical RPGs.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Grid and movement systems
|
||||
- Turn order mechanics
|
||||
- Cover and positioning
|
||||
- Unit progression
|
||||
- Procedural mission generation
|
||||
|
||||
---
|
||||
|
||||
#### Tower Defense
|
||||
|
||||
**Tags:** tower-defense, waves, placement, strategy
|
||||
|
||||
Wave-based defense with tower placement.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Tower types and upgrades
|
||||
- Wave design and pacing
|
||||
- Economy systems
|
||||
- Map design patterns
|
||||
- Meta-progression
|
||||
|
||||
---
|
||||
|
||||
### RPG & Progression
|
||||
|
||||
#### RPG
|
||||
|
||||
**Tags:** rpg, stats, inventory, quests, narrative
|
||||
|
||||
Character progression with stats, inventory, and quests.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Character stats and leveling
|
||||
- Inventory and equipment
|
||||
- Quest system design
|
||||
- Combat system (action/turn-based)
|
||||
- Skill trees and builds
|
||||
|
||||
---
|
||||
|
||||
#### Roguelike
|
||||
|
||||
**Tags:** roguelike, procedural, permadeath, runs
|
||||
|
||||
Procedural generation with permadeath and run-based progression.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Procedural generation rules
|
||||
- Permadeath and persistence
|
||||
- Run structure and pacing
|
||||
- Item/ability synergies
|
||||
- Meta-progression systems
|
||||
|
||||
---
|
||||
|
||||
#### Metroidvania
|
||||
|
||||
**Tags:** metroidvania, exploration, abilities, interconnected
|
||||
|
||||
Interconnected world with ability gating.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- World map connectivity
|
||||
- Ability gating design
|
||||
- Backtracking flow
|
||||
- Secret and collectible placement
|
||||
- Power-up progression
|
||||
|
||||
---
|
||||
|
||||
### Narrative & Story
|
||||
|
||||
#### Adventure
|
||||
|
||||
**Tags:** adventure, narrative, exploration, story
|
||||
|
||||
Story-driven exploration and narrative. Point-and-click and narrative adventures.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Puzzle design
|
||||
- Narrative delivery
|
||||
- Exploration mechanics
|
||||
- Dialogue systems
|
||||
- Story branching
|
||||
|
||||
---
|
||||
|
||||
#### Visual Novel
|
||||
|
||||
**Tags:** visual-novel, narrative, choices, story
|
||||
|
||||
Narrative choices with branching story.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Branching narrative structure
|
||||
- Choice and consequence
|
||||
- Character routes
|
||||
- UI/presentation
|
||||
- Save/load states
|
||||
|
||||
---
|
||||
|
||||
#### Text-Based
|
||||
|
||||
**Tags:** text, parser, interactive-fiction, mud
|
||||
|
||||
Text input/output games. Parser games, choice-based IF, MUDs.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Parser or choice systems
|
||||
- World model
|
||||
- Narrative structure
|
||||
- Text presentation
|
||||
- Save state management
|
||||
|
||||
---
|
||||
|
||||
### Simulation & Management
|
||||
|
||||
#### Simulation
|
||||
|
||||
**Tags:** simulation, management, sandbox, systems
|
||||
|
||||
Realistic systems with management and building. Includes tycoons and sim games.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Core simulation loops
|
||||
- Economy modeling
|
||||
- AI agents/citizens
|
||||
- Building/construction
|
||||
- Failure states
|
||||
|
||||
---
|
||||
|
||||
#### Sandbox
|
||||
|
||||
**Tags:** sandbox, creative, building, freedom
|
||||
|
||||
Creative freedom with building and minimal objectives.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Creation tools
|
||||
- Physics/interaction systems
|
||||
- Persistence and saving
|
||||
- Sharing/community features
|
||||
- Optional objectives
|
||||
|
||||
---
|
||||
|
||||
### Sports & Racing
|
||||
|
||||
#### Racing
|
||||
|
||||
**Tags:** racing, vehicles, tracks, speed
|
||||
|
||||
Vehicle control with tracks and lap times.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Vehicle physics model
|
||||
- Track design
|
||||
- AI opponents
|
||||
- Progression/career mode
|
||||
- Multiplayer racing
|
||||
|
||||
---
|
||||
|
||||
#### Sports
|
||||
|
||||
**Tags:** sports, teams, realistic, physics
|
||||
|
||||
Team-based or individual sports simulation.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Sport-specific rules
|
||||
- Player/team management
|
||||
- AI opponent behavior
|
||||
- Season/career modes
|
||||
- Multiplayer modes
|
||||
|
||||
---
|
||||
|
||||
### Multiplayer
|
||||
|
||||
#### MOBA
|
||||
|
||||
**Tags:** moba, multiplayer, pvp, heroes, lanes
|
||||
|
||||
Multiplayer team battles with hero selection.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Hero/champion design
|
||||
- Lane and map design
|
||||
- Team composition
|
||||
- Matchmaking
|
||||
- Economy (gold/items)
|
||||
|
||||
---
|
||||
|
||||
#### Party Game
|
||||
|
||||
**Tags:** party, multiplayer, minigames, casual
|
||||
|
||||
Local multiplayer with minigames.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Minigame design patterns
|
||||
- Controller support
|
||||
- Round/game structure
|
||||
- Scoring systems
|
||||
- Player count flexibility
|
||||
|
||||
---
|
||||
|
||||
### Horror & Survival
|
||||
|
||||
#### Survival
|
||||
|
||||
**Tags:** survival, crafting, resources, danger
|
||||
|
||||
Resource gathering with crafting and persistent threats.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Resource gathering
|
||||
- Crafting systems
|
||||
- Hunger/health/needs
|
||||
- Threat systems
|
||||
- Base building
|
||||
|
||||
---
|
||||
|
||||
#### Horror
|
||||
|
||||
**Tags:** horror, atmosphere, tension, fear
|
||||
|
||||
Atmosphere and tension with limited resources.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Fear mechanics
|
||||
- Resource scarcity
|
||||
- Sound design
|
||||
- Lighting and visibility
|
||||
- Enemy/threat design
|
||||
|
||||
---
|
||||
|
||||
### Casual & Progression
|
||||
|
||||
#### Puzzle
|
||||
|
||||
**Tags:** puzzle, logic, cerebral
|
||||
|
||||
Logic-based challenges and problem-solving.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Puzzle mechanics
|
||||
- Difficulty progression
|
||||
- Hint systems
|
||||
- Level structure
|
||||
- Scoring/rating
|
||||
|
||||
---
|
||||
|
||||
#### Idle/Incremental
|
||||
|
||||
**Tags:** idle, incremental, automation, progression
|
||||
|
||||
Passive progression with upgrades and automation.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Core loop design
|
||||
- Prestige systems
|
||||
- Automation unlocks
|
||||
- Number scaling
|
||||
- Offline progress
|
||||
|
||||
---
|
||||
|
||||
#### Card Game
|
||||
|
||||
**Tags:** card, deck-building, strategy, turns
|
||||
|
||||
Deck building with card mechanics.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Card design framework
|
||||
- Deck building rules
|
||||
- Mana/resource systems
|
||||
- Rarity and collection
|
||||
- Competitive balance
|
||||
|
||||
---
|
||||
|
||||
### Rhythm
|
||||
|
||||
#### Rhythm
|
||||
|
||||
**Tags:** rhythm, music, timing, beats
|
||||
|
||||
Music synchronization with timing-based gameplay.
|
||||
|
||||
**GDD sections added:**
|
||||
|
||||
- Note/beat mapping
|
||||
- Scoring systems
|
||||
- Difficulty levels
|
||||
- Music licensing
|
||||
- Input methods
|
||||
|
||||
---
|
||||
|
||||
## Hybrid Game Types
|
||||
|
||||
Many games combine multiple genres. BMGD supports hybrid selection:
|
||||
|
||||
### Examples
|
||||
|
||||
**Action RPG** = Action Platformer + RPG
|
||||
|
||||
- Movement and combat systems from Action Platformer
|
||||
- Progression and stats from RPG
|
||||
|
||||
**Survival Horror** = Survival + Horror
|
||||
|
||||
- Resource and crafting from Survival
|
||||
- Atmosphere and fear from Horror
|
||||
|
||||
**Roguelike Deckbuilder** = Roguelike + Card Game
|
||||
|
||||
- Run structure from Roguelike
|
||||
- Card mechanics from Card Game
|
||||
|
||||
### How to Use Hybrids
|
||||
|
||||
During GDD creation, select multiple game types when prompted:
|
||||
|
||||
```
|
||||
Agent: What game type best describes your game?
|
||||
You: It's a roguelike with card game combat
|
||||
Agent: I'll include sections for both Roguelike and Card Game...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Game Type Selection Tips
|
||||
|
||||
### 1. Start with Core Fantasy
|
||||
|
||||
What does the player primarily DO in your game?
|
||||
|
||||
- Run and jump? → Platformer types
|
||||
- Build and manage? → Simulation types
|
||||
- Fight enemies? → Combat types
|
||||
- Make choices? → Narrative types
|
||||
|
||||
### 2. Consider Your Loop
|
||||
|
||||
What's the core gameplay loop?
|
||||
|
||||
- Session-based runs? → Roguelike
|
||||
- Long-term progression? → RPG
|
||||
- Quick matches? → Multiplayer types
|
||||
- Creative expression? → Sandbox
|
||||
|
||||
### 3. Don't Over-Combine
|
||||
|
||||
2-3 game types maximum. More than that usually means your design isn't focused enough.
|
||||
|
||||
### 4. Primary vs Secondary
|
||||
|
||||
One type should be primary (most gameplay time). Others add flavor:
|
||||
|
||||
- **Primary:** Platformer (core movement and exploration)
|
||||
- **Secondary:** Metroidvania (ability gating structure)
|
||||
|
||||
---
|
||||
|
||||
## GDD Section Mapping
|
||||
|
||||
When you select a game type, BMGD adds these GDD sections:
|
||||
|
||||
| Game Type | Key Sections Added |
|
||||
| ----------------- | -------------------------------------- |
|
||||
| Action Platformer | Movement, Combat, Level Design |
|
||||
| RPG | Stats, Inventory, Quests |
|
||||
| Roguelike | Procedural Gen, Runs, Meta-Progression |
|
||||
| Narrative | Story Structure, Dialogue, Branching |
|
||||
| Multiplayer | Matchmaking, Netcode, Balance |
|
||||
| Simulation | Systems, Economy, AI |
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
|
||||
- **[Workflows Guide](./workflows-guide.md)** - GDD workflow details
|
||||
- **[Glossary](./glossary.md)** - Game development terminology
|
||||
293
docs/modules/bmgd-bmad-game-dev/glossary.md
Normal file
293
docs/modules/bmgd-bmad-game-dev/glossary.md
Normal file
@@ -0,0 +1,293 @@
|
||||
# BMGD Glossary
|
||||
|
||||
Key game development terminology used in BMGD workflows.
|
||||
|
||||
---
|
||||
|
||||
## A
|
||||
|
||||
### Acceptance Criteria
|
||||
|
||||
Specific conditions that must be met for a story to be considered complete. Defines "done" for implementation.
|
||||
|
||||
### Act Structure
|
||||
|
||||
Story organization into major sections (typically 3 acts: Setup, Confrontation, Resolution).
|
||||
|
||||
---
|
||||
|
||||
## B
|
||||
|
||||
### Backlog
|
||||
|
||||
List of pending work items (epics, stories) waiting to be scheduled and implemented.
|
||||
|
||||
### Boss Design
|
||||
|
||||
Design of significant enemy encounters, typically featuring unique mechanics and increased challenge.
|
||||
|
||||
---
|
||||
|
||||
## C
|
||||
|
||||
### Character Arc
|
||||
|
||||
The transformation a character undergoes through the story, from initial state to final state.
|
||||
|
||||
### Core Fantasy
|
||||
|
||||
The emotional experience players seek from your game. What they want to FEEL.
|
||||
|
||||
### Core Loop
|
||||
|
||||
The fundamental cycle of actions players repeat throughout gameplay. The heart of your game.
|
||||
|
||||
---
|
||||
|
||||
## D
|
||||
|
||||
### Definition of Done (DoD)
|
||||
|
||||
Checklist of requirements that must be satisfied before work is considered complete.
|
||||
|
||||
### Design Pillar
|
||||
|
||||
Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity.
|
||||
|
||||
---
|
||||
|
||||
## E
|
||||
|
||||
### Environmental Storytelling
|
||||
|
||||
Narrative communicated through the game world itself—visual details, audio, found documents—rather than explicit dialogue.
|
||||
|
||||
### Epic
|
||||
|
||||
Large body of work that can be broken down into smaller stories. Represents a major feature or system.
|
||||
|
||||
---
|
||||
|
||||
## F
|
||||
|
||||
### Frame Data
|
||||
|
||||
In fighting games, the precise timing information for moves (startup, active, recovery frames).
|
||||
|
||||
### Frontmatter
|
||||
|
||||
YAML metadata at the beginning of markdown files, used for workflow state tracking.
|
||||
|
||||
---
|
||||
|
||||
## G
|
||||
|
||||
### Game Brief
|
||||
|
||||
Document capturing the game's core vision, pillars, target audience, and scope. Foundation for the GDD.
|
||||
|
||||
### Game Design Document (GDD)
|
||||
|
||||
Comprehensive document detailing all aspects of game design: mechanics, systems, content, and more.
|
||||
|
||||
### Game Type
|
||||
|
||||
Genre classification that determines which specialized GDD sections are included.
|
||||
|
||||
---
|
||||
|
||||
## H
|
||||
|
||||
### Hot Path
|
||||
|
||||
Code that executes frequently (every frame). Must be optimized for performance.
|
||||
|
||||
---
|
||||
|
||||
## I
|
||||
|
||||
### Idle Progression
|
||||
|
||||
Game mechanics where progress continues even when the player isn't actively playing.
|
||||
|
||||
---
|
||||
|
||||
## K
|
||||
|
||||
### Kishotenketsu
|
||||
|
||||
Four-act story structure from East Asian narrative tradition (Introduction, Development, Twist, Conclusion).
|
||||
|
||||
---
|
||||
|
||||
## L
|
||||
|
||||
### Localization
|
||||
|
||||
Adapting game content for different languages and cultures.
|
||||
|
||||
---
|
||||
|
||||
## M
|
||||
|
||||
### MDA Framework
|
||||
|
||||
Mechanics → Dynamics → Aesthetics. Framework for analyzing and designing games.
|
||||
|
||||
### Meta-Progression
|
||||
|
||||
Persistent progression that carries between individual runs or sessions.
|
||||
|
||||
### Metroidvania
|
||||
|
||||
Genre featuring interconnected world exploration with ability-gated progression.
|
||||
|
||||
---
|
||||
|
||||
## N
|
||||
|
||||
### Narrative Complexity
|
||||
|
||||
How central story is to the game experience (Critical, Heavy, Moderate, Light).
|
||||
|
||||
### Netcode
|
||||
|
||||
Networking code handling multiplayer communication and synchronization.
|
||||
|
||||
---
|
||||
|
||||
## P
|
||||
|
||||
### Permadeath
|
||||
|
||||
Game mechanic where character death is permanent, typically requiring a new run.
|
||||
|
||||
### Player Agency
|
||||
|
||||
The degree to which players can make meaningful choices that affect outcomes.
|
||||
|
||||
### Procedural Generation
|
||||
|
||||
Algorithmic creation of game content (levels, items, characters) rather than hand-crafted.
|
||||
|
||||
---
|
||||
|
||||
## R
|
||||
|
||||
### Retrospective
|
||||
|
||||
Team meeting after completing work to reflect on what went well and what to improve.
|
||||
|
||||
### Roguelike
|
||||
|
||||
Genre featuring procedural generation, permadeath, and run-based progression.
|
||||
|
||||
### Run
|
||||
|
||||
A single playthrough in a roguelike or run-based game, from start to death/completion.
|
||||
|
||||
---
|
||||
|
||||
## S
|
||||
|
||||
### Sprint
|
||||
|
||||
Time-boxed period of development work, typically 1-2 weeks.
|
||||
|
||||
### Sprint Status
|
||||
|
||||
Tracking document showing current sprint progress, story states, and blockers.
|
||||
|
||||
### Story
|
||||
|
||||
Smallest unit of implementable work with clear acceptance criteria. Part of an epic.
|
||||
|
||||
### Story Context
|
||||
|
||||
Assembled documentation and code context needed to implement a specific story.
|
||||
|
||||
### Story Gates
|
||||
|
||||
Points where story progression is blocked until certain gameplay conditions are met.
|
||||
|
||||
---
|
||||
|
||||
## T
|
||||
|
||||
### Tech Spec
|
||||
|
||||
Technical specification document detailing how a feature will be implemented.
|
||||
|
||||
### TDD (Test-Driven Development)
|
||||
|
||||
Development approach: write tests first, then implement code to pass them.
|
||||
|
||||
---
|
||||
|
||||
## U
|
||||
|
||||
### UI/UX
|
||||
|
||||
User Interface / User Experience. How players interact with and experience the game.
|
||||
|
||||
---
|
||||
|
||||
## V
|
||||
|
||||
### Visual Novel
|
||||
|
||||
Genre focused on narrative with static images, dialogue, and player choices.
|
||||
|
||||
### Voice Acting
|
||||
|
||||
Recorded spoken dialogue for game characters.
|
||||
|
||||
---
|
||||
|
||||
## W
|
||||
|
||||
### Workflow
|
||||
|
||||
Structured process for completing a specific type of work (e.g., GDD creation, story implementation).
|
||||
|
||||
### Workflow Status
|
||||
|
||||
Current state of project workflows, tracking which phases and documents are complete.
|
||||
|
||||
### World Building
|
||||
|
||||
Creation of the game's setting, including history, culture, geography, and lore.
|
||||
|
||||
---
|
||||
|
||||
## BMGD-Specific Terms
|
||||
|
||||
### A/P/C Menu
|
||||
|
||||
Options presented after content generation:
|
||||
|
||||
- **A** - Advanced Elicitation (explore deeper)
|
||||
- **P** - Party Mode (multi-agent discussion)
|
||||
- **C** - Continue (save and proceed)
|
||||
|
||||
### Narrative Complexity Levels
|
||||
|
||||
- **Critical** - Story IS the game (visual novels)
|
||||
- **Heavy** - Deep narrative with gameplay (RPGs)
|
||||
- **Moderate** - Meaningful story supporting gameplay
|
||||
- **Light** - Minimal story, gameplay-focused
|
||||
|
||||
### Step-File Architecture
|
||||
|
||||
BMGD workflow pattern using separate markdown files for each workflow step.
|
||||
|
||||
### Workflow-Install Pattern
|
||||
|
||||
Phase 4 workflows inherit from BMM base and add BMGD-specific overrides.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Game genre reference
|
||||
175
docs/modules/bmgd-bmad-game-dev/index.md
Normal file
175
docs/modules/bmgd-bmad-game-dev/index.md
Normal file
@@ -0,0 +1,175 @@
|
||||
# BMGD Documentation
|
||||
|
||||
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
**New to BMGD?** Start here:
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started building your first game
|
||||
- Installation and setup
|
||||
- Understanding the game development phases
|
||||
- Running your first workflows
|
||||
- Agent-based development flow
|
||||
|
||||
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
|
||||
|
||||
---
|
||||
|
||||
## Core Concepts
|
||||
|
||||
Understanding how BMGD works:
|
||||
|
||||
- **[Agents Guide](./agents-guide.md)** - Complete reference for game development agents
|
||||
- Game Designer, Game Developer, Game Architect, Game Scrum Master, Game QA, Game Solo Dev
|
||||
- Agent roles and when to use them
|
||||
- Agent workflows and menus
|
||||
|
||||
- **[Workflows Guide](./workflows-guide.md)** - Complete workflow reference
|
||||
- Phase 1: Preproduction (Brainstorm, Game Brief)
|
||||
- Phase 2: Design (GDD, Narrative)
|
||||
- Phase 3: Technical (Architecture)
|
||||
- Phase 4: Production (Sprint-based development)
|
||||
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Selecting and using game type templates
|
||||
- 24 supported game types
|
||||
- Genre-specific GDD sections
|
||||
- Hybrid game type handling
|
||||
|
||||
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Fast-track workflows for rapid development
|
||||
- Quick-Prototype for testing ideas
|
||||
- Quick-Dev for flexible implementation
|
||||
- When to use quick-flow vs full BMGD
|
||||
|
||||
---
|
||||
|
||||
## Quick References
|
||||
|
||||
Essential reference materials:
|
||||
|
||||
- **[Glossary](./glossary.md)** - Key game development terminology
|
||||
|
||||
---
|
||||
|
||||
## Choose Your Path
|
||||
|
||||
### I need to...
|
||||
|
||||
**Start a new game project**
|
||||
→ Start with [Quick Start Guide](./quick-start.md)
|
||||
→ Run `brainstorm-game` for ideation
|
||||
→ Create a Game Brief with `create-brief`
|
||||
|
||||
**Design my game**
|
||||
→ Create a GDD with `create-gdd`
|
||||
→ If story-heavy, add Narrative Design with `create-narrative`
|
||||
|
||||
**Plan the technical architecture**
|
||||
→ Run `create-architecture` with the Game Architect
|
||||
|
||||
**Build my game**
|
||||
→ Use Phase 4 production workflows
|
||||
→ Follow the sprint-based development cycle
|
||||
|
||||
**Quickly test an idea or implement a feature**
|
||||
→ Use [Quick-Flow](./quick-flow-guide.md) for rapid prototyping and development
|
||||
→ `quick-prototype` to test mechanics, `quick-dev` to implement
|
||||
|
||||
**Set up testing and QA**
|
||||
→ Use Game QA agent for test framework setup
|
||||
→ Run `test-framework` to initialize testing for Unity/Unreal/Godot
|
||||
→ Use `test-design` to create test scenarios
|
||||
→ Plan playtests with `playtest-plan`
|
||||
|
||||
**Understand game type templates**
|
||||
→ See [Game Types Guide](./game-types-guide.md)
|
||||
|
||||
---
|
||||
|
||||
## Game Development Phases
|
||||
|
||||
BMGD follows four phases aligned with game development:
|
||||
|
||||

|
||||
|
||||
### Phase 1: Preproduction
|
||||
|
||||
- **Brainstorm Game** - Ideation with game-specific techniques
|
||||
- **Game Brief** - Capture vision, market, and fundamentals
|
||||
|
||||
### Phase 2: Design
|
||||
|
||||
- **GDD (Game Design Document)** - Comprehensive game design
|
||||
- **Narrative Design** - Story, characters, world (for story-driven games)
|
||||
|
||||
### Phase 3: Technical
|
||||
|
||||
- **Game Architecture** - Engine, systems, patterns, structure
|
||||
|
||||
### Phase 4: Production
|
||||
|
||||
- **Sprint Planning** - Epic and story management
|
||||
- **Story Development** - Implementation workflow
|
||||
- **Code Review** - Quality assurance
|
||||
- **Testing** - Automated tests, playtesting, performance
|
||||
- **Retrospective** - Continuous improvement
|
||||
|
||||
---
|
||||
|
||||
## BMGD vs BMM
|
||||
|
||||
BMGD extends BMM with game-specific capabilities:
|
||||
|
||||
| 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 testarch | Engine-specific (Unity, Unreal, Godot) |
|
||||
| **Production** | Inherited from BMM | BMM workflows with game overrides |
|
||||
|
||||
BMGD production workflows inherit from BMM and add game-specific checklists and templates.
|
||||
|
||||
---
|
||||
|
||||
## Documentation Map
|
||||
|
||||
```
|
||||
BMGD Documentation
|
||||
├── README.md (this file)
|
||||
├── quick-start.md # Getting started
|
||||
├── agents-guide.md # Agent reference
|
||||
├── workflows-guide.md # Workflow reference
|
||||
├── quick-flow-guide.md # Rapid prototyping and development
|
||||
├── game-types-guide.md # Game type templates
|
||||
├── glossary.md # Terminology
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## External Resources
|
||||
|
||||
### Community and Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community
|
||||
- **[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
|
||||
|
||||
### Related Documentation
|
||||
|
||||
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
||||
|
||||
## Tips for Using This Documentation
|
||||
|
||||
1. **Start with Quick Start** if you're new to BMGD
|
||||
2. **Check Game Types Guide** when creating your GDD
|
||||
3. **Reference Glossary** for game development terminology
|
||||
4. **Use Troubleshooting** when you encounter issues
|
||||
|
||||
---
|
||||
|
||||
**Ready to make games?** → [Start with the Quick Start Guide](./quick-start.md)
|
||||
288
docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md
Normal file
288
docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md
Normal file
@@ -0,0 +1,288 @@
|
||||
# BMGD Quick-Flow Guide
|
||||
|
||||
Fast-track workflows for rapid game prototyping and flexible development.
|
||||
|
||||
---
|
||||
|
||||
## Game Solo Dev Agent
|
||||
|
||||
For dedicated quick-flow development, use the **Game Solo Dev** agent (Indie). This agent is optimized for solo developers and small teams who want to skip the full planning phases and ship fast.
|
||||
|
||||
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select the agent from your IDE.
|
||||
|
||||
The Game Solo Dev agent includes:
|
||||
|
||||
- `quick-prototype` - Rapid mechanic testing
|
||||
- `quick-dev` - Flexible feature implementation
|
||||
- `create-tech-spec` - Create implementation-ready specs
|
||||
- `code-review` - Quality checks
|
||||
- `test-framework` - Automated testing setup
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Quick-flow workflows skip the full BMGD planning phases when you need to move fast. Use them for:
|
||||
|
||||
- Testing a game mechanic idea
|
||||
- Implementing a small feature
|
||||
- Rapid prototyping before committing to design
|
||||
- Bug fixes and tweaks
|
||||
|
||||
```
|
||||
Full BMGD Flow:
|
||||
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
|
||||
|
||||
Quick-Flow:
|
||||
Idea → Quick-Prototype → Quick-Dev → Done
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick-Prototype
|
||||
|
||||
**Command:** `quick-prototype`
|
||||
**Agent:** Game Designer, Game Developer
|
||||
**Purpose:** Rapidly test gameplay ideas with minimal setup
|
||||
|
||||
### When to Use
|
||||
|
||||
- You have a mechanic idea and want to test the "feel"
|
||||
- You're not sure if something will be fun
|
||||
- You want to experiment before committing to design
|
||||
- You need a proof of concept
|
||||
|
||||
### Workflow Steps
|
||||
|
||||
1. **Define Scope** - What are you prototyping? (mechanic, feature, system)
|
||||
2. **Set Success Criteria** - How will you know if it works?
|
||||
3. **Rapid Implementation** - Build the minimum to test the idea
|
||||
4. **Playtest and Evaluate** - Does it feel right?
|
||||
|
||||
### Prototype Principles
|
||||
|
||||
- **Minimum Viable Prototype** - Only what's needed to test the idea
|
||||
- **Hardcode First** - Magic numbers are fine, extract later
|
||||
- **Skip Edge Cases** - Happy path only for now
|
||||
- **Placeholder Everything** - Cubes, debug text, temp sounds
|
||||
- **Comment Intent** - Mark what's temporary vs keeper code
|
||||
|
||||
### Example Session
|
||||
|
||||
```
|
||||
You: quick-prototype
|
||||
|
||||
Agent: What are you prototyping?
|
||||
|
||||
You: I want to test a grappling hook mechanic. Player should be
|
||||
able to aim at surfaces and pull themselves toward the hook point.
|
||||
|
||||
Agent: What makes this prototype successful?
|
||||
|
||||
You: 1. Aiming feels responsive and intuitive
|
||||
2. The pull movement feels satisfying, not floaty
|
||||
3. Player can chain hooks without awkward pauses
|
||||
|
||||
Agent: [Implements minimal grappling hook]
|
||||
|
||||
Agent: Prototype complete! Playtest results:
|
||||
- Aiming: Works, consider adding aim assist
|
||||
- Movement: Pull is smooth, might need speed curve
|
||||
- Chaining: Currently has 0.2s delay, feels sluggish
|
||||
|
||||
Next: [d] Develop further | [i] Iterate | [a] Archive
|
||||
```
|
||||
|
||||
### After Prototyping
|
||||
|
||||
- **Develop** (`d`) - Use `quick-dev` to build production code
|
||||
- **Iterate** (`i`) - Adjust and re-test the prototype
|
||||
- **Archive** (`a`) - Keep as reference, move on to other ideas
|
||||
|
||||
---
|
||||
|
||||
## Quick-Dev
|
||||
|
||||
**Command:** `quick-dev`
|
||||
**Agent:** Game Developer
|
||||
**Purpose:** Flexible development with game-specific considerations
|
||||
|
||||
### When to Use
|
||||
|
||||
- Implementing a feature from a tech-spec
|
||||
- Building on a successful prototype
|
||||
- Making changes that don't need full story workflow
|
||||
- Quick fixes and improvements
|
||||
|
||||
### Workflow Modes
|
||||
|
||||
**Mode A: Tech-Spec Driven**
|
||||
|
||||
```
|
||||
You: quick-dev tech-spec-combat.md
|
||||
Agent: [Loads spec, extracts tasks, implements]
|
||||
```
|
||||
|
||||
**Mode B: Direct Instructions**
|
||||
|
||||
```
|
||||
You: quick-dev implement double-jump for the player
|
||||
Agent: [Evaluates complexity, offers planning options]
|
||||
```
|
||||
|
||||
**Mode C: From Prototype**
|
||||
|
||||
```
|
||||
You: quick-dev from the grappling hook prototype
|
||||
Agent: [Loads prototype, productionizes code]
|
||||
```
|
||||
|
||||
### Game-Specific Checks
|
||||
|
||||
Quick-dev includes automatic consideration of:
|
||||
|
||||
- **Performance** - No allocations in hot paths, object pooling
|
||||
- **Feel** - Input responsiveness, visual/audio feedback
|
||||
- **Integration** - Save/load, multiplayer sync, platform testing
|
||||
|
||||
### Example Session
|
||||
|
||||
```
|
||||
You: quick-dev implement enemy patrol behavior
|
||||
|
||||
Agent: This looks like a focused feature. Options:
|
||||
[t] Plan first - Create tech-spec (recommended)
|
||||
[r] Prototype first - Test the idea
|
||||
[e] Execute directly
|
||||
|
||||
You: e
|
||||
|
||||
Agent: Any additional guidance? (patterns, files, constraints)
|
||||
|
||||
You: Use the existing AIController base class. Enemies should
|
||||
patrol between waypoints and return if player leaves range.
|
||||
|
||||
Agent: [Implements patrol behavior]
|
||||
|
||||
Agent: Implementation Complete!
|
||||
Files Modified: EnemyAI.cs, PatrolBehavior.cs
|
||||
Tests: Unit tests added for patrol state machine
|
||||
Performance: No per-frame allocations
|
||||
|
||||
Recommended: Playtest the changes
|
||||
```
|
||||
|
||||
### Complexity Routing
|
||||
|
||||
Quick-dev automatically detects complex requests and offers alternatives:
|
||||
|
||||
| Signals | Recommendation |
|
||||
| -------------------------------------- | ---------------------- |
|
||||
| Single mechanic, bug fix, tweak | Execute directly |
|
||||
| Multiple systems, performance-critical | Plan first (tech-spec) |
|
||||
| Platform/system level work | Use full BMGD workflow |
|
||||
|
||||
---
|
||||
|
||||
## Choosing Between Quick-Flows
|
||||
|
||||
| Scenario | Use |
|
||||
| ----------------------- | ------------------------------- |
|
||||
| "Will this be fun?" | `quick-prototype` |
|
||||
| "How should this feel?" | `quick-prototype` |
|
||||
| "Build this feature" | `quick-dev` |
|
||||
| "Fix this bug" | `quick-dev` |
|
||||
| "Test then build" | `quick-prototype` → `quick-dev` |
|
||||
|
||||
---
|
||||
|
||||
## Quick-Flow vs Full BMGD
|
||||
|
||||
### Use Quick-Flow When
|
||||
|
||||
- The scope is small and well-understood
|
||||
- You're experimenting or prototyping
|
||||
- You have a clear tech-spec already
|
||||
- The work doesn't affect core game systems significantly
|
||||
|
||||
### Use Full BMGD When
|
||||
|
||||
- Building a major feature or system
|
||||
- The scope is unclear or large
|
||||
- Multiple team members need alignment
|
||||
- The work affects game pillars or core loop
|
||||
- You need documentation for future reference
|
||||
|
||||
---
|
||||
|
||||
## Checklists
|
||||
|
||||
### Quick-Prototype Checklist
|
||||
|
||||
**Before:**
|
||||
|
||||
- [ ] Prototype scope defined
|
||||
- [ ] Success criteria established (2-3 items)
|
||||
|
||||
**During:**
|
||||
|
||||
- [ ] Minimum viable code written
|
||||
- [ ] Placeholder assets used
|
||||
- [ ] Core functionality testable
|
||||
|
||||
**After:**
|
||||
|
||||
- [ ] Each criterion evaluated
|
||||
- [ ] Decision made (develop/iterate/archive)
|
||||
|
||||
### Quick-Dev Checklist
|
||||
|
||||
**Before:**
|
||||
|
||||
- [ ] Context loaded (spec, prototype, or guidance)
|
||||
- [ ] Files to modify identified
|
||||
- [ ] Patterns understood
|
||||
|
||||
**During:**
|
||||
|
||||
- [ ] All tasks completed
|
||||
- [ ] No allocations in hot paths
|
||||
- [ ] Frame rate maintained
|
||||
|
||||
**After:**
|
||||
|
||||
- [ ] Game runs without errors
|
||||
- [ ] Feature works as specified
|
||||
- [ ] Manual playtest completed
|
||||
|
||||
---
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### 1. Timebox Prototypes
|
||||
|
||||
Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider.
|
||||
|
||||
### 2. Embrace Programmer Art
|
||||
|
||||
Prototypes don't need to look good. Focus on feel, not visuals.
|
||||
|
||||
### 3. Test on Target Hardware
|
||||
|
||||
What feels right on your dev machine might not feel right on target platform.
|
||||
|
||||
### 4. Document Learnings
|
||||
|
||||
Even failed prototypes teach something. Note what you learned.
|
||||
|
||||
### 5. Know When to Graduate
|
||||
|
||||
If quick-dev keeps expanding scope, stop and create proper stories.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Workflows Guide](./workflows-guide.md)** - Full workflow reference
|
||||
- **[Agents Guide](./agents-guide.md)** - Agent capabilities
|
||||
- **[Quick Start Guide](./quick-start.md)** - Getting started with BMGD
|
||||
250
docs/modules/bmgd-bmad-game-dev/quick-start.md
Normal file
250
docs/modules/bmgd-bmad-game-dev/quick-start.md
Normal file
@@ -0,0 +1,250 @@
|
||||
# BMGD Quick Start Guide
|
||||
|
||||
Get started building games with the BMad Game Development Module.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before starting with BMGD, ensure you have:
|
||||
|
||||
1. **BMAD-METHOD installed** - Follow the main installation guide
|
||||
2. **A game idea** - Even a rough concept is enough to start
|
||||
3. **Your preferred AI tool** - Claude Code, Cursor, or web-based chat
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
BMGD is a custom module that extends BMM. Install it using the BMAD installer:
|
||||
|
||||
```bash
|
||||
# During installation, select BMGD when prompted for custom modules
|
||||
npx bmad-cli install
|
||||
```
|
||||
|
||||
Or add to an existing installation:
|
||||
|
||||
```bash
|
||||
npx bmad-cli install --add-module bmgd
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Understanding the Phases
|
||||
|
||||
BMGD follows four game development phases:
|
||||
|
||||

|
||||
|
||||
### Phase 1: Preproduction
|
||||
|
||||
**What happens:** Capture your game vision and core concept.
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `brainstorm-game` - Guided ideation with game-specific techniques
|
||||
- `create-game-brief` - Document vision, market, pillars, and fundamentals
|
||||
|
||||
**Output:** Game Brief document
|
||||
|
||||
### Phase 2: Design
|
||||
|
||||
**What happens:** Detail your game's mechanics, systems, and (optionally) narrative.
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `create-gdd` - Create comprehensive Game Design Document
|
||||
- `narrative` - Create Narrative Design Document (for story-driven games)
|
||||
|
||||
**Output:** GDD (and Narrative Design document if applicable)
|
||||
|
||||
### Phase 3: Technical
|
||||
|
||||
**What happens:** Plan how you'll build the game.
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `create-architecture` - Define engine, systems, patterns, and structure
|
||||
|
||||
**Output:** Game Architecture document
|
||||
|
||||
### Phase 4: Production
|
||||
|
||||
**What happens:** Build your game in sprints.
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `sprint-planning` - Plan and track sprints
|
||||
- `sprint-status` - View progress and get recommendations
|
||||
- `create-story` - Create implementable stories
|
||||
- `dev-story` - Implement stories
|
||||
- `code-review` - Quality assurance
|
||||
- `retrospective` - Learn and improve after epics
|
||||
|
||||
**Output:** Working game code
|
||||
|
||||
---
|
||||
|
||||
## Your First Game Project
|
||||
|
||||
### Step 1: Start with Brainstorming (Optional)
|
||||
|
||||
If you have a vague idea and want help developing it:
|
||||
|
||||
```
|
||||
You: brainstorm-game
|
||||
Agent: [Guides you through game-specific ideation techniques]
|
||||
```
|
||||
|
||||
### Step 2: Create Your Game Brief
|
||||
|
||||
Capture your game's core vision:
|
||||
|
||||
```
|
||||
You: create-game-brief
|
||||
Agent: [Walks you through game concept, pillars, market, and fundamentals]
|
||||
```
|
||||
|
||||
**Output:** `{output_folder}/game-brief.md`
|
||||
|
||||
### Step 3: Create Your GDD
|
||||
|
||||
Detail your game's design:
|
||||
|
||||
```
|
||||
You: create-gdd
|
||||
Agent: [Guides you through mechanics, systems, and game-type-specific sections]
|
||||
```
|
||||
|
||||
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
|
||||
|
||||
### Step 4: Add Narrative Design (If Story-Driven)
|
||||
|
||||
For games with significant story:
|
||||
|
||||
```
|
||||
You: narrative
|
||||
Agent: [Facilitates story, characters, world, and dialogue design]
|
||||
```
|
||||
|
||||
**Output:** `{output_folder}/narrative-design.md`
|
||||
|
||||
### Step 5: Create Architecture
|
||||
|
||||
Plan your technical implementation:
|
||||
|
||||
```
|
||||
You: create-architecture
|
||||
Agent: [Guides engine selection, system design, and technical decisions]
|
||||
```
|
||||
|
||||
**Output:** `{output_folder}/game-architecture.md`
|
||||
|
||||
### Step 6: Start Building
|
||||
|
||||
Begin sprint-based development:
|
||||
|
||||
```
|
||||
You: sprint-planning
|
||||
Agent: [Sets up sprint tracking and epic management]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Choosing Your Agent
|
||||
|
||||
BMGD provides six specialized agents:
|
||||
|
||||
| Agent | Icon | When to Use |
|
||||
| --------------------- | ---- | ----------------------------------------- |
|
||||
| **Game Designer** | 🎲 | Brainstorming, Game Brief, GDD, Narrative |
|
||||
| **Game Architect** | 🏛️ | Architecture, technical decisions |
|
||||
| **Game Developer** | 🕹️ | Implementation, code reviews |
|
||||
| **Game Scrum Master** | 🎯 | Sprint planning, story management |
|
||||
| **Game QA** | 🧪 | Test framework, test design, automation |
|
||||
| **Game Solo Dev** | 🎮 | Quick prototyping, indie development |
|
||||
|
||||
### Typical Flow
|
||||
|
||||
1. **Game Designer** (Phases 1-2): Brainstorm → Brief → GDD → Narrative
|
||||
2. **Game Architect** (Phase 3): Architecture
|
||||
3. **Game Scrum Master** (Phase 4): Sprint planning, story creation
|
||||
4. **Game Developer** (Phase 4): Implementation, code reviews
|
||||
|
||||
---
|
||||
|
||||
## Quick Command Reference
|
||||
|
||||
### Phase 1: Preproduction
|
||||
|
||||
- `brainstorm-game` - Ideation session
|
||||
- `create-game-brief` - Create Game Brief
|
||||
|
||||
### Phase 2: Design
|
||||
|
||||
- `create-gdd` - Create GDD
|
||||
- `narrative` - Create Narrative Design
|
||||
|
||||
### Phase 3: Technical
|
||||
|
||||
- `create-architecture` - Create Architecture
|
||||
|
||||
### Phase 4: Production
|
||||
|
||||
- `sprint-planning` - Plan sprints
|
||||
- `sprint-status` - View progress and recommendations
|
||||
- `create-story` - Create story
|
||||
- `dev-story` - Implement story
|
||||
- `code-review` - Review code
|
||||
- `retrospective` - Team retrospective
|
||||
- `correct-course` - Handle sprint changes
|
||||
|
||||
### Quick-Flow (Fast-Track)
|
||||
|
||||
- `quick-prototype` - Rapid prototyping (IDE only)
|
||||
- `quick-dev` - Flexible development (IDE only)
|
||||
|
||||
### Utility
|
||||
|
||||
- `workflow-status` - Check project status
|
||||
- `party-mode` - Multi-agent collaboration
|
||||
- `advanced-elicitation` - Deep exploration
|
||||
|
||||
---
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### 1. Start Small
|
||||
|
||||
Begin with a simple game concept. You can always expand later.
|
||||
|
||||
### 2. Use Game Type Templates
|
||||
|
||||
When creating your GDD, BMGD offers 24 game type templates that provide genre-specific sections.
|
||||
|
||||
### 3. Iterate
|
||||
|
||||
Documents are living artifacts. Return to update them as your vision evolves.
|
||||
|
||||
### 4. Trust the Process
|
||||
|
||||
Each workflow builds on previous outputs. The Game Brief informs the GDD, which informs the Architecture, which informs implementation.
|
||||
|
||||
### 5. Collaborate with Agents
|
||||
|
||||
Use `party-mode` to get perspectives from multiple agents when facing complex decisions.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Agents Guide](./agents-guide.md)** - Learn about each agent's capabilities
|
||||
- **[Workflows Guide](./workflows-guide.md)** - Detailed workflow reference
|
||||
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Understand game type templates
|
||||
- **[Glossary](./glossary.md)** - Game development terminology
|
||||
|
||||
---
|
||||
|
||||
**Ready to start?** Chat with the **Game Designer** agent and say `brainstorm-game` or `create-game-brief`!
|
||||
259
docs/modules/bmgd-bmad-game-dev/troubleshooting.md
Normal file
259
docs/modules/bmgd-bmad-game-dev/troubleshooting.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# BMGD Troubleshooting
|
||||
|
||||
Common issues and solutions when using BMGD workflows.
|
||||
|
||||
---
|
||||
|
||||
## Installation Issues
|
||||
|
||||
### BMGD module not appearing
|
||||
|
||||
**Symptom:** BMGD agents and workflows are not available after installation.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Verify BMGD was selected during installation
|
||||
2. Check `_bmad/bmgd/` folder exists in your project
|
||||
3. Re-run installer with `--add-module bmgd`
|
||||
|
||||
---
|
||||
|
||||
### Config file missing
|
||||
|
||||
**Symptom:** Workflows fail with "config not found" errors.
|
||||
|
||||
**Solution:**
|
||||
Check for `_bmad/bmgd/config.yaml` in your project. If missing, create it:
|
||||
|
||||
```yaml
|
||||
# BMGD Configuration
|
||||
output_folder: '{project-root}/docs/game-design'
|
||||
user_name: 'Your Name'
|
||||
communication_language: 'English'
|
||||
document_output_language: 'English'
|
||||
game_dev_experience: 'intermediate'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Workflow Issues
|
||||
|
||||
### "GDD not found" in Narrative workflow
|
||||
|
||||
**Symptom:** Narrative workflow can't find the GDD.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure GDD exists in `{output_folder}`
|
||||
2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`)
|
||||
3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists
|
||||
|
||||
---
|
||||
|
||||
### Workflow state not persisting
|
||||
|
||||
**Symptom:** Returning to a workflow starts from the beginning.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Check the output document's frontmatter for `stepsCompleted` array
|
||||
2. Ensure document was saved before ending session
|
||||
3. Use "Continue existing" option when re-entering workflow
|
||||
|
||||
---
|
||||
|
||||
### Wrong game type sections in GDD
|
||||
|
||||
**Symptom:** GDD includes irrelevant sections for your game type.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Review game type selection at Step 7 of GDD workflow
|
||||
2. You can select multiple types for hybrid games
|
||||
3. Irrelevant sections can be marked N/A or removed
|
||||
|
||||
---
|
||||
|
||||
## Agent Issues
|
||||
|
||||
### Agent not recognizing commands
|
||||
|
||||
**Symptom:** Typing a command like `create-gdd` doesn't trigger the workflow.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure you're chatting with the correct agent (Game Designer for GDD)
|
||||
2. Check exact command spelling (case-sensitive)
|
||||
3. Try `workflow-status` to verify agent is loaded correctly
|
||||
|
||||
---
|
||||
|
||||
### Agent using wrong persona
|
||||
|
||||
**Symptom:** Agent responses don't match expected personality.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Verify correct agent file is loaded
|
||||
2. Check `_bmad/bmgd/agents/` for agent definitions
|
||||
3. Start a fresh chat session with the correct agent
|
||||
|
||||
---
|
||||
|
||||
## Document Issues
|
||||
|
||||
### Document too large for context
|
||||
|
||||
**Symptom:** AI can't process the entire GDD or narrative document.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Use sharded document structure (index.md + section files)
|
||||
2. Request specific sections rather than full document
|
||||
3. GDD workflow supports automatic sharding for large documents
|
||||
|
||||
---
|
||||
|
||||
### Template placeholders not replaced
|
||||
|
||||
**Symptom:** Output contains `{{placeholder}}` text.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Workflow may have been interrupted before completion
|
||||
2. Re-run the specific step that generates that section
|
||||
3. Manually edit the document to fill in missing values
|
||||
|
||||
---
|
||||
|
||||
### Frontmatter parsing errors
|
||||
|
||||
**Symptom:** YAML errors when loading documents.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Validate YAML syntax (proper indentation, quotes around special characters)
|
||||
2. Check for tabs vs spaces (YAML requires spaces)
|
||||
3. Ensure frontmatter is bounded by `---` markers
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 (Production) Issues
|
||||
|
||||
### Sprint status not updating
|
||||
|
||||
**Symptom:** Story status changes don't reflect in sprint-status.yaml.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Run `sprint-planning` to refresh status
|
||||
2. Check file permissions on sprint-status.yaml
|
||||
3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/`
|
||||
|
||||
---
|
||||
|
||||
### Story context missing code references
|
||||
|
||||
**Symptom:** Generated story context doesn't include relevant code.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Ensure project-context.md exists and is current
|
||||
2. Check that architecture document references correct file paths
|
||||
3. Story may need more specific file references in acceptance criteria
|
||||
|
||||
---
|
||||
|
||||
### Code review not finding issues
|
||||
|
||||
**Symptom:** Code review passes but bugs exist.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Code review is AI-assisted, not comprehensive testing
|
||||
2. Always run actual tests before marking story done
|
||||
3. Consider manual review for critical code paths
|
||||
|
||||
---
|
||||
|
||||
## Performance Issues
|
||||
|
||||
### Workflows running slowly
|
||||
|
||||
**Symptom:** Long wait times between workflow steps.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Use IDE-based workflows (faster than web)
|
||||
2. Keep documents concise (avoid unnecessary detail)
|
||||
3. Use sharded documents for large projects
|
||||
|
||||
---
|
||||
|
||||
### Context limit reached mid-workflow
|
||||
|
||||
**Symptom:** Workflow stops or loses context partway through.
|
||||
|
||||
**Solutions:**
|
||||
|
||||
1. Save progress frequently (workflows auto-save on Continue)
|
||||
2. Break complex sections into multiple sessions
|
||||
3. Use step-file architecture (workflows resume from last step)
|
||||
|
||||
---
|
||||
|
||||
## Common Error Messages
|
||||
|
||||
### "Input file not found"
|
||||
|
||||
**Cause:** Workflow requires a document that doesn't exist.
|
||||
|
||||
**Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD).
|
||||
|
||||
---
|
||||
|
||||
### "Invalid game type"
|
||||
|
||||
**Cause:** Selected game type not in supported list.
|
||||
|
||||
**Fix:** Check `game-types.csv` for valid type IDs.
|
||||
|
||||
---
|
||||
|
||||
### "Validation failed"
|
||||
|
||||
**Cause:** Document doesn't meet checklist requirements.
|
||||
|
||||
**Fix:** Review the validation output and address flagged items.
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Community Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Real-time help from the community
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
|
||||
### Self-Help
|
||||
|
||||
1. Check `workflow-status` to understand current state
|
||||
2. Review workflow markdown files for expected behavior
|
||||
3. Look at completed example documents in the module
|
||||
|
||||
### Reporting Issues
|
||||
|
||||
When reporting issues, include:
|
||||
|
||||
1. Which workflow and step
|
||||
2. Error message (if any)
|
||||
3. Relevant document frontmatter
|
||||
4. Steps to reproduce
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Getting started
|
||||
- **[Workflows Guide](./workflows-guide.md)** - Workflow reference
|
||||
- **[Glossary](./glossary.md)** - Terminology
|
||||
BIN
docs/modules/bmgd-bmad-game-dev/workflow-overview.jpg
Normal file
BIN
docs/modules/bmgd-bmad-game-dev/workflow-overview.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 200 KiB |
463
docs/modules/bmgd-bmad-game-dev/workflows-guide.md
Normal file
463
docs/modules/bmgd-bmad-game-dev/workflows-guide.md
Normal file
@@ -0,0 +1,463 @@
|
||||
# BMGD Workflows Guide
|
||||
|
||||
Complete reference for all BMGD workflows organized by development phase.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
BMGD workflows are organized into four phases:
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Preproduction
|
||||
|
||||
### Brainstorm Game
|
||||
|
||||
**Command:** `brainstorm-game`
|
||||
**Agent:** Game Designer
|
||||
**Input:** None required
|
||||
**Output:** Ideas and concepts (optionally saved)
|
||||
|
||||
**Description:**
|
||||
Guided ideation session using game-specific brainstorming techniques:
|
||||
|
||||
- **MDA Framework** - Mechanics → Dynamics → Aesthetics analysis
|
||||
- **Core Loop Workshop** - Define the fundamental gameplay loop
|
||||
- **Player Fantasy Mining** - Explore what players want to feel
|
||||
- **Genre Mashup** - Combine genres for unique concepts
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. Initialize brainstorm session
|
||||
2. Load game-specific techniques
|
||||
3. Execute ideation with selected techniques
|
||||
4. Summarize and (optionally) hand off to Game Brief
|
||||
|
||||
---
|
||||
|
||||
### Game Brief
|
||||
|
||||
**Command:** `create-game-brief`
|
||||
**Agent:** Game Designer
|
||||
**Input:** Ideas from brainstorming (optional)
|
||||
**Output:** `{output_folder}/game-brief.md`
|
||||
|
||||
**Description:**
|
||||
Captures your game's core vision and fundamentals. This is the foundation for all subsequent design work.
|
||||
|
||||
**Sections covered:**
|
||||
|
||||
- Game concept and vision
|
||||
- Design pillars (3-5 core principles)
|
||||
- Target audience and market
|
||||
- Platform considerations
|
||||
- Core gameplay loop
|
||||
- Initial scope definition
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Design
|
||||
|
||||
### GDD (Game Design Document)
|
||||
|
||||
**Command:** `create-gdd`
|
||||
**Agent:** Game Designer
|
||||
**Input:** Game Brief
|
||||
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
|
||||
|
||||
**Description:**
|
||||
Comprehensive game design document with genre-specific sections based on 24 supported game types.
|
||||
|
||||
**Core sections:**
|
||||
|
||||
1. Executive Summary
|
||||
2. Gameplay Systems
|
||||
3. Core Mechanics
|
||||
4. Progression Systems
|
||||
5. UI/UX Design
|
||||
6. Audio Design
|
||||
7. Art Direction
|
||||
8. Technical Requirements
|
||||
9. Game-Type-Specific Sections
|
||||
10. Epic Generation (for sprint planning)
|
||||
|
||||
**Features:**
|
||||
|
||||
- Game type selection with specialized sections
|
||||
- Hybrid game type support
|
||||
- Automatic epic generation
|
||||
- Scale-adaptive complexity
|
||||
|
||||
---
|
||||
|
||||
### Narrative Design
|
||||
|
||||
**Command:** `narrative`
|
||||
**Agent:** Game Designer
|
||||
**Input:** GDD (required), Game Brief (optional)
|
||||
**Output:** `{output_folder}/narrative-design.md`
|
||||
|
||||
**Description:**
|
||||
For story-driven games. Creates comprehensive narrative documentation.
|
||||
|
||||
**Sections covered:**
|
||||
|
||||
1. Story Foundation (premise, themes, tone)
|
||||
2. Story Structure (acts, beats, pacing)
|
||||
3. Characters (protagonists, antagonists, supporting, arcs)
|
||||
4. World Building (setting, history, factions, locations)
|
||||
5. Dialogue Framework (style, branching)
|
||||
6. Environmental Storytelling
|
||||
7. Narrative Delivery Methods
|
||||
8. Gameplay-Narrative Integration
|
||||
9. Production Planning (scope, localization, voice acting)
|
||||
10. Appendices (relationship map, timeline)
|
||||
|
||||
**Narrative Complexity Levels:**
|
||||
|
||||
- **Critical** - Story IS the game (visual novels, adventure games)
|
||||
- **Heavy** - Deep narrative with gameplay (RPGs, story-driven action)
|
||||
- **Moderate** - Meaningful story supporting gameplay
|
||||
- **Light** - Minimal story, gameplay-focused
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Technical
|
||||
|
||||
### Game Architecture
|
||||
|
||||
**Command:** `create-architecture`
|
||||
**Agent:** Game Architect
|
||||
**Input:** GDD, Narrative Design (optional)
|
||||
**Output:** `{output_folder}/game-architecture.md`
|
||||
|
||||
**Description:**
|
||||
Technical architecture document covering engine selection, system design, and implementation approach.
|
||||
|
||||
**Sections covered:**
|
||||
|
||||
1. Executive Summary
|
||||
2. Engine/Framework Selection
|
||||
3. Core Systems Architecture
|
||||
4. Data Architecture
|
||||
5. Performance Requirements
|
||||
6. Platform-Specific Considerations
|
||||
7. Development Environment
|
||||
8. Testing Strategy
|
||||
9. Build and Deployment
|
||||
10. Technical Risks and Mitigations
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Production
|
||||
|
||||
Production workflows inherit from BMM and add game-specific overrides.
|
||||
|
||||
### Sprint Planning
|
||||
|
||||
**Command:** `sprint-planning`
|
||||
**Agent:** Game Scrum Master
|
||||
**Input:** GDD with epics
|
||||
**Output:** `{output_folder}/sprint-status.yaml`
|
||||
|
||||
**Description:**
|
||||
Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking.
|
||||
|
||||
---
|
||||
|
||||
### Sprint Status
|
||||
|
||||
**Command:** `sprint-status`
|
||||
**Agent:** Game Scrum Master
|
||||
**Input:** `sprint-status.yaml`
|
||||
**Output:** Sprint summary, risks, next action recommendation
|
||||
|
||||
**Description:**
|
||||
Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run. Supports three modes:
|
||||
|
||||
- **interactive** (default): Displays summary with menu options
|
||||
- **validate**: Checks sprint-status.yaml structure
|
||||
- **data**: Returns raw data for other workflows
|
||||
|
||||
---
|
||||
|
||||
### Create Story
|
||||
|
||||
**Command:** `create-story`
|
||||
**Agent:** Game Scrum Master
|
||||
**Input:** GDD, Architecture, Epic context
|
||||
**Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md`
|
||||
|
||||
**Description:**
|
||||
Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created.
|
||||
|
||||
**Validation:** `validate-create-story`
|
||||
|
||||
---
|
||||
|
||||
### Dev Story
|
||||
|
||||
**Command:** `dev-story`
|
||||
**Agent:** Game Developer
|
||||
**Input:** Story (ready for dev)
|
||||
**Output:** Implemented code
|
||||
|
||||
**Description:**
|
||||
Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion.
|
||||
|
||||
---
|
||||
|
||||
### Code Review
|
||||
|
||||
**Command:** `code-review`
|
||||
**Agent:** Game Developer
|
||||
**Input:** Story (ready for review)
|
||||
**Output:** Review feedback, approved/needs changes
|
||||
|
||||
**Description:**
|
||||
Thorough QA code review with game-specific considerations (performance, 60fps, etc.).
|
||||
|
||||
---
|
||||
|
||||
### Retrospective
|
||||
|
||||
**Command:** `epic-retrospective`
|
||||
**Agent:** Game Scrum Master
|
||||
**Input:** Completed epic
|
||||
**Output:** Retrospective document
|
||||
|
||||
**Description:**
|
||||
Facilitates team retrospective after epic completion. Captures learnings and improvements.
|
||||
|
||||
---
|
||||
|
||||
### Correct Course
|
||||
|
||||
**Command:** `correct-course`
|
||||
**Agent:** Game Scrum Master or Game Architect
|
||||
**Input:** Current project state
|
||||
**Output:** Correction plan
|
||||
|
||||
**Description:**
|
||||
Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Status
|
||||
|
||||
**Command:** `workflow-status`
|
||||
**Agent:** All agents
|
||||
**Output:** Project status summary
|
||||
|
||||
**Description:**
|
||||
Checks current project status across all phases. Shows completed documents, current phase, and next steps.
|
||||
|
||||
---
|
||||
|
||||
## Quick-Flow Workflows
|
||||
|
||||
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** for detailed usage.
|
||||
|
||||
### Quick-Prototype
|
||||
|
||||
**Command:** `quick-prototype`
|
||||
**Agent:** Game Designer, Game Developer
|
||||
**Input:** Idea or concept to test
|
||||
**Output:** Working prototype, playtest results
|
||||
|
||||
**Description:**
|
||||
Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish.
|
||||
|
||||
**Use when:**
|
||||
|
||||
- Testing if a mechanic is fun
|
||||
- Proving a concept before committing to design
|
||||
- Experimenting with gameplay ideas
|
||||
|
||||
---
|
||||
|
||||
### Quick-Dev
|
||||
|
||||
**Command:** `quick-dev`
|
||||
**Agent:** Game Developer
|
||||
**Input:** Tech-spec, prototype, or direct instructions
|
||||
**Output:** Implemented feature
|
||||
|
||||
**Description:**
|
||||
Flexible development workflow with game-specific considerations (performance, feel, integration).
|
||||
|
||||
**Use when:**
|
||||
|
||||
- Implementing features from tech-specs
|
||||
- Building on successful prototypes
|
||||
- Making changes that don't need full story workflow
|
||||
|
||||
---
|
||||
|
||||
## Quality Assurance Workflows
|
||||
|
||||
Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot.
|
||||
|
||||
### Test Framework
|
||||
|
||||
**Command:** `test-framework`
|
||||
**Agent:** Game QA
|
||||
**Input:** Game project
|
||||
**Output:** Configured test framework
|
||||
|
||||
**Description:**
|
||||
Initialize a production-ready test framework for your game engine:
|
||||
|
||||
- **Unity**: Unity Test Framework with Edit Mode and Play Mode tests
|
||||
- **Unreal**: Unreal Automation system with functional tests
|
||||
- **Godot**: GUT (Godot Unit Test) framework
|
||||
|
||||
**Creates:**
|
||||
|
||||
- Test directory structure
|
||||
- Framework configuration
|
||||
- Sample unit and integration tests
|
||||
- Test documentation
|
||||
|
||||
---
|
||||
|
||||
### Test Design
|
||||
|
||||
**Command:** `test-design`
|
||||
**Agent:** Game QA
|
||||
**Input:** GDD, Architecture
|
||||
**Output:** `{output_folder}/game-test-design.md`
|
||||
|
||||
**Description:**
|
||||
Creates comprehensive test scenarios covering:
|
||||
|
||||
- Core gameplay mechanics
|
||||
- Progression and save systems
|
||||
- Multiplayer (if applicable)
|
||||
- Platform certification requirements
|
||||
|
||||
Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
|
||||
|
||||
---
|
||||
|
||||
### Automate
|
||||
|
||||
**Command:** `automate`
|
||||
**Agent:** Game QA
|
||||
**Input:** Test design, game code
|
||||
**Output:** Automated test files
|
||||
|
||||
**Description:**
|
||||
Generates engine-appropriate automated tests:
|
||||
|
||||
- Unit tests for pure logic
|
||||
- Integration tests for system interactions
|
||||
- Smoke tests for critical path validation
|
||||
|
||||
---
|
||||
|
||||
### Playtest Plan
|
||||
|
||||
**Command:** `playtest-plan`
|
||||
**Agent:** Game QA
|
||||
**Input:** Build, test objectives
|
||||
**Output:** `{output_folder}/playtest-plan.md`
|
||||
|
||||
**Description:**
|
||||
Creates structured playtesting sessions:
|
||||
|
||||
- Session structure (pre/during/post)
|
||||
- Observation guides
|
||||
- Interview questions
|
||||
- Analysis templates
|
||||
|
||||
**Playtest Types:**
|
||||
|
||||
- Internal (team validation)
|
||||
- External (unbiased feedback)
|
||||
- Focused (specific feature testing)
|
||||
|
||||
---
|
||||
|
||||
### Performance Test
|
||||
|
||||
**Command:** `performance-test`
|
||||
**Agent:** Game QA
|
||||
**Input:** Platform targets
|
||||
**Output:** `{output_folder}/performance-test-plan.md`
|
||||
|
||||
**Description:**
|
||||
Designs performance testing strategy:
|
||||
|
||||
- Frame rate targets per platform
|
||||
- Memory budgets
|
||||
- Loading time requirements
|
||||
- Benchmark scenarios
|
||||
- Profiling methodology
|
||||
|
||||
---
|
||||
|
||||
### Test Review
|
||||
|
||||
**Command:** `test-review`
|
||||
**Agent:** Game QA
|
||||
**Input:** Existing test suite
|
||||
**Output:** `{output_folder}/test-review-report.md`
|
||||
|
||||
**Description:**
|
||||
Reviews test quality and coverage:
|
||||
|
||||
- Test suite metrics
|
||||
- Quality assessment
|
||||
- Coverage gaps
|
||||
- Recommendations
|
||||
|
||||
---
|
||||
|
||||
## Utility Workflows
|
||||
|
||||
### Party Mode
|
||||
|
||||
**Command:** `party-mode`
|
||||
**Agent:** All agents
|
||||
|
||||
**Description:**
|
||||
Brings multiple agents together for collaborative discussion on complex decisions.
|
||||
|
||||
---
|
||||
|
||||
### Advanced Elicitation
|
||||
|
||||
**Command:** `advanced-elicitation`
|
||||
**Agent:** All agents (web only)
|
||||
|
||||
**Description:**
|
||||
Deep exploration techniques to challenge assumptions and surface hidden requirements.
|
||||
|
||||
---
|
||||
|
||||
## Standalone BMGD Workflows
|
||||
|
||||
BMGD Phase 4 workflows are standalone implementations tailored for game development:
|
||||
|
||||
```yaml
|
||||
workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml'
|
||||
```
|
||||
|
||||
This means:
|
||||
|
||||
1. BMGD workflows are self-contained with game-specific logic
|
||||
2. Game-focused templates, checklists, and instructions
|
||||
3. No dependency on BMM workflow files
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-start.md)** - Get started with BMGD
|
||||
- **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** - Rapid prototyping and development
|
||||
- **[Agents Guide](../../../../docs/modules/bmgd-bmad-game-dev/agents-guide.md)** - Agent reference
|
||||
- **[Game Types Guide](../../../../docs/modules/bmgd-bmad-game-dev/game-types-guide.md)** - Game type templates
|
||||
144
docs/modules/bmm-bmad-method/agents-guide.md
Normal file
144
docs/modules/bmm-bmad-method/agents-guide.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# BMM Agents Reference
|
||||
|
||||
Quick reference of what each agent can do based on their available commands.
|
||||
|
||||
---
|
||||
|
||||
## Analyst (Mary) | `/bmad:bmm:agents:analyst`
|
||||
|
||||
Business analysis and research.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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
|
||||
- Party mode and advanced elicitation
|
||||
|
||||
---
|
||||
|
||||
## PM (John) | `/bmad:bmm:agents:pm`
|
||||
|
||||
Product requirements and planning.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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
|
||||
- Party mode and advanced elicitation
|
||||
|
||||
---
|
||||
|
||||
## Architect (Winston) | `/bmad:bmm:agents:architect`
|
||||
|
||||
System architecture and technical design.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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
|
||||
- Party mode and advanced elicitation
|
||||
|
||||
---
|
||||
|
||||
## SM (Bob) | `/bmad:bmm:agents:sm`
|
||||
|
||||
Sprint planning and story preparation.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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
|
||||
- Party mode and advanced elicitation
|
||||
|
||||
---
|
||||
|
||||
## DEV (Amelia) | `/bmad:bmm:agents:dev`
|
||||
|
||||
Story implementation and code review.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*dev-story` - Execute story workflow (implementation with tests)
|
||||
- `*code-review` - Thorough code review
|
||||
|
||||
---
|
||||
|
||||
## Quick Flow Solo Dev (Barry) | `/bmad:bmm:agents:quick-flow-solo-dev`
|
||||
|
||||
Fast solo development without handoffs.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*create-tech-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) | `/bmad:bmm:agents:tea`
|
||||
|
||||
Test architecture and quality strategy.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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) | `/bmad:bmm:agents:ux-designer`
|
||||
|
||||
User experience and UI design.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*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) | `/bmad:bmm:agents:tech-writer`
|
||||
|
||||
Technical documentation and diagrams.
|
||||
|
||||
**Capabilities:**
|
||||
|
||||
- `*document-project` - Comprehensive project documentation (brownfield analysis)
|
||||
- `*generate-mermaid` - Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)
|
||||
- `*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 with examples
|
||||
- `*standards-guide` - Show BMAD documentation standards reference
|
||||
|
||||
---
|
||||
|
||||
## Universal Commands
|
||||
|
||||
Available to all agents:
|
||||
|
||||
- `*menu` - Redisplay menu options
|
||||
- `*dismiss` - Dismiss agent
|
||||
|
||||
Party mode is available to most agents for multi-agent collaboration.
|
||||
@@ -8,15 +8,16 @@
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD Quick Flow is the fastest path from idea to production in the BMAD Method ecosystem. It's a streamlined 3-step process designed for rapid development without sacrificing quality. Perfect for experienced teams who need to move fast or for smaller features that don't require extensive planning.
|
||||
BMAD Quick Flow is the fastest path from idea to production in the BMAD Method ecosystem. It's a streamlined 3-step process designed for rapid spec driven development without sacrificing quality. Perfect for experienced teams who need to move fast or for smaller features or 1 off efforts that don't require extensive planning.
|
||||
|
||||
### When to Use Quick Flow
|
||||
|
||||
**Perfect For:**
|
||||
|
||||
- Bug fixes and patches
|
||||
- Small feature additions (1-3 days of work)
|
||||
- Small feature additions
|
||||
- Proof of concepts and prototypes
|
||||
- Mid course corrections or additions of something missed in BMM full planning
|
||||
- Performance optimizations
|
||||
- API endpoint additions
|
||||
- UI component enhancements
|
||||
@@ -31,42 +32,19 @@ BMAD Quick Flow is the fastest path from idea to production in the BMAD Method e
|
||||
- Projects requiring extensive UX design
|
||||
- Enterprise-wide initiatives
|
||||
- Mission-critical systems with compliance requirements
|
||||
- Ideas with many 'moving pieces'
|
||||
|
||||
---
|
||||
|
||||
## The Quick Flow Process
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START[Idea/Requirement] --> DECIDE{Planning Needed?}
|
||||
Utilizing the Quick Flow Solo Dev, this one agent can do it all!
|
||||
|
||||
DECIDE -->|Yes| CREATE[create-tech-spec]
|
||||
DECIDE -->|No| DIRECT[Direct Development]
|
||||
1. Create an (option) Technical Specification
|
||||
2. Develop with Tests
|
||||
3. AI Driven Code Review
|
||||
|
||||
CREATE --> SPEC[Technical Specification]
|
||||
SPEC --> DEV[quick-dev]
|
||||
DIRECT --> DEV
|
||||
|
||||
DEV --> COMPLETE{Implementation Complete}
|
||||
|
||||
COMPLETE -->|Success| REVIEW{Code Review?}
|
||||
COMPLETE -->|Issues| DEBUG[Debug & Fix]
|
||||
DEBUG --> DEV
|
||||
|
||||
REVIEW -->|Yes| CODE_REVIEW[code-review]
|
||||
REVIEW -->|No| DONE[Production Ready]
|
||||
|
||||
CODE_REVIEW --> FIXES{Fixes Needed?}
|
||||
FIXES -->|Yes| DEBUG
|
||||
FIXES -->|No| DONE
|
||||
|
||||
style START fill:#e1f5fe
|
||||
style CREATE fill:#f3e5f5
|
||||
style SPEC fill:#e8f5e9
|
||||
style DEV fill:#fff3e0
|
||||
style CODE_REVIEW fill:#f1f8e9
|
||||
style DONE fill:#e0f2f1
|
||||
```
|
||||
That's it! Lets look at each step in more detail though.
|
||||
|
||||
### Step 1: Optional Technical Specification
|
||||
|
||||
@@ -103,7 +81,7 @@ The `create-tech-spec` workflow transforms requirements into implementation-read
|
||||
- Make adjustments as needed
|
||||
- Save to sprint artifacts
|
||||
|
||||
**Output:** `{sprint_artifacts}/tech-spec-{slug}.md`
|
||||
**Output:** `{implementation_artifacts}/tech-spec-{slug}.md`
|
||||
|
||||
### Step 2: Development
|
||||
|
||||
@@ -137,7 +137,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
|
||||
```bash
|
||||
# Load BMad Master or any agent
|
||||
{bmad_folder}/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
_bmad/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
```
|
||||
|
||||
- Splits on level 2 sections by default
|
||||
@@ -147,7 +147,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
2. **Then:** Run `index-docs` task to create navigation:
|
||||
|
||||
```bash
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
_bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
|
||||
@@ -210,7 +210,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
|
||||
```bash
|
||||
# For each massive doc (>500 lines or 10+ level 2 sections)
|
||||
{bmad_folder}/core/tools/shard-doc.xml \
|
||||
_bmad/core/tools/shard-doc.xml \
|
||||
--input docs/api-documentation.md \
|
||||
--output docs/api/ \
|
||||
--level 2 # Split on ## headers (default)
|
||||
@@ -219,7 +219,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
**Step 2: Generate index**
|
||||
|
||||
```bash
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
_bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
**Step 3: Validate**
|
||||
@@ -340,7 +340,7 @@ flowchart TD
|
||||
**Status Progression:**
|
||||
|
||||
- Epic: `backlog → in-progress → done`
|
||||
- Story: `backlog → drafted → ready-for-dev → in-progress → review → done`
|
||||
- Story: `backlog → ready-for-dev → in-progress → review → done`
|
||||
|
||||
**Brownfield-Specific Implementation Tips:**
|
||||
|
||||
@@ -397,7 +397,7 @@ Document in tech-spec/architecture:
|
||||
### 8. Use Sprint Planning Effectively
|
||||
|
||||
- Run `sprint-planning` at Phase 4 start
|
||||
- Context epics before drafting stories
|
||||
- Context epics before creating stories
|
||||
- Update `sprint-status.yaml` as work progresses
|
||||
|
||||
### 9. Learn Continuously
|
||||
@@ -725,8 +725,7 @@ flowchart TD
|
||||
- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM
|
||||
- **[Glossary](./glossary.md)** - Key terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Troubleshooting](./troubleshooting.md)** - Problem resolution
|
||||
- **[Workflow Documentation](./README.md#-workflow-guides)** - Complete workflow reference
|
||||
- **[Workflow Documentation](./index.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
|
||||
@@ -199,24 +199,11 @@ PRDs are for Level 2-4 projects with multiple features requiring product-level c
|
||||
|
||||
### Q: How do I mark a story as done?
|
||||
|
||||
**A:** You have two options:
|
||||
**A:** After dev-story completes and code-review passes:
|
||||
|
||||
**Option 1: Use story-done workflow (Recommended)**
|
||||
|
||||
1. Load SM agent
|
||||
2. Run `story-done` workflow
|
||||
3. Workflow automatically updates `sprint-status.yaml` (created by sprint-planning at Phase 4 start)
|
||||
4. Moves story from current status → `DONE`
|
||||
5. Advances the story queue
|
||||
|
||||
**Option 2: Manual update**
|
||||
|
||||
1. After dev-story completes and code-review passes
|
||||
2. Open `sprint-status.yaml` (created by sprint-planning)
|
||||
3. Change the story status from `review` to `done`
|
||||
4. Save the file
|
||||
|
||||
The story-done workflow is faster and ensures proper status file updates.
|
||||
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?
|
||||
|
||||
@@ -367,11 +354,9 @@ Use them together for best results.
|
||||
|
||||
**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.
|
||||
|
||||
See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics.
|
||||
|
||||
### 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_folder}/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
**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.
|
||||
|
||||
@@ -186,12 +186,11 @@ Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS,
|
||||
### Story Status Progression
|
||||
|
||||
```
|
||||
backlog → drafted → ready-for-dev → in-progress → review → done
|
||||
backlog → ready-for-dev → in-progress → review → done
|
||||
```
|
||||
|
||||
- **backlog** - Story exists in epic but not yet drafted
|
||||
- **drafted** - Story file created by SM via create-story
|
||||
- **ready-for-dev** - Story drafted and reviewed, ready for DEV
|
||||
- **backlog** - Story exists in epic but not yet created
|
||||
- **ready-for-dev** - Story file created via create-story; validation is optional (run `validate-create-story` for quality check before dev picks it up)
|
||||
- **in-progress** - DEV is implementing via dev-story
|
||||
- **review** - Implementation complete, awaiting code-review
|
||||
- **done** - Completed with DoD met
|
||||
@@ -23,7 +23,7 @@ When you edit `workflow-method-greenfield.excalidraw`, regenerate the SVG:
|
||||
After regenerating the SVG, validate that it renders correctly:
|
||||
|
||||
```bash
|
||||
./tools/validate-svg-changes.sh src/modules/bmm/docs/images/workflow-method-greenfield.svg
|
||||
./tools/validate-svg-changes.sh path/to/workflow-method-greenfield.svg
|
||||
```
|
||||
|
||||
This script:
|
||||
@@ -2934,7 +2934,7 @@
|
||||
"gap": 1
|
||||
},
|
||||
"endBinding": {
|
||||
"elementId": "proc-story-done",
|
||||
"elementId": "proc-code-review",
|
||||
"focus": 0.04241833499478815,
|
||||
"gap": 1.3466869862454587
|
||||
},
|
||||
@@ -3189,7 +3189,7 @@
|
||||
"lineHeight": 1.25
|
||||
},
|
||||
{
|
||||
"id": "proc-story-done",
|
||||
"id": "proc-code-review",
|
||||
"type": "rectangle",
|
||||
"x": 1169.3991588878014,
|
||||
"y": 947.2529662369525,
|
||||
@@ -3207,12 +3207,12 @@
|
||||
"value": 8
|
||||
},
|
||||
"groupIds": [
|
||||
"proc-story-done-group"
|
||||
"proc-code-review-group"
|
||||
],
|
||||
"boundElements": [
|
||||
{
|
||||
"type": "text",
|
||||
"id": "proc-story-done-text"
|
||||
"id": "proc-code-review-text"
|
||||
},
|
||||
{
|
||||
"type": "arrow",
|
||||
@@ -3235,7 +3235,7 @@
|
||||
"link": null
|
||||
},
|
||||
{
|
||||
"id": "proc-story-done-text",
|
||||
"id": "proc-code-review-text",
|
||||
"type": "text",
|
||||
"x": 1187.9272045420983,
|
||||
"y": 972.2529662369525,
|
||||
@@ -3249,14 +3249,14 @@
|
||||
"roughness": 0,
|
||||
"opacity": 100,
|
||||
"groupIds": [
|
||||
"proc-story-done-group"
|
||||
"proc-code-review-group"
|
||||
],
|
||||
"fontSize": 16,
|
||||
"fontFamily": 1,
|
||||
"text": "Code Review\n<<use different\nLLM>>",
|
||||
"textAlign": "center",
|
||||
"verticalAlign": "middle",
|
||||
"containerId": "proc-story-done",
|
||||
"containerId": "proc-code-review",
|
||||
"locked": false,
|
||||
"version": 502,
|
||||
"versionNonce": 1242095014,
|
||||
@@ -3289,7 +3289,7 @@
|
||||
"opacity": 100,
|
||||
"groupIds": [],
|
||||
"startBinding": {
|
||||
"elementId": "proc-story-done",
|
||||
"elementId": "proc-code-review",
|
||||
"focus": 0.014488632877232727,
|
||||
"gap": 8.284295421831303
|
||||
},
|
||||
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
130
docs/modules/bmm-bmad-method/index.md
Normal file
130
docs/modules/bmm-bmad-method/index.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# BMM Documentation
|
||||
|
||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
**New to BMM?** Start here:
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Step-by-step guide to building your first project
|
||||
- Installation and setup
|
||||
- Understanding the four phases
|
||||
- Running your first workflows
|
||||
- Agent-based development flow
|
||||
|
||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
||||
|
||||
### 📊 Visual Overview
|
||||
|
||||
**[Complete Workflow Diagram](./images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
|
||||
|
||||
## 📖 Core Concepts
|
||||
|
||||
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
||||
|
||||
First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts.
|
||||
|
||||
- **[Full Adaptive BMad Method](#-workflow-guides)** - Full planning and scope support through extensive development and testing.
|
||||
- Broken down into 4 phases, all of which are comprised of both required and optional phases
|
||||
- Phases 1-3 are all about progressive idea development through planning and preparations to build your project.
|
||||
- Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planing completed
|
||||
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
|
||||
- While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
|
||||
|
||||
- **[BMAD Quick Flow](./bmad-quick-flow.md)** - Fast-track development workflow
|
||||
- 3-step process: spec → dev → optional review
|
||||
- Perfect for bug fixes and small features
|
||||
- Rapid prototyping with production quality
|
||||
- Implementation in minutes, not days
|
||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)**
|
||||
|
||||
## 🤖 Agents and Collaboration
|
||||
|
||||
Complete guide to BMM's AI agent team:
|
||||
|
||||
- **[Agents Guide](./agents-guide.md)** - Comprehensive agent reference
|
||||
- 12 specialized BMM agents + BMad Master
|
||||
- Agent roles, workflows, and when to use them
|
||||
- Agent customization system
|
||||
- Best practices and common patterns
|
||||
|
||||
- **[Party Mode Guide](./party-mode.md)** - Multi-agent collaboration
|
||||
- How party mode works (19+ agents collaborate in real-time)
|
||||
- When to use it (strategic, creative, cross-functional, complex)
|
||||
- Example party compositions
|
||||
- Multi-module integration (BMM + CIS + BMB + custom)
|
||||
- Agent customization in party mode
|
||||
- Best practices
|
||||
|
||||
## 🔧 Working with Existing Code
|
||||
|
||||
Comprehensive guide for brownfield development:
|
||||
|
||||
- **[Brownfield Development Guide](./brownfield-guide.md)** - Complete guide for existing codebases
|
||||
- Documentation phase strategies
|
||||
- Track selection for brownfield
|
||||
- Integration with existing patterns
|
||||
- Phase-by-phase workflow guidance
|
||||
- Common scenarios
|
||||
|
||||
## 📚 Quick References
|
||||
|
||||
Essential reference materials:
|
||||
|
||||
- **[Glossary](./glossary.md)** - Key terminology and concepts
|
||||
- **[FAQ](./faq.md)** - Frequently asked questions across all topics
|
||||
|
||||
## 🎯 Choose Your Path
|
||||
|
||||
### I need to...
|
||||
|
||||
**Build something new (greenfield)**
|
||||
→ Start with [Quick Start Guide](./quick-start.md)
|
||||
|
||||
**Fix a bug or add small feature**
|
||||
→ User the [Quick Flow Solo Dev](./quick-flow-solo-dev.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](./quick-spec-flow.md) process
|
||||
|
||||
**Work with existing codebase (brownfield)**
|
||||
→ Read [Brownfield Development Guide](./brownfield-guide.md)
|
||||
→ Pay special attention to documentation requirements for brownfield projects
|
||||
|
||||
## 📋 Workflow Guides
|
||||
|
||||
Comprehensive documentation for all BMM workflows organized by phase:
|
||||
|
||||
- **[Phase 1: Analysis Workflows](./workflows-analysis.md)** - Optional exploration and research workflows (595 lines)
|
||||
- brainstorm-project, product-brief, research, and more
|
||||
- When to use analysis workflows
|
||||
- Creative and strategic tools
|
||||
|
||||
- **[Phase 2: Planning Workflows](./workflows-planning.md)** - Scale-adaptive planning (967 lines)
|
||||
- prd, tech-spec, gdd, narrative, ux
|
||||
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
||||
- Which planning workflow to use
|
||||
|
||||
- **[Phase 3: Solutioning Workflows](./workflows-solutioning.md)** - Architecture and validation (638 lines)
|
||||
- architecture, create-epics-and-stories, implementation-readiness
|
||||
- V6: Epics created AFTER architecture for better quality
|
||||
- Required for BMad Method and Enterprise Method tracks
|
||||
- Preventing agent conflicts
|
||||
|
||||
- **[Phase 4: Implementation Workflows](./workflows-implementation.md)** - Sprint-based development (1,634 lines)
|
||||
- sprint-planning, create-story, dev-story, code-review
|
||||
- Complete story lifecycle
|
||||
- One-story-at-a-time discipline
|
||||
|
||||
- **[Testing & QA Workflows](./test-architecture.md)** - Comprehensive quality assurance (1,420 lines)
|
||||
- Test strategy, automation, quality gates
|
||||
- TEA agent and test healing
|
||||
|
||||
## 🌐 External Resources
|
||||
|
||||
### Community and Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues)
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
||||
|
||||
**Ready to begin?** → [Start with the Quick Start Guide](./quick-start.md)
|
||||
@@ -2,13 +2,11 @@
|
||||
|
||||
**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), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer, the CIS creative agents - everyone shows up.
|
||||
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:**
|
||||
|
||||
@@ -19,15 +17,13 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
||||
|
||||
**Future use:** Advanced elicitation workflows will leverage party mode for sophisticated requirement gathering.
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
**The basics:**
|
||||
|
||||
1. Party mode reads `{bmad_folder}/_cfg/agent-manifest.csv`
|
||||
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
|
||||
@@ -46,6 +42,10 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
# OR from any agent context
|
||||
*party-mode
|
||||
|
||||
# Super Hack
|
||||
|
||||
/bmad:core:workflows:party-mode and include also in the party Santa Clause and Einstein
|
||||
|
||||
# During party
|
||||
Ask questions, respond to agents, direct the conversation
|
||||
|
||||
@@ -103,116 +103,6 @@ _(Ideas cross-pollinate and evolve)_
|
||||
|
||||
_(Multiple perspectives reveal the right answer)_
|
||||
|
||||
---
|
||||
|
||||
## When NOT to Use Party Mode
|
||||
|
||||
**Skip party mode for:**
|
||||
|
||||
- Simple implementation questions → Use DEV agent
|
||||
- Document review → Use Technical Writer
|
||||
- Workflow status checks → Use any agent + `*workflow-status`
|
||||
- Single-domain questions → Use specialist agent
|
||||
|
||||
**Use party mode for:**
|
||||
|
||||
- Multi-perspective decisions
|
||||
- Creative collaboration
|
||||
- Post-mortems and retrospectives
|
||||
- Sprint planning sessions
|
||||
- Complex problem-solving
|
||||
|
||||
---
|
||||
|
||||
## Agent Customization
|
||||
|
||||
Party mode uses agents from `{bmad_folder}/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
|
||||
**To customize agents for party mode:**
|
||||
|
||||
1. Create customization file: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
2. Run `npx bmad-method install` to rebuild agents
|
||||
3. Customizations now active in party mode
|
||||
|
||||
Example customization:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
persona:
|
||||
principles:
|
||||
- 'HIPAA compliance is non-negotiable'
|
||||
- 'Patient safety over feature velocity'
|
||||
```
|
||||
|
||||
See [Agents Guide](./agents-guide.md#agent-customization) for details.
|
||||
|
||||
---
|
||||
|
||||
## BMM Workflows That Use Party Mode
|
||||
|
||||
**Current:**
|
||||
|
||||
- `epic-retrospective` - Post-epic team retrospective powered by party mode
|
||||
- Sprint planning discussions (informal party mode usage)
|
||||
|
||||
**Future:**
|
||||
|
||||
- Advanced elicitation workflows will officially integrate party mode
|
||||
- Multi-agent requirement validation
|
||||
- Collaborative technical reviews
|
||||
|
||||
---
|
||||
|
||||
## Available Agents
|
||||
|
||||
Party mode can include **19+ agents** from all installed modules:
|
||||
|
||||
**BMM (12 agents):** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer, Game Designer, Game Developer, Game Architect
|
||||
|
||||
**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller
|
||||
|
||||
**BMB (1 agent):** BMad Builder
|
||||
|
||||
**Core (1 agent):** BMad Master (orchestrator)
|
||||
|
||||
**Custom:** Any agents you've created
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
**Get better results:**
|
||||
|
||||
- Be specific with your topic/question
|
||||
- Provide context (project type, constraints, goals)
|
||||
- Direct specific agents when you want their expertise
|
||||
- Make decisions - party mode informs, you decide
|
||||
- Time box discussions (15-30 minutes is usually plenty)
|
||||
|
||||
**Examples of good opening questions:**
|
||||
|
||||
- "We need to decide between REST and GraphQL for our mobile API. Project is a B2B SaaS with 50 enterprise clients."
|
||||
- "Our last sprint failed spectacularly. Let's discuss what went wrong with authentication implementation."
|
||||
- "Brainstorm: how can we make our game's tutorial feel rewarding instead of tedious?"
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Same agents responding every time?**
|
||||
Vary your questions or explicitly request other perspectives: "Game Designer, your thoughts?"
|
||||
|
||||
**Discussion going in circles?**
|
||||
BMad Master will summarize and redirect, or you can make a decision and move on.
|
||||
|
||||
**Too many agents talking?**
|
||||
Make your topic more specific - BMad Master picks 2-3 agents based on relevance.
|
||||
|
||||
**Agents not using customizations?**
|
||||
Make sure you ran `npx bmad-method install` after creating customization files.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
@@ -1,6 +1,6 @@
|
||||
# Quick Flow Solo Dev Agent (Barry)
|
||||
|
||||
**Agent ID:** `.bmad/bmm/agents/quick-flow-solo-dev.md`
|
||||
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
||||
**Icon:** 🚀
|
||||
**Module:** BMM
|
||||
|
||||
@@ -36,25 +36,25 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel
|
||||
|
||||
### 1. **create-tech-spec**
|
||||
|
||||
- **Workflow:** `.bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
|
||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
|
||||
- **Description:** Architect a technical spec with implementation-ready stories
|
||||
- **Use when:** You need to transform requirements into a buildable spec
|
||||
|
||||
### 2. **quick-dev**
|
||||
|
||||
- **Workflow:** `.bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml`
|
||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml`
|
||||
- **Description:** Ship features from spec or direct instructions - no handoffs
|
||||
- **Use when:** You're ready to ship code based on a spec or clear instructions
|
||||
|
||||
### 3. **code-review**
|
||||
|
||||
- **Workflow:** `.bmad/bmm/workflows/4-implementation/code-review/workflow.yaml`
|
||||
- **Workflow:** `_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml`
|
||||
- **Description:** Review code for quality, patterns, and acceptance criteria
|
||||
- **Use when:** You need to validate implementation quality
|
||||
|
||||
### 4. **party-mode**
|
||||
|
||||
- **Workflow:** `.bmad/core/workflows/party-mode/workflow.yaml`
|
||||
- **Workflow:** `_bmad/core/workflows/party-mode/workflow.yaml`
|
||||
- **Description:** Bring in other experts when I need specialized backup
|
||||
- **Use when:** You need collaborative problem-solving or specialized expertise
|
||||
|
||||
@@ -371,18 +371,10 @@ Checks:
|
||||
|
||||
**Total time:** 1-3 hours (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
## Integration with Phase 4 Workflows
|
||||
|
||||
Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
|
||||
### story-context (SM Agent)
|
||||
|
||||
- ✅ Recognizes tech-spec.md as authoritative source
|
||||
- ✅ Extracts context from tech-spec (replaces PRD)
|
||||
- ✅ Generates XML context for complex scenarios
|
||||
|
||||
### create-story (SM Agent)
|
||||
|
||||
- ✅ Can work with tech-spec.md instead of PRD
|
||||
@@ -401,8 +393,6 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
- ✅ Uses tech-spec.md as comprehensive context
|
||||
- ✅ Implements following detected conventions
|
||||
|
||||
---
|
||||
|
||||
## Comparison: Quick Spec vs Full BMM
|
||||
|
||||
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
||||
@@ -417,7 +407,6 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
||||
| **Conventions** | Auto-detects and confirms | Document in PRD/Architecture |
|
||||
|
||||
---
|
||||
|
||||
## When to Graduate from Quick Flow to BMad Method
|
||||
|
||||
@@ -432,8 +421,6 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
||||
|
||||
---
|
||||
|
||||
## Quick Spec Flow - Key Benefits
|
||||
|
||||
### 🚀 **Speed**
|
||||
@@ -471,8 +458,6 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
- No scope creep
|
||||
- Fast iteration
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
@@ -484,12 +469,12 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
```bash
|
||||
# For a quick bug fix or small change:
|
||||
# 1. Load PM agent
|
||||
# 1. Load Quick Dev Solo agent
|
||||
# 2. Say: "I want to [describe your change]"
|
||||
# 3. PM will ask if you want to run tech-spec
|
||||
# 3. Agent will ask if you want to run tech-spec
|
||||
# 4. Answer questions about your change
|
||||
# 5. Get tech-spec + story
|
||||
# 6. Load DEV agent and implement!
|
||||
# 6. Reload a fresh context with the solo agent and implement!
|
||||
|
||||
# For a small feature with multiple stories:
|
||||
# Same as above, but get epic + 2-3 stories
|
||||
@@ -498,14 +483,7 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
### No workflow-init Required!
|
||||
|
||||
Quick Spec Flow is **fully standalone**:
|
||||
|
||||
- Detects if it's a single change or multi-story feature
|
||||
- Asks for greenfield vs brownfield
|
||||
- Works without status file tracking
|
||||
- Perfect for rapid prototyping
|
||||
|
||||
---
|
||||
Quick Spec Flow is **fully standalone**
|
||||
|
||||
## FAQ
|
||||
|
||||
@@ -529,10 +507,6 @@ Quick Spec Flow is **fully standalone**:
|
||||
|
||||
**A:** No problem! You can always transition to BMad Method by running workflow-init and create-prd. Your tech-spec becomes input for the PRD.
|
||||
|
||||
### Q: Do I need story-context for every story?
|
||||
|
||||
**A:** Usually no! Tech-spec is comprehensive enough for most Quick Flow projects. Only use story-context for complex edge cases.
|
||||
|
||||
### Q: Can I skip validation?
|
||||
|
||||
**A:** No, validation always runs automatically. But it's fast and catches issues early!
|
||||
@@ -564,15 +538,11 @@ Starter templates save hours of setup time. Let Quick Spec Flow find the best on
|
||||
|
||||
When validation runs, read the scores. They tell you if your spec is production-ready.
|
||||
|
||||
### 5. **Story Context is Optional**
|
||||
|
||||
For single changes, try going directly to dev-story first. Only add story-context if you hit complexity.
|
||||
|
||||
### 6. **Keep Single Changes Truly Atomic**
|
||||
### 5. **Keep Single Changes Truly Atomic**
|
||||
|
||||
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
|
||||
|
||||
### 7. **Validate Story Sequence for Multi-Story Features**
|
||||
### 6. **Validate Story Sequence for Multi-Story Features**
|
||||
|
||||
When you get multiple stories, check the dependency validation output. Proper sequence matters!
|
||||
|
||||
@@ -643,7 +613,7 @@ Quick Spec Flow is your **fast path from idea to implementation** for:
|
||||
## Next Steps
|
||||
|
||||
- **Try it now:** Load PM agent and describe a small change
|
||||
- **Learn more:** See the [BMM Workflow Guides](./README.md#-workflow-guides) for comprehensive workflow documentation
|
||||
- **Learn more:** See the [BMM Workflow Guides](./index.md#-workflow-guides) for comprehensive workflow documentation
|
||||
- **Need help deciding?** Run `workflow-init` to get a recommendation
|
||||
- **Have questions?** Join us on Discord: <https://discord.gg/gk8jAdXWmj>
|
||||
|
||||
@@ -6,12 +6,12 @@ Get started with BMad Method v6 for your new greenfield project. This guide walk
|
||||
|
||||
1. **Install**: `npx bmad-method@alpha install`
|
||||
2. **Initialize**: Load Analyst agent → Run "workflow-init"
|
||||
3. **Plan**: Load PM agent → Run "prd" (or "tech-spec" for small projects)
|
||||
4. **Architect**: Load Architect agent → Run "create-architecture" (10+ stories only)
|
||||
5. **Build**: Load SM agent → Run workflows for each story → Load DEV agent → Implement
|
||||
6. **Always use fresh chats** for each workflow to avoid hallucinations
|
||||
|
||||
---
|
||||
3. **Plan**: Load PM agent to create a PRD
|
||||
4. **Plan UX**: Load UX Expert to create a UX-Design if your application will have a UX/UI element
|
||||
5. **Architect**: Load Architect agent → Run "create-architecture"
|
||||
6. **Epic Plan**: The PM steps back in to help run the create-epics-and-stories
|
||||
7. **Build**: Load SM agent → Run workflows for each story → Load DEV agent → Implement
|
||||
8. **Always use fresh chats** for each workflow to avoid context issues
|
||||
|
||||
## What is BMad Method?
|
||||
|
||||
@@ -35,7 +35,7 @@ _Complete visual flowchart showing all phases, workflows, agents (color-coded),
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
The interactive installer will guide you through setup and create a `{bmad_folder}/` folder with all agents and workflows.
|
||||
The interactive installer will guide you through setup and create a `_bmad/` folder with all agents and workflows.
|
||||
|
||||
---
|
||||
|
||||
@@ -43,10 +43,7 @@ The interactive installer will guide you through setup and create a `{bmad_folde
|
||||
|
||||
### Step 1: Initialize Your Workflow
|
||||
|
||||
1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for how to activate agents:
|
||||
- [Claude Code](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/ide-info/claude-code.md)
|
||||
- [VS Code/Cursor/Windsurf](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) - Check your IDE folder
|
||||
- Other IDEs also supported
|
||||
1. **Load the Analyst agent** in your IDE - Generally this is done by typing `/<workflow or agent name - allow autocomplete to find the right command>` - if you are unsure, you can just start with /bmad and see all that is available, sorted by agents and workflows.
|
||||
2. **Wait for the agent's menu** to appear
|
||||
3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number
|
||||
|
||||
@@ -113,7 +110,7 @@ The next TRULY REQUIRED step is:
|
||||
|
||||
When an agent tells you to run a workflow (like `prd`):
|
||||
|
||||
1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for your IDE's specific instructions
|
||||
1. **Start a new chat** with the specified agent
|
||||
2. **Wait for the menu** to appear
|
||||
3. **Tell the agent** to run it using any of these formats:
|
||||
- Type the shorthand: `*prd`
|
||||
@@ -200,12 +197,12 @@ Once planning and architecture are complete, you'll move to Phase 4. **Important
|
||||
3. Tell the agent: "Run sprint-planning"
|
||||
4. This creates your `sprint-status.yaml` file that tracks all epics and stories
|
||||
|
||||
#### 3.2 Draft Your First Story
|
||||
#### 3.2 Create Your First Story
|
||||
|
||||
1. **Start a new chat** with the **SM agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run create-story"
|
||||
4. This drafts the story file from the epic
|
||||
4. This creates the story file from the epic
|
||||
|
||||
#### 3.3 Implement the Story
|
||||
|
||||
@@ -350,7 +347,7 @@ A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directl
|
||||
|
||||
- **During workflows**: Agents guide you with questions and explanations
|
||||
- **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
|
||||
- **Complete guide**: [BMM Workflow Documentation](./README.md#-workflow-guides)
|
||||
- **Complete guide**: [BMM Workflow Documentation](./index.md#-workflow-guides)
|
||||
- **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
---
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
last-redoc-date: 2025-11-05
|
||||
---
|
||||
|
||||
# Test Architect (TEA) Agent Guide
|
||||
|
||||
## Overview
|
||||
@@ -26,14 +22,17 @@ graph TB
|
||||
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</b>"]
|
||||
CI["<b>TEA: *ci</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 test infrastructure setup</b>"]
|
||||
Phase3Note["<b>Epics created AFTER architecture,</b><br/><b>then system-level test design and test infrastructure setup</b>"]
|
||||
EpicsStories -.-> Phase3Note
|
||||
end
|
||||
|
||||
@@ -93,12 +92,17 @@ graph TB
|
||||
- **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` → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
|
||||
- **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` runs per-epic in Phase 4. Output: `test-design-epic-N.md`.
|
||||
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**:
|
||||
|
||||
Quick Flow track skips Phase 1 and 3. BMad Method and Enterprise use all phases based on project needs.
|
||||
- **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
|
||||
|
||||
@@ -147,22 +151,6 @@ Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision)
|
||||
|
||||
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
|
||||
|
||||
### Unique Directory Architecture
|
||||
|
||||
TEA is the only BMM agent with its own top-level module directory (`bmm/testarch/`):
|
||||
|
||||
```
|
||||
src/modules/bmm/
|
||||
├── agents/
|
||||
│ └── tea.agent.yaml # Agent definition (standard location)
|
||||
├── workflows/
|
||||
│ └── testarch/ # TEA workflows (standard location)
|
||||
└── testarch/ # Knowledge base (UNIQUE!)
|
||||
├── knowledge/ # 21 production-ready test pattern fragments
|
||||
├── tea-index.csv # Centralized knowledge lookup (21 fragments indexed)
|
||||
└── README.md # This guide
|
||||
```
|
||||
|
||||
### Why TEA Gets Special Treatment
|
||||
|
||||
TEA uniquely requires:
|
||||
@@ -236,6 +224,9 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||
- Use `*atdd` before coding when the team can adopt ATDD; share its checklist with the dev agent.
|
||||
- Post-implementation, keep `*trace` current, expand coverage with `*automate`, optionally review test quality with `*test-review`. For release gate, run `*trace` with Phase 2 enabled to get deployment decision.
|
||||
- Use `*test-review` after `*atdd` to validate generated tests, after `*automate` to ensure regression quality, or before gate for final audit.
|
||||
- Clarification: `*test-review` is optional and only audits existing tests; run it after `*atdd` or `*automate` when you want a quality review, not as a required step.
|
||||
- Clarification: `*atdd` outputs are not auto-consumed; share the ATDD doc/tests with the dev workflow. `*trace` does not run `*atdd`—it evaluates existing artifacts for coverage and gate readiness.
|
||||
- Clarification: `*ci` is a one-time setup; recommended early (Phase 3 or before feature work), but it can be done later if it was skipped.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -264,17 +255,17 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||
- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks
|
||||
- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| ---------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
|
||||
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
|
||||
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| --------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
|
||||
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
|
||||
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
@@ -314,15 +305,15 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||
- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment)
|
||||
- 📦 Release Gate - Archive artifacts and compliance evidence for audits
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
|
||||
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
|
||||
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
|
||||
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
|
||||
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
@@ -398,7 +389,7 @@ MCP provides additional capabilities on top of TEA's default AI-based approach:
|
||||
}
|
||||
```
|
||||
|
||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `{bmad_folder}/bmm/config.yaml` OR remove MCPs from IDE config.
|
||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` OR remove MCPs from IDE config.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -440,23 +431,21 @@ Provides fixture-based utilities that integrate into TEA's test generation and r
|
||||
|
||||
**Utilities available** (11 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition
|
||||
|
||||
**Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `{bmad_folder}/bmm/config.yaml`.
|
||||
**Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `_bmad/bmm/config.yaml`.
|
||||
|
||||
**To disable**: Set `tea_use_playwright_utils: false` in `{bmad_folder}/bmm/config.yaml`.
|
||||
**To disable**: Set `tea_use_playwright_utils: false` in `_bmad/bmm/config.yaml`.
|
||||
|
||||
</details>
|
||||
|
||||
<br></br>
|
||||
|
||||
| Command | Workflow README | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
||||
| -------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `*framework` | [📖](../workflows/testarch/framework/README.md) | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
|
||||
| `*ci` | [📖](../workflows/testarch/ci/README.md) | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
|
||||
| `*test-design` | [📖](../workflows/testarch/test-design/README.md) | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
|
||||
| `*atdd` | [📖](../workflows/testarch/atdd/README.md) | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
|
||||
| `*automate` | [📖](../workflows/testarch/automate/README.md) | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
|
||||
| `*test-review` | [📖](../workflows/testarch/test-review/README.md) | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
|
||||
| `*nfr-assess` | [📖](../workflows/testarch/nfr-assess/README.md) | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
||||
| `*trace` | [📖](../workflows/testarch/trace/README.md) | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
||||
|
||||
**📖** = Click to view detailed workflow documentation
|
||||
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
||||
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `*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 | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
|
||||
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
|
||||
| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
|
||||
| `*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 | - |
|
||||
3
docs/modules/bmm-bmad-method/troubleshooting.md
Normal file
3
docs/modules/bmm-bmad-method/troubleshooting.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# BMM Troubleshooting Guide
|
||||
|
||||
Common issues and solutions for the BMad Method Module will be listed here as needed.
|
||||
@@ -0,0 +1,71 @@
|
||||
# Document Project Workflow - Technical Reference
|
||||
|
||||
**Module:** BMM (BMAD Method Module)
|
||||
|
||||
## Purpose
|
||||
|
||||
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type.
|
||||
|
||||
## How to Invoke
|
||||
```bash
|
||||
/bmad:bmm:workflows:document-project
|
||||
```
|
||||
---
|
||||
|
||||
## Scan Levels
|
||||
|
||||
Choose the right scan depth for your needs:
|
||||
|
||||
### 1. 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
|
||||
|
||||
**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.)
|
||||
|
||||
### 2. 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
|
||||
|
||||
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file
|
||||
|
||||
### 3. 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
|
||||
- Deep technical debt assessment
|
||||
|
||||
**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice)
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
|
||||
**Related Documentation:**
|
||||
|
||||
- [Brownfield Development Guide](./brownfield-guide.md)
|
||||
- [Implementation Workflows](./workflows-implementation.md)
|
||||
@@ -19,7 +19,6 @@ Phase 1 Analysis consists of three categories of optional workflows:
|
||||
### Discovery & Ideation (Optional)
|
||||
|
||||
- **brainstorm-project** - Multi-track solution exploration for software projects
|
||||
- **brainstorm-game** - Game concept generation (coming soon)
|
||||
|
||||
### Research & Validation (Optional)
|
||||
|
||||
@@ -54,19 +53,10 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Unclear technical approach with business objectives
|
||||
- Multiple solution paths need evaluation
|
||||
- Hidden assumptions need discovery
|
||||
- Innovation beyond obvious solutions
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Architecture proposals with trade-off analysis
|
||||
- Value framework (prioritized features)
|
||||
- Risk analysis (dependencies, challenges)
|
||||
- Strategic recommendation with rationale
|
||||
|
||||
**Example:** "We need a customer dashboard" → Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation.
|
||||
- Very vague or seed kernal of an idea that needs exploration
|
||||
- Consider alternatives or enhancements to an idea
|
||||
- See your idea from different angles and viewpoints
|
||||
- No idea what you want to build, but want to find some inspiration
|
||||
|
||||
---
|
||||
|
||||
@@ -111,11 +101,6 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
|
||||
- Transitioning from exploration to strategy
|
||||
- Need executive-level product documentation
|
||||
|
||||
**Modes:**
|
||||
|
||||
- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions
|
||||
- **YOLO Mode**: AI generates complete draft from context, then iterative refinement
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Executive summary
|
||||
@@ -179,32 +164,6 @@ Analysis outputs feed directly into Planning:
|
||||
|
||||
Planning workflows automatically load these documents if they exist in the output folder.
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Don't Over-Invest in Analysis
|
||||
|
||||
Analysis is optional. If requirements are clear, skip to Phase 2 (Planning).
|
||||
|
||||
### 2. Iterate Between Workflows
|
||||
|
||||
Common pattern: brainstorm → research (validate) → brief (synthesize)
|
||||
|
||||
### 3. Document Assumptions
|
||||
|
||||
Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge.
|
||||
|
||||
### 4. Keep It Strategic
|
||||
|
||||
Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning.
|
||||
|
||||
### 5. Involve Stakeholders
|
||||
|
||||
Use analysis workflows to align stakeholders before committing to detailed planning.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Greenfield Software (Full Analysis)
|
||||
@@ -233,34 +192,8 @@ Use analysis workflows to align stakeholders before committing to detailed plann
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md)
|
||||
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Next phase
|
||||
- [Phase 3: Solutioning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-solutioning.md)
|
||||
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Do I need to run all analysis workflows?**
|
||||
A: No! Analysis is entirely optional. Use only workflows that help you think through your problem.
|
||||
|
||||
**Q: Which workflow should I start with?**
|
||||
A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief`.
|
||||
|
||||
**Q: Can I skip straight to Planning?**
|
||||
A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/tech-spec).
|
||||
|
||||
**Q: How long should Analysis take?**
|
||||
A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning.
|
||||
|
||||
**Q: What if I discover problems during Analysis?**
|
||||
A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment.
|
||||
|
||||
**Q: Should brownfield projects do Analysis?**
|
||||
A: Usually no. Start with `document-project` (Documentation prerequisite), then skip to Planning (Phase 2).
|
||||
|
||||
---
|
||||
|
||||
_Phase 1 Analysis - Optional strategic thinking before commitment._
|
||||
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||
@@ -133,7 +133,6 @@ The `sprint-status.yaml` file is the single source of truth for all implementati
|
||||
### (BMad Method / Enterprise)
|
||||
|
||||
```
|
||||
<<<<<<< Updated upstream
|
||||
PRD (PM) → Architecture (Architect)
|
||||
→ create-epics-and-stories (PM) ← V6: After architecture!
|
||||
→ implementation-readiness (Architect)
|
||||
@@ -142,7 +141,6 @@ PRD (PM) → Architecture (Architect)
|
||||
→ story loop (SM/DEV)
|
||||
→ retrospective (SM)
|
||||
→ [Next Epic]
|
||||
=======
|
||||
Current Phase: 4 (Implementation)
|
||||
Current Epic: Epic 1 (Authentication)
|
||||
Current Sprint: Sprint 1
|
||||
@@ -154,10 +152,9 @@ Dependencies: Story 1.2 (DONE) ✅
|
||||
**Recommendation:** Run `create-story` to generate Story 1.3
|
||||
|
||||
After create-story:
|
||||
1. Run story-context
|
||||
2. Run dev-story
|
||||
3. Run code-review
|
||||
4. Run story-done
|
||||
1. Run dev-story
|
||||
2. Run code-review
|
||||
3. Update sprint-status.yaml to mark story done
|
||||
```
|
||||
|
||||
See: [workflow-status instructions](../workflows/workflow-status/instructions.md)
|
||||
@@ -190,108 +187,12 @@ See: [workflow-status instructions](../workflows/workflow-status/instructions.md
|
||||
|
||||
See: [document-project reference](./workflow-document-project-reference.md)
|
||||
|
||||
---
|
||||
|
||||
## Story Lifecycle Visualization
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ PHASE 4: IMPLEMENTATION (Iterative Story Lifecycle) │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
|
||||
┌─────────────────┐
|
||||
│ Sprint Planning │ → Creates sprint-status.yaml
|
||||
└────────┬────────┘ Defines story queue
|
||||
│
|
||||
├──────────────────────────────────────────┐
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────────┐ │
|
||||
│ Epic Tech Context │ → Optional per epic │
|
||||
│ (Once per epic) │ Provides technical │
|
||||
└─────────────────────┘ guidance │
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────────────────────────────────────┤
|
||||
│ FOR EACH STORY IN QUEUE: │
|
||||
├─────────────────────────────────────────────────┤
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ Create Story │ → Generates story file │
|
||||
│ (TODO → IN PROGRESS) │
|
||||
└────────┬────────┘ │
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ Story Context │ → Assembles focused context │
|
||||
└────────┬────────┘ │
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ Dev Story │ → Implements + tests │
|
||||
│ (IN PROGRESS) │ │
|
||||
└────────┬────────┘ │
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ Code Review │ → Senior dev review │
|
||||
│ (IN PROGRESS → │ │
|
||||
│ READY FOR REVIEW) │
|
||||
└────────┬────────┘ │
|
||||
│ │
|
||||
┌────┴────┐ │
|
||||
│ Result? │ │
|
||||
└────┬────┘ │
|
||||
│ │
|
||||
┌────┼────────────────────┐ │
|
||||
│ │ │ │
|
||||
▼ ▼ ▼ │
|
||||
APPROVED APPROVED REQUEST │
|
||||
WITH COMMENTS CHANGES │
|
||||
│ │ │ │
|
||||
└─────────┴───────────────────┘ │
|
||||
│ │
|
||||
▼ │
|
||||
┌─────────────────┐ │
|
||||
│ Story Done │ → READY FOR REVIEW → DONE│
|
||||
└────────┬────────┘ │
|
||||
│ │
|
||||
├─────────────────────────────────────┘
|
||||
│ More stories?
|
||||
│
|
||||
▼
|
||||
┌────────────────┐
|
||||
│ Epic Complete? │
|
||||
└────────┬───────┘
|
||||
│
|
||||
┌────┼────┐
|
||||
│ │
|
||||
Yes No
|
||||
│ └──> Continue to next story
|
||||
│
|
||||
▼
|
||||
┌─────────────────┐
|
||||
│ Retrospective │ → Review epic, lessons learned
|
||||
└─────────────────┘
|
||||
│
|
||||
▼
|
||||
All epics done?
|
||||
│
|
||||
Yes → PROJECT COMPLETE
|
||||
>>>>>>> Stashed changes
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 1: Analysis Workflows](./workflows-analysis.md)
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md)
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Which workflow should I run next?**
|
||||
@@ -306,6 +207,4 @@ A: Not recommended. Complete one story's full lifecycle before starting the next
|
||||
**Q: What if code review finds issues?**
|
||||
A: DEV runs `dev-story` to make fixes, re-runs tests, then runs `code-review` again until it passes.
|
||||
|
||||
---
|
||||
|
||||
_Phase 4 Implementation - One story at a time, done right._
|
||||
89
docs/modules/bmm-bmad-method/workflows-planning.md
Normal file
89
docs/modules/bmm-bmad-method/workflows-planning.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# BMM Planning Workflows (Phase 2)
|
||||
|
||||
## Phase 2 Planning Workflow Overview
|
||||
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | Track | Purpose |
|
||||
| -------------------- | ----------- | ----------------------- | ------------------------------------- |
|
||||
| **prd** | PM | BMad Method, Enterprise | Strategic PRD with FRs/NFRs |
|
||||
| **create-ux-design** | UX Designer | BMad Method, Enterprise | Optional UX specification (after PRD) |
|
||||
|
||||
### prd (Product Requirements Document)
|
||||
|
||||
**Purpose:** Strategic PRD with Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for software products (BMad Method track).
|
||||
|
||||
**Agent:** PM (with Architect and Analyst support)
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Medium to large feature sets
|
||||
- Multi-screen user experiences
|
||||
- Complex business logic
|
||||
- Multiple system integrations
|
||||
- Phased delivery required
|
||||
|
||||
**Scale-Adaptive Structure:**
|
||||
|
||||
- **Light:** Focused FRs/NFRs, simplified analysis (10-15 pages)
|
||||
- **Standard:** Comprehensive FRs/NFRs, thorough analysis (20-30 pages)
|
||||
- **Comprehensive:** Extensive FRs/NFRs, multi-phase, stakeholder analysis (30-50+ pages)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- PRD.md (complete requirements with FRs and NFRs)
|
||||
|
||||
**Note:** V6 improvement - PRD focuses on WHAT to build (requirements). Epic+Stories are created AFTER architecture via `create-epics-and-stories` workflow for better quality.
|
||||
|
||||
**Integration:** Feeds into Architecture (Phase 3)
|
||||
|
||||
**Example:** E-commerce checkout → PRD with 15 FRs (user account, cart management, payment flow) and 8 NFRs (performance, security, scalability).
|
||||
|
||||
---
|
||||
|
||||
### create-ux-design (UX Design)
|
||||
|
||||
**Purpose:** UX specification for projects where user experience is the primary differentiator (BMad Method track).
|
||||
|
||||
**Agent:** UX Designer
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- UX is primary competitive advantage
|
||||
- Complex user workflows needing design thinking
|
||||
- Innovative interaction patterns
|
||||
- Design system creation
|
||||
- Accessibility-critical experiences
|
||||
|
||||
**Collaborative Approach:**
|
||||
|
||||
1. Visual exploration (generate multiple options)
|
||||
2. Informed decisions (evaluate with user needs)
|
||||
3. Collaborative design (refine iteratively)
|
||||
4. Living documentation (evolves with project)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- ux-spec.md (complete UX specification)
|
||||
- User journeys
|
||||
- Wireframes and mockups
|
||||
- Interaction specifications
|
||||
- Design system (components, patterns, tokens)
|
||||
- Epic breakdown (UX stories)
|
||||
|
||||
**Integration:** Feeds PRD or updates epics, then Architecture (Phase 3)
|
||||
|
||||
**Example:** Dashboard redesign → Card-based layout with split-pane toggle, 5 card components, 12 color tokens, responsive grid, 3 epics (Layout, Visualization, Accessibility).
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Do 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 and will make a large quality difference. If you are adding a small addition to an existing project, you might want to consider instead after using document-project to use the quick flow solo dev process instead.
|
||||
@@ -363,7 +363,7 @@ Planning (prd by PM - FRs/NFRs only)
|
||||
→ Phase 4 (Implementation)
|
||||
```
|
||||
|
||||
**Note on TEA (Test Architect):** TEA is fully operational with 8 workflows across all phases. TEA validates architecture testability during Phase 3 reviews but does not have a dedicated solutioning workflow. TEA's primary setup occurs in Phase 2 (`*framework`, `*ci`, `*test-design`) and testing execution in Phase 4 (`*atdd`, `*automate`, `*test-review`, `*trace`, `*nfr-assess`).
|
||||
**Note on TEA (Test Architect):** TEA is fully operational with 8 workflows across all phases. TEA validates architecture testability during Phase 3 reviews but does not have a dedicated solutioning workflow. TEA's primary setup occurs after architecture in Phase 3 (`*framework`, `*ci`, system-level `*test-design`), with optional Phase 2 baseline `*trace`. Testing execution happens in Phase 4 (`*atdd`, `*automate`, `*test-review`, `*trace`, `*nfr-assess`).
|
||||
|
||||
**Note:** Enterprise uses the same planning and architecture as BMad Method. The only difference is optional extended workflows added AFTER architecture but BEFORE create-epics-and-stories.
|
||||
|
||||
@@ -434,7 +434,7 @@ Architecture documents are living. Update them as you learn during implementatio
|
||||
|
||||
**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method.
|
||||
|
||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration.
|
||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](../../../../docs/modules/bmm-bmad-method/test-architecture.md) for TEA's full lifecycle integration.
|
||||
|
||||
---
|
||||
|
||||
@@ -471,10 +471,10 @@ Architecture documents are living. Update them as you learn during implementatio
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase
|
||||
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Previous phase
|
||||
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md) - Next phase
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
@@ -17,8 +17,6 @@ CIS provides structured creative methodologies through distinctive agent persona
|
||||
|
||||
## Specialized Agents
|
||||
|
||||
[View detailed agent descriptions →](./agents/README.md)
|
||||
|
||||
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
||||
- **Maya** - Design Thinking Maestro (jazz-like improviser)
|
||||
- **Dr. Quinn** - Problem Solver (detective-scientist hybrid)
|
||||
@@ -27,7 +25,7 @@ CIS provides structured creative methodologies through distinctive agent persona
|
||||
|
||||
## Interactive Workflows
|
||||
|
||||
[View all workflows →](./workflows/README.md)
|
||||
[View all workflows →](../workflows/README.md)
|
||||
|
||||
**5 Workflows** with **150+ Creative Techniques:**
|
||||
|
||||
@@ -103,7 +101,7 @@ agent cis/brainstorming-coach
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `/{bmad_folder}/cis/config.yaml`:
|
||||
Edit `/_bmad/cis/config.yaml`:
|
||||
|
||||
```yaml
|
||||
output_folder: ./creative-outputs
|
||||
@@ -144,9 +142,7 @@ CIS workflows integrate with:
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Workflow Guide](./workflows/README.md)** - Detailed workflow instructions
|
||||
- **[Agent Personas](./agents/README.md)** - Full agent descriptions
|
||||
- **[BMM Integration](../bmm/README.md)** - Development workflow connection
|
||||
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
||||
|
||||
---
|
||||
|
||||
105
docs/modules/core/advanced-elicitation.md
Normal file
105
docs/modules/core/advanced-elicitation.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# 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 |
|
||||
100
docs/modules/core/brainstorming.md
Normal file
100
docs/modules/core/brainstorming.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# 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.
|
||||
64
docs/modules/core/core-tasks.md
Normal file
64
docs/modules/core/core-tasks.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Core Tasks
|
||||
|
||||
Core Tasks are reusable task definitions that can be invoked by any BMAD module, workflow, or agent. These tasks provide standardized functionality for common operations.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Index Docs](#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](#shard-document) — Split large documents into sections
|
||||
|
||||
---
|
||||
|
||||
## Index Docs
|
||||
|
||||
**Generates or updates an index.md file documenting all documents in a specified directory.**
|
||||
|
||||
This task scans a target directory, reads file contents to understand their purpose, and creates a well-organized index with accurate descriptions. Files are grouped by type, purpose, or subdirectory, and descriptions are generated from actual content rather than guessing from filenames.
|
||||
|
||||
**Use it when:** You need to create navigable documentation for a folder of markdown files, or 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 based on actual content
|
||||
4. Create or update index.md with organized listings using relative paths
|
||||
|
||||
**Output format:** A markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
||||
|
||||
---
|
||||
|
||||
## Adversarial Review (General)
|
||||
|
||||
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
||||
|
||||
This task applies adversarial thinking to content review—approaching the material with the assumption that problems exist. It's designed to find what's missing, not just what's wrong, and produces at least ten specific findings. The reviewer adopts a professional but skeptical tone, looking for gaps, inconsistencies, oversights, and areas that need clarification.
|
||||
|
||||
**Use it when:** You need a critical eye on code diffs, specifications, user stories, documentation, or any artifact before finalizing. It's particularly valuable before merging code, releasing documentation, or considering a specification complete.
|
||||
|
||||
**How it works:**
|
||||
1. Load the content to review (diff, branch, uncommitted changes, document, etc.)
|
||||
2. Perform adversarial analysis with extreme skepticism—assume problems exist
|
||||
3. Find at least ten issues to fix or improve
|
||||
4. Output findings as a markdown list
|
||||
|
||||
**Note:** This task is designed to run in a separate subagent/process with read access to the project but no prior context, ensuring an unbiased review.
|
||||
|
||||
---
|
||||
|
||||
## Shard Document
|
||||
|
||||
**Splits large markdown documents into smaller, organized files based on level 2 (##) sections.**
|
||||
|
||||
Uses the `@kayvan/markdown-tree-parser` tool to automatically break down large documents into a folder structure. Each level 2 heading becomes a separate file, and an index.md is generated to tie everything together. This makes large documents more maintainable and allows for easier navigation and updates to individual sections.
|
||||
|
||||
**Use it when:** A markdown file has grown too large to effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently.
|
||||
|
||||
**How it works:**
|
||||
1. Confirm source document path and verify it's a markdown file
|
||||
2. Determine destination folder (defaults to same location as source, folder named after document)
|
||||
3. Execute the sharding command using npx @kayvan/markdown-tree-parser
|
||||
4. Verify output files and index.md were created
|
||||
5. Handle the original document—delete, move to archive, or keep with warning
|
||||
|
||||
**Handling the original:** After sharding, the task prompts you to delete, archive, or keep the original document. Deleting or archiving is recommended to avoid confusion and ensure updates happen in the sharded files only.
|
||||
30
docs/modules/core/core-workflows.md
Normal file
30
docs/modules/core/core-workflows.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Core Workflows
|
||||
|
||||
Core Workflows are domain-agnostic workflows that can be utilized by any BMAD-compliant module, workflow, or agent. These workflows are installed by default and available at any time.
|
||||
|
||||
## Available Core Workflows
|
||||
|
||||
### [Party Mode](party-mode.md)
|
||||
|
||||
Orchestrate dynamic multi-agent conversations with your entire BMAD team. Engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
### [Brainstorming](brainstorming.md)
|
||||
|
||||
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 that are already within you.
|
||||
|
||||
### [Advanced Elicitation](advanced-elicitation.md)
|
||||
|
||||
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, essentially "LLM brainstorming" to find better approaches and uncover improvements.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Core Workflows are designed to be invoked and configured by other modules. When called from another workflow, they accept contextual parameters to customize the session:
|
||||
|
||||
- **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
|
||||
|
||||
This allows modules to leverage these workflows' capabilities while maintaining focus on their specific domain and objectives.
|
||||
133
docs/modules/core/document-sharding-guide.md
Normal file
133
docs/modules/core/document-sharding-guide.md
Normal file
@@ -0,0 +1,133 @@
|
||||
# Document Sharding Guide
|
||||
|
||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Document Sharding Guide](#document-sharding-guide)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [What is Document Sharding?](#what-is-document-sharding)
|
||||
- [Architecture](#architecture)
|
||||
- [When to Use Sharding](#when-to-use-sharding)
|
||||
- [Ideal Candidates](#ideal-candidates)
|
||||
- [How Sharding Works](#how-sharding-works)
|
||||
- [Sharding Process](#sharding-process)
|
||||
- [Workflow Discovery](#workflow-discovery)
|
||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
||||
- [CLI Command](#cli-command)
|
||||
- [Interactive Process](#interactive-process)
|
||||
- [What Gets Created](#what-gets-created)
|
||||
- [Workflow Support](#workflow-support)
|
||||
- [Universal Support](#universal-support)
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
||||
|
||||
- **Selective Loading** - Workflows load only the sections they need
|
||||
- **Reduced Token Usage** - Massive efficiency gains for large projects
|
||||
- **Better Organization** - Logical section-based file structure
|
||||
- **Maintained Context** - Index file preserves document structure
|
||||
|
||||
### Architecture
|
||||
|
||||
```
|
||||
Before Sharding:
|
||||
docs/
|
||||
└── PRD.md (large 50k token file)
|
||||
|
||||
After Sharding:
|
||||
docs/
|
||||
└── prd/
|
||||
├── index.md # Table of contents with descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Additional sections
|
||||
```
|
||||
|
||||
## When to Use Sharding
|
||||
|
||||
### Ideal Candidates
|
||||
|
||||
**Large Multi-Epic Projects:**
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
## How Sharding Works
|
||||
|
||||
### Sharding Process
|
||||
|
||||
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
|
||||
2. **Section Extraction**: Tool splits by level 2 headings
|
||||
3. **File Creation**: Each section becomes a separate file
|
||||
4. **Index Generation**: `index.md` created with structure and descriptions
|
||||
|
||||
### Workflow Discovery
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
||||
1. **Try whole document first** - Look for `document-name.md`
|
||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead.
|
||||
|
||||
## Using the Shard-Doc Tool
|
||||
|
||||
### CLI Command
|
||||
|
||||
```bash
|
||||
/bmad:core:tools:shard-doc
|
||||
```
|
||||
|
||||
### Interactive Process
|
||||
|
||||
```
|
||||
Agent: Which document would you like to shard?
|
||||
User: docs/PRD.md
|
||||
|
||||
Agent: Default destination: docs/prd/
|
||||
Accept default? [y/n]
|
||||
User: y
|
||||
|
||||
Agent: Sharding PRD.md...
|
||||
✓ Created 12 section files
|
||||
✓ Generated index.md
|
||||
✓ Complete!
|
||||
```
|
||||
|
||||
### What Gets Created
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
```markdown
|
||||
# PRD - Index
|
||||
|
||||
## Sections
|
||||
|
||||
1. [Overview](./overview.md) - Project vision and objectives
|
||||
2. [User Requirements](./user-requirements.md) - Feature specifications
|
||||
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
|
||||
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
|
||||
...
|
||||
```
|
||||
|
||||
**Individual section files:**
|
||||
|
||||
- Named from heading text (kebab-case)
|
||||
- Contains complete section content
|
||||
- Preserves all markdown formatting
|
||||
- Can be read independently
|
||||
|
||||
## Workflow Support
|
||||
|
||||
### Universal Support
|
||||
|
||||
**All BMM workflows support both formats:**
|
||||
|
||||
- ✅ Whole documents
|
||||
- ✅ Sharded documents
|
||||
- ✅ Automatic detection
|
||||
- ✅ Transparent to user
|
||||
11
docs/modules/core/global-core-config.md
Normal file
11
docs/modules/core/global-core-config.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Core Module Global Inheritable Config
|
||||
|
||||
The Core Modules module.yaml file defines configuration values that are useful and unique for all other modules to utilize, and by default all other modules installed will clone the values defined in the core module yaml.config into their own. It is possible for other modules to override these values, but the general intent it to accept the core module values and define their own values as needed, or extend the core values.
|
||||
|
||||
Currently, the core module.yaml config will define (asking the user upon installation, and recording to the core module config.yaml):
|
||||
- `user_name`: string (defaults to the system defined user name)
|
||||
- `communication_language`: string (defaults to english)
|
||||
- `document_output_language`: string (defaults to english)
|
||||
- `output_folder`: string (default `_bmad-output`)
|
||||
|
||||
An example of extending one of these values, in the BMad Method module.yaml it defines a planning_artifacts config, which will default to `default: "{output_folder}/planning-artifacts"` thus whatever the output_folder will be, this extended versions default will use the value from this core module and append a new folder onto it. The user can choose to replace this without utilizing the output_folder from the core if they so chose.
|
||||
15
docs/modules/core/index.md
Normal file
15
docs/modules/core/index.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# 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](global-core-config.md)** — Inheritable configuration that impacts all modules and custom content
|
||||
- **[Core Workflows](core-workflows.md)** — Domain-agnostic workflows usable by any module
|
||||
- [Party Mode](party-mode.md) — Multi-agent conversation orchestration
|
||||
- [Brainstorming](brainstorming.md) — Structured creative sessions with 60+ techniques
|
||||
- [Advanced Elicitation](advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||
- **[Core Tasks](core-tasks.md)** — Common tasks available across modules
|
||||
- [Index Docs](core-tasks.md#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](core-tasks.md#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](core-tasks.md#shard-document) — Split large documents into sections
|
||||
50
docs/modules/core/party-mode.md
Normal file
50
docs/modules/core/party-mode.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Party Mode
|
||||
|
||||
**Orchestrate dynamic multi-agent conversations with your entire BMAD team.**
|
||||
|
||||
Party Mode brings together all your installed BMAD agents for collaborative discussions. Instead of working with a single agent, you can engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Exploring complex topics that would benefit from diverse expert perspectives
|
||||
- Brainstorming with agents who can build on each other's ideas
|
||||
- Getting a comprehensive view across multiple domains (technical, business, creative, strategic)
|
||||
- Enjoying dynamic, agent-to-agent conversations where experts challenge and complement each other
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. Party Mode loads your complete agent roster and introduces the available team members
|
||||
2. You present a topic or question
|
||||
3. The facilitator intelligently selects 2-3 most relevant agents based on expertise needed
|
||||
4. Agents respond in character, can reference each other, and engage in natural cross-talk
|
||||
5. The conversation continues until you choose to exit
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Intelligent agent selection** — The system analyzes your topic and selects the most relevant agents based on their expertise, capabilities, and principles
|
||||
- **Authentic personalities** — Each agent maintains their unique voice, communication style, and domain knowledge throughout the conversation
|
||||
- **Natural cross-talk** — Agents can reference each other, build on previous points, ask questions, and even respectfully disagree
|
||||
- **Optional TTS integration** — Each agent response can be read aloud with voice configurations matching their personalities
|
||||
- **Graceful exit** — Sessions conclude with personalized farewells from participating agents
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Party Mode 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** | Prebias the discussion toward a specific domain or question |
|
||||
| **Additional personas** | Inject expert agents into the roster at runtime for specialized perspectives |
|
||||
| **Participation constraints** | Limit which agents can contribute based on relevance |
|
||||
|
||||
### Example
|
||||
|
||||
A medical module workflow could invoke Party Mode with expert doctor personas added to the roster, and the conversation pre-focused on a specific diagnosis or treatment decision. The agents would then discuss the medical case with appropriate domain expertise while maintaining their distinct personalities and perspectives.
|
||||
@@ -1,227 +0,0 @@
|
||||
# BMad v4 to v6 Upgrade Guide
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
|
||||
---
|
||||
|
||||
## Automatic V4 Detection
|
||||
|
||||
When you run `npm run install:bmad` on a project with v4 installed, the installer automatically detects:
|
||||
|
||||
- **Legacy folders**: Any folders starting with `.bmad`, `bmad` (lowercase), or `Bmad`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Backup of v4 Modules**: All `.bmad-*` folders are moved to `v4-backup/` in your project root
|
||||
- If a backup already exists, a timestamp is added to avoid conflicts
|
||||
- Example: `.bmad-core` → `v4-backup/.bmad-core`
|
||||
- Your project files and data are NOT affected
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders: `.claude/commands/`, `.cursor/commands/`, etc.
|
||||
- These old commands would still reference v4 folder structure if left in place
|
||||
- The installer provides copy/paste terminal commands for your platform
|
||||
- You can proceed without cleanup, but removing them prevents confusion with old v4 commands
|
||||
|
||||
---
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ------------------------------------------------ |
|
||||
| `.bmad-2d-phaser-game-dev` | Integrated into BMM |
|
||||
| `.bmad-2d-unity-game-dev` | Integrated into BMM |
|
||||
| `.bmad-godot-game-dev` | Integrated into BMM |
|
||||
| `.bmad-*-game-dev` (any) | Integrated into BMM |
|
||||
| `.bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM |
|
||||
| `.bmad-creative-writing` | Not adapted - New module releasing soon |
|
||||
|
||||
**Game Development**: All game development functionality has been consolidated and expanded within the BMM (BMad Method) module. Game-specific workflows now adapt to your game type and engine.
|
||||
|
||||
---
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
### Folder Structure
|
||||
|
||||
**v4 "Expansion Packs" Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .bmad-core/ # Was actually the BMad Method
|
||||
├── .bmad-game-dev/ # Separate expansion packs
|
||||
├── .bmad-creative-writing/
|
||||
└── .bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── {bmad_folder}/ # Single installation folder, default .bmad
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
└── _cfg/ # Your customizations
|
||||
└── agents/ # Agent customization files
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `.bmad-core`**: Was actually the BMad Method
|
||||
- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
|
||||
- **v6 `{bmad_folder}/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file
|
||||
|
||||
---
|
||||
|
||||
## Project Progress Migration
|
||||
|
||||
### If You've Completed Planning Phase (PRD/Architecture) with the BMad Method:
|
||||
|
||||
After running the v6 installer:
|
||||
|
||||
1. **Run `workflow-init`** workflow to set up the guided workflow system
|
||||
2. **Specify your project level** when prompted:
|
||||
- If you followed v4's full workflow (PRD → Architecture → Stories), select **Level 3 or 4**
|
||||
- This tells v6 you've already completed planning and solutioning phases
|
||||
3. **Document paths**: Keep your existing paths during installation
|
||||
- Default PRD/Architecture location: `docs/`
|
||||
- Default stories location: `docs/sprint-artifacts/`
|
||||
- **Accept these defaults** if you're already using them in v4
|
||||
|
||||
> **Important**: v6 workflows can handle both sharded and unsharded documents. You don't need to restructure your existing PRD or architecture files.
|
||||
|
||||
### If You're Mid-Development (Stories Created/Implemented)
|
||||
|
||||
1. Complete the v6 installation as above
|
||||
2. Run `workflow-init` and specify Level 3 or 4
|
||||
3. When ready to continue development, run the **`sprint-planning`** workflow (Phase 4)
|
||||
|
||||
---
|
||||
|
||||
## Agent Customization Migration
|
||||
|
||||
### v4 Agent Customization
|
||||
|
||||
In v4, you may have modified agent files directly in `.bmad-*` folders.
|
||||
|
||||
### v6 Agent Customization
|
||||
|
||||
**All customizations** now go in `{bmad_folder}/_cfg/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
persona:
|
||||
name: 'Captain Jack' # Override agent name
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors for software concepts
|
||||
- Always upbeat and adventurous
|
||||
```
|
||||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `{bmad_folder}/bmm/agents/pm.md`
|
||||
- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
|
||||
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
|
||||
|
||||
---
|
||||
|
||||
## Document Compatibility
|
||||
|
||||
### Sharded vs Unsharded Documents
|
||||
|
||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
||||
|
||||
- ✅ Sharded documents (split into multiple files)
|
||||
- ✅ Unsharded documents (single file per section)
|
||||
- ✅ Custom sections for your project type
|
||||
- ✅ Mixed approaches
|
||||
|
||||
All workflow files are scanned automatically. No manual configuration needed.
|
||||
|
||||
---
|
||||
|
||||
## Installation Steps
|
||||
|
||||
### 1. Clone Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmad-code-org/BMAD-METHOD
|
||||
cd BMAD-METHOD
|
||||
npm install
|
||||
```
|
||||
|
||||
### 2. Run Installer on Your v4 Project
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
**Enter the full path to your v4 project** when prompted.
|
||||
|
||||
### 3. Follow Interactive Prompts
|
||||
|
||||
The installer will:
|
||||
|
||||
1. Detect v4 installation and offer to backup `.bmad-*` folders
|
||||
2. Prompt for recommended cleanup (you can skip)
|
||||
3. Let you select modules (recommend: BMM for software and or game development)
|
||||
4. Configure core settings (name, language, etc.)
|
||||
5. Configure module-specific options
|
||||
6. Configure IDE integrations
|
||||
|
||||
### 4. Accept Default Paths
|
||||
|
||||
If you're using:
|
||||
|
||||
- `docs/` for PRD and architecture
|
||||
- `docs/sprint-artifacts/` for story files
|
||||
|
||||
**Accept these defaults** during installation.
|
||||
|
||||
### 5. Initialize Workflow
|
||||
|
||||
After installation:
|
||||
|
||||
1. **Load the Analyst agent** - See your IDE-specific instructions in [docs/ide-info](./ide-info/) for how to activate agents:
|
||||
- [Claude Code](./ide-info/claude-code.md)
|
||||
- [Cursor](./ide-info/cursor.md)
|
||||
- [VS Code/Windsurf](./ide-info/) - Check your IDE folder
|
||||
|
||||
2. **Wait for the agent's menu** to appear
|
||||
|
||||
3. **Tell the agent**: `*workflow-init` - v6 supports excellent natural language fuzzy matching, so you could also say "workflow init" or "please init the workflow"
|
||||
|
||||
Since you are migrating an existing project from v4, it's most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4.
|
||||
|
||||
---
|
||||
|
||||
## Post-Migration Checklist
|
||||
|
||||
- [ ] v4 folders backed up to `v4-backup/`
|
||||
- [ ] v6 installed to `{bmad_folder}/` folder
|
||||
- [ ] `workflow-init` run with correct project level selected
|
||||
- [ ] Agent customizations migrated to `{bmad_folder}/_cfg/agents/` if needed
|
||||
- [ ] IDE integration working (test by listing agents)
|
||||
- [ ] For active development: `sprint-planning` workflow executed
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
|
||||
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
- **Docs**: Check `{bmad_folder}/docs/` in your installation for IDE-specific instructions
|
||||
@@ -1,17 +0,0 @@
|
||||
# v6 Pending Items
|
||||
|
||||
Before calling this beta
|
||||
|
||||
- finalize web bundler
|
||||
- some subagents working again
|
||||
- knowledge base for bmad
|
||||
|
||||
## Needed Beta → v0 release
|
||||
|
||||
Aside from stability and bug fixes found during the alpha period - the main focus will be on the following:
|
||||
|
||||
- knowledge base for BMM
|
||||
- Module repository and submission process defined
|
||||
- MCP Injections based on installation selection
|
||||
- sub agent for open-code and claude code optimization
|
||||
- TDD Workflow Integration
|
||||
@@ -1,473 +0,0 @@
|
||||
# Using BMad Web Bundles in Gemini Gems & Custom GPTs
|
||||
|
||||
Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
||||
Web bundles are standalone XML files containing:
|
||||
|
||||
- Complete agent persona and instructions
|
||||
- All workflows and dependencies
|
||||
- Interactive menu system
|
||||
- Party mode for multi-agent collaboration
|
||||
- No external files required
|
||||
|
||||
**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally.
|
||||
|
||||
## Critical Setup Rules
|
||||
|
||||
**READ THIS FIRST - Following these rules ensures BMad works correctly in Gemini/GPT:**
|
||||
|
||||
1. **ONE file per Gem/GPT** - Upload exactly ONE XML file per Gemini Gem or Custom GPT instance. Do NOT combine multiple agent files.
|
||||
|
||||
2. **Use the setup instructions** - When creating your Gem/GPT, you MUST add the configuration prompt (shown in Quick Start below) so it knows how to read the XML file.
|
||||
|
||||
3. **Enable Canvas/Code Execution** - This is ESSENTIAL for document generation workflows (PRD, Architecture, etc.). Enable this in your Gem/GPT settings.
|
||||
|
||||
4. **Gemini Gems are strongly preferred** - They work significantly better than Custom GPTs for BMad workflows.
|
||||
|
||||
5. **Team bundles = Gemini 2.5 Pro+ only** - Team bundles (multiple agents) have terrible performance in Custom GPTs due to context limits. Only use them with Gemini 2.5 Pro or higher.
|
||||
|
||||
6. **Create separate Gems for each agent** - Make a PM Gem, an Architect Gem, a Developer Gem, etc. Don't try to combine them (except via official team bundles).
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Get Web Bundle Files
|
||||
|
||||
**Option A: Download Pre-Bundled Files (Quickest)**
|
||||
|
||||
Download ready-to-use bundles that are automatically updated whenever commits are merged to main:
|
||||
|
||||
**[→ Download Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)**
|
||||
|
||||
Navigate to the module folder (bmm, bmb, cis, bmgd) → agents folder → download the `.xml` file you need. These bundles are automatically regenerated and deployed with every commit to the main branch, ensuring you always have the latest version.
|
||||
|
||||
**Option B: Generate from Local Installation**
|
||||
|
||||
From your BMad project directory:
|
||||
|
||||
```bash
|
||||
# Generate all agent bundles
|
||||
npm run bundle
|
||||
|
||||
# Or generate specific bundles
|
||||
node tools/cli/bundlers/bundle-web.js module bmm
|
||||
node tools/cli/bundlers/bundle-web.js agent bmm dev
|
||||
```
|
||||
|
||||
**Output location:** `web-bundles/` directory
|
||||
|
||||
```
|
||||
web-bundles/
|
||||
├── bmm/
|
||||
│ ├── agents/ # Individual agents
|
||||
│ └── teams/ # Multi-agent teams
|
||||
├── bmb/
|
||||
├── cis/
|
||||
└── bmgd/
|
||||
```
|
||||
|
||||
### 2. Upload to Gemini Gems (Recommended)
|
||||
|
||||
**IMPORTANT: Create ONE Gem per agent file. Do NOT upload multiple agent files to a single Gem.**
|
||||
|
||||
**Create a Gem:**
|
||||
|
||||
1. Go to [Google AI Studio](https://aistudio.google.com/)
|
||||
2. Click "New Gem" or "Create Gem"
|
||||
3. Give your Gem a name (e.g., "BMad PM Agent")
|
||||
4. **Enable "Code execution" for best results with document generation**
|
||||
5. In the **System Instructions** field, add this EXACT text (customize the config values):
|
||||
|
||||
```
|
||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
||||
|
||||
CONFIG.YAML Values:
|
||||
- user_name: [Your Name]
|
||||
- communication_language: English
|
||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
||||
- document_output_language: English
|
||||
- bmm-workflow-status: standalone (no workflow)
|
||||
```
|
||||
|
||||
6. **Upload ONE XML file** (e.g., `pm.xml`) - either attach as a file or paste contents
|
||||
7. Save and test your Gem by typing `*help` to see the menu
|
||||
|
||||
**Tips for Gemini:**
|
||||
|
||||
- **Enable Code Execution/Canvas** - Critical for document output (PRDs, architecture docs, etc.)
|
||||
- **Use Gemini 2.5 Pro+** for best results, especially for complex workflows
|
||||
- **One agent per Gem** - Create separate Gems for PM, Architect, Developer, etc.
|
||||
- Test the agent by triggering menu items with `*workflow-name`
|
||||
|
||||
### 3. Upload to Custom GPTs
|
||||
|
||||
**IMPORTANT: Create ONE Custom GPT per agent file. Do NOT upload multiple agent files to a single GPT.**
|
||||
|
||||
**Create a Custom GPT:**
|
||||
|
||||
1. Go to [ChatGPT](https://chat.openai.com/)
|
||||
2. Click your profile → "My GPTs" → "Create a GPT"
|
||||
3. Configure your GPT:
|
||||
- **Name:** BMad PM Agent (or your choice)
|
||||
- **Description:** AI planning agent powered by BMad Method
|
||||
4. In the **Instructions** field, add this EXACT text at the top (customize the config values):
|
||||
|
||||
```
|
||||
All of your operating instructions and resources are contained in the XML file attached. Read in the initial agent block and instructions to understand it. You will not deviate from the character and rules outlined in the attached!
|
||||
|
||||
CONFIG.YAML Values:
|
||||
- user_name: [Your Name]
|
||||
- communication_language: English
|
||||
- user_skill_level: [Beginner|Intermediate|Expert]
|
||||
- document_output_language: English
|
||||
- bmm-workflow-status: standalone (no workflow)
|
||||
```
|
||||
|
||||
5. **Below that text**, paste the entire contents of ONE XML file (e.g., `pm.xml`)
|
||||
6. **Enable "Canvas" in ChatGPT settings** for better document output
|
||||
7. Save and test by typing `*help`
|
||||
|
||||
**Tips for Custom GPTs:**
|
||||
|
||||
- **Enable Canvas** - Essential for workflow document generation
|
||||
- **One agent per GPT** - Create separate GPTs for each agent
|
||||
- Custom GPTs have smaller context windows than Gemini - avoid team bundles
|
||||
- Works best with focused agents (PM, Analyst, Architect)
|
||||
|
||||
## Available Web Bundles
|
||||
|
||||
After running `npm run bundle`, you'll have access to:
|
||||
|
||||
### BMad Method (BMM) Agents
|
||||
|
||||
- **analyst.xml** - Business analysis and requirements gathering
|
||||
- **architect.xml** - System architecture and technical design
|
||||
- **dev.xml** - Full-stack development and implementation
|
||||
- **pm.xml** - Product management and planning
|
||||
- **sm.xml** - Scrum master and agile facilitation
|
||||
- **tea.xml** - Test architecture and quality assurance
|
||||
- **tech-writer.xml** - Technical documentation
|
||||
- **ux-designer.xml** - User experience design
|
||||
- **game-designer.xml** - Game design and mechanics
|
||||
- **game-dev.xml** - Game development
|
||||
- **game-architect.xml** - Game architecture
|
||||
|
||||
### BMad Builder (BMB) Agent
|
||||
|
||||
- **bmad-builder.xml** - Create custom agents, workflows, and modules
|
||||
|
||||
### Creative Intelligence Suite (CIS) Agents
|
||||
|
||||
- **brainstorming-coach.xml** - Creative brainstorming facilitation
|
||||
- **design-thinking-coach.xml** - Human-centered problem solving
|
||||
- **innovation-strategist.xml** - Innovation and strategy
|
||||
- **creative-problem-solver.xml** - Breakthrough problem solving
|
||||
- **storyteller.xml** - Narrative and storytelling
|
||||
|
||||
### Team Bundles (Multi-Agent Collaboration)
|
||||
|
||||
**CRITICAL: Team bundles are ONLY recommended for Gemini 2.5 Pro+ in the web. The experience is poor with Custom GPTs due to limited context windows.**
|
||||
|
||||
- **bmm/teams/team-fullstack.xml** - Full BMad Method development team
|
||||
- **bmgd/teams/team-gamedev.xml** - Game development team
|
||||
- **cis/teams/creative-squad.xml** - Creative Intelligence team
|
||||
|
||||
**When to use team bundles:**
|
||||
|
||||
- You want multiple agents collaborating in one Gem
|
||||
- You're using Gemini 2.5 Pro+ (required)
|
||||
- You need diverse perspectives on complex problems
|
||||
|
||||
**When to use individual agents instead:**
|
||||
|
||||
- Using Custom GPTs (always use individual agents)
|
||||
- Want focused expertise from a single agent
|
||||
- Need faster, more streamlined interactions
|
||||
|
||||
## Recommended Workflow: Web Planning → Local Implementation
|
||||
|
||||
**Save significant costs** by doing planning phases in web bundles, then switching to local IDE for implementation.
|
||||
|
||||
### Cost-Saving Strategy
|
||||
|
||||
**Phase 1-3: Do in Web (Major Cost Savings)**
|
||||
|
||||
Use Gemini Gems or Custom GPTs for these workflows:
|
||||
|
||||
1. **Analysis Phase** (Analyst, PM)
|
||||
- `*brainstorm-project` - Brainstorm ideas and features
|
||||
- `*research` - Market and technical research
|
||||
- `*product-brief` - Create product vision
|
||||
|
||||
2. **Planning Phase** (PM)
|
||||
- `*prd` - Generate comprehensive Product Requirements Document
|
||||
- `*create-epics-and-stories` - Break down into development stories
|
||||
|
||||
3. **Solutioning Phase** (Architect, UX Designer)
|
||||
- `*architecture` - Define technical architecture
|
||||
- `*create-ux-design` - Design user experience
|
||||
|
||||
**Export Artifacts:**
|
||||
After each workflow, copy/download the generated documents (PRD, Architecture, UX Design, etc.)
|
||||
|
||||
**Phase 4: Switch to Local IDE (Required for Implementation)**
|
||||
|
||||
1. Save exported artifacts to your project's `docs/` folder
|
||||
2. Run local BMad installation with `*workflow-init`
|
||||
3. BMad will detect the existing artifacts and update workflow status
|
||||
4. Proceed with implementation using Developer agent locally
|
||||
|
||||
**Why this works:**
|
||||
|
||||
- **Planning workflows** are token-heavy but don't need code context
|
||||
- **Web models (Gemini/GPT)** handle planning excellently at lower cost
|
||||
- **Local IDE implementation** needs full codebase access and tools
|
||||
- **Best of both worlds**: Cost savings + full implementation capabilities
|
||||
|
||||
**Typical savings:** 60-80% cost reduction by doing analysis, planning, and architecture in web before moving to local implementation.
|
||||
|
||||
## Using Web Bundles
|
||||
|
||||
### Basic Usage
|
||||
|
||||
**1. Load the Agent**
|
||||
|
||||
Upload or paste the XML file into Gemini/GPT. The agent will introduce itself and show its menu.
|
||||
|
||||
**2. Choose a Workflow**
|
||||
|
||||
Use natural language or shortcuts:
|
||||
|
||||
```
|
||||
"Run the PRD workflow"
|
||||
*prd
|
||||
|
||||
"Start brainstorming"
|
||||
*brainstorm-project
|
||||
|
||||
"Show me the menu"
|
||||
*help
|
||||
```
|
||||
|
||||
**3. Follow the Workflow**
|
||||
|
||||
The agent guides you through the workflow step-by-step, asking questions and creating deliverables.
|
||||
|
||||
### Advanced Features
|
||||
|
||||
**Party Mode**
|
||||
|
||||
All web bundles include party mode for multi-agent collaboration:
|
||||
|
||||
```
|
||||
*party
|
||||
```
|
||||
|
||||
This activates multiple agents who collaborate on your task, providing diverse perspectives.
|
||||
|
||||
**Context Loading**
|
||||
|
||||
Some workflows load additional context:
|
||||
|
||||
```
|
||||
*workflow-init # Initialize project workflow
|
||||
*document-project # Analyze existing codebase
|
||||
```
|
||||
|
||||
**Dynamic Menus**
|
||||
|
||||
Agents adapt their menus based on project phase and available workflows.
|
||||
|
||||
## Platform Differences
|
||||
|
||||
### Gemini Gems (Strongly Recommended)
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Better XML parsing and handling
|
||||
- Handles large bundles well
|
||||
- Supports complex workflows
|
||||
- Larger context window (better for team bundles)
|
||||
- Code execution for document generation
|
||||
- Works excellently with BMad workflows
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Requires Google account
|
||||
- May have rate limits on free tier
|
||||
|
||||
**Best for:**
|
||||
|
||||
- All individual agents (PM, Architect, Developer, UX Designer, etc.)
|
||||
- Team bundles (requires Gemini 2.5 Pro+)
|
||||
- Complex multi-step workflows
|
||||
- Document-heavy workflows (PRD, Architecture)
|
||||
|
||||
**Recommended Model:** Gemini 2.5 Pro or higher
|
||||
|
||||
### Custom GPTs
|
||||
|
||||
**Pros:**
|
||||
|
||||
- Familiar ChatGPT interface
|
||||
- Good for conversational workflows
|
||||
- Easy sharing with team via link
|
||||
|
||||
**Cons:**
|
||||
|
||||
- Smaller context window than Gemini
|
||||
- Character limit on instructions (large bundles may not fit)
|
||||
- **NOT recommended for team bundles**
|
||||
- Canvas feature less mature than Gemini's code execution
|
||||
|
||||
**Best for:**
|
||||
|
||||
- Individual focused agents (PM, Analyst, Architect)
|
||||
- Creative agents (CIS)
|
||||
- Simpler workflows (product-brief, brainstorm-project)
|
||||
- Quick prototyping
|
||||
|
||||
**NOT recommended for:** Team bundles, Developer agent, complex technical workflows
|
||||
|
||||
## Customization
|
||||
|
||||
**Before Bundling:**
|
||||
|
||||
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
|
||||
|
||||
1. Edit `{bmad_folder}/_cfg/agents/<agent>.customize.yaml`
|
||||
2. Rebuild: `npx bmad-method build <agent-name>`
|
||||
3. Generate bundles: `npm run bundle`
|
||||
|
||||
Your customizations will be included in the web bundles.
|
||||
|
||||
**After Bundling:**
|
||||
|
||||
You can manually edit the XML to:
|
||||
|
||||
- Change agent name (search for `<name>`)
|
||||
- Modify persona (search for `<persona>`)
|
||||
- Add custom instructions (in `<critical>` blocks)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Agent not responding correctly?**
|
||||
|
||||
- Check that the entire XML file was uploaded
|
||||
- Verify no truncation occurred (Gemini/GPT have character limits)
|
||||
- Try a simpler agent first (analyst, pm)
|
||||
|
||||
**Menu items not working?**
|
||||
|
||||
- Use the `*` prefix for shortcuts: `*prd` not `prd`
|
||||
- Or use natural language: "Run the PRD workflow"
|
||||
- Check the agent's menu with `*help`
|
||||
|
||||
**Workflows failing?**
|
||||
|
||||
- Some workflows expect project files (not available in web context)
|
||||
- Use workflows designed for planning/analysis in web bundles
|
||||
- For implementation workflows, use local IDE installation
|
||||
|
||||
**File too large for GPT?**
|
||||
|
||||
- Split into sections and use multiple GPTs
|
||||
- Use Gemini Gems instead (better for large files)
|
||||
- Generate single-agent bundles instead of team bundles
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **One File Per Gem/GPT** - Always upload only ONE XML file per Gemini Gem or Custom GPT instance
|
||||
2. **Prefer Gemini Over GPT** - Gemini Gems work significantly better with BMad bundles
|
||||
3. **Enable Canvas/Code Execution** - Essential for document generation workflows (PRD, Architecture, etc.)
|
||||
4. **Create Separate Gems for Each Agent** - Don't try to combine agents except via team bundles
|
||||
5. **Team Bundles = Gemini 2.5 Pro+ Only** - Never use team bundles with Custom GPTs
|
||||
6. **Use for Planning Phases** - Web bundles excel at analysis, planning, and architecture (Phases 1-3)
|
||||
7. **Switch to Local for Implementation** - Use local IDE installation for Phase 4 development
|
||||
8. **Export and Save Artifacts** - Copy generated documents to your project's `docs/` folder
|
||||
9. **Run workflow-init Locally** - After importing web artifacts, initialize local workflow status
|
||||
10. **Keep Updated** - Rebuild bundles after BMad updates to get latest improvements
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Complete Web → Local Workflow (Recommended)
|
||||
|
||||
**Goal:** Build a new SaaS product with maximum cost savings
|
||||
|
||||
**Phase 1-3: Web Planning (Gemini Gems)**
|
||||
|
||||
1. **Download bundles:**
|
||||
- `bmm/agents/analyst.xml`
|
||||
- `bmm/agents/pm.xml`
|
||||
- `bmm/agents/architect.xml`
|
||||
- `bmm/agents/ux-designer.xml`
|
||||
|
||||
2. **Create 4 separate Gemini Gems** (one per agent, enable Code Execution)
|
||||
|
||||
3. **Analysis (Analyst Gem):**
|
||||
- Run: `*brainstorm-project` → Generate ideas
|
||||
- Run: `*research` → Market analysis
|
||||
- Export: Save research findings
|
||||
|
||||
4. **Planning (PM Gem):**
|
||||
- Share research findings
|
||||
- Run: `*product-brief` → Product vision
|
||||
- Run: `*prd` → Full requirements document
|
||||
- Export: Save PRD to `docs/prd.md`
|
||||
|
||||
5. **UX Design (UX Designer Gem):**
|
||||
- Share PRD
|
||||
- Run: `*create-ux-design` → UX specifications
|
||||
- Export: Save UX design to `docs/ux-design.md`
|
||||
|
||||
6. **Architecture (Architect Gem):**
|
||||
- Share PRD and UX Design
|
||||
- Run: `*architecture` → Technical architecture
|
||||
- Export: Save to `docs/architecture.md`
|
||||
|
||||
**Phase 4: Local Implementation**
|
||||
|
||||
7. **Setup local BMad:**
|
||||
- Install BMad locally: `npx bmad-method@alpha install`
|
||||
- Place exported docs in project `docs/` folder
|
||||
- Load Developer agent
|
||||
- Run: `*workflow-init` → BMad detects artifacts, suggests next steps
|
||||
|
||||
8. **Implement:**
|
||||
- Run: `*sprint-planning` → Set up sprint
|
||||
- Run: `*dev-story` → Implement features
|
||||
- Use full IDE capabilities with codebase access
|
||||
|
||||
**Cost Savings:** 60-80% by doing planning in Gemini before local implementation
|
||||
|
||||
### Example 2: Quick Brainstorming Session
|
||||
|
||||
1. Download `cis/agents/brainstorming-coach.xml`
|
||||
2. Create Gemini Gem with Code Execution enabled
|
||||
3. Run: `*brainstorming`
|
||||
4. Choose technique (e.g., SCAMPER, Mind Mapping)
|
||||
5. Generate and refine ideas
|
||||
6. Export results for team review
|
||||
|
||||
### Example 3: Architecture Review
|
||||
|
||||
1. Download `bmm/agents/architect.xml`
|
||||
2. Create Gemini Gem (enable Code Execution)
|
||||
3. Paste existing PRD into conversation
|
||||
4. Run: `*architecture`
|
||||
5. Collaborate on technical decisions
|
||||
6. Export architecture document to `docs/architecture.md`
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Agent Customization Guide](./agent-customization-guide.md)** - Customize before bundling
|
||||
- **[BMM Documentation](../src/modules/bmm/docs/README.md)** - Learn all workflows
|
||||
- **[Web Bundler Technical Docs](./installers-bundlers/web-bundler-usage.md)** - Advanced bundling options
|
||||
- **[Contributing Guide](../CONTRIBUTING.md)** - Help improve web bundles
|
||||
|
||||
## Resources
|
||||
|
||||
- **[Google AI Studio](https://aistudio.google.com/)** - Create Gemini Gems
|
||||
- **[Custom GPTs](https://chat.openai.com/gpts)** - Build Custom GPTs
|
||||
- **[BMad Discord](https://discord.gg/gk8jAdXWmj)** - Get help and share your Gems/GPTs
|
||||
@@ -16,8 +16,12 @@ export default [
|
||||
'test/template-test-generator/**/*.md',
|
||||
'test/fixtures/**',
|
||||
'test/fixtures/**/*.yaml',
|
||||
'.bmad/**',
|
||||
'.bmad*/**',
|
||||
'_bmad/**',
|
||||
'_bmad*/**',
|
||||
// Docusaurus build artifacts
|
||||
'.docusaurus/**',
|
||||
'build/**',
|
||||
'website/**',
|
||||
// Gitignored patterns
|
||||
'z*/**', // z-samples, z1, z2, etc.
|
||||
'.claude/**',
|
||||
@@ -77,9 +81,9 @@ export default [
|
||||
},
|
||||
},
|
||||
|
||||
// CLI/CommonJS scripts under tools/** and test/**
|
||||
// CLI scripts under tools/** and test/**
|
||||
{
|
||||
files: ['tools/**/*.js', 'test/**/*.js'],
|
||||
files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
|
||||
rules: {
|
||||
// Allow CommonJS patterns for Node CLI scripts
|
||||
'unicorn/prefer-module': 'off',
|
||||
@@ -106,6 +110,7 @@ export default [
|
||||
'no-useless-catch': 'off',
|
||||
'unicorn/prefer-number-properties': 'off',
|
||||
'no-unreachable': 'off',
|
||||
'unicorn/text-encoding-identifier-case': 'off',
|
||||
},
|
||||
},
|
||||
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
# Example Custom Content module
|
||||
|
||||
This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file,
|
||||
These items will be discovered by the installer and offered for installation.
|
||||
@@ -1,269 +0,0 @@
|
||||
---
|
||||
stepsCompleted: [1, 2, 3, 4, 5, 6, 7]
|
||||
---
|
||||
|
||||
## Build Summary
|
||||
|
||||
**Date:** 2025-12-04
|
||||
**Status:** Build Complete
|
||||
|
||||
### Files Generated
|
||||
|
||||
**Main Workflow:**
|
||||
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/workflow.md`
|
||||
|
||||
**Step Files (12 total):**
|
||||
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-01-init.md` - Game setup and mode selection
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-02-q1.md` - Question 1 (Level 1)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-03-q2.md` - Question 2 (Level 2)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-04-q3.md` - Question 3 (Level 3)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-05-q4.md` - Question 4 (Level 4)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-06-q5.md` - Question 5 (Level 5)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-07-q6.md` - Question 6 (Level 6)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-08-q7.md` - Question 7 (Level 7)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-09-q8.md` - Question 8 (Level 8)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-10-q9.md` - Question 9 (Level 9)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-11-q10.md` - Question 10 (Level 10)
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/steps/step-12-results.md` - Final results and celebration
|
||||
|
||||
**Templates:**
|
||||
|
||||
- `/Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master/templates/csv-headers.template` - CSV column headers
|
||||
|
||||
### Key Features Implemented
|
||||
|
||||
1. **Dual Game Modes:**
|
||||
- Mode 1: Sudden Death (game over on first wrong answer)
|
||||
- Mode 2: Marathon (complete all 10 questions)
|
||||
|
||||
2. **CSV History Tracking:**
|
||||
- 44 columns including DateTime, Category, GameMode, all questions/answers, FinalScore
|
||||
- Automatic CSV creation with headers
|
||||
- Real-time updates after each question
|
||||
|
||||
3. **Gameshow Persona:**
|
||||
- Energetic, dramatic host presentation
|
||||
- Progressive difficulty from Level 1-10
|
||||
- Immediate feedback and celebration
|
||||
|
||||
4. **Flow Control:**
|
||||
- Automatic CSV routing based on game mode
|
||||
- Play again or quit options at completion
|
||||
|
||||
### Next Steps for Testing
|
||||
|
||||
1. Run the workflow: `/bmad:bmb:workflows:quiz-master`
|
||||
2. Test both game modes
|
||||
3. Verify CSV file creation and updates
|
||||
4. Check question progression and difficulty
|
||||
5. Validate final score calculation
|
||||
|
||||
## Plan Review Summary
|
||||
|
||||
- **Plan reviewed by:** User
|
||||
- **Date:** 2025-12-04
|
||||
- **Status:** Approved without modifications
|
||||
- **Ready for design phase:** Yes
|
||||
- **Output Documents:** CSV history file (BMad-quiz-results.csv)
|
||||
|
||||
# Workflow Creation Plan: quiz-master
|
||||
|
||||
## Initial Project Context
|
||||
|
||||
- **Module:** stand-alone
|
||||
- **Target Location:** /Users/brianmadison/dev/BMAD-METHOD/.bmad/custom/src/workflows/quiz-master
|
||||
- **Created:** 2025-12-04
|
||||
|
||||
## Detailed Requirements
|
||||
|
||||
### 1. Workflow Purpose and Scope
|
||||
|
||||
- **Primary Goal:** Entertainment-based interactive trivia quiz
|
||||
- **Structure:** Always exactly 10 questions (1 per difficulty level 1-10)
|
||||
- **Format:** Multiple choice with 4 options (A, B, C, D)
|
||||
- **Progression:** Linear progression through all 10 levels regardless of correct/incorrect answers
|
||||
- **Scoring:** Track correct answers for final score
|
||||
|
||||
### 2. Workflow Type Classification
|
||||
|
||||
- **Type:** Interactive Workflow with Linear structure
|
||||
- **Interaction Style:** High interactivity with user input for each question
|
||||
- **Flow:** Step 1 (Init) → Step 2 (Quiz Questions) → Step 3 (Results) → Step 4 (History Save)
|
||||
|
||||
### 3. Workflow Flow and Step Structure
|
||||
|
||||
**Step 1 - Game Initialization:**
|
||||
|
||||
- Read user_name from config.yaml
|
||||
- Present suggested categories OR accept freeform category input
|
||||
- Create CSV file if not exists with proper headers
|
||||
- Start new row for current game session
|
||||
|
||||
**Step 2 - Quiz Game Loop:**
|
||||
|
||||
- Loop through 10 questions (levels 1-10)
|
||||
- Each question has 4 multiple-choice options
|
||||
- User enters A, B, C, or D
|
||||
- Provide immediate feedback on correctness
|
||||
- Continue to next level regardless of answer
|
||||
|
||||
**Step 3 - Results Display:**
|
||||
|
||||
- Show final score (e.g., "You got 7 out of 10!")
|
||||
- Provide entertaining commentary based on performance
|
||||
|
||||
**Step 4 - History Management:**
|
||||
|
||||
- Append complete game data to CSV
|
||||
- Columns: DateTime, Category, Q1-Question, Q1-Choices, Q1-UserAnswer, Q1-Correct, Q2-Question, ... Q10-Correct, FinalScore
|
||||
|
||||
### 4. User Interaction Style
|
||||
|
||||
- **Persona:** Over-the-top gameshow host (enthusiastic, dramatic, celebratory)
|
||||
- **Instruction Style:** Intent-based with gameshow flair
|
||||
- **Language:** Energetic, encouraging, theatrical
|
||||
- **Feedback:** Immediate, celebratory for correct, encouraging for incorrect
|
||||
|
||||
### 5. Input Requirements
|
||||
|
||||
- **From config:** user_name (BMad)
|
||||
- **From user:** Category selection (suggested list or freeform)
|
||||
- **From user:** 10 answers (A/B/C/D)
|
||||
|
||||
### 6. Output Specifications
|
||||
|
||||
- **Primary:** Interactive quiz experience with gameshow atmosphere
|
||||
- **Secondary:** CSV history file named: BMad-quiz-results.csv
|
||||
- **CSV Structure:**
|
||||
- Row per game session
|
||||
- Headers: DateTime, Category, Q1-Question, Q1-Choices, Q1-UserAnswer, Q1-Correct, ..., Q10-Correct, FinalScore
|
||||
|
||||
### 7. Success Criteria
|
||||
|
||||
- User completes all 10 questions
|
||||
- Gameshow atmosphere maintained throughout
|
||||
- CSV file properly created/updated
|
||||
- User receives final score with entertaining feedback
|
||||
- All question data and answers recorded accurately
|
||||
|
||||
### 8. Special Considerations
|
||||
|
||||
- Always assume fresh chat/new game
|
||||
- CSV file creation in Step 1 if missing
|
||||
- Freeform categories allowed (any topic)
|
||||
- No need to display previous history during game
|
||||
- Focus on entertainment over assessment
|
||||
- After user enters A/B/C/D, automatically continue to next question (no "Continue" prompts)
|
||||
- Streamlined experience without advanced elicitation or party mode tools
|
||||
|
||||
## Tools Configuration
|
||||
|
||||
### Core BMAD Tools
|
||||
|
||||
- **Party-Mode**: Excluded - Want streamlined quiz flow without interruptions
|
||||
- **Advanced Elicitation**: Excluded - Quiz format is straightforward without need for complex analysis
|
||||
- **Brainstorming**: Excluded - Categories can be suggested directly or entered freeform
|
||||
|
||||
### LLM Features
|
||||
|
||||
- **Web-Browsing**: Excluded - Quiz questions can be generated from existing knowledge
|
||||
- **File I/O**: Included - Essential for CSV history file management (reading/writing quiz results)
|
||||
- **Sub-Agents**: Excluded - Single gameshow host persona is sufficient
|
||||
- **Sub-Processes**: Excluded - Linear quiz flow doesn't require parallel processing
|
||||
|
||||
### Memory Systems
|
||||
|
||||
- **Sidecar File**: Excluded - Each quiz session is independent (always assume fresh chat)
|
||||
|
||||
### External Integrations
|
||||
|
||||
- None required for this workflow
|
||||
|
||||
### Installation Requirements
|
||||
|
||||
- None - All required tools (File I/O) are core features with no additional setup needed
|
||||
|
||||
## Workflow Design
|
||||
|
||||
### Step Structure
|
||||
|
||||
**Total Steps: 12**
|
||||
|
||||
1. Step 01 - Init: Mode selection, category choice, CSV setup
|
||||
2. Steps 02-11: Individual questions (1-10) with CSV updates
|
||||
3. Step 12 - Results: Final score display and celebration
|
||||
|
||||
### Game Modes
|
||||
|
||||
- **Mode 1 - Sudden Death**: Game over on first wrong answer
|
||||
- **Mode 2 - Marathon**: Continue through all 10 questions
|
||||
|
||||
### CSV Structure (44 columns)
|
||||
|
||||
Headers: DateTime,Category,GameMode,Q1-Question,Q1-Choices,Q1-UserAnswer,Q1-Correct,...,Q10-Correct,FinalScore
|
||||
|
||||
### Flow Logic
|
||||
|
||||
- Step 01: Create row with DateTime, Category, GameMode
|
||||
- Steps 02-11: Update CSV with question data
|
||||
- Mode 1: IF incorrect → jump to Step 12
|
||||
- Mode 2: Always continue
|
||||
- Step 12: Update FinalScore, display results
|
||||
|
||||
### Gameshow Persona
|
||||
|
||||
- Energetic, dramatic host
|
||||
- Celebratory feedback for correct answers
|
||||
- Encouraging messages for incorrect
|
||||
|
||||
### File Structure
|
||||
|
||||
```
|
||||
quiz-master/
|
||||
├── workflow.md
|
||||
├── steps/
|
||||
│ ├── step-01-init.md
|
||||
│ ├── step-02-q1.md
|
||||
│ ├── ...
|
||||
│ └── step-12-results.md
|
||||
└── templates/
|
||||
└── csv-headers.template
|
||||
```
|
||||
|
||||
## Output Format Design
|
||||
|
||||
**Format Type**: Strict Template
|
||||
|
||||
**Output Requirements**:
|
||||
|
||||
- Document type: CSV data file
|
||||
- File format: CSV (UTF-8 encoding)
|
||||
- Frequency: Append one row per quiz session
|
||||
|
||||
**Structure Specifications**:
|
||||
|
||||
- Exact 43 columns with specific headers
|
||||
- Headers: DateTime,Category,Q1-Question,Q1-Choices,Q1-UserAnswer,Q1-Correct,...,Q10-Correct,FinalScore
|
||||
- Data formats:
|
||||
- DateTime: ISO 8601 (YYYY-MM-DDTHH:MM:SS)
|
||||
- Category: Text
|
||||
- QX-Question: Text
|
||||
- QX-Choices: (A)Opt1|(B)Opt2|(C)Opt3|(D)Opt4
|
||||
- QX-UserAnswer: A/B/C/D
|
||||
- QX-Correct: TRUE/FALSE
|
||||
- FinalScore: Number (0-10)
|
||||
|
||||
**Template Information**:
|
||||
|
||||
- Template source: Created based on requirements
|
||||
- Template file: CSV with fixed column structure
|
||||
- Placeholders: None - strict format required
|
||||
|
||||
**Special Considerations**:
|
||||
|
||||
- CSV commas within text must be quoted
|
||||
- Newlines in questions replaced with spaces
|
||||
- Headers created only if file doesn't exist
|
||||
- Append mode for all subsequent quiz sessions
|
||||
@@ -1,4 +0,0 @@
|
||||
# EXAMPLE MODULE WARNING
|
||||
|
||||
This module is an example and is not at all recommended for any usage, this module was not vetted by any medical professionals and should
|
||||
be considered at best for entertainment purposes only.
|
||||
@@ -1,27 +0,0 @@
|
||||
# Mental Wellness Module Configuration
|
||||
# This file defines installation questions and module configuration values
|
||||
|
||||
code: mwm
|
||||
name: "MWM: Mental Wellness Module"
|
||||
default_selected: false
|
||||
|
||||
header: "MWM™: Custom Wellness Module"
|
||||
subheader: "Demo of Potential Non Coding Custom Module Use case"
|
||||
|
||||
# Variables from Core Config inserted:
|
||||
## user_name
|
||||
## communication_language
|
||||
## output_folder
|
||||
## bmad_folder
|
||||
## install_user_docs
|
||||
## kb_install
|
||||
|
||||
companion_name:
|
||||
prompt: "What would you like to call your mental wellness companion?"
|
||||
default: "Wellness Guide"
|
||||
result: "{value}"
|
||||
|
||||
journal_location:
|
||||
prompt: "Where should your wellness journal be saved?"
|
||||
default: "{output_folder}/mental-wellness"
|
||||
result: "{project-root}/{value}"
|
||||
@@ -1,47 +0,0 @@
|
||||
# CBT Coach - Cognitive Distortions Reference
|
||||
|
||||
## The 10 Cognitive Distortions
|
||||
|
||||
1. **All-or-Nothing Thinking**
|
||||
- Seeing things in black-and-white categories
|
||||
- Example: "If I'm not perfect, I'm a failure"
|
||||
|
||||
2. **Overgeneralization**
|
||||
- Seeing a single negative event as a never-ending pattern
|
||||
- Example: "I didn't get the job, so I'll never get hired"
|
||||
|
||||
3. **Mental Filter**
|
||||
- Dwell on negatives and ignore positives
|
||||
- Example: Focusing on one criticism in an otherwise good review
|
||||
|
||||
4. **Disqualifying the Positive**
|
||||
- Rejecting positive experiences as "don't count"
|
||||
- Example: "They were just being nice"
|
||||
|
||||
5. **Jumping to Conclusions**
|
||||
- Mind reading (assuming you know what others think)
|
||||
- Fortune telling (predicting the future negatively)
|
||||
|
||||
6. **Magnification/Minimization**
|
||||
- Exaggerating negatives or shrinking positives
|
||||
- Example: "Making a mistake feels catastrophic"
|
||||
|
||||
7. **Emotional Reasoning**
|
||||
- Believing something because it feels true
|
||||
- Example: "I feel anxious, so danger must be near"
|
||||
|
||||
8. **"Should" Statements**
|
||||
- Using "shoulds" to motivate
|
||||
- Example: "I should be more productive"
|
||||
|
||||
9. **Labeling**
|
||||
- Assigning global negative traits
|
||||
- Example: "I'm a loser" instead of "I made a mistake"
|
||||
|
||||
10. **Personalization**
|
||||
- Taking responsibility/blame for things outside your control
|
||||
- Example: "It's my fault the party wasn't fun"
|
||||
|
||||
## User's Common Patterns
|
||||
|
||||
_Track which distortions appear most frequently_
|
||||
@@ -1,17 +0,0 @@
|
||||
# CBT Coach - Thought Records
|
||||
|
||||
## Thought Record History
|
||||
|
||||
_CBT thought records are documented here for pattern tracking and progress review_
|
||||
|
||||
## Common Patterns Identified
|
||||
|
||||
_Recurring cognitive distortions and thought patterns_
|
||||
|
||||
## Successful Reframes
|
||||
|
||||
_Examples of successful cognitive restructuring_
|
||||
|
||||
## Homework Assignments
|
||||
|
||||
_CBT exercises and behavioral experiments_
|
||||
@@ -1,150 +0,0 @@
|
||||
agent:
|
||||
metadata:
|
||||
name: "Dr. Alexis, M.D."
|
||||
title: "CBT Coach"
|
||||
icon: "🧠"
|
||||
module: "mwm"
|
||||
hasSidecar: true
|
||||
persona:
|
||||
role: "Cognitive Behavioral Therapy specialist"
|
||||
identity: |
|
||||
A structured yet empathetic CBT practitioner who helps users identify and reframe negative thought patterns using evidence-based techniques. Skilled at making cognitive behavioral concepts accessible and practical for daily use. Balances clinical expertise with genuine care for user progress.
|
||||
communication_style: |
|
||||
Clear, structured, and educational. Uses simple language to explain CBT concepts. Asks targeted questions to guide insight. Provides concrete exercises and homework. Validates struggles while encouraging growth. Uses Socratic questioning to help users discover their own insights.
|
||||
principles:
|
||||
- "Thoughts are not facts - they can be examined and challenged"
|
||||
- "Behavior change follows cognitive change"
|
||||
- "Small, consistent practice creates lasting change"
|
||||
- "Self-compassion is essential for growth"
|
||||
- "Evidence over assumptions"
|
||||
|
||||
critical_actions:
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md and review previous CBT work"
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/cognitive-distortions.md and reference recognized patterns"
|
||||
- "Load COMPLETE file {agent_sidecar_folder}/cbt-coach-sidecar/progress.md and track user development"
|
||||
- "ONLY read/write files in {agent_sidecar_folder}/cbt-coach-sidecar/ - this is our CBT workspace"
|
||||
|
||||
prompts:
|
||||
- id: "thought-record"
|
||||
content: |
|
||||
<instructions>
|
||||
Guide user through completing a CBT thought record
|
||||
</instructions>
|
||||
|
||||
Let's work through a thought record together. This powerful tool helps us examine our thinking patterns.
|
||||
|
||||
**Step 1: Situation**
|
||||
What was happening when the upsetting feeling started? Be specific - time, place, who was there?
|
||||
|
||||
**Step 2: Automatic Thoughts**
|
||||
What thoughts went through your mind? List them exactly as they occurred.
|
||||
|
||||
**Step 3: Emotions**
|
||||
What emotions did you feel? Rate each from 0-100 in intensity.
|
||||
|
||||
**Step 4: Cognitive Distortions**
|
||||
Looking at your thoughts, which of these patterns might be present?
|
||||
- All-or-nothing thinking
|
||||
- Overgeneralization
|
||||
- Mental filter
|
||||
- Disqualifying the positive
|
||||
- Jumping to conclusions
|
||||
- Magnification/minimization
|
||||
- Emotional reasoning
|
||||
- "Should" statements
|
||||
- Labeling
|
||||
- Personalization
|
||||
|
||||
**Step 5: Alternative Thoughts**
|
||||
What's a more balanced or realistic way to view this situation?
|
||||
|
||||
**Step 6: Outcome**
|
||||
How do you feel now? Rate emotions again.
|
||||
|
||||
- id: "cognitive-reframing"
|
||||
content: |
|
||||
<instructions>
|
||||
Help user identify and challenge negative thought patterns
|
||||
</instructions>
|
||||
|
||||
Let's examine this thought pattern together.
|
||||
|
||||
First, identify the automatic thought: "I'll never be good enough at this"
|
||||
|
||||
Now, let's gather evidence:
|
||||
- What evidence supports this thought?
|
||||
- What evidence contradicts this thought?
|
||||
- What would you tell a friend with this thought?
|
||||
- What's a more balanced perspective?
|
||||
|
||||
Remember: We're looking for accuracy, not just positive thinking. Sometimes the balanced thought acknowledges real challenges while avoiding catastrophizing.
|
||||
|
||||
What feels most realistic and helpful to you now?
|
||||
|
||||
- id: "behavioral-experiment"
|
||||
content: |
|
||||
<instructions>
|
||||
Design a behavioral experiment to test a belief
|
||||
</instructions>
|
||||
|
||||
Let's design a small experiment to test your belief.
|
||||
|
||||
**The Belief:** "If I speak up in meetings, everyone will think I'm stupid"
|
||||
|
||||
**The Experiment:**
|
||||
1. What's a small step to test this? (e.g., share one brief comment)
|
||||
2. What do you predict will happen? (be specific)
|
||||
3. How can you collect real data? (observe reactions, ask for feedback)
|
||||
4. What would disprove your belief?
|
||||
5. What would partially support it?
|
||||
|
||||
Remember: We're scientists testing hypotheses, not trying to prove ourselves right. What would be most informative to learn?
|
||||
|
||||
menu:
|
||||
- multi: "[CH] Chat with Dr. Alexis or [SPM] Start Party Mode"
|
||||
triggers:
|
||||
- party-mode:
|
||||
- input: SPM or fuzzy match start party mode
|
||||
- route: "{project-root}/{bmad_folder}/core/workflows/edit-agent/workflow.md"
|
||||
- data: CBT coach agent discussion
|
||||
- type: exec
|
||||
- expert-chat:
|
||||
- input: CH or fuzzy match chat with dr alexis
|
||||
- action: agent responds as CBT coach
|
||||
- type: exec
|
||||
|
||||
- multi: "[TR] Thought Record [CF] Challenge Feeling"
|
||||
triggers:
|
||||
- thought-record:
|
||||
- input: TR or fuzzy match thought record
|
||||
- route: "{project-root}/{bmad_folder}/mwm/workflows/cbt-thought-record/workflow.md"
|
||||
- description: "Complete thought record 📝"
|
||||
- type: exec
|
||||
- challenge-feeling:
|
||||
- input: CF or fuzzy match challenge feeling
|
||||
- action: "#cognitive-reframing"
|
||||
- description: "Challenge thoughts 🔄"
|
||||
- type: exec
|
||||
|
||||
- multi: "[BE] Behavioral Experiment [CD] Cognitive Distortions"
|
||||
triggers:
|
||||
- behavior-experiment:
|
||||
- input: BE or fuzzy match behavioral experiment
|
||||
- action: "#behavioral-experiment"
|
||||
- description: "Test your beliefs 🧪"
|
||||
- type: exec
|
||||
- cognitive-distortions:
|
||||
- input: CD or fuzzy match cognitive distortions
|
||||
- action: "Review and explain the 10 common cognitive distortions with examples"
|
||||
- description: "Learn distortions 🎭"
|
||||
- type: exec
|
||||
|
||||
- trigger: "core-beliefs"
|
||||
action: "Guide exploration of core beliefs using downward arrow technique"
|
||||
description: "Explore core beliefs 💎"
|
||||
type: action
|
||||
|
||||
- trigger: "save-thought-work"
|
||||
action: "Save this thought work to {agent_sidecar_folder}/cbt-coach-sidecar/thought-records.md with date and patterns"
|
||||
description: "Save thought work 💾"
|
||||
type: action
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user