Compare commits
148 Commits
v6.0.0-alp
...
main
| Author | SHA1 | Date |
|---|---|---|
|
|
df176d4206 | |
|
|
2d9ebcaf2f | |
|
|
5b80649d3a | |
|
|
594235522c | |
|
|
7ecae1d000 | |
|
|
ba890779a2 | |
|
|
323cd75efd | |
|
|
b0c35d595f | |
|
|
0c46ef0be2 | |
|
|
79067a9427 | |
|
|
fa01b4929b | |
|
|
0bbb544521 | |
|
|
c3d1bf3fe8 | |
|
|
04e3dc8f75 | |
|
|
ef7abb7ca5 | |
|
|
981e5a49c2 | |
|
|
e17c7e8793 | |
|
|
1665ad68df | |
|
|
6af79165d8 | |
|
|
bdcd8afa42 | |
|
|
d45eff15bf | |
|
|
0a7329ff23 | |
|
|
7afe018f82 | |
|
|
8c59fb96a7 | |
|
|
7fcfd4c1b8 | |
|
|
53220420a5 | |
|
|
9c0314732e | |
|
|
542a7429ec | |
|
|
9df5720ab3 | |
|
|
1c13305f9f | |
|
|
6198add5bd | |
|
|
5fe54de24e | |
|
|
903710be1b | |
|
|
98b97cf4fd | |
|
|
bb29d5067b | |
|
|
4f0285a2e8 | |
|
|
cf80e9b127 | |
|
|
f01c5cef4d | |
|
|
98bce75905 | |
|
|
dd8c54cc9f | |
|
|
4ded43d707 | |
|
|
181aeac04a | |
|
|
f7466c2530 | |
|
|
7d3d51ff4f | |
|
|
4c92e0cc88 | |
|
|
0d2b8c3429 | |
|
|
984bd9e558 | |
|
|
6a282f86b4 | |
|
|
6c5381b6dc | |
|
|
27c18e0020 | |
|
|
9ebc4ce9c0 | |
|
|
5ffef8dc35 | |
|
|
43c0e290d2 | |
|
|
cad9be3e89 | |
|
|
82d211b7ca | |
|
|
8719d828d0 | |
|
|
3abcefe1fb | |
|
|
9168e00167 | |
|
|
d0c9cd7b0b | |
|
|
c352e03d18 | |
|
|
9b12f6f86c | |
|
|
91f6c41be1 | |
|
|
02513c721f | |
|
|
e7a34a2b61 | |
|
|
85339708e6 | |
|
|
b4f230f565 | |
|
|
b102694c64 | |
|
|
5aef6379b9 | |
|
|
4cb5cc7dbc | |
|
|
c5d0fb55ba | |
|
|
c0adbc4e76 | |
|
|
f6dab0d0ff | |
|
|
cf6cf779bb | |
|
|
7074395bdd | |
|
|
9b8ce69f37 | |
|
|
79959e75ac | |
|
|
8bdf21f65b | |
|
|
7d63dcd6a0 | |
|
|
999ece33a9 | |
|
|
baf2b9daef | |
|
|
9abd6654f1 | |
|
|
4346f0bcf3 | |
|
|
431b961451 | |
|
|
def8da0acb | |
|
|
48881f86a6 | |
|
|
efbe839a0a | |
|
|
3f9ad4868c | |
|
|
aad132c9b1 | |
|
|
c9f2dc51db | |
|
|
6eb7c34752 | |
|
|
9b9f43fcb9 | |
|
|
77a53a20ed | |
|
|
5d89298fe8 | |
|
|
421a811e87 | |
|
|
c9c3d31d3a | |
|
|
ec8ab0c638 | |
|
|
aae7923d5d | |
|
|
3734607994 | |
|
|
e29a1273e1 | |
|
|
01bbe2a3ef | |
|
|
73135bee8e | |
|
|
6f8f0871cf | |
|
|
14bfa5b224 | |
|
|
83641eee9d | |
|
|
a96ea2f19a | |
|
|
28e6dded4d | |
|
|
966ca5db0b | |
|
|
e0318d9da8 | |
|
|
4a983d64a7 | |
|
|
f25fcc686c | |
|
|
411cded4d0 | |
|
|
a50d82df1c | |
|
|
d022e569bd | |
|
|
7990ad528c | |
|
|
5881790068 | |
|
|
d83a88da66 | |
|
|
7b68d1a326 | |
|
|
7cd4926adb | |
|
|
0fa53ad144 | |
|
|
afee68ca99 | |
|
|
b952d28fb3 | |
|
|
577c1aa218 | |
|
|
abba7ee987 | |
|
|
d34efa2695 | |
|
|
87b1292e3f | |
|
|
43f7eee29a | |
|
|
96f21be73e | |
|
|
66e7d3a36d | |
|
|
2b7f7ff421 | |
|
|
3360666c2a | |
|
|
274dea16fa | |
|
|
dcd581c84a | |
|
|
6d84a60a78 | |
|
|
59e1b7067c | |
|
|
1d8df63ac5 | |
|
|
993d02b8b3 | |
|
|
5cb5606ba3 | |
|
|
eeebf152af | |
|
|
d419ac8a70 | |
|
|
568249e985 | |
|
|
c0f6401902 | |
|
|
e535f94325 | |
|
|
e465ce4bb5 | |
|
|
9d328082eb | |
|
|
d4f6642333 | |
|
|
9f85dade25 | |
|
|
5870651bad | |
|
|
eff826eef9 |
Binary file not shown.
|
|
@ -0,0 +1,169 @@
|
||||||
|
---
|
||||||
|
name: changelog-social
|
||||||
|
description: Generate social media announcements for Discord, Twitter, and LinkedIn from the latest changelog entry. Use when user asks to create release announcements, social posts, or share changelog updates. Reads CHANGELOG.md in current working directory. Reference examples/ for tone and format.
|
||||||
|
disable-model-invocation: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Changelog Social
|
||||||
|
|
||||||
|
Generate engaging social media announcements from changelog entries.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
### Step 1: Extract Changelog Entry
|
||||||
|
|
||||||
|
Read `./CHANGELOG.md` and extract the latest version entry. The changelog follows this format:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## [VERSION]
|
||||||
|
|
||||||
|
### 🎁 Features
|
||||||
|
* **Title** — Description
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
* **Title** — Description
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
* **Title** — Description
|
||||||
|
|
||||||
|
### 🔧 Maintenance
|
||||||
|
* **Title** — Description
|
||||||
|
```
|
||||||
|
|
||||||
|
Parse:
|
||||||
|
- **Version number** (e.g., `6.0.0-Beta.5`)
|
||||||
|
- **Features** - New functionality, enhancements
|
||||||
|
- **Bug Fixes** - Fixes users will care about
|
||||||
|
- **Documentation** - New or improved docs
|
||||||
|
- **Maintenance** - Dependency updates, tooling improvements
|
||||||
|
|
||||||
|
### Step 2: Get Git Contributors
|
||||||
|
|
||||||
|
Use git log to find contributors since the previous version. Get commits between the current version tag and the previous one:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Find the previous version tag first
|
||||||
|
git tag --sort=-version:refname | head -5
|
||||||
|
|
||||||
|
# Get commits between versions with PR numbers and authors
|
||||||
|
git log <previous-tag>..<current-tag> --pretty=format:"%h|%s|%an" --grep="#"
|
||||||
|
```
|
||||||
|
|
||||||
|
Extract PR numbers from commit messages that contain `#` followed by digits. Compile unique contributors.
|
||||||
|
|
||||||
|
### Step 3: Generate Discord Announcement
|
||||||
|
|
||||||
|
**Limit: 2,000 characters per message.** Split into multiple messages if needed.
|
||||||
|
|
||||||
|
Use this template style:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
🚀 **BMad vVERSION RELEASED!**
|
||||||
|
|
||||||
|
🎉 [Brief hype sentence]
|
||||||
|
|
||||||
|
🪥 **KEY HIGHLIGHT** - [One-line summary]
|
||||||
|
|
||||||
|
🎯 **CATEGORY NAME**
|
||||||
|
• Feature one - brief description
|
||||||
|
• Feature two - brief description
|
||||||
|
• Coming soon: Future teaser
|
||||||
|
|
||||||
|
🔧 **ANOTHER CATEGORY**
|
||||||
|
• Fix or feature
|
||||||
|
• Another item
|
||||||
|
|
||||||
|
📚 **DOCS OR OTHER**
|
||||||
|
• Item
|
||||||
|
• Item with link
|
||||||
|
|
||||||
|
🌟 **COMMUNITY PHILOSOPHY** (optional - include for major releases)
|
||||||
|
• Everything is FREE - No paywalls
|
||||||
|
• Knowledge shared, not sold
|
||||||
|
|
||||||
|
📊 **STATS**
|
||||||
|
X commits | Y PRs merged | Z files changed
|
||||||
|
|
||||||
|
🙏 **CONTRIBUTORS**
|
||||||
|
@username1 (X PRs!), @username2 (Y PRs!)
|
||||||
|
@username3, @username4, username5 + dependabot 🛡️
|
||||||
|
Community-driven FTW! 🌟
|
||||||
|
|
||||||
|
📦 **INSTALL:**
|
||||||
|
`npx bmad-method@VERSION install`
|
||||||
|
|
||||||
|
⭐ **SUPPORT US:**
|
||||||
|
🌟 GitHub: github.com/bmad-code-org/BMAD-METHOD/
|
||||||
|
📺 YouTube: youtube.com/@BMadCode
|
||||||
|
☕ Donate: buymeacoffee.com/bmad
|
||||||
|
|
||||||
|
🔥 **Next version tease!**
|
||||||
|
```
|
||||||
|
|
||||||
|
**Content Strategy:**
|
||||||
|
- Focus on **user impact** - what's better for them?
|
||||||
|
- Highlight **annoying bugs fixed** that frustrated users
|
||||||
|
- Show **new capabilities** that enable workflows
|
||||||
|
- Keep it **punchy** - use emojis and short bullets
|
||||||
|
- Add **personality** - excitement, humor, gratitude
|
||||||
|
|
||||||
|
### Step 4: Generate Twitter Post
|
||||||
|
|
||||||
|
**Limit: 25,000 characters per tweet (Premium).** With Premium, use a single comprehensive post matching the Discord style (minus Discord-specific formatting). Aim for 1,500-3,000 characters for better engagement.
|
||||||
|
|
||||||
|
**Threads are optional** — only use for truly massive releases where you want multiple engagement points.
|
||||||
|
|
||||||
|
See `examples/twitter-example.md` for the single-post Premium format.
|
||||||
|
|
||||||
|
## Content Selection Guidelines
|
||||||
|
|
||||||
|
**Include:**
|
||||||
|
- New features that change workflows
|
||||||
|
- Bug fixes for annoying/blocking issues
|
||||||
|
- Documentation that helps users
|
||||||
|
- Performance improvements
|
||||||
|
- New agents or workflows
|
||||||
|
- Breaking changes (call out clearly)
|
||||||
|
|
||||||
|
**Skip/Minimize:**
|
||||||
|
- Internal refactoring
|
||||||
|
- Dependency updates (unless user-facing)
|
||||||
|
- Test improvements
|
||||||
|
- Minor style fixes
|
||||||
|
|
||||||
|
**Emphasize:**
|
||||||
|
- "Finally fixed" issues
|
||||||
|
- "Faster" operations
|
||||||
|
- "Easier" workflows
|
||||||
|
- "Now supports" capabilities
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Reference example posts in `examples/` for tone and formatting guidance:
|
||||||
|
|
||||||
|
- **discord-example.md** — Full Discord announcement with emojis, sections, contributor shout-outs
|
||||||
|
- **twitter-example.md** — Twitter thread format (5 tweets max for major releases)
|
||||||
|
- **linkedin-example.md** — Professional post for major/minor releases with significant features
|
||||||
|
|
||||||
|
**When to use LinkedIn:**
|
||||||
|
- Major version releases (e.g., v6.0.0 Beta, v7.0.0)
|
||||||
|
- Minor releases with exceptional new features
|
||||||
|
- Community milestone announcements
|
||||||
|
|
||||||
|
Read the appropriate example file before generating to match the established style and voice.
|
||||||
|
|
||||||
|
## Output Format
|
||||||
|
|
||||||
|
Present both announcements in clearly labeled sections:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Discord Announcement
|
||||||
|
|
||||||
|
[paste Discord content here]
|
||||||
|
|
||||||
|
## Twitter Post
|
||||||
|
|
||||||
|
[paste Twitter content here]
|
||||||
|
```
|
||||||
|
|
||||||
|
Offer to make adjustments if the user wants different emphasis, tone, or content.
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
🚀 **BMad v6.0.0-alpha.23 RELEASED!**
|
||||||
|
|
||||||
|
🎉 Huge update - almost beta!
|
||||||
|
|
||||||
|
🪟 **WINDOWS INSTALLER FIXED** - Menu arrows issue should be fixed! CRLF & ESM problems resolved.
|
||||||
|
|
||||||
|
🎯 **PRD WORKFLOWS IMPROVED**
|
||||||
|
• Validation & Edit workflows added!
|
||||||
|
• PRD Cohesion check ensures document flows beautifully
|
||||||
|
• Coming soon: Use of subprocess optimization (context saved!)
|
||||||
|
• Coming soon: Final format polish step in all workflows - Human consumption OR hyper-optimized LLM condensed initially!
|
||||||
|
|
||||||
|
🔧 **WORKFLOW CREATOR & VALIDATOR**
|
||||||
|
• Subprocess support for advanced optimization
|
||||||
|
• Path violation checks ensure integrity
|
||||||
|
• Beyond error checking - offers optimization & flow suggestions!
|
||||||
|
|
||||||
|
📚 **NEW DOCS SITE** - docs.bmad-method.org
|
||||||
|
• Diataxis framework: Tutorials, How-To, Explanations, References
|
||||||
|
• Current docs still being revised
|
||||||
|
• Tutorials, blogs & explainers coming soon!
|
||||||
|
|
||||||
|
💡 **BRAINSTORMING REVOLUTION**
|
||||||
|
• 100+ idea goal (quantity-first!)
|
||||||
|
• Anti-bias protocol (pivot every 10 ideas)
|
||||||
|
• Chain-of-thought + simulated temperature prompts
|
||||||
|
• Coming soon: SubProcessing (on-the-fly sub agents)
|
||||||
|
|
||||||
|
🌟 **COMMUNITY PHILOSOPHY**
|
||||||
|
• Everything is FREE - No paywalls, no gated content
|
||||||
|
• Knowledge shared, not sold
|
||||||
|
• No premium tiers - full access to our ideas
|
||||||
|
|
||||||
|
📊 **27 commits | 217 links converted | 42+ docs created**
|
||||||
|
|
||||||
|
🙏 **17 Community PR Authors in this release!**
|
||||||
|
@lum (6 PRs!), @q00 (3 PRs!), @phil (2 PRs!)
|
||||||
|
@mike, @alex, @ramiz, @sjennings + dependabot 🛡️
|
||||||
|
Community-driven FTW! 🌟
|
||||||
|
|
||||||
|
📦 **INSTALL ALPHA:**
|
||||||
|
`npx bmad-method install`
|
||||||
|
|
||||||
|
⭐ **SUPPORT US:**
|
||||||
|
🌟 GitHub: github.com/bmad-code-org/BMAD-METHOD/
|
||||||
|
📺 YouTube: youtube.com/@BMadCode
|
||||||
|
|
||||||
|
🎤 **SPEAKING & MEDIA**
|
||||||
|
Available for conferences, podcasts, media appearances!
|
||||||
|
Topics: AI-Native Organizations (Any Industry), BMad Method
|
||||||
|
DM on Discord for inquiries!
|
||||||
|
|
||||||
|
🔥 **V6 Beta is DAYS away!** January 22nd ETA - new features such as xyz and abc bug fixes!
|
||||||
|
|
@ -0,0 +1,49 @@
|
||||||
|
🚀 **Announcing BMad Method v6.0.0 Beta - AI-Native Agile Development Framework**
|
||||||
|
|
||||||
|
I'm excited to share that BMad Method, the open-source AI-driven agile development framework, is entering Beta! After 27 alpha releases and countless community contributions, we're approaching a major milestone.
|
||||||
|
|
||||||
|
**What's New in v6.0.0-alpha.23**
|
||||||
|
|
||||||
|
🪟 **Windows Compatibility Fixed**
|
||||||
|
We've resolved the installer issues that affected Windows users. The menu arrows problem, CRLF handling, and ESM compatibility are all resolved.
|
||||||
|
|
||||||
|
🎯 **Enhanced PRD Workflows**
|
||||||
|
Our Product Requirements Document workflows now include validation and editing capabilities, with a new cohesion check that ensures your documents flow beautifully. Subprocess optimization is coming soon to save even more context.
|
||||||
|
|
||||||
|
🔧 **Workflow Creator & Validator**
|
||||||
|
New tools for creating and validating workflows with subprocess support, path violation checks, and optimization suggestions that go beyond simple error checking.
|
||||||
|
|
||||||
|
📚 **New Documentation Platform**
|
||||||
|
We've launched docs.bmad-method.org using the Diataxis framework - providing clear separation between tutorials, how-to guides, explanations, and references. Our documentation is being continuously revised and expanded.
|
||||||
|
|
||||||
|
💡 **Brainstorming Revolution**
|
||||||
|
Our brainstorming workflows now use research-backed techniques: 100+ idea goals, anti-bias protocols, chain-of-thought reasoning, and simulated temperature prompts for higher divergence.
|
||||||
|
|
||||||
|
**Our Philosophy**
|
||||||
|
|
||||||
|
Everything in BMad Method is FREE. No paywalls, no gated content, no premium tiers. We believe knowledge should be shared, not sold. This is community-driven development at its finest.
|
||||||
|
|
||||||
|
**The Stats**
|
||||||
|
- 27 commits in this release
|
||||||
|
- 217 documentation links converted
|
||||||
|
- 42+ new documents created
|
||||||
|
- 17 community PR authors contributed
|
||||||
|
|
||||||
|
**Get Started**
|
||||||
|
|
||||||
|
```
|
||||||
|
npx bmad-method@alpha install
|
||||||
|
```
|
||||||
|
|
||||||
|
**Learn More**
|
||||||
|
- GitHub: github.com/bmad-code-org/BMAD-METHOD
|
||||||
|
- YouTube: youtube.com/@BMadCode
|
||||||
|
- Docs: docs.bmad-method.org
|
||||||
|
|
||||||
|
**What's Next?**
|
||||||
|
|
||||||
|
Beta is just days away with an ETA of January 22nd. We're also available for conferences, podcasts, and media appearances to discuss AI-Native Organizations and the BMad Method.
|
||||||
|
|
||||||
|
Have you tried BMad Method yet? I'd love to hear about your experience in the comments!
|
||||||
|
|
||||||
|
#AI #SoftwareDevelopment #Agile #OpenSource #DevTools #LLM #AgentEngineering
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
🚀 **BMad v6.0.0-alpha.23 RELEASED!**
|
||||||
|
|
||||||
|
Huge update - we're almost at Beta! 🎉
|
||||||
|
|
||||||
|
🪟 **WINDOWS INSTALLER FIXED** - Menu arrows issue should be fixed! CRLF & ESM problems resolved.
|
||||||
|
|
||||||
|
🎯 **PRD WORKFLOWS IMPROVED**
|
||||||
|
• Validation & Edit workflows added!
|
||||||
|
• PRD Cohesion check ensures document flows beautifully
|
||||||
|
• Coming soon: Subprocess optimization (context saved!)
|
||||||
|
• Coming soon: Final format polish step in all workflows
|
||||||
|
|
||||||
|
🔧 **WORKFLOW CREATOR & VALIDATOR**
|
||||||
|
• Subprocess support for advanced optimization
|
||||||
|
• Path violation checks ensure integrity
|
||||||
|
• Beyond error checking - offers optimization & flow suggestions!
|
||||||
|
|
||||||
|
📚 **NEW DOCS SITE** - docs.bmad-method.org
|
||||||
|
• Diataxis framework: Tutorials, How-To, Explanations, References
|
||||||
|
• Current docs still being revised
|
||||||
|
• Tutorials, blogs & explainers coming soon!
|
||||||
|
|
||||||
|
💡 **BRAINSTORMING REVOLUTION**
|
||||||
|
• 100+ idea goal (quantity-first!)
|
||||||
|
• Anti-bias protocol (pivot every 10 ideas)
|
||||||
|
• Chain-of-thought + simulated temperature prompts
|
||||||
|
• Coming soon: SubProcessing (on-the-fly sub agents)
|
||||||
|
|
||||||
|
🌟 **COMMUNITY PHILOSOPHY**
|
||||||
|
• Everything is FREE - No paywalls, no gated content
|
||||||
|
• Knowledge shared, not sold
|
||||||
|
• No premium tiers - full access to our ideas
|
||||||
|
|
||||||
|
📊 **27 commits | 217 links converted | 42+ docs created**
|
||||||
|
|
||||||
|
🙏 **17 Community PR Authors in this release!**
|
||||||
|
@lum (6 PRs!), @q00 (3 PRs!), @phil (2 PRs!)
|
||||||
|
@mike, @alex, @ramiz, @sjennings + dependabot 🛡️
|
||||||
|
Community-driven FTW! 🌟
|
||||||
|
|
||||||
|
📦 **INSTALL ALPHA:**
|
||||||
|
`npx bmad-method install`
|
||||||
|
|
||||||
|
⭐ **SUPPORT US:**
|
||||||
|
🌟 GitHub: github.com/bmad-code-org/BMAD-METHOD/
|
||||||
|
📺 YouTube: youtube.com/@BMadCode
|
||||||
|
|
||||||
|
🎤 **SPEAKING & MEDIA**
|
||||||
|
Available for conferences, podcasts, media appearances!
|
||||||
|
Topics: AI-Native Organizations (Any Industry), BMad Method
|
||||||
|
DM on Discord for inquiries!
|
||||||
|
|
||||||
|
🔥 **V6 Beta is DAYS away!** January 22nd ETA!
|
||||||
|
|
||||||
|
#AI #DevTools #Agile #OpenSource #LLM #AgentEngineering
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
name: draft-changelog
|
||||||
|
description: Analyzes changes since the last release and generates a draft changelog entry
|
||||||
|
disable-model-invocation: true
|
||||||
|
---
|
||||||
|
|
||||||
|
Read `prompts/instructions.md` and execute.
|
||||||
|
|
@ -0,0 +1,58 @@
|
||||||
|
# Draft Changelog Execution
|
||||||
|
|
||||||
|
## Input
|
||||||
|
Project path (or run from project root)
|
||||||
|
|
||||||
|
## Step 1: Identify Current State
|
||||||
|
- Get the latest released tag
|
||||||
|
- Get current version
|
||||||
|
- Verify there are commits since the last release
|
||||||
|
|
||||||
|
## Step 2: Launch Explore Agent
|
||||||
|
|
||||||
|
Use `thoroughness: "very thorough"` to analyze all changes since the last release tag.
|
||||||
|
|
||||||
|
**Key: For each merge commit, look up the merged PR/issue that was closed.**
|
||||||
|
- Use `gh pr view` or git commit body to find the PR number
|
||||||
|
- Read the PR description and comments to understand full context
|
||||||
|
- Don't rely solely on commit merge messages - they lack context
|
||||||
|
|
||||||
|
**Analyze:**
|
||||||
|
|
||||||
|
1. **All merges/commits** since the last tag
|
||||||
|
2. **For each merge, read the original PR/issue** that was closed
|
||||||
|
3. **Files changed** with statistics
|
||||||
|
4. **Categorize changes:**
|
||||||
|
- 🎁 **Features** - New functionality, new agents, new workflows
|
||||||
|
- 🐛 **Bug Fixes** - Fixed bugs, corrected issues
|
||||||
|
- ♻️ **Refactoring** - Code improvements, reorganization
|
||||||
|
- 📚 **Documentation** - Docs updates, README changes
|
||||||
|
- 🔧 **Maintenance** - Dependency updates, tooling, infrastructure
|
||||||
|
- 💥 **Breaking Changes** - Changes that may affect users
|
||||||
|
|
||||||
|
**Provide:**
|
||||||
|
- Comprehensive summary of ALL changes with PR context
|
||||||
|
- Categorization of each change
|
||||||
|
- Identification of breaking changes
|
||||||
|
- Significance assessment (major/minor/trivial)
|
||||||
|
|
||||||
|
## Step 3: Generate Draft Changelog
|
||||||
|
|
||||||
|
Format:
|
||||||
|
```markdown
|
||||||
|
## v0.X.X - [Date]
|
||||||
|
|
||||||
|
* [Change 1 - categorized by type]
|
||||||
|
* [Change 2]
|
||||||
|
```
|
||||||
|
|
||||||
|
Guidelines:
|
||||||
|
- Present tense ("Fix bug" not "Fixed bug")
|
||||||
|
- Most significant changes first
|
||||||
|
- Group related changes
|
||||||
|
- Clear, concise language
|
||||||
|
- For breaking changes, clearly indicate impact
|
||||||
|
|
||||||
|
## Step 4: Present Draft
|
||||||
|
|
||||||
|
Show the draft with current version, last tag, commit count, and options to edit/retry.
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
# gh-triage
|
||||||
|
|
||||||
|
Fetches all GitHub issues via gh CLI and uses AI agents to deeply analyze, cluster, and prioritize issues.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Run from within any BMad Method repository to triage issues.
|
||||||
|
|
||||||
|
## What It Does
|
||||||
|
|
||||||
|
1. Fetches all open issues via `gh issue list`
|
||||||
|
2. Splits issues into batches
|
||||||
|
3. Launches parallel agents to analyze each batch
|
||||||
|
4. Generates comprehensive triage report to `_bmad-output/triage-reports/`
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
name: gh-triage
|
||||||
|
description: Fetch all GitHub issues via gh CLI and use AI agents to deeply analyze, cluster, and prioritize issues
|
||||||
|
license: MIT
|
||||||
|
disable-model-invocation: true
|
||||||
|
metadata:
|
||||||
|
author: bmad-code-org
|
||||||
|
version: "3.0.0"
|
||||||
|
compatibility: Requires gh CLI, git repository, and BMad Method with Task tool support
|
||||||
|
---
|
||||||
|
|
||||||
|
Read `prompts/instructions.md` and execute.
|
||||||
|
|
@ -0,0 +1,60 @@
|
||||||
|
You are analyzing a batch of GitHub issues for deep understanding and triage.
|
||||||
|
|
||||||
|
**YOUR TASK:**
|
||||||
|
Read the issues in your batch and provide DEEP analysis:
|
||||||
|
|
||||||
|
1. **For EACH issue, analyze:**
|
||||||
|
- What is this ACTUALLY about? (beyond keywords)
|
||||||
|
- What component/system does it affect?
|
||||||
|
- What's the impact and severity?
|
||||||
|
- Is it a bug, feature request, or something else?
|
||||||
|
- What specific theme does it belong to?
|
||||||
|
|
||||||
|
2. **PRIORITY ASSESSMENT:**
|
||||||
|
- CRITICAL: Blocks users, security issues, data loss, broken installers
|
||||||
|
- HIGH: Major functionality broken, important features missing
|
||||||
|
- MEDIUM: Workarounds available, minor bugs, nice-to-have features
|
||||||
|
- LOW: Edge cases, cosmetic issues, questions
|
||||||
|
|
||||||
|
3. **RELATIONSHIPS:**
|
||||||
|
- Duplicates: Near-identical issues about the same problem
|
||||||
|
- Related: Issues connected by theme or root cause
|
||||||
|
- Dependencies: One issue blocks or requires another
|
||||||
|
|
||||||
|
**YOUR BATCH:**
|
||||||
|
[Paste the batch of issues here - each with number, title, body, labels]
|
||||||
|
|
||||||
|
**OUTPUT FORMAT (JSON only, no markdown):**
|
||||||
|
{
|
||||||
|
"issues": [
|
||||||
|
{
|
||||||
|
"number": 123,
|
||||||
|
"title": "issue title",
|
||||||
|
"deep_understanding": "2-3 sentences explaining what this is really about",
|
||||||
|
"affected_components": ["installer", "workflows", "docs"],
|
||||||
|
"issue_type": "bug/feature/question/tech-debt",
|
||||||
|
"priority": "CRITICAL/HIGH/MEDIUM/LOW",
|
||||||
|
"priority_rationale": "Why this priority level",
|
||||||
|
"theme": "installation/workflow/integration/docs/ide-support/etc",
|
||||||
|
"relationships": {
|
||||||
|
"duplicates_of": [456],
|
||||||
|
"related_to": [789, 101],
|
||||||
|
"blocks": [111]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"cross_repo_issues": [
|
||||||
|
{"number": 123, "target_repo": "bmad-builder", "reason": "about agent builder"}
|
||||||
|
],
|
||||||
|
"cleanup_candidates": [
|
||||||
|
{"number": 456, "reason": "v4-related/outdated/duplicate"}
|
||||||
|
],
|
||||||
|
"themes_found": {
|
||||||
|
"Installation Blockers": {
|
||||||
|
"count": 5,
|
||||||
|
"root_cause": "Common pattern if identifiable"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Return ONLY valid JSON. No explanations outside the JSON structure.
|
||||||
|
|
@ -0,0 +1,74 @@
|
||||||
|
# GitHub Issue Triage with AI Analysis
|
||||||
|
|
||||||
|
**CRITICAL RULES:**
|
||||||
|
- NEVER include time or effort estimates in output or recommendations
|
||||||
|
- Focus on WHAT needs to be done, not HOW LONG it takes
|
||||||
|
- Use Bash tool with gh CLI for all GitHub operations
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
### Step 1: Fetch Issues
|
||||||
|
Use `gh issue list --json number,title,body,labels` to fetch all open issues.
|
||||||
|
|
||||||
|
### Step 2: Batch Creation
|
||||||
|
Split issues into batches of ~10 issues each for parallel analysis.
|
||||||
|
|
||||||
|
### Step 3: Parallel Agent Analysis
|
||||||
|
For EACH batch, use the Task tool with `subagent_type=general-purpose` to launch an agent with prompt from `prompts/agent-prompt.md`
|
||||||
|
|
||||||
|
### Step 4: Consolidate & Generate Report
|
||||||
|
After all agents complete, create a comprehensive markdown report saved to `_bmad-output/triage-reports/triage-YYYY-MM-DD.md`
|
||||||
|
|
||||||
|
## Report Format
|
||||||
|
|
||||||
|
### Executive Summary
|
||||||
|
- Total issues analyzed
|
||||||
|
- Issue count by priority (CRITICAL, HIGH, MEDIUM, LOW)
|
||||||
|
- Major themes discovered
|
||||||
|
- Top 5 critical issues requiring immediate attention
|
||||||
|
|
||||||
|
### Critical Issues (CRITICAL Priority)
|
||||||
|
For each CRITICAL issue:
|
||||||
|
- **#123 - [Issue Title](url)**
|
||||||
|
- **What it's about:** [Deep understanding]
|
||||||
|
- **Affected:** [Components]
|
||||||
|
- **Why Critical:** [Rationale]
|
||||||
|
- **Suggested Action:** [Specific action]
|
||||||
|
|
||||||
|
### High Priority Issues (HIGH Priority)
|
||||||
|
Same format as Critical, grouped by theme.
|
||||||
|
|
||||||
|
### Theme Clusters
|
||||||
|
For each major theme:
|
||||||
|
- **Theme Name** (N issues)
|
||||||
|
- **What connects these:** [Pattern]
|
||||||
|
- **Root cause:** [If identifiable]
|
||||||
|
- **Consolidated actions:** [Bulk actions if applicable]
|
||||||
|
- **Issues:** #123, #456, #789
|
||||||
|
|
||||||
|
### Relationships & Dependencies
|
||||||
|
- **Duplicates:** List pairs with `gh issue close` commands
|
||||||
|
- **Related Issues:** Groups of related issues
|
||||||
|
- **Dependencies:** Blocking relationships
|
||||||
|
|
||||||
|
### Cross-Repo Issues
|
||||||
|
Issues that should be migrated to other repositories.
|
||||||
|
|
||||||
|
For each, provide:
|
||||||
|
```
|
||||||
|
gh issue close XXX --repo CURRENT_REPO --comment "This issue belongs in REPO. Please report at https://github.com/TARGET_REPO/issues/new"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cleanup Candidates
|
||||||
|
- **v4-related:** Deprecated version issues with close commands
|
||||||
|
- **Stale:** No activity >30 days
|
||||||
|
- **Low priority + old:** Low priority issues >60 days old
|
||||||
|
|
||||||
|
### Actionable Next Steps
|
||||||
|
Specific, prioritized actions:
|
||||||
|
1. [CRITICAL] Fix broken installer - affects all new users
|
||||||
|
2. [HIGH] Resolve Windows path escaping issues
|
||||||
|
3. [HIGH] Address workflow integration bugs
|
||||||
|
etc.
|
||||||
|
|
||||||
|
Include `gh` commands where applicable for bulk actions.
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
# release-module
|
||||||
|
|
||||||
|
Automates the complete release process for npm modules.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Run from project root or pass project path:
|
||||||
|
```
|
||||||
|
bmad-utility-skills:release-module
|
||||||
|
```
|
||||||
|
|
||||||
|
## Prerequisite
|
||||||
|
|
||||||
|
First run `draft-changelog` to analyze changes and create a draft changelog.
|
||||||
|
|
||||||
|
## What It Does
|
||||||
|
|
||||||
|
1. Gets and confirms changelog entry
|
||||||
|
2. Confirms version bump type (patch/minor/major)
|
||||||
|
3. Updates CHANGELOG.md
|
||||||
|
4. Bumps version with `npm version`
|
||||||
|
5. Pushes git tag
|
||||||
|
6. Publishes to npm
|
||||||
|
7. Creates GitHub release
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
name: release-module
|
||||||
|
description: Automates the complete release process for npm modules - version bump, changelog, git tag, npm publish, GitHub release
|
||||||
|
disable-model-invocation: true
|
||||||
|
---
|
||||||
|
|
||||||
|
Read `prompts/instructions.md` and execute.
|
||||||
|
|
@ -0,0 +1,73 @@
|
||||||
|
# Release BMad Module Execution
|
||||||
|
|
||||||
|
## Input
|
||||||
|
Project path (or run from project root)
|
||||||
|
|
||||||
|
## Execution Steps
|
||||||
|
|
||||||
|
### Step 1: Get Current State
|
||||||
|
- Verify git working tree is clean
|
||||||
|
- Get latest tag and current version
|
||||||
|
- Check for unpushed commits
|
||||||
|
|
||||||
|
### Step 2: Get Changelog Entry
|
||||||
|
|
||||||
|
Ask the user for the changelog entry (from draft-changelog skill or manual).
|
||||||
|
|
||||||
|
### Step 3: Confirm Changelog
|
||||||
|
|
||||||
|
Show project name, current version, proposed next version, and changelog. Get confirmation.
|
||||||
|
|
||||||
|
### Step 4: Confirm Version Bump Type
|
||||||
|
|
||||||
|
Ask what type of bump: patch, minor, major, prerelease, or custom.
|
||||||
|
|
||||||
|
### Step 5: Update CHANGELOG.md
|
||||||
|
|
||||||
|
Insert new entry at top, commit, and push.
|
||||||
|
|
||||||
|
### Step 6: Bump Version
|
||||||
|
|
||||||
|
Run `npm version` to update package.json, create commit, and create tag.
|
||||||
|
|
||||||
|
### Step 7: Push Tag
|
||||||
|
|
||||||
|
Push the new version tag to GitHub.
|
||||||
|
|
||||||
|
### Step 8: Publish to npm
|
||||||
|
|
||||||
|
Publish the package.
|
||||||
|
|
||||||
|
### Step 9: Create GitHub Release
|
||||||
|
|
||||||
|
Create release with changelog notes using `gh release create`.
|
||||||
|
|
||||||
|
### Step 10: Create Social Announcement
|
||||||
|
|
||||||
|
Create a social media announcement file at `_bmad-output/social/{repo-name}-release.md`.
|
||||||
|
|
||||||
|
Format:
|
||||||
|
```markdown
|
||||||
|
# {name} v{version} Released
|
||||||
|
|
||||||
|
## Highlights
|
||||||
|
{2-3 bullet points of key features/changes}
|
||||||
|
|
||||||
|
## Links
|
||||||
|
- GitHub: {release-url}
|
||||||
|
- npm: {npm-url}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 11: Confirm Completion
|
||||||
|
|
||||||
|
Show npm, GitHub, and social announcement file paths.
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
Stop immediately on any step failure. Inform user and suggest fix.
|
||||||
|
|
||||||
|
## Important Notes
|
||||||
|
|
||||||
|
- Wait for user confirmation before destructive operations
|
||||||
|
- Push changelog commit before version bump
|
||||||
|
- Use explicit directory paths in commands
|
||||||
|
|
@ -0,0 +1,124 @@
|
||||||
|
name: Bug Report
|
||||||
|
description: File a bug report to help us improve BMad Method
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: bug
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for filing a bug report! Please fill out the information below to help us reproduce and fix the issue.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Clear and concise description of what the bug is
|
||||||
|
placeholder: e.g., When I run /dev-story, it crashes on step 3
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Step-by-step instructions to reproduce the behavior
|
||||||
|
placeholder: |
|
||||||
|
1. Run 'npx bmad-method install'
|
||||||
|
2. Select option X
|
||||||
|
3. Run workflow Y
|
||||||
|
4. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: What you expected to happen
|
||||||
|
placeholder: The workflow should complete successfully
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: actual
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: What actually happened
|
||||||
|
placeholder: The workflow crashed with error "..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: screenshots
|
||||||
|
attributes:
|
||||||
|
label: Screenshots
|
||||||
|
description: Add screenshots if applicable (paste images directly)
|
||||||
|
placeholder: Paste any relevant screenshots here
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: module
|
||||||
|
attributes:
|
||||||
|
label: Which module is this for?
|
||||||
|
description: Select the BMad module this issue relates to
|
||||||
|
options:
|
||||||
|
- BMad Method (BMM) - Core Framework
|
||||||
|
- BMad Builder (BMB) - Agent Builder Tool
|
||||||
|
- Test Architect (TEA) - Test Strategy Module
|
||||||
|
- Game Dev Studio (BMGD) - Game Development Module
|
||||||
|
- Creative Intelligence Suite (CIS) - Innovation Module
|
||||||
|
- Not sure / Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: BMad Version
|
||||||
|
description: "Check with: npx bmad-method --version or check package.json"
|
||||||
|
placeholder: e.g., 6.0.0-Beta.4
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: ide
|
||||||
|
attributes:
|
||||||
|
label: Which AI IDE are you using?
|
||||||
|
options:
|
||||||
|
- Claude Code
|
||||||
|
- Cursor
|
||||||
|
- Windsurf
|
||||||
|
- Copilot CLI / GitHub Copilot
|
||||||
|
- Kilo Code
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: platform
|
||||||
|
attributes:
|
||||||
|
label: Operating System
|
||||||
|
options:
|
||||||
|
- macOS
|
||||||
|
- Windows
|
||||||
|
- Linux
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Relevant log output
|
||||||
|
description: Copy and paste any relevant log output
|
||||||
|
render: shell
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: terms
|
||||||
|
attributes:
|
||||||
|
label: Confirm
|
||||||
|
options:
|
||||||
|
- label: I've searched for existing issues
|
||||||
|
required: true
|
||||||
|
- label: I'm using the latest version
|
||||||
|
required: false
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**Steps to Reproduce**
|
|
||||||
What lead to the bug and can it be reliable recreated - if so with what steps.
|
|
||||||
|
|
||||||
**PR**
|
|
||||||
If you have an idea to fix and would like to contribute, please indicate here you are working on a fix, or link to a proposed PR to fix the issue. Please review the contribution.md - contributions are always welcome!
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Please be Specific if relevant**
|
|
||||||
Model(s) Used:
|
|
||||||
Agentic IDE Used:
|
|
||||||
WebSite Used:
|
|
||||||
Project Language:
|
|
||||||
BMad Method version:
|
|
||||||
|
|
||||||
**Screenshots or Links**
|
|
||||||
If applicable, add screenshots or links (if web sharable record) to help explain your problem.
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here. The more information you can provide, the easier it will be to suggest a fix or resolve
|
|
||||||
|
|
@ -1,5 +1,8 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Discord Community Support
|
- name: 📚 Documentation
|
||||||
|
url: http://docs.bmad-method.org
|
||||||
|
about: Check the docs first — tutorials, guides, and reference
|
||||||
|
- name: 💬 Discord Community
|
||||||
url: https://discord.gg/gk8jAdXWmj
|
url: https://discord.gg/gk8jAdXWmj
|
||||||
about: Please join our Discord server for general questions and community discussion before opening an issue.
|
about: Join for questions, discussion, and help before opening an issue
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
name: Documentation
|
||||||
|
description: Report issues or suggest improvements to documentation
|
||||||
|
title: "[DOCS] "
|
||||||
|
labels: documentation
|
||||||
|
assignees: []
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Help us improve the BMad Method documentation!
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: doc-type
|
||||||
|
attributes:
|
||||||
|
label: What type of documentation issue is this?
|
||||||
|
options:
|
||||||
|
- Error or inaccuracy
|
||||||
|
- Missing information
|
||||||
|
- Unclear or confusing
|
||||||
|
- Outdated content
|
||||||
|
- Request for new documentation
|
||||||
|
- Typo or grammar
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: location
|
||||||
|
attributes:
|
||||||
|
label: Documentation location
|
||||||
|
description: Where is the documentation that needs improvement?
|
||||||
|
placeholder: e.g., http://docs.bmad-method.org/tutorials/getting-started/ or "In the README"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: issue
|
||||||
|
attributes:
|
||||||
|
label: What's the issue?
|
||||||
|
description: Describe the documentation issue in detail
|
||||||
|
placeholder: e.g., Step 3 says to run command X but it should be command Y
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: suggestion
|
||||||
|
attributes:
|
||||||
|
label: Suggested improvement
|
||||||
|
description: How would you like to see this improved?
|
||||||
|
placeholder: e.g., Change the command to X and add an example
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: BMad Version (if applicable)
|
||||||
|
placeholder: e.g., 6.0.0-Beta.4
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest an idea or new feature
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe your idea**
|
||||||
|
A clear and concise description of what you'd like to see added or changed.
|
||||||
|
|
||||||
|
**Why is this needed?**
|
||||||
|
Explain the problem this solves or the benefit it brings to the BMad community.
|
||||||
|
|
||||||
|
**How should it work?**
|
||||||
|
Describe your proposed solution. If you have ideas on implementation, share them here.
|
||||||
|
|
||||||
|
**PR**
|
||||||
|
If you'd like to contribute, please indicate you're working on this or link to your PR. Please review [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context, screenshots, or links that help explain your idea.
|
||||||
|
|
@ -1,109 +0,0 @@
|
||||||
---
|
|
||||||
name: V6 Idea Submission
|
|
||||||
about: Suggest an idea for v6
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
---
|
|
||||||
|
|
||||||
# Idea: [Replace with a clear, actionable title]
|
|
||||||
|
|
||||||
## PASS Framework
|
|
||||||
|
|
||||||
**P**roblem:
|
|
||||||
|
|
||||||
> What's broken or missing? What pain point are we addressing? (1-2 sentences)
|
|
||||||
>
|
|
||||||
> [Your answer here]
|
|
||||||
|
|
||||||
**A**udience:
|
|
||||||
|
|
||||||
> Who's affected by this problem and how severely? (1-2 sentences)
|
|
||||||
>
|
|
||||||
> [Your answer here]
|
|
||||||
|
|
||||||
**S**olution:
|
|
||||||
|
|
||||||
> What will we build or change? How will we measure success? (1-2 sentences with at least 1 measurable outcome)
|
|
||||||
>
|
|
||||||
> [Your answer here]
|
|
||||||
>
|
|
||||||
> [Your Acceptance Criteria for measuring success here]
|
|
||||||
|
|
||||||
**S**ize:
|
|
||||||
|
|
||||||
> How much effort do you estimate this will take?
|
|
||||||
>
|
|
||||||
> - [ ] **XS** - A few hours
|
|
||||||
> - [ ] **S** - 1-2 days
|
|
||||||
> - [ ] **M** - 3-5 days
|
|
||||||
> - [ ] **L** - 1-2 weeks
|
|
||||||
> - [ ] **XL** - More than 2 weeks
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Metadata
|
|
||||||
|
|
||||||
**Submitted by:** [Your name]
|
|
||||||
**Date:** [Today's date]
|
|
||||||
**Priority:** [Leave blank - will be assigned during team review]
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to see a GOOD example</summary>
|
|
||||||
|
|
||||||
### Idea: Add search functionality to customer dashboard
|
|
||||||
|
|
||||||
**P**roblem:
|
|
||||||
Customers can't find their past orders quickly. They have to scroll through pages of orders to find what they're looking for, leading to 15+ support tickets per week.
|
|
||||||
|
|
||||||
**A**udience:
|
|
||||||
All 5,000+ active customers are affected. Support team spends ~10 hours/week helping customers find orders.
|
|
||||||
|
|
||||||
**S**olution:
|
|
||||||
Add a search bar that filters by order number, date range, and product name. Success = 50% reduction in order-finding support tickets within 2 weeks of launch.
|
|
||||||
|
|
||||||
**S**ize:
|
|
||||||
|
|
||||||
- [x] **M** - 3-5 days
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to see a POOR example</summary>
|
|
||||||
|
|
||||||
### Idea: Make the app better
|
|
||||||
|
|
||||||
**P**roblem:
|
|
||||||
The app needs improvements and updates.
|
|
||||||
|
|
||||||
**A**udience:
|
|
||||||
Users
|
|
||||||
|
|
||||||
**S**olution:
|
|
||||||
Fix issues and add features.
|
|
||||||
|
|
||||||
**S**ize:
|
|
||||||
|
|
||||||
- [ ] Unknown
|
|
||||||
|
|
||||||
_Why this is poor: Too vague, no specific problem identified, no measurable success criteria, unclear scope_
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips for Success
|
|
||||||
|
|
||||||
1. **Be specific** - Vague problems lead to vague solutions
|
|
||||||
2. **Quantify when possible** - Numbers help us prioritize (e.g., "20 customers asked for this" vs "customers want this")
|
|
||||||
3. **One idea per submission** - If you have multiple ideas, submit multiple templates
|
|
||||||
4. **Success metrics matter** - How will we know this worked?
|
|
||||||
5. **Honest sizing** - Better to overestimate than underestimate
|
|
||||||
|
|
||||||
## Questions?
|
|
||||||
|
|
||||||
Reach out to @OverlordBaconPants if you need help completing this template.
|
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
---
|
||||||
|
name: Issue
|
||||||
|
about: Report a problem or something that's not working
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**Steps to reproduce**
|
||||||
|
1. What were you doing when the bug occurred?
|
||||||
|
2. What steps can recreate the issue?
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Environment (if relevant)**
|
||||||
|
- Model(s) used:
|
||||||
|
- Agentic IDE used:
|
||||||
|
- BMad version:
|
||||||
|
- Project language:
|
||||||
|
|
||||||
|
**Screenshots or links**
|
||||||
|
If applicable, add screenshots or links to help explain the problem.
|
||||||
|
|
||||||
|
**PR**
|
||||||
|
If you'd like to contribute a fix, please indicate you're working on it or link to your PR. See [CONTRIBUTING.md](../../CONTRIBUTING.md) — contributions are always welcome!
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here. The more information you provide, the easier it is to help.
|
||||||
|
|
@ -1,329 +0,0 @@
|
||||||
name: Publish Latest Bundles
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch: {}
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
bundle-and-publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout BMAD-METHOD
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: ".nvmrc"
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Generate bundles
|
|
||||||
run: npm run bundle
|
|
||||||
|
|
||||||
- name: Create bundle distribution structure
|
|
||||||
run: |
|
|
||||||
mkdir -p dist/bundles
|
|
||||||
|
|
||||||
# Copy web bundles (XML files from npm run bundle output)
|
|
||||||
cp -r web-bundles/* dist/bundles/ 2>/dev/null || true
|
|
||||||
|
|
||||||
# Verify bundles were copied (fail if completely empty)
|
|
||||||
if [ ! "$(ls -A dist/bundles)" ]; then
|
|
||||||
echo "❌ ERROR: No bundles found in dist/bundles/"
|
|
||||||
echo "This likely means 'npm run bundle' failed or bundles weren't generated"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Count bundles per module
|
|
||||||
for module in bmm bmb cis bmgd; do
|
|
||||||
if [ -d "dist/bundles/$module/agents" ]; then
|
|
||||||
COUNT=$(find dist/bundles/$module/agents -name '*.xml' 2>/dev/null | wc -l)
|
|
||||||
echo "✅ $module: $COUNT agent bundles"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Generate index.html for each agents directory (fixes directory browsing)
|
|
||||||
for module in bmm bmb cis bmgd; do
|
|
||||||
if [ -d "dist/bundles/$module/agents" ]; then
|
|
||||||
cat > "dist/bundles/$module/agents/index.html" << 'DIREOF'
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>MODULE_NAME Agents</title>
|
|
||||||
<style>
|
|
||||||
body { font-family: system-ui; max-width: 800px; margin: 50px auto; padding: 20px; }
|
|
||||||
li { margin: 10px 0; }
|
|
||||||
a { color: #0066cc; text-decoration: none; }
|
|
||||||
a:hover { text-decoration: underline; }
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<h1>MODULE_NAME Agents</h1>
|
|
||||||
<ul>
|
|
||||||
AGENT_LINKS
|
|
||||||
</ul>
|
|
||||||
<p><a href="../../">← Back to all modules</a></p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
DIREOF
|
|
||||||
|
|
||||||
# Replace MODULE_NAME
|
|
||||||
sed -i "s/MODULE_NAME/${module^^}/g" "dist/bundles/$module/agents/index.html"
|
|
||||||
|
|
||||||
# Generate agent links
|
|
||||||
LINKS=""
|
|
||||||
for file in dist/bundles/$module/agents/*.xml; do
|
|
||||||
if [ -f "$file" ]; then
|
|
||||||
name=$(basename "$file" .xml)
|
|
||||||
LINKS="$LINKS <li><a href=\"./$name.xml\">$name</a></li>\n"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
sed -i "s|AGENT_LINKS|$LINKS|" "dist/bundles/$module/agents/index.html"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Create zip archives per module
|
|
||||||
mkdir -p dist/bundles/downloads
|
|
||||||
for module in bmm bmb cis bmgd; do
|
|
||||||
if [ -d "dist/bundles/$module" ]; then
|
|
||||||
(cd dist/bundles && zip -r downloads/$module-agents.zip $module/)
|
|
||||||
echo "✅ Created $module-agents.zip"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Generate index.html dynamically based on actual bundles
|
|
||||||
TIMESTAMP=$(date -u +"%Y-%m-%d %H:%M UTC")
|
|
||||||
COMMIT_SHA=$(git rev-parse --short HEAD)
|
|
||||||
|
|
||||||
# Function to generate agent links for a module
|
|
||||||
generate_agent_links() {
|
|
||||||
local module=$1
|
|
||||||
local agent_dir="dist/bundles/$module/agents"
|
|
||||||
|
|
||||||
if [ ! -d "$agent_dir" ]; then
|
|
||||||
echo ""
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
local links=""
|
|
||||||
local count=0
|
|
||||||
|
|
||||||
# Find all XML files and generate links
|
|
||||||
for xml_file in "$agent_dir"/*.xml; do
|
|
||||||
if [ -f "$xml_file" ]; then
|
|
||||||
local agent_name=$(basename "$xml_file" .xml)
|
|
||||||
# Convert filename to display name (pm -> PM, tech-writer -> Tech Writer)
|
|
||||||
local display_name=$(echo "$agent_name" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++) {if(length($i)==2) $i=toupper($i); else $i=toupper(substr($i,1,1)) tolower(substr($i,2));}}1')
|
|
||||||
|
|
||||||
if [ $count -gt 0 ]; then
|
|
||||||
links="$links | "
|
|
||||||
fi
|
|
||||||
links="$links<a href=\"./$module/agents/$agent_name.xml\">$display_name</a>"
|
|
||||||
count=$((count + 1))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "$links"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Generate agent links for each module
|
|
||||||
BMM_LINKS=$(generate_agent_links "bmm")
|
|
||||||
CIS_LINKS=$(generate_agent_links "cis")
|
|
||||||
BMGD_LINKS=$(generate_agent_links "bmgd")
|
|
||||||
|
|
||||||
# Count agents for bulk downloads
|
|
||||||
BMM_COUNT=$(find dist/bundles/bmm/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
|
||||||
CIS_COUNT=$(find dist/bundles/cis/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
|
||||||
BMGD_COUNT=$(find dist/bundles/bmgd/agents -name '*.xml' 2>/dev/null | wc -l | tr -d ' ')
|
|
||||||
|
|
||||||
# Create index.html
|
|
||||||
cat > dist/bundles/index.html << EOF
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>BMAD Bundles - Latest</title>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<style>
|
|
||||||
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; max-width: 800px; margin: 50px auto; padding: 20px; }
|
|
||||||
h1 { color: #333; }
|
|
||||||
.platform { margin: 30px 0; padding: 20px; background: #f5f5f5; border-radius: 8px; }
|
|
||||||
.module { margin: 15px 0; }
|
|
||||||
a { color: #0066cc; text-decoration: none; }
|
|
||||||
a:hover { text-decoration: underline; }
|
|
||||||
code { background: #e0e0e0; padding: 2px 6px; border-radius: 3px; }
|
|
||||||
.warning { background: #fff3cd; padding: 15px; border-left: 4px solid #ffc107; margin: 20px 0; }
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<h1>BMAD Web Bundles - Latest (Main Branch)</h1>
|
|
||||||
|
|
||||||
<div class="warning">
|
|
||||||
<strong>⚠️ Latest Build (Unstable)</strong><br>
|
|
||||||
These bundles are built from the latest main branch commit. For stable releases, visit
|
|
||||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD/releases/latest">GitHub Releases</a>.
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p><strong>Last Updated:</strong> <code>$TIMESTAMP</code></p>
|
|
||||||
<p><strong>Commit:</strong> <code>$COMMIT_SHA</code></p>
|
|
||||||
|
|
||||||
<h2>Available Modules</h2>
|
|
||||||
|
|
||||||
EOF
|
|
||||||
|
|
||||||
# Add BMM section if agents exist
|
|
||||||
if [ -n "$BMM_LINKS" ]; then
|
|
||||||
cat >> dist/bundles/index.html << EOF
|
|
||||||
<div class="platform">
|
|
||||||
<h3>BMM (BMad Method)</h3>
|
|
||||||
<div class="module">
|
|
||||||
$BMM_LINKS<br>
|
|
||||||
📁 <a href="./bmm/agents/">Browse All</a> | 📦 <a href="./downloads/bmm-agents.zip">Download Zip</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
EOF
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Add CIS section if agents exist
|
|
||||||
if [ -n "$CIS_LINKS" ]; then
|
|
||||||
cat >> dist/bundles/index.html << EOF
|
|
||||||
<div class="platform">
|
|
||||||
<h3>CIS (Creative Intelligence Suite)</h3>
|
|
||||||
<div class="module">
|
|
||||||
$CIS_LINKS<br>
|
|
||||||
📁 <a href="./cis/agents/">Browse Agents</a> | 📦 <a href="./downloads/cis-agents.zip">Download Zip</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
EOF
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Add BMGD section if agents exist
|
|
||||||
if [ -n "$BMGD_LINKS" ]; then
|
|
||||||
cat >> dist/bundles/index.html << EOF
|
|
||||||
<div class="platform">
|
|
||||||
<h3>BMGD (Game Development)</h3>
|
|
||||||
<div class="module">
|
|
||||||
$BMGD_LINKS<br>
|
|
||||||
📁 <a href="./bmgd/agents/">Browse Agents</a> | 📦 <a href="./downloads/bmgd-agents.zip">Download Zip</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
EOF
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Add bulk downloads section
|
|
||||||
cat >> dist/bundles/index.html << EOF
|
|
||||||
<h2>Bulk Downloads</h2>
|
|
||||||
<p>Download all agents for a module as a zip archive:</p>
|
|
||||||
<ul>
|
|
||||||
EOF
|
|
||||||
|
|
||||||
[ "$BMM_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/bmm-agents.zip\">📦 BMM Agents (all $BMM_COUNT)</a></li>" >> dist/bundles/index.html
|
|
||||||
[ "$CIS_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/cis-agents.zip\">📦 CIS Agents (all $CIS_COUNT)</a></li>" >> dist/bundles/index.html
|
|
||||||
[ "$BMGD_COUNT" -gt 0 ] && echo " <li><a href=\"./downloads/bmgd-agents.zip\">📦 BMGD Agents (all $BMGD_COUNT)</a></li>" >> dist/bundles/index.html
|
|
||||||
|
|
||||||
# Close HTML
|
|
||||||
cat >> dist/bundles/index.html << 'EOF'
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<h2>Usage</h2>
|
|
||||||
<p>Copy the raw XML URL and paste into your AI platform's custom instructions or project knowledge.</p>
|
|
||||||
<p>Example: <code>https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/pm.xml</code></p>
|
|
||||||
|
|
||||||
<h2>Installation (Recommended)</h2>
|
|
||||||
<p>For full IDE integration with slash commands, use the installer:</p>
|
|
||||||
<pre>npx bmad-method@alpha install</pre>
|
|
||||||
|
|
||||||
<footer style="margin-top: 50px; padding-top: 20px; border-top: 1px solid #ccc; color: #666;">
|
|
||||||
<p>Built from <a href="https://github.com/bmad-code-org/BMAD-METHOD">BMAD-METHOD</a> repository.</p>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
EOF
|
|
||||||
|
|
||||||
- name: Checkout bmad-bundles repo
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
repository: bmad-code-org/bmad-bundles
|
|
||||||
path: bmad-bundles
|
|
||||||
token: ${{ secrets.BUNDLES_PAT }}
|
|
||||||
|
|
||||||
- name: Update bundles
|
|
||||||
run: |
|
|
||||||
# Clear old bundles
|
|
||||||
rm -rf bmad-bundles/*
|
|
||||||
|
|
||||||
# Copy new bundles
|
|
||||||
cp -r dist/bundles/* bmad-bundles/
|
|
||||||
|
|
||||||
# Create .nojekyll for GitHub Pages
|
|
||||||
touch bmad-bundles/.nojekyll
|
|
||||||
|
|
||||||
# Create README
|
|
||||||
cat > bmad-bundles/README.md << 'EOF'
|
|
||||||
# BMAD Web Bundles (Latest)
|
|
||||||
|
|
||||||
**⚠️ Unstable Build**: These bundles are auto-generated from the latest `main` branch.
|
|
||||||
|
|
||||||
For stable releases, visit [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases/latest).
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Copy raw markdown URLs for use in AI platforms:
|
|
||||||
|
|
||||||
- Claude Code: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/claude-code/sub-agents/{agent}.md`
|
|
||||||
- ChatGPT: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/chatgpt/sub-agents/{agent}.md`
|
|
||||||
- Gemini: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/gemini/sub-agents/{agent}.md`
|
|
||||||
|
|
||||||
## Browse
|
|
||||||
|
|
||||||
Visit [https://bmad-code-org.github.io/bmad-bundles/](https://bmad-code-org.github.io/bmad-bundles/) to browse bundles.
|
|
||||||
|
|
||||||
## Installation (Recommended)
|
|
||||||
|
|
||||||
For full IDE integration:
|
|
||||||
```bash
|
|
||||||
npx bmad-method@alpha install
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Auto-updated by [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) on every main branch merge.
|
|
||||||
EOF
|
|
||||||
|
|
||||||
- name: Commit and push to bmad-bundles
|
|
||||||
run: |
|
|
||||||
cd bmad-bundles
|
|
||||||
git config user.name "github-actions[bot]"
|
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
||||||
|
|
||||||
git add .
|
|
||||||
|
|
||||||
if git diff --staged --quiet; then
|
|
||||||
echo "No changes to bundles, skipping commit"
|
|
||||||
else
|
|
||||||
COMMIT_SHA=$(cd .. && git rev-parse --short HEAD)
|
|
||||||
git commit -m "Update bundles from BMAD-METHOD@${COMMIT_SHA}"
|
|
||||||
git push
|
|
||||||
echo "✅ Bundles published to GitHub Pages"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Summary
|
|
||||||
run: |
|
|
||||||
echo "## 🎉 Bundles Published!" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "**Latest bundles** available at:" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "- 🌐 Browse: https://bmad-code-org.github.io/bmad-bundles/" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "- 📦 Raw files: https://github.com/bmad-code-org/bmad-bundles" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "**Commit**: ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY
|
|
||||||
|
|
@ -2,19 +2,9 @@ name: Discord Notification
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
types: [opened, closed, reopened, ready_for_review]
|
types: [opened, closed]
|
||||||
release:
|
|
||||||
types: [published]
|
|
||||||
create:
|
|
||||||
delete:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
pull_request_review:
|
|
||||||
types: [submitted]
|
|
||||||
pull_request_review_comment:
|
|
||||||
types: [created]
|
|
||||||
issues:
|
issues:
|
||||||
types: [opened, closed, reopened]
|
types: [opened]
|
||||||
|
|
||||||
env:
|
env:
|
||||||
MAX_TITLE: 100
|
MAX_TITLE: 100
|
||||||
|
|
@ -47,9 +37,7 @@ jobs:
|
||||||
|
|
||||||
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
|
if [ "$ACTION" = "opened" ]; then ICON="🔀"; LABEL="New PR"
|
||||||
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
|
elif [ "$ACTION" = "closed" ] && [ "$MERGED" = "true" ]; then ICON="🎉"; LABEL="Merged"
|
||||||
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"
|
elif [ "$ACTION" = "closed" ]; then ICON="❌"; LABEL="Closed"; fi
|
||||||
elif [ "$ACTION" = "reopened" ]; then ICON="🔄"; LABEL="Reopened"
|
|
||||||
else ICON="📋"; LABEL="Ready"; fi
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
||||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||||
|
|
@ -77,22 +65,16 @@ jobs:
|
||||||
- name: Notify Discord
|
- name: Notify Discord
|
||||||
env:
|
env:
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||||
ACTION: ${{ github.event.action }}
|
|
||||||
ISSUE_NUM: ${{ github.event.issue.number }}
|
ISSUE_NUM: ${{ github.event.issue.number }}
|
||||||
ISSUE_URL: ${{ github.event.issue.html_url }}
|
ISSUE_URL: ${{ github.event.issue.html_url }}
|
||||||
ISSUE_TITLE: ${{ github.event.issue.title }}
|
ISSUE_TITLE: ${{ github.event.issue.title }}
|
||||||
ISSUE_USER: ${{ github.event.issue.user.login }}
|
ISSUE_USER: ${{ github.event.issue.user.login }}
|
||||||
ISSUE_BODY: ${{ github.event.issue.body }}
|
ISSUE_BODY: ${{ github.event.issue.body }}
|
||||||
ACTOR: ${{ github.actor }}
|
|
||||||
run: |
|
run: |
|
||||||
set -o pipefail
|
set -o pipefail
|
||||||
source .github/scripts/discord-helpers.sh
|
source .github/scripts/discord-helpers.sh
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
[ -z "$WEBHOOK" ] && exit 0
|
||||||
|
|
||||||
if [ "$ACTION" = "opened" ]; then ICON="🐛"; LABEL="New Issue"; USER="$ISSUE_USER"
|
|
||||||
elif [ "$ACTION" = "closed" ]; then ICON="✅"; LABEL="Closed"; USER="$ACTOR"
|
|
||||||
else ICON="🔄"; LABEL="Reopened"; USER="$ACTOR"; fi
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
||||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
||||||
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
BODY=$(printf '%s' "$ISSUE_BODY" | trunc $MAX_BODY)
|
||||||
|
|
@ -102,209 +84,7 @@ jobs:
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
||||||
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
[ -n "$ISSUE_BODY" ] && [ ${#ISSUE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
||||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
[ -n "$BODY" ] && BODY=" · $BODY"
|
||||||
USER=$(printf '%s' "$USER" | esc)
|
USER=$(printf '%s' "$ISSUE_USER" | esc)
|
||||||
|
|
||||||
MSG="$ICON **[$LABEL #$ISSUE_NUM: $TITLE](<$ISSUE_URL>)**"$'\n'"by @$USER$BODY"
|
MSG="🐛 **[Issue #$ISSUE_NUM: $TITLE](<$ISSUE_URL>)**"$'\n'"by @$USER$BODY"
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
issue_comment:
|
|
||||||
if: github.event_name == 'issue_comment'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.repository.default_branch }}
|
|
||||||
sparse-checkout: .github/scripts
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
IS_PR: ${{ github.event.issue.pull_request && 'true' || 'false' }}
|
|
||||||
ISSUE_NUM: ${{ github.event.issue.number }}
|
|
||||||
ISSUE_TITLE: ${{ github.event.issue.title }}
|
|
||||||
COMMENT_URL: ${{ github.event.comment.html_url }}
|
|
||||||
COMMENT_USER: ${{ github.event.comment.user.login }}
|
|
||||||
COMMENT_BODY: ${{ github.event.comment.body }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
source .github/scripts/discord-helpers.sh
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
|
|
||||||
[ "$IS_PR" = "true" ] && TYPE="PR" || TYPE="Issue"
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$ISSUE_TITLE" | trunc $MAX_TITLE | esc)
|
|
||||||
[ ${#ISSUE_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
|
||||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
|
||||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
|
||||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
|
||||||
fi
|
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
|
||||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
|
||||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
|
||||||
|
|
||||||
MSG="💬 **[Comment on $TYPE #$ISSUE_NUM: $TITLE](<$COMMENT_URL>)**"$'\n'"@$USER: $BODY"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
pull_request_review:
|
|
||||||
if: github.event_name == 'pull_request_review'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.repository.default_branch }}
|
|
||||||
sparse-checkout: .github/scripts
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
STATE: ${{ github.event.review.state }}
|
|
||||||
PR_NUM: ${{ github.event.pull_request.number }}
|
|
||||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
|
||||||
REVIEW_URL: ${{ github.event.review.html_url }}
|
|
||||||
REVIEW_USER: ${{ github.event.review.user.login }}
|
|
||||||
REVIEW_BODY: ${{ github.event.review.body }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
source .github/scripts/discord-helpers.sh
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
|
|
||||||
if [ "$STATE" = "approved" ]; then ICON="✅"; LABEL="Approved"
|
|
||||||
elif [ "$STATE" = "changes_requested" ]; then ICON="🔧"; LABEL="Changes Requested"
|
|
||||||
else ICON="👀"; LABEL="Reviewed"; fi
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
|
||||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
|
||||||
BODY=$(printf '%s' "$REVIEW_BODY" | trunc $MAX_BODY)
|
|
||||||
if [ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ]; then
|
|
||||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
|
||||||
fi
|
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
|
||||||
[ -n "$REVIEW_BODY" ] && [ ${#REVIEW_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
|
||||||
[ -n "$BODY" ] && BODY=": $BODY"
|
|
||||||
USER=$(printf '%s' "$REVIEW_USER" | esc)
|
|
||||||
|
|
||||||
MSG="$ICON **[$LABEL PR #$PR_NUM: $TITLE](<$REVIEW_URL>)**"$'\n'"@$USER$BODY"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
pull_request_review_comment:
|
|
||||||
if: github.event_name == 'pull_request_review_comment'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.repository.default_branch }}
|
|
||||||
sparse-checkout: .github/scripts
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
PR_NUM: ${{ github.event.pull_request.number }}
|
|
||||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
|
||||||
COMMENT_URL: ${{ github.event.comment.html_url }}
|
|
||||||
COMMENT_USER: ${{ github.event.comment.user.login }}
|
|
||||||
COMMENT_BODY: ${{ github.event.comment.body }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
source .github/scripts/discord-helpers.sh
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
|
|
||||||
TITLE=$(printf '%s' "$PR_TITLE" | trunc $MAX_TITLE | esc)
|
|
||||||
[ ${#PR_TITLE} -gt $MAX_TITLE ] && TITLE="${TITLE}..."
|
|
||||||
BODY=$(printf '%s' "$COMMENT_BODY" | trunc $MAX_BODY)
|
|
||||||
if [ ${#COMMENT_BODY} -gt $MAX_BODY ]; then
|
|
||||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
|
||||||
fi
|
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
|
||||||
[ ${#COMMENT_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
|
||||||
USER=$(printf '%s' "$COMMENT_USER" | esc)
|
|
||||||
|
|
||||||
MSG="💭 **[Review Comment PR #$PR_NUM: $TITLE](<$COMMENT_URL>)**"$'\n'"@$USER: $BODY"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
release:
|
|
||||||
if: github.event_name == 'release'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.repository.default_branch }}
|
|
||||||
sparse-checkout: .github/scripts
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
TAG: ${{ github.event.release.tag_name }}
|
|
||||||
NAME: ${{ github.event.release.name }}
|
|
||||||
URL: ${{ github.event.release.html_url }}
|
|
||||||
RELEASE_BODY: ${{ github.event.release.body }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
source .github/scripts/discord-helpers.sh
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
|
|
||||||
REL_NAME=$(printf '%s' "$NAME" | trunc $MAX_TITLE | esc)
|
|
||||||
[ ${#NAME} -gt $MAX_TITLE ] && REL_NAME="${REL_NAME}..."
|
|
||||||
BODY=$(printf '%s' "$RELEASE_BODY" | trunc $MAX_BODY)
|
|
||||||
if [ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ]; then
|
|
||||||
BODY=$(printf '%s' "$BODY" | strip_trailing_url)
|
|
||||||
fi
|
|
||||||
BODY=$(printf '%s' "$BODY" | wrap_urls | esc)
|
|
||||||
[ -n "$RELEASE_BODY" ] && [ ${#RELEASE_BODY} -gt $MAX_BODY ] && BODY="${BODY}..."
|
|
||||||
[ -n "$BODY" ] && BODY=" · $BODY"
|
|
||||||
TAG_ESC=$(printf '%s' "$TAG" | esc)
|
|
||||||
|
|
||||||
MSG="🚀 **[Release $TAG_ESC: $REL_NAME](<$URL>)**"$'\n'"$BODY"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
create:
|
|
||||||
if: github.event_name == 'create'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.repository.default_branch }}
|
|
||||||
sparse-checkout: .github/scripts
|
|
||||||
sparse-checkout-cone-mode: false
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
REF_TYPE: ${{ github.event.ref_type }}
|
|
||||||
REF: ${{ github.event.ref }}
|
|
||||||
ACTOR: ${{ github.actor }}
|
|
||||||
REPO_URL: ${{ github.event.repository.html_url }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
source .github/scripts/discord-helpers.sh
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
|
|
||||||
[ "$REF_TYPE" = "branch" ] && ICON="🌿" || ICON="🏷️"
|
|
||||||
REF_TRUNC=$(printf '%s' "$REF" | trunc $MAX_TITLE)
|
|
||||||
[ ${#REF} -gt $MAX_TITLE ] && REF_TRUNC="${REF_TRUNC}..."
|
|
||||||
REF_ESC=$(printf '%s' "$REF_TRUNC" | esc)
|
|
||||||
REF_URL=$(jq -rn --arg ref "$REF" '$ref | @uri')
|
|
||||||
ACTOR_ESC=$(printf '%s' "$ACTOR" | esc)
|
|
||||||
MSG="$ICON **${REF_TYPE^} created: [$REF_ESC](<$REPO_URL/tree/$REF_URL>)** by @$ACTOR_ESC"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
|
||||||
|
|
||||||
delete:
|
|
||||||
if: github.event_name == 'delete'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Notify Discord
|
|
||||||
env:
|
|
||||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
REF_TYPE: ${{ github.event.ref_type }}
|
|
||||||
REF: ${{ github.event.ref }}
|
|
||||||
ACTOR: ${{ github.actor }}
|
|
||||||
run: |
|
|
||||||
set -o pipefail
|
|
||||||
[ -z "$WEBHOOK" ] && exit 0
|
|
||||||
esc() { sed -e 's/[][\*_()~`]/\\&/g' -e 's/@/@ /g'; }
|
|
||||||
trunc() { tr '\n\r' ' ' | cut -c1-"$1"; }
|
|
||||||
|
|
||||||
REF_TRUNC=$(printf '%s' "$REF" | trunc 100)
|
|
||||||
[ ${#REF} -gt 100 ] && REF_TRUNC="${REF_TRUNC}..."
|
|
||||||
REF_ESC=$(printf '%s' "$REF_TRUNC" | esc)
|
|
||||||
ACTOR_ESC=$(printf '%s' "$ACTOR" | esc)
|
|
||||||
MSG="🗑️ **${REF_TYPE^} deleted: $REF_ESC** by @$ACTOR_ESC"
|
|
||||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||||
|
|
|
||||||
|
|
@ -6,11 +6,11 @@ on:
|
||||||
version_bump:
|
version_bump:
|
||||||
description: Version bump type
|
description: Version bump type
|
||||||
required: true
|
required: true
|
||||||
default: alpha
|
default: beta
|
||||||
type: choice
|
type: choice
|
||||||
options:
|
options:
|
||||||
- alpha
|
|
||||||
- beta
|
- beta
|
||||||
|
- alpha
|
||||||
- patch
|
- patch
|
||||||
- minor
|
- minor
|
||||||
- major
|
- major
|
||||||
|
|
@ -158,9 +158,12 @@ jobs:
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
VERSION="${{ steps.version.outputs.new_version }}"
|
VERSION="${{ steps.version.outputs.new_version }}"
|
||||||
if [[ "$VERSION" == *"alpha"* ]] || [[ "$VERSION" == *"beta"* ]]; then
|
if [[ "$VERSION" == *"alpha"* ]]; then
|
||||||
echo "Publishing prerelease version with --tag alpha"
|
echo "Publishing alpha prerelease version with --tag alpha"
|
||||||
npm publish --tag alpha
|
npm publish --tag alpha
|
||||||
|
elif [[ "$VERSION" == *"beta"* ]]; then
|
||||||
|
echo "Publishing beta prerelease version with --tag latest"
|
||||||
|
npm publish --tag latest
|
||||||
else
|
else
|
||||||
echo "Publishing stable version with --tag latest"
|
echo "Publishing stable version with --tag latest"
|
||||||
npm publish --tag latest
|
npm publish --tag latest
|
||||||
|
|
|
||||||
|
|
@ -69,6 +69,27 @@ jobs:
|
||||||
- name: markdownlint
|
- name: markdownlint
|
||||||
run: npm run lint:md
|
run: npm run lint:md
|
||||||
|
|
||||||
|
docs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: ".nvmrc"
|
||||||
|
cache: "npm"
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Validate documentation links
|
||||||
|
run: npm run docs:validate-links
|
||||||
|
|
||||||
|
- name: Build documentation
|
||||||
|
run: npm run docs:build
|
||||||
|
|
||||||
validate:
|
validate:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
@ -92,3 +113,6 @@ jobs:
|
||||||
|
|
||||||
- name: Test agent compilation components
|
- name: Test agent compilation components
|
||||||
run: npm run test:install
|
run: npm run test:install
|
||||||
|
|
||||||
|
- name: Validate file references
|
||||||
|
run: npm run validate:refs
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,11 @@
|
||||||
# Dependencies
|
# Dependencies
|
||||||
node_modules/
|
**/node_modules/
|
||||||
pnpm-lock.yaml
|
pnpm-lock.yaml
|
||||||
bun.lock
|
bun.lock
|
||||||
deno.lock
|
deno.lock
|
||||||
pnpm-workspace.yaml
|
pnpm-workspace.yaml
|
||||||
package-lock.json
|
package-lock.json
|
||||||
|
|
||||||
|
|
||||||
test-output/*
|
test-output/*
|
||||||
coverage/
|
coverage/
|
||||||
|
|
||||||
|
|
@ -28,11 +27,6 @@ Thumbs.db
|
||||||
# Development tools and configs
|
# Development tools and configs
|
||||||
.prettierrc
|
.prettierrc
|
||||||
|
|
||||||
# IDE and editor configs
|
|
||||||
.windsurf/
|
|
||||||
.trae/
|
|
||||||
_bmad*/.cursor/
|
|
||||||
|
|
||||||
# AI assistant files
|
# AI assistant files
|
||||||
CLAUDE.md
|
CLAUDE.md
|
||||||
.ai/*
|
.ai/*
|
||||||
|
|
@ -43,37 +37,30 @@ CLAUDE.local.md
|
||||||
.serena/
|
.serena/
|
||||||
.claude/settings.local.json
|
.claude/settings.local.json
|
||||||
|
|
||||||
# Project-specific
|
|
||||||
_bmad-core
|
|
||||||
_bmad-creator-tools
|
|
||||||
flattened-codebase.xml
|
|
||||||
*.stats.md
|
|
||||||
.internal-docs/
|
|
||||||
#UAT template testing output files
|
|
||||||
tools/template-test-generator/test-scenarios/
|
|
||||||
|
|
||||||
# Bundler temporary files and generated bundles
|
|
||||||
.bundler-temp/
|
|
||||||
|
|
||||||
# Generated web bundles (built by CI, not committed)
|
|
||||||
src/modules/bmm/sub-modules/
|
|
||||||
src/modules/bmb/sub-modules/
|
|
||||||
src/modules/cis/sub-modules/
|
|
||||||
src/modules/bmgd/sub-modules/
|
|
||||||
shared-modules
|
|
||||||
z*/
|
z*/
|
||||||
|
|
||||||
_bmad
|
_bmad
|
||||||
_bmad-output
|
_bmad-output
|
||||||
.claude
|
.clinerules
|
||||||
|
.augment
|
||||||
|
.crush
|
||||||
|
.cursor
|
||||||
|
.iflow
|
||||||
|
.opencode
|
||||||
|
.qwen
|
||||||
|
.rovodev
|
||||||
|
.kilocodemodes
|
||||||
|
.claude/commands
|
||||||
.codex
|
.codex
|
||||||
.github/chatmodes
|
.github/chatmodes
|
||||||
|
.github/agents
|
||||||
.agent
|
.agent
|
||||||
.agentvibes/
|
.agentvibes
|
||||||
.kiro/
|
.kiro
|
||||||
.roo
|
.roo
|
||||||
|
.trae
|
||||||
|
.windsurf
|
||||||
|
|
||||||
bmad-custom-src/
|
|
||||||
|
|
||||||
# Astro / Documentation Build
|
# Astro / Documentation Build
|
||||||
website/.astro/
|
website/.astro/
|
||||||
|
|
|
||||||
|
|
@ -5,3 +5,16 @@ npx --no-install lint-staged
|
||||||
|
|
||||||
# Validate everything
|
# Validate everything
|
||||||
npm test
|
npm test
|
||||||
|
|
||||||
|
# Validate docs links only when docs change
|
||||||
|
if command -v rg >/dev/null 2>&1; then
|
||||||
|
if git diff --cached --name-only | rg -q '^docs/'; then
|
||||||
|
npm run docs:validate-links
|
||||||
|
npm run docs:build
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
if git diff --cached --name-only | grep -Eq '^docs/'; then
|
||||||
|
npm run docs:validate-links
|
||||||
|
npm run docs:build
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
# https://github.com/DavidAnson/markdownlint-cli2
|
# https://github.com/DavidAnson/markdownlint-cli2
|
||||||
|
|
||||||
ignores:
|
ignores:
|
||||||
- node_modules/**
|
- "**/node_modules/**"
|
||||||
- test/fixtures/**
|
- test/fixtures/**
|
||||||
- CODE_OF_CONDUCT.md
|
- CODE_OF_CONDUCT.md
|
||||||
- _bmad/**
|
- _bmad/**
|
||||||
|
|
@ -11,7 +11,6 @@ ignores:
|
||||||
- .claude/**
|
- .claude/**
|
||||||
- .roo/**
|
- .roo/**
|
||||||
- .codex/**
|
- .codex/**
|
||||||
- .agentvibes/**
|
|
||||||
- .kiro/**
|
- .kiro/**
|
||||||
- sample-project/**
|
- sample-project/**
|
||||||
- test-project-install/**
|
- test-project-install/**
|
||||||
|
|
|
||||||
6
.npmrc
6
.npmrc
|
|
@ -1 +1,5 @@
|
||||||
registry=https://registry.npmjs.org
|
# Prevent peer dependency warnings during installation
|
||||||
|
legacy-peer-deps=true
|
||||||
|
|
||||||
|
# Improve install performance
|
||||||
|
prefer-offline=true
|
||||||
|
|
|
||||||
162
CHANGELOG.md
162
CHANGELOG.md
|
|
@ -1,5 +1,167 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [6.0.0-Beta.5]
|
||||||
|
|
||||||
|
### 🎁 Features
|
||||||
|
|
||||||
|
* **Add generate-project-context workflow** — New 3-step workflow for project context generation, integrated with quick-flow-solo-dev agent
|
||||||
|
* **Shard market research customer analysis** — Refactor monolithic customer insights into 4-step detailed customer behavior analysis workflow
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
* **Fix npm install peer dependency issues** — Add `.npmrc` with `legacy-peer-deps=true`, update Starlight to 0.37.5, and add `--legacy-peer-deps` flag to module installer (PR #1476)
|
||||||
|
* **Fix leaked source paths in PRD validation report** — Replace absolute `/src/core/` paths with `{project-root}/_bmad/core/` (#1481)
|
||||||
|
* **Fix orphaned market research customer analysis** — Connect step-01-init to step-02-customer-behavior to complete workflow sharding (#1486)
|
||||||
|
* **Fix duplicate 2-letter brainstorming code** — Change BS to BSP to resolve conflict with cis Brainstorming module
|
||||||
|
* **Fix tech writer sidecar functionality** — Enable proper sidecar operation (#1487)
|
||||||
|
* **Fix relative paths in workflow steps** — Correct paths in step-11-polish (#1497) and step-e-04-complete (#1498)
|
||||||
|
* **Fix party-mode workflow file extension** — Correct extension in workflow.xml (#1499)
|
||||||
|
* **Fix generated slash commands** — Add `disable-model-invocation` to all generated commands (#1501)
|
||||||
|
* **Fix agent scan and help CSV files** — Correct module-help.csv entries
|
||||||
|
* **Fix HELP_STEP placeholder replacement** — Fix placeholder not replaced in compiled agents, fix hardcoded path, fix single quote (#1437)
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
* **Add exact slash commands to Getting Started guide** — Provide precise command examples for users (#1505)
|
||||||
|
* **Remove .claude/commands from version control** — Commands are generated, not tracked (#1506)
|
||||||
|
|
||||||
|
### 🔧 Maintenance
|
||||||
|
|
||||||
|
* **Update Starlight to 0.37.5** — Latest version with peer dependency compatibility
|
||||||
|
* **Add GitHub issue templates** — New bug-report.yaml and documentation.yaml templates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [6.0.0-Beta.4]
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- **Activation steps formatting fix**: Fixed missing opening quote that caused infrequent menu rendering issues
|
||||||
|
- **Custom module installation fix**: Added missing yaml require in manifest.js to fix custom module installation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [6.0.0-Beta.3]
|
||||||
|
|
||||||
|
### 🌟 Key Highlights
|
||||||
|
|
||||||
|
1. **SDET Module Replaces TEA**: TEA module removed from core, SDET module added with "automate" workflow for test automation
|
||||||
|
2. **Gemini CLI TOML Support**: IDE integration now supports the TOML config format used by Gemini CLI
|
||||||
|
3. **File System Sprint Status**: Default project_key support for file-system based sprint status tracking
|
||||||
|
|
||||||
|
### 🔧 Features & Improvements
|
||||||
|
|
||||||
|
**Module Changes:**
|
||||||
|
- **TEA Module Moved to External** (#1430, #1443): The TEA module is now external. SDET module added with a single "automate" workflow focused on test automation
|
||||||
|
- **SDET Module**: New module with streamlined test automation capabilities
|
||||||
|
|
||||||
|
**IDE Integration:**
|
||||||
|
- **Gemini CLI TOML Format** (#1431): Previous update accidentally switched Gemini to md instead of toml.
|
||||||
|
|
||||||
|
**Sprint Status:**
|
||||||
|
- **Default project_key** (#1446): File-system based sprint status now uses a default project_key so certain LLMs do not complain
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- **Quick-flow workflow path fix** (#1368): Fixed incorrect workflow_path in bmad-quick-flow/quick-spec steps (step-01, step-02, step-03) - changed from non-existent 'create-tech-spec' to correct 'quick-spec'
|
||||||
|
- **PRD edit flow paths**: Fixed path references in PRD editing workflow
|
||||||
|
- **Agent file handling**: Changes to prevent double agent files and use .agent.md file extensions
|
||||||
|
- **README link fix**: Corrected broken documentation links
|
||||||
|
|
||||||
|
## [6.0.0-Beta.2]
|
||||||
|
|
||||||
|
- Fix installer so commands match what is installed, centralize most ide into a central file instead of separate files for each ide.
|
||||||
|
- Specific IDEs may still need udpates, but all is config driven now and should be easier to maintain
|
||||||
|
- Kiro still needs updates, but its been in this state since contributed, will investigate soon
|
||||||
|
- Any version older than Beta.0 will recommend removal and reinstall to project. From later alphas though its sufficient to quick update if still desired, but best is just start fresh with Beta.
|
||||||
|
|
||||||
|
## [6.0.0-Beta.1]
|
||||||
|
|
||||||
|
**Release: January 2026 - Alpha to Beta Transition**
|
||||||
|
|
||||||
|
### 🎉 Beta Release
|
||||||
|
|
||||||
|
- **Transition from Alpha to Beta**: BMad Method is now in Beta! This marks a significant milestone in the framework's development
|
||||||
|
- **NPM Default Tag**: Beta versions are now published with the `latest` tag, making `npx bmad-method` serve the beta version by default
|
||||||
|
|
||||||
|
### 🌟 Key Highlights
|
||||||
|
|
||||||
|
1. **bmad-help**: Revolutionary AI-powered guidance system replaces the alpha workflow-init and workflow tracking — introduces full AI intelligence to guide users through workflows, commands, and project context
|
||||||
|
2. **Module Ecosystem Expansion**: bmad-builder, CIS (Creative Intelligence Suite), and Game Dev Studio moved to separate repositories for focused development
|
||||||
|
3. **Installer Consolidation**: Unified installer architecture with standardized command naming (`bmad-dash-case.md` or `bmad-*-agent-*.md`)
|
||||||
|
4. **Windows Compatibility**: Complete migration from Inquirer.js to @clack/prompts for reliable cross-platform support
|
||||||
|
|
||||||
|
### 🚀 Major Features
|
||||||
|
|
||||||
|
**bmad-help - Intelligent Guidance System:**
|
||||||
|
|
||||||
|
- **Replaces**: workflow-init and legacy workflow tracking
|
||||||
|
- **AI-Powered**: Full context awareness of installed modules, workflows, agents, and commands
|
||||||
|
- **Dynamic Discovery**: Automatically catalogs all available workflows from installed modules
|
||||||
|
- **Intelligent Routing**: Guides users to the right workflow or agent based on their goal
|
||||||
|
- **IDE Integration**: Generates proper IDE command files for all discovered workflows
|
||||||
|
|
||||||
|
**Module Restructuring:**
|
||||||
|
|
||||||
|
| Module | Status | New Location |
|
||||||
|
| ------------------------------------- | ------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| **bmad-builder** | Near beta, with docs and walkthroughs coming soon | `bmad-code-org/bmad-builder` |
|
||||||
|
| **CIS** (Creative Intelligence Suite) | Published as npm package | `bmad-code-org/bmad-module-creative-intelligence-suite` |
|
||||||
|
| **Game Dev Studio** | Published as npm package | `bmad-code-org/bmad-module-game-dev-studio` |
|
||||||
|
|
||||||
|
### 🔧 Installer & CLI Improvements
|
||||||
|
|
||||||
|
**UnifiedInstaller Architecture:**
|
||||||
|
|
||||||
|
- All IDE installers now use a common `UnifiedInstaller` class
|
||||||
|
- Standardized command naming conventions:
|
||||||
|
- Workflows: `bmad-module-workflow-name.md`
|
||||||
|
- Agents: `bmad-module-agent-name.md`
|
||||||
|
- Tasks: `bmad-task-name.md`
|
||||||
|
- Tools: `bmad-tool-name.md`
|
||||||
|
- External module installation from npm with progress indicators
|
||||||
|
- Module removal on unselect with confirmation
|
||||||
|
|
||||||
|
**Windows Compatibility Fix:**
|
||||||
|
|
||||||
|
- Replaced Inquirer.js with @clack/prompts to fix arrow key navigation issues on Windows
|
||||||
|
- All 91 installer workflows migrated to new prompt system
|
||||||
|
|
||||||
|
### 📚 Documentation Updates
|
||||||
|
|
||||||
|
**Significant docsite improvements:**
|
||||||
|
|
||||||
|
- Interactive workflow guide page (`/workflow-guide`) with track selector
|
||||||
|
- TEA documentation restructured using Diátaxis framework (25 docs)
|
||||||
|
- Style guide optimized for LLM readers (367 lines, down from 767)
|
||||||
|
- Glossary rewritten using table format (123 lines, down from 373)
|
||||||
|
- README overhaul with numbered command flows and prominent `/bmad-help` callout
|
||||||
|
- New workflow map diagram with interactive HTML
|
||||||
|
- New editorial review tasks for document quality
|
||||||
|
- E2E testing methodology for Game Dev Studio
|
||||||
|
|
||||||
|
More documentation updates coming soon.
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
|
||||||
|
- Fixed TodoMVC URL references to include `/dist/` path
|
||||||
|
- Fixed glob pattern normalization for Windows compatibility
|
||||||
|
- Fixed YAML indentation in kilo.js customInstructions field
|
||||||
|
- Fixed stale path references in check-implementation-readiness workflow
|
||||||
|
- Fixed sprint-status.yaml sync in correct-course workflow
|
||||||
|
- Fixed web bundler entry point reference
|
||||||
|
- Fixed mergeModuleHelpCatalogs ordering after generateManifests
|
||||||
|
|
||||||
|
### 📊 Statistics
|
||||||
|
|
||||||
|
- **91 commits** since alpha.23
|
||||||
|
- **969 files changed** (+23,716 / -91,509 lines)
|
||||||
|
- **Net reduction of ~67,793 lines** through cleanup and consolidation
|
||||||
|
- **3 major modules** moved to separate repositories
|
||||||
|
- **Complete installer refactor** for standardization
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [6.0.0-alpha.23]
|
## [6.0.0-alpha.23]
|
||||||
|
|
||||||
**Release: January 11, 2026**
|
**Release: January 11, 2026**
|
||||||
|
|
|
||||||
313
CONTRIBUTING.md
313
CONTRIBUTING.md
|
|
@ -1,268 +1,167 @@
|
||||||
# Contributing to BMad
|
# Contributing to BMad
|
||||||
|
|
||||||
Thank you for considering contributing to the BMad project! We believe in **Human Amplification, Not Replacement** - bringing out the best thinking in both humans and AI through guided collaboration.
|
Thank you for considering contributing! We believe in **Human Amplification, Not Replacement** — bringing out the best thinking in both humans and AI through guided collaboration.
|
||||||
|
|
||||||
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
|
💬 **Discord**: [Join our community](https://discord.gg/gk8jAdXWmj) for real-time discussions, questions, and collaboration.
|
||||||
|
|
||||||
- **#bmad-development** - Technical discussions and development questions
|
---
|
||||||
- **#suggestions-feedback** - Feature ideas and suggestions
|
|
||||||
- **#report-bugs-and-issues** - Bug reports and issue discussions
|
|
||||||
|
|
||||||
## Our Philosophy
|
## Our Philosophy
|
||||||
|
|
||||||
### BMad Core™: Universal Foundation
|
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
|
||||||
|
|
||||||
BMad Core empowers humans and AI agents working together in true partnership across any domain through our **C.O.R.E. Framework** (Collaboration Optimized Reflection Engine):
|
**✅ What we welcome:**
|
||||||
|
- Enhanced collaboration patterns and workflows
|
||||||
- **Collaboration**: Human-AI partnership where both contribute unique strengths
|
- Improved agent personas and prompts
|
||||||
- **Optimized**: The collaborative process refined for maximum effectiveness
|
- Domain-specific modules leveraging BMad Core
|
||||||
- **Reflection**: Guided thinking that helps discover better solutions and insights
|
- Better planning and context continuity
|
||||||
- **Engine**: The powerful framework that orchestrates specialized agents and workflows
|
|
||||||
|
|
||||||
### BMad Method™: Agile AI-Driven Development
|
|
||||||
|
|
||||||
The BMad Method is the flagship bmad module for agile AI-driven software development. It emphasizes thorough planning and solid architectural foundations to provide detailed context for developer agents, mirroring real-world agile best practices.
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
**Partnership Over Automation** - AI agents act as expert coaches, mentors, and collaborators who amplify human capability rather than replace it.
|
|
||||||
|
|
||||||
**Bidirectional Guidance** - Agents guide users through structured workflows while users push agents with advanced prompting. Both sides actively work to extract better information from each other.
|
|
||||||
|
|
||||||
**Systems of Workflows** - BMad Core builds comprehensive systems of guided workflows with specialized agent teams for any domain.
|
|
||||||
|
|
||||||
**Tool-Agnostic Foundation** - BMad Core remains tool-agnostic, providing stable, extensible groundwork that adapts to any domain.
|
|
||||||
|
|
||||||
## What Makes a Good Contribution?
|
|
||||||
|
|
||||||
Every contribution should strengthen human-AI collaboration. Ask yourself: **"Does this make humans and AI better together?"**
|
|
||||||
|
|
||||||
**✅ Contributions that align:**
|
|
||||||
|
|
||||||
- Enhance universal collaboration patterns
|
|
||||||
- Improve agent personas and workflows
|
|
||||||
- Strengthen planning and context continuity
|
|
||||||
- Increase cross-domain accessibility
|
|
||||||
- Add domain-specific modules leveraging BMad Core
|
|
||||||
|
|
||||||
**❌ What detracts from our mission:**
|
|
||||||
|
|
||||||
|
**❌ What doesn't fit:**
|
||||||
- Purely automated solutions that sideline humans
|
- Purely automated solutions that sideline humans
|
||||||
- Tools that don't improve the partnership
|
|
||||||
- Complexity that creates barriers to adoption
|
- Complexity that creates barriers to adoption
|
||||||
- Features that fragment BMad Core's foundation
|
- Features that fragment BMad Core's foundation
|
||||||
|
|
||||||
## Before You Contribute
|
---
|
||||||
|
|
||||||
### Reporting Bugs
|
## Reporting Issues
|
||||||
|
|
||||||
1. **Check existing issues** first to avoid duplicates
|
**ALL bug reports and feature requests MUST go through GitHub Issues.**
|
||||||
2. **Consider discussing in Discord** (#report-bugs-and-issues channel) for quick help
|
|
||||||
3. **Use the bug report template** when creating a new issue - it guides you through providing:
|
|
||||||
- Clear bug description
|
|
||||||
- Steps to reproduce
|
|
||||||
- Expected vs actual behavior
|
|
||||||
- Model/IDE/BMad version details
|
|
||||||
- Screenshots or links if applicable
|
|
||||||
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
|
||||||
|
|
||||||
### Suggesting Features or New Modules
|
### Before Creating an Issue
|
||||||
|
|
||||||
1. **Discuss first in Discord** (#suggestions-feedback channel) - the feature request template asks if you've done this
|
1. **Search existing issues** — Use the GitHub issue search to check if your bug or feature has already been reported
|
||||||
2. **Check existing issues and discussions** to avoid duplicates
|
2. **Search closed issues** — Your issue may have been fixed or addressed previously
|
||||||
3. **Use the feature request template** when creating an issue
|
3. **Check discussions** — Some conversations happen in [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
|
||||||
4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration
|
|
||||||
|
|
||||||
### Before Starting Work
|
### Bug Reports
|
||||||
|
|
||||||
|
After searching, if the bug is unreported, use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md) and include:
|
||||||
|
|
||||||
|
- Clear description of the problem
|
||||||
|
- Steps to reproduce
|
||||||
|
- Expected vs actual behavior
|
||||||
|
- Your environment (model, IDE, BMad version)
|
||||||
|
- Screenshots or error messages if applicable
|
||||||
|
|
||||||
|
### Feature Requests
|
||||||
|
|
||||||
|
After searching, use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) and explain:
|
||||||
|
|
||||||
|
- What the feature is
|
||||||
|
- Why it would benefit the BMad community
|
||||||
|
- How it strengthens human-AI collaboration
|
||||||
|
|
||||||
|
**For community modules**, review [TRADEMARK.md](TRADEMARK.md) for proper naming conventions (e.g., "My Module (BMad Community Module)").
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Before Starting Work
|
||||||
|
|
||||||
⚠️ **Required before submitting PRs:**
|
⚠️ **Required before submitting PRs:**
|
||||||
|
|
||||||
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
| Work Type | Requirement |
|
||||||
2. **For features**: Discuss in Discord (#suggestions-feedback) AND create a feature request issue
|
| ------------- | ---------------------------------------------- |
|
||||||
3. **For large changes**: Always open an issue first to discuss alignment
|
| Bug fix | An open issue (create one if it doesn't exist) |
|
||||||
|
| Feature | An open feature request issue |
|
||||||
|
| Large changes | Discussion via issue first |
|
||||||
|
|
||||||
Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes.
|
**Why?** This prevents wasted effort on work that may not align with project direction.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Pull Request Guidelines
|
## Pull Request Guidelines
|
||||||
|
|
||||||
### Which Branch?
|
### Target Branch
|
||||||
|
|
||||||
**Submit PR's to `main` branch** (critical only):
|
Submit PRs to the `main` branch.
|
||||||
|
|
||||||
- 🚨 Critical bug fixes that break basic functionality
|
### PR Size
|
||||||
- 🔒 Security patches
|
|
||||||
- 📚 Fixing dangerously incorrect documentation
|
|
||||||
- 🐛 Bugs preventing installation or basic usage
|
|
||||||
|
|
||||||
### PR Size Guidelines
|
- **Ideal**: 200-400 lines of code changes
|
||||||
|
- **Maximum**: 800 lines (excluding generated files)
|
||||||
|
- **One feature/fix per PR**
|
||||||
|
|
||||||
- **Ideal PR size**: 200-400 lines of code changes
|
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
||||||
- **Maximum PR size**: 800 lines (excluding generated files)
|
|
||||||
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
|
|
||||||
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
|
|
||||||
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
|
|
||||||
|
|
||||||
### Breaking Down Large PRs
|
### New to Pull Requests?
|
||||||
|
|
||||||
If your change exceeds 800 lines, use this checklist to split it:
|
1. **Fork** the repository
|
||||||
|
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
||||||
- [ ] Can I separate the refactoring from the feature implementation?
|
3. **Create a branch**: `git checkout -b fix/description` or `git checkout -b feature/description`
|
||||||
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
|
4. **Make changes** — keep them focused
|
||||||
- [ ] Can I split by file or module?
|
5. **Commit**: `git commit -m "fix: correct typo in README"`
|
||||||
- [ ] Can I create a base PR with shared utilities first?
|
6. **Push**: `git push origin fix/description`
|
||||||
- [ ] Can I separate test additions from implementation?
|
7. **Open PR** from your fork on GitHub
|
||||||
- [ ] Even if changes are related, can they deliver value independently?
|
|
||||||
- [ ] Can these changes be merged in any order without breaking things?
|
|
||||||
|
|
||||||
Example breakdown:
|
|
||||||
|
|
||||||
1. PR #1: Add utility functions and types (100 lines)
|
|
||||||
2. PR #2: Refactor existing code to use utilities (200 lines)
|
|
||||||
3. PR #3: Implement new feature using refactored code (300 lines)
|
|
||||||
4. PR #4: Add comprehensive tests (200 lines)
|
|
||||||
|
|
||||||
**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value.
|
|
||||||
|
|
||||||
### Pull Request Process
|
|
||||||
|
|
||||||
#### New to Pull Requests?
|
|
||||||
|
|
||||||
If you're new to GitHub or pull requests, here's a quick guide:
|
|
||||||
|
|
||||||
1. **Fork the repository** - Click the "Fork" button on GitHub to create your own copy
|
|
||||||
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
|
||||||
3. **Create a new branch** - Never work on `main` directly!
|
|
||||||
```bash
|
|
||||||
git checkout -b fix/description
|
|
||||||
# or
|
|
||||||
git checkout -b feature/description
|
|
||||||
```
|
|
||||||
4. **Make your changes** - Edit files, keeping changes small and focused
|
|
||||||
5. **Commit your changes** - Use clear, descriptive commit messages
|
|
||||||
```bash
|
|
||||||
git add .
|
|
||||||
git commit -m "fix: correct typo in README"
|
|
||||||
```
|
|
||||||
6. **Push to your fork** - `git push origin fix/description`
|
|
||||||
7. **Create the Pull Request** - Go to your fork on GitHub and click "Compare & pull request"
|
|
||||||
|
|
||||||
### PR Description Template
|
### PR Description Template
|
||||||
|
|
||||||
Keep your PR description concise and focused. Use this template:
|
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
## What
|
## What
|
||||||
|
|
||||||
[1-2 sentences describing WHAT changed]
|
[1-2 sentences describing WHAT changed]
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
[1-2 sentences explaining WHY this change is needed]
|
[1-2 sentences explaining WHY this change is needed]
|
||||||
Fixes #[issue number] (if applicable)
|
Fixes #[issue number]
|
||||||
|
|
||||||
## How
|
## How
|
||||||
|
- [2-3 bullets listing HOW you implemented it]
|
||||||
## [2-3 bullets listing HOW you implemented it]
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
-
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
[1-2 sentences on how you tested this]
|
[1-2 sentences on how you tested this]
|
||||||
```
|
```
|
||||||
|
|
||||||
**Maximum PR description length: 200 words** (excluding code examples if needed)
|
**Keep it under 200 words.**
|
||||||
|
|
||||||
### Good vs Bad PR Descriptions
|
### Commit Messages
|
||||||
|
|
||||||
❌ **Bad Example:**
|
Use conventional commits:
|
||||||
|
|
||||||
> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics...
|
|
||||||
|
|
||||||
✅ **Good Example:**
|
|
||||||
|
|
||||||
> **What:** Added validation for agent dependency resolution
|
|
||||||
> **Why:** Build was failing silently when agents had circular dependencies
|
|
||||||
> **How:**
|
|
||||||
>
|
|
||||||
> - Added cycle detection in dependency-resolver.js
|
|
||||||
> - Throws clear error with dependency chain
|
|
||||||
> **Testing:** Tested with circular deps between 3 agents
|
|
||||||
|
|
||||||
### Commit Message Convention
|
|
||||||
|
|
||||||
Use conventional commits format:
|
|
||||||
|
|
||||||
- `feat:` New feature
|
- `feat:` New feature
|
||||||
- `fix:` Bug fix
|
- `fix:` Bug fix
|
||||||
- `docs:` Documentation only
|
- `docs:` Documentation only
|
||||||
- `refactor:` Code change that neither fixes a bug nor adds a feature
|
- `refactor:` Code change (no bug/feature)
|
||||||
- `test:` Adding missing tests
|
- `test:` Adding tests
|
||||||
- `chore:` Changes to build process or auxiliary tools
|
- `chore:` Build/tools changes
|
||||||
|
|
||||||
Keep commit messages under 72 characters.
|
Keep messages under 72 characters. Each commit = one logical change.
|
||||||
|
|
||||||
### Atomic Commits
|
|
||||||
|
|
||||||
Each commit should represent one logical change:
|
|
||||||
|
|
||||||
- **Do:** One bug fix per commit
|
|
||||||
- **Do:** One feature addition per commit
|
|
||||||
- **Don't:** Mix refactoring with bug fixes
|
|
||||||
- **Don't:** Combine unrelated changes
|
|
||||||
|
|
||||||
## What Makes a Good Pull Request?
|
|
||||||
|
|
||||||
✅ **Good PRs:**
|
|
||||||
|
|
||||||
- Change one thing at a time
|
|
||||||
- Have clear, descriptive titles
|
|
||||||
- Explain what and why in the description
|
|
||||||
- Include only the files that need to change
|
|
||||||
- Reference related issue numbers
|
|
||||||
|
|
||||||
❌ **Avoid:**
|
|
||||||
|
|
||||||
- Changing formatting of entire files
|
|
||||||
- Multiple unrelated changes in one PR
|
|
||||||
- Copying your entire project/repo into the PR
|
|
||||||
- Changes without explanation
|
|
||||||
- Working directly on `main` branch
|
|
||||||
|
|
||||||
## Common Mistakes to Avoid
|
|
||||||
|
|
||||||
1. **Don't reformat entire files** - only change what's necessary
|
|
||||||
2. **Don't include unrelated changes** - stick to one fix/feature per PR
|
|
||||||
3. **Don't paste code in issues** - create a proper PR instead
|
|
||||||
4. **Don't submit your whole project** - contribute specific improvements
|
|
||||||
|
|
||||||
## Prompt & Agent Guidelines
|
|
||||||
|
|
||||||
- Keep dev agents lean - they need context for coding, not documentation
|
|
||||||
- Web/planning agents can be larger with more complex tasks
|
|
||||||
- Everything is natural language (markdown) - no code in core framework
|
|
||||||
- Use bmad modules for domain-specific features
|
|
||||||
- Validate YAML schemas with `npm run validate:schemas` before committing
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
By participating in this project, you agree to abide by our Code of Conduct. We foster a collaborative, respectful environment focused on building better human-AI partnerships.
|
|
||||||
|
|
||||||
## Need Help?
|
|
||||||
|
|
||||||
- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj):
|
|
||||||
- **#bmad-development** - Technical questions and discussions
|
|
||||||
- **#suggestions-feedback** - Feature ideas and suggestions
|
|
||||||
- **#report-bugs-and-issues** - Get help with bugs before filing issues
|
|
||||||
- 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
|
||||||
- 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
|
||||||
- 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner. Together, we're building a future where humans and AI work better together.
|
## What Makes a Good PR?
|
||||||
|
|
||||||
|
| ✅ Do | ❌ Don't |
|
||||||
|
| --------------------------- | ---------------------------- |
|
||||||
|
| Change one thing per PR | Mix unrelated changes |
|
||||||
|
| Clear title and description | Vague or missing explanation |
|
||||||
|
| Reference related issues | Reformat entire files |
|
||||||
|
| Small, focused commits | Copy your whole project |
|
||||||
|
| Work on a branch | Work directly on `main` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prompt & Agent Guidelines
|
||||||
|
|
||||||
|
- Keep dev agents lean — focus on coding context, not documentation
|
||||||
|
- Web/planning agents can be larger with complex tasks
|
||||||
|
- Everything is natural language (markdown) — no code in core framework
|
||||||
|
- Use BMad modules for domain-specific features
|
||||||
|
- Validate YAML schemas: `npm run validate:schemas`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Need Help?
|
||||||
|
|
||||||
|
- 💬 **Discord**: [Join the community](https://discord.gg/gk8jAdXWmj)
|
||||||
|
- 🐛 **Bugs**: Use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
||||||
|
- 💡 **Features**: Use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
By participating, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
|
By contributing, your contributions are licensed under the same MIT License. See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
# Contributors
|
||||||
|
|
||||||
|
BMad Core, BMad Method and BMad and Community BMad Modules are made possible by contributions from our community. We gratefully acknowledge everyone who has helped improve this project.
|
||||||
|
|
||||||
|
## How We Credit Contributors
|
||||||
|
|
||||||
|
- **Git history** — Every contribution is preserved in the project's commit history
|
||||||
|
- **Contributors badge** — See the dynamic contributors list on our [README](README.md)
|
||||||
|
- **GitHub contributors graph** — Visual representation at <https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors>
|
||||||
|
|
||||||
|
## Becoming a Contributor
|
||||||
|
|
||||||
|
Anyone who submits a pull request that is merged becomes a contributor. Contributions include:
|
||||||
|
|
||||||
|
- Bug fixes
|
||||||
|
- New features or workflows
|
||||||
|
- Documentation improvements
|
||||||
|
- Bug reports and issue triaging
|
||||||
|
- Code reviews
|
||||||
|
- Helping others in discussions
|
||||||
|
|
||||||
|
There are no minimum contribution requirements — whether it's a one-character typo fix or a major feature, we value all contributions.
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
The BMad Method project is copyrighted by BMad Code, LLC. Individual contributions are licensed under the same MIT License as the project. Contributors retain authorship credit through Git history and the contributors graph.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Thank you to everyone who has helped make BMad Method better!**
|
||||||
|
|
||||||
|
For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||||
10
LICENSE
10
LICENSE
|
|
@ -2,6 +2,9 @@ MIT License
|
||||||
|
|
||||||
Copyright (c) 2025 BMad Code, LLC
|
Copyright (c) 2025 BMad Code, LLC
|
||||||
|
|
||||||
|
This project incorporates contributions from the open source community.
|
||||||
|
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
in the Software without restriction, including without limitation the rights
|
in the Software without restriction, including without limitation the rights
|
||||||
|
|
@ -21,6 +24,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
SOFTWARE.
|
SOFTWARE.
|
||||||
|
|
||||||
TRADEMARK NOTICE:
|
TRADEMARK NOTICE:
|
||||||
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
|
BMad™, BMad Method™, and BMad Core™ are trademarks of BMad Code, LLC, covering all
|
||||||
trademarks in this software does not grant any rights to use the trademarks
|
casings and variations (including BMAD, bmad, BMadMethod, BMAD-METHOD, etc.). The use of
|
||||||
for any other purpose.
|
these trademarks in this software does not grant any rights to use the trademarks
|
||||||
|
for any other purpose. See [TRADEMARK.md](TRADEMARK.md) for detailed guidelines.
|
||||||
|
|
|
||||||
124
README.md
124
README.md
|
|
@ -1,69 +1,139 @@
|
||||||
# BMad Method
|

|
||||||
|
|
||||||
[](https://www.npmjs.com/package/bmad-method)
|
[](https://www.npmjs.com/package/bmad-method)
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[](https://nodejs.org)
|
[](https://nodejs.org)
|
||||||
[](https://discord.gg/gk8jAdXWmj)
|
[](https://discord.gg/gk8jAdXWmj)
|
||||||
|
|
||||||
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
||||||
|
|
||||||
|
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
||||||
|
|
||||||
## Why BMad?
|
## Why BMad?
|
||||||
|
|
||||||
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
||||||
|
|
||||||
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
|
||||||
|
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
|
||||||
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
||||||
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
||||||
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
|
||||||
|
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method@alpha install
|
npx bmad-method install
|
||||||
```
|
```
|
||||||
|
|
||||||
Follow the installer prompts to configure your project. Then run:
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
||||||
|
|
||||||
```bash
|
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
||||||
*workflow-init
|
|
||||||
```
|
|
||||||
|
|
||||||
This analyzes your project and recommends a track:
|
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
||||||
|
- `/bmad-help I just finished the architecture, I am not sure what to do next`
|
||||||
|
|
||||||
| Track | Best For | Time to First Story |
|
And the amazing thing is BMad Help evolves depending on what modules you install also!
|
||||||
| --------------- | ------------------------- | ------------------- |
|
- `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
|
||||||
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
|
||||||
| **BMad Method** | Products and platforms | ~15 minutes |
|
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
|
||||||
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
|
||||||
|
### Simple Path (Quick Flow)
|
||||||
|
|
||||||
|
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
|
||||||
|
|
||||||
|
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|
||||||
|
2. `/dev-story` — implements each story
|
||||||
|
3. `/code-review` — validates quality
|
||||||
|
|
||||||
|
### Full Planning Path (BMad Method)
|
||||||
|
|
||||||
|
Products, platforms, complex features — structured planning then build:
|
||||||
|
|
||||||
|
1. `/product-brief` — define problem, users, and MVP scope
|
||||||
|
2. `/create-prd` — full requirements with personas, metrics, and risks
|
||||||
|
3. `/create-architecture` — technical decisions and system design
|
||||||
|
4. `/create-epics-and-stories` — break work into prioritized stories
|
||||||
|
5. `/sprint-planning` — initialize sprint tracking
|
||||||
|
6. **Repeat per story:** `/create-story` → `/dev-story` → `/code-review`
|
||||||
|
|
||||||
|
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/).
|
||||||
|
|
||||||
## Modules
|
## Modules
|
||||||
|
|
||||||
| Module | Purpose |
|
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
|
||||||
| ------------------------------------- | -------------------------------------------------------- |
|
|
||||||
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
| Module | GitHub | NPM | Purpose |
|
||||||
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||||
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
||||||
|
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
||||||
|
| **Test Architect (TEA)** 🆕 | [bmad-code-org/tea](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise) | [tea](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise) | Risk-based test strategy, automation, and release gates (8 workflows) |
|
||||||
|
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
||||||
|
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
||||||
|
|
||||||
|
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
|
||||||
|
|
||||||
|
## Testing Agents
|
||||||
|
|
||||||
|
BMad provides two testing options to fit your needs:
|
||||||
|
|
||||||
|
### Quinn (QA) - Built-in
|
||||||
|
|
||||||
|
**Quick test automation for rapid coverage**
|
||||||
|
|
||||||
|
- ✅ **Always available** in BMM module (no separate install)
|
||||||
|
- ✅ **Simple**: One workflow (`QA` - Automate)
|
||||||
|
- ✅ **Beginner-friendly**: Standard test framework patterns
|
||||||
|
- ✅ **Fast**: Generate tests and ship
|
||||||
|
|
||||||
|
**Use Quinn for:** Small projects, quick coverage, standard patterns
|
||||||
|
|
||||||
|
### Test Architect (TEA) - Optional Module
|
||||||
|
|
||||||
|
**Enterprise-grade test strategy and quality engineering**
|
||||||
|
|
||||||
|
- 🆕 **Standalone module** (install separately)
|
||||||
|
- 🏗️ **Comprehensive**: 8 workflows covering full test lifecycle
|
||||||
|
- 🎯 **Advanced**: Risk-based planning, quality gates, NFR assessment
|
||||||
|
- 📚 **Knowledge-driven**: 34 testing patterns and best practices
|
||||||
|
- 📖 [Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||||
|
|
||||||
|
**Use TEA for:** Enterprise projects, test strategy, compliance, release gates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
**[BMad Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
||||||
|
**[Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)** — TEA standalone module documentation
|
||||||
|
|
||||||
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
|
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
||||||
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
||||||
|
- [Test Architect Migration Guide](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/migration/) — Upgrading from BMM-embedded TEA
|
||||||
|
|
||||||
### For v4 Users
|
### For v4 Users
|
||||||
|
|
||||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
||||||
|
- If you need to install V4, you can do this with `npx bmad-method@4.44.3 install` - similar for any past version.
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
||||||
- [YouTube](https://www.youtube.com/@BMadCode) — Video tutorials and updates
|
- [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
||||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
||||||
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
||||||
|
|
||||||
|
## Support BMad
|
||||||
|
|
||||||
|
BMad is free for everyone — and always will be. If you'd like to support development:
|
||||||
|
|
||||||
|
- ⭐ Please click the star project icon near the top right of this page
|
||||||
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
||||||
|
- 🏢 Corporate sponsorship — DM on Discord
|
||||||
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||||
|
|
@ -74,6 +144,8 @@ MIT License — see [LICENSE](LICENSE) for details.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC.
|
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
|
||||||
|
|
||||||
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
||||||
|
|
||||||
|
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,85 @@
|
||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
We release security patches for the following versions:
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
| ------- | ------------------ |
|
||||||
|
| Latest | :white_check_mark: |
|
||||||
|
| < Latest | :x: |
|
||||||
|
|
||||||
|
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
|
||||||
|
|
||||||
|
### How to Report
|
||||||
|
|
||||||
|
**Do NOT report security vulnerabilities through public GitHub issues.**
|
||||||
|
|
||||||
|
Instead, please report them via one of these methods:
|
||||||
|
|
||||||
|
1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report.
|
||||||
|
|
||||||
|
2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj).
|
||||||
|
|
||||||
|
### What to Include
|
||||||
|
|
||||||
|
Please include as much of the following information as possible:
|
||||||
|
|
||||||
|
- Type of vulnerability (e.g., prompt injection, path traversal, etc.)
|
||||||
|
- Full paths of source file(s) related to the vulnerability
|
||||||
|
- Step-by-step instructions to reproduce the issue
|
||||||
|
- Proof-of-concept or exploit code (if available)
|
||||||
|
- Impact assessment of the vulnerability
|
||||||
|
|
||||||
|
### Response Timeline
|
||||||
|
|
||||||
|
- **Initial Response**: Within 48 hours of receiving your report
|
||||||
|
- **Status Update**: Within 7 days with our assessment
|
||||||
|
- **Resolution Target**: Critical issues within 30 days; other issues within 90 days
|
||||||
|
|
||||||
|
### What to Expect
|
||||||
|
|
||||||
|
1. We will acknowledge receipt of your report
|
||||||
|
2. We will investigate and validate the vulnerability
|
||||||
|
3. We will work on a fix and coordinate disclosure timing with you
|
||||||
|
4. We will credit you in the security advisory (unless you prefer to remain anonymous)
|
||||||
|
|
||||||
|
## Security Scope
|
||||||
|
|
||||||
|
### In Scope
|
||||||
|
|
||||||
|
- Vulnerabilities in BMad Method core framework code
|
||||||
|
- Security issues in agent definitions or workflows that could lead to unintended behavior
|
||||||
|
- Path traversal or file system access issues
|
||||||
|
- Prompt injection vulnerabilities that bypass intended agent behavior
|
||||||
|
- Supply chain vulnerabilities in dependencies
|
||||||
|
|
||||||
|
### Out of Scope
|
||||||
|
|
||||||
|
- Security issues in user-created custom agents or modules
|
||||||
|
- Vulnerabilities in third-party AI providers (Claude, GPT, etc.)
|
||||||
|
- Issues that require physical access to a user's machine
|
||||||
|
- Social engineering attacks
|
||||||
|
- Denial of service attacks that don't exploit a specific vulnerability
|
||||||
|
|
||||||
|
## Security Best Practices for Users
|
||||||
|
|
||||||
|
When using BMad Method:
|
||||||
|
|
||||||
|
1. **Review Agent Outputs**: Always review AI-generated code before executing it
|
||||||
|
2. **Limit File Access**: Configure your AI IDE to limit file system access where possible
|
||||||
|
3. **Keep Updated**: Regularly update to the latest version
|
||||||
|
4. **Validate Dependencies**: Review any dependencies added by generated code
|
||||||
|
5. **Environment Isolation**: Consider running AI-assisted development in isolated environments
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Thank you for helping keep BMad Method and our community safe.
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
# Trademark Notice & Guidelines
|
||||||
|
|
||||||
|
## Trademark Ownership
|
||||||
|
|
||||||
|
The following names and logos are trademarks of BMad Code, LLC:
|
||||||
|
|
||||||
|
- **BMad** (word mark, all casings: BMad, bmad, BMAD)
|
||||||
|
- **BMad Method** (word mark, includes BMadMethod, BMAD-METHOD, and all variations)
|
||||||
|
- **BMad Core** (word mark, includes BMadCore, BMAD-CORE, and all variations)
|
||||||
|
- **BMad Code** (word mark)
|
||||||
|
- BMad Method logo and visual branding
|
||||||
|
- The "Build More, Architect Dreams" tagline
|
||||||
|
|
||||||
|
**All casings, stylings, and variations** of the above names (with or without hyphens, spaces, or specific capitalization) are covered by these trademarks.
|
||||||
|
|
||||||
|
These trademarks are protected under trademark law and are **not** licensed under the MIT License. The MIT License applies to the software code only, not to the BMad brand identity.
|
||||||
|
|
||||||
|
## What This Means
|
||||||
|
|
||||||
|
You may:
|
||||||
|
|
||||||
|
- Use the BMad software under the terms of the MIT License
|
||||||
|
- Refer to BMad to accurately describe compatibility or integration (e.g., "Compatible with BMad Method v6")
|
||||||
|
- Link to <https://github.com/bmad-code-org/BMAD-METHOD>
|
||||||
|
- Fork the software and distribute your own version under a different name
|
||||||
|
|
||||||
|
You may **not**:
|
||||||
|
|
||||||
|
- Use "BMad" or any confusingly similar variation as your product name, service name, company name, or domain name
|
||||||
|
- Present your product as officially endorsed, approved, or certified by BMad Code, LLC when it is not, without written consent from an authorized representative of BMad Code, LLC
|
||||||
|
- Use BMad logos or branding in a way that suggests your product is an official or endorsed BMad product
|
||||||
|
- Register domain names, social media handles, or trademarks that incorporate BMad branding
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
| Permitted | Not Permitted |
|
||||||
|
| ------------------------------------------------------ | -------------------------------------------- |
|
||||||
|
| "My workflow tool, compatible with BMad Method" | "BMadFlow" or "BMad Studio" |
|
||||||
|
| "An alternative implementation inspired by BMad" | "BMad Pro" or "BMad Enterprise" |
|
||||||
|
| "My Awesome Healthcare Module (Bmad Community Module)" | "The Official BMad Core Healthcare Module" |
|
||||||
|
| Accurately stating you use BMad as a dependency | Implying official endorsement or partnership |
|
||||||
|
|
||||||
|
## Commercial Use
|
||||||
|
|
||||||
|
You may sell products that incorporate or work with BMad software. However:
|
||||||
|
|
||||||
|
- Your product must have its own distinct name and branding
|
||||||
|
- You must not use BMad trademarks in your marketing, domain names, or product identity
|
||||||
|
- You may truthfully describe technical compatibility (e.g., "Works with BMad Method")
|
||||||
|
|
||||||
|
## Questions?
|
||||||
|
|
||||||
|
If you have questions about trademark usage or would like to discuss official partnership or endorsement opportunities, please reach out:
|
||||||
|
|
||||||
|
- **Email**: <contact@bmadcode.com>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 366 KiB |
|
|
@ -1,40 +0,0 @@
|
||||||
---
|
|
||||||
title: "Workflow Diagram Maintenance"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## Regenerating SVG from Excalidraw
|
|
||||||
|
|
||||||
When you edit `workflow-method-greenfield.excalidraw`, regenerate the SVG:
|
|
||||||
|
|
||||||
1. Open <https://excalidraw.com/>
|
|
||||||
2. Load the `.excalidraw` file
|
|
||||||
3. Click menu (☰) → Export image → SVG
|
|
||||||
4. **Set "Scale" to 1x** (default is 2x)
|
|
||||||
5. Click "Export"
|
|
||||||
6. Save as `workflow-method-greenfield.svg`
|
|
||||||
7. **Validate the changes** (see below)
|
|
||||||
8. Commit both files together
|
|
||||||
|
|
||||||
**Important:**
|
|
||||||
|
|
||||||
- Always use **1x scale** to maintain consistent dimensions
|
|
||||||
- Automated export tools (`excalidraw-to-svg`) are broken - use manual export only
|
|
||||||
|
|
||||||
## Visual Validation
|
|
||||||
|
|
||||||
After regenerating the SVG, validate that it renders correctly:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./tools/validate-svg-changes.sh path/to/workflow-method-greenfield.svg
|
|
||||||
```
|
|
||||||
|
|
||||||
This script:
|
|
||||||
|
|
||||||
- Checks for required dependencies (Playwright, ImageMagick)
|
|
||||||
- Installs Playwright locally if needed (no package.json pollution)
|
|
||||||
- Renders old vs new SVG using browser-accurate rendering
|
|
||||||
- Compares pixel-by-pixel and generates a diff image
|
|
||||||
- Outputs a prompt for AI visual analysis (paste into Gemini/Claude)
|
|
||||||
|
|
||||||
**Threshold**: <0.01% difference is acceptable (anti-aliasing variations)
|
|
||||||
|
|
@ -1,88 +1,28 @@
|
||||||
# Documentation Style Guide
|
---
|
||||||
|
title: "Documentation Style Guide"
|
||||||
|
---
|
||||||
|
|
||||||
Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
|
This project adheres to the [Google Developer Documentation Style Guide](https://developers.google.com/style) and uses [Diataxis](https://diataxis.fr/) to structure content. Only project-specific conventions follow.
|
||||||
|
|
||||||
## Quick Principles
|
## Project-Specific Rules
|
||||||
|
|
||||||
1. **Clarity over brevity** — Be concise, but never at the cost of understanding
|
| Rule | Specification |
|
||||||
2. **Consistent structure** — Follow established patterns so readers know what to expect
|
| -------------------------------- | ---------------------------------------- |
|
||||||
3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully
|
| No horizontal rules (`---`) | Fragments reading flow |
|
||||||
4. **Scannable content** — Headers, lists, and callouts help readers find what they need
|
| No `####` headers | Use bold text or admonitions instead |
|
||||||
|
| No "Related" or "Next:" sections | Sidebar handles navigation |
|
||||||
|
| No deeply nested lists | Break into sections instead |
|
||||||
|
| No code blocks for non-code | Use admonitions for dialogue examples |
|
||||||
|
| No bold paragraphs for callouts | Use admonitions instead |
|
||||||
|
| 1-2 admonitions per section max | Tutorials allow 3-4 per major section |
|
||||||
|
| Table cells / list items | 1-2 sentences max |
|
||||||
|
| Header budget | 8-12 `##` per doc; 2-3 `###` per section |
|
||||||
|
|
||||||
## Validation Steps
|
## Admonitions (Starlight Syntax)
|
||||||
|
|
||||||
Before submitting documentation changes, run these checks from the repo root:
|
|
||||||
|
|
||||||
1. **Fix link format** — Convert relative links (`./`, `../`) to site-relative paths (`/path/`)
|
|
||||||
```bash
|
|
||||||
npm run docs:fix-links # Preview changes
|
|
||||||
npm run docs:fix-links -- --write # Apply changes
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Validate links** — Check all links point to existing files
|
|
||||||
```bash
|
|
||||||
npm run docs:validate-links # Preview issues
|
|
||||||
npm run docs:validate-links -- --write # Auto-fix where possible
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Build the site** — Verify no build errors
|
|
||||||
```bash
|
|
||||||
npm run docs:build
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tutorial Structure
|
|
||||||
|
|
||||||
Every tutorial should follow this structure:
|
|
||||||
|
|
||||||
```
|
|
||||||
1. Title + Hook (1-2 sentences describing the outcome)
|
|
||||||
2. Version/Module Notice (info or warning admonition as appropriate)
|
|
||||||
3. What You'll Learn (bullet list of outcomes)
|
|
||||||
4. Prerequisites (info admonition)
|
|
||||||
5. Quick Path (tip admonition - TL;DR summary)
|
|
||||||
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
|
||||||
7. Installation (if applicable)
|
|
||||||
8. Step 1: [First Major Task]
|
|
||||||
9. Step 2: [Second Major Task]
|
|
||||||
10. Step 3: [Third Major Task]
|
|
||||||
11. What You've Accomplished (summary + folder structure if applicable)
|
|
||||||
12. Quick Reference (commands table)
|
|
||||||
13. Common Questions (FAQ format)
|
|
||||||
14. Getting Help (community links)
|
|
||||||
15. Key Takeaways (tip admonition - memorable points)
|
|
||||||
```
|
|
||||||
|
|
||||||
Not all sections are required for every tutorial, but this is the standard flow.
|
|
||||||
|
|
||||||
## Visual Hierarchy
|
|
||||||
|
|
||||||
### Avoid
|
|
||||||
|
|
||||||
| Pattern | Problem |
|
|
||||||
|---------|---------|
|
|
||||||
| `---` horizontal rules | Fragment the reading flow |
|
|
||||||
| `####` deep headers | Create visual noise |
|
|
||||||
| **Important:** bold paragraphs | Blend into body text |
|
|
||||||
| Deeply nested lists | Hard to scan |
|
|
||||||
| Code blocks for non-code | Confusing semantics |
|
|
||||||
|
|
||||||
### Use Instead
|
|
||||||
|
|
||||||
| Pattern | When to Use |
|
|
||||||
|---------|-------------|
|
|
||||||
| White space + section headers | Natural content separation |
|
|
||||||
| Bold text within paragraphs | Inline emphasis |
|
|
||||||
| Admonitions | Callouts that need attention |
|
|
||||||
| Tables | Structured comparisons |
|
|
||||||
| Flat lists | Scannable options |
|
|
||||||
|
|
||||||
## Admonitions
|
|
||||||
|
|
||||||
Use Starlight admonitions strategically:
|
|
||||||
|
|
||||||
```md
|
```md
|
||||||
:::tip[Title]
|
:::tip[Title]
|
||||||
Shortcuts, best practices, "pro tips"
|
Shortcuts, best practices
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::note[Title]
|
:::note[Title]
|
||||||
|
|
@ -90,7 +30,7 @@ Context, definitions, examples, prerequisites
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::caution[Title]
|
:::caution[Title]
|
||||||
Caveats, potential issues, things to watch out for
|
Caveats, potential issues
|
||||||
:::
|
:::
|
||||||
|
|
||||||
:::danger[Title]
|
:::danger[Title]
|
||||||
|
|
@ -98,154 +38,306 @@ Critical warnings only — data loss, security issues
|
||||||
:::
|
:::
|
||||||
```
|
```
|
||||||
|
|
||||||
### Standard Admonition Uses
|
### Standard Uses
|
||||||
|
|
||||||
| Admonition | Standard Use in Tutorials |
|
| Admonition | Use For |
|
||||||
|------------|---------------------------|
|
| ------------------------ | ----------------------------- |
|
||||||
| `:::note[Prerequisites]` | What users need before starting |
|
| `:::note[Prerequisites]` | Dependencies before starting |
|
||||||
| `:::tip[Quick Path]` | TL;DR summary at top of tutorial |
|
| `:::tip[Quick Path]` | TL;DR summary at document top |
|
||||||
| `:::caution[Fresh Chats]` | Context limitation reminders |
|
| `:::caution[Important]` | Critical caveats |
|
||||||
| `:::note[Example]` | Command/response examples |
|
| `:::note[Example]` | Command/response examples |
|
||||||
| `:::tip[Check Your Status]` | How to verify progress |
|
|
||||||
| `:::tip[Remember These]` | Key takeaways at end |
|
|
||||||
|
|
||||||
### Admonition Guidelines
|
## Standard Table Formats
|
||||||
|
|
||||||
- **Always include a title** for tip, info, and warning
|
**Phases:**
|
||||||
- **Keep content brief** — 1-3 sentences ideal
|
|
||||||
- **Don't overuse** — More than 3-4 per major section feels noisy
|
|
||||||
- **Don't nest** — Admonitions inside admonitions are hard to read
|
|
||||||
|
|
||||||
## Headers
|
|
||||||
|
|
||||||
### Budget
|
|
||||||
|
|
||||||
- **8-12 `##` sections** for full tutorials following standard structure
|
|
||||||
- **2-3 `###` subsections** per `##` section maximum
|
|
||||||
- **Avoid `####` entirely** — use bold text or admonitions instead
|
|
||||||
|
|
||||||
### Naming
|
|
||||||
|
|
||||||
- Use action verbs for steps: "Install BMad", "Create Your Plan"
|
|
||||||
- Use nouns for reference sections: "Common Questions", "Quick Reference"
|
|
||||||
- Keep headers short and scannable
|
|
||||||
|
|
||||||
## Code Blocks
|
|
||||||
|
|
||||||
### Do
|
|
||||||
|
|
||||||
```md
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
```
|
|
||||||
|
|
||||||
### Don't
|
|
||||||
|
|
||||||
````md
|
|
||||||
```
|
|
||||||
You: Do something
|
|
||||||
Agent: [Response here]
|
|
||||||
```
|
|
||||||
````
|
|
||||||
|
|
||||||
For command/response examples, use an admonition instead:
|
|
||||||
|
|
||||||
```md
|
|
||||||
:::note[Example]
|
|
||||||
Run `workflow-status` and the agent will tell you the next recommended workflow.
|
|
||||||
:::
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tables
|
|
||||||
|
|
||||||
Use tables for:
|
|
||||||
- Phases and what happens in each
|
|
||||||
- Agent roles and when to use them
|
|
||||||
- Command references
|
|
||||||
- Comparing options
|
|
||||||
- Step sequences with multiple attributes
|
|
||||||
|
|
||||||
Keep tables simple:
|
|
||||||
- 2-4 columns maximum
|
|
||||||
- Short cell content
|
|
||||||
- Left-align text, right-align numbers
|
|
||||||
|
|
||||||
### Standard Tables
|
|
||||||
|
|
||||||
**Phases Table:**
|
|
||||||
```md
|
```md
|
||||||
| Phase | Name | What Happens |
|
| Phase | Name | What Happens |
|
||||||
|-------|------|--------------|
|
| ----- | -------- | -------------------------------------------- |
|
||||||
| 1 | Analysis | Brainstorm, research *(optional)* |
|
| 1 | Analysis | Brainstorm, research *(optional)* |
|
||||||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
||||||
```
|
```
|
||||||
|
|
||||||
**Quick Reference Table:**
|
**Commands:**
|
||||||
|
|
||||||
```md
|
```md
|
||||||
| Command | Agent | Purpose |
|
| Command | Agent | Purpose |
|
||||||
|---------|-------|---------|
|
| ------------ | ------- | ------------------------------------ |
|
||||||
| `*workflow-init` | Analyst | Initialize a new project |
|
| `brainstorm` | Analyst | Brainstorm a new project |
|
||||||
| `*prd` | PM | Create Product Requirements Document |
|
| `prd` | PM | Create Product Requirements Document |
|
||||||
```
|
```
|
||||||
|
|
||||||
**Build Cycle Table:**
|
## Folder Structure Blocks
|
||||||
```md
|
|
||||||
| Step | Agent | Workflow | Purpose |
|
Show in "What You've Accomplished" sections:
|
||||||
|------|-------|----------|---------|
|
|
||||||
| 1 | SM | `create-story` | Create story file from epic |
|
````md
|
||||||
| 2 | DEV | `dev-story` | Implement the story |
|
```
|
||||||
|
your-project/
|
||||||
|
├── _bmad/ # BMad configuration
|
||||||
|
├── _bmad-output/
|
||||||
|
│ ├── PRD.md # Your requirements document
|
||||||
|
│ └── bmm-workflow-status.yaml # Progress tracking
|
||||||
|
└── ...
|
||||||
|
```
|
||||||
|
````
|
||||||
|
|
||||||
|
## Tutorial Structure
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (1-2 sentences describing outcome)
|
||||||
|
2. Version/Module Notice (info or warning admonition) (optional)
|
||||||
|
3. What You'll Learn (bullet list of outcomes)
|
||||||
|
4. Prerequisites (info admonition)
|
||||||
|
5. Quick Path (tip admonition - TL;DR summary)
|
||||||
|
6. Understanding [Topic] (context before steps - tables for phases/agents)
|
||||||
|
7. Installation (optional)
|
||||||
|
8. Step 1: [First Major Task]
|
||||||
|
9. Step 2: [Second Major Task]
|
||||||
|
10. Step 3: [Third Major Task]
|
||||||
|
11. What You've Accomplished (summary + folder structure)
|
||||||
|
12. Quick Reference (commands table)
|
||||||
|
13. Common Questions (FAQ format)
|
||||||
|
14. Getting Help (community links)
|
||||||
|
15. Key Takeaways (tip admonition)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Lists
|
### Tutorial Checklist
|
||||||
|
|
||||||
### Flat Lists (Preferred)
|
- [ ] Hook describes outcome in 1-2 sentences
|
||||||
|
- [ ] "What You'll Learn" section present
|
||||||
|
- [ ] Prerequisites in admonition
|
||||||
|
- [ ] Quick Path TL;DR admonition at top
|
||||||
|
- [ ] Tables for phases, commands, agents
|
||||||
|
- [ ] "What You've Accomplished" section present
|
||||||
|
- [ ] Quick Reference table present
|
||||||
|
- [ ] Common Questions section present
|
||||||
|
- [ ] Getting Help section present
|
||||||
|
- [ ] Key Takeaways admonition at end
|
||||||
|
|
||||||
|
## How-To Structure
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (one sentence: "Use the `X` workflow to...")
|
||||||
|
2. When to Use This (bullet list of scenarios)
|
||||||
|
3. When to Skip This (optional)
|
||||||
|
4. Prerequisites (note admonition)
|
||||||
|
5. Steps (numbered ### subsections)
|
||||||
|
6. What You Get (output/artifacts produced)
|
||||||
|
7. Example (optional)
|
||||||
|
8. Tips (optional)
|
||||||
|
9. Next Steps (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### How-To Checklist
|
||||||
|
|
||||||
|
- [ ] Hook starts with "Use the `X` workflow to..."
|
||||||
|
- [ ] "When to Use This" has 3-5 bullet points
|
||||||
|
- [ ] Prerequisites listed
|
||||||
|
- [ ] Steps are numbered `###` subsections with action verbs
|
||||||
|
- [ ] "What You Get" describes output artifacts
|
||||||
|
|
||||||
|
## Explanation Structure
|
||||||
|
|
||||||
|
### Types
|
||||||
|
|
||||||
|
| Type | Example |
|
||||||
|
| ----------------- | ---------------------------- |
|
||||||
|
| **Index/Landing** | `core-concepts/index.md` |
|
||||||
|
| **Concept** | `what-are-agents.md` |
|
||||||
|
| **Feature** | `quick-flow.md` |
|
||||||
|
| **Philosophy** | `why-solutioning-matters.md` |
|
||||||
|
| **FAQ** | `brownfield-faq.md` |
|
||||||
|
|
||||||
|
### General Template
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (1-2 sentences)
|
||||||
|
2. Overview/Definition (what it is, why it matters)
|
||||||
|
3. Key Concepts (### subsections)
|
||||||
|
4. Comparison Table (optional)
|
||||||
|
5. When to Use / When Not to Use (optional)
|
||||||
|
6. Diagram (optional - mermaid, 1 per doc max)
|
||||||
|
7. Next Steps (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Index/Landing Pages
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (one sentence)
|
||||||
|
2. Content Table (links with descriptions)
|
||||||
|
3. Getting Started (numbered list)
|
||||||
|
4. Choose Your Path (optional - decision tree)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Concept Explainers
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (what it is)
|
||||||
|
2. Types/Categories (### subsections) (optional)
|
||||||
|
3. Key Differences Table
|
||||||
|
4. Components/Parts
|
||||||
|
5. Which Should You Use?
|
||||||
|
6. Creating/Customizing (pointer to how-to guides)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Feature Explainers
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (what it does)
|
||||||
|
2. Quick Facts (optional - "Perfect for:", "Time to:")
|
||||||
|
3. When to Use / When Not to Use
|
||||||
|
4. How It Works (mermaid diagram optional)
|
||||||
|
5. Key Benefits
|
||||||
|
6. Comparison Table (optional)
|
||||||
|
7. When to Graduate/Upgrade (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Philosophy/Rationale Documents
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (the principle)
|
||||||
|
2. The Problem
|
||||||
|
3. The Solution
|
||||||
|
4. Key Principles (### subsections)
|
||||||
|
5. Benefits
|
||||||
|
6. When This Applies
|
||||||
|
```
|
||||||
|
|
||||||
|
### Explanation Checklist
|
||||||
|
|
||||||
|
- [ ] Hook states what document explains
|
||||||
|
- [ ] Content in scannable `##` sections
|
||||||
|
- [ ] Comparison tables for 3+ options
|
||||||
|
- [ ] Diagrams have clear labels
|
||||||
|
- [ ] Links to how-to guides for procedural questions
|
||||||
|
- [ ] 2-3 admonitions max per document
|
||||||
|
|
||||||
|
## Reference Structure
|
||||||
|
|
||||||
|
### Types
|
||||||
|
|
||||||
|
| Type | Example |
|
||||||
|
| ----------------- | --------------------- |
|
||||||
|
| **Index/Landing** | `workflows/index.md` |
|
||||||
|
| **Catalog** | `agents/index.md` |
|
||||||
|
| **Deep-Dive** | `document-project.md` |
|
||||||
|
| **Configuration** | `core-tasks.md` |
|
||||||
|
| **Glossary** | `glossary/index.md` |
|
||||||
|
| **Comprehensive** | `bmgd-workflows.md` |
|
||||||
|
|
||||||
|
### Reference Index Pages
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (one sentence)
|
||||||
|
2. Content Sections (## for each category)
|
||||||
|
- Bullet list with links and descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Catalog Reference
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook
|
||||||
|
2. Items (## for each item)
|
||||||
|
- Brief description (one sentence)
|
||||||
|
- **Commands:** or **Key Info:** as flat list
|
||||||
|
3. Universal/Shared (## section) (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Item Deep-Dive Reference
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook (one sentence purpose)
|
||||||
|
2. Quick Facts (optional note admonition)
|
||||||
|
- Module, Command, Input, Output as list
|
||||||
|
3. Purpose/Overview (## section)
|
||||||
|
4. How to Invoke (code block)
|
||||||
|
5. Key Sections (## for each aspect)
|
||||||
|
- Use ### for sub-options
|
||||||
|
6. Notes/Caveats (tip or caution admonition)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration Reference
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook
|
||||||
|
2. Table of Contents (jump links if 4+ items)
|
||||||
|
3. Items (## for each config/task)
|
||||||
|
- **Bold summary** — one sentence
|
||||||
|
- **Use it when:** bullet list
|
||||||
|
- **How it works:** numbered steps (3-5 max)
|
||||||
|
- **Output:** expected result (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Comprehensive Reference Guide
|
||||||
|
|
||||||
|
```text
|
||||||
|
1. Title + Hook
|
||||||
|
2. Overview (## section)
|
||||||
|
- Diagram or table showing organization
|
||||||
|
3. Major Sections (## for each phase/category)
|
||||||
|
- Items (### for each item)
|
||||||
|
- Standardized fields: Command, Agent, Input, Output, Description
|
||||||
|
4. Next Steps (optional)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Reference Checklist
|
||||||
|
|
||||||
|
- [ ] Hook states what document references
|
||||||
|
- [ ] Structure matches reference type
|
||||||
|
- [ ] Items use consistent structure throughout
|
||||||
|
- [ ] Tables for structured/comparative data
|
||||||
|
- [ ] Links to explanation docs for conceptual depth
|
||||||
|
- [ ] 1-2 admonitions max
|
||||||
|
|
||||||
|
## Glossary Structure
|
||||||
|
|
||||||
|
Starlight generates right-side "On this page" navigation from headers:
|
||||||
|
|
||||||
|
- Categories as `##` headers — appear in right nav
|
||||||
|
- Terms in tables — compact rows, not individual headers
|
||||||
|
- No inline TOC — right sidebar handles navigation
|
||||||
|
|
||||||
|
### Table Format
|
||||||
|
|
||||||
```md
|
```md
|
||||||
- **Option A** — Description of option A
|
## Category Name
|
||||||
- **Option B** — Description of option B
|
|
||||||
- **Option C** — Description of option C
|
| Term | Definition |
|
||||||
|
| ------------ | ---------------------------------------------------------------------------------------- |
|
||||||
|
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
|
||||||
|
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
|
||||||
```
|
```
|
||||||
|
|
||||||
### Numbered Steps
|
### Definition Rules
|
||||||
|
|
||||||
```md
|
| Do | Don't |
|
||||||
1. Load the **PM agent** in a new chat
|
| ----------------------------- | ------------------------------------------- |
|
||||||
2. Run the PRD workflow: `*prd`
|
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
|
||||||
3. Output: `PRD.md`
|
| Keep to 1-2 sentences | Write multi-paragraph explanations |
|
||||||
```
|
| Bold term name in cell | Use plain text for terms |
|
||||||
|
|
||||||
### Avoid Deep Nesting
|
### Context Markers
|
||||||
|
|
||||||
```md
|
Add italic context at definition start for limited-scope terms:
|
||||||
<!-- Don't do this -->
|
|
||||||
1. First step
|
|
||||||
- Sub-step A
|
|
||||||
- Detail 1
|
|
||||||
- Detail 2
|
|
||||||
- Sub-step B
|
|
||||||
2. Second step
|
|
||||||
```
|
|
||||||
|
|
||||||
Instead, break into separate sections or use an admonition for context.
|
- `*Quick Flow only.*`
|
||||||
|
- `*BMad Method/Enterprise.*`
|
||||||
|
- `*Phase N.*`
|
||||||
|
- `*BMGD.*`
|
||||||
|
- `*Brownfield.*`
|
||||||
|
|
||||||
## Links
|
### Glossary Checklist
|
||||||
|
|
||||||
- Use descriptive link text: `[Tutorial Style Guide](./tutorial-style.md)`
|
- [ ] Terms in tables, not individual headers
|
||||||
- Avoid "click here" or bare URLs
|
- [ ] Terms alphabetized within categories
|
||||||
- Prefer relative paths within docs
|
- [ ] Definitions 1-2 sentences
|
||||||
|
- [ ] Context markers italicized
|
||||||
## Images
|
- [ ] Term names bolded in cells
|
||||||
|
- [ ] No "A [term] is..." definitions
|
||||||
- Always include alt text
|
|
||||||
- Add a caption in italics below: `*Description of the image.*`
|
|
||||||
- Use SVG for diagrams when possible
|
|
||||||
- Store in `./images/` relative to the document
|
|
||||||
|
|
||||||
## FAQ Sections
|
## FAQ Sections
|
||||||
|
|
||||||
Use a TOC with jump links, `###` headers for questions, and direct answers:
|
|
||||||
|
|
||||||
```md
|
```md
|
||||||
## Questions
|
## Questions
|
||||||
|
|
||||||
|
|
@ -260,88 +352,16 @@ Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
||||||
|
|
||||||
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](...) or ask in [Discord](...) so we can add it!
|
**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
|
||||||
```
|
```
|
||||||
|
|
||||||
### FAQ Guidelines
|
## Validation Commands
|
||||||
|
|
||||||
- **TOC at top** — Jump links under `## Questions` for quick navigation
|
Before submitting documentation changes:
|
||||||
- **`###` headers** — Questions are scannable and linkable (no `Q:` prefix)
|
|
||||||
- **Direct answers** — No `**A:**` prefix, just the answer
|
|
||||||
- **No "Related Documentation"** — Sidebar handles navigation; avoid repetitive links
|
|
||||||
- **End with CTA** — "Have a question not answered here?" with issue/Discord links
|
|
||||||
|
|
||||||
## Folder Structure Blocks
|
|
||||||
|
|
||||||
Show project structure in "What You've Accomplished":
|
|
||||||
|
|
||||||
````md
|
|
||||||
Your project now has:
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run docs:fix-links # Preview link format fixes
|
||||||
|
npm run docs:fix-links -- --write # Apply fixes
|
||||||
|
npm run docs:validate-links # Check links exist
|
||||||
|
npm run docs:build # Verify no build errors
|
||||||
```
|
```
|
||||||
your-project/
|
|
||||||
├── _bmad/ # BMad configuration
|
|
||||||
├── _bmad-output/
|
|
||||||
│ ├── PRD.md # Your requirements document
|
|
||||||
│ └── bmm-workflow-status.yaml # Progress tracking
|
|
||||||
└── ...
|
|
||||||
```
|
|
||||||
````
|
|
||||||
|
|
||||||
## Example: Before and After
|
|
||||||
|
|
||||||
### Before (Noisy)
|
|
||||||
|
|
||||||
```md
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
### Step 1: Initialize
|
|
||||||
|
|
||||||
#### What happens during init?
|
|
||||||
|
|
||||||
**Important:** You need to describe your project.
|
|
||||||
|
|
||||||
1. Your project goals
|
|
||||||
- What you want to build
|
|
||||||
- Why you're building it
|
|
||||||
2. The complexity
|
|
||||||
- Small, medium, or large
|
|
||||||
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
### After (Clean)
|
|
||||||
|
|
||||||
```md
|
|
||||||
## Step 1: Initialize Your Project
|
|
||||||
|
|
||||||
Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`.
|
|
||||||
|
|
||||||
:::note[What Happens]
|
|
||||||
You'll describe your project goals and complexity. The workflow then recommends a planning track.
|
|
||||||
:::
|
|
||||||
```
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
Before submitting a tutorial:
|
|
||||||
|
|
||||||
- [ ] Follows the standard structure
|
|
||||||
- [ ] Has version/module notice if applicable
|
|
||||||
- [ ] Has "What You'll Learn" section
|
|
||||||
- [ ] Has Prerequisites admonition
|
|
||||||
- [ ] Has Quick Path TL;DR admonition
|
|
||||||
- [ ] No horizontal rules (`---`)
|
|
||||||
- [ ] No `####` headers
|
|
||||||
- [ ] Admonitions used for callouts (not bold paragraphs)
|
|
||||||
- [ ] Tables used for structured data (phases, commands, agents)
|
|
||||||
- [ ] Lists are flat (no deep nesting)
|
|
||||||
- [ ] Has "What You've Accomplished" section
|
|
||||||
- [ ] Has Quick Reference table
|
|
||||||
- [ ] Has Common Questions section
|
|
||||||
- [ ] Has Getting Help section
|
|
||||||
- [ ] Has Key Takeaways admonition
|
|
||||||
- [ ] All links use descriptive text
|
|
||||||
- [ ] Images have alt text and captions
|
|
||||||
|
|
|
||||||
|
|
@ -1,247 +0,0 @@
|
||||||
---
|
|
||||||
title: "Getting Started with BMad v4"
|
|
||||||
description: Install BMad and create your first planning document
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation.
|
|
||||||
|
|
||||||
:::note[Stable Release]
|
|
||||||
This tutorial covers BMad v4, the current stable release. For the latest features (with potential breaking changes), see the [BMad v6 Alpha tutorial](./getting-started-bmadv6.md).
|
|
||||||
:::
|
|
||||||
|
|
||||||
## What You'll Learn
|
|
||||||
|
|
||||||
- Install and configure BMad for your IDE
|
|
||||||
- Understand how BMad organizes work into phases and agents
|
|
||||||
- Initialize a project and choose a planning track
|
|
||||||
- Create your first requirements document
|
|
||||||
|
|
||||||
:::note[Prerequisites]
|
|
||||||
- **Node.js 20+** — Required for the installer
|
|
||||||
- **Git** — Recommended for version control
|
|
||||||
- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar
|
|
||||||
- **A project idea** — Even a simple one works for learning
|
|
||||||
:::
|
|
||||||
|
|
||||||
:::tip[Quick Path]
|
|
||||||
**Install** → `npx bmad-method install`
|
|
||||||
**Initialize** → Load Analyst agent, run `workflow-init`
|
|
||||||
**Plan** → PM creates PRD, Architect creates architecture
|
|
||||||
**Build** → SM manages sprints, DEV implements stories
|
|
||||||
**Always use fresh chats** for each workflow to avoid context issues.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Understanding BMad
|
|
||||||
|
|
||||||
BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases:
|
|
||||||
|
|
||||||
| Phase | Name | What Happens |
|
|
||||||
|-------|------|--------------|
|
|
||||||
| 1 | Analysis | Brainstorm, research *(optional)* |
|
|
||||||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
|
||||||
| 3 | Solutioning | Architecture, design decisions *(varies by track)* |
|
|
||||||
| 4 | Implementation | Build code story by story *(required)* |
|
|
||||||
|
|
||||||
Based on your project's complexity, BMad offers three planning tracks:
|
|
||||||
|
|
||||||
| Track | Best For | Documents Created |
|
|
||||||
|-------|----------|-------------------|
|
|
||||||
| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only |
|
|
||||||
| **BMad Method** | Products, platforms, complex features | PRD + Architecture + UX |
|
|
||||||
| **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps |
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Open a terminal in your project directory and run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
|
|
||||||
The interactive installer guides you through setup:
|
|
||||||
|
|
||||||
- **Choose Installation Location** — Select current directory (recommended), subdirectory, or custom path
|
|
||||||
- **Select Your AI Tool** — Claude Code, Cursor, Windsurf, or other
|
|
||||||
- **Choose Modules** — Select **BMM** (BMad Method) for this tutorial
|
|
||||||
- **Accept Defaults** — Customize later in `_bmad/[module]/config.yaml`
|
|
||||||
|
|
||||||
Verify your installation:
|
|
||||||
|
|
||||||
```
|
|
||||||
your-project/
|
|
||||||
├── _bmad/
|
|
||||||
│ ├── bmm/ # Method module
|
|
||||||
│ │ ├── agents/ # Agent files
|
|
||||||
│ │ ├── workflows/ # Workflow files
|
|
||||||
│ │ └── config.yaml # Module config
|
|
||||||
│ └── core/ # Core utilities
|
|
||||||
├── _bmad-output/ # Generated artifacts (created later)
|
|
||||||
└── .claude/ # IDE configuration (if using Claude Code)
|
|
||||||
```
|
|
||||||
|
|
||||||
:::tip[Troubleshooting]
|
|
||||||
Having issues? See [Install BMad](../../how-to/installation/install-bmad.md) for common solutions.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Step 1: Initialize Your Project
|
|
||||||
|
|
||||||
Load the **Analyst agent** in your IDE:
|
|
||||||
- **Claude Code**: Type `/analyst` or load the agent file directly
|
|
||||||
- **Cursor/Windsurf**: Open the agent file from `_bmad/bmm/agents/`
|
|
||||||
|
|
||||||
Wait for the agent's menu to appear, then run:
|
|
||||||
|
|
||||||
```
|
|
||||||
Run workflow-init
|
|
||||||
```
|
|
||||||
|
|
||||||
Or use the shorthand: `*workflow-init`
|
|
||||||
|
|
||||||
The workflow asks you to describe:
|
|
||||||
- **Your project and goals** — What are you building? What problem does it solve?
|
|
||||||
- **Existing codebase** — Is this new (greenfield) or existing code (brownfield)?
|
|
||||||
- **Size and complexity** — Roughly how big is this? (adjustable later)
|
|
||||||
|
|
||||||
Based on your description, the workflow suggests a planning track. For this tutorial, choose **BMad Method**.
|
|
||||||
|
|
||||||
Once you confirm, the workflow creates `bmm-workflow-status.yaml` to track your progress.
|
|
||||||
|
|
||||||
:::caution[Fresh Chats]
|
|
||||||
Always start a fresh chat for each workflow. This prevents context limitations from causing issues.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Step 2: Create Your Plan
|
|
||||||
|
|
||||||
With your project initialized, work through the planning phases.
|
|
||||||
|
|
||||||
### Phase 1: Analysis (Optional)
|
|
||||||
|
|
||||||
If you want to brainstorm or research first:
|
|
||||||
- **brainstorm-project** — Guided ideation with the Analyst
|
|
||||||
- **research** — Market and technical research
|
|
||||||
- **product-brief** — Recommended foundation document
|
|
||||||
|
|
||||||
### Phase 2: Planning (Required)
|
|
||||||
|
|
||||||
**Start a fresh chat** and load the **PM agent**.
|
|
||||||
|
|
||||||
```
|
|
||||||
Run prd
|
|
||||||
```
|
|
||||||
|
|
||||||
Or use shortcuts: `*prd`, select "create-prd" from the menu, or say "Let's create a PRD".
|
|
||||||
|
|
||||||
The PM agent guides you through:
|
|
||||||
1. **Project overview** — Refine your project description
|
|
||||||
2. **Goals and success metrics** — What does success look like?
|
|
||||||
3. **User personas** — Who uses this product?
|
|
||||||
4. **Functional requirements** — What must the system do?
|
|
||||||
5. **Non-functional requirements** — Performance, security, scalability needs
|
|
||||||
|
|
||||||
When complete, you'll have `PRD.md` in your `_bmad-output/` folder.
|
|
||||||
|
|
||||||
:::note[UX Design (Optional)]
|
|
||||||
If your project has a user interface, load the **UX-Designer agent** and run the UX design workflow after creating your PRD.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Phase 3: Solutioning (Required for BMad Method)
|
|
||||||
|
|
||||||
**Start a fresh chat** and load the **Architect agent**.
|
|
||||||
|
|
||||||
```
|
|
||||||
Run create-architecture
|
|
||||||
```
|
|
||||||
|
|
||||||
The architect guides you through technical decisions: tech stack, database design, API patterns, and system structure.
|
|
||||||
|
|
||||||
:::tip[Check Your Status]
|
|
||||||
Unsure what's next? Load any agent and run `workflow-status`. It tells you the next recommended or required workflow.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Step 3: Build Your Project
|
|
||||||
|
|
||||||
Once planning is complete, move to implementation.
|
|
||||||
|
|
||||||
### Initialize Sprint Planning
|
|
||||||
|
|
||||||
Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories.
|
|
||||||
|
|
||||||
### The Build Cycle
|
|
||||||
|
|
||||||
For each story, repeat this cycle with fresh chats:
|
|
||||||
|
|
||||||
| Step | Agent | Workflow | Purpose |
|
|
||||||
|------|-------|----------|---------|
|
|
||||||
| 1 | SM | `create-story` | Create story file from epic |
|
|
||||||
| 2 | DEV | `dev-story` | Implement the story |
|
|
||||||
| 3 | DEV | `code-review` | Quality validation *(recommended)* |
|
|
||||||
|
|
||||||
After completing all stories in an epic, load the **SM agent** and run `retrospective`.
|
|
||||||
|
|
||||||
## What You've Accomplished
|
|
||||||
|
|
||||||
You've learned the foundation of building with BMad:
|
|
||||||
|
|
||||||
- Installed BMad and configured it for your IDE
|
|
||||||
- Initialized a project with your chosen planning track
|
|
||||||
- Created planning documents (PRD, Architecture)
|
|
||||||
- Understood the build cycle for implementation
|
|
||||||
|
|
||||||
Your project now has:
|
|
||||||
|
|
||||||
```
|
|
||||||
your-project/
|
|
||||||
├── _bmad/ # BMad configuration
|
|
||||||
├── _bmad-output/
|
|
||||||
│ ├── PRD.md # Your requirements document
|
|
||||||
│ ├── architecture.md # Technical decisions
|
|
||||||
│ └── bmm-workflow-status.yaml # Progress tracking
|
|
||||||
└── ...
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick Reference
|
|
||||||
|
|
||||||
| Command | Agent | Purpose |
|
|
||||||
|---------|-------|---------|
|
|
||||||
| `*workflow-init` | Analyst | Initialize a new project |
|
|
||||||
| `*workflow-status` | Any | Check progress and next steps |
|
|
||||||
| `*prd` | PM | Create Product Requirements Document |
|
|
||||||
| `*create-architecture` | Architect | Create architecture document |
|
|
||||||
| `*sprint-planning` | SM | Initialize sprint tracking |
|
|
||||||
| `*create-story` | SM | Create a story file |
|
|
||||||
| `*dev-story` | DEV | Implement a story |
|
|
||||||
| `*code-review` | DEV | Review implemented code |
|
|
||||||
|
|
||||||
## Common Questions
|
|
||||||
|
|
||||||
**Do I need to create a PRD for every project?**
|
|
||||||
Only for BMad Method and Enterprise tracks. Quick Flow projects use a simpler tech-spec instead.
|
|
||||||
|
|
||||||
**Can I skip Phase 1 (Analysis)?**
|
|
||||||
Yes, Phase 1 is optional. If you already know what you're building, start with Phase 2 (Planning).
|
|
||||||
|
|
||||||
**What if I want to brainstorm first?**
|
|
||||||
Load the Analyst agent and run `*brainstorm-project` before `workflow-init`.
|
|
||||||
|
|
||||||
**Why start fresh chats for each workflow?**
|
|
||||||
Workflows are context-intensive. Reusing chats can cause the AI to hallucinate or lose track of details. Fresh chats ensure maximum context capacity.
|
|
||||||
|
|
||||||
## Getting Help
|
|
||||||
|
|
||||||
- **During workflows** — Agents guide you with questions and explanations
|
|
||||||
- **Check status** — Run `workflow-status` with any agent
|
|
||||||
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
|
||||||
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)
|
|
||||||
|
|
||||||
## Key Takeaways
|
|
||||||
|
|
||||||
:::tip[Remember These]
|
|
||||||
- **Always use fresh chats** — Load agents in new chats for each workflow
|
|
||||||
- **Let workflow-status guide you** — Ask any agent for status when unsure
|
|
||||||
- **Track matters** — Quick Flow uses tech-spec; Method/Enterprise need PRD and architecture
|
|
||||||
- **Tracking is automatic** — Status files update themselves
|
|
||||||
- **Agents are flexible** — Use menu numbers, shortcuts (`*prd`), or natural language
|
|
||||||
:::
|
|
||||||
|
|
||||||
Ready to start? Install BMad, load the Analyst, run `workflow-init`, and let the agents guide you.
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 126 KiB |
|
|
@ -0,0 +1,374 @@
|
||||||
|
---
|
||||||
|
title: "Game Types Reference"
|
||||||
|
---
|
||||||
|
|
||||||
|
BMGD supports 24 game type templates. Each adds genre-specific sections to your GDD.
|
||||||
|
|
||||||
|
## Game Types
|
||||||
|
|
||||||
|
### Action & Combat
|
||||||
|
|
||||||
|
#### Action Platformer
|
||||||
|
|
||||||
|
Side-scrolling or 3D platforming with combat mechanics.
|
||||||
|
|
||||||
|
**Examples:** Hollow Knight, Mega Man, Celeste
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Movement systems (jumps, dashes, wall mechanics)
|
||||||
|
- Combat mechanics (melee/ranged, combos)
|
||||||
|
- Level design patterns
|
||||||
|
- Boss design
|
||||||
|
|
||||||
|
#### Shooter
|
||||||
|
|
||||||
|
Projectile combat with aiming mechanics.
|
||||||
|
|
||||||
|
**Examples:** Doom, Call of Duty, Splatoon
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Weapon systems
|
||||||
|
- Aiming and accuracy
|
||||||
|
- Enemy AI patterns
|
||||||
|
- Level/arena design
|
||||||
|
- Multiplayer considerations
|
||||||
|
|
||||||
|
#### Fighting
|
||||||
|
|
||||||
|
1v1 combat with combos and frame data.
|
||||||
|
|
||||||
|
**Examples:** Street Fighter, Tekken, Super Smash Bros.
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Frame data systems
|
||||||
|
- Combo mechanics
|
||||||
|
- Character movesets
|
||||||
|
- Competitive balance
|
||||||
|
- Netcode requirements
|
||||||
|
|
||||||
|
### Strategy & Tactics
|
||||||
|
|
||||||
|
#### Strategy
|
||||||
|
|
||||||
|
Resource management with tactical decisions.
|
||||||
|
|
||||||
|
**Examples:** StarCraft, Civilization, Europa Universalis
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Resource systems
|
||||||
|
- Unit/building design
|
||||||
|
- AI opponent behavior
|
||||||
|
- Map/scenario design
|
||||||
|
- Victory conditions
|
||||||
|
|
||||||
|
#### Turn-Based Tactics
|
||||||
|
|
||||||
|
Grid-based movement with turn order.
|
||||||
|
|
||||||
|
**Examples:** XCOM, Fire Emblem, Into the Breach
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Grid and movement systems
|
||||||
|
- Turn order mechanics
|
||||||
|
- Cover and positioning
|
||||||
|
- Unit progression
|
||||||
|
- Procedural mission generation
|
||||||
|
|
||||||
|
#### Tower Defense
|
||||||
|
|
||||||
|
Wave-based defense with tower placement.
|
||||||
|
|
||||||
|
**Examples:** Bloons TD, Kingdom Rush, Plants vs. Zombies
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Tower types and upgrades
|
||||||
|
- Wave design and pacing
|
||||||
|
- Economy systems
|
||||||
|
- Map design patterns
|
||||||
|
- Meta-progression
|
||||||
|
|
||||||
|
### RPG & Progression
|
||||||
|
|
||||||
|
#### RPG
|
||||||
|
|
||||||
|
Character progression with stats, inventory, and quests.
|
||||||
|
|
||||||
|
**Examples:** Final Fantasy, The Witcher, Baldur's Gate
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Character stats and leveling
|
||||||
|
- Inventory and equipment
|
||||||
|
- Quest system design
|
||||||
|
- Combat system (action/turn-based)
|
||||||
|
- Skill trees and builds
|
||||||
|
|
||||||
|
#### Roguelike
|
||||||
|
|
||||||
|
Procedural generation with permadeath and run-based progression.
|
||||||
|
|
||||||
|
**Examples:** Hades, Dead Cells, Spelunky
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Procedural generation rules
|
||||||
|
- Permadeath and persistence
|
||||||
|
- Run structure and pacing
|
||||||
|
- Item/ability synergies
|
||||||
|
- Meta-progression systems
|
||||||
|
|
||||||
|
#### Metroidvania
|
||||||
|
|
||||||
|
Interconnected world with ability gating.
|
||||||
|
|
||||||
|
**Examples:** Metroid, Castlevania: Symphony of the Night, Ori
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- World map connectivity
|
||||||
|
- Ability gating design
|
||||||
|
- Backtracking flow
|
||||||
|
- Secret and collectible placement
|
||||||
|
- Power-up progression
|
||||||
|
|
||||||
|
### Narrative & Story
|
||||||
|
|
||||||
|
#### Adventure
|
||||||
|
|
||||||
|
Story-driven exploration with puzzle elements.
|
||||||
|
|
||||||
|
**Examples:** Monkey Island, Myst, Life is Strange
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Puzzle design
|
||||||
|
- Narrative delivery
|
||||||
|
- Exploration mechanics
|
||||||
|
- Dialogue systems
|
||||||
|
- Story branching
|
||||||
|
|
||||||
|
#### Visual Novel
|
||||||
|
|
||||||
|
Narrative choices with branching story.
|
||||||
|
|
||||||
|
**Examples:** Doki Doki Literature Club, Phoenix Wright, Steins;Gate
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Branching narrative structure
|
||||||
|
- Choice and consequence
|
||||||
|
- Character routes
|
||||||
|
- UI/presentation
|
||||||
|
- Save/load states
|
||||||
|
|
||||||
|
#### Text-Based
|
||||||
|
|
||||||
|
Text input/output games with parser or choice mechanics.
|
||||||
|
|
||||||
|
**Examples:** Zork, 80 Days, Dwarf Fortress (adventure mode)
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Parser or choice systems
|
||||||
|
- World model
|
||||||
|
- Narrative structure
|
||||||
|
- Text presentation
|
||||||
|
- Save state management
|
||||||
|
|
||||||
|
### Simulation & Management
|
||||||
|
|
||||||
|
#### Simulation
|
||||||
|
|
||||||
|
Realistic systems with management and building.
|
||||||
|
|
||||||
|
**Examples:** SimCity, RollerCoaster Tycoon, The Sims
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Core simulation loops
|
||||||
|
- Economy modeling
|
||||||
|
- AI agents/citizens
|
||||||
|
- Building/construction
|
||||||
|
- Failure states
|
||||||
|
|
||||||
|
#### Sandbox
|
||||||
|
|
||||||
|
Creative freedom with building and minimal objectives.
|
||||||
|
|
||||||
|
**Examples:** Minecraft, Terraria, Garry's Mod
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Creation tools
|
||||||
|
- Physics/interaction systems
|
||||||
|
- Persistence and saving
|
||||||
|
- Sharing/community features
|
||||||
|
- Optional objectives
|
||||||
|
|
||||||
|
### Sports & Racing
|
||||||
|
|
||||||
|
#### Racing
|
||||||
|
|
||||||
|
Vehicle control with tracks and lap times.
|
||||||
|
|
||||||
|
**Examples:** Mario Kart, Forza, Need for Speed
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Vehicle physics model
|
||||||
|
- Track design
|
||||||
|
- AI opponents
|
||||||
|
- Progression/career mode
|
||||||
|
- Multiplayer racing
|
||||||
|
|
||||||
|
#### Sports
|
||||||
|
|
||||||
|
Team-based or individual sports simulation.
|
||||||
|
|
||||||
|
**Examples:** FIFA, NBA 2K, Tony Hawk's Pro Skater
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Sport-specific rules
|
||||||
|
- Player/team management
|
||||||
|
- AI opponent behavior
|
||||||
|
- Season/career modes
|
||||||
|
- Multiplayer modes
|
||||||
|
|
||||||
|
### Multiplayer
|
||||||
|
|
||||||
|
#### MOBA
|
||||||
|
|
||||||
|
Multiplayer team battles with hero selection.
|
||||||
|
|
||||||
|
**Examples:** League of Legends, Dota 2, Smite
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Hero/champion design
|
||||||
|
- Lane and map design
|
||||||
|
- Team composition
|
||||||
|
- Matchmaking
|
||||||
|
- Economy (gold/items)
|
||||||
|
|
||||||
|
#### Party Game
|
||||||
|
|
||||||
|
Local multiplayer with minigames.
|
||||||
|
|
||||||
|
**Examples:** Mario Party, Jackbox, Overcooked
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Minigame design patterns
|
||||||
|
- Controller support
|
||||||
|
- Round/game structure
|
||||||
|
- Scoring systems
|
||||||
|
- Player count flexibility
|
||||||
|
|
||||||
|
### Horror & Survival
|
||||||
|
|
||||||
|
#### Survival
|
||||||
|
|
||||||
|
Resource gathering with crafting and persistent threats.
|
||||||
|
|
||||||
|
**Examples:** Don't Starve, Subnautica, The Forest
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Resource gathering
|
||||||
|
- Crafting systems
|
||||||
|
- Hunger/health/needs
|
||||||
|
- Threat systems
|
||||||
|
- Base building
|
||||||
|
|
||||||
|
#### Horror
|
||||||
|
|
||||||
|
Atmosphere and tension with limited resources.
|
||||||
|
|
||||||
|
**Examples:** Resident Evil, Silent Hill, Amnesia
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Fear mechanics
|
||||||
|
- Resource scarcity
|
||||||
|
- Sound design
|
||||||
|
- Lighting and visibility
|
||||||
|
- Enemy/threat design
|
||||||
|
|
||||||
|
### Casual & Progression
|
||||||
|
|
||||||
|
#### Puzzle
|
||||||
|
|
||||||
|
Logic-based challenges and problem-solving.
|
||||||
|
|
||||||
|
**Examples:** Tetris, Portal, The Witness
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Puzzle mechanics
|
||||||
|
- Difficulty progression
|
||||||
|
- Hint systems
|
||||||
|
- Level structure
|
||||||
|
- Scoring/rating
|
||||||
|
|
||||||
|
#### Idle/Incremental
|
||||||
|
|
||||||
|
Passive progression with upgrades and automation.
|
||||||
|
|
||||||
|
**Examples:** Cookie Clicker, Adventure Capitalist, Clicker Heroes
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Core loop design
|
||||||
|
- Prestige systems
|
||||||
|
- Automation unlocks
|
||||||
|
- Number scaling
|
||||||
|
- Offline progress
|
||||||
|
|
||||||
|
#### Card Game
|
||||||
|
|
||||||
|
Deck building with card mechanics.
|
||||||
|
|
||||||
|
**Examples:** Slay the Spire, Hearthstone, Magic: The Gathering Arena
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Card design framework
|
||||||
|
- Deck building rules
|
||||||
|
- Mana/resource systems
|
||||||
|
- Rarity and collection
|
||||||
|
- Competitive balance
|
||||||
|
|
||||||
|
### Rhythm
|
||||||
|
|
||||||
|
#### Rhythm
|
||||||
|
|
||||||
|
Music synchronization with timing-based gameplay.
|
||||||
|
|
||||||
|
**Examples:** Guitar Hero, Beat Saber, Crypt of the NecroDancer
|
||||||
|
|
||||||
|
**GDD sections:**
|
||||||
|
|
||||||
|
- Note/beat mapping
|
||||||
|
- Scoring systems
|
||||||
|
- Difficulty levels
|
||||||
|
- Music licensing
|
||||||
|
- Input methods
|
||||||
|
|
||||||
|
## Hybrid Types
|
||||||
|
|
||||||
|
Multiple game types can be combined. GDD sections from all selected types are included.
|
||||||
|
|
||||||
|
| Hybrid | Components | Combined Sections |
|
||||||
|
|--------|------------|-------------------|
|
||||||
|
| Action RPG | Action Platformer + RPG | Movement, combat, stats, inventory |
|
||||||
|
| Survival Horror | Survival + Horror | Resources, crafting, atmosphere, fear |
|
||||||
|
| Roguelike Deckbuilder | Roguelike + Card Game | Run structure, procedural gen, cards |
|
||||||
|
| Tactical RPG | Turn-Based Tactics + RPG | Grid movement, stats, progression |
|
||||||
|
| Open World Survival | Sandbox + Survival | Building, crafting, exploration |
|
||||||
|
|
@ -0,0 +1,113 @@
|
||||||
|
---
|
||||||
|
title: "BMGD Quick Guide"
|
||||||
|
description: Quick reference for BMad Game Dev Studio
|
||||||
|
---
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
# BMGD Quick Guide
|
||||||
|
|
||||||
|
BMad Game Dev Studio (BMGD) extends BMM with game-specific capabilities. Developed by game industry veterans, it guides you through product research, technical design, narrative design, and a full epic-driven production cycle.
|
||||||
|
|
||||||
|
## Under Construction
|
||||||
|
|
||||||
|
Documentation is under heavy construction catching up with the new beta release. We'll have complete documentation up as soon as possible. For now, please ask in the BMGD section of the Discord if you have any questions.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
**Install → Game Brief → GDD → (Narrative) → Architecture → Build**
|
||||||
|
|
||||||
|
BMGD is an optional module installed via BMAD Method: `npx bmad-method install`
|
||||||
|
|
||||||
|
See [How-To Reference](#how-to-reference) for commands.
|
||||||
|
|
||||||
|
## Development Phases
|
||||||
|
|
||||||
|
| Phase | Name | Key Activities |
|
||||||
|
|-------|------|----------------|
|
||||||
|
| 1 | **Preproduction** | Brainstorm Game, Game Brief, market research |
|
||||||
|
| 2 | **Design** | GDD creation, Narrative Design (for story-driven games) |
|
||||||
|
| 3 | **Technical** | Game Architecture (engine, systems, patterns) |
|
||||||
|
| 4 | **Production** | Sprint planning, story development, code review, testing |
|
||||||
|
|
||||||
|
## BMGD Agents
|
||||||
|
|
||||||
|
| Agent | Purpose |
|
||||||
|
|-------|---------|
|
||||||
|
| Game Designer | Game mechanics, balance, player psychology |
|
||||||
|
| Game Developer | Implementation with engine-specific patterns |
|
||||||
|
| Game Architect | Engine selection, systems design, technical structure |
|
||||||
|
| Game Scrum Master | Sprint planning and epic management |
|
||||||
|
| Game QA | Playtesting, engine-specific testing, performance profiling |
|
||||||
|
| Game Solo Dev | Full-stack game development for solo projects |
|
||||||
|
|
||||||
|
## Key Documents
|
||||||
|
|
||||||
|
| Document | Purpose |
|
||||||
|
|----------|---------|
|
||||||
|
| **Game Brief** | Vision, market positioning, fundamentals |
|
||||||
|
| **GDD** | Core loop, mechanics, progression, art/audio direction |
|
||||||
|
| **Narrative Design** | Story structure, characters, world-building, dialogue |
|
||||||
|
| **Architecture** | Engine, systems, patterns, project structure |
|
||||||
|
|
||||||
|
## Game Type Templates
|
||||||
|
|
||||||
|
BMGD includes 24 game type templates that auto-configure GDD sections:
|
||||||
|
|
||||||
|
Action, Adventure, Puzzle, RPG, Strategy, Simulation, Sports, Racing, Fighting, Horror, Platformer, Shooter, and more.
|
||||||
|
|
||||||
|
Each template provides genre-specific GDD sections, mechanics patterns, testing considerations, and common pitfalls to avoid.
|
||||||
|
|
||||||
|
## Explanation: BMGD vs BMM
|
||||||
|
|
||||||
|
### When to Use Each
|
||||||
|
|
||||||
|
| Use BMGD for | Use BMM for |
|
||||||
|
|--------------|-------------|
|
||||||
|
| Video games | Web applications |
|
||||||
|
| Interactive experiences | APIs and services |
|
||||||
|
| Game prototyping | Mobile apps (non-game) |
|
||||||
|
| Game jams | General software projects |
|
||||||
|
|
||||||
|
### Phase Mapping
|
||||||
|
|
||||||
|
| BMM Phase | BMGD Phase | Key Difference |
|
||||||
|
|-----------|------------|----------------|
|
||||||
|
| Analysis | Preproduction | Game concepts, Game Brief instead of Product Brief |
|
||||||
|
| Planning | Design | GDD instead of PRD; optional Narrative Design |
|
||||||
|
| Solutioning | Technical | Focus on engine selection, game-specific patterns |
|
||||||
|
| Implementation | Production | Game QA replaces TEA; engine-specific testing |
|
||||||
|
|
||||||
|
### Document Differences
|
||||||
|
|
||||||
|
| BMM | BMGD | Notes |
|
||||||
|
|-----|------|-------|
|
||||||
|
| Product Brief | Game Brief | Captures vision, market, fundamentals |
|
||||||
|
| PRD | GDD | Includes mechanics, balance, player experience |
|
||||||
|
| N/A | Narrative Design | Story, characters, world (story-driven games) |
|
||||||
|
| Architecture | Architecture | BMGD version includes engine-specific patterns and considerations |
|
||||||
|
|
||||||
|
### Testing Differences
|
||||||
|
|
||||||
|
**BMM (TEA):** Web-focused testing with Playwright, Cypress, API testing, E2E for web apps.
|
||||||
|
|
||||||
|
**BMGD (Game QA):** Engine-specific frameworks (Unity, Unreal, Godot), gameplay testing, performance profiling, playtest planning, balance validation.
|
||||||
|
|
||||||
|
## How-To Reference
|
||||||
|
|
||||||
|
| I need to... | Action |
|
||||||
|
|--------------|--------------------------------------------------------------------------------------------------------|
|
||||||
|
| Install BMGD | Run `npx bmad-method install` and select BMGD during module installation |
|
||||||
|
| Start a new game | Run `/bmad-gds-brainstorm-game`, then `/bmad:gds:create-game-brief` |
|
||||||
|
| Design my game | Run `/bmad-gds-create-gdd`; add `/bmad:gds:narrative` if story-heavy |
|
||||||
|
| Plan architecture | Run `/bmad-gds-game-architecture` with Game Architect |
|
||||||
|
| Build my game | Use Phase 4 production workflows - Run `/bmad-help` to see what's next |
|
||||||
|
| Test an idea quickly | Use [Quick-Flow](quick-flow-workflows.md) for rapid prototyping |
|
||||||
|
|
||||||
|
## Further Reading
|
||||||
|
|
||||||
|
- [Game Types Guide](game-types.md)
|
||||||
|
- [Quick-Flow Guide](quick-flow-workflows.md)
|
||||||
|
|
||||||
|
|
@ -0,0 +1,160 @@
|
||||||
|
---
|
||||||
|
title: "Quick Flow Workflows"
|
||||||
|
---
|
||||||
|
|
||||||
|
How to create tech specs and execute implementations with Quick Flow.
|
||||||
|
|
||||||
|
## Choosing a Workflow
|
||||||
|
|
||||||
|
| Situation | Workflow | Command |
|
||||||
|
|-----------|----------|---------|
|
||||||
|
| Need to document before implementing | Quick-Spec | `/bmad-gds-quick-spec` |
|
||||||
|
| Multiple approaches to evaluate | Quick-Spec | `/bmad-gds-quick-spec` |
|
||||||
|
| Have a completed tech-spec | Quick-Dev | `/bmad-gds-quick-dev path/to/spec.md` |
|
||||||
|
| Have clear, direct instructions | Quick-Dev | `/bmad-gds-quick-dev` |
|
||||||
|
| Building complete game system | Full GDS | `/bmad-gds-workflow-init` |
|
||||||
|
| Epic-level features | Full GDS | `/bmad-gds-workflow-init` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How to Create a Tech Spec (Quick-Spec)
|
||||||
|
|
||||||
|
### Step 1: Start the workflow
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/bmad-gds-quick-spec
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Describe your requirement
|
||||||
|
|
||||||
|
Provide your feature request. The agent scans the codebase and asks clarifying questions.
|
||||||
|
|
||||||
|
**Checkpoint options:**
|
||||||
|
- `[a]` Advanced Elicitation - explore requirements deeper
|
||||||
|
- `[c]` Continue to investigation
|
||||||
|
- `[p]` Party Mode - consult expert agents
|
||||||
|
|
||||||
|
### Step 3: Review investigation findings
|
||||||
|
|
||||||
|
The agent analyzes the codebase for patterns, constraints, and similar implementations. Review the findings.
|
||||||
|
|
||||||
|
**Checkpoint options:**
|
||||||
|
- `[c]` Continue to spec generation
|
||||||
|
- `[p]` Party Mode - get technical review
|
||||||
|
|
||||||
|
### Step 4: Review generated spec
|
||||||
|
|
||||||
|
The agent creates an ordered task list with file paths and acceptance criteria. Verify completeness.
|
||||||
|
|
||||||
|
**Checkpoint options:**
|
||||||
|
- `[c]` Continue to final review
|
||||||
|
- `[p]` Party Mode - technical review
|
||||||
|
|
||||||
|
### Step 5: Finalize
|
||||||
|
|
||||||
|
Confirm the spec meets these standards:
|
||||||
|
- Every task has a file path and specific action
|
||||||
|
- Tasks ordered by dependency
|
||||||
|
- Acceptance criteria in Given/When/Then format
|
||||||
|
- No placeholders or TBD sections
|
||||||
|
|
||||||
|
**Options:**
|
||||||
|
- `[d]` Start Quick-Dev immediately
|
||||||
|
- `[done]` Save spec and exit
|
||||||
|
|
||||||
|
**Output:** `{planning_artifacts}/tech-spec-{slug}.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How to Execute Implementation (Quick-Dev)
|
||||||
|
|
||||||
|
### With a Tech-Spec
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/bmad-gds-quick-dev path/to/tech-spec-feature.md
|
||||||
|
```
|
||||||
|
|
||||||
|
The agent:
|
||||||
|
1. Captures baseline git commit
|
||||||
|
2. Loads and validates the spec
|
||||||
|
3. Executes tasks in order
|
||||||
|
4. Runs self-check
|
||||||
|
5. Performs adversarial review
|
||||||
|
6. Resolves findings
|
||||||
|
7. Validates against acceptance criteria
|
||||||
|
|
||||||
|
### With Direct Instructions
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/bmad-gds-quick-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Then describe what you want implemented:
|
||||||
|
1. Captures baseline git commit
|
||||||
|
2. Evaluates complexity (may suggest planning)
|
||||||
|
3. Gathers context from codebase
|
||||||
|
4. Executes implementation
|
||||||
|
5. Runs self-check and adversarial review
|
||||||
|
6. Resolves findings
|
||||||
|
|
||||||
|
**Escalation:** If the agent detects complexity (multiple components, system-level scope, uncertainty), it offers:
|
||||||
|
- `[t]` Create tech-spec first
|
||||||
|
- `[w]` Use full GDS workflow
|
||||||
|
- `[e]` Execute anyway
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Spec has placeholders or TBD sections
|
||||||
|
|
||||||
|
Return to investigation step. Complete missing research, inline all findings, re-run review.
|
||||||
|
|
||||||
|
### Workflow lost context mid-step
|
||||||
|
|
||||||
|
Check frontmatter for `stepsCompleted`. Resume from last completed step.
|
||||||
|
|
||||||
|
### Agent suggested planning but you want to execute
|
||||||
|
|
||||||
|
You can override with `[e]`, but document your assumptions. Escalation heuristics exist because planning saves time on complex tasks.
|
||||||
|
|
||||||
|
### Tests failing after implementation
|
||||||
|
|
||||||
|
Return to the resolve-findings step. Review failures, fix issues, ensure test expectations are correct, re-run full suite.
|
||||||
|
|
||||||
|
### Need help
|
||||||
|
|
||||||
|
```bash
|
||||||
|
/bmad-help
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
### File Locations
|
||||||
|
|
||||||
|
| File | Location |
|
||||||
|
|------|----------|
|
||||||
|
| Work in progress | `{implementation_artifacts}/tech-spec-wip.md` |
|
||||||
|
| Completed specs | `{planning_artifacts}/tech-spec-{slug}.md` |
|
||||||
|
| Archived specs | `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md` |
|
||||||
|
| Workflow files | `_bmad/gds/workflows/gds-quick-flow/` |
|
||||||
|
|
||||||
|
### Validation Criteria
|
||||||
|
|
||||||
|
**Self-check (before adversarial review):**
|
||||||
|
- All tasks/instructions completed
|
||||||
|
- Tests written and passing
|
||||||
|
- Follows existing patterns
|
||||||
|
- No obvious bugs
|
||||||
|
- Acceptance criteria met
|
||||||
|
- Code is readable
|
||||||
|
|
||||||
|
**Adversarial review:**
|
||||||
|
- Correctness
|
||||||
|
- Security
|
||||||
|
- Performance
|
||||||
|
- Maintainability
|
||||||
|
- Test coverage
|
||||||
|
- Error handling
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 118 KiB |
|
|
@ -6,19 +6,21 @@ Download BMad Method resources for offline use, AI training, or integration.
|
||||||
|
|
||||||
## Source Bundles
|
## Source Bundles
|
||||||
|
|
||||||
|
Download these from the `downloads/` folder on the documentation site.
|
||||||
|
|
||||||
| File | Description |
|
| File | Description |
|
||||||
|------|-------------|
|
| ------------------ | ------------------------------- |
|
||||||
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMad source files |
|
| `bmad-sources.zip` | Complete BMad source files |
|
||||||
| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only |
|
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
||||||
|
|
||||||
## LLM-Optimized Files
|
## LLM-Optimized Files
|
||||||
|
|
||||||
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window.
|
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
|
||||||
|
|
||||||
| File | Description | Use Case |
|
| File | Description | Use Case |
|
||||||
|------|-------------|----------|
|
| --------------- | ----------------------------------- | -------------------------- |
|
||||||
| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation |
|
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
||||||
| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading |
|
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
||||||
|
|
||||||
### Using with LLMs
|
### Using with LLMs
|
||||||
|
|
||||||
|
|
@ -41,12 +43,12 @@ docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt")
|
||||||
|
|
||||||
## Installation Options
|
## Installation Options
|
||||||
|
|
||||||
### NPM (Recommended)
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx bmad-method@alpha install
|
npx bmad-method install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
[More details](/docs/how-to/install-bmad.md)
|
||||||
|
|
||||||
## Version Information
|
## Version Information
|
||||||
|
|
||||||
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,24 @@
|
||||||
|
---
|
||||||
|
title: "Advanced Elicitation"
|
||||||
|
description: Push the LLM to rethink its work using structured reasoning methods
|
||||||
|
---
|
||||||
|
|
||||||
|
Make the LLM reconsider what it just generated. You pick a reasoning method, it applies that method to its own output, you decide whether to keep the improvements.
|
||||||
|
|
||||||
|
Dozens of methods are built in - things like First Principles, Red Team vs Blue Team, Pre-mortem Analysis, Socratic Questioning, and more.
|
||||||
|
|
||||||
|
## When to Use It
|
||||||
|
|
||||||
|
- After a workflow generates content and you want alternatives
|
||||||
|
- When output seems okay but you suspect there's more depth
|
||||||
|
- To stress-test assumptions or find weaknesses
|
||||||
|
- For high-stakes content where rethinking helps
|
||||||
|
|
||||||
|
Workflows offer advanced elicitation at decision points - after the LLM has generated something, you'll be asked if you want to run it.
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. LLM suggests 5 relevant methods for your content
|
||||||
|
2. You pick one (or reshuffle for different options)
|
||||||
|
3. Method is applied, improvements shown
|
||||||
|
4. Accept or discard, repeat or continue
|
||||||
|
|
@ -0,0 +1,57 @@
|
||||||
|
---
|
||||||
|
title: "Adversarial Review"
|
||||||
|
description: Forced reasoning technique that prevents lazy "looks good" reviews
|
||||||
|
---
|
||||||
|
|
||||||
|
Force deeper analysis by requiring problems to be found.
|
||||||
|
|
||||||
|
## What is Adversarial Review?
|
||||||
|
|
||||||
|
A review technique where the reviewer *must* find issues. No "looks good" allowed. The reviewer adopts a cynical stance - assume problems exist and find them.
|
||||||
|
|
||||||
|
This isn't about being negative. It's about forcing genuine analysis instead of a cursory glance that rubber-stamps whatever was submitted.
|
||||||
|
|
||||||
|
**The core rule:** You must find issues. Zero findings triggers a halt - re-analyze or explain why.
|
||||||
|
|
||||||
|
## Why It Works
|
||||||
|
|
||||||
|
Normal reviews suffer from confirmation bias. You skim the work, nothing jumps out, you approve it. The "find problems" mandate breaks this pattern:
|
||||||
|
|
||||||
|
- **Forces thoroughness** - Can't approve until you've looked hard enough to find issues
|
||||||
|
- **Catches missing things** - "What's not here?" becomes a natural question
|
||||||
|
- **Improves signal quality** - Findings are specific and actionable, not vague concerns
|
||||||
|
- **Information asymmetry** - Run reviews with fresh context (no access to original reasoning) so you evaluate the artifact, not the intent
|
||||||
|
|
||||||
|
## Where It's Used
|
||||||
|
|
||||||
|
Adversarial review appears throughout BMAD workflows - code review, implementation readiness checks, spec validation, and others. Sometimes it's a required step, sometimes optional (like advanced elicitation or party mode). The pattern adapts to whatever artifact needs scrutiny.
|
||||||
|
|
||||||
|
## Human Filtering Required
|
||||||
|
|
||||||
|
Because the AI is *instructed* to find problems, it will find problems - even when they don't exist. Expect false positives: nitpicks dressed as issues, misunderstandings of intent, or outright hallucinated concerns.
|
||||||
|
|
||||||
|
**You decide what's real.** Review each finding, dismiss the noise, fix what matters.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Instead of:
|
||||||
|
|
||||||
|
> "The authentication implementation looks reasonable. Approved."
|
||||||
|
|
||||||
|
An adversarial review produces:
|
||||||
|
|
||||||
|
> 1. **HIGH** - `login.ts:47` - No rate limiting on failed attempts
|
||||||
|
> 2. **HIGH** - Session token stored in localStorage (XSS vulnerable)
|
||||||
|
> 3. **MEDIUM** - Password validation happens client-side only
|
||||||
|
> 4. **MEDIUM** - No audit logging for failed login attempts
|
||||||
|
> 5. **LOW** - Magic number `3600` should be `SESSION_TIMEOUT_SECONDS`
|
||||||
|
|
||||||
|
The first review might miss a security vulnerability. The second caught four.
|
||||||
|
|
||||||
|
## Iteration and Diminishing Returns
|
||||||
|
|
||||||
|
After addressing findings, consider running it again. A second pass usually catches more. A third isn't always useless either. But each pass takes time, and eventually you hit diminishing returns - just nitpicks and false findings.
|
||||||
|
|
||||||
|
:::tip[Better Reviews]
|
||||||
|
Assume problems exist. Look for what's missing, not just what's wrong.
|
||||||
|
:::
|
||||||
|
|
@ -1,340 +0,0 @@
|
||||||
---
|
|
||||||
title: "Quick Flow Solo Dev Agent (Barry)"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
|
|
||||||
**Icon:** 🚀
|
|
||||||
**Module:** BMM
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Barry is the elite solo developer who lives and breathes the BMad Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev.
|
|
||||||
|
|
||||||
### Agent Persona
|
|
||||||
|
|
||||||
**Name:** Barry
|
|
||||||
**Title:** Quick Flow Solo Dev
|
|
||||||
|
|
||||||
**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMad Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams.
|
|
||||||
|
|
||||||
**Communication Style:** Direct, confident, and implementation-focused. Uses tech slang and gets straight to the point. No fluff, just results. Every response moves the project forward.
|
|
||||||
|
|
||||||
**Core Principles:**
|
|
||||||
|
|
||||||
- Planning and execution are two sides of the same coin
|
|
||||||
- Quick Flow is my religion
|
|
||||||
- Specs are for building, not bureaucracy
|
|
||||||
- Code that ships is better than perfect code that doesn't
|
|
||||||
- Documentation happens alongside development, not after
|
|
||||||
- Ship early, ship often
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Menu Commands
|
|
||||||
|
|
||||||
Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
|
|
||||||
|
|
||||||
### 1. **quick-spec**
|
|
||||||
|
|
||||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md`
|
|
||||||
- **Description:** Architect a technical spec with implementation-ready stories
|
|
||||||
- **Use when:** You need to transform requirements into a buildable spec
|
|
||||||
|
|
||||||
### 2. **quick-dev**
|
|
||||||
|
|
||||||
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml`
|
|
||||||
- **Description:** Ship features from spec or direct instructions - no handoffs
|
|
||||||
- **Use when:** You're ready to ship code based on a spec or clear instructions
|
|
||||||
|
|
||||||
### 3. **code-review**
|
|
||||||
|
|
||||||
- **Workflow:** `_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml`
|
|
||||||
- **Description:** Review code for quality, patterns, and acceptance criteria
|
|
||||||
- **Use when:** You need to validate implementation quality
|
|
||||||
|
|
||||||
### 4. **party-mode**
|
|
||||||
|
|
||||||
- **Workflow:** `_bmad/core/workflows/party-mode/workflow.yaml`
|
|
||||||
- **Description:** Bring in other experts when I need specialized backup
|
|
||||||
- **Use when:** You need collaborative problem-solving or specialized expertise
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Barry
|
|
||||||
|
|
||||||
### Ideal Scenarios
|
|
||||||
|
|
||||||
1. **Quick Flow Development** - Small to medium features that need rapid delivery
|
|
||||||
2. **Technical Specification Creation** - When you need detailed implementation plans
|
|
||||||
3. **Direct Development** - When requirements are clear and you want to skip extensive planning
|
|
||||||
4. **Code Reviews** - When you need senior-level technical validation
|
|
||||||
5. **Performance-Critical Features** - When optimization and scalability are paramount
|
|
||||||
|
|
||||||
### Project Types
|
|
||||||
|
|
||||||
- **Greenfield Projects** - New features or components
|
|
||||||
- **Brownfield Modifications** - Enhancements to existing codebases
|
|
||||||
- **Bug Fixes** - Complex issues requiring deep technical understanding
|
|
||||||
- **Proof of Concepts** - Rapid prototyping with production-quality code
|
|
||||||
- **Performance Optimizations** - System improvements and scalability work
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The BMad Quick Flow Process
|
|
||||||
|
|
||||||
Barry orchestrates a simple, efficient 3-step process:
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart LR
|
|
||||||
A[Requirements] --> B[quick-spec]
|
|
||||||
B --> C[Tech Spec]
|
|
||||||
C --> D[quick-dev]
|
|
||||||
D --> E[Implementation]
|
|
||||||
E --> F{Code Review?}
|
|
||||||
F -->|Yes| G[code-review]
|
|
||||||
F -->|No| H[Complete]
|
|
||||||
G --> H[Complete]
|
|
||||||
|
|
||||||
style A fill:#e1f5fe
|
|
||||||
style B fill:#f3e5f5
|
|
||||||
style C fill:#e8f5e9
|
|
||||||
style D fill:#fff3e0
|
|
||||||
style E fill:#fce4ec
|
|
||||||
style G fill:#f1f8e9
|
|
||||||
style H fill:#e0f2f1
|
|
||||||
```
|
|
||||||
|
|
||||||
### Step 1: Technical Specification (`quick-spec`)
|
|
||||||
|
|
||||||
**Goal:** Transform user requirements into implementation-ready technical specifications
|
|
||||||
|
|
||||||
**Process:**
|
|
||||||
|
|
||||||
1. **Problem Understanding** - Clarify requirements, scope, and constraints
|
|
||||||
2. **Code Investigation** - Analyze existing patterns and dependencies (if applicable)
|
|
||||||
3. **Specification Generation** - Create comprehensive tech spec with:
|
|
||||||
- Problem statement and solution overview
|
|
||||||
- Development context and patterns
|
|
||||||
- Implementation tasks with acceptance criteria
|
|
||||||
- Technical decisions and dependencies
|
|
||||||
4. **Review and Finalize** - Validate spec captures user intent
|
|
||||||
|
|
||||||
**Output:** `tech-spec-{slug}.md` saved to sprint artifacts
|
|
||||||
|
|
||||||
**Best Practices:**
|
|
||||||
|
|
||||||
- Include ALL context a fresh dev agent needs
|
|
||||||
- Be specific about files, patterns, and conventions
|
|
||||||
- Define clear acceptance criteria using Given/When/Then format
|
|
||||||
- Document technical decisions and trade-offs
|
|
||||||
|
|
||||||
### Step 2: Development (`quick-dev`)
|
|
||||||
|
|
||||||
**Goal:** Execute implementation based on tech spec or direct instructions
|
|
||||||
|
|
||||||
**Two Modes:**
|
|
||||||
|
|
||||||
**Mode A: Tech-Spec Driven**
|
|
||||||
|
|
||||||
- Load existing tech spec
|
|
||||||
- Extract tasks, context, and acceptance criteria
|
|
||||||
- Execute all tasks continuously without stopping
|
|
||||||
- Respect project context and existing patterns
|
|
||||||
|
|
||||||
**Mode B: Direct Instructions**
|
|
||||||
|
|
||||||
- Accept direct development commands
|
|
||||||
- Offer optional planning step
|
|
||||||
- Execute with minimal friction
|
|
||||||
|
|
||||||
**Process:**
|
|
||||||
|
|
||||||
1. **Load Project Context** - Understand patterns and conventions
|
|
||||||
2. **Execute Implementation** - Work through all tasks:
|
|
||||||
- Load relevant files and context
|
|
||||||
- Implement following established patterns
|
|
||||||
- Write and run tests
|
|
||||||
- Handle errors appropriately
|
|
||||||
3. **Verify Completion** - Ensure all tasks complete, tests passing, AC satisfied
|
|
||||||
|
|
||||||
### Step 3: Code Review (`code-review`) - Optional
|
|
||||||
|
|
||||||
**Goal:** Senior developer review of implemented code
|
|
||||||
|
|
||||||
**When to Use:**
|
|
||||||
|
|
||||||
- Critical production features
|
|
||||||
- Complex architectural changes
|
|
||||||
- Performance-sensitive implementations
|
|
||||||
- Team development scenarios
|
|
||||||
- Learning and knowledge transfer
|
|
||||||
|
|
||||||
**Review Focus:**
|
|
||||||
|
|
||||||
- Code quality and patterns
|
|
||||||
- Acceptance criteria compliance
|
|
||||||
- Performance and scalability
|
|
||||||
- Security considerations
|
|
||||||
- Maintainability and documentation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Collaboration with Other Agents
|
|
||||||
|
|
||||||
### Natural Partnerships
|
|
||||||
|
|
||||||
- **Tech Writer** - For documentation and API specs when I need it
|
|
||||||
- **Architect** - For complex system design decisions beyond Quick Flow scope
|
|
||||||
- **Dev** - For implementation pair programming (rarely needed)
|
|
||||||
- **QA** - For test strategy and quality gates on critical features
|
|
||||||
- **UX Designer** - For user experience considerations
|
|
||||||
|
|
||||||
### Party Mode Composition
|
|
||||||
|
|
||||||
In party mode, Barry often acts as:
|
|
||||||
|
|
||||||
- **Solo Tech Lead** - Guiding architectural decisions
|
|
||||||
- **Implementation Expert** - Providing coding insights
|
|
||||||
- **Performance Optimizer** - Ensuring scalable solutions
|
|
||||||
- **Code Review Authority** - Validating technical approaches
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips for Working with Barry
|
|
||||||
|
|
||||||
### For Best Results
|
|
||||||
|
|
||||||
1. **Be Specific** - Provide clear requirements and constraints
|
|
||||||
2. **Share Context** - Include relevant files and patterns
|
|
||||||
3. **Define Success** - Clear acceptance criteria lead to better outcomes
|
|
||||||
4. **Trust the Process** - The 3-step flow is optimized for speed and quality
|
|
||||||
5. **Leverage Expertise** - I'll give you optimization and architectural insights automatically
|
|
||||||
|
|
||||||
### Communication Patterns
|
|
||||||
|
|
||||||
- **Git Commit Style** - "feat: Add user authentication with OAuth 2.0"
|
|
||||||
- **RFC Style** - "Proposing microservice architecture for scalability"
|
|
||||||
- **Direct Questions** - "Actually, have you considered the race condition?"
|
|
||||||
- **Technical Trade-offs** - "We could optimize for speed over memory here"
|
|
||||||
|
|
||||||
### Avoid These Common Mistakes
|
|
||||||
|
|
||||||
1. **Vague Requirements** - Leads to unnecessary back-and-forth
|
|
||||||
2. **Ignoring Patterns** - Causes technical debt and inconsistencies
|
|
||||||
3. **Skipping Code Review** - Missed opportunities for quality improvement
|
|
||||||
4. **Over-planning** - I excel at rapid, pragmatic development
|
|
||||||
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Workflow
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Start with Barry
|
|
||||||
/bmad:bmm:agents:quick-flow-solo-dev
|
|
||||||
|
|
||||||
# Create a tech spec
|
|
||||||
> quick-spec
|
|
||||||
|
|
||||||
# Quick implementation
|
|
||||||
> quick-dev tech-spec-auth.md
|
|
||||||
|
|
||||||
# Optional code review
|
|
||||||
> code-review
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sample Tech Spec Structure
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Tech-Spec: User Authentication System
|
|
||||||
|
|
||||||
**Created:** 2025-01-15
|
|
||||||
**Status:** Ready for Development
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
### Problem Statement
|
|
||||||
|
|
||||||
Users cannot securely access the application, and we need role-based permissions for enterprise features.
|
|
||||||
|
|
||||||
### Solution
|
|
||||||
|
|
||||||
Implement OAuth 2.0 authentication with JWT tokens and role-based access control (RBAC).
|
|
||||||
|
|
||||||
### Scope (In/Out)
|
|
||||||
|
|
||||||
**In:** Login, logout, password reset, role management
|
|
||||||
**Out:** Social login, SSO, multi-factor authentication (Phase 2)
|
|
||||||
|
|
||||||
## Context for Development
|
|
||||||
|
|
||||||
### Codebase Patterns
|
|
||||||
|
|
||||||
- Use existing auth middleware pattern in `src/middleware/auth.js`
|
|
||||||
- Follow service layer pattern from `src/services/`
|
|
||||||
- JWT secrets managed via environment variables
|
|
||||||
|
|
||||||
### Files to Reference
|
|
||||||
|
|
||||||
- `src/middleware/auth.js` - Authentication middleware
|
|
||||||
- `src/models/User.js` - User data model
|
|
||||||
- `config/database.js` - Database connection
|
|
||||||
|
|
||||||
### Technical Decisions
|
|
||||||
|
|
||||||
- JWT tokens over sessions for API scalability
|
|
||||||
- bcrypt for password hashing
|
|
||||||
- Role-based permissions stored in database
|
|
||||||
|
|
||||||
## Implementation Plan
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
|
|
||||||
- [ ] Create authentication service
|
|
||||||
- [ ] Implement login/logout endpoints
|
|
||||||
- [ ] Add JWT middleware
|
|
||||||
- [ ] Create role-based permissions
|
|
||||||
- [ ] Write comprehensive tests
|
|
||||||
|
|
||||||
### Acceptance Criteria
|
|
||||||
|
|
||||||
- [ ] Given valid credentials, when user logs in, then receive JWT token
|
|
||||||
- [ ] Given invalid token, when accessing protected route, then return 401
|
|
||||||
- [ ] Given admin role, when accessing admin endpoint, then allow access
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
|
|
||||||
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Complete agent reference
|
|
||||||
- **[Four Phases](/docs/explanation/architecture/four-phases.md)** - Understanding development tracks
|
|
||||||
- **[Workflow Implementation](/docs/how-to/workflows/run-sprint-planning.md)** - Implementation workflows
|
|
||||||
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Frequently Asked Questions
|
|
||||||
|
|
||||||
**Q: When should I use Barry vs other agents?**
|
|
||||||
A: Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
|
|
||||||
|
|
||||||
**Q: Is the code review step mandatory?**
|
|
||||||
A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
|
|
||||||
|
|
||||||
**Q: Can I skip the tech spec step?**
|
|
||||||
A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
|
|
||||||
|
|
||||||
**Q: How does Barry differ from the Dev agent?**
|
|
||||||
A: Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
|
|
||||||
|
|
||||||
**Q: Can Barry handle enterprise-scale projects?**
|
|
||||||
A: For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev`
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
---
|
|
||||||
title: "Understanding Agents"
|
|
||||||
description: Understanding BMad agents and their roles
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Comprehensive guides to BMad's AI agents - their roles, capabilities, and how to work with them effectively.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Guides
|
|
||||||
|
|
||||||
### BMM Agents
|
|
||||||
|
|
||||||
- **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities
|
|
||||||
- **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** - The dedicated agent for rapid development
|
|
||||||
|
|
||||||
### BMGD Agents
|
|
||||||
|
|
||||||
- **[Game Development Agents](/docs/explanation/game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** - Core concept explanation
|
|
||||||
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
||||||
- **[Customize Agents](/docs/how-to/customization/customize-agents.md)** - How to customize agent behavior
|
|
||||||
|
|
@ -1,126 +0,0 @@
|
||||||
---
|
|
||||||
title: "The Four Phases of BMad Method"
|
|
||||||
description: Understanding the four phases of the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Overview
|
|
||||||
|
|
||||||
| Phase | Name | Purpose | Required? |
|
|
||||||
|-------|------|---------|-----------|
|
|
||||||
| **Phase 1** | Analysis | Exploration and discovery | Optional |
|
|
||||||
| **Phase 2** | Planning | Requirements definition | Required |
|
|
||||||
| **Phase 3** | Solutioning | Technical design | Track-dependent |
|
|
||||||
| **Phase 4** | Implementation | Building the software | Required |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis (Optional)
|
|
||||||
|
|
||||||
Exploration and discovery workflows that help validate ideas and understand markets before planning.
|
|
||||||
|
|
||||||
**Workflows:**
|
|
||||||
- `brainstorm-project` - Solution exploration
|
|
||||||
- `research` - Market/technical/competitive research
|
|
||||||
- `product-brief` - Strategic vision capture
|
|
||||||
|
|
||||||
**When to use:**
|
|
||||||
- Starting new projects
|
|
||||||
- Exploring opportunities
|
|
||||||
- Validating market fit
|
|
||||||
|
|
||||||
**When to skip:**
|
|
||||||
- Clear requirements
|
|
||||||
- Well-defined features
|
|
||||||
- Continuing existing work
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning (Required)
|
|
||||||
|
|
||||||
Requirements definition using the scale-adaptive system to match planning depth to project complexity.
|
|
||||||
|
|
||||||
**Workflows:**
|
|
||||||
- `prd` - Product Requirements Document (BMad Method/Enterprise)
|
|
||||||
- `tech-spec` - Technical specification (Quick Flow)
|
|
||||||
- `create-ux-design` - Optional UX specification
|
|
||||||
|
|
||||||
**Key principle:**
|
|
||||||
Define **what** to build and **why**. Leave **how** to Phase 3.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning (Track-Dependent)
|
|
||||||
|
|
||||||
Technical architecture and design decisions that prevent agent conflicts during implementation.
|
|
||||||
|
|
||||||
**Workflows:**
|
|
||||||
- `architecture` - System design with ADRs
|
|
||||||
- `create-epics-and-stories` - Work breakdown (after architecture)
|
|
||||||
- `implementation-readiness` - Gate check
|
|
||||||
|
|
||||||
**Required for:**
|
|
||||||
- BMad Method (complex projects)
|
|
||||||
- Enterprise Method
|
|
||||||
|
|
||||||
**Skip for:**
|
|
||||||
- Quick Flow (simple changes)
|
|
||||||
|
|
||||||
**Key principle:**
|
|
||||||
Make technical decisions explicit so all agents implement consistently.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation (Required)
|
|
||||||
|
|
||||||
Iterative sprint-based development with story-centric workflow.
|
|
||||||
|
|
||||||
**Workflows:**
|
|
||||||
- `sprint-planning` - Initialize tracking
|
|
||||||
- `create-story` - Prepare stories
|
|
||||||
- `dev-story` - Implement with tests
|
|
||||||
- `code-review` - Quality assurance
|
|
||||||
- `retrospective` - Continuous improvement
|
|
||||||
|
|
||||||
**Key principle:**
|
|
||||||
One story at a time, complete each story's full lifecycle before starting the next.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase Flow by Track
|
|
||||||
|
|
||||||
### Quick Flow
|
|
||||||
|
|
||||||
```
|
|
||||||
Phase 2 (tech-spec) → Phase 4 (implement)
|
|
||||||
```
|
|
||||||
|
|
||||||
Skip Phases 1 and 3 for simple changes.
|
|
||||||
|
|
||||||
### BMad Method
|
|
||||||
|
|
||||||
```
|
|
||||||
Phase 1 (optional) → Phase 2 (PRD) → Phase 3 (architecture) → Phase 4 (implement)
|
|
||||||
```
|
|
||||||
|
|
||||||
Full methodology for complex projects.
|
|
||||||
|
|
||||||
### Enterprise
|
|
||||||
|
|
||||||
```
|
|
||||||
Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (implement)
|
|
||||||
```
|
|
||||||
|
|
||||||
Same as BMad Method with optional extended workflows.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
|
|
||||||
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md)
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
@ -1,120 +0,0 @@
|
||||||
---
|
|
||||||
title: "Custom Content"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
BMad supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine.
|
|
||||||
|
|
||||||
This flexibility transforms the platform beyond its current capabilities, enabling:
|
|
||||||
|
|
||||||
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
|
|
||||||
- Completely new modules, workflows, templates, and agents outside software engineering
|
|
||||||
- Professional services tools
|
|
||||||
- Entertainment and educational content
|
|
||||||
- Science and engineering workflows
|
|
||||||
- Productivity and self-help solutions
|
|
||||||
- Role-specific augmentation for virtually any profession
|
|
||||||
|
|
||||||
## Categories
|
|
||||||
|
|
||||||
- [Custom Stand-Alone Modules](#custom-stand-alone-modules)
|
|
||||||
- [Custom Add-On Modules](#custom-add-on-modules)
|
|
||||||
- [Custom Global Modules](#custom-global-modules)
|
|
||||||
- [Custom Agents](#custom-agents)
|
|
||||||
- [Custom Workflows](#custom-workflows)
|
|
||||||
|
|
||||||
## Custom Stand-Alone Modules
|
|
||||||
|
|
||||||
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
|
|
||||||
|
|
||||||
Custom modules are [installable](/docs/how-to/installation/install-custom-modules.md) using the standard BMad method and support advanced features:
|
|
||||||
|
|
||||||
- Optional user information collection during installation/updates
|
|
||||||
- Versioning and upgrade paths
|
|
||||||
- Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools)
|
|
||||||
- Ability to bundle specific tools such as MCP, skills, execution libraries, and code
|
|
||||||
|
|
||||||
## Custom Add-On Modules
|
|
||||||
|
|
||||||
Custom Add-On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities.
|
|
||||||
|
|
||||||
Examples include:
|
|
||||||
|
|
||||||
- Alternative implementation workflows for BMad Method agents
|
|
||||||
- Framework-specific support for particular use cases
|
|
||||||
- Game development expansions that add new genre-specific capabilities without reinventing existing functionality
|
|
||||||
|
|
||||||
Add-on modules can include:
|
|
||||||
|
|
||||||
- Custom agents with awareness of the target module
|
|
||||||
- Access to existing module workflows
|
|
||||||
- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more
|
|
||||||
|
|
||||||
## Custom Global Modules
|
|
||||||
|
|
||||||
Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem.
|
|
||||||
|
|
||||||
Examples include:
|
|
||||||
|
|
||||||
- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module
|
|
||||||
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
|
|
||||||
- Installation and update tools that work with any BMad method configuration
|
|
||||||
|
|
||||||
Upcoming standards will document best practices for building global content that affects installed modules through:
|
|
||||||
|
|
||||||
- Custom content injections
|
|
||||||
- Agent customization auto-injection
|
|
||||||
- Tooling installers
|
|
||||||
|
|
||||||
## Custom Agents
|
|
||||||
|
|
||||||
Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions.
|
|
||||||
|
|
||||||
### BMad Tiny Agents
|
|
||||||
|
|
||||||
Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with:
|
|
||||||
|
|
||||||
- Team coordination and management
|
|
||||||
- Understanding team details and requirements
|
|
||||||
- Tracking specific tasks with designated tools
|
|
||||||
|
|
||||||
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
|
|
||||||
|
|
||||||
### Simple and Expert Agents
|
|
||||||
|
|
||||||
The distinction between simple and expert agents lies in their structure:
|
|
||||||
|
|
||||||
**Simple Agent:**
|
|
||||||
|
|
||||||
- Single file containing all prompts and configuration
|
|
||||||
- Self-contained and straightforward
|
|
||||||
|
|
||||||
**Expert Agent:**
|
|
||||||
|
|
||||||
- Similar to simple agents but includes a sidecar folder
|
|
||||||
- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files
|
|
||||||
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
|
|
||||||
- has metadata type: expert
|
|
||||||
|
|
||||||
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
|
|
||||||
|
|
||||||
Custom agents can be:
|
|
||||||
|
|
||||||
- Used within custom modules
|
|
||||||
- Designed as standalone tools
|
|
||||||
- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with
|
|
||||||
|
|
||||||
## Custom Workflows
|
|
||||||
|
|
||||||
Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including:
|
|
||||||
|
|
||||||
- User engagements
|
|
||||||
- Business processes
|
|
||||||
- Content generation (code, documentation, or other output formats)
|
|
||||||
|
|
||||||
A custom workflow created outside of a larger module can still be distributed and used without associated agents through:
|
|
||||||
|
|
||||||
- Slash commands
|
|
||||||
- Manual command/prompt execution when supported by tools
|
|
||||||
|
|
||||||
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
|
|
||||||
|
|
@ -1,66 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMad Builder (BMB)"
|
|
||||||
description: Create custom agents, workflows, and modules for BMad
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Create custom agents, workflows, and modules for BMad.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Step-by-step guide to building your first agent
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Architecture
|
|
||||||
|
|
||||||
Comprehensive guides for each agent type:
|
|
||||||
|
|
||||||
- **Simple Agent Architecture** - Self-contained, optimized, personality-driven
|
|
||||||
- **Expert Agent Architecture** - Memory, sidecar files, domain restrictions
|
|
||||||
- **Module Agent Architecture** - Workflow integration, professional tools
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Concepts
|
|
||||||
|
|
||||||
### YAML to XML Compilation
|
|
||||||
|
|
||||||
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
|
||||||
|
|
||||||
1. **Frontmatter** - Name and description from metadata
|
|
||||||
2. **Activation Block** - Steps, menu handlers, rules
|
|
||||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
|
||||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Reference Examples
|
|
||||||
|
|
||||||
Production-ready examples available in the BMB reference folder:
|
|
||||||
|
|
||||||
### Simple Agents
|
|
||||||
- **commit-poet** - Commit message artisan with style customization
|
|
||||||
|
|
||||||
### Expert Agents
|
|
||||||
- **journal-keeper** - Personal journal companion with memory and pattern recognition
|
|
||||||
|
|
||||||
### Module Agents
|
|
||||||
- **security-engineer** - BMM security specialist with threat modeling
|
|
||||||
- **trend-analyst** - CIS trend intelligence expert
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation Guide
|
|
||||||
|
|
||||||
For installing standalone simple and expert agents, see:
|
|
||||||
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) - Understanding content types
|
|
||||||
- [Create Custom Agent](/docs/tutorials/advanced/create-custom-agent.md) - Tutorial
|
|
||||||
|
|
@ -1,135 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMM Documentation"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🚀 Getting Started
|
|
||||||
|
|
||||||
**New to BMM?** Start here:
|
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project
|
|
||||||
- Installation and setup
|
|
||||||
- Understanding the four phases
|
|
||||||
- Running your first workflows
|
|
||||||
- Agent-based development flow
|
|
||||||
|
|
||||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
|
||||||
|
|
||||||
### 📊 Visual Overview
|
|
||||||
|
|
||||||
**[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
|
|
||||||
|
|
||||||
## 📖 Core Concepts
|
|
||||||
|
|
||||||
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
|
||||||
|
|
||||||
First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts.
|
|
||||||
|
|
||||||
- **[Full Adaptive BMad Method](#workflow-guides)** - Full planning and scope support through extensive development and testing.
|
|
||||||
- Broken down into 4 phases, all of which are comprised of both required and optional phases
|
|
||||||
- Phases 1-3 are all about progressive idea development through planning and preparations to build your project.
|
|
||||||
- Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed
|
|
||||||
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
|
|
||||||
- While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
|
|
||||||
|
|
||||||
- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow
|
|
||||||
- 3-step process: spec → dev → optional review
|
|
||||||
- Perfect for bug fixes and small features
|
|
||||||
- Rapid prototyping with production quality
|
|
||||||
- Implementation in minutes, not days
|
|
||||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/agents/barry-quick-flow.md)**
|
|
||||||
|
|
||||||
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
|
|
||||||
|
|
||||||
## 🤖 Agents and Collaboration
|
|
||||||
|
|
||||||
Complete guide to BMM's AI agent team:
|
|
||||||
|
|
||||||
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
|
|
||||||
- 12 specialized BMM agents + BMad Master
|
|
||||||
- Agent roles, workflows, and when to use them
|
|
||||||
- Agent customization system
|
|
||||||
- Best practices and common patterns
|
|
||||||
|
|
||||||
- **[Party Mode Guide](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
||||||
- How party mode works (19+ agents collaborate in real-time)
|
|
||||||
- When to use it (strategic, creative, cross-functional, complex)
|
|
||||||
- Example party compositions
|
|
||||||
- Multi-module integration (BMM + CIS + BMB + custom)
|
|
||||||
- Agent customization in party mode
|
|
||||||
- Best practices
|
|
||||||
|
|
||||||
## 🔧 Working with Existing Code
|
|
||||||
|
|
||||||
Comprehensive guide for brownfield development:
|
|
||||||
|
|
||||||
- **[Brownfield Development Guide](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases
|
|
||||||
- Documentation phase strategies
|
|
||||||
- Track selection for brownfield
|
|
||||||
- Integration with existing patterns
|
|
||||||
- Phase-by-phase workflow guidance
|
|
||||||
- Common scenarios
|
|
||||||
|
|
||||||
## 📚 Quick References
|
|
||||||
|
|
||||||
Essential reference materials:
|
|
||||||
|
|
||||||
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
|
|
||||||
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
|
|
||||||
|
|
||||||
## 🎯 Choose Your Path
|
|
||||||
|
|
||||||
### I need to...
|
|
||||||
|
|
||||||
**Build something new (greenfield)**
|
|
||||||
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
||||||
**Fix a bug or add small feature**
|
|
||||||
→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process
|
|
||||||
|
|
||||||
**Work with existing codebase (brownfield)**
|
|
||||||
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
→ Pay special attention to documentation requirements for brownfield projects
|
|
||||||
|
|
||||||
## 📋 Workflow Guides
|
|
||||||
|
|
||||||
Comprehensive documentation for all BMM workflows organized by phase:
|
|
||||||
|
|
||||||
- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
|
|
||||||
- brainstorm-project, product-brief, research, and more
|
|
||||||
- When to use analysis workflows
|
|
||||||
- Creative and strategic tools
|
|
||||||
|
|
||||||
- **[Phase 2: Planning Workflows](/docs/how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
|
|
||||||
- prd, tech-spec, gdd, narrative, ux
|
|
||||||
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
|
||||||
- Which planning workflow to use
|
|
||||||
|
|
||||||
- **[Phase 3: Solutioning Workflows](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
|
|
||||||
- architecture, create-epics-and-stories, implementation-readiness
|
|
||||||
- V6: Epics created AFTER architecture for better quality
|
|
||||||
- Required for BMad Method and Enterprise Method tracks
|
|
||||||
- Preventing agent conflicts
|
|
||||||
|
|
||||||
- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
|
|
||||||
- sprint-planning, create-story, dev-story, code-review
|
|
||||||
- Complete story lifecycle
|
|
||||||
- One-story-at-a-time discipline
|
|
||||||
|
|
||||||
- **[Testing & QA Workflows](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
|
|
||||||
- Test strategy, automation, quality gates
|
|
||||||
- TEA agent and test healing
|
|
||||||
|
|
||||||
## 🌐 External Resources
|
|
||||||
|
|
||||||
### Community and Support
|
|
||||||
|
|
||||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-issues)
|
|
||||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
|
||||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
|
||||||
|
|
||||||
**Ready to begin?** → [Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
title: "Brainstorming"
|
||||||
|
description: Interactive creative sessions using 60+ proven ideation techniques
|
||||||
|
---
|
||||||
|
|
||||||
|
Unlock your creativity through guided exploration.
|
||||||
|
|
||||||
|
## What is Brainstorming?
|
||||||
|
|
||||||
|
Run `brainstorming` and you've got a creative facilitator pulling ideas out of you - not generating them for you. The AI acts as coach and guide, using proven techniques to create conditions where your best thinking emerges.
|
||||||
|
|
||||||
|
**Good for:**
|
||||||
|
|
||||||
|
- Breaking through creative blocks
|
||||||
|
- Generating product or feature ideas
|
||||||
|
- Exploring problems from new angles
|
||||||
|
- Developing raw concepts into action plans
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. **Setup** - Define topic, goals, constraints
|
||||||
|
2. **Choose approach** - Pick techniques yourself, get AI recommendations, go random, or follow a progressive flow
|
||||||
|
3. **Facilitation** - Work through techniques with probing questions and collaborative coaching
|
||||||
|
4. **Organize** - Ideas grouped into themes and prioritized
|
||||||
|
5. **Action** - Top ideas get next steps and success metrics
|
||||||
|
|
||||||
|
Everything gets captured in a session document you can reference later or share with stakeholders.
|
||||||
|
|
||||||
|
:::note[Your Ideas]
|
||||||
|
Every idea comes from you. The workflow creates conditions for insight - you're the source.
|
||||||
|
:::
|
||||||
|
|
@ -6,12 +6,12 @@ Quick answers to common questions about brownfield (existing codebase) developme
|
||||||
|
|
||||||
## Questions
|
## Questions
|
||||||
|
|
||||||
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
- [Questions](#questions)
|
||||||
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
||||||
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
||||||
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
||||||
- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs)
|
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
||||||
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||||
|
|
||||||
### What is brownfield vs greenfield?
|
### What is brownfield vs greenfield?
|
||||||
|
|
||||||
|
|
@ -25,19 +25,12 @@ Highly recommended, especially if:
|
||||||
- No existing documentation
|
- No existing documentation
|
||||||
- Documentation is outdated
|
- Documentation is outdated
|
||||||
- AI agents need context about existing code
|
- AI agents need context about existing code
|
||||||
- Level 2-4 complexity
|
|
||||||
|
|
||||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`.
|
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
||||||
|
|
||||||
### What if I forget to run document-project?
|
### What if I forget to run document-project?
|
||||||
|
|
||||||
Workflows will lack context about existing code. You may get:
|
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
||||||
|
|
||||||
- Suggestions that don't match existing patterns
|
|
||||||
- Integration approaches that miss existing APIs
|
|
||||||
- Architecture that conflicts with current structure
|
|
||||||
|
|
||||||
Run document-project and restart planning with proper context.
|
|
||||||
|
|
||||||
### Can I use Quick Spec Flow for brownfield projects?
|
### Can I use Quick Spec Flow for brownfield projects?
|
||||||
|
|
||||||
|
|
@ -50,17 +43,6 @@ Yes! Quick Spec Flow works great for brownfield. It will:
|
||||||
|
|
||||||
Perfect for bug fixes and small features in existing codebases.
|
Perfect for bug fixes and small features in existing codebases.
|
||||||
|
|
||||||
### How does workflow-init handle old planning docs?
|
|
||||||
|
|
||||||
workflow-init asks about YOUR current work first, then uses old artifacts as context:
|
|
||||||
|
|
||||||
1. Shows what it found (old PRD, epics, etc.)
|
|
||||||
2. Asks: "Is this work in progress, previous effort, or proposed work?"
|
|
||||||
3. If previous effort: Asks you to describe your NEW work
|
|
||||||
4. Determines level based on YOUR work, not old artifacts
|
|
||||||
|
|
||||||
This prevents old Level 3 PRDs from forcing Level 3 workflow for a new Level 0 bug fix.
|
|
||||||
|
|
||||||
### What if my existing code doesn't follow best practices?
|
### What if my existing code doesn't follow best practices?
|
||||||
|
|
||||||
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||||
|
|
@ -1,204 +0,0 @@
|
||||||
---
|
|
||||||
title: "Agent Roles in BMad Method"
|
|
||||||
description: Understanding the different agent roles in BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Agents Overview
|
|
||||||
|
|
||||||
| Agent | Role | Primary Phase |
|
|
||||||
|-------|------|---------------|
|
|
||||||
| **Analyst** | Research and discovery | Phase 1 (Analysis) |
|
|
||||||
| **PM** | Requirements and planning | Phase 2 (Planning) |
|
|
||||||
| **Architect** | Technical design | Phase 3 (Solutioning) |
|
|
||||||
| **SM** | Sprint orchestration | Phase 4 (Implementation) |
|
|
||||||
| **DEV** | Code implementation | Phase 4 (Implementation) |
|
|
||||||
| **TEA** | Test architecture | Phases 3-4 (Cross-phase) |
|
|
||||||
| **UX Designer** | User experience | Phase 2-3 |
|
|
||||||
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1: Analysis
|
|
||||||
|
|
||||||
### Analyst (Mary)
|
|
||||||
|
|
||||||
Business analysis and research specialist.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Brainstorming and ideation
|
|
||||||
- Market, domain, and competitive research
|
|
||||||
- Product brief creation
|
|
||||||
- Brownfield project documentation
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*brainstorm-project`
|
|
||||||
- `*research`
|
|
||||||
- `*product-brief`
|
|
||||||
- `*document-project`
|
|
||||||
|
|
||||||
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2: Planning
|
|
||||||
|
|
||||||
### PM (John)
|
|
||||||
|
|
||||||
Product requirements and planning expert.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Creating Product Requirements Documents
|
|
||||||
- Defining functional and non-functional requirements
|
|
||||||
- Breaking requirements into epics and stories
|
|
||||||
- Validating implementation readiness
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*create-prd`
|
|
||||||
- `*create-epics-and-stories`
|
|
||||||
- `*implementation-readiness`
|
|
||||||
|
|
||||||
**When to use:** Defining what to build, creating PRDs, organizing work into stories.
|
|
||||||
|
|
||||||
### UX Designer (Sally)
|
|
||||||
|
|
||||||
User experience and UI design specialist.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- UX specification creation
|
|
||||||
- User journey mapping
|
|
||||||
- Wireframe and mockup design
|
|
||||||
- Design system documentation
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*create-ux-design`
|
|
||||||
- `*validate-design`
|
|
||||||
|
|
||||||
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3: Solutioning
|
|
||||||
|
|
||||||
### Architect (Winston)
|
|
||||||
|
|
||||||
System architecture and technical design expert.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- System architecture design
|
|
||||||
- Architecture Decision Records (ADRs)
|
|
||||||
- Technical standards definition
|
|
||||||
- Implementation readiness validation
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*create-architecture`
|
|
||||||
- `*implementation-readiness`
|
|
||||||
|
|
||||||
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4: Implementation
|
|
||||||
|
|
||||||
### SM (Bob)
|
|
||||||
|
|
||||||
Sprint planning and story preparation orchestrator.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Sprint planning and tracking
|
|
||||||
- Story preparation for development
|
|
||||||
- Course correction handling
|
|
||||||
- Epic retrospectives
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*sprint-planning`
|
|
||||||
- `*create-story`
|
|
||||||
- `*correct-course`
|
|
||||||
- `*epic-retrospective`
|
|
||||||
|
|
||||||
**When to use:** Organizing work, preparing stories, tracking progress.
|
|
||||||
|
|
||||||
### DEV (Amelia)
|
|
||||||
|
|
||||||
Story implementation and code review specialist.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Story implementation with tests
|
|
||||||
- Code review
|
|
||||||
- Following architecture patterns
|
|
||||||
- Quality assurance
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*dev-story`
|
|
||||||
- `*code-review`
|
|
||||||
|
|
||||||
**When to use:** Writing code, implementing stories, reviewing quality.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Cross-Phase Agents
|
|
||||||
|
|
||||||
### TEA (Murat)
|
|
||||||
|
|
||||||
Test architecture and quality strategy expert.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Test framework setup
|
|
||||||
- Test design and planning
|
|
||||||
- ATDD and automation
|
|
||||||
- Quality gate decisions
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*framework`, `*ci`
|
|
||||||
- `*test-design`, `*atdd`, `*automate`
|
|
||||||
- `*test-review`, `*trace`, `*nfr-assess`
|
|
||||||
|
|
||||||
**When to use:** Setting up testing, creating test plans, quality gates.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Flow
|
|
||||||
|
|
||||||
### Quick Flow Solo Dev (Barry)
|
|
||||||
|
|
||||||
Fast solo development without handoffs.
|
|
||||||
|
|
||||||
**Responsibilities:**
|
|
||||||
- Technical specification
|
|
||||||
- End-to-end implementation
|
|
||||||
- Code review
|
|
||||||
|
|
||||||
**Key Workflows:**
|
|
||||||
- `*quick-spec`
|
|
||||||
- `*quick-dev`
|
|
||||||
- `*code-review`
|
|
||||||
|
|
||||||
**When to use:** Bug fixes, small features, rapid prototyping.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choosing the Right Agent
|
|
||||||
|
|
||||||
| Task | Agent |
|
|
||||||
|------|-------|
|
|
||||||
| Brainstorming ideas | Analyst |
|
|
||||||
| Market research | Analyst |
|
|
||||||
| Creating PRD | PM |
|
|
||||||
| Designing UX | UX Designer |
|
|
||||||
| System architecture | Architect |
|
|
||||||
| Preparing stories | SM |
|
|
||||||
| Writing code | DEV |
|
|
||||||
| Setting up tests | TEA |
|
|
||||||
| Quick bug fix | Quick Flow Solo Dev |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts
|
|
||||||
- [Agent Reference](/docs/reference/agents/index.md) - Complete command reference
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMad Core Concepts"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Understanding the fundamental building blocks of the BMad Method.
|
|
||||||
|
|
||||||
## The Essentials
|
|
||||||
|
|
||||||
| Concept | Description | Guide |
|
|
||||||
|---------|-------------|-------|
|
|
||||||
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) |
|
|
||||||
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) |
|
|
||||||
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) |
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
### New to BMad?
|
|
||||||
Start here to understand what BMad is and how it works:
|
|
||||||
|
|
||||||
1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents
|
|
||||||
2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks
|
|
||||||
3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality
|
|
||||||
|
|
||||||
### Installing BMad
|
|
||||||
|
|
||||||
- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project
|
|
||||||
- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
|
|
||||||
- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows
|
|
||||||
|
|
||||||
### Advanced
|
|
||||||
|
|
||||||
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) to understand the core building block of BMad.
|
|
||||||
|
|
@ -1,96 +0,0 @@
|
||||||
---
|
|
||||||
title: "Agents"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
|
||||||
|
|
||||||
## Agent Types
|
|
||||||
|
|
||||||
BMad has two primary agent types, designed for different use cases:
|
|
||||||
|
|
||||||
### Simple Agents
|
|
||||||
|
|
||||||
**Self-contained, focused, ready to use.**
|
|
||||||
|
|
||||||
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
|
|
||||||
|
|
||||||
**Best for:**
|
|
||||||
- Single-purpose assistants (code review, documentation, commit messages)
|
|
||||||
- Quick deployment
|
|
||||||
- Projects that don't require persistent memory
|
|
||||||
- Getting started fast
|
|
||||||
|
|
||||||
**Example:** A commit message agent that reads your git diff and generates conventional commits.
|
|
||||||
|
|
||||||
### Expert Agents
|
|
||||||
|
|
||||||
**Powerful, memory-equipped, domain specialists.**
|
|
||||||
|
|
||||||
Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
|
|
||||||
|
|
||||||
**Best for:**
|
|
||||||
- Domain specialists (security architect, game designer, product manager)
|
|
||||||
- Tasks requiring persistent memory
|
|
||||||
- Complex workflows with multiple stages
|
|
||||||
- Projects that grow over time
|
|
||||||
|
|
||||||
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
|
|
||||||
|
|
||||||
## Key Differences
|
|
||||||
|
|
||||||
| Feature | Simple | Expert |
|
|
||||||
| ---------------- | -------------- | -------------------------- |
|
|
||||||
| **Files** | Single file | Agent + sidecar folder |
|
|
||||||
| **Memory** | Session only | Persistent across sessions |
|
|
||||||
| **Capabilities** | Focused scope | Multi-domain, extensible |
|
|
||||||
| **Setup** | Zero config | Sidecar initialization |
|
|
||||||
| **Best Use** | Specific tasks | Ongoing projects |
|
|
||||||
|
|
||||||
## Agent Components
|
|
||||||
|
|
||||||
All agents share these building blocks:
|
|
||||||
|
|
||||||
### Persona
|
|
||||||
- **Role** - What the agent does (expertise domain)
|
|
||||||
- **Identity** - Who the agent is (personality, character)
|
|
||||||
- **Communication Style** - How the agent speaks (tone, voice)
|
|
||||||
- **Principles** - Why the agent acts (values, decision framework)
|
|
||||||
|
|
||||||
### Capabilities
|
|
||||||
- Skills, tools, and knowledge the agent can apply
|
|
||||||
- Mapped to specific menu commands
|
|
||||||
|
|
||||||
### Menu
|
|
||||||
- Interactive command list
|
|
||||||
- Triggers, descriptions, and handlers
|
|
||||||
- Auto-includes help and exit options
|
|
||||||
|
|
||||||
### Critical Actions (optional)
|
|
||||||
- Instructions that execute before the agent starts
|
|
||||||
- Enable autonomous behaviors (e.g., "check git status before changes")
|
|
||||||
|
|
||||||
## Which Should You Use?
|
|
||||||
|
|
||||||
**Choose Simple when:**
|
|
||||||
- You need a task done quickly and reliably
|
|
||||||
- The scope is well-defined and won't change much
|
|
||||||
- You don't need the agent to remember things between sessions
|
|
||||||
|
|
||||||
**Choose Expert when:**
|
|
||||||
- You're building something complex over time
|
|
||||||
- The agent needs to maintain context (project history, decisions)
|
|
||||||
- You want the agent to coordinate workflows or other agents
|
|
||||||
- Domain expertise requires specialized knowledge bases
|
|
||||||
|
|
||||||
## Creating Custom Agents
|
|
||||||
|
|
||||||
BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md) for step-by-step instructions.
|
|
||||||
|
|
||||||
## Customizing Existing Agents
|
|
||||||
|
|
||||||
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Learn about [Workflows](/docs/explanation/core-concepts/what-are-workflows.md) to see how agents accomplish complex tasks.
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
---
|
|
||||||
title: "Modules"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
|
||||||
|
|
||||||
## What is a Module?
|
|
||||||
|
|
||||||
A module is a self-contained package that includes:
|
|
||||||
|
|
||||||
- **Agents** - Specialized AI assistants
|
|
||||||
- **Workflows** - Step-by-step processes
|
|
||||||
- **Configuration** - Module-specific settings
|
|
||||||
- **Documentation** - Usage guides and reference
|
|
||||||
|
|
||||||
## Official Modules
|
|
||||||
|
|
||||||
### Core Module
|
|
||||||
Always installed, provides shared functionality:
|
|
||||||
- Global configuration
|
|
||||||
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
|
||||||
- Common tasks (document indexing, sharding, review)
|
|
||||||
|
|
||||||
### BMad Method (BMM)
|
|
||||||
Software and game development:
|
|
||||||
- Project planning workflows
|
|
||||||
- Implementation agents (Dev, PM, QA, Scrum Master)
|
|
||||||
- Testing and architecture guidance
|
|
||||||
|
|
||||||
### BMad Builder (BMB)
|
|
||||||
Create custom solutions:
|
|
||||||
- Agent creation workflows
|
|
||||||
- Workflow authoring tools
|
|
||||||
- Module scaffolding
|
|
||||||
|
|
||||||
### Creative Intelligence Suite (CIS)
|
|
||||||
Innovation and creativity:
|
|
||||||
- Creative thinking techniques
|
|
||||||
- Innovation strategy workflows
|
|
||||||
- Storytelling and ideation
|
|
||||||
|
|
||||||
### BMad Game Dev (BMGD)
|
|
||||||
Game development specialization:
|
|
||||||
- Game design workflows
|
|
||||||
- Narrative development
|
|
||||||
- Performance testing frameworks
|
|
||||||
|
|
||||||
## Module Structure
|
|
||||||
|
|
||||||
Installed modules follow this structure:
|
|
||||||
|
|
||||||
```
|
|
||||||
_bmad/
|
|
||||||
├── core/ # Always present
|
|
||||||
├── bmm/ # BMad Method (if installed)
|
|
||||||
├── bmb/ # BMad Builder (if installed)
|
|
||||||
├── cis/ # Creative Intelligence (if installed)
|
|
||||||
└── bmgd/ # Game Dev (if installed)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Custom Modules
|
|
||||||
|
|
||||||
You can create your own modules containing:
|
|
||||||
- Custom agents for your domain
|
|
||||||
- Organizational workflows
|
|
||||||
- Team-specific configurations
|
|
||||||
|
|
||||||
Custom modules are installed the same way as official modules.
|
|
||||||
|
|
||||||
## Installing Modules
|
|
||||||
|
|
||||||
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
|
||||||
|
|
||||||
See [Installation Guide](/docs/how-to/installation/index.md) for details.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Installation Guide](/docs/how-to/installation/index.md) to set up BMad with the modules you need.
|
|
||||||
|
|
@ -1,217 +0,0 @@
|
||||||
---
|
|
||||||
title: "Workflows"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs.
|
|
||||||
|
|
||||||
This guide explains what workflows are, why they're powerful, and how to think about designing them.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Is a Workflow?
|
|
||||||
|
|
||||||
A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction.
|
|
||||||
|
|
||||||
Think of it this way: instead of asking "help me build a nutrition plan" and getting a generic response, a workflow guides you (or runs automatically) through discovery, assessment, strategy, shopping lists, and prep schedules—each step building on the last, nothing missed, no shortcuts taken.
|
|
||||||
|
|
||||||
## How do workflows differ from skills?
|
|
||||||
|
|
||||||
Actually they really do not - a workflow can be a skill, and a skill can be a workflow. The main thing with a BMad workflow is the suggestion to follow certain conventions, which actually are also skill best practices. A skill has a few optional and required fields to add as the main file workflow and get stored in a specific location depending on your tool choice for automatic invocation by the llm - whereas workflows are generally intentionally launched, with from another process calling them, or a user invoking via a slash command. In the near future, workflows will optionally be installable as skills also - but if you like, you can add front matter to your custom workflows based on the skill spec from Anthropic, and put them in the proper location your tool dictates.
|
|
||||||
|
|
||||||
### The Power of Progressive Disclosure
|
|
||||||
|
|
||||||
Here's why workflows work so well: the AI only sees the current step. It doesn't know about step 5 when it's on step 2. It can't get ahead of itself, skip steps, or lose focus. Each step gets the AI's full attention, completing fully before the next step loads.
|
|
||||||
|
|
||||||
This is the opposite of a giant prompt that tries to handle everything at once and inevitably misses details or loses coherence.
|
|
||||||
|
|
||||||
Workflows exist on a spectrum:
|
|
||||||
|
|
||||||
- **Interactive workflows** guide users through complex decisions via collaboration and facilitation
|
|
||||||
- **Automated workflows** run with minimal user input, processing documents or executing tasks
|
|
||||||
- **Hybrid workflows** combine both—some steps need user input, others run automatically
|
|
||||||
|
|
||||||
### Real-World Workflow Examples
|
|
||||||
|
|
||||||
**Tax Organizer Workflow**
|
|
||||||
|
|
||||||
A tax preparation workflow that helps users organize financial documents for tax filing. Runs in a single session, follows prescriptive IRS categories, produces a checklist of required documents with missing-item alerts. Sequential and compliance-focused.
|
|
||||||
|
|
||||||
**Meal Planning Workflow**
|
|
||||||
|
|
||||||
Creates personalized weekly meal plans through collaborative nutrition planning. Users can stop mid-session and return later because the workflow tracks progress. Intent-based conversation helps discover preferences rather than following a script. Multi-session, creative, and highly interactive.
|
|
||||||
|
|
||||||
**Course Creator Workflow**
|
|
||||||
|
|
||||||
Helps instructors design course syllabi. Branches based on course type—academic courses need accreditation sections, vocational courses need certification prep, self-paced courses need different structures entirely.
|
|
||||||
|
|
||||||
**Therapy Intake Workflow**
|
|
||||||
|
|
||||||
Guides mental health professionals through structured client intake sessions. Highly sensitive and confidential, uses intent-based questioning to build rapport while ensuring all required clinical information is collected. Continuable across multiple sessions.
|
|
||||||
|
|
||||||
**Software Architecture Workflow** (BMM Module)
|
|
||||||
|
|
||||||
Part of a larger software development pipeline. Runs after product requirements and UX design are complete, takes those documents as input, then collaboratively walks through technical decisions: system components, data flows, technology choices, architectural patterns. Produces an architecture document that implementation teams use to build consistently.
|
|
||||||
|
|
||||||
**Shard Document Workflow**
|
|
||||||
|
|
||||||
Nearly hands-off automated workflow. Takes a large document as input, uses a custom npx tool to split it into smaller files, deletes the original, then augments an index with content details so the LLM can efficiently find and reference specific sections later. Minimal user interaction—just specify the input document.
|
|
||||||
|
|
||||||
These examples show the range: from collaborative creative processes to automated batch jobs, workflows ensure completeness and consistency whether the work involves deep collaboration or minimal human oversight.
|
|
||||||
|
|
||||||
### The Facilitative Philosophy
|
|
||||||
|
|
||||||
When workflows involve users, they should be **facilitative, not directive**. The AI treats users as partners and domain experts, not as passive recipients of generated content.
|
|
||||||
|
|
||||||
**Collaborative dialogue, not command-response**: The AI and user work together throughout. The AI brings structured thinking, methodology, and technical knowledge. The user brings domain expertise, context, and judgment. Together they produce something better than either could alone.
|
|
||||||
|
|
||||||
**The user is the expert in their domain**: A nutrition planning workflow doesn't dictate meal plans—it guides users through discovering what works for their lifestyle. An architecture workflow doesn't tell architects what to build—it facilitates systematic decision-making so choices are explicit and consistent.
|
|
||||||
|
|
||||||
**Intent-based facilitation**: Workflows should describe goals and approaches, not scripts. Instead of "Ask: What is your age? Then ask: What is your goal weight?" use "Guide the user through understanding their health profile. Ask 1-2 questions at a time. Think about their responses before asking follow-ups. Probe to understand their actual needs."
|
|
||||||
|
|
||||||
The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative.
|
|
||||||
|
|
||||||
**When to be prescriptive**: Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception, not the rule. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Why Workflows Matter
|
|
||||||
|
|
||||||
Workflows solve three fundamental problems with AI interactions:
|
|
||||||
|
|
||||||
**Focus**: Each step contains only instructions for that phase. The AI sees one step at a time, preventing it from getting ahead of itself or losing focus.
|
|
||||||
|
|
||||||
**Continuity**: Workflows can span multiple sessions. Stop mid-workflow and return later without losing progress—something free-form prompts can't do.
|
|
||||||
|
|
||||||
**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How Workflows Work
|
|
||||||
|
|
||||||
### The Basic Structure
|
|
||||||
|
|
||||||
Workflows consist of multiple markdown files, each representing one step:
|
|
||||||
|
|
||||||
```
|
|
||||||
my-workflow/
|
|
||||||
├── workflow.md # Entry point and configuration
|
|
||||||
├── steps/ # Step files (steps-c/ for create, steps-e/ for edit, steps-v/ for validate)
|
|
||||||
│ ├── step-01-init.md
|
|
||||||
│ ├── step-02-profile.md
|
|
||||||
│ └── step-N-final.md
|
|
||||||
├── data/ # Reference materials, CSVs, examples
|
|
||||||
└── templates/ # Output document templates
|
|
||||||
```
|
|
||||||
|
|
||||||
The `workflow.md` file is minimal—it contains the workflow name, description, goal, the AI's role, and how to start. Importantly, it does not list all steps or detail what each does. This is progressive disclosure in action.
|
|
||||||
|
|
||||||
### Sequential Execution
|
|
||||||
|
|
||||||
Workflows execute in strict sequence: `step-01 → step-02 → step-03 → ... → step-N`
|
|
||||||
|
|
||||||
The AI cannot skip steps or optimize the sequence. It must complete each step fully before loading the next. This ensures thoroughness and prevents shortcuts that compromise quality.
|
|
||||||
|
|
||||||
### Continuable Workflows
|
|
||||||
|
|
||||||
Some workflows are complex enough that users might need multiple sessions. These "continuable workflows" track which steps are complete in the output document's frontmatter, so users can stop and resume later without losing progress.
|
|
||||||
|
|
||||||
Use continuable workflows when:
|
|
||||||
- The workflow produces large documents
|
|
||||||
- Multiple sessions are likely
|
|
||||||
- Complex decisions benefit from reflection
|
|
||||||
- The workflow has many steps (8+)
|
|
||||||
|
|
||||||
Keep it simple (single-session) when tasks are quick, focused, and can be completed in one sitting.
|
|
||||||
|
|
||||||
### Workflow Chaining
|
|
||||||
|
|
||||||
Workflows can be chained together where outputs become inputs. The BMM module pipeline is a perfect example:
|
|
||||||
|
|
||||||
```
|
|
||||||
brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning
|
|
||||||
↓
|
|
||||||
implement-story → review → repeat
|
|
||||||
```
|
|
||||||
|
|
||||||
Each workflow checks for required inputs from prior workflows, validates they're complete, and produces output for the next workflow. This creates powerful end-to-end pipelines for complex processes.
|
|
||||||
|
|
||||||
### The Tri-Modal Pattern
|
|
||||||
|
|
||||||
For critical workflows that produce important artifacts, BMad uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others.
|
|
||||||
|
|
||||||
**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMad standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns.
|
|
||||||
|
|
||||||
**Validate mode** runs standalone and checks artifacts against standards. Because it's separate, you can run validation whenever you want—immediately after creation, weeks later when things have changed, or even using a different LLM entirely. It's like having a quality assurance checkpoint that's always available but never forced.
|
|
||||||
|
|
||||||
**Edit mode** modifies existing artifacts while enforcing standards. As you update documents to reflect changing requirements or new understanding, edit mode ensures you don't accidentally drift away from the patterns that make the artifacts useful. It checks compliance as you work and can route back to create mode if it detects something that needs full conversion.
|
|
||||||
|
|
||||||
All BMad planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action.
|
|
||||||
|
|
||||||
This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Design Decisions
|
|
||||||
|
|
||||||
Before building a workflow, answer these questions:
|
|
||||||
|
|
||||||
**Module affiliation**: Is this standalone or part of a module? Module-based workflows can access module-specific variables and reference other workflow outputs. Also when part of a module, generally they will be associated to an agent.
|
|
||||||
|
|
||||||
**Continuable or single-session?**: Will users need multiple sessions, or can this be completed in one sitting?
|
|
||||||
|
|
||||||
**Edit/Validate support?**: Do you need Create/Edit/Validate modes (tri-modal structure)? Use tri-modal for complex, critical workflows requiring quality assurance. Use create-only for simple, one-off workflows.
|
|
||||||
|
|
||||||
**Document output?**: Does this produce a persistent file, or perform actions without output?
|
|
||||||
|
|
||||||
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning from Examples
|
|
||||||
|
|
||||||
The best way to understand workflows is to study real examples. Look at the official BMad modules:
|
|
||||||
|
|
||||||
- **BMB (Module Builder)**: Workflow and agent creation workflows
|
|
||||||
- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
|
|
||||||
- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture
|
|
||||||
- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy
|
|
||||||
|
|
||||||
Study the workflow.md files to understand how each workflow starts. Examine step files to see how instructions are structured. Notice the frontmatter variables, menu handling, and how steps chain together.
|
|
||||||
|
|
||||||
Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Workflows
|
|
||||||
|
|
||||||
Use workflows when:
|
|
||||||
|
|
||||||
- **Tasks are multi-step and complex**: Break down complexity into manageable pieces
|
|
||||||
- **Quality and completeness matter**: Sequential enforcement ensures nothing gets missed
|
|
||||||
- **Repeatability is important**: Get consistent results every time
|
|
||||||
- **Tasks span multiple sessions**: Continuable workflows preserve progress
|
|
||||||
- **You need to chain processes**: Output of one workflow becomes input of another
|
|
||||||
- **Compliance or standards matter**: Enforce required steps and documentation
|
|
||||||
|
|
||||||
Don't use workflows when:
|
|
||||||
|
|
||||||
- **Tasks are simple and one-off**: A single prompt works fine for quick questions
|
|
||||||
- **Flexibility trumps structure**: Free-form conversation is better for exploration
|
|
||||||
|
|
||||||
Modified BMad Workflows
|
|
||||||
|
|
||||||
- **Tasks are truly one-step**
|
|
||||||
|
|
||||||
If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have
|
|
||||||
a short single file workflow.md file.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Bottom Line
|
|
||||||
|
|
||||||
Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match.
|
|
||||||
|
|
||||||
They're not just for software development. You can create workflows for any guided process - meal planning, course design, therapy intake, tax preparation, document processing, creative writing, event planning—any complex task that benefits from structure and thoroughness.
|
|
||||||
|
|
||||||
Start simple. Study examples. Build workflows for your own domain. You'll wonder how you ever got by with just prompts.
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
---
|
|
||||||
title: "Core Module"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The Core Module is installed with all installations of BMad modules and provides common functionality that any module, workflow, or agent can take advantage of.
|
|
||||||
|
|
||||||
## Core Module Components
|
|
||||||
|
|
||||||
- **[Global Core Config](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
|
|
||||||
- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
|
|
||||||
- [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration
|
|
||||||
- [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
|
|
||||||
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
|
||||||
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
|
|
||||||
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
|
||||||
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review-general) — Critical content review
|
|
||||||
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
|
||||||
|
|
@ -1,121 +0,0 @@
|
||||||
---
|
|
||||||
title: "Creative Intelligence Suite (CIS)"
|
|
||||||
description: AI-powered creative facilitation with the Creative Intelligence Suite
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Capabilities
|
|
||||||
|
|
||||||
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Specialized Agents
|
|
||||||
|
|
||||||
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
|
||||||
- **Maya** - Design Thinking Maestro (jazz-like improviser)
|
|
||||||
- **Dr. Quinn** - Problem Solver (detective-scientist hybrid)
|
|
||||||
- **Victor** - Innovation Oracle (bold strategic precision)
|
|
||||||
- **Sophia** - Master Storyteller (whimsical narrator)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Interactive Workflows
|
|
||||||
|
|
||||||
**5 Workflows** with **150+ Creative Techniques:**
|
|
||||||
|
|
||||||
### Brainstorming
|
|
||||||
|
|
||||||
36 techniques across 7 categories for ideation:
|
|
||||||
- Divergent/convergent thinking
|
|
||||||
- Lateral connections
|
|
||||||
- Forced associations
|
|
||||||
|
|
||||||
### Design Thinking
|
|
||||||
|
|
||||||
Complete 5-phase human-centered process:
|
|
||||||
- Empathize → Define → Ideate → Prototype → Test
|
|
||||||
- User journey mapping
|
|
||||||
- Rapid iteration
|
|
||||||
|
|
||||||
### Problem Solving
|
|
||||||
|
|
||||||
Systematic root cause analysis:
|
|
||||||
- 5 Whys, Fishbone diagrams
|
|
||||||
- Solution generation
|
|
||||||
- Impact assessment
|
|
||||||
|
|
||||||
### Innovation Strategy
|
|
||||||
|
|
||||||
Business model disruption:
|
|
||||||
- Blue Ocean Strategy
|
|
||||||
- Jobs-to-be-Done
|
|
||||||
- Disruptive innovation patterns
|
|
||||||
|
|
||||||
### Storytelling
|
|
||||||
|
|
||||||
25 narrative frameworks:
|
|
||||||
- Hero's Journey
|
|
||||||
- Story circles
|
|
||||||
- Compelling pitch structures
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
### Direct Workflow
|
|
||||||
|
|
||||||
```bash
|
|
||||||
workflow brainstorming
|
|
||||||
|
|
||||||
workflow design-thinking --data /path/to/context.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Agent-Facilitated
|
|
||||||
|
|
||||||
```bash
|
|
||||||
agent cis/brainstorming-coach
|
|
||||||
|
|
||||||
> *brainstorm
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Differentiators
|
|
||||||
|
|
||||||
- **Facilitation Over Generation** - Guides discovery through questions
|
|
||||||
- **Energy-Aware Sessions** - Adapts to engagement levels
|
|
||||||
- **Context Integration** - Domain-specific guidance support
|
|
||||||
- **Persona-Driven** - Unique communication styles
|
|
||||||
- **Rich Method Libraries** - 150+ proven techniques
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Integration Points
|
|
||||||
|
|
||||||
CIS workflows integrate with:
|
|
||||||
|
|
||||||
- **BMM** - Powers project brainstorming
|
|
||||||
- **BMB** - Creative module design
|
|
||||||
- **Custom Modules** - Shared creative resource
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Best Practices
|
|
||||||
|
|
||||||
1. **Set clear objectives** before starting sessions
|
|
||||||
2. **Provide context documents** for domain relevance
|
|
||||||
3. **Trust the process** - Let facilitation guide you
|
|
||||||
4. **Take breaks** when energy flags
|
|
||||||
5. **Document insights** as they emerge
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) - Core philosophy
|
|
||||||
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Technique reference
|
|
||||||
|
|
@ -1,62 +0,0 @@
|
||||||
---
|
|
||||||
title: "Getting Started FAQ"
|
|
||||||
description: Common questions about getting started with the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about getting started with the BMad Method.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init)
|
|
||||||
- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow)
|
|
||||||
- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working)
|
|
||||||
- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started)
|
|
||||||
- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4)
|
|
||||||
|
|
||||||
### Do I always need to run workflow-init?
|
|
||||||
|
|
||||||
No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
|
|
||||||
|
|
||||||
- Determines your project's appropriate level automatically
|
|
||||||
- Creates the tracking status file
|
|
||||||
- Routes you to the correct starting workflow
|
|
||||||
|
|
||||||
For experienced users: use the [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow.
|
|
||||||
|
|
||||||
### Why do I need fresh chats for each workflow?
|
|
||||||
|
|
||||||
Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for:
|
|
||||||
|
|
||||||
- Planning workflows (PRD, architecture)
|
|
||||||
- Analysis workflows (brainstorming, research)
|
|
||||||
- Complex story implementation
|
|
||||||
|
|
||||||
Quick workflows like status checks can reuse chats safely.
|
|
||||||
|
|
||||||
### Can I skip workflow-status and just start working?
|
|
||||||
|
|
||||||
Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for:
|
|
||||||
|
|
||||||
- New projects (guides initial setup)
|
|
||||||
- When you're unsure what to do next
|
|
||||||
- After breaks in work (reminds you where you left off)
|
|
||||||
- Checking overall progress
|
|
||||||
|
|
||||||
### What's the minimum I need to get started?
|
|
||||||
|
|
||||||
For the fastest path:
|
|
||||||
|
|
||||||
1. Install BMad Method: `npx bmad-method@alpha install`
|
|
||||||
2. For small changes: Load PM agent → run tech-spec → implement
|
|
||||||
3. For larger projects: Load PM agent → run prd → architect → implement
|
|
||||||
|
|
||||||
### How do I know if I'm in Phase 1, 2, 3, or 4?
|
|
||||||
|
|
||||||
Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on:
|
|
||||||
|
|
||||||
- **Phase 1** — Brainstorming, research, product brief (optional)
|
|
||||||
- **Phase 2** — Creating either a PRD or tech-spec (always required)
|
|
||||||
- **Phase 3** — Architecture design (Level 2-4 only)
|
|
||||||
- **Phase 4** — Actually writing code, implementing stories
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
---
|
|
||||||
title: "Implementation FAQ"
|
|
||||||
description: Common questions about implementation in the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about implementation in the BMad Method.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [Does create-story include implementation context?](#does-create-story-include-implementation-context)
|
|
||||||
- [How do I mark a story as done?](#how-do-i-mark-a-story-as-done)
|
|
||||||
- [Can I work on multiple stories at once?](#can-i-work-on-multiple-stories-at-once)
|
|
||||||
- [What if my story takes longer than estimated?](#what-if-my-story-takes-longer-than-estimated)
|
|
||||||
- [When should I run retrospective?](#when-should-i-run-retrospective)
|
|
||||||
|
|
||||||
### Does create-story include implementation context?
|
|
||||||
|
|
||||||
Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler.
|
|
||||||
|
|
||||||
### How do I mark a story as done?
|
|
||||||
|
|
||||||
After dev-story completes and code-review passes:
|
|
||||||
|
|
||||||
1. Open `sprint-status.yaml` (created by sprint-planning)
|
|
||||||
2. Change the story status from `review` to `done`
|
|
||||||
3. Save the file
|
|
||||||
|
|
||||||
### Can I work on multiple stories at once?
|
|
||||||
|
|
||||||
Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other.
|
|
||||||
|
|
||||||
### What if my story takes longer than estimated?
|
|
||||||
|
|
||||||
That's normal! Stories are estimates. If implementation reveals more complexity:
|
|
||||||
|
|
||||||
1. Continue working until DoD is met
|
|
||||||
2. Consider if story should be split
|
|
||||||
3. Document learnings in retrospective
|
|
||||||
4. Adjust future estimates based on this learning
|
|
||||||
|
|
||||||
### When should I run retrospective?
|
|
||||||
|
|
||||||
After completing all stories in an epic (when epic is done). Retrospectives capture:
|
|
||||||
|
|
||||||
- What went well
|
|
||||||
- What could improve
|
|
||||||
- Technical insights
|
|
||||||
- Learnings for future epics
|
|
||||||
|
|
||||||
Don't wait until project end — run after each epic for continuous improvement.
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
---
|
|
||||||
title: "Frequently Asked Questions"
|
|
||||||
description: Frequently asked questions about the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about the BMad Method, organized by topic.
|
|
||||||
|
|
||||||
## Topics
|
|
||||||
|
|
||||||
- [Getting Started](/docs/explanation/faq/getting-started-faq.md) - Questions about starting with BMad
|
|
||||||
- [Levels & Tracks](/docs/explanation/faq/levels-and-tracks-faq.md) - Choosing the right level
|
|
||||||
- [Workflows](/docs/explanation/faq/workflows-faq.md) - Workflow and phase questions
|
|
||||||
- [Planning](/docs/explanation/faq/planning-faq.md) - Planning document questions
|
|
||||||
- [Implementation](/docs/explanation/faq/implementation-faq.md) - Implementation questions
|
|
||||||
- [Brownfield](/docs/explanation/faq/brownfield-faq.md) - Existing codebase questions
|
|
||||||
- [Tools & Advanced](/docs/explanation/faq/tools-faq.md) - Tools, IDEs, and advanced topics
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
---
|
|
||||||
title: "Levels and Tracks FAQ"
|
|
||||||
description: Common questions about choosing the right level for your project
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about choosing the right level for your BMad Method project.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [How do I know which level my project is?](#how-do-i-know-which-level-my-project-is)
|
|
||||||
- [Can I change levels mid-project?](#can-i-change-levels-mid-project)
|
|
||||||
- [What if workflow-init suggests the wrong level?](#what-if-workflow-init-suggests-the-wrong-level)
|
|
||||||
- [Do I always need architecture for Level 2?](#do-i-always-need-architecture-for-level-2)
|
|
||||||
- [What's the difference between Level 1 and Level 2?](#whats-the-difference-between-level-1-and-level-2)
|
|
||||||
|
|
||||||
### How do I know which level my project is?
|
|
||||||
|
|
||||||
Use workflow-init for automatic detection, or self-assess using these keywords:
|
|
||||||
|
|
||||||
- **Level 0** — "fix", "bug", "typo", "small change", "patch" → 1 story
|
|
||||||
- **Level 1** — "simple", "basic", "small feature", "add" → 1-10 stories
|
|
||||||
- **Level 2** — "dashboard", "several features", "admin panel" → 5-15 stories
|
|
||||||
- **Level 3** — "platform", "integration", "complex", "system" → 12-40 stories
|
|
||||||
- **Level 4** — "enterprise", "multi-tenant", "multiple products" → 40+ stories
|
|
||||||
|
|
||||||
When in doubt, start smaller. You can always run create-prd later if needed.
|
|
||||||
|
|
||||||
### Can I change levels mid-project?
|
|
||||||
|
|
||||||
Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible — your initial level choice isn't permanent.
|
|
||||||
|
|
||||||
### What if workflow-init suggests the wrong level?
|
|
||||||
|
|
||||||
You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment.
|
|
||||||
|
|
||||||
### Do I always need architecture for Level 2?
|
|
||||||
|
|
||||||
No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning.
|
|
||||||
|
|
||||||
### What's the difference between Level 1 and Level 2?
|
|
||||||
|
|
||||||
- **Level 1** — 1-10 stories, uses tech-spec (simpler, faster), no architecture
|
|
||||||
- **Level 2** — 5-15 stories, uses PRD (product-focused), optional architecture
|
|
||||||
|
|
||||||
The overlap (5-10 stories) is intentional. Choose based on:
|
|
||||||
|
|
||||||
- Need product-level planning? → Level 2
|
|
||||||
- Just need technical plan? → Level 1
|
|
||||||
- Multiple epics? → Level 2
|
|
||||||
- Single epic? → Level 1
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
---
|
|
||||||
title: "Planning Documents FAQ"
|
|
||||||
description: Common questions about planning documents in the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about planning documents in the BMad Method.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [Why no tech-spec at Level 2+?](#why-no-tech-spec-at-level-2)
|
|
||||||
- [Do I need a PRD for a bug fix?](#do-i-need-a-prd-for-a-bug-fix)
|
|
||||||
- [Can I skip the product brief?](#can-i-skip-the-product-brief)
|
|
||||||
|
|
||||||
### Why no tech-spec at Level 2+?
|
|
||||||
|
|
||||||
Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses:
|
|
||||||
|
|
||||||
- PRD (product vision, functional requirements, non-functional requirements)
|
|
||||||
- Architecture (system design)
|
|
||||||
- Epics+Stories (created AFTER architecture is complete)
|
|
||||||
|
|
||||||
### Do I need a PRD for a bug fix?
|
|
||||||
|
|
||||||
No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
|
|
||||||
|
|
||||||
- Load PM agent
|
|
||||||
- Run tech-spec workflow
|
|
||||||
- Implement immediately
|
|
||||||
|
|
||||||
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
|
|
||||||
|
|
||||||
### Can I skip the product brief?
|
|
||||||
|
|
||||||
Yes, product brief is always optional. It's most valuable for:
|
|
||||||
|
|
||||||
- Level 3-4 projects needing strategic direction
|
|
||||||
- Projects with stakeholders requiring alignment
|
|
||||||
- Novel products needing market research
|
|
||||||
- When you want to explore solution space before committing
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,253 +0,0 @@
|
||||||
---
|
|
||||||
title: "Tools and Advanced FAQ"
|
|
||||||
description: Common questions about tools, IDEs, and advanced topics in the BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about tools, IDEs, and advanced topics in the BMad Method.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
**Tools and Technical**
|
|
||||||
|
|
||||||
- [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering)
|
|
||||||
- [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools)
|
|
||||||
- [What IDEs/tools support BMM?](#what-idestools-support-bmm)
|
|
||||||
- [Can I customize agents?](#can-i-customize-agents)
|
|
||||||
- [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation)
|
|
||||||
- [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects)
|
|
||||||
|
|
||||||
**Advanced**
|
|
||||||
|
|
||||||
- [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3)
|
|
||||||
- [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches)
|
|
||||||
- [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint)
|
|
||||||
- [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations)
|
|
||||||
- [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project)
|
|
||||||
- [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it)
|
|
||||||
|
|
||||||
**Getting Help**
|
|
||||||
|
|
||||||
- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here)
|
|
||||||
- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature)
|
|
||||||
|
|
||||||
## Tools and Technical
|
|
||||||
|
|
||||||
### Why are my Mermaid diagrams not rendering?
|
|
||||||
|
|
||||||
Common issues:
|
|
||||||
|
|
||||||
1. Missing language tag: Use ` ```mermaid` not just ` ``` `
|
|
||||||
2. Syntax errors in diagram (validate at mermaid.live)
|
|
||||||
3. Tool doesn't support Mermaid (check your Markdown renderer)
|
|
||||||
|
|
||||||
All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs.
|
|
||||||
|
|
||||||
### Can I use BMM with GitHub Copilot / Cursor / other AI tools?
|
|
||||||
|
|
||||||
Yes! BMM is complementary. BMM handles:
|
|
||||||
|
|
||||||
- Project planning and structure
|
|
||||||
- Workflow orchestration
|
|
||||||
- Agent Personas and expertise
|
|
||||||
- Documentation generation
|
|
||||||
- Quality gates
|
|
||||||
|
|
||||||
Your AI coding assistant handles:
|
|
||||||
|
|
||||||
- Line-by-line code completion
|
|
||||||
- Quick refactoring
|
|
||||||
- Test generation
|
|
||||||
|
|
||||||
Use them together for best results.
|
|
||||||
|
|
||||||
### What IDEs/tools support BMM?
|
|
||||||
|
|
||||||
BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes.
|
|
||||||
|
|
||||||
**Recommended Tools:**
|
|
||||||
|
|
||||||
- **Claude Code** — Best choice
|
|
||||||
- Sonnet 4.5 (excellent workflow following, coding, reasoning)
|
|
||||||
- Opus (maximum context, complex planning)
|
|
||||||
- Native agent mode designed for BMM workflows
|
|
||||||
|
|
||||||
- **Cursor**
|
|
||||||
- Supports Anthropic (Claude) and OpenAI models
|
|
||||||
- Agent mode with composer
|
|
||||||
- Good for developers who prefer Cursor's UX
|
|
||||||
|
|
||||||
- **Windsurf**
|
|
||||||
- Multi-model support
|
|
||||||
- Agent capabilities
|
|
||||||
- Suitable for BMM workflows
|
|
||||||
|
|
||||||
**What Matters:**
|
|
||||||
|
|
||||||
1. **Agent mode** — Can load long workflow instructions and maintain context
|
|
||||||
2. **High-quality LLM** — Models ranked high on SWE-bench (coding benchmarks)
|
|
||||||
3. **Model selection** — Access to Claude Sonnet 4.5, Opus, or GPT-4o class models
|
|
||||||
4. **Context capacity** — Can handle large planning documents and codebases
|
|
||||||
|
|
||||||
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
|
|
||||||
|
|
||||||
### Can I customize agents?
|
|
||||||
|
|
||||||
Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
|
||||||
|
|
||||||
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags — a format any LLM can read and follow.
|
|
||||||
|
|
||||||
### What happens to my planning docs after implementation?
|
|
||||||
|
|
||||||
Keep them! They serve as:
|
|
||||||
|
|
||||||
- Historical record of decisions
|
|
||||||
- Onboarding material for new team members
|
|
||||||
- Reference for future enhancements
|
|
||||||
- Audit trail for compliance
|
|
||||||
|
|
||||||
For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean.
|
|
||||||
|
|
||||||
### Can I use BMM for non-software projects?
|
|
||||||
|
|
||||||
BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain.
|
|
||||||
|
|
||||||
## Advanced
|
|
||||||
|
|
||||||
### What if my project grows from Level 1 to Level 3?
|
|
||||||
|
|
||||||
Totally fine! When you realize scope has grown:
|
|
||||||
|
|
||||||
1. Run create-prd to add product-level planning
|
|
||||||
2. Run create-architecture for system design
|
|
||||||
3. Use existing tech-spec as input for PRD
|
|
||||||
4. Continue with updated level
|
|
||||||
|
|
||||||
The system is flexible — growth is expected.
|
|
||||||
|
|
||||||
### Can I mix greenfield and brownfield approaches?
|
|
||||||
|
|
||||||
Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach:
|
|
||||||
|
|
||||||
1. Run document-project for brownfield context
|
|
||||||
2. Use greenfield workflows for new feature planning
|
|
||||||
3. Explicitly document integration points between new and existing
|
|
||||||
4. Test integration thoroughly
|
|
||||||
|
|
||||||
### How do I handle urgent hotfixes during a sprint?
|
|
||||||
|
|
||||||
Use correct-course workflow or just:
|
|
||||||
|
|
||||||
1. Save your current work state
|
|
||||||
2. Load PM agent → quick tech-spec for hotfix
|
|
||||||
3. Implement hotfix (Level 0 flow)
|
|
||||||
4. Deploy hotfix
|
|
||||||
5. Return to original sprint work
|
|
||||||
|
|
||||||
Level 0 Quick Spec Flow is perfect for urgent fixes.
|
|
||||||
|
|
||||||
### What if I disagree with the workflow's recommendations?
|
|
||||||
|
|
||||||
Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context:
|
|
||||||
|
|
||||||
- Explain your reasoning to the agent
|
|
||||||
- Ask for alternative approaches
|
|
||||||
- Skip the recommendation if you're confident
|
|
||||||
- Document why you deviated (for future reference)
|
|
||||||
|
|
||||||
Trust your expertise — BMM supports your decisions.
|
|
||||||
|
|
||||||
### Can multiple developers work on the same BMM project?
|
|
||||||
|
|
||||||
Yes! But the paradigm is fundamentally different from traditional agile teams.
|
|
||||||
|
|
||||||
**Key Difference:**
|
|
||||||
|
|
||||||
- **Traditional** — Multiple devs work on stories within one epic (months)
|
|
||||||
- **Agentic** — Each dev owns complete epics (days)
|
|
||||||
|
|
||||||
**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories.
|
|
||||||
|
|
||||||
**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days.
|
|
||||||
|
|
||||||
**Team Work Distribution:**
|
|
||||||
|
|
||||||
- **Recommended:** Split work by **epic** (not story)
|
|
||||||
- Each developer owns complete epics end-to-end
|
|
||||||
- Parallel work happens at epic level
|
|
||||||
- Minimal coordination needed
|
|
||||||
|
|
||||||
**For full-stack apps:**
|
|
||||||
|
|
||||||
- Frontend and backend can be separate epics (unusual in traditional agile)
|
|
||||||
- Frontend dev owns all frontend epics
|
|
||||||
- Backend dev owns all backend epics
|
|
||||||
- Works because delivery is so fast
|
|
||||||
|
|
||||||
**Enterprise Considerations:**
|
|
||||||
|
|
||||||
- Use **git submodules** for BMM installation (not .gitignore)
|
|
||||||
- Allows personal configurations without polluting main repo
|
|
||||||
- Teams may use different AI tools (Claude Code, Cursor, etc.)
|
|
||||||
- Developers may follow different methods or create custom agents/workflows
|
|
||||||
|
|
||||||
**Quick Tips:**
|
|
||||||
|
|
||||||
- Share `sprint-status.yaml` (single source of truth)
|
|
||||||
- Assign entire epics to developers (not individual stories)
|
|
||||||
- Coordinate at epic boundaries, not story level
|
|
||||||
- Use git submodules for BMM in enterprise settings
|
|
||||||
|
|
||||||
### What is party mode and when should I use it?
|
|
||||||
|
|
||||||
Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time.
|
|
||||||
|
|
||||||
**How it works:**
|
|
||||||
|
|
||||||
1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent)
|
|
||||||
2. Introduce your topic
|
|
||||||
3. BMad Master selects 2-3 most relevant agents per message
|
|
||||||
4. Agents cross-talk, debate, and build on each other's ideas
|
|
||||||
|
|
||||||
**Best for:**
|
|
||||||
|
|
||||||
- Strategic decisions with trade-offs (architecture choices, tech stack, scope)
|
|
||||||
- Creative brainstorming (game design, product innovation, UX ideation)
|
|
||||||
- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions)
|
|
||||||
- Complex problem-solving (multi-faceted challenges, risk assessment)
|
|
||||||
|
|
||||||
**Example parties:**
|
|
||||||
|
|
||||||
- **Product Strategy** — PM + Innovation Strategist (CIS) + Analyst
|
|
||||||
- **Technical Design** — Architect + Creative Problem Solver (CIS) + Game Architect
|
|
||||||
- **User Experience** — UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
|
|
||||||
|
|
||||||
**Why it's powerful:**
|
|
||||||
|
|
||||||
- Diverse perspectives (technical, creative, strategic)
|
|
||||||
- Healthy debate reveals blind spots
|
|
||||||
- Emergent insights from agent interaction
|
|
||||||
- Natural collaboration across modules
|
|
||||||
|
|
||||||
**For complete documentation:** See the [Party Mode Guide](/docs/explanation/features/party-mode.md)
|
|
||||||
|
|
||||||
## Getting Help
|
|
||||||
|
|
||||||
### Where do I get help if my question isn't answered here?
|
|
||||||
|
|
||||||
1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics
|
|
||||||
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help)
|
|
||||||
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
|
||||||
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)
|
|
||||||
|
|
||||||
### How do I report a bug or request a feature?
|
|
||||||
|
|
||||||
Open a GitHub issue at: <https://github.com/bmad-code-org/BMAD-METHOD/issues>
|
|
||||||
|
|
||||||
Please include:
|
|
||||||
|
|
||||||
- BMM version (check your installed version)
|
|
||||||
- Steps to reproduce (for bugs)
|
|
||||||
- Expected vs actual behavior
|
|
||||||
- Relevant workflow or agent involved
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,61 +0,0 @@
|
||||||
---
|
|
||||||
title: "Workflows FAQ"
|
|
||||||
description: Common questions about BMad Method workflows and phases
|
|
||||||
---
|
|
||||||
|
|
||||||
Quick answers to common questions about BMad Method workflows and phases.
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
- [What's the difference between workflow-status and workflow-init?](#whats-the-difference-between-workflow-status-and-workflow-init)
|
|
||||||
- [Can I skip Phase 1 (Analysis)?](#can-i-skip-phase-1-analysis)
|
|
||||||
- [When is Phase 3 (Architecture) required?](#when-is-phase-3-architecture-required)
|
|
||||||
- [What happens if I skip a recommended workflow?](#what-happens-if-i-skip-a-recommended-workflow)
|
|
||||||
- [How do I know when Phase 3 is complete?](#how-do-i-know-when-phase-3-is-complete)
|
|
||||||
- [Can I run workflows in parallel?](#can-i-run-workflows-in-parallel)
|
|
||||||
|
|
||||||
### What's the difference between workflow-status and workflow-init?
|
|
||||||
|
|
||||||
- **workflow-status** — Checks existing status and tells you what's next (use when continuing work)
|
|
||||||
- **workflow-init** — Creates new status file and sets up project (use when starting new project)
|
|
||||||
|
|
||||||
If status file exists, use workflow-status. If not, use workflow-init.
|
|
||||||
|
|
||||||
### Can I skip Phase 1 (Analysis)?
|
|
||||||
|
|
||||||
Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if:
|
|
||||||
|
|
||||||
- Requirements are clear
|
|
||||||
- No research needed
|
|
||||||
- Time-sensitive work
|
|
||||||
- Small changes (Level 0-1)
|
|
||||||
|
|
||||||
### When is Phase 3 (Architecture) required?
|
|
||||||
|
|
||||||
- **Level 0-1** — Never (skip entirely)
|
|
||||||
- **Level 2** — Optional (only if system design needed)
|
|
||||||
- **Level 3-4** — Required (comprehensive architecture mandatory)
|
|
||||||
|
|
||||||
### What happens if I skip a recommended workflow?
|
|
||||||
|
|
||||||
Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause:
|
|
||||||
|
|
||||||
- Integration issues during implementation
|
|
||||||
- Rework due to poor planning
|
|
||||||
- Conflicting design decisions
|
|
||||||
- Longer development time overall
|
|
||||||
|
|
||||||
### How do I know when Phase 3 is complete?
|
|
||||||
|
|
||||||
For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4.
|
|
||||||
|
|
||||||
### Can I run workflows in parallel?
|
|
||||||
|
|
||||||
Most workflows must be sequential within a phase:
|
|
||||||
|
|
||||||
- **Phase 1** — brainstorm → research → product-brief (optional order)
|
|
||||||
- **Phase 2** — PRD must complete before moving forward
|
|
||||||
- **Phase 3** — architecture → epics+stories → implementation-readiness (sequential)
|
|
||||||
- **Phase 4** — Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity
|
|
||||||
|
|
||||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
||||||
|
|
@ -1,108 +0,0 @@
|
||||||
---
|
|
||||||
title: "Advanced Elicitation"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
|
|
||||||
|
|
||||||
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use It
|
|
||||||
|
|
||||||
- After a workflow generates a section of content and you want to explore alternatives
|
|
||||||
- When the LLM's initial output seems adequate but you suspect there's more depth available
|
|
||||||
- For high-stakes content where multiple perspectives would strengthen the result
|
|
||||||
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
|
||||||
- When you want the LLM to "think again" but with structured reasoning methods
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
|
||||||
|
|
||||||
### 1. Context Analysis
|
|
||||||
The LLM analyzes the current content, understanding its type, complexity, stakeholder needs, risk level, and creative potential.
|
|
||||||
|
|
||||||
### 2. Smart Method Selection
|
|
||||||
Based on context, 5 methods are intelligently selected from a library of 50+ techniques and presented to you:
|
|
||||||
|
|
||||||
| Option | Description |
|
|
||||||
| ----------------- | ---------------------------------------- |
|
|
||||||
| **1-5** | Apply the selected method to the content |
|
|
||||||
| **[r] Reshuffle** | Get 5 new methods selected randomly |
|
|
||||||
| **[a] List All** | Browse the complete method library |
|
|
||||||
| **[x] Proceed** | Continue with enhanced content |
|
|
||||||
|
|
||||||
### 3. Method Execution & Iteration
|
|
||||||
- The selected method is applied to the current content
|
|
||||||
- Improvements are shown for your review
|
|
||||||
- You choose whether to apply changes or discard them
|
|
||||||
- The menu re-appears for additional elicitations
|
|
||||||
- Each method builds on previous enhancements
|
|
||||||
|
|
||||||
### 4. Party Mode Integration (Optional)
|
|
||||||
If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Method Categories
|
|
||||||
|
|
||||||
| Category | Focus | Example Methods |
|
|
||||||
| ----------------- | ----------------------------------- | -------------------------------------------------------------- |
|
|
||||||
| **Core** | Foundational reasoning techniques | First Principles Analysis, 5 Whys, Socratic Questioning |
|
|
||||||
| **Collaboration** | Multiple perspectives and synthesis | Stakeholder Round Table, Expert Panel Review, Debate Club |
|
|
||||||
| **Advanced** | Complex reasoning frameworks | Tree of Thoughts, Graph of Thoughts, Self-Consistency |
|
|
||||||
| **Competitive** | Adversarial stress-testing | Red Team vs Blue Team, Shark Tank Pitch, Code Review Gauntlet |
|
|
||||||
| **Technical** | Architecture and code quality | Decision Records, Rubber Duck Debugging, Algorithm Olympics |
|
|
||||||
| **Creative** | Innovation and lateral thinking | SCAMPER, Reverse Engineering, Random Input Stimulus |
|
|
||||||
| **Research** | Evidence-based analysis | Literature Review Personas, Thesis Defense, Comparative Matrix |
|
|
||||||
| **Risk** | Risk identification and mitigation | Pre-mortem Analysis, Failure Mode Analysis, Chaos Monkey |
|
|
||||||
| **Learning** | Understanding verification | Feynman Technique, Active Recall Testing |
|
|
||||||
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
|
||||||
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
|
||||||
- **Smart context selection** — Methods chosen based on content type, complexity, and stakeholder needs
|
|
||||||
- **Iterative enhancement** — Each method builds on previous improvements
|
|
||||||
- **User control** — Accept or discard each enhancement before proceeding
|
|
||||||
- **Party Mode integration** — Agents can participate when Party Mode is active
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Integration
|
|
||||||
|
|
||||||
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
|
||||||
|
|
||||||
| Parameter | Description |
|
|
||||||
| ---------------------- | --------------------------------------------------------- |
|
|
||||||
| **Content to enhance** | The current section content that was just generated |
|
|
||||||
| **Context type** | The kind of content being created (spec, code, doc, etc.) |
|
|
||||||
| **Enhancement goals** | What the calling workflow wants to improve |
|
|
||||||
|
|
||||||
### Integration Flow
|
|
||||||
|
|
||||||
When called from a workflow:
|
|
||||||
1. Receives the current section content that was just generated
|
|
||||||
2. Applies elicitation methods iteratively to enhance that content
|
|
||||||
3. Returns the enhanced version when user selects 'x' to proceed
|
|
||||||
4. The enhanced content replaces the original section in the output document
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Advanced Elicitation vs. Brainstorming
|
|
||||||
|
|
||||||
| | **Advanced Elicitation** | **Brainstorming** |
|
|
||||||
| ------------ | ------------------------------------------------- | --------------------------------------------- |
|
|
||||||
| **Source** | LLM generates ideas through structured reasoning | User provides ideas, AI coaches them out |
|
|
||||||
| **Purpose** | Rethink and improve LLM's own output | Unlock user's creativity |
|
|
||||||
| **Methods** | 50+ reasoning and analysis techniques | 60+ ideation and creativity techniques |
|
|
||||||
| **Best for** | Enhancing generated content, finding alternatives | Breaking through blocks, generating new ideas |
|
|
||||||
|
|
@ -1,103 +0,0 @@
|
||||||
---
|
|
||||||
title: "Brainstorming"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
|
|
||||||
|
|
||||||
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner—using proven techniques to draw out ideas and insights that are already within you.
|
|
||||||
|
|
||||||
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use It
|
|
||||||
|
|
||||||
- Breaking through creative blocks on a specific challenge
|
|
||||||
- Generating innovative ideas for products, features, or solutions
|
|
||||||
- Exploring a problem from completely new angles
|
|
||||||
- Systematically developing ideas from raw concepts to actionable plans
|
|
||||||
- Team ideation (with collaborative techniques) or personal creative exploration
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
|
||||||
|
|
||||||
### 1. Session Setup
|
|
||||||
Define your topic, goals, and any constraints.
|
|
||||||
|
|
||||||
### 2. Choose Your Approach
|
|
||||||
|
|
||||||
| Approach | Description |
|
|
||||||
|----------|-------------|
|
|
||||||
| **User-Selected** | Browse the full technique library and pick what appeals to you |
|
|
||||||
| **AI-Recommended** | Get customized technique suggestions based on your goals |
|
|
||||||
| **Random Selection** | Discover unexpected methods through serendipitous technique combinations |
|
|
||||||
| **Progressive Flow** | Journey systematically from expansive exploration to focused action planning |
|
|
||||||
|
|
||||||
### 3. Interactive Facilitation
|
|
||||||
Work through techniques with true collaborative coaching. The AI asks probing questions, builds on your ideas, and helps you think deeper—but your ideas are the source.
|
|
||||||
|
|
||||||
### 4. Idea Organization
|
|
||||||
All your generated ideas are organized into themes and prioritized.
|
|
||||||
|
|
||||||
### 5. Action Planning
|
|
||||||
Top ideas get concrete next steps, resource requirements, and success metrics.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
|
||||||
|
|
||||||
A comprehensive session document that captures the entire journey:
|
|
||||||
|
|
||||||
- Topic, goals, and session parameters
|
|
||||||
- Each technique used and how it was applied
|
|
||||||
- Your contributions and the ideas you generated
|
|
||||||
- Thematic organization connecting related insights
|
|
||||||
- Prioritized ideas with action plans
|
|
||||||
- Session highlights and key breakthroughs
|
|
||||||
|
|
||||||
This document becomes a permanent record of your creative process—valuable for future reference, sharing with stakeholders, or continuing the session later.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technique Categories
|
|
||||||
|
|
||||||
| Category | Focus |
|
|
||||||
|----------|-------|
|
|
||||||
| **Collaborative** | Team dynamics and inclusive participation |
|
|
||||||
| **Creative** | Breakthrough thinking and paradigm shifts |
|
|
||||||
| **Deep** | Root cause analysis and strategic insight |
|
|
||||||
| **Structured** | Organized frameworks and systematic exploration |
|
|
||||||
| **Theatrical** | Playful, radical perspectives |
|
|
||||||
| **Wild** | Boundary-pushing, extreme thinking |
|
|
||||||
| **Biomimetic** | Nature-inspired solutions |
|
|
||||||
| **Quantum** | Quantum principles for innovation |
|
|
||||||
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
|
||||||
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
|
|
||||||
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
|
||||||
- **On-demand loading** — Techniques loaded from a comprehensive library as needed
|
|
||||||
- **Session preservation** — Every step, insight, and action plan is documented
|
|
||||||
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Workflow Integration
|
|
||||||
|
|
||||||
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
|
||||||
|
|
||||||
| Parameter | Description |
|
|
||||||
|-----------|-------------|
|
|
||||||
| **Topic focus** | What the brainstorming should help discover or solve |
|
|
||||||
| **Guardrails** | Constraints, boundaries, or must-avoid areas |
|
|
||||||
| **Output goals** | What the final output needs to accomplish for the calling workflow |
|
|
||||||
| **Context files** | Project-specific guidance to inform technique selection |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
When creating a new module in the BMad Builder workflow, Brainstorming can be invoked with guardrails around the module's purpose and a goal to discover key features, user needs, or architectural considerations. The session becomes focused on producing exactly what the module creation workflow needs.
|
|
||||||
|
|
@ -1,112 +0,0 @@
|
||||||
---
|
|
||||||
title: "Party Mode: Multi-Agent Collaboration"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
**Get all your AI agents in one conversation**
|
|
||||||
|
|
||||||
## What is Party Mode?
|
|
||||||
|
|
||||||
Ever wanted to gather your entire AI team in one room and see what happens? That's party mode.
|
|
||||||
|
|
||||||
Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at key workflow junctions when asked), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer and more that you can choose from.
|
|
||||||
|
|
||||||
**Why it's useful:**
|
|
||||||
|
|
||||||
- **After complex workflows** - Debrief with the whole team about what worked, what didn't
|
|
||||||
- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously
|
|
||||||
- **Brainstorming sessions** - Watch ideas evolve through cross-pollination
|
|
||||||
- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic)
|
|
||||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
|
||||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How It Works
|
|
||||||
|
|
||||||
**The basics:**
|
|
||||||
|
|
||||||
1. Party mode reads `_bmad/_config/agent-manifest.csv`
|
|
||||||
2. Loads ALL installed agents (already includes your customizations from install)
|
|
||||||
3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic
|
|
||||||
4. Agents respond in character, can agree/disagree/build on each other's ideas
|
|
||||||
5. Discussion continues until you type "exit" or reach natural conclusion
|
|
||||||
|
|
||||||
**That's it.** No complex merging, no runtime magic. Just agents talking.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
```bash
|
|
||||||
/bmad:core:workflows:party-mode
|
|
||||||
|
|
||||||
*party-mode
|
|
||||||
|
|
||||||
|
|
||||||
/bmad:core:workflows:party-mode and include also in the party Santa Clause and Einstein
|
|
||||||
|
|
||||||
Ask questions, respond to agents, direct the conversation
|
|
||||||
|
|
||||||
Type: exit
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Fun Examples
|
|
||||||
|
|
||||||
### Example 1: Calling Out Bad Architecture
|
|
||||||
|
|
||||||
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
|
||||||
|
|
||||||
**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
|
||||||
|
|
||||||
**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
|
||||||
|
|
||||||
**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
|
||||||
|
|
||||||
**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
|
||||||
|
|
||||||
_(Watch them debate whose fault it really was - it's therapeutic)_
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Example 2: Creative Brainstorming
|
|
||||||
|
|
||||||
**You:** "How do we make onboarding feel magical instead of boring?"
|
|
||||||
|
|
||||||
**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
|
||||||
|
|
||||||
**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
|
||||||
|
|
||||||
**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges."
|
|
||||||
|
|
||||||
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
|
||||||
|
|
||||||
_(Ideas cross-pollinate and evolve)_
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Example 3: Technical Decision
|
|
||||||
|
|
||||||
**You:** "Monolith or microservices for MVP?"
|
|
||||||
|
|
||||||
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
|
||||||
|
|
||||||
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
|
||||||
|
|
||||||
**DEV:** "Monolith with clear module boundaries. We can extract services later if needed."
|
|
||||||
|
|
||||||
**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right."
|
|
||||||
|
|
||||||
_(Multiple perspectives reveal the right answer)_
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- [Agents Reference](/docs/reference/agents/index.md) - Complete agent reference
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Setup Party Mode](/docs/how-to/workflows/setup-party-mode.md) - How to use it
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Better decisions through diverse perspectives. Welcome to party mode._
|
|
||||||
|
|
@ -1,169 +0,0 @@
|
||||||
---
|
|
||||||
title: "Quick Spec Flow"
|
|
||||||
description: Understanding Quick Spec Flow for rapid development in BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
|
|
||||||
|
|
||||||
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
|
||||||
|
|
||||||
**Time to implementation:** Minutes, not hours
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Quick Flow
|
|
||||||
|
|
||||||
### ✅ Use Quick Flow when:
|
|
||||||
|
|
||||||
- Single bug fix or small enhancement
|
|
||||||
- Small feature with clear scope (typically 1-15 stories)
|
|
||||||
- Rapid prototyping or experimentation
|
|
||||||
- Adding to existing brownfield codebase
|
|
||||||
- You know exactly what you want to build
|
|
||||||
|
|
||||||
### ❌ Use BMad Method or Enterprise when:
|
|
||||||
|
|
||||||
- Building new products or major features
|
|
||||||
- Need stakeholder alignment
|
|
||||||
- Complex multi-team coordination
|
|
||||||
- Requires extensive planning and architecture
|
|
||||||
|
|
||||||
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Flow Overview
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart TD
|
|
||||||
START[Step 1: Run Tech-Spec Workflow]
|
|
||||||
DETECT[Detects project stack]
|
|
||||||
ANALYZE[Analyzes brownfield codebase]
|
|
||||||
TEST[Detects test frameworks]
|
|
||||||
CONFIRM[Confirms conventions]
|
|
||||||
GENERATE[Generates context-rich tech-spec]
|
|
||||||
STORIES[Creates ready-to-implement stories]
|
|
||||||
IMPL[Step 2: Implement with DEV Agent]
|
|
||||||
DONE[DONE!]
|
|
||||||
|
|
||||||
START --> DETECT
|
|
||||||
DETECT --> ANALYZE
|
|
||||||
ANALYZE --> TEST
|
|
||||||
TEST --> CONFIRM
|
|
||||||
CONFIRM --> GENERATE
|
|
||||||
GENERATE --> STORIES
|
|
||||||
STORIES --> IMPL
|
|
||||||
IMPL --> DONE
|
|
||||||
|
|
||||||
style START fill:#bfb,stroke:#333,stroke-width:2px
|
|
||||||
style IMPL fill:#bbf,stroke:#333,stroke-width:2px
|
|
||||||
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What Makes It Quick
|
|
||||||
|
|
||||||
- ✅ No Product Brief needed
|
|
||||||
- ✅ No PRD needed
|
|
||||||
- ✅ No Architecture doc needed
|
|
||||||
- ✅ Auto-detects your stack
|
|
||||||
- ✅ Auto-analyzes brownfield code
|
|
||||||
- ✅ Auto-validates quality
|
|
||||||
- ✅ Story context optional (tech-spec is comprehensive!)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Smart Context Discovery
|
|
||||||
|
|
||||||
Quick Spec Flow automatically discovers and uses:
|
|
||||||
|
|
||||||
### Existing Documentation
|
|
||||||
- Product briefs (if they exist)
|
|
||||||
- Research documents
|
|
||||||
- `document-project` output (brownfield codebase map)
|
|
||||||
|
|
||||||
### Project Stack
|
|
||||||
- **Node.js:** package.json → frameworks, dependencies, scripts
|
|
||||||
- **Python:** requirements.txt, pyproject.toml → packages, tools
|
|
||||||
- **Ruby:** Gemfile → gems and versions
|
|
||||||
- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies
|
|
||||||
- **Go:** go.mod → modules
|
|
||||||
- **Rust:** Cargo.toml → crates
|
|
||||||
|
|
||||||
### Brownfield Code Patterns
|
|
||||||
- Directory structure and organization
|
|
||||||
- Existing code patterns (class-based, functional, MVC)
|
|
||||||
- Naming conventions
|
|
||||||
- Test frameworks and patterns
|
|
||||||
- Code style configurations
|
|
||||||
|
|
||||||
### Convention Confirmation
|
|
||||||
|
|
||||||
Quick Spec Flow detects your conventions and **asks for confirmation**:
|
|
||||||
|
|
||||||
```
|
|
||||||
I've detected these conventions in your codebase:
|
|
||||||
|
|
||||||
Code Style:
|
|
||||||
- ESLint with Airbnb config
|
|
||||||
- Prettier with single quotes
|
|
||||||
|
|
||||||
Test Patterns:
|
|
||||||
- Jest test framework
|
|
||||||
- .test.js file naming
|
|
||||||
|
|
||||||
Should I follow these existing conventions? (yes/no)
|
|
||||||
```
|
|
||||||
|
|
||||||
**You decide:** Conform to existing patterns or establish new standards!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Auto-Validation
|
|
||||||
|
|
||||||
Quick Spec Flow **automatically validates** everything:
|
|
||||||
|
|
||||||
- ✅ Context gathering completeness
|
|
||||||
- ✅ Definitiveness (no "use X or Y" statements)
|
|
||||||
- ✅ Brownfield integration quality
|
|
||||||
- ✅ Stack alignment
|
|
||||||
- ✅ Implementation readiness
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Comparison: Quick Flow vs Full BMM
|
|
||||||
|
|
||||||
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
|
||||||
| --------------------- | ---------------------------- | ---------------------------------- |
|
|
||||||
| **Setup** | None (standalone) | workflow-init recommended |
|
|
||||||
| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture |
|
|
||||||
| **Time to Code** | Minutes | Hours to days |
|
|
||||||
| **Best For** | Bug fixes, small features | New products, major features |
|
|
||||||
| **Context Discovery** | Automatic | Manual + guided |
|
|
||||||
| **Validation** | Auto-validates everything | Manual validation steps |
|
|
||||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Graduate to BMad Method
|
|
||||||
|
|
||||||
Start with Quick Flow, but switch to BMad Method when:
|
|
||||||
|
|
||||||
- ❌ Project grows beyond initial scope
|
|
||||||
- ❌ Multiple teams need coordination
|
|
||||||
- ❌ Stakeholders need formal documentation
|
|
||||||
- ❌ Product vision is unclear
|
|
||||||
- ❌ Architectural decisions need deep analysis
|
|
||||||
- ❌ Compliance/regulatory requirements exist
|
|
||||||
|
|
||||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Quick Spec](/docs/how-to/workflows/quick-spec.md) - How to use Quick Flow
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Understanding the full methodology
|
|
||||||
|
|
@ -1,497 +0,0 @@
|
||||||
---
|
|
||||||
title: "Test Architect (TEA) Overview"
|
|
||||||
description: Understanding the Test Architect (TEA) agent and its role in BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The Test Architect (TEA) is a specialized agent focused on quality strategy, test automation, and release gates in BMad Method projects.
|
|
||||||
|
|
||||||
:::tip[Design Philosophy]
|
|
||||||
TEA was built to solve AI-generated tests that rot in review. For the problem statement and design principles, see [Testing as Engineering](/docs/explanation/philosophy/testing-as-engineering.md). For setup, see [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md).
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
|
|
||||||
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
|
|
||||||
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choose Your TEA Engagement Model
|
|
||||||
|
|
||||||
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
|
|
||||||
|
|
||||||
1. **No TEA**
|
|
||||||
- Skip all TEA workflows. Use your existing team testing approach.
|
|
||||||
|
|
||||||
2. **TEA-only (Standalone)**
|
|
||||||
- Use TEA on a non-BMad project. Bring your own requirements, acceptance criteria, and environments.
|
|
||||||
- Typical sequence: `*test-design` (system or epic) -> `*atdd` and/or `*automate` -> optional `*test-review` -> `*trace` for coverage and gate decisions.
|
|
||||||
- Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline.
|
|
||||||
|
|
||||||
3. **Integrated: Greenfield - BMad Method (Simple/Standard Work)**
|
|
||||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
|
||||||
- Phase 4: per-epic `*test-design`, optional `*atdd`, then `*automate` and optional `*test-review`.
|
|
||||||
- Gate (Phase 2): `*trace`.
|
|
||||||
|
|
||||||
4. **Integrated: Brownfield - BMad Method or Enterprise (Simple or Complex)**
|
|
||||||
- Phase 2: baseline `*trace`.
|
|
||||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
|
||||||
- Phase 4: per-epic `*test-design` focused on regression and integration risks.
|
|
||||||
- Gate (Phase 2): `*trace`; `*nfr-assess` (if not done earlier).
|
|
||||||
- For brownfield BMad Method, follow the same flow with `*nfr-assess` optional.
|
|
||||||
|
|
||||||
5. **Integrated: Greenfield - Enterprise Method (Enterprise/Compliance Work)**
|
|
||||||
- Phase 2: `*nfr-assess`.
|
|
||||||
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
|
|
||||||
- Phase 4: per-epic `*test-design`, plus `*atdd`/`*automate`/`*test-review`.
|
|
||||||
- Gate (Phase 2): `*trace`; archive artifacts as needed.
|
|
||||||
|
|
||||||
If you are unsure, default to the integrated path for your track and adjust later.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TEA Workflow Lifecycle
|
|
||||||
|
|
||||||
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%%
|
|
||||||
graph TB
|
|
||||||
subgraph Phase2["<b>Phase 2: PLANNING</b>"]
|
|
||||||
PM["<b>PM: *prd (creates PRD with FRs/NFRs)</b>"]
|
|
||||||
PlanNote["<b>Business requirements phase</b>"]
|
|
||||||
NFR2["<b>TEA: *nfr-assess (optional, enterprise)</b>"]
|
|
||||||
PM -.-> NFR2
|
|
||||||
NFR2 -.-> PlanNote
|
|
||||||
PM -.-> PlanNote
|
|
||||||
end
|
|
||||||
|
|
||||||
subgraph Phase3["<b>Phase 3: SOLUTIONING</b>"]
|
|
||||||
Architecture["<b>Architect: *architecture</b>"]
|
|
||||||
EpicsStories["<b>PM/Architect: *create-epics-and-stories</b>"]
|
|
||||||
TestDesignSys["<b>TEA: *test-design (system-level)</b>"]
|
|
||||||
Framework["<b>TEA: *framework (optional if needed)</b>"]
|
|
||||||
CI["<b>TEA: *ci (optional if needed)</b>"]
|
|
||||||
GateCheck["<b>Architect: *implementation-readiness</b>"]
|
|
||||||
Architecture --> EpicsStories
|
|
||||||
Architecture --> TestDesignSys
|
|
||||||
TestDesignSys --> Framework
|
|
||||||
EpicsStories --> Framework
|
|
||||||
Framework --> CI
|
|
||||||
CI --> GateCheck
|
|
||||||
Phase3Note["<b>Epics created AFTER architecture,</b><br/><b>then system-level test design and test infrastructure setup</b>"]
|
|
||||||
EpicsStories -.-> Phase3Note
|
|
||||||
end
|
|
||||||
|
|
||||||
subgraph Phase4["<b>Phase 4: IMPLEMENTATION - Per Epic Cycle</b>"]
|
|
||||||
SprintPlan["<b>SM: *sprint-planning</b>"]
|
|
||||||
TestDesign["<b>TEA: *test-design (per epic)</b>"]
|
|
||||||
CreateStory["<b>SM: *create-story</b>"]
|
|
||||||
ATDD["<b>TEA: *atdd (optional, before dev)</b>"]
|
|
||||||
DevImpl["<b>DEV: implements story</b>"]
|
|
||||||
Automate["<b>TEA: *automate</b>"]
|
|
||||||
TestReview1["<b>TEA: *test-review (optional)</b>"]
|
|
||||||
Trace1["<b>TEA: *trace (refresh coverage)</b>"]
|
|
||||||
|
|
||||||
SprintPlan --> TestDesign
|
|
||||||
TestDesign --> CreateStory
|
|
||||||
CreateStory --> ATDD
|
|
||||||
ATDD --> DevImpl
|
|
||||||
DevImpl --> Automate
|
|
||||||
Automate --> TestReview1
|
|
||||||
TestReview1 --> Trace1
|
|
||||||
Trace1 -.->|next story| CreateStory
|
|
||||||
TestDesignNote["<b>Test design: 'How do I test THIS epic?'</b><br/>Creates test-design-epic-N.md per epic"]
|
|
||||||
TestDesign -.-> TestDesignNote
|
|
||||||
end
|
|
||||||
|
|
||||||
subgraph Gate["<b>EPIC/RELEASE GATE</b>"]
|
|
||||||
NFR["<b>TEA: *nfr-assess (if not done earlier)</b>"]
|
|
||||||
TestReview2["<b>TEA: *test-review (final audit, optional)</b>"]
|
|
||||||
TraceGate["<b>TEA: *trace - Phase 2: Gate</b>"]
|
|
||||||
GateDecision{"<b>Gate Decision</b>"}
|
|
||||||
|
|
||||||
NFR --> TestReview2
|
|
||||||
TestReview2 --> TraceGate
|
|
||||||
TraceGate --> GateDecision
|
|
||||||
GateDecision -->|PASS| Pass["<b>PASS ✅</b>"]
|
|
||||||
GateDecision -->|CONCERNS| Concerns["<b>CONCERNS ⚠️</b>"]
|
|
||||||
GateDecision -->|FAIL| Fail["<b>FAIL ❌</b>"]
|
|
||||||
GateDecision -->|WAIVED| Waived["<b>WAIVED ⏭️</b>"]
|
|
||||||
end
|
|
||||||
|
|
||||||
Phase2 --> Phase3
|
|
||||||
Phase3 --> Phase4
|
|
||||||
Phase4 --> Gate
|
|
||||||
|
|
||||||
style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000
|
|
||||||
style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000
|
|
||||||
style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000
|
|
||||||
style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000
|
|
||||||
style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000
|
|
||||||
style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000
|
|
||||||
style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000
|
|
||||||
style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000
|
|
||||||
```
|
|
||||||
|
|
||||||
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and documentation prerequisite:
|
|
||||||
|
|
||||||
- **Documentation** (Optional for brownfield): Prerequisite using `*document-project`
|
|
||||||
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
|
|
||||||
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
|
|
||||||
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
|
|
||||||
- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows)
|
|
||||||
|
|
||||||
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**:
|
|
||||||
|
|
||||||
- **System-level (Phase 3):** Run immediately after architecture/ADR drafting to produce `test-design-system.md` (testability review, ADR → test mapping, Architecturally Significant Requirements (ASRs), environment needs). Feeds the implementation-readiness gate.
|
|
||||||
- **Epic-level (Phase 4):** Run per-epic to produce `test-design-epic-N.md` (risk, priorities, coverage plan).
|
|
||||||
|
|
||||||
Quick Flow track skips Phases 1 and 3.
|
|
||||||
BMad Method and Enterprise use all phases based on project needs.
|
|
||||||
When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Why TEA is Different from Other BMM Agents
|
|
||||||
|
|
||||||
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
|
|
||||||
|
|
||||||
### Phase-Specific Agents (Standard Pattern)
|
|
||||||
|
|
||||||
Most BMM agents work in a single phase:
|
|
||||||
|
|
||||||
- **Phase 1 (Analysis)**: Analyst agent
|
|
||||||
- **Phase 2 (Planning)**: PM agent
|
|
||||||
- **Phase 3 (Solutioning)**: Architect agent
|
|
||||||
- **Phase 4 (Implementation)**: SM, DEV agents
|
|
||||||
|
|
||||||
### TEA: Multi-Phase Quality Agent (Unique Pattern)
|
|
||||||
|
|
||||||
TEA is **the only agent that operates in multiple phases**:
|
|
||||||
|
|
||||||
```
|
|
||||||
Phase 1 (Analysis) → [TEA not typically used]
|
|
||||||
↓
|
|
||||||
Phase 2 (Planning) → [PM defines requirements - TEA not active]
|
|
||||||
↓
|
|
||||||
Phase 3 (Solutioning) → TEA: *framework, *ci (test infrastructure AFTER architecture)
|
|
||||||
↓
|
|
||||||
Phase 4 (Implementation) → TEA: *test-design (per epic: "how do I test THIS feature?")
|
|
||||||
→ TEA: *atdd, *automate, *test-review, *trace (per story)
|
|
||||||
↓
|
|
||||||
Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision)
|
|
||||||
```
|
|
||||||
|
|
||||||
### TEA's 8 Workflows Across Phases
|
|
||||||
|
|
||||||
**Standard agents**: 1-3 workflows per phase
|
|
||||||
**TEA**: 8 workflows across Phase 3, Phase 4, and Release Gate
|
|
||||||
|
|
||||||
| Phase | TEA Workflows | Frequency | Purpose |
|
|
||||||
| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- |
|
|
||||||
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
|
|
||||||
| **Phase 3** | \*framework, \*ci | Once per project | Setup test infrastructure AFTER architecture |
|
|
||||||
| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
|
|
||||||
| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
|
|
||||||
|
|
||||||
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
|
|
||||||
|
|
||||||
### Why TEA Requires Its Own Knowledge Base
|
|
||||||
|
|
||||||
TEA uniquely requires:
|
|
||||||
|
|
||||||
- **Extensive domain knowledge**: 30+ fragments covering test patterns, CI/CD, fixtures, quality practices, and optional playwright-utils integration
|
|
||||||
- **Cross-cutting concerns**: Domain-specific testing patterns that apply across all BMad projects (vs project-specific artifacts like PRDs/stories)
|
|
||||||
- **Optional integrations**: MCP capabilities (exploratory, verification) and playwright-utils support
|
|
||||||
|
|
||||||
This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## High-Level Cheat Sheets
|
|
||||||
|
|
||||||
These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation).
|
|
||||||
|
|
||||||
**Note:** Quick Flow projects typically don't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value.
|
|
||||||
|
|
||||||
**Legend for Track Deltas:**
|
|
||||||
|
|
||||||
- ➕ = New workflow or phase added (doesn't exist in baseline)
|
|
||||||
- 🔄 = Modified focus (same workflow, different emphasis or purpose)
|
|
||||||
- 📦 = Additional output or archival requirement
|
|
||||||
|
|
||||||
### Greenfield - BMad Method (Simple/Standard Work)
|
|
||||||
|
|
||||||
**Planning Track:** BMad Method (PRD + Architecture)
|
|
||||||
**Use Case:** New projects with standard complexity
|
|
||||||
|
|
||||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
|
||||||
| -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
||||||
| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` |
|
|
||||||
| **Phase 2**: Planning | - | PM `*prd` (creates PRD with FRs/NFRs) | PRD with functional/non-functional requirements |
|
|
||||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test scaffold, 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 (per-epic test plan) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan |
|
|
||||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
|
||||||
| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix |
|
|
||||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary |
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Execution Notes</summary>
|
|
||||||
|
|
||||||
- Run `*framework` only once per repo or when modern harness support is missing.
|
|
||||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to setup test infrastructure based on architectural decisions.
|
|
||||||
- **Phase 4 starts**: After solutioning is complete, sprint planning loads all epics.
|
|
||||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create a test plan for THAT specific epic/feature. Output: `test-design-epic-N.md`.
|
|
||||||
- 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>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Worked Example – “Nova CRM” Greenfield Feature</summary>
|
|
||||||
|
|
||||||
1. **Planning (Phase 2):** Analyst runs `*product-brief`; PM executes `*prd` to produce PRD with FRs/NFRs.
|
|
||||||
2. **Solutioning (Phase 3):** Architect completes `*architecture` for the new module; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up test infrastructure via `*framework` and `*ci` based on architectural decisions; gate check validates planning completeness.
|
|
||||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status.
|
|
||||||
4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` to create test plan for Epic 1, producing `test-design-epic-1.md` with risk assessment.
|
|
||||||
5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA optionally runs `*atdd`; Dev implements with guidance from failing tests.
|
|
||||||
6. **Post-Dev (Phase 4):** TEA runs `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage.
|
|
||||||
7. **Release Gate:** TEA runs `*trace` with Phase 2 enabled to generate gate decision.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Brownfield - BMad Method or Enterprise (Simple or Complex)
|
|
||||||
|
|
||||||
**Planning Tracks:** BMad Method or Enterprise Method
|
|
||||||
**Use Case:** Existing codebases - simple additions (BMad Method) or complex enterprise requirements (Enterprise Method)
|
|
||||||
|
|
||||||
**🔄 Brownfield Deltas from Greenfield:**
|
|
||||||
|
|
||||||
- ➕ Documentation (Prerequisite) - Document existing codebase if undocumented
|
|
||||||
- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning
|
|
||||||
- 🔄 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 |
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Execution Notes</summary>
|
|
||||||
|
|
||||||
- Lead with `*trace` during Planning (Phase 2) to baseline existing test coverage before architecture work begins.
|
|
||||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to modernize test infrastructure. For brownfield, framework may need to integrate with or replace existing test setup.
|
|
||||||
- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics.
|
|
||||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to identify regression hotspots, integration risks, and mitigation strategies for THAT specific epic/feature. Output: `test-design-epic-N.md`.
|
|
||||||
- Use `*atdd` when stories benefit from ATDD; otherwise proceed to implementation and rely on post-dev automation.
|
|
||||||
- After development, expand coverage with `*automate`, optionally review test quality with `*test-review`, re-run `*trace` (Phase 2 for gate decision). Run `*nfr-assess` now if non-functional risks weren't addressed earlier.
|
|
||||||
- Use `*test-review` to validate existing brownfield tests or audit new tests before gate.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Worked Example – “Atlas Payments” Brownfield Story</summary>
|
|
||||||
|
|
||||||
1. **Planning (Phase 2):** PM executes `*prd` to create PRD with FRs/NFRs; TEA runs `*trace` to baseline existing coverage.
|
|
||||||
2. **Solutioning (Phase 3):** Architect triggers `*architecture` capturing legacy payment flows and integration architecture; `*create-epics-and-stories` generates Epic 1 (Payment Processing) based on architecture; TEA sets up `*framework` and `*ci` based on architectural decisions; gate check validates planning.
|
|
||||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load Epic 1 into sprint status.
|
|
||||||
4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` for Epic 1 (Payment Processing), producing `test-design-epic-1.md` that flags settlement edge cases, regression hotspots, and mitigation plans.
|
|
||||||
5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA runs `*atdd` producing failing Playwright specs; Dev implements with guidance from tests and checklist.
|
|
||||||
6. **Post-Dev (Phase 4):** TEA applies `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage.
|
|
||||||
7. **Release Gate:** TEA performs `*nfr-assess` to validate SLAs, runs `*trace` with Phase 2 enabled to generate gate decision (PASS/CONCERNS/FAIL).
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Greenfield - Enterprise Method (Enterprise/Compliance Work)
|
|
||||||
|
|
||||||
**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies)
|
|
||||||
**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements
|
|
||||||
|
|
||||||
**🏢 Enterprise Deltas from BMad Method:**
|
|
||||||
|
|
||||||
- ➕ Phase 1: `*research` - Domain and compliance research (recommended)
|
|
||||||
- ➕ Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability)
|
|
||||||
- 🔄 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 |
|
|
||||||
| **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 |
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Execution Notes</summary>
|
|
||||||
|
|
||||||
- `*nfr-assess` runs early in Planning (Phase 2) to capture compliance, security, and performance requirements upfront.
|
|
||||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` with enterprise-grade configurations (selective testing, burn-in jobs, caching, notifications).
|
|
||||||
- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics.
|
|
||||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create an enterprise-focused test plan for THAT specific epic, ensuring alignment with security architecture, performance targets, and compliance requirements. Output: `test-design-epic-N.md`.
|
|
||||||
- Use `*atdd` for stories when feasible so acceptance tests can lead implementation.
|
|
||||||
- Use `*test-review` per story or sprint to maintain quality standards and ensure compliance with testing best practices.
|
|
||||||
- Prior to release, rerun coverage (`*trace`, `*automate`), perform final quality audit with `*test-review`, and formalize the decision with `*trace` Phase 2 (gate decision); archive artifacts for compliance audits.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Worked Example – “Helios Ledger” Enterprise Release</summary>
|
|
||||||
|
|
||||||
1. **Planning (Phase 2):** Analyst runs `*research` and `*product-brief`; PM completes `*prd` creating PRD with FRs/NFRs; TEA runs `*nfr-assess` to establish NFR targets.
|
|
||||||
2. **Solutioning (Phase 3):** Architect completes `*architecture` with enterprise considerations; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up `*framework` and `*ci` with enterprise-grade configurations based on architectural decisions; gate check validates planning completeness.
|
|
||||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status.
|
|
||||||
4. **Per-Epic (Phase 4):** For each epic, TEA runs `*test-design` to create epic-specific test plan (e.g., `test-design-epic-1.md`, `test-design-epic-2.md`) with compliance-focused risk assessment.
|
|
||||||
5. **Per-Story (Phase 4):** For each story, TEA uses `*atdd`, `*automate`, `*test-review`, and `*trace`; Dev teams iterate on the findings.
|
|
||||||
6. **Release Gate:** TEA re-checks coverage, performs final quality audit with `*test-review`, and logs the final gate decision via `*trace` Phase 2, archiving artifacts for compliance.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## TEA Command Catalog
|
|
||||||
|
|
||||||
| 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 | - |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Playwright Utils Integration
|
|
||||||
|
|
||||||
TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. This integration enhances TEA's test generation and review workflows with production-ready patterns.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><strong>Installation & Configuration</strong></summary>
|
|
||||||
|
|
||||||
**Package**: `@seontechnologies/playwright-utils` ([npm](https://www.npmjs.com/package/@seontechnologies/playwright-utils) | [GitHub](https://github.com/seontechnologies/playwright-utils))
|
|
||||||
|
|
||||||
**Install**: `npm install -D @seontechnologies/playwright-utils`
|
|
||||||
|
|
||||||
**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/bmm/config.yaml`.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><strong>How Playwright Utils Enhances TEA Workflows</strong></summary>
|
|
||||||
|
|
||||||
1. `*framework`:
|
|
||||||
- Default: Basic Playwright scaffold
|
|
||||||
- **+ playwright-utils**: Scaffold with api-request, network-recorder, auth-session, burn-in, network-error-monitor fixtures pre-configured
|
|
||||||
|
|
||||||
Benefit: Production-ready patterns from day one
|
|
||||||
|
|
||||||
2. `*automate`, `*atdd`:
|
|
||||||
- Default: Standard test patterns
|
|
||||||
- **+ playwright-utils**: Tests using api-request (schema validation), intercept-network-call (mocking), recurse (polling), log (structured logging), file-utils (CSV/PDF)
|
|
||||||
|
|
||||||
Benefit: Advanced patterns without boilerplate
|
|
||||||
|
|
||||||
3. `*test-review`:
|
|
||||||
- Default: Reviews against core knowledge base (22 fragments)
|
|
||||||
- **+ playwright-utils**: Reviews against expanded knowledge base (33 fragments: 22 core + 11 playwright-utils)
|
|
||||||
|
|
||||||
Benefit: Reviews include fixture composition, auth patterns, network recording best practices
|
|
||||||
|
|
||||||
4. `*ci`:
|
|
||||||
- Default: Standard CI workflow
|
|
||||||
- **+ playwright-utils**: CI workflow with burn-in script (smart test selection) and network-error-monitor integration
|
|
||||||
|
|
||||||
Benefit: Faster CI feedback, HTTP error detection
|
|
||||||
|
|
||||||
**Utilities available** (10 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Playwright MCP Enhancements
|
|
||||||
|
|
||||||
TEA can leverage Playwright MCP servers to enhance test generation with live browser verification. MCP provides interactive capabilities on top of TEA's default AI-based approach.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><strong>MCP Server Configuration</strong></summary>
|
|
||||||
|
|
||||||
**Two Playwright MCP servers** (actively maintained, continuously updated):
|
|
||||||
|
|
||||||
- `playwright` - Browser automation (`npx @playwright/mcp@latest`)
|
|
||||||
- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`)
|
|
||||||
|
|
||||||
**Config example**:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"mcpServers": {
|
|
||||||
"playwright": {
|
|
||||||
"command": "npx",
|
|
||||||
"args": ["@playwright/mcp@latest"]
|
|
||||||
},
|
|
||||||
"playwright-test": {
|
|
||||||
"command": "npx",
|
|
||||||
"args": ["playwright", "run-test-mcp-server"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` OR remove MCPs from IDE config.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary><strong>How MCP Enhances TEA Workflows</strong></summary>
|
|
||||||
|
|
||||||
1. `*test-design`:
|
|
||||||
- Default: Analysis + documentation
|
|
||||||
- **+ MCP**: Interactive UI discovery with `browser_navigate`, `browser_click`, `browser_snapshot`, behavior observation
|
|
||||||
|
|
||||||
Benefit: Discover actual functionality, edge cases, undocumented features
|
|
||||||
|
|
||||||
2. `*atdd`, `*automate`:
|
|
||||||
- Default: Infers selectors and interactions from requirements and knowledge fragments
|
|
||||||
- **+ MCP**: Generates tests **then** verifies with `generator_setup_page`, `browser_*` tools, validates against live app
|
|
||||||
|
|
||||||
Benefit: Accurate selectors from real DOM, verified behavior, refined test code
|
|
||||||
|
|
||||||
3. `*automate` (healing mode):
|
|
||||||
- Default: Pattern-based fixes from error messages + knowledge fragments
|
|
||||||
- **+ MCP**: Pattern fixes **enhanced with** `browser_snapshot`, `browser_console_messages`, `browser_network_requests`, `browser_generate_locator`
|
|
||||||
|
|
||||||
Benefit: Visual failure context, live DOM inspection, root cause discovery
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - How to set up testing infrastructure
|
|
||||||
- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
---
|
|
||||||
title: "Web Bundles"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Use BMad agents in Gemini Gems and Custom GPTs.
|
|
||||||
|
|
||||||
## Status
|
|
||||||
|
|
||||||
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
|
||||||
|
|
||||||
## What Are Web Bundles?
|
|
||||||
|
|
||||||
Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload.
|
|
||||||
|
|
||||||
### What's Included
|
|
||||||
|
|
||||||
- Complete agent persona and instructions
|
|
||||||
- All workflows and dependencies
|
|
||||||
- Interactive menu system
|
|
||||||
- Party mode for multi-agent collaboration
|
|
||||||
- No external files required
|
|
||||||
|
|
||||||
### Use Cases
|
|
||||||
|
|
||||||
**Perfect for:**
|
|
||||||
- Uploading a single file to a Gemini GEM or Custom GPT
|
|
||||||
- Using BMad Method from the Web
|
|
||||||
- Cost savings (generally lower cost than local usage)
|
|
||||||
- Quick sharing of agent configurations
|
|
||||||
|
|
||||||
**Trade-offs:**
|
|
||||||
- Some quality reduction vs local usage
|
|
||||||
- Less convenient than full local installation
|
|
||||||
- Limited to agent capabilities (no workflow file access)
|
|
||||||
|
|
@ -1,410 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMGD Agents Guide"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Complete reference for BMGD's six specialized game development agents.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Overview
|
|
||||||
|
|
||||||
BMGD provides six agents, each with distinct expertise:
|
|
||||||
|
|
||||||
| Agent | Name | Role | Phase Focus |
|
|
||||||
| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- |
|
|
||||||
| 🎲 **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 |
|
|
||||||
| 🏛️ **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 |
|
|
||||||
| 🕹️ **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 |
|
|
||||||
| 🎯 **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 |
|
|
||||||
| 🧪 **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases |
|
|
||||||
| 🎮 **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎲 Game Designer (Samus Shepard)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Lead Game Designer + Creative Vision Architect
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Veteran designer with 15+ years crafting AAA and indie hits. Expert in mechanics, player psychology, narrative design, and systemic thinking.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Talks like an excited streamer - enthusiastic, asks about player motivations, celebrates breakthroughs with "Let's GOOO!"
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- Design what players want to FEEL, not what they say they want
|
|
||||||
- Prototype fast - one hour of playtesting beats ten hours of discussion
|
|
||||||
- Every mechanic must serve the core fantasy
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Brainstorming game ideas
|
|
||||||
- Creating Game Briefs
|
|
||||||
- Designing GDDs
|
|
||||||
- Developing narrative design
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ---------------------- | -------------------------------- |
|
|
||||||
| `workflow-status` | Check project status |
|
|
||||||
| `brainstorm-game` | Guided game ideation |
|
|
||||||
| `create-game-brief` | Create Game Brief |
|
|
||||||
| `create-gdd` | Create Game Design Document |
|
|
||||||
| `narrative` | Create Narrative Design Document |
|
|
||||||
| `quick-prototype` | Rapid prototyping (IDE only) |
|
|
||||||
| `party-mode` | Multi-agent collaboration |
|
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🏛️ Game Architect (Cloud Dragonborn)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Principal Game Systems Architect + Technical Director
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Master architect with 20+ years shipping 30+ titles. Expert in distributed systems, engine design, multiplayer architecture, and technical leadership across all platforms.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Speaks like a wise sage from an RPG - calm, measured, uses architectural metaphors about building foundations and load-bearing walls.
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- Architecture is about delaying decisions until you have enough data
|
|
||||||
- Build for tomorrow without over-engineering today
|
|
||||||
- Hours of planning save weeks of refactoring hell
|
|
||||||
- Every system must handle the hot path at 60fps
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Planning technical architecture
|
|
||||||
- Making engine/framework decisions
|
|
||||||
- Designing game systems
|
|
||||||
- Course correction during development
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ---------------------- | ------------------------------------- |
|
|
||||||
| `workflow-status` | Check project status |
|
|
||||||
| `create-architecture` | Create Game Architecture |
|
|
||||||
| `correct-course` | Course correction analysis (IDE only) |
|
|
||||||
| `party-mode` | Multi-agent collaboration |
|
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🕹️ Game Developer (Link Freeman)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Senior Game Developer + Technical Implementation Specialist
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Battle-hardened dev with expertise in Unity, Unreal, and custom engines. Ten years shipping across mobile, console, and PC. Writes clean, performant code.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Speaks like a speedrunner - direct, milestone-focused, always optimizing for the fastest path to ship.
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- 60fps is non-negotiable
|
|
||||||
- Write code designers can iterate without fear
|
|
||||||
- Ship early, ship often, iterate on player feedback
|
|
||||||
- Red-green-refactor: tests first, implementation second
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Implementing stories
|
|
||||||
- Code reviews
|
|
||||||
- Performance optimization
|
|
||||||
- Completing story work
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ---------------------- | ------------------------------- |
|
|
||||||
| `workflow-status` | Check sprint progress |
|
|
||||||
| `dev-story` | Implement story tasks |
|
|
||||||
| `code-review` | Perform code review |
|
|
||||||
| `quick-dev` | Flexible development (IDE only) |
|
|
||||||
| `quick-prototype` | Rapid prototyping (IDE only) |
|
|
||||||
| `party-mode` | Multi-agent collaboration |
|
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎯 Game Scrum Master (Max)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Game Development Scrum Master + Sprint Orchestrator
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Certified Scrum Master specializing in game dev workflows. Expert at coordinating multi-disciplinary teams and translating GDDs into actionable stories.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Talks in game terminology - milestones are save points, handoffs are level transitions, blockers are boss fights.
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- Every sprint delivers playable increments
|
|
||||||
- Clean separation between design and implementation
|
|
||||||
- Keep the team moving through each phase
|
|
||||||
- Stories are single source of truth for implementation
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Sprint planning and management
|
|
||||||
- Creating epic tech specs
|
|
||||||
- Writing story drafts
|
|
||||||
- Assembling story context
|
|
||||||
- Running retrospectives
|
|
||||||
- Handling course corrections
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ----------------------- | ------------------------------------------- |
|
|
||||||
| `workflow-status` | Check project status |
|
|
||||||
| `sprint-planning` | Generate/update sprint status |
|
|
||||||
| `sprint-status` | View sprint progress, get next action |
|
|
||||||
| `create-story` | Create story (marks ready-for-dev directly) |
|
|
||||||
| `validate-create-story` | Validate story draft |
|
|
||||||
| `epic-retrospective` | Facilitate retrospective |
|
|
||||||
| `correct-course` | Navigate significant changes |
|
|
||||||
| `party-mode` | Multi-agent collaboration |
|
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🧪 Game QA (GLaDOS)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Game QA Architect + Test Automation Specialist
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Senior QA architect with 12+ years in game testing across Unity, Unreal, and Godot. Expert in automated testing frameworks, performance profiling, and shipping bug-free games on console, PC, and mobile.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Speaks like a quality guardian - methodical, data-driven, but understands that "feel" matters in games. Uses metrics to back intuition. "Trust, but verify with tests."
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- Test what matters: gameplay feel, performance, progression
|
|
||||||
- Automated tests catch regressions, humans catch fun problems
|
|
||||||
- Every shipped bug is a process failure, not a people failure
|
|
||||||
- Flaky tests are worse than no tests - they erode trust
|
|
||||||
- Profile before optimize, test before ship
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Setting up test frameworks
|
|
||||||
- Designing test strategies
|
|
||||||
- Creating automated tests
|
|
||||||
- Planning playtesting sessions
|
|
||||||
- Performance testing
|
|
||||||
- Reviewing test coverage
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ---------------------- | --------------------------------------------------- |
|
|
||||||
| `workflow-status` | Check project status |
|
|
||||||
| `test-framework` | Initialize game test framework (Unity/Unreal/Godot) |
|
|
||||||
| `test-design` | Create comprehensive game test scenarios |
|
|
||||||
| `automate` | Generate automated game tests |
|
|
||||||
| `playtest-plan` | Create structured playtesting plan |
|
|
||||||
| `performance-test` | Design performance testing strategy |
|
|
||||||
| `test-review` | Review test quality and coverage |
|
|
||||||
| `party-mode` | Multi-agent collaboration |
|
|
||||||
| `advanced-elicitation` | Deep exploration (web only) |
|
|
||||||
|
|
||||||
### Knowledge Base
|
|
||||||
|
|
||||||
GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-index.csv`) including:
|
|
||||||
|
|
||||||
**Engine-Specific Testing:**
|
|
||||||
|
|
||||||
- Unity Test Framework (Edit Mode, Play Mode)
|
|
||||||
- Unreal Automation and Gauntlet
|
|
||||||
- Godot GUT (Godot Unit Test)
|
|
||||||
|
|
||||||
**Game-Specific Testing:**
|
|
||||||
|
|
||||||
- Playtesting fundamentals
|
|
||||||
- Balance testing
|
|
||||||
- Save system testing
|
|
||||||
- Multiplayer/network testing
|
|
||||||
- Input testing
|
|
||||||
- Platform certification (TRC/XR)
|
|
||||||
- Localization testing
|
|
||||||
|
|
||||||
**General QA:**
|
|
||||||
|
|
||||||
- QA automation strategies
|
|
||||||
- Performance testing
|
|
||||||
- Regression testing
|
|
||||||
- Smoke testing
|
|
||||||
- Test prioritization (P0-P3)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🎮 Game Solo Dev (Indie)
|
|
||||||
|
|
||||||
### Role
|
|
||||||
|
|
||||||
Elite Indie Game Developer + Quick Flow Specialist
|
|
||||||
|
|
||||||
### Identity
|
|
||||||
|
|
||||||
Battle-hardened solo game developer who ships complete games from concept to launch. Expert in Unity, Unreal, and Godot, having shipped titles across mobile, PC, and console. Lives and breathes the Quick Flow workflow - prototyping fast, iterating faster, and shipping before the hype dies.
|
|
||||||
|
|
||||||
### Communication Style
|
|
||||||
|
|
||||||
Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and player experience. Every response moves the game closer to ship. "Does it feel good? Ship it."
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- Prototype fast, fail fast, iterate faster
|
|
||||||
- A playable build beats a perfect design doc
|
|
||||||
- 60fps is non-negotiable - performance is a feature
|
|
||||||
- The core loop must be fun before anything else matters
|
|
||||||
- Ship early, playtest often
|
|
||||||
|
|
||||||
### When to Use
|
|
||||||
|
|
||||||
- Solo game development
|
|
||||||
- Rapid prototyping
|
|
||||||
- Quick iteration without full team workflow
|
|
||||||
- Indie projects with tight timelines
|
|
||||||
- When you want to handle everything yourself
|
|
||||||
|
|
||||||
### Available Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| ------------------ | ------------------------------------------------------ |
|
|
||||||
| `quick-prototype` | Rapid prototype to test if a mechanic is fun |
|
|
||||||
| `quick-dev` | Implement features end-to-end with game considerations |
|
|
||||||
| `quick-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](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
|
||||||
- **[Workflows Guide](/docs/reference/workflows/index.md)** - Detailed workflow reference
|
|
||||||
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Game type templates
|
|
||||||
|
|
@ -1,150 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMGD vs BMM"
|
|
||||||
description: Understanding the differences between BMGD and BMM
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quick Comparison
|
|
||||||
|
|
||||||
| Aspect | BMM | BMGD |
|
|
||||||
| -------------- | ------------------------------------- | ------------------------------------------------------------------------ |
|
|
||||||
| **Focus** | General software | Game development |
|
|
||||||
| **Agents** | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev |
|
|
||||||
| **Planning** | PRD, Tech Spec | Game Brief, GDD |
|
|
||||||
| **Types** | N/A | 24 game type templates |
|
|
||||||
| **Narrative** | N/A | Full narrative workflow |
|
|
||||||
| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) |
|
|
||||||
| **Production** | BMM workflows | BMM workflows with game overrides |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Agent Differences
|
|
||||||
|
|
||||||
### BMM Agents
|
|
||||||
- PM (Product Manager)
|
|
||||||
- Architect
|
|
||||||
- DEV (Developer)
|
|
||||||
- SM (Scrum Master)
|
|
||||||
- TEA (Test Architect)
|
|
||||||
- Quick Flow Solo Dev
|
|
||||||
|
|
||||||
### BMGD Agents
|
|
||||||
- Game Designer
|
|
||||||
- Game Developer
|
|
||||||
- Game Architect
|
|
||||||
- Game Scrum Master
|
|
||||||
- Game QA
|
|
||||||
- Game Solo Dev
|
|
||||||
|
|
||||||
BMGD agents understand game-specific concepts like:
|
|
||||||
- Game mechanics and balance
|
|
||||||
- Player psychology
|
|
||||||
- Engine-specific patterns
|
|
||||||
- Playtesting and QA
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Planning Documents
|
|
||||||
|
|
||||||
### BMM Planning
|
|
||||||
- **Product Brief** → **PRD** → **Architecture**
|
|
||||||
- Focus: Software requirements, user stories, system design
|
|
||||||
|
|
||||||
### BMGD Planning
|
|
||||||
- **Game Brief** → **GDD** → **Architecture**
|
|
||||||
- Focus: Game vision, mechanics, narrative, player experience
|
|
||||||
|
|
||||||
The GDD (Game Design Document) includes:
|
|
||||||
- Core gameplay loop
|
|
||||||
- Mechanics and systems
|
|
||||||
- Progression and balance
|
|
||||||
- Art and audio direction
|
|
||||||
- Genre-specific sections
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Type Templates
|
|
||||||
|
|
||||||
BMGD includes 24 game type templates that auto-configure GDD sections:
|
|
||||||
|
|
||||||
- Action, Adventure, Puzzle
|
|
||||||
- RPG, Strategy, Simulation
|
|
||||||
- Sports, Racing, Fighting
|
|
||||||
- Horror, Platformer, Shooter
|
|
||||||
- And more...
|
|
||||||
|
|
||||||
Each template provides:
|
|
||||||
- Genre-specific GDD sections
|
|
||||||
- Relevant mechanics patterns
|
|
||||||
- Testing considerations
|
|
||||||
- Common pitfalls to avoid
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Narrative Support
|
|
||||||
|
|
||||||
BMGD includes full narrative workflow for story-driven games:
|
|
||||||
|
|
||||||
- **Narrative Design** workflow
|
|
||||||
- Story structure templates
|
|
||||||
- Character development
|
|
||||||
- World-building guidelines
|
|
||||||
- Dialogue systems
|
|
||||||
|
|
||||||
BMM has no equivalent for narrative design.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Testing Differences
|
|
||||||
|
|
||||||
### BMM Testing (TEA)
|
|
||||||
- Web-focused (Playwright, Cypress)
|
|
||||||
- API testing
|
|
||||||
- E2E for web applications
|
|
||||||
|
|
||||||
### BMGD Testing (Game QA)
|
|
||||||
- Engine-specific frameworks (Unity, Unreal, Godot)
|
|
||||||
- Gameplay testing
|
|
||||||
- Performance profiling
|
|
||||||
- Playtest planning
|
|
||||||
- Balance validation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Production Workflow
|
|
||||||
|
|
||||||
BMGD production workflows **inherit from BMM** and add game-specific:
|
|
||||||
- Checklists
|
|
||||||
- Templates
|
|
||||||
- Quality gates
|
|
||||||
- Engine-specific considerations
|
|
||||||
|
|
||||||
This means you get all of BMM's implementation structure plus game-specific enhancements.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use Each
|
|
||||||
|
|
||||||
### Use BMM when:
|
|
||||||
- Building web applications
|
|
||||||
- Creating APIs and services
|
|
||||||
- Developing mobile apps (non-game)
|
|
||||||
- Any general software project
|
|
||||||
|
|
||||||
### Use BMGD when:
|
|
||||||
- Building video games
|
|
||||||
- Creating interactive experiences
|
|
||||||
- Game prototyping
|
|
||||||
- Game jams
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [BMGD Overview](/docs/explanation/game-dev/index.md) - Getting started with BMGD
|
|
||||||
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game templates
|
|
||||||
- [Quick Start BMGD](/docs/tutorials/getting-started/quick-start-bmgd.md) - Tutorial
|
|
||||||
|
|
@ -1,506 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMGD Game Types Guide"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Reference for selecting and using BMGD's 24 supported game type templates.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Supported Game Types
|
|
||||||
|
|
||||||
### Action & Combat
|
|
||||||
|
|
||||||
#### Action Platformer
|
|
||||||
|
|
||||||
**Tags:** action, platformer, combat, movement
|
|
||||||
|
|
||||||
Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Celeste with combat, or Mega Man.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Movement systems (jumps, dashes, wall mechanics)
|
|
||||||
- Combat mechanics (melee/ranged, combos)
|
|
||||||
- Level design patterns
|
|
||||||
- Boss design
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Shooter
|
|
||||||
|
|
||||||
**Tags:** shooter, combat, aiming, fps, tps
|
|
||||||
|
|
||||||
Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Weapon systems
|
|
||||||
- Aiming and accuracy
|
|
||||||
- Enemy AI patterns
|
|
||||||
- Level/arena design
|
|
||||||
- Multiplayer considerations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Fighting
|
|
||||||
|
|
||||||
**Tags:** fighting, combat, competitive, combos, pvp
|
|
||||||
|
|
||||||
1v1 combat with combos and frame data. Traditional fighters and platform fighters.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Frame data systems
|
|
||||||
- Combo mechanics
|
|
||||||
- Character movesets
|
|
||||||
- Competitive balance
|
|
||||||
- Netcode requirements
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Strategy & Tactics
|
|
||||||
|
|
||||||
#### Strategy
|
|
||||||
|
|
||||||
**Tags:** strategy, tactics, resources, planning
|
|
||||||
|
|
||||||
Resource management with tactical decisions. RTS, 4X, and grand strategy.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Resource systems
|
|
||||||
- Unit/building design
|
|
||||||
- AI opponent behavior
|
|
||||||
- Map/scenario design
|
|
||||||
- Victory conditions
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Turn-Based Tactics
|
|
||||||
|
|
||||||
**Tags:** tactics, turn-based, grid, positioning
|
|
||||||
|
|
||||||
Grid-based movement with turn order. XCOM-likes and tactical RPGs.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Grid and movement systems
|
|
||||||
- Turn order mechanics
|
|
||||||
- Cover and positioning
|
|
||||||
- Unit progression
|
|
||||||
- Procedural mission generation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Tower Defense
|
|
||||||
|
|
||||||
**Tags:** tower-defense, waves, placement, strategy
|
|
||||||
|
|
||||||
Wave-based defense with tower placement.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Tower types and upgrades
|
|
||||||
- Wave design and pacing
|
|
||||||
- Economy systems
|
|
||||||
- Map design patterns
|
|
||||||
- Meta-progression
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### RPG & Progression
|
|
||||||
|
|
||||||
#### RPG
|
|
||||||
|
|
||||||
**Tags:** rpg, stats, inventory, quests, narrative
|
|
||||||
|
|
||||||
Character progression with stats, inventory, and quests.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Character stats and leveling
|
|
||||||
- Inventory and equipment
|
|
||||||
- Quest system design
|
|
||||||
- Combat system (action/turn-based)
|
|
||||||
- Skill trees and builds
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Roguelike
|
|
||||||
|
|
||||||
**Tags:** roguelike, procedural, permadeath, runs
|
|
||||||
|
|
||||||
Procedural generation with permadeath and run-based progression.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Procedural generation rules
|
|
||||||
- Permadeath and persistence
|
|
||||||
- Run structure and pacing
|
|
||||||
- Item/ability synergies
|
|
||||||
- Meta-progression systems
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Metroidvania
|
|
||||||
|
|
||||||
**Tags:** metroidvania, exploration, abilities, interconnected
|
|
||||||
|
|
||||||
Interconnected world with ability gating.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- World map connectivity
|
|
||||||
- Ability gating design
|
|
||||||
- Backtracking flow
|
|
||||||
- Secret and collectible placement
|
|
||||||
- Power-up progression
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Narrative & Story
|
|
||||||
|
|
||||||
#### Adventure
|
|
||||||
|
|
||||||
**Tags:** adventure, narrative, exploration, story
|
|
||||||
|
|
||||||
Story-driven exploration and narrative. Point-and-click and narrative adventures.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Puzzle design
|
|
||||||
- Narrative delivery
|
|
||||||
- Exploration mechanics
|
|
||||||
- Dialogue systems
|
|
||||||
- Story branching
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Visual Novel
|
|
||||||
|
|
||||||
**Tags:** visual-novel, narrative, choices, story
|
|
||||||
|
|
||||||
Narrative choices with branching story.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Branching narrative structure
|
|
||||||
- Choice and consequence
|
|
||||||
- Character routes
|
|
||||||
- UI/presentation
|
|
||||||
- Save/load states
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Text-Based
|
|
||||||
|
|
||||||
**Tags:** text, parser, interactive-fiction, mud
|
|
||||||
|
|
||||||
Text input/output games. Parser games, choice-based IF, MUDs.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Parser or choice systems
|
|
||||||
- World model
|
|
||||||
- Narrative structure
|
|
||||||
- Text presentation
|
|
||||||
- Save state management
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Simulation & Management
|
|
||||||
|
|
||||||
#### Simulation
|
|
||||||
|
|
||||||
**Tags:** simulation, management, sandbox, systems
|
|
||||||
|
|
||||||
Realistic systems with management and building. Includes tycoons and sim games.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Core simulation loops
|
|
||||||
- Economy modeling
|
|
||||||
- AI agents/citizens
|
|
||||||
- Building/construction
|
|
||||||
- Failure states
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Sandbox
|
|
||||||
|
|
||||||
**Tags:** sandbox, creative, building, freedom
|
|
||||||
|
|
||||||
Creative freedom with building and minimal objectives.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Creation tools
|
|
||||||
- Physics/interaction systems
|
|
||||||
- Persistence and saving
|
|
||||||
- Sharing/community features
|
|
||||||
- Optional objectives
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Sports & Racing
|
|
||||||
|
|
||||||
#### Racing
|
|
||||||
|
|
||||||
**Tags:** racing, vehicles, tracks, speed
|
|
||||||
|
|
||||||
Vehicle control with tracks and lap times.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Vehicle physics model
|
|
||||||
- Track design
|
|
||||||
- AI opponents
|
|
||||||
- Progression/career mode
|
|
||||||
- Multiplayer racing
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Sports
|
|
||||||
|
|
||||||
**Tags:** sports, teams, realistic, physics
|
|
||||||
|
|
||||||
Team-based or individual sports simulation.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Sport-specific rules
|
|
||||||
- Player/team management
|
|
||||||
- AI opponent behavior
|
|
||||||
- Season/career modes
|
|
||||||
- Multiplayer modes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Multiplayer
|
|
||||||
|
|
||||||
#### MOBA
|
|
||||||
|
|
||||||
**Tags:** moba, multiplayer, pvp, heroes, lanes
|
|
||||||
|
|
||||||
Multiplayer team battles with hero selection.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Hero/champion design
|
|
||||||
- Lane and map design
|
|
||||||
- Team composition
|
|
||||||
- Matchmaking
|
|
||||||
- Economy (gold/items)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Party Game
|
|
||||||
|
|
||||||
**Tags:** party, multiplayer, minigames, casual
|
|
||||||
|
|
||||||
Local multiplayer with minigames.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Minigame design patterns
|
|
||||||
- Controller support
|
|
||||||
- Round/game structure
|
|
||||||
- Scoring systems
|
|
||||||
- Player count flexibility
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Horror & Survival
|
|
||||||
|
|
||||||
#### Survival
|
|
||||||
|
|
||||||
**Tags:** survival, crafting, resources, danger
|
|
||||||
|
|
||||||
Resource gathering with crafting and persistent threats.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Resource gathering
|
|
||||||
- Crafting systems
|
|
||||||
- Hunger/health/needs
|
|
||||||
- Threat systems
|
|
||||||
- Base building
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Horror
|
|
||||||
|
|
||||||
**Tags:** horror, atmosphere, tension, fear
|
|
||||||
|
|
||||||
Atmosphere and tension with limited resources.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Fear mechanics
|
|
||||||
- Resource scarcity
|
|
||||||
- Sound design
|
|
||||||
- Lighting and visibility
|
|
||||||
- Enemy/threat design
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Casual & Progression
|
|
||||||
|
|
||||||
#### Puzzle
|
|
||||||
|
|
||||||
**Tags:** puzzle, logic, cerebral
|
|
||||||
|
|
||||||
Logic-based challenges and problem-solving.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Puzzle mechanics
|
|
||||||
- Difficulty progression
|
|
||||||
- Hint systems
|
|
||||||
- Level structure
|
|
||||||
- Scoring/rating
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Idle/Incremental
|
|
||||||
|
|
||||||
**Tags:** idle, incremental, automation, progression
|
|
||||||
|
|
||||||
Passive progression with upgrades and automation.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Core loop design
|
|
||||||
- Prestige systems
|
|
||||||
- Automation unlocks
|
|
||||||
- Number scaling
|
|
||||||
- Offline progress
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Card Game
|
|
||||||
|
|
||||||
**Tags:** card, deck-building, strategy, turns
|
|
||||||
|
|
||||||
Deck building with card mechanics.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Card design framework
|
|
||||||
- Deck building rules
|
|
||||||
- Mana/resource systems
|
|
||||||
- Rarity and collection
|
|
||||||
- Competitive balance
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Rhythm
|
|
||||||
|
|
||||||
#### Rhythm
|
|
||||||
|
|
||||||
**Tags:** rhythm, music, timing, beats
|
|
||||||
|
|
||||||
Music synchronization with timing-based gameplay.
|
|
||||||
|
|
||||||
**GDD sections added:**
|
|
||||||
|
|
||||||
- Note/beat mapping
|
|
||||||
- Scoring systems
|
|
||||||
- Difficulty levels
|
|
||||||
- Music licensing
|
|
||||||
- Input methods
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Hybrid Game Types
|
|
||||||
|
|
||||||
Many games combine multiple genres. BMGD supports hybrid selection:
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
**Action RPG** = Action Platformer + RPG
|
|
||||||
|
|
||||||
- Movement and combat systems from Action Platformer
|
|
||||||
- Progression and stats from RPG
|
|
||||||
|
|
||||||
**Survival Horror** = Survival + Horror
|
|
||||||
|
|
||||||
- Resource and crafting from Survival
|
|
||||||
- Atmosphere and fear from Horror
|
|
||||||
|
|
||||||
**Roguelike Deckbuilder** = Roguelike + Card Game
|
|
||||||
|
|
||||||
- Run structure from Roguelike
|
|
||||||
- Card mechanics from Card Game
|
|
||||||
|
|
||||||
### How to Use Hybrids
|
|
||||||
|
|
||||||
During GDD creation, select multiple game types when prompted:
|
|
||||||
|
|
||||||
```
|
|
||||||
Agent: What game type best describes your game?
|
|
||||||
You: It's a roguelike with card game combat
|
|
||||||
Agent: I'll include sections for both Roguelike and Card Game...
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Type Selection Tips
|
|
||||||
|
|
||||||
### 1. Start with Core Fantasy
|
|
||||||
|
|
||||||
What does the player primarily DO in your game?
|
|
||||||
|
|
||||||
- Run and jump? → Platformer types
|
|
||||||
- Build and manage? → Simulation types
|
|
||||||
- Fight enemies? → Combat types
|
|
||||||
- Make choices? → Narrative types
|
|
||||||
|
|
||||||
### 2. Consider Your Loop
|
|
||||||
|
|
||||||
What's the core gameplay loop?
|
|
||||||
|
|
||||||
- Session-based runs? → Roguelike
|
|
||||||
- Long-term progression? → RPG
|
|
||||||
- Quick matches? → Multiplayer types
|
|
||||||
- Creative expression? → Sandbox
|
|
||||||
|
|
||||||
### 3. Don't Over-Combine
|
|
||||||
|
|
||||||
2-3 game types maximum. More than that usually means your design isn't focused enough.
|
|
||||||
|
|
||||||
### 4. Primary vs Secondary
|
|
||||||
|
|
||||||
One type should be primary (most gameplay time). Others add flavor:
|
|
||||||
|
|
||||||
- **Primary:** Platformer (core movement and exploration)
|
|
||||||
- **Secondary:** Metroidvania (ability gating structure)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## GDD Section Mapping
|
|
||||||
|
|
||||||
When you select a game type, BMGD adds these GDD sections:
|
|
||||||
|
|
||||||
| Game Type | Key Sections Added |
|
|
||||||
| ----------------- | -------------------------------------- |
|
|
||||||
| Action Platformer | Movement, Combat, Level Design |
|
|
||||||
| RPG | Stats, Inventory, Quests |
|
|
||||||
| Roguelike | Procedural Gen, Runs, Meta-Progression |
|
|
||||||
| Narrative | Story Structure, Dialogue, Branching |
|
|
||||||
| Multiplayer | Matchmaking, Netcode, Balance |
|
|
||||||
| Simulation | Systems, Economy, AI |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
|
|
||||||
- **[Workflows Guide](/docs/reference/workflows/bmgd-workflows.md)** - GDD workflow details
|
|
||||||
- **[Glossary](/docs/reference/glossary/index.md)** - Game development terminology
|
|
||||||
|
|
@ -1,85 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMGD - Game Development Module"
|
|
||||||
description: AI-powered workflows for game design and development with BMGD
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
**New to BMGD?** Start here:
|
|
||||||
|
|
||||||
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started building your first game
|
|
||||||
- Installation and setup
|
|
||||||
- Understanding the game development phases
|
|
||||||
- Running your first workflows
|
|
||||||
- Agent-based development flow
|
|
||||||
|
|
||||||
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Documentation
|
|
||||||
|
|
||||||
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types)
|
|
||||||
- **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Game Development Phases
|
|
||||||
|
|
||||||
BMGD follows four phases aligned with game development:
|
|
||||||
|
|
||||||
### Phase 1: Preproduction
|
|
||||||
- **Brainstorm Game** - Ideation with game-specific techniques
|
|
||||||
- **Game Brief** - Capture vision, market, and fundamentals
|
|
||||||
|
|
||||||
### Phase 2: Design
|
|
||||||
- **GDD (Game Design Document)** - Comprehensive game design
|
|
||||||
- **Narrative Design** - Story, characters, world (for story-driven games)
|
|
||||||
|
|
||||||
### Phase 3: Technical
|
|
||||||
- **Game Architecture** - Engine, systems, patterns, structure
|
|
||||||
|
|
||||||
### Phase 4: Production
|
|
||||||
- **Sprint Planning** - Epic and story management
|
|
||||||
- **Story Development** - Implementation workflow
|
|
||||||
- **Code Review** - Quality assurance
|
|
||||||
- **Testing** - Automated tests, playtesting, performance
|
|
||||||
- **Retrospective** - Continuous improvement
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Choose Your Path
|
|
||||||
|
|
||||||
### I need to...
|
|
||||||
|
|
||||||
**Start a new game project**
|
|
||||||
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)
|
|
||||||
→ Run `brainstorm-game` for ideation
|
|
||||||
→ Create a Game Brief with `create-brief`
|
|
||||||
|
|
||||||
**Design my game**
|
|
||||||
→ Create a GDD with `create-gdd`
|
|
||||||
→ If story-heavy, add Narrative Design with `create-narrative`
|
|
||||||
|
|
||||||
**Plan the technical architecture**
|
|
||||||
→ Run `create-architecture` with the Game Architect
|
|
||||||
|
|
||||||
**Build my game**
|
|
||||||
→ Use Phase 4 production workflows
|
|
||||||
→ Follow the sprint-based development cycle
|
|
||||||
|
|
||||||
**Quickly test an idea**
|
|
||||||
→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game type templates
|
|
||||||
- [BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md) - Comparison with core method
|
|
||||||
- [Glossary](/docs/reference/glossary/index.md) - Terminology reference
|
|
||||||
|
|
@ -0,0 +1,57 @@
|
||||||
|
---
|
||||||
|
title: "Party Mode"
|
||||||
|
description: Multi-agent collaboration - get all your AI agents in one conversation
|
||||||
|
---
|
||||||
|
|
||||||
|
Get all your AI agents in one conversation.
|
||||||
|
|
||||||
|
## What is Party Mode?
|
||||||
|
|
||||||
|
Run `party-mode` and you've got your whole AI team in one room - PM, Architect, Dev, UX Designer, whoever you need. BMad Master orchestrates, picking relevant agents per message. Agents respond in character, agree, disagree, and build on each other's ideas.
|
||||||
|
|
||||||
|
The conversation continues as long as you want. Ask follow-ups, push back on answers, redirect the discussion - it's a real back-and-forth with your agents until you're done.
|
||||||
|
|
||||||
|
**Good for:**
|
||||||
|
|
||||||
|
- Big decisions with tradeoffs
|
||||||
|
- Brainstorming sessions
|
||||||
|
- Post-mortems when things go wrong
|
||||||
|
- Sprint retrospectives and planning
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Calling Out Bad Architecture
|
||||||
|
|
||||||
|
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
||||||
|
|
||||||
|
**Architect:** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
||||||
|
|
||||||
|
**Dev:** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
||||||
|
|
||||||
|
**PM:** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
||||||
|
|
||||||
|
**TEA:** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
||||||
|
|
||||||
|
### Creative Brainstorming
|
||||||
|
|
||||||
|
**You:** "How do we make onboarding feel magical instead of boring?"
|
||||||
|
|
||||||
|
**UX Designer:** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
||||||
|
|
||||||
|
**Storyteller:** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
||||||
|
|
||||||
|
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
||||||
|
|
||||||
|
### Technical Decision
|
||||||
|
|
||||||
|
**You:** "Monolith or microservices for MVP?"
|
||||||
|
|
||||||
|
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
||||||
|
|
||||||
|
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
||||||
|
|
||||||
|
**Dev:** "Monolith with clear module boundaries. We can extract services later if needed."
|
||||||
|
|
||||||
|
:::tip[Better Decisions]
|
||||||
|
Better decisions through diverse perspectives. Welcome to party mode.
|
||||||
|
:::
|
||||||
|
|
@ -1,121 +0,0 @@
|
||||||
---
|
|
||||||
title: "Facilitation Over Generation"
|
|
||||||
description: Understanding CIS's facilitation-first approach to creative work
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Problem with Generation
|
|
||||||
|
|
||||||
Traditional AI approaches to creative work:
|
|
||||||
|
|
||||||
```
|
|
||||||
User: "Give me marketing ideas"
|
|
||||||
AI: "Here are 10 marketing ideas..."
|
|
||||||
```
|
|
||||||
|
|
||||||
This approach:
|
|
||||||
- Produces generic, predictable outputs
|
|
||||||
- Removes human ownership of ideas
|
|
||||||
- Misses context and nuance
|
|
||||||
- Limits creative exploration
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Facilitation Approach
|
|
||||||
|
|
||||||
CIS agents use strategic questioning:
|
|
||||||
|
|
||||||
```
|
|
||||||
User: "I need marketing ideas"
|
|
||||||
CIS: "What makes your customers choose you over alternatives?
|
|
||||||
What's the one thing they always mention?"
|
|
||||||
User: "They say our support is exceptional"
|
|
||||||
CIS: "Interesting! How might you make that exceptional
|
|
||||||
support visible before they become customers?"
|
|
||||||
```
|
|
||||||
|
|
||||||
This approach:
|
|
||||||
- Draws out insights already within you
|
|
||||||
- Maintains human ownership of ideas
|
|
||||||
- Captures context and nuance
|
|
||||||
- Enables deeper creative exploration
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principles
|
|
||||||
|
|
||||||
### 1. Questions Over Answers
|
|
||||||
|
|
||||||
CIS agents ask strategic questions rather than providing direct answers. This:
|
|
||||||
- Activates your own creative thinking
|
|
||||||
- Uncovers assumptions
|
|
||||||
- Reveals blind spots
|
|
||||||
- Builds on your domain knowledge
|
|
||||||
|
|
||||||
### 2. Energy-Aware Sessions
|
|
||||||
|
|
||||||
CIS monitors engagement and adapts:
|
|
||||||
- Adjusts pace when energy flags
|
|
||||||
- Suggests breaks when needed
|
|
||||||
- Changes techniques to maintain momentum
|
|
||||||
- Recognizes productive vs. unproductive struggle
|
|
||||||
|
|
||||||
### 3. Process Trust
|
|
||||||
|
|
||||||
CIS uses proven methodologies:
|
|
||||||
- Design Thinking's 5 phases
|
|
||||||
- Structured brainstorming techniques
|
|
||||||
- Root cause analysis frameworks
|
|
||||||
- Innovation strategy patterns
|
|
||||||
|
|
||||||
You're not just having a conversation—you're following time-tested creative processes.
|
|
||||||
|
|
||||||
### 4. Persona-Driven Engagement
|
|
||||||
|
|
||||||
Each CIS agent has a distinct personality:
|
|
||||||
- **Carson** - Energetic, encouraging
|
|
||||||
- **Maya** - Jazz-like, improvisational
|
|
||||||
- **Dr. Quinn** - Analytical, methodical
|
|
||||||
- **Victor** - Bold, strategic
|
|
||||||
- **Sophia** - Narrative, imaginative
|
|
||||||
|
|
||||||
These personas create engaging experiences that maintain creative flow.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When Generation is Appropriate
|
|
||||||
|
|
||||||
CIS does generate when appropriate:
|
|
||||||
- Synthesizing session outputs
|
|
||||||
- Documenting decisions
|
|
||||||
- Creating structured artifacts
|
|
||||||
- Providing technique examples
|
|
||||||
|
|
||||||
But the core creative work happens through facilitated discovery.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Benefits
|
|
||||||
|
|
||||||
### For Individuals
|
|
||||||
- Deeper insights than pure generation
|
|
||||||
- Ownership of creative outputs
|
|
||||||
- Skill development in creative thinking
|
|
||||||
- More memorable and actionable ideas
|
|
||||||
|
|
||||||
### For Teams
|
|
||||||
- Shared creative experience
|
|
||||||
- Aligned understanding
|
|
||||||
- Documented rationale
|
|
||||||
- Stronger buy-in to outcomes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Creative Intelligence Suite](/docs/explanation/creative-intelligence/index.md) - CIS overview
|
|
||||||
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Available techniques
|
|
||||||
|
|
@ -1,119 +0,0 @@
|
||||||
---
|
|
||||||
title: "AI-Generated Testing: Why Most Approaches Fail"
|
|
||||||
description: How Playwright-Utils, TEA workflows, and Playwright MCPs solve AI test quality problems
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
AI-generated tests frequently fail in production because they lack systematic quality standards. This document explains the problem and presents a solution combining three components: Playwright-Utils, TEA (Test Architect), and Playwright MCPs.
|
|
||||||
|
|
||||||
:::note[Source]
|
|
||||||
This article is adapted from [The Testing Meta Most Teams Have Not Caught Up To Yet](https://dev.to/muratkeremozcan/the-testing-meta-most-teams-have-not-caught-up-to-yet-5765) by Murat K Ozcan.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## The Problem with AI-Generated Tests
|
|
||||||
|
|
||||||
When teams use AI to generate tests without structure, they often produce what can be called "slop factory" outputs:
|
|
||||||
|
|
||||||
| Issue | Description |
|
|
||||||
|-------|-------------|
|
|
||||||
| Redundant coverage | Multiple tests covering the same functionality |
|
|
||||||
| Incorrect assertions | Tests that pass but don't actually verify behavior |
|
|
||||||
| Flaky tests | Non-deterministic tests that randomly pass or fail |
|
|
||||||
| Unreviewable diffs | Generated code too verbose or inconsistent to review |
|
|
||||||
|
|
||||||
The core problem is that prompt-driven testing paths lean into nondeterminism, which is the exact opposite of what testing exists to protect.
|
|
||||||
|
|
||||||
:::caution[The Paradox]
|
|
||||||
AI excels at generating code quickly, but testing requires precision and consistency. Without guardrails, AI-generated tests amplify the chaos they're meant to prevent.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## The Solution: A Three-Part Stack
|
|
||||||
|
|
||||||
The solution combines three components that work together to enforce quality:
|
|
||||||
|
|
||||||
### Playwright-Utils
|
|
||||||
|
|
||||||
Bridges the gap between Cypress ergonomics and Playwright's capabilities by standardizing commonly reinvented primitives through utility functions.
|
|
||||||
|
|
||||||
| Utility | Purpose |
|
|
||||||
|---------|---------|
|
|
||||||
| api-request | API calls with schema validation |
|
|
||||||
| auth-session | Authentication handling |
|
|
||||||
| intercept-network-call | Network mocking and interception |
|
|
||||||
| recurse | Retry logic and polling |
|
|
||||||
| log | Structured logging |
|
|
||||||
| network-recorder | Record and replay network traffic |
|
|
||||||
| burn-in | Smart test selection for CI |
|
|
||||||
| network-error-monitor | HTTP error detection |
|
|
||||||
| file-utils | CSV/PDF handling |
|
|
||||||
|
|
||||||
These utilities eliminate the need to reinvent authentication, API calls, retries, and logging for every project.
|
|
||||||
|
|
||||||
### TEA (Test Architect Agent)
|
|
||||||
|
|
||||||
A quality operating model packaged as eight executable workflows spanning test design, CI/CD gates, and release readiness. TEA encodes test architecture expertise into repeatable processes.
|
|
||||||
|
|
||||||
| Workflow | Purpose |
|
|
||||||
|----------|---------|
|
|
||||||
| `*test-design` | Risk-based test planning per epic |
|
|
||||||
| `*framework` | Scaffold production-ready test infrastructure |
|
|
||||||
| `*ci` | CI pipeline with selective testing |
|
|
||||||
| `*atdd` | Acceptance test-driven development |
|
|
||||||
| `*automate` | Prioritized test automation |
|
|
||||||
| `*test-review` | Test quality audits (0-100 score) |
|
|
||||||
| `*nfr-assess` | Non-functional requirements assessment |
|
|
||||||
| `*trace` | Coverage traceability and gate decisions |
|
|
||||||
|
|
||||||
:::tip[Key Insight]
|
|
||||||
TEA doesn't just generate tests—it provides a complete quality operating model with workflows for planning, execution, and release gates.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Playwright MCPs
|
|
||||||
|
|
||||||
Model Context Protocols enable real-time verification during test generation. Instead of inferring selectors and behavior from documentation, MCPs allow agents to:
|
|
||||||
|
|
||||||
- Run flows and confirm the DOM against the accessibility tree
|
|
||||||
- Validate network responses in real-time
|
|
||||||
- Discover actual functionality through interactive exploration
|
|
||||||
- Verify generated tests against live applications
|
|
||||||
|
|
||||||
## How They Work Together
|
|
||||||
|
|
||||||
The three components form a quality pipeline:
|
|
||||||
|
|
||||||
| Stage | Component | Action |
|
|
||||||
|-------|-----------|--------|
|
|
||||||
| Standards | Playwright-Utils | Provides production-ready patterns and utilities |
|
|
||||||
| Process | TEA Workflows | Enforces systematic test planning and review |
|
|
||||||
| Verification | Playwright MCPs | Validates generated tests against live applications |
|
|
||||||
|
|
||||||
**Before (AI-only):** 20 tests with redundant coverage, incorrect assertions, and flaky behavior.
|
|
||||||
|
|
||||||
**After (Full Stack):** Risk-based selection, verified selectors, validated behavior, reviewable code.
|
|
||||||
|
|
||||||
## Why This Matters
|
|
||||||
|
|
||||||
Traditional AI testing approaches fail because they:
|
|
||||||
|
|
||||||
- **Lack quality standards** — No consistent patterns or utilities
|
|
||||||
- **Skip planning** — Jump straight to test generation without risk assessment
|
|
||||||
- **Can't verify** — Generate tests without validating against actual behavior
|
|
||||||
- **Don't review** — No systematic audit of generated test quality
|
|
||||||
|
|
||||||
The three-part stack addresses each gap:
|
|
||||||
|
|
||||||
| Gap | Solution |
|
|
||||||
|-----|----------|
|
|
||||||
| No standards | Playwright-Utils provides production-ready patterns |
|
|
||||||
| No planning | TEA `*test-design` workflow creates risk-based test plans |
|
|
||||||
| No verification | Playwright MCPs validate against live applications |
|
|
||||||
| No review | TEA `*test-review` audits quality with scoring |
|
|
||||||
|
|
||||||
This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session.
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [TEA Overview](/docs/explanation/features/tea-overview.md) — Workflow details and cheat sheets
|
|
||||||
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) — Implementation guide
|
|
||||||
- [The Testing Meta Most Teams Have Not Caught Up To Yet](https://dev.to/muratkeremozcan/the-testing-meta-most-teams-have-not-caught-up-to-yet-5765) — Original article by Murat K Ozcan
|
|
||||||
- [Playwright-Utils Repository](https://github.com/seontechnologies/playwright-utils) — Source and documentation
|
|
||||||
|
|
@ -3,11 +3,8 @@ title: "Preventing Agent Conflicts"
|
||||||
description: How architecture prevents conflicts when multiple agents implement a system
|
description: How architecture prevents conflicts when multiple agents implement a system
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Conflict Types
|
## Common Conflict Types
|
||||||
|
|
||||||
### API Style Conflicts
|
### API Style Conflicts
|
||||||
|
|
@ -43,8 +40,6 @@ With architecture:
|
||||||
- ADR specifies state management approach
|
- ADR specifies state management approach
|
||||||
- All agents implement consistently
|
- All agents implement consistently
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## How Architecture Prevents Conflicts
|
## How Architecture Prevents Conflicts
|
||||||
|
|
||||||
### 1. Explicit Decisions via ADRs
|
### 1. Explicit Decisions via ADRs
|
||||||
|
|
@ -70,8 +65,6 @@ Explicit documentation of:
|
||||||
- Code organization
|
- Code organization
|
||||||
- Testing patterns
|
- Testing patterns
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture as Shared Context
|
## Architecture as Shared Context
|
||||||
|
|
||||||
Think of architecture as the shared context that all agents read before implementing:
|
Think of architecture as the shared context that all agents read before implementing:
|
||||||
|
|
@ -88,14 +81,12 @@ Agent C reads architecture → implements Epic 3
|
||||||
Result: Consistent implementation
|
Result: Consistent implementation
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key ADR Topics
|
## Key ADR Topics
|
||||||
|
|
||||||
Common decisions that prevent conflicts:
|
Common decisions that prevent conflicts:
|
||||||
|
|
||||||
| Topic | Example Decision |
|
| Topic | Example Decision |
|
||||||
|-------|-----------------|
|
| ---------------- | -------------------------------------------- |
|
||||||
| API Style | GraphQL vs REST vs gRPC |
|
| API Style | GraphQL vs REST vs gRPC |
|
||||||
| Database | PostgreSQL vs MongoDB |
|
| Database | PostgreSQL vs MongoDB |
|
||||||
| Auth | JWT vs Sessions |
|
| Auth | JWT vs Sessions |
|
||||||
|
|
@ -103,36 +94,17 @@ Common decisions that prevent conflicts:
|
||||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||||
| Testing | Jest + Playwright vs Vitest + Cypress |
|
| Testing | Jest + Playwright vs Vitest + Cypress |
|
||||||
|
|
||||||
---
|
## Anti-Patterns to Avoid
|
||||||
|
|
||||||
## Anti-Patterns
|
:::caution[Common Mistakes]
|
||||||
|
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
|
||||||
### ❌ Implicit Decisions
|
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
|
||||||
|
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
|
||||||
"We'll figure out the API style as we go"
|
:::
|
||||||
→ Leads to inconsistency
|
|
||||||
|
|
||||||
### ❌ Over-Documentation
|
|
||||||
|
|
||||||
Every minor choice documented
|
|
||||||
→ Analysis paralysis, wasted time
|
|
||||||
|
|
||||||
### ❌ Stale Architecture
|
|
||||||
|
|
||||||
Document written once, never updated
|
|
||||||
→ Agents follow outdated patterns
|
|
||||||
|
|
||||||
### ✅ Correct Approach
|
|
||||||
|
|
||||||
|
:::tip[Correct Approach]
|
||||||
- Document decisions that cross epic boundaries
|
- Document decisions that cross epic boundaries
|
||||||
- Focus on conflict-prone areas
|
- Focus on conflict-prone areas
|
||||||
- Update architecture as you learn
|
- Update architecture as you learn
|
||||||
- Use `correct-course` for significant changes
|
- Use `correct-course` for significant changes
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md)
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md)
|
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
---
|
||||||
|
title: "Quick Flow"
|
||||||
|
description: Fast-track for small changes - skip the full methodology
|
||||||
|
---
|
||||||
|
|
||||||
|
Quick Flow is for when you don't need the full BMad Method. Skip Product Brief, PRD, and Architecture - go straight to implementation.
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
1. **Run `quick-spec`** — generates a focused tech-spec
|
||||||
|
2. **Run `quick-dev`** — implements it
|
||||||
|
|
||||||
|
That's it.
|
||||||
|
|
||||||
|
## When to Use It
|
||||||
|
|
||||||
|
- Bug fixes
|
||||||
|
- Refactoring
|
||||||
|
- Small features
|
||||||
|
- Prototyping
|
||||||
|
|
||||||
|
## When to Use Full BMad Method Instead
|
||||||
|
|
||||||
|
- New products
|
||||||
|
- Major features
|
||||||
|
- Multiple teams involved
|
||||||
|
- Stakeholder alignment needed
|
||||||
|
|
@ -6,8 +6,6 @@ description: Understanding why the solutioning phase is critical for multi-epic
|
||||||
|
|
||||||
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Problem Without Solutioning
|
## The Problem Without Solutioning
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -18,8 +16,6 @@ Result: Inconsistent API design, integration nightmare
|
||||||
|
|
||||||
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## The Solution With Solutioning
|
## The Solution With Solutioning
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -30,8 +26,6 @@ Result: Consistent implementation, no conflicts
|
||||||
|
|
||||||
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Solutioning vs Planning
|
## Solutioning vs Planning
|
||||||
|
|
||||||
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
||||||
|
|
@ -43,8 +37,6 @@ By documenting technical decisions explicitly, all agents implement consistently
|
||||||
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
||||||
| Level | Business logic | Technical design + Work breakdown |
|
| Level | Business logic | Technical design + Work breakdown |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Principle
|
## Key Principle
|
||||||
|
|
||||||
**Make technical decisions explicit and documented** so all agents implement consistently.
|
**Make technical decisions explicit and documented** so all agents implement consistently.
|
||||||
|
|
@ -56,8 +48,6 @@ This prevents:
|
||||||
- Naming convention mismatches
|
- Naming convention mismatches
|
||||||
- Security approach variations
|
- Security approach variations
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When Solutioning is Required
|
## When Solutioning is Required
|
||||||
|
|
||||||
| Track | Solutioning Required? |
|
| Track | Solutioning Required? |
|
||||||
|
|
@ -67,9 +57,9 @@ This prevents:
|
||||||
| BMad Method Complex | Yes |
|
| BMad Method Complex | Yes |
|
||||||
| Enterprise | Yes |
|
| Enterprise | Yes |
|
||||||
|
|
||||||
**Rule of thumb:** If you have multiple epics that could be implemented by different agents, you need solutioning.
|
:::tip[Rule of Thumb]
|
||||||
|
If you have multiple epics that could be implemented by different agents, you need solutioning.
|
||||||
---
|
:::
|
||||||
|
|
||||||
## The Cost of Skipping
|
## The Cost of Skipping
|
||||||
|
|
||||||
|
|
@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
|
||||||
- **Longer development time** overall
|
- **Longer development time** overall
|
||||||
- **Technical debt** from inconsistent patterns
|
- **Technical debt** from inconsistent patterns
|
||||||
|
|
||||||
|
:::caution[Cost Multiplier]
|
||||||
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Overview of all phases
|
|
||||||
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md) - Detailed conflict prevention
|
|
||||||
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - How to do it
|
|
||||||
|
|
@ -1,91 +0,0 @@
|
||||||
---
|
|
||||||
title: "How to Add a Feature to an Existing Project"
|
|
||||||
description: How to add new features to an existing brownfield project
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
|
||||||
|
|
||||||
- Adding a new feature to an existing codebase
|
|
||||||
- Major enhancements that need proper planning
|
|
||||||
- Features that touch multiple parts of the system
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed
|
|
||||||
- Existing project documentation (run `document-project` first if needed)
|
|
||||||
- Clear understanding of what you want to build
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
|
||||||
|
|
||||||
### 1. Run workflow-init
|
|
||||||
|
|
||||||
```
|
|
||||||
Run workflow-init
|
|
||||||
```
|
|
||||||
|
|
||||||
The workflow should recognize you're in an existing project. If not, explicitly clarify that this is brownfield development.
|
|
||||||
|
|
||||||
### 2. Choose Your Approach
|
|
||||||
|
|
||||||
| Feature Scope | Recommended Approach |
|
|
||||||
|---------------|---------------------|
|
|
||||||
| Small (1-5 stories) | Quick Flow with tech-spec |
|
|
||||||
| Medium (5-15 stories) | BMad Method with PRD |
|
|
||||||
| Large (15+ stories) | Full BMad Method with architecture |
|
|
||||||
|
|
||||||
### 3. Create Planning Documents
|
|
||||||
|
|
||||||
**For Quick Flow:**
|
|
||||||
- Load PM agent
|
|
||||||
- Run tech-spec workflow
|
|
||||||
- The agent will analyze your existing codebase and create a context-aware spec
|
|
||||||
|
|
||||||
**For BMad Method:**
|
|
||||||
- Load PM agent
|
|
||||||
- Run PRD workflow
|
|
||||||
- Ensure the agent reads your existing documentation
|
|
||||||
- Review that integration points are clearly identified
|
|
||||||
|
|
||||||
### 4. Consider Architecture Impact
|
|
||||||
|
|
||||||
If your feature affects system architecture:
|
|
||||||
|
|
||||||
- Load Architect agent
|
|
||||||
- Run architecture workflow
|
|
||||||
- Ensure alignment with existing patterns
|
|
||||||
- Document any new ADRs (Architecture Decision Records)
|
|
||||||
|
|
||||||
### 5. Implement
|
|
||||||
|
|
||||||
Follow the standard Phase 4 implementation workflows:
|
|
||||||
|
|
||||||
1. `sprint-planning` - Organize your work
|
|
||||||
2. `create-story` - Prepare each story
|
|
||||||
3. `dev-story` - Implement with tests
|
|
||||||
4. `code-review` - Quality assurance
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- Always ensure agents read your existing documentation
|
|
||||||
- Pay attention to integration points with existing code
|
|
||||||
- Follow existing conventions unless deliberately changing them
|
|
||||||
- Document why you're adding new patterns (if any)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)
|
|
||||||
- [Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)
|
|
||||||
|
|
@ -1,84 +0,0 @@
|
||||||
---
|
|
||||||
title: "How to Document an Existing Project"
|
|
||||||
description: How to document an existing brownfield codebase using BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
|
||||||
|
|
||||||
- Starting work on an undocumented legacy project
|
|
||||||
- Documentation is outdated and needs refresh
|
|
||||||
- AI agents need context about existing code patterns
|
|
||||||
- Onboarding new team members
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- BMad Method installed in your project
|
|
||||||
- Access to the codebase you want to document
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
|
||||||
|
|
||||||
### 1. Load the Analyst Agent
|
|
||||||
|
|
||||||
Start a fresh chat and load the Analyst agent.
|
|
||||||
|
|
||||||
### 2. Run the document-project Workflow
|
|
||||||
|
|
||||||
Tell the agent:
|
|
||||||
|
|
||||||
```
|
|
||||||
Run the document-project workflow
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Let the Agent Scan Your Codebase
|
|
||||||
|
|
||||||
The workflow will:
|
|
||||||
|
|
||||||
- Scan your codebase structure
|
|
||||||
- Identify architecture patterns
|
|
||||||
- Document the technology stack
|
|
||||||
- Create reference documentation
|
|
||||||
- Generate a PRD-like document from existing code
|
|
||||||
|
|
||||||
### 4. Review the Generated Documentation
|
|
||||||
|
|
||||||
The output will be saved to `project-documentation-{date}.md` in your output folder.
|
|
||||||
|
|
||||||
Review the documentation for:
|
|
||||||
|
|
||||||
- Accuracy of detected patterns
|
|
||||||
- Completeness of architecture description
|
|
||||||
- Any missing business rules or intent
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## What You Get
|
|
||||||
|
|
||||||
- **Project overview** - High-level description of what the project does
|
|
||||||
- **Technology stack** - Detected frameworks, libraries, and tools
|
|
||||||
- **Architecture patterns** - Code organization and design patterns found
|
|
||||||
- **Business rules** - Logic extracted from the codebase
|
|
||||||
- **Integration points** - External APIs and services
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- Run this before any major brownfield work
|
|
||||||
- Keep the documentation updated as the project evolves
|
|
||||||
- Use it as input for future PRD creation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)
|
|
||||||
|
|
@ -3,24 +3,19 @@ title: "Brownfield Development"
|
||||||
description: How to use BMad Method on existing codebases
|
description: How to use BMad Method on existing codebases
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use BMad Method effectively when working on existing projects and legacy codebases.
|
||||||
How to effectively use BMad Method when working on existing projects and legacy codebases.
|
|
||||||
|
|
||||||
## What is Brownfield Development?
|
## What is Brownfield Development?
|
||||||
|
|
||||||
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
||||||
|
|
||||||
This tutorial covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
- BMad Method installed (`npx bmad-method install`)
|
- BMad Method installed (`npx bmad-method install`)
|
||||||
- An existing codebase you want to work on
|
- An existing codebase you want to work on
|
||||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
||||||
|
:::
|
||||||
---
|
|
||||||
|
|
||||||
## Step 1: Clean Up Completed Planning Artifacts
|
## Step 1: Clean Up Completed Planning Artifacts
|
||||||
|
|
||||||
|
|
@ -30,8 +25,6 @@ If you have completed all PRD epics and stories through the BMad process, clean
|
||||||
- `_bmad-output/planning-artifacts/`
|
- `_bmad-output/planning-artifacts/`
|
||||||
- `_bmad-output/implementation-artifacts/`
|
- `_bmad-output/implementation-artifacts/`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Step 2: Maintain Quality Project Documentation
|
## Step 2: Maintain Quality Project Documentation
|
||||||
|
|
||||||
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
||||||
|
|
@ -43,11 +36,11 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
||||||
|
|
||||||
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
||||||
|
|
||||||
---
|
## Step 3: Get Help
|
||||||
|
|
||||||
## Step 3: Initialize for Brownfield Work
|
Get help to know what to do next based on your unique needs
|
||||||
|
|
||||||
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
|
Run `bmad-help` to get guidance when you are not sure what to do next.
|
||||||
|
|
||||||
### Choosing Your Approach
|
### Choosing Your Approach
|
||||||
|
|
||||||
|
|
@ -85,18 +78,7 @@ When doing architecture, ensure the architect:
|
||||||
|
|
||||||
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
|
||||||
|
|
||||||
---
|
## More Information
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
|
|
||||||
- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
|
|
||||||
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||||
- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
|
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Documentation
|
|
||||||
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md) - Fast path for small changes
|
|
||||||
|
|
|
||||||
|
|
@ -3,20 +3,14 @@ title: "How to Make Quick Fixes in Brownfield Projects"
|
||||||
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
description: How to make quick fixes and ad-hoc changes in brownfield projects
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
|
||||||
Not everything requires the full BMad method or even Quick Flow. For bug fixes, refactorings, or small targeted changes, you can work directly with the agent.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- Bug fixes
|
- Simple bug fixes
|
||||||
- Small refactorings
|
- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts
|
||||||
- Targeted code improvements
|
- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow
|
||||||
- Learning about your codebase
|
- Learning about your codebase
|
||||||
- One-off changes that don't need planning
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
## Steps
|
||||||
|
|
||||||
|
|
@ -25,7 +19,7 @@ Not everything requires the full BMad method or even Quick Flow. For bug fixes,
|
||||||
For quick fixes, you can use:
|
For quick fixes, you can use:
|
||||||
|
|
||||||
- **DEV agent** - For implementation-focused work
|
- **DEV agent** - For implementation-focused work
|
||||||
- **Quick Flow Solo Dev** - For slightly larger changes that still need a tech-spec
|
- **Quick Flow Solo Dev** - For slightly larger changes that still need a quick-spec to keep the agent aligned to planning and standards
|
||||||
|
|
||||||
### 2. Describe the Change
|
### 2. Describe the Change
|
||||||
|
|
||||||
|
|
@ -54,8 +48,6 @@ The agent will:
|
||||||
|
|
||||||
Review the changes made and commit when satisfied.
|
Review the changes made and commit when satisfied.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Learning Your Codebase
|
## Learning Your Codebase
|
||||||
|
|
||||||
This approach is also excellent for exploring unfamiliar code:
|
This approach is also excellent for exploring unfamiliar code:
|
||||||
|
|
@ -68,14 +60,12 @@ Explain how the authentication system works in this codebase
|
||||||
Show me where error handling happens in the API layer
|
Show me where error handling happens in the API layer
|
||||||
```
|
```
|
||||||
|
|
||||||
LLMs are excellent at interpreting and analyzing code—whether it was AI-generated or not. Use the agent to:
|
LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to:
|
||||||
|
|
||||||
- Learn about your project
|
- Learn about your project
|
||||||
- Understand how things are built
|
- Understand how things are built
|
||||||
- Explore unfamiliar parts of the codebase
|
- Explore unfamiliar parts of the codebase
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## When to Upgrade to Formal Planning
|
## When to Upgrade to Formal Planning
|
||||||
|
|
||||||
Consider using Quick Flow or full BMad Method when:
|
Consider using Quick Flow or full BMad Method when:
|
||||||
|
|
@ -84,11 +74,3 @@ Consider using Quick Flow or full BMad Method when:
|
||||||
- You're unsure about the scope
|
- You're unsure about the scope
|
||||||
- The fix keeps growing in complexity
|
- The fix keeps growing in complexity
|
||||||
- You need documentation for the change
|
- You need documentation for the change
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
||||||
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)
|
|
||||||
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md)
|
|
||||||
|
|
|
||||||
|
|
@ -1,208 +0,0 @@
|
||||||
---
|
|
||||||
title: "Agent Customization Guide"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Customize BMad agents without modifying core files. All customizations persist through updates.
|
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
**1. Locate Customization Files**
|
|
||||||
|
|
||||||
After installation, find agent customization files in:
|
|
||||||
|
|
||||||
```
|
|
||||||
_bmad/_config/agents/
|
|
||||||
├── core-bmad-master.customize.yaml
|
|
||||||
├── bmm-dev.customize.yaml
|
|
||||||
├── bmm-pm.customize.yaml
|
|
||||||
└── ... (one file per installed agent)
|
|
||||||
```
|
|
||||||
|
|
||||||
**2. Edit Any Agent**
|
|
||||||
|
|
||||||
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
|
||||||
|
|
||||||
**3. Rebuild the Agent**
|
|
||||||
|
|
||||||
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method@alpha install # and then select option to compile all agents
|
|
||||||
npx bmad-method@alpha build <agent-name>
|
|
||||||
|
|
||||||
npx bmad-method@alpha build bmm-dev
|
|
||||||
npx bmad-method@alpha build core-bmad-master
|
|
||||||
npx bmad-method@alpha build bmm-pm
|
|
||||||
```
|
|
||||||
|
|
||||||
## What You Can Customize
|
|
||||||
|
|
||||||
### Agent Name
|
|
||||||
|
|
||||||
Change how the agent introduces itself:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
agent:
|
|
||||||
metadata:
|
|
||||||
name: 'Spongebob' # Default: "Amelia"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Persona
|
|
||||||
|
|
||||||
Replace the agent's personality, role, and communication style:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
persona:
|
|
||||||
role: 'Senior Full-Stack Engineer'
|
|
||||||
identity: 'Lives in a pineapple (under the sea)'
|
|
||||||
communication_style: 'Spongebob'
|
|
||||||
principles:
|
|
||||||
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
|
||||||
- 'Favor composition over inheritance'
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** The persona section replaces the entire default persona (not merged).
|
|
||||||
|
|
||||||
### Memories
|
|
||||||
|
|
||||||
Add persistent context the agent will always remember:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
memories:
|
|
||||||
- 'Works at Krusty Krab'
|
|
||||||
- 'Favorite Celebrity: David Hasslehoff'
|
|
||||||
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
|
|
||||||
```
|
|
||||||
|
|
||||||
### Custom Menu Items
|
|
||||||
|
|
||||||
Add your own workflows to the agent's menu:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
menu:
|
|
||||||
- trigger: my-workflow
|
|
||||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
|
||||||
description: My custom workflow
|
|
||||||
- trigger: deploy
|
|
||||||
action: '#deploy-prompt'
|
|
||||||
description: Deploy to production
|
|
||||||
```
|
|
||||||
|
|
||||||
**Don't include:** `*` prefix or `help`/`exit` items - these are auto-injected.
|
|
||||||
|
|
||||||
### Critical Actions
|
|
||||||
|
|
||||||
Add instructions that execute before the agent starts:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
critical_actions:
|
|
||||||
- 'Always check git status before making changes'
|
|
||||||
- 'Use conventional commit messages'
|
|
||||||
```
|
|
||||||
|
|
||||||
### Custom Prompts
|
|
||||||
|
|
||||||
Define reusable prompts for `action="#id"` menu handlers:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
prompts:
|
|
||||||
- id: deploy-prompt
|
|
||||||
content: |
|
|
||||||
Deploy the current branch to production:
|
|
||||||
1. Run all tests
|
|
||||||
2. Build the project
|
|
||||||
3. Execute deployment script
|
|
||||||
```
|
|
||||||
|
|
||||||
## Real-World Examples
|
|
||||||
|
|
||||||
**Example 1: Customize Developer Agent for TDD**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
agent:
|
|
||||||
metadata:
|
|
||||||
name: 'TDD Developer'
|
|
||||||
|
|
||||||
memories:
|
|
||||||
- 'Always write tests before implementation'
|
|
||||||
- 'Project uses Jest and React Testing Library'
|
|
||||||
|
|
||||||
critical_actions:
|
|
||||||
- 'Review test coverage before committing'
|
|
||||||
```
|
|
||||||
|
|
||||||
**Example 2: Add Custom Deployment Workflow**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
menu:
|
|
||||||
- trigger: deploy-staging
|
|
||||||
workflow: '{project-root}/_bmad/deploy-staging.yaml'
|
|
||||||
description: Deploy to staging environment
|
|
||||||
- trigger: deploy-prod
|
|
||||||
workflow: '{project-root}/_bmad/deploy-prod.yaml'
|
|
||||||
description: Deploy to production (with approval)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Example 3: Multilingual Product Manager**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
persona:
|
|
||||||
role: 'Bilingual Product Manager'
|
|
||||||
identity: 'Expert in US and LATAM markets'
|
|
||||||
communication_style: 'Clear, strategic, with cultural awareness'
|
|
||||||
principles:
|
|
||||||
- 'Consider localization from day one'
|
|
||||||
- 'Balance business goals with user needs'
|
|
||||||
|
|
||||||
memories:
|
|
||||||
- 'User speaks English and Spanish'
|
|
||||||
- 'Target markets: US and Latin America'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
- **Start Small:** Customize one section at a time and rebuild to test
|
|
||||||
- **Backup:** Copy customization files before major changes
|
|
||||||
- **Update-Safe:** Your customizations in `_config/` survive all BMad updates
|
|
||||||
- **Per-Project:** Customization files are per-project, not global
|
|
||||||
- **Version Control:** Consider committing `_config/` to share customizations with your team
|
|
||||||
|
|
||||||
## Module vs. Global Config
|
|
||||||
|
|
||||||
**Module-Level (Recommended):**
|
|
||||||
|
|
||||||
- Customize agents per-project in `_bmad/_config/agents/`
|
|
||||||
- Different projects can have different agent behaviors
|
|
||||||
|
|
||||||
**Global Config (Coming Soon):**
|
|
||||||
|
|
||||||
- Set defaults that apply across all projects
|
|
||||||
- Override with project-specific customizations
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
**Changes not appearing?**
|
|
||||||
|
|
||||||
- Make sure you ran `npx bmad-method build <agent-name>` after editing
|
|
||||||
- Check YAML syntax is valid (indentation matters!)
|
|
||||||
- Verify the agent name matches the file name pattern
|
|
||||||
|
|
||||||
**Agent not loading?**
|
|
||||||
|
|
||||||
- Check for YAML syntax errors
|
|
||||||
- Ensure required fields aren't left empty if you uncommented them
|
|
||||||
- Try reverting to the template and rebuilding
|
|
||||||
|
|
||||||
**Need to reset?**
|
|
||||||
|
|
||||||
- Delete the `.customize.yaml` file
|
|
||||||
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
|
|
||||||
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
|
|
||||||
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference
|
|
||||||
|
|
||||||
[← Back to Customization](/docs/how-to/customization/index.md)
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
---
|
|
||||||
title: "Workflow Customization Guide"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Customize and optimize workflows with step replacement and hooks.
|
|
||||||
|
|
||||||
## Status
|
|
||||||
|
|
||||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
|
||||||
|
|
||||||
## What to Expect
|
|
||||||
|
|
||||||
Workflow customization will allow you to:
|
|
||||||
|
|
||||||
- **Replace Steps** - Swap out specific workflow steps with custom implementations
|
|
||||||
- **Add Hooks** - Inject custom behavior before/after workflow steps
|
|
||||||
- **Extend Workflows** - Create new workflows based on existing ones
|
|
||||||
- **Override Behavior** - Customize workflow logic for your project's needs
|
|
||||||
|
|
||||||
## For Now
|
|
||||||
|
|
||||||
While workflow customization is in development, you can:
|
|
||||||
|
|
||||||
- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows
|
|
||||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
|
|
||||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.
|
|
||||||
|
|
||||||
[← Back to Customization](/docs/how-to/customization/index.md)
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: "BMad Customization"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Personalize agents and workflows to match your needs.
|
|
||||||
|
|
||||||
## Guides
|
|
||||||
|
|
||||||
| Guide | Description |
|
|
||||||
|-------|-------------|
|
|
||||||
| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files |
|
|
||||||
| **[Workflow Customization](/docs/how-to/customization/customize-workflows.md)** | Customize and optimize workflows |
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
BMad provides two main customization approaches:
|
|
||||||
|
|
||||||
### Agent Customization
|
|
||||||
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
|
||||||
|
|
||||||
### Workflow Customization
|
|
||||||
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Next:** Read the [Agent Customization Guide](/docs/how-to/customization/customize-agents.md) to start personalizing your agents.
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
---
|
|
||||||
title: "Workflow Vendoring, Customization, and Inheritance (Official Support Coming Soon)"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
|
|
||||||
|
|
||||||
## Workflow Vendoring
|
|
||||||
|
|
||||||
Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs.
|
|
||||||
|
|
||||||
### How to Vendor
|
|
||||||
|
|
||||||
Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent.
|
|
||||||
|
|
||||||
From your modules agent definition, you would implement the menu item as follows in the agent:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- trigger: develop-story
|
|
||||||
exec-vendor: "{project-root}/_bmad/<source-module>/workflows/4-production/dev-story/workflow.md"
|
|
||||||
exec: "{project-root}/_bmad/<my-module>/workflows/dev-story/workflow.md"
|
|
||||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
|
||||||
```
|
|
||||||
|
|
||||||
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
|
||||||
|
|
||||||
## Workflow Inheritance (Official Support Coming Post Beta)
|
|
||||||
|
|
||||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
|
||||||
|
|
||||||
Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific.
|
|
||||||
|
|
||||||
Some possible examples could be:
|
|
||||||
|
|
||||||
- Retrospective
|
|
||||||
- Sprint Planning
|
|
||||||
- Collaborative Brainstorming Sessions
|
|
||||||
|
|
||||||
## Workflow Customization (Official Support Coming Post Beta)
|
|
||||||
|
|
||||||
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
|
||||||
|
|
||||||
This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time.
|
|
||||||
|
|
||||||
For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow.
|
|
||||||
|
|
@ -0,0 +1,158 @@
|
||||||
|
---
|
||||||
|
title: "BMad Method Customization Guide"
|
||||||
|
---
|
||||||
|
|
||||||
|
The ability to customize the BMad Method and its core to your needs, while still being able to get updates and enhancements is a critical idea within the BMad Ecosystem.
|
||||||
|
|
||||||
|
The Customization Guidance outlined here, while targeted at understanding BMad Method customization, applies to any other module use within the BMad Method.
|
||||||
|
|
||||||
|
## Types of Customization
|
||||||
|
|
||||||
|
Customization includes Agent Customization, Workflow/Skill customization, the addition of new MCPs or Skills to be used by existing agents. Aside from all of this, a whole other realm of customization involves creating / adding your own relevant BMad Builder workflows, skills, agents and maybe even your own net new modules to compliment the BMad Method Module.
|
||||||
|
|
||||||
|
Warning: The reason for customizing as this guide will prescribe will allow you to continue getting updates without worrying about losing your customization changes. And by continuing to get updates as BMad modules advance, you will be able to continue to evolve as the system improves.
|
||||||
|
|
||||||
|
## Agent Customization
|
||||||
|
|
||||||
|
### Agent Customization Areas
|
||||||
|
|
||||||
|
- Change agent names, personas or manner of speech
|
||||||
|
- Add project-specific memories or context
|
||||||
|
- Add custom menu items to custom or inline prompts, skills or custom BMad workflows
|
||||||
|
- Define critical actions that occur agent startup for consistent behavior
|
||||||
|
|
||||||
|
## How to customize an agent.
|
||||||
|
|
||||||
|
**1. Locate Customization Files**
|
||||||
|
|
||||||
|
After installation, find agent customization files in:
|
||||||
|
|
||||||
|
```
|
||||||
|
_bmad/_config/agents/
|
||||||
|
├── core-bmad-master.customize.yaml
|
||||||
|
├── bmm-dev.customize.yaml
|
||||||
|
├── bmm-pm.customize.yaml
|
||||||
|
└── ... (one file per installed agent)
|
||||||
|
```
|
||||||
|
|
||||||
|
**2. Edit Any Agent**
|
||||||
|
|
||||||
|
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
||||||
|
|
||||||
|
**3. Rebuild the Agent**
|
||||||
|
|
||||||
|
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
|
You can either then:
|
||||||
|
|
||||||
|
- Select `Quick Update` - This will also ensure all packages are up to date AND compile all agents to include any updates or customizations
|
||||||
|
- Select `Rebuild Agents` - This will only rebuild and apply customizations to agents, without pulling the latest
|
||||||
|
|
||||||
|
There will be additional tools shortly after beta launch to allow install of individual agents, workflows, skills and modules without the need for using the full bmad installer.
|
||||||
|
|
||||||
|
### What Agent Properties Can Be Customized?
|
||||||
|
|
||||||
|
#### Agent Name
|
||||||
|
|
||||||
|
Change how the agent introduces itself:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
agent:
|
||||||
|
metadata:
|
||||||
|
name: 'Spongebob' # Default: "Amelia"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Persona
|
||||||
|
|
||||||
|
Replace the agent's personality, role, and communication style:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
persona:
|
||||||
|
role: 'Senior Full-Stack Engineer'
|
||||||
|
identity: 'Lives in a pineapple (under the sea)'
|
||||||
|
communication_style: 'Spongebob annoying'
|
||||||
|
principles:
|
||||||
|
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
||||||
|
- 'Favor composition over inheritance'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** The persona section replaces the entire default persona (not merged).
|
||||||
|
|
||||||
|
#### Memories
|
||||||
|
|
||||||
|
Add persistent context the agent will always remember:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
memories:
|
||||||
|
- 'Works at Krusty Krab'
|
||||||
|
- 'Favorite Celebrity: David Hasslehoff'
|
||||||
|
- 'Learned in Epic 1 that its not cool to just pretend that tests have passed'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Menu Items
|
||||||
|
|
||||||
|
Any custom items you add here will be included in the agents display menu.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
menu:
|
||||||
|
- trigger: my-workflow
|
||||||
|
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||||
|
description: My custom workflow
|
||||||
|
- trigger: deploy
|
||||||
|
action: '#deploy-prompt'
|
||||||
|
description: Deploy to production
|
||||||
|
```
|
||||||
|
|
||||||
|
### Critical Actions
|
||||||
|
|
||||||
|
Add instructions that execute before the agent starts:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
critical_actions:
|
||||||
|
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom Prompts
|
||||||
|
|
||||||
|
Define reusable prompts for `action="#id"` menu handlers:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prompts:
|
||||||
|
- id: deploy-prompt
|
||||||
|
content: |
|
||||||
|
Deploy the current branch to production:
|
||||||
|
1. Run all tests
|
||||||
|
2. Build the project
|
||||||
|
3. Execute deployment script
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
**Changes not appearing?**
|
||||||
|
|
||||||
|
- Make sure you ran `npx bmad-method build <agent-name>` after editing
|
||||||
|
- Check YAML syntax is valid (indentation matters!)
|
||||||
|
- Verify the agent name matches the file name pattern
|
||||||
|
|
||||||
|
**Agent not loading?**
|
||||||
|
|
||||||
|
- Check for YAML syntax errors
|
||||||
|
- Ensure required fields aren't left empty if you uncommented them
|
||||||
|
- Try reverting to the template and rebuilding
|
||||||
|
|
||||||
|
**Need to reset?**
|
||||||
|
|
||||||
|
- Remove content from the `.customize.yaml` file (or delete the file)
|
||||||
|
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
||||||
|
|
||||||
|
## Workflow Customization
|
||||||
|
|
||||||
|
Information about customizing existing BMad Method workflows and skills are coming soon.
|
||||||
|
|
||||||
|
## Module Customization
|
||||||
|
|
||||||
|
Information on how to build expansion modules that augment BMad, or make other existing module customizations are coming soon.
|
||||||
|
|
@ -3,41 +3,38 @@ title: "How to Get Answers About BMad"
|
||||||
description: Use an LLM to quickly answer your own BMad questions
|
description: Use an LLM to quickly answer your own BMad questions
|
||||||
---
|
---
|
||||||
|
|
||||||
Point an LLM at BMad's source files and ask your question. That's the technique—the rest of this guide shows you how.
|
If you have successfully installed BMad and the BMad Method (+ other modules as needed) - the first step in getting answers is `/bmad-help`. This will answer upwards of 80% of all questions and is available to you in the IDE as you are working.
|
||||||
|
|
||||||
## See It Work
|
## When to Use This
|
||||||
|
|
||||||
:::note[Example]
|
- You have a question about how BMad works or what to do next with BMad
|
||||||
**Q:** "Tell me the fastest way to build something with BMad"
|
- You want to understand a specific agent or workflow
|
||||||
|
- You need quick answers without waiting for Discord
|
||||||
|
|
||||||
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. This gets small features shipped in a single focused session instead of going through the full 4-phase BMM workflow.
|
:::note[Prerequisites]
|
||||||
|
An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Why This Works
|
## Steps
|
||||||
|
|
||||||
BMad's prompts are written in plain English, not code. The `_bmad` folder contains readable instructions, workflows, and agent definitions—exactly what LLMs are good at processing. You're not asking the LLM to guess; you're giving it the actual source material.
|
### 1. Choose Your Source
|
||||||
|
|
||||||
## How to Do It
|
|
||||||
|
|
||||||
### What Each Source Gives You
|
|
||||||
|
|
||||||
| Source | Best For | Examples |
|
| Source | Best For | Examples |
|
||||||
|--------|----------|----------|
|
| -------------------- | ----------------------------------------- | ---------------------------- |
|
||||||
| **`_bmad` folder** (installed) | How BMad works in detail—agents, workflows, prompts | "What does the PM agent do?" "How does the PRD workflow work?" |
|
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
|
||||||
| **Full GitHub repo** (cloned) | Why things are the way they are—history, installer, architecture | "Why is the installer structured this way?" "What changed in v6?" |
|
| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
|
||||||
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMad's four phases" "What's the difference between levels?" |
|
| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" |
|
||||||
|
|
||||||
:::note[What's `_bmad`?]
|
The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead.
|
||||||
The `_bmad` folder is created when you install BMad. It contains all the agent definitions, workflows, and prompts. If you don't have this folder yet, you haven't installed BMad—see the "clone the repo" option below.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### If Your AI Can Read Files (Claude Code, Cursor, etc.)
|
### 2. Point Your AI at the Source
|
||||||
|
|
||||||
**BMad installed:** Point your LLM at the `_bmad` folder and ask directly.
|
**If your AI can read files (Claude Code, Cursor, etc.):**
|
||||||
|
|
||||||
**Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) for git history and installer details.
|
- **BMad installed:** Point at the `_bmad` folder and ask directly
|
||||||
|
- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||||
|
|
||||||
### If You Use ChatGPT or Claude.ai
|
**If you use ChatGPT or Claude.ai:**
|
||||||
|
|
||||||
Fetch `llms-full.txt` into your session:
|
Fetch `llms-full.txt` into your session:
|
||||||
|
|
||||||
|
|
@ -45,18 +42,31 @@ Fetch `llms-full.txt` into your session:
|
||||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also find this and other downloadable resources on the [Downloads page](/docs/downloads.md).
|
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
||||||
|
|
||||||
:::tip[Verify Surprising Answers]
|
### 3. Ask Your Question
|
||||||
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
|
|
||||||
|
:::note[Example]
|
||||||
|
**Q:** "Tell me the fastest way to build something with BMad"
|
||||||
|
|
||||||
|
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## What You Get
|
||||||
|
|
||||||
|
Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond.
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord.
|
||||||
|
- **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?"
|
||||||
|
|
||||||
## Still Stuck?
|
## Still Stuck?
|
||||||
|
|
||||||
Tried the LLM approach and still need help? You now have a much better question to ask.
|
Tried the LLM approach and still need help? You now have a much better question to ask.
|
||||||
|
|
||||||
| Channel | Use For |
|
| Channel | Use For |
|
||||||
|---------|---------|
|
| ------------------------- | ------------------------------------------- |
|
||||||
| `#bmad-method-help` | Quick questions (real-time chat) |
|
| `#bmad-method-help` | Quick questions (real-time chat) |
|
||||||
| `help-requests` forum | Detailed questions (searchable, persistent) |
|
| `help-requests` forum | Detailed questions (searchable, persistent) |
|
||||||
| `#suggestions-feedback` | Ideas and feature requests |
|
| `#suggestions-feedback` | Ideas and feature requests |
|
||||||
|
|
@ -64,13 +74,7 @@ Tried the LLM approach and still need help? You now have a much better question
|
||||||
|
|
||||||
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||||
|
|
||||||
## Found a Bug?
|
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs)
|
||||||
|
|
||||||
If it's clearly a bug in BMad itself, skip Discord and go straight to GitHub Issues:
|
|
||||||
|
|
||||||
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*You!*
|
*You!*
|
||||||
*Stuck*
|
*Stuck*
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,82 @@
|
||||||
|
---
|
||||||
|
title: "How to Install BMad"
|
||||||
|
description: Step-by-step guide to installing BMad in your project
|
||||||
|
---
|
||||||
|
|
||||||
|
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
||||||
|
|
||||||
|
## When to Use This
|
||||||
|
|
||||||
|
- Starting a new project with BMad
|
||||||
|
- Adding BMad to an existing codebase
|
||||||
|
- Update the existing BMad Installation
|
||||||
|
|
||||||
|
:::note[Prerequisites]
|
||||||
|
- **Node.js** 20+ (required for the installer)
|
||||||
|
- **Git** (recommended)
|
||||||
|
- **AI tool** (Claude Code, Cursor, Windsurf, or similar)
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
### 1. Run the Installer
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx bmad-method install
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Choose Installation Location
|
||||||
|
|
||||||
|
The installer will ask where to install BMad files:
|
||||||
|
|
||||||
|
- Current directory (recommended for new projects if you created the directory yourself and ran from within the directory)
|
||||||
|
- Custom path
|
||||||
|
|
||||||
|
### 3. Select Your AI Tools
|
||||||
|
|
||||||
|
Pick which AI tools you use:
|
||||||
|
|
||||||
|
- Claude Code
|
||||||
|
- Cursor
|
||||||
|
- Windsurf
|
||||||
|
- Others
|
||||||
|
|
||||||
|
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
||||||
|
|
||||||
|
### 4. Choose Modules
|
||||||
|
|
||||||
|
The installer shows available modules. Select whichever ones you need — most users just want **BMad Method** (the software development module).
|
||||||
|
|
||||||
|
### 5. Follow the Prompts
|
||||||
|
|
||||||
|
The installer guides you through the rest — custom content, settings, etc.
|
||||||
|
|
||||||
|
## What You Get
|
||||||
|
|
||||||
|
```
|
||||||
|
your-project/
|
||||||
|
├── _bmad/
|
||||||
|
│ ├── bmm/ # Your selected modules
|
||||||
|
│ │ └── config.yaml # Module settings (if you ever need to change them)
|
||||||
|
│ ├── core/ # Required core module
|
||||||
|
│ └── ...
|
||||||
|
├── _bmad-output/ # Generated artifacts
|
||||||
|
└── .claude/ # Claude Code commands (if using Claude Code)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Verify Installation
|
||||||
|
|
||||||
|
Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next.
|
||||||
|
|
||||||
|
**Latest from main branch:**
|
||||||
|
```bash
|
||||||
|
npx github:bmad-code-org/BMAD-METHOD install
|
||||||
|
```
|
||||||
|
|
||||||
|
Use these if you want the newest features before they're officially released. Things might break.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
**Installer throws an error** — Copy-paste the output into your AI assistant and let it figure it out.
|
||||||
|
|
||||||
|
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](/docs/how-to/get-answers-about-bmad.md) for how to point your AI at the right sources.
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
---
|
|
||||||
title: "Installation Guides"
|
|
||||||
description: How to install and upgrade BMad Method
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
How-to guides for installing and configuring the BMad Method.
|
|
||||||
|
|
||||||
## Available Guides
|
|
||||||
|
|
||||||
| Guide | Description |
|
|
||||||
|-------|-------------|
|
|
||||||
| **[Install BMad](/docs/how-to/installation/install-bmad.md)** | Step-by-step installation instructions |
|
|
||||||
| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Add custom agents, workflows, and modules |
|
|
||||||
| **[Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md)** | Migrate from BMad v4 to v6 |
|
|
||||||
|
|
@ -1,138 +0,0 @@
|
||||||
---
|
|
||||||
title: "How to Install BMad"
|
|
||||||
description: Step-by-step guide to installing BMad in your project
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
Complete guide to installing BMad in your project.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
- **Node.js** 20+ (required for the installer)
|
|
||||||
- **Git** (recommended)
|
|
||||||
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Steps
|
|
||||||
|
|
||||||
### 1. Run the Installer
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx bmad-method install
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Choose Installation Location
|
|
||||||
|
|
||||||
The installer will ask where to install BMad files. Options:
|
|
||||||
- Current directory (recommended for new projects)
|
|
||||||
- Subdirectory
|
|
||||||
- Custom path
|
|
||||||
|
|
||||||
### 3. Select Your AI Tools
|
|
||||||
|
|
||||||
Choose which AI tools you'll be using:
|
|
||||||
- Claude Code
|
|
||||||
- Cursor
|
|
||||||
- Windsurf
|
|
||||||
- Other
|
|
||||||
|
|
||||||
The installer configures BMad for your selected tools.
|
|
||||||
|
|
||||||
### 4. Choose Modules
|
|
||||||
|
|
||||||
Select which modules to install:
|
|
||||||
|
|
||||||
| Module | Purpose |
|
|
||||||
|--------|---------|
|
|
||||||
| **BMM** | Core methodology for software development |
|
|
||||||
| **BMGD** | Game development workflows |
|
|
||||||
| **CIS** | Creative intelligence and facilitation |
|
|
||||||
| **BMB** | Building custom agents and workflows |
|
|
||||||
|
|
||||||
### 5. Add Custom Content (Optional)
|
|
||||||
|
|
||||||
If you have custom agents, workflows, or modules:
|
|
||||||
- Point to their location
|
|
||||||
- The installer will integrate them
|
|
||||||
|
|
||||||
### 6. Configure Settings
|
|
||||||
|
|
||||||
For each module, either:
|
|
||||||
- Accept recommended defaults (faster)
|
|
||||||
- Customize settings (more control)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Verify Installation
|
|
||||||
|
|
||||||
After installation, verify by:
|
|
||||||
|
|
||||||
1. Checking the `_bmad/` directory exists
|
|
||||||
2. Loading an agent in your AI tool
|
|
||||||
3. Running `*menu` to see available commands
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Directory Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
your-project/
|
|
||||||
├── _bmad/
|
|
||||||
│ ├── bmm/ # Method module
|
|
||||||
│ │ ├── agents/ # Agent files
|
|
||||||
│ │ ├── workflows/ # Workflow files
|
|
||||||
│ │ └── config.yaml # Module config
|
|
||||||
│ ├── core/ # Core utilities
|
|
||||||
│ └── ...
|
|
||||||
├── _bmad-output/ # Generated artifacts
|
|
||||||
└── .claude/ # IDE configuration
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Edit `_bmad/[module]/config.yaml` to customize:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
output_folder: ./_bmad-output
|
|
||||||
user_name: Your Name
|
|
||||||
communication_language: english
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
### "Command not found: npx"
|
|
||||||
|
|
||||||
Install Node.js 20+:
|
|
||||||
```bash
|
|
||||||
brew install node
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### "Permission denied"
|
|
||||||
|
|
||||||
Check npm permissions:
|
|
||||||
```bash
|
|
||||||
npm config set prefix ~/.npm-global
|
|
||||||
```
|
|
||||||
|
|
||||||
### Installer hangs
|
|
||||||
|
|
||||||
Try running with verbose output:
|
|
||||||
```bash
|
|
||||||
npx bmad-method install --verbose
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related
|
|
||||||
|
|
||||||
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
|
|
||||||
- [Upgrade to V6](/docs/how-to/installation/upgrade-to-v6.md) - Upgrading from previous versions
|
|
||||||
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) - Adding custom content
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue