Compare commits
403 Commits
v6.0.0-Bet
...
main
| Author | SHA1 | Date |
|---|---|---|
|
|
e3f935fd6d | |
|
|
10282a4a14 | |
|
|
a59ae5c842 | |
|
|
ad9cb7a177 | |
|
|
93a1e1dc46 | |
|
|
31ae226bb4 | |
|
|
c28206dca4 | |
|
|
1a6f8d52bc | |
|
|
1cb913523e | |
|
|
a2839cbee0 | |
|
|
6a73623f33 | |
|
|
3ca957e229 | |
|
|
9725b0ae90 | |
|
|
182550407c | |
|
|
4b2389231f | |
|
|
9088d4958b | |
|
|
0d2863f77f | |
|
|
a092209267 | |
|
|
1786d1debc | |
|
|
4cb58ba9f3 | |
|
|
871d921072 | |
|
|
3fad46849f | |
|
|
3bb953f18b | |
|
|
43c59f0cff | |
|
|
3c8d865457 | |
|
|
1b8424cf6d | |
|
|
9973b3c35a | |
|
|
1a0da0278f | |
|
|
52ebc3330d | |
|
|
8b13628496 | |
|
|
642b6a0cf4 | |
|
|
fd1e24c5c2 | |
|
|
84bade9a95 | |
|
|
4f1894908c | |
|
|
7a214cc7d8 | |
|
|
ac5cb552c0 | |
|
|
be555aad8b | |
|
|
22035ef015 | |
|
|
f0e43f02e2 | |
|
|
0380656de6 | |
|
|
5a1f356e2c | |
|
|
21c2a48ab2 | |
|
|
ebbc6d2a33 | |
|
|
f0c7cf41c7 | |
|
|
0580164bdc | |
|
|
72f6963253 | |
|
|
3bae0cba6a | |
|
|
e84874e9f0 | |
|
|
fcd0873d22 | |
|
|
96091cb74d | |
|
|
93d03e5f80 | |
|
|
f3f606a9ce | |
|
|
9636e86b75 | |
|
|
88aa53506a | |
|
|
653c3ae152 | |
|
|
39359ddbcd | |
|
|
f036c21d13 | |
|
|
cc300b3940 | |
|
|
6de6f45086 | |
|
|
a1418dfd28 | |
|
|
e5062a8bbb | |
|
|
21123d6349 | |
|
|
f6c2854ed9 | |
|
|
b8388ff227 | |
|
|
80604b45fe | |
|
|
bce72fe18d | |
|
|
6742b1ff7b | |
|
|
e21d6b36ae | |
|
|
cad25817eb | |
|
|
aa2a9a2818 | |
|
|
be6611570a | |
|
|
28954fea79 | |
|
|
bed9052d49 | |
|
|
ba0c59128d | |
|
|
8e8432e138 | |
|
|
2f4c9ca879 | |
|
|
ebe490a505 | |
|
|
6dc9ce0090 | |
|
|
0bf6cb3380 | |
|
|
d42de639bc | |
|
|
082abc1a17 | |
|
|
07f1a44c5c | |
|
|
d1163f85e1 | |
|
|
cbb9a2a0c9 | |
|
|
45d125f3b5 | |
|
|
ce23cb5d5a | |
|
|
fdad19ebd7 | |
|
|
09bca114e5 | |
|
|
6a91eb6855 | |
|
|
f12e38e003 | |
|
|
17cd19f07b | |
|
|
4404b4bc9a | |
|
|
8efc8c309c | |
|
|
4937ce1bc2 | |
|
|
ac994d683d | |
|
|
1397c8f44a | |
|
|
1558a68a0a | |
|
|
cb16a4fac2 | |
|
|
de565221d8 | |
|
|
6ee4062e56 | |
|
|
75292af47c | |
|
|
a2f4bfea8f | |
|
|
098c96740c | |
|
|
5de8a78c6a | |
|
|
42b1d0f657 | |
|
|
1ec0d8ba43 | |
|
|
2a3708fd32 | |
|
|
e794a81ee2 | |
|
|
2aa5cddbe6 | |
|
|
67232c11cc | |
|
|
2622b5d094 | |
|
|
71c6d5c924 | |
|
|
4bfb076724 | |
|
|
f5813f26f2 | |
|
|
02cfaf64a4 | |
|
|
a98bf008fc | |
|
|
fa9c10ec05 | |
|
|
d8ab6efa1f | |
|
|
cbb8b98876 | |
|
|
9fa51d996b | |
|
|
ccfd818ebd | |
|
|
a6fdf4349f | |
|
|
da4426237e | |
|
|
f076957807 | |
|
|
5a06b56eaa | |
|
|
7f0ffb54c0 | |
|
|
a136713dc9 | |
|
|
1dd6668a0d | |
|
|
87f47625da | |
|
|
b42f1e732a | |
|
|
9f8f7f4a3e | |
|
|
6c83482513 | |
|
|
5c24754627 | |
|
|
fe86785dbf | |
|
|
0efe81faec | |
|
|
b1209a97da | |
|
|
73e5552aad | |
|
|
f7cd62acba | |
|
|
9976f06e46 | |
|
|
1338e4852d | |
|
|
6c259bbbc5 | |
|
|
f15b2d129f | |
|
|
f04a1ba8d8 | |
|
|
b9b135573d | |
|
|
709b4e8fc9 | |
|
|
930b5fd7ea | |
|
|
6721904adb | |
|
|
74391d712b | |
|
|
93a808a3d6 | |
|
|
54d097c8ca | |
|
|
fb4d9169a6 | |
|
|
71630bc4e9 | |
|
|
211c7e38c3 | |
|
|
e0a56489f7 | |
|
|
2d78e1d942 | |
|
|
7e6c26cd04 | |
|
|
b3d0810042 | |
|
|
df5c32e0dd | |
|
|
d343fbe55f | |
|
|
b0d4bf7e28 | |
|
|
9471c832d5 | |
|
|
2c23522d87 | |
|
|
089c19d7ab | |
|
|
b9926e1c4a | |
|
|
304ef02427 | |
|
|
122ef9b43c | |
|
|
2b2b9201a7 | |
|
|
516557451a | |
|
|
f3d6ee2cb8 | |
|
|
9d17cee2a8 | |
|
|
f4084ea199 | |
|
|
b93d0087db | |
|
|
6ff29d4707 | |
|
|
4cbbeb6602 | |
|
|
3678dbe3ff | |
|
|
40bb9abd31 | |
|
|
d050711b07 | |
|
|
7a0fe16251 | |
|
|
1457e0b552 | |
|
|
2d64254ff6 | |
|
|
e7f87af938 | |
|
|
8886805856 | |
|
|
7ea11c2db9 | |
|
|
f374f2e17d | |
|
|
76d5db5395 | |
|
|
67f0501a67 | |
|
|
c9658e0039 | |
|
|
717e013f55 | |
|
|
aecead265f | |
|
|
a64e4de621 | |
|
|
cc2a4142d4 | |
|
|
6ce3801dff | |
|
|
380a0af24b | |
|
|
a0c58a1814 | |
|
|
b46f42ec1e | |
|
|
a62e7a3c25 | |
|
|
74b53e13a7 | |
|
|
6a98b94949 | |
|
|
8dbc9b375d | |
|
|
6cb0cc40fc | |
|
|
bc8d239834 | |
|
|
e97aecda28 | |
|
|
ac769b230f | |
|
|
9e7aeec385 | |
|
|
405fd93e50 | |
|
|
5f92146a29 | |
|
|
df4d53de0e | |
|
|
d2f15ef776 | |
|
|
a4ecc03dcc | |
|
|
79a829b591 | |
|
|
80671650c2 | |
|
|
25d24d02c4 | |
|
|
037c34b897 | |
|
|
75867b0bea | |
|
|
d39fcd5938 | |
|
|
8ba428ee35 | |
|
|
997c2e3655 | |
|
|
521f1e15ca | |
|
|
2e88b846f7 | |
|
|
88e576d10b | |
|
|
9cd6e3826d | |
|
|
e073aee30b | |
|
|
8f1cb7fb70 | |
|
|
a48fd4aae8 | |
|
|
75ec4aa504 | |
|
|
7b4875be79 | |
|
|
c57506464f | |
|
|
fcbcaa6831 | |
|
|
fd26a2e0f2 | |
|
|
904b8c0dff | |
|
|
861716fbe3 | |
|
|
0ba809c3e8 | |
|
|
42aa184074 | |
|
|
5a5ade333a | |
|
|
7f7ce8c5e3 | |
|
|
5e1149dc14 | |
|
|
df9a7f9b67 | |
|
|
9cd362d2d8 | |
|
|
e64cef80b6 | |
|
|
32693f1a6b | |
|
|
874ae40bb2 | |
|
|
6292b0323f | |
|
|
3339f24890 | |
|
|
c0877e795f | |
|
|
ffd7d53be5 | |
|
|
031a9093a1 | |
|
|
2a12c6b2f0 | |
|
|
bb046f5062 | |
|
|
2b809e56a4 | |
|
|
5988fe0506 | |
|
|
61d89c82ef | |
|
|
30a98633cd | |
|
|
b7315c6e32 | |
|
|
6a0046917a | |
|
|
c8f5b60598 | |
|
|
7bc2b5e0e0 | |
|
|
1ed5c9d94b | |
|
|
fb76895145 | |
|
|
ebf1513069 | |
|
|
10f02a8f15 | |
|
|
7857b17626 | |
|
|
063aa58b8d | |
|
|
9421f20b69 | |
|
|
956c43ff62 | |
|
|
1b3c3c5013 | |
|
|
066bfe32e9 | |
|
|
ee25fcca6f | |
|
|
4c470d9948 | |
|
|
0782e291fd | |
|
|
5c9227340e | |
|
|
350a1eaa47 | |
|
|
140ae57f2a | |
|
|
c9ebe1b417 | |
|
|
835d6d85a5 | |
|
|
dc8293e5df | |
|
|
7f1a55ca8c | |
|
|
8e5898e862 | |
|
|
44ba15f9a1 | |
|
|
db8f856fce | |
|
|
ec973ebcf3 | |
|
|
4974cd847f | |
|
|
5aab72caba | |
|
|
434e7efab6 | |
|
|
0d3b317598 | |
|
|
09ce8559f2 | |
|
|
e3ffdf9c90 | |
|
|
d812205470 | |
|
|
ed76f57a19 | |
|
|
f7846fd5eb | |
|
|
abf3d25f06 | |
|
|
259e8a11ba | |
|
|
9536e1e6e3 | |
|
|
7ece8b09fa | |
|
|
35a7f101dd | |
|
|
efc69ffb2c | |
|
|
44972d62b9 | |
|
|
deedf18fc5 | |
|
|
17fe438452 | |
|
|
d036d34892 | |
|
|
bc7c7f0757 | |
|
|
43cfc01f2c | |
|
|
1677d54f22 | |
|
|
5ad35d68bd | |
|
|
2f484f15b6 | |
|
|
2d2f4855b1 | |
|
|
d94757a7d4 | |
|
|
6bfc937bd3 | |
|
|
72a9325a40 | |
|
|
5ed436cda0 | |
|
|
97a533e298 | |
|
|
b83ccc71b9 | |
|
|
d43663e3af | |
|
|
0d858cbc5b | |
|
|
3ad6985643 | |
|
|
44eeaa8a71 | |
|
|
1d49fe1802 | |
|
|
476082fda7 | |
|
|
8cf22a4182 | |
|
|
d48d40d397 | |
|
|
675e753e9b | |
|
|
276fcb1042 | |
|
|
99c1fa940a | |
|
|
bea89893fd | |
|
|
eb6cf96912 | |
|
|
eeb773c33d | |
|
|
35dff6b105 | |
|
|
fb05848dd3 | |
|
|
e72b82ed31 | |
|
|
d0ecfc0dd9 | |
|
|
a135622429 | |
|
|
811d03262d | |
|
|
3dd37bc94d | |
|
|
5579816ed2 | |
|
|
1782e97731 | |
|
|
9247146397 | |
|
|
c8481c21c3 | |
|
|
1198c8b9b7 | |
|
|
17a46a26a3 | |
|
|
e5ee30b199 | |
|
|
aa573bdbb8 | |
|
|
3f688d5669 | |
|
|
eb88384d9e | |
|
|
469a2e288c | |
|
|
454b19a125 | |
|
|
8115ad826b | |
|
|
d4b4bdfa12 | |
|
|
d6cc8b060a | |
|
|
ccaa88bb2d | |
|
|
382ab8ed45 | |
|
|
1937552da3 | |
|
|
2d134314c9 | |
|
|
a5e2b1c63a | |
|
|
5b5cb1a396 | |
|
|
98c1fa8282 | |
|
|
ae7b3a7930 | |
|
|
3103c3d4ce | |
|
|
e66bbd02f2 | |
|
|
b815410904 | |
|
|
c8ca083316 | |
|
|
5b79330f72 | |
|
|
b4d118c897 | |
|
|
3e35057b89 | |
|
|
0659aac02c | |
|
|
0bf8e0edfb | |
|
|
36c21dbada | |
|
|
2754d66042 | |
|
|
60c3477a3a | |
|
|
622b627430 | |
|
|
c563cef0c2 | |
|
|
90ea3cbed7 | |
|
|
a1101534b2 | |
|
|
24cf444366 | |
|
|
fc5ef57a5a | |
|
|
b1bfce9aa7 | |
|
|
ecf7fbcb2c | |
|
|
cb73c05cf6 | |
|
|
045b1fe148 | |
|
|
4c36c94c2d | |
|
|
a8cda7c6fa | |
|
|
97bfe0a485 | |
|
|
6c2d0195d3 | |
|
|
90d9204dc9 | |
|
|
09316ecc7f | |
|
|
a79f581003 | |
|
|
dbb754f085 | |
|
|
c1a927ae8d | |
|
|
33f78a3bf9 | |
|
|
d027811954 | |
|
|
ae92f7bc50 | |
|
|
f7b5f03800 | |
|
|
7c0e5d5e1d | |
|
|
8be3713595 | |
|
|
22601f8198 | |
|
|
068a9dc45a | |
|
|
420e720242 | |
|
|
311b237d85 | |
|
|
2aab028f96 | |
|
|
47a70cc92d | |
|
|
dcc55dd0d5 | |
|
|
d37ee7f27a | |
|
|
bd620e38e5 | |
|
|
731bee26ea | |
|
|
5276d58b2c |
|
|
@ -0,0 +1,109 @@
|
|||
# Augment Code Review Guidelines for BMAD-METHOD
|
||||
# https://docs.augmentcode.com/codereview/overview
|
||||
# Focus: Skill validation and quality
|
||||
# Canonical rules: tools/skill-validator.md (single source of truth)
|
||||
|
||||
file_paths_to_ignore:
|
||||
# --- Shared baseline: tool configs ---
|
||||
- ".coderabbit.yaml"
|
||||
- ".augment/**"
|
||||
- "eslint.config.mjs"
|
||||
# --- Shared baseline: build output ---
|
||||
- "dist/**"
|
||||
- "build/**"
|
||||
- "coverage/**"
|
||||
# --- Shared baseline: vendored/generated ---
|
||||
- "node_modules/**"
|
||||
- "**/*.min.js"
|
||||
- "**/*.generated.*"
|
||||
- "**/*.bundle.md"
|
||||
# --- Shared baseline: package metadata ---
|
||||
- "package-lock.json"
|
||||
# --- Shared baseline: binary/media ---
|
||||
- "*.png"
|
||||
- "*.jpg"
|
||||
- "*.svg"
|
||||
# --- Shared baseline: test fixtures ---
|
||||
- "test/fixtures/**"
|
||||
- "test/template-test-generator/**"
|
||||
- "tools/template-test-generator/test-scenarios/**"
|
||||
# --- Shared baseline: non-project dirs ---
|
||||
- "_bmad*/**"
|
||||
- "website/**"
|
||||
- "z*/**"
|
||||
- "sample-project/**"
|
||||
- "test-project-install/**"
|
||||
# --- Shared baseline: AI assistant dirs ---
|
||||
- ".claude/**"
|
||||
- ".codex/**"
|
||||
- ".agent/**"
|
||||
- ".agentvibes/**"
|
||||
- ".kiro/**"
|
||||
- ".roo/**"
|
||||
- ".github/chatmodes/**"
|
||||
# --- Shared baseline: build temp ---
|
||||
- ".bundler-temp/**"
|
||||
# --- Shared baseline: generated reports ---
|
||||
- "**/validation-report-*.md"
|
||||
- "CHANGELOG.md"
|
||||
|
||||
areas:
|
||||
# ============================================
|
||||
# SKILL FILES
|
||||
# ============================================
|
||||
skill_files:
|
||||
description: "All skill content — SKILL.md, workflow.md, step files, data files, and templates within skill directories"
|
||||
globs:
|
||||
- "src/**/skills/**"
|
||||
- "src/**/workflows/**"
|
||||
- "src/**/tasks/**"
|
||||
rules:
|
||||
- id: "skill_validation"
|
||||
description: "Apply the full rule catalog defined in tools/skill-validator.md. That file is the single source of truth for all skill validation rules covering SKILL.md metadata, workflow.md constraints, step file structure, path references, variable resolution, sequential execution, and skill invocation syntax."
|
||||
severity: "high"
|
||||
|
||||
# ============================================
|
||||
# AGENT DEFINITIONS
|
||||
# ============================================
|
||||
agent_definitions:
|
||||
description: "Agent YAML configuration files"
|
||||
globs:
|
||||
- "src/**/*.agent.yaml"
|
||||
rules:
|
||||
- id: "agent_metadata_required"
|
||||
description: "Agent files must have metadata section with id, name, title, icon, and module"
|
||||
severity: "high"
|
||||
|
||||
- id: "agent_persona_required"
|
||||
description: "Agent files must define persona with role, identity, communication_style, and principles"
|
||||
severity: "high"
|
||||
|
||||
- id: "agent_menu_valid_skills"
|
||||
description: "Menu triggers must reference valid skill names that exist"
|
||||
severity: "high"
|
||||
|
||||
# ============================================
|
||||
# DOCUMENTATION
|
||||
# ============================================
|
||||
documentation:
|
||||
description: "Documentation files"
|
||||
globs:
|
||||
- "docs/**/*.md"
|
||||
- "README.md"
|
||||
- "CONTRIBUTING.md"
|
||||
rules:
|
||||
- id: "valid_internal_links"
|
||||
description: "Internal markdown links must point to existing files"
|
||||
severity: "medium"
|
||||
|
||||
# ============================================
|
||||
# BUILD TOOLS
|
||||
# ============================================
|
||||
build_tools:
|
||||
description: "Build scripts and tooling"
|
||||
globs:
|
||||
- "tools/**"
|
||||
rules:
|
||||
- id: "script_error_handling"
|
||||
description: "Scripts should handle errors gracefully with proper exit codes"
|
||||
severity: "medium"
|
||||
Binary file not shown.
|
|
@ -1,169 +0,0 @@
|
|||
---
|
||||
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.
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
🚀 **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!
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
🚀 **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
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
🚀 **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
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
name: draft-changelog
|
||||
description: Analyzes changes since last release and updates CHANGELOG.md ONLY. Does NOT trigger releases.
|
||||
disable-model-invocation: true
|
||||
---
|
||||
|
||||
Read `prompts/instructions.md` and execute.
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
# Draft Changelog Execution
|
||||
|
||||
## ⚠️ IMPORTANT - READ FIRST
|
||||
|
||||
**This skill ONLY updates CHANGELOG.md. That is its entire purpose.**
|
||||
|
||||
- **DO** update CHANGELOG.md with the new version entry
|
||||
- **DO** present the draft for user review before editing
|
||||
- **DO NOT** trigger any GitHub release workflows
|
||||
- **DO NOT** run any other skills or workflows automatically
|
||||
- **DO NOT** make any commits
|
||||
|
||||
After the changelog is complete, you may suggest the user can run `/release-module` if they want to proceed with the actual release — but NEVER trigger it yourself.
|
||||
|
||||
## 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 & Update CHANGELOG.md
|
||||
|
||||
Show the draft with current version, last tag, commit count, and options to edit/retry.
|
||||
|
||||
When user accepts:
|
||||
1. Update CHANGELOG.md with the new entry (insert at top, after `# Changelog` header)
|
||||
2. STOP. That's it. You're done.
|
||||
|
||||
You may optionally suggest: *"When ready, you can run `/release-module` to create the actual release."*
|
||||
|
||||
**DO NOT:**
|
||||
- Trigger any GitHub workflows
|
||||
- Run any other skills
|
||||
- Make any commits
|
||||
- Do anything beyond updating CHANGELOG.md
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
# 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/`
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
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.
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
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.
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
# 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.
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
# 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
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
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.
|
||||
|
|
@ -1,73 +0,0 @@
|
|||
# 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
|
||||
|
|
@ -17,21 +17,83 @@ reviews:
|
|||
base_branches:
|
||||
- main
|
||||
path_filters:
|
||||
# --- Shared baseline: tool configs ---
|
||||
- "!.coderabbit.yaml"
|
||||
- "!.augment/**"
|
||||
- "!eslint.config.mjs"
|
||||
# --- Shared baseline: build output ---
|
||||
- "!dist/**"
|
||||
- "!build/**"
|
||||
- "!coverage/**"
|
||||
# --- Shared baseline: vendored/generated ---
|
||||
- "!**/node_modules/**"
|
||||
- "!**/*.min.js"
|
||||
- "!**/*.generated.*"
|
||||
- "!**/*.bundle.md"
|
||||
# --- Shared baseline: package metadata ---
|
||||
- "!package-lock.json"
|
||||
# --- Shared baseline: binary/media ---
|
||||
- "!*.png"
|
||||
- "!*.jpg"
|
||||
- "!*.svg"
|
||||
# --- Shared baseline: test fixtures ---
|
||||
- "!test/fixtures/**"
|
||||
- "!test/template-test-generator/**"
|
||||
- "!tools/template-test-generator/test-scenarios/**"
|
||||
# --- Shared baseline: non-project dirs ---
|
||||
- "!_bmad*/**"
|
||||
- "!website/**"
|
||||
- "!z*/**"
|
||||
- "!sample-project/**"
|
||||
- "!test-project-install/**"
|
||||
# --- Shared baseline: AI assistant dirs ---
|
||||
- "!.claude/**"
|
||||
- "!.codex/**"
|
||||
- "!.agent/**"
|
||||
- "!.agentvibes/**"
|
||||
- "!.kiro/**"
|
||||
- "!.roo/**"
|
||||
- "!.github/chatmodes/**"
|
||||
# --- Shared baseline: build temp ---
|
||||
- "!.bundler-temp/**"
|
||||
# --- Shared baseline: generated reports ---
|
||||
- "!**/validation-report-*.md"
|
||||
- "!CHANGELOG.md"
|
||||
path_instructions:
|
||||
- path: "**/*"
|
||||
- path: "src/**"
|
||||
instructions: |
|
||||
Focus on inconsistencies, contradictions, edge cases and serious issues.
|
||||
Avoid commenting on minor issues such as linting, formatting and style issues.
|
||||
When providing code suggestions, use GitHub's suggestion format:
|
||||
```suggestion
|
||||
<code changes>
|
||||
```
|
||||
- path: "**/*.js"
|
||||
Source file changed. Check whether documentation under docs/ needs
|
||||
a corresponding update — new features, changed behavior, renamed
|
||||
concepts, altered CLI flags, or modified configuration options should
|
||||
all be reflected in the relevant doc pages. Flag missing or outdated
|
||||
docs as a review comment.
|
||||
- path: "src/**/skills/**"
|
||||
instructions: |
|
||||
CLI tooling code. Check for: missing error handling on fs operations,
|
||||
path.join vs string concatenation, proper cleanup in error paths.
|
||||
Flag any process.exit() without error message.
|
||||
Skill file. Apply the full rule catalog defined in tools/skill-validator.md.
|
||||
That document is the single source of truth for all skill validation rules
|
||||
covering SKILL.md metadata, workflow.md constraints, step file structure,
|
||||
path references, variable resolution, sequential execution, and skill
|
||||
invocation syntax.
|
||||
- path: "src/**/workflows/**"
|
||||
instructions: |
|
||||
Legacy workflow file (pre-skill conversion). Apply the full rule catalog
|
||||
defined in tools/skill-validator.md — the same rules apply to workflows
|
||||
that are being converted to skills.
|
||||
- path: "src/**/tasks/**"
|
||||
instructions: |
|
||||
Task file. Apply the full rule catalog defined in tools/skill-validator.md.
|
||||
- path: "src/**/*.agent.yaml"
|
||||
instructions: |
|
||||
Agent definition file. Check:
|
||||
- Has metadata section with id, name, title, icon, and module
|
||||
- Defines persona with role, identity, communication_style, and principles
|
||||
- Menu triggers reference valid skill names that exist
|
||||
- path: "docs/**/*.md"
|
||||
instructions: |
|
||||
Documentation file. Check internal markdown links point to existing files.
|
||||
- path: "tools/**"
|
||||
instructions: |
|
||||
Build script/tooling. Check error handling and proper exit codes.
|
||||
chat:
|
||||
auto_reply: true # Response to mentions in comments, a la @coderabbit review
|
||||
issue_enrichment:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 📚 Documentation
|
||||
url: http://docs.bmad-method.org
|
||||
url: https://docs.bmad-method.org
|
||||
about: Check the docs first — tutorials, guides, and reference
|
||||
- name: 💬 Discord Community
|
||||
url: https://discord.gg/gk8jAdXWmj
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ body:
|
|||
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"
|
||||
placeholder: e.g., https://docs.bmad-method.org/tutorials/getting-started/ or "In the README"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
## What
|
||||
<!-- 1-2 sentences describing WHAT changed -->
|
||||
|
||||
## Why
|
||||
<!-- 1-2 sentences explaining WHY this change is needed -->
|
||||
<!-- Fixes `#issue_number` (if applicable) -->
|
||||
|
||||
## How
|
||||
<!-- 2-3 bullets listing HOW you implemented it -->
|
||||
-
|
||||
|
||||
## Testing
|
||||
<!-- 1-2 sentences on how you tested this -->
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
name: Trigger CodeRabbit on Ready for Review
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
types: [ready_for_review]
|
||||
|
||||
jobs:
|
||||
trigger-review:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Request CodeRabbit review
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.payload.pull_request.number,
|
||||
body: '@coderabbitai review'
|
||||
});
|
||||
|
|
@ -6,9 +6,8 @@ on:
|
|||
- main
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "src/modules/*/docs/**"
|
||||
- "website/**"
|
||||
- "tools/build-docs.js"
|
||||
- "tools/build-docs.mjs"
|
||||
- ".github/workflows/docs.yaml"
|
||||
workflow_dispatch:
|
||||
|
||||
|
|
@ -19,6 +18,7 @@ permissions:
|
|||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
# No big win in setting this to true — risk of cancelling a deploy mid-flight.
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
|
|
@ -28,12 +28,13 @@ jobs:
|
|||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
# Full history needed for Starlight's lastUpdated timestamps (git log)
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "20"
|
||||
node-version-file: ".nvmrc"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
|
|
|
|||
|
|
@ -1,193 +0,0 @@
|
|||
name: Manual Release
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
version_bump:
|
||||
description: Version bump type
|
||||
required: true
|
||||
default: beta
|
||||
type: choice
|
||||
options:
|
||||
- beta
|
||||
- alpha
|
||||
- patch
|
||||
- minor
|
||||
- major
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ".nvmrc"
|
||||
cache: npm
|
||||
registry-url: https://registry.npmjs.org
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests and validation
|
||||
run: |
|
||||
npm run validate
|
||||
npm run format:check
|
||||
npm run lint
|
||||
|
||||
- name: Configure Git
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
- name: Bump version
|
||||
run: |
|
||||
case "${{ github.event.inputs.version_bump }}" in
|
||||
alpha|beta) npm version prerelease --no-git-tag-version --preid=${{ github.event.inputs.version_bump }} ;;
|
||||
*) npm version ${{ github.event.inputs.version_bump }} --no-git-tag-version ;;
|
||||
esac
|
||||
|
||||
- name: Get new version and previous tag
|
||||
id: version
|
||||
run: |
|
||||
echo "new_version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
||||
echo "previous_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Update installer package.json
|
||||
run: |
|
||||
sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
|
||||
|
||||
# TODO: Re-enable web bundles once tools/cli/bundlers/ is restored
|
||||
# - name: Generate web bundles
|
||||
# run: npm run bundle
|
||||
|
||||
- name: Commit version bump
|
||||
run: |
|
||||
git add .
|
||||
git commit -m "release: bump to v${{ steps.version.outputs.new_version }}"
|
||||
|
||||
- name: Generate release notes
|
||||
id: release_notes
|
||||
run: |
|
||||
# Get commits since last tag
|
||||
COMMITS=$(git log ${{ steps.version.outputs.previous_tag }}..HEAD --pretty=format:"- %s" --reverse)
|
||||
|
||||
# Categorize commits
|
||||
FEATURES=$(echo "$COMMITS" | grep -E "^- (feat|Feature)" || true)
|
||||
FIXES=$(echo "$COMMITS" | grep -E "^- (fix|Fix)" || true)
|
||||
CHORES=$(echo "$COMMITS" | grep -E "^- (chore|Chore)" || true)
|
||||
OTHERS=$(echo "$COMMITS" | grep -v -E "^- (feat|Feature|fix|Fix|chore|Chore|release:|Release:)" || true)
|
||||
|
||||
# Build release notes
|
||||
cat > release_notes.md << 'EOF'
|
||||
## 🚀 What's New in v${{ steps.version.outputs.new_version }}
|
||||
|
||||
EOF
|
||||
|
||||
if [ ! -z "$FEATURES" ]; then
|
||||
echo "### ✨ New Features" >> release_notes.md
|
||||
echo "$FEATURES" >> release_notes.md
|
||||
echo "" >> release_notes.md
|
||||
fi
|
||||
|
||||
if [ ! -z "$FIXES" ]; then
|
||||
echo "### 🐛 Bug Fixes" >> release_notes.md
|
||||
echo "$FIXES" >> release_notes.md
|
||||
echo "" >> release_notes.md
|
||||
fi
|
||||
|
||||
if [ ! -z "$OTHERS" ]; then
|
||||
echo "### 📦 Other Changes" >> release_notes.md
|
||||
echo "$OTHERS" >> release_notes.md
|
||||
echo "" >> release_notes.md
|
||||
fi
|
||||
|
||||
if [ ! -z "$CHORES" ]; then
|
||||
echo "### 🔧 Maintenance" >> release_notes.md
|
||||
echo "$CHORES" >> release_notes.md
|
||||
echo "" >> release_notes.md
|
||||
fi
|
||||
|
||||
cat >> release_notes.md << 'EOF'
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
**Full Changelog**: https://github.com/bmad-code-org/BMAD-METHOD/compare/${{ steps.version.outputs.previous_tag }}...v${{ steps.version.outputs.new_version }}
|
||||
EOF
|
||||
|
||||
# Output for GitHub Actions
|
||||
echo "RELEASE_NOTES<<EOF" >> $GITHUB_OUTPUT
|
||||
cat release_notes.md >> $GITHUB_OUTPUT
|
||||
echo "EOF" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Create and push tag
|
||||
run: |
|
||||
# Check if tag already exists
|
||||
if git rev-parse "v${{ steps.version.outputs.new_version }}" >/dev/null 2>&1; then
|
||||
echo "Tag v${{ steps.version.outputs.new_version }} already exists, skipping tag creation"
|
||||
else
|
||||
git tag -a "v${{ steps.version.outputs.new_version }}" -m "Release v${{ steps.version.outputs.new_version }}"
|
||||
git push origin "v${{ steps.version.outputs.new_version }}"
|
||||
fi
|
||||
|
||||
- name: Push changes to main
|
||||
run: |
|
||||
if git push origin HEAD:main 2>/dev/null; then
|
||||
echo "✅ Successfully pushed to main branch"
|
||||
else
|
||||
echo "⚠️ Could not push to main (protected branch). This is expected."
|
||||
echo "📝 Version bump and tag were created successfully."
|
||||
fi
|
||||
|
||||
- name: Publish to NPM
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.new_version }}"
|
||||
if [[ "$VERSION" == *"alpha"* ]]; then
|
||||
echo "Publishing alpha prerelease version with --tag alpha"
|
||||
npm publish --tag alpha
|
||||
elif [[ "$VERSION" == *"beta"* ]]; then
|
||||
echo "Publishing beta prerelease version with --tag latest"
|
||||
npm publish --tag latest
|
||||
else
|
||||
echo "Publishing stable version with --tag latest"
|
||||
npm publish --tag latest
|
||||
fi
|
||||
|
||||
- name: Create GitHub Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: v${{ steps.version.outputs.new_version }}
|
||||
name: "BMad Method v${{ steps.version.outputs.new_version }}"
|
||||
body: |
|
||||
${{ steps.release_notes.outputs.RELEASE_NOTES }}
|
||||
draft: false
|
||||
prerelease: ${{ contains(steps.version.outputs.new_version, 'alpha') || contains(steps.version.outputs.new_version, 'beta') }}
|
||||
|
||||
- name: Summary
|
||||
run: |
|
||||
echo "## 🎉 Successfully released v${{ steps.version.outputs.new_version }}!" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### 📦 Distribution" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **NPM**: Published with @latest tag" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **GitHub Release**: https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v${{ steps.version.outputs.new_version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### ✅ Installation" >> $GITHUB_STEP_SUMMARY
|
||||
echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY
|
||||
echo "npx bmad-method@${{ steps.version.outputs.new_version }} install" >> $GITHUB_STEP_SUMMARY
|
||||
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
name: Publish
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- "src/**"
|
||||
- "tools/cli/**"
|
||||
- "package.json"
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
channel:
|
||||
description: "Publish channel"
|
||||
required: true
|
||||
default: "latest"
|
||||
type: choice
|
||||
options:
|
||||
- latest
|
||||
- next
|
||||
bump:
|
||||
description: "Version bump type (latest channel only)"
|
||||
required: false
|
||||
default: "patch"
|
||||
type: choice
|
||||
options:
|
||||
- patch
|
||||
- minor
|
||||
- major
|
||||
|
||||
concurrency:
|
||||
group: publish
|
||||
cancel-in-progress: ${{ github.event_name == 'push' }}
|
||||
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
if: github.repository == 'bmad-code-org/BMAD-METHOD' && (github.event_name != 'workflow_dispatch' || github.ref == 'refs/heads/main')
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Generate GitHub App token
|
||||
id: app-token
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
app-id: ${{ secrets.RELEASE_APP_ID }}
|
||||
private-key: ${{ secrets.RELEASE_APP_PRIVATE_KEY }}
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ steps.app-token.outputs.token || secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ".nvmrc"
|
||||
cache: "npm"
|
||||
|
||||
- name: Ensure trusted publishing toolchain
|
||||
run: |
|
||||
# npm trusted publishing requires Node >= 22.14.0 and npm >= 11.5.1.
|
||||
npm install --global npm@11.6.2
|
||||
|
||||
- name: Configure git user
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
|
||||
- name: Derive next prerelease version
|
||||
if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.channel == 'next')
|
||||
run: |
|
||||
NEXT_VER=$(npm view bmad-method@next version 2>/dev/null || echo "")
|
||||
LATEST_VER=$(npm view bmad-method@latest version 2>/dev/null || echo "")
|
||||
|
||||
# Determine the best base version for the next prerelease.
|
||||
BASE=$(node -e "
|
||||
const semver = require('semver');
|
||||
const next = process.argv[1] || null;
|
||||
const latest = process.argv[2] || null;
|
||||
if (!next && !latest) process.exit(0);
|
||||
if (!next) { console.log(latest); process.exit(0); }
|
||||
if (!latest) { console.log(next); process.exit(0); }
|
||||
const nextBase = next.replace(/-next\.\d+$/, '');
|
||||
console.log(semver.gt(latest, nextBase) ? latest : next);
|
||||
" "$NEXT_VER" "$LATEST_VER")
|
||||
|
||||
if [ -n "$BASE" ]; then
|
||||
npm version "$BASE" --no-git-tag-version --allow-same-version
|
||||
fi
|
||||
npm version prerelease --preid=next --no-git-tag-version
|
||||
|
||||
- name: Bump stable version
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
run: 'npm version ${{ inputs.bump }} -m "chore(release): v%s [skip ci]"'
|
||||
|
||||
- name: Publish prerelease to npm
|
||||
if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.channel == 'next')
|
||||
run: npm publish --tag next --provenance
|
||||
|
||||
- name: Publish stable release to npm
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
run: npm publish --tag latest --provenance
|
||||
|
||||
- name: Push version commit and tag
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
run: git push origin main --follow-tags
|
||||
|
||||
- name: Create GitHub Release
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
run: |
|
||||
TAG="v$(node -p 'require("./package.json").version')"
|
||||
gh release create "$TAG" --generate-notes
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Notify Discord
|
||||
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
set -o pipefail
|
||||
source .github/scripts/discord-helpers.sh
|
||||
[ -z "$WEBHOOK" ] && exit 0
|
||||
|
||||
VERSION=$(node -p 'require("./package.json").version')
|
||||
RELEASE_URL="${{ github.server_url }}/${{ github.repository }}/releases/tag/v${VERSION}"
|
||||
MSG=$(printf '📦 **[bmad-method v%s released](<%s>)**' "$VERSION" "$RELEASE_URL" | esc)
|
||||
|
||||
jq -n --arg content "$MSG" '{content: $content}' | curl -sf --retry 2 -X POST "$WEBHOOK" -H "Content-Type: application/json" -d @-
|
||||
env:
|
||||
WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
|
|
@ -1,15 +1,15 @@
|
|||
name: Quality & Validation
|
||||
|
||||
# Runs comprehensive quality checks on all PRs:
|
||||
# Runs comprehensive quality checks on all PRs and pushes to main:
|
||||
# - Prettier (formatting)
|
||||
# - ESLint (linting)
|
||||
# - markdownlint (markdown quality)
|
||||
# - Schema validation (YAML structure)
|
||||
# - Agent schema tests (fixture-based validation)
|
||||
# - Installation component tests (compilation)
|
||||
# - Bundle validation (web bundle integrity)
|
||||
# Keep this workflow aligned with `npm run quality` in `package.json`.
|
||||
|
||||
"on":
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: ["**"]
|
||||
workflow_dispatch:
|
||||
|
|
@ -84,10 +84,8 @@ jobs:
|
|||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Validate documentation links
|
||||
run: npm run docs:validate-links
|
||||
|
||||
- name: Build documentation
|
||||
# Note: build-docs.mjs runs link validation internally before building
|
||||
run: npm run docs:build
|
||||
|
||||
validate:
|
||||
|
|
@ -105,14 +103,11 @@ jobs:
|
|||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Validate YAML schemas
|
||||
run: npm run validate:schemas
|
||||
|
||||
- name: Run agent schema validation tests
|
||||
run: npm run test:schemas
|
||||
|
||||
- name: Test agent compilation components
|
||||
run: npm run test:install
|
||||
|
||||
- name: Validate file references
|
||||
run: npm run validate:refs
|
||||
|
||||
- name: Validate skills
|
||||
run: npm run validate:skills
|
||||
|
|
|
|||
|
|
@ -17,9 +17,15 @@ npm-debug.log*
|
|||
# Build output
|
||||
build/*.txt
|
||||
|
||||
design-artifacts/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
|
||||
# Python
|
||||
__pycache__/
|
||||
.pytest_cache/
|
||||
|
||||
# System files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
|
@ -36,13 +42,19 @@ cursor
|
|||
CLAUDE.local.md
|
||||
.serena/
|
||||
.claude/settings.local.json
|
||||
.junie/
|
||||
.agents/
|
||||
|
||||
z*/
|
||||
!docs/zh-cn/
|
||||
|
||||
_bmad
|
||||
_bmad-output
|
||||
.clinerules
|
||||
.augment
|
||||
# .augment/ is gitignored except tracked config files — add exceptions explicitly
|
||||
.augment/*
|
||||
!.augment/code_review_guidelines.yaml
|
||||
.codebuddy
|
||||
.crush
|
||||
.cursor
|
||||
.iflow
|
||||
|
|
@ -50,7 +62,7 @@ _bmad-output
|
|||
.qwen
|
||||
.rovodev
|
||||
.kilocodemodes
|
||||
.claude/commands
|
||||
.claude
|
||||
.codex
|
||||
.github/chatmodes
|
||||
.github/agents
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
# Development & Testing
|
||||
test/
|
||||
.husky/
|
||||
.github/
|
||||
.vscode/
|
||||
.augment/
|
||||
coverage/
|
||||
test-output/
|
||||
|
||||
# Documentation site (users access docs online)
|
||||
docs/
|
||||
website/
|
||||
|
||||
# Configuration files (development only)
|
||||
.coderabbit.yaml
|
||||
.markdownlint-cli2.yaml
|
||||
.prettierignore
|
||||
.nvmrc
|
||||
eslint.config.mjs
|
||||
prettier.config.mjs
|
||||
|
||||
# Build tools (not needed at runtime)
|
||||
tools/build-docs.mjs
|
||||
tools/fix-doc-links.js
|
||||
tools/validate-doc-links.js
|
||||
tools/validate-file-refs.js
|
||||
|
||||
# Images (branding/marketing only)
|
||||
banner-bmad-method.png
|
||||
Wordmark.png
|
||||
|
||||
# Repository metadata
|
||||
CONTRIBUTING.md
|
||||
CONTRIBUTORS.md
|
||||
SECURITY.md
|
||||
TRADEMARK.md
|
||||
CHANGELOG.md
|
||||
CNAME
|
||||
CODE_OF_CONDUCT.md
|
||||
|
|
@ -7,3 +7,6 @@ CODE_OF_CONDUCT.md
|
|||
# BMAD runtime folders (user-specific, not in repo)
|
||||
_bmad/
|
||||
_bmad*/
|
||||
|
||||
# IDE integration folders (user-specific, not in repo)
|
||||
.junie/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
# BMAD-METHOD
|
||||
|
||||
Open source framework for structured, agent-assisted software delivery.
|
||||
|
||||
## Rules
|
||||
|
||||
- Use Conventional Commits for every commit.
|
||||
- Before pushing, run `npm ci && npm run quality` on `HEAD` in the exact checkout you are about to push.
|
||||
`quality` mirrors the checks in `.github/workflows/quality.yaml`.
|
||||
|
||||
- Skill validation rules are in `tools/skill-validator.md`.
|
||||
- Deterministic skill checks run via `npm run validate:skills` (included in `quality`).
|
||||
258
CHANGELOG.md
258
CHANGELOG.md
|
|
@ -1,5 +1,260 @@
|
|||
# Changelog
|
||||
|
||||
## v6.2.0 - 2026-03-15
|
||||
|
||||
### 🎁 Highlights
|
||||
|
||||
* Fix manifest generation so BMad Builder installs correctly when a module has no agents (#1998)
|
||||
* Prototype preview of bmad-product-brief-preview skill — try `/bmad-product-brief-preview` and share feedback! (#1959)
|
||||
* All skills now use native skill directory format for improved modularity and maintainability (#1931, #1945, #1946, #1949, #1950, #1984, #1985, #1988, #1994)
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Rewrite code-review skill with sharded step-file architecture and auto-detect review intent from invocation args (#2007, #2013)
|
||||
* Add inference-based skill validator with comprehensive rules for naming, variables, paths, and invocation syntax (#1981)
|
||||
* Add REF-03 skill invocation language rule and PATH-05 skill encapsulation rule to validator (#2004)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Validation pass 2 — fix path, variable, and sequence issues across 32 files (#2008)
|
||||
* Replace broken party-mode workflow refs with skill syntax (#2000)
|
||||
* Improve bmad-help description for accurate trigger matching (#2012)
|
||||
* Point zh-cn doc links to Chinese pages instead of English (#2010)
|
||||
* Validation cleanup for bmad-quick-flow (#1997), 6 skills batch (#1996), bmad-sprint-planning (#1995), bmad-retrospective (#1993), bmad-dev-story (#1992), bmad-create-story (#1991), bmad-code-review (#1990), bmad-create-epics-and-stories (#1989), bmad-create-architecture (#1987), bmad-check-implementation-readiness (#1986), bmad-create-ux-design (#1983), bmad-create-product-brief (#1982)
|
||||
|
||||
### 🔧 Maintenance
|
||||
|
||||
* Normalize skill invocation syntax to `Invoke the skill` pattern repo-wide (#2004)
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
* Add Chinese translation for core-tools reference (#2002)
|
||||
* Update version hint, TEA module link, and HTTP→HTTPS links in Chinese README (#1922, #1921)
|
||||
|
||||
## [6.1.0] - 2026-03-12
|
||||
|
||||
### Highlights
|
||||
|
||||
* Whiteport Design Studio (WDS) module enabled in the installer
|
||||
* Support @next installation channel (`npx bmad-method@next install`) — get the latest tip of main instead of waiting for the next stable published version
|
||||
* Everything now installs as a skill — all workflows, agents, and tasks converted to markdown with SKILL.md entrypoints (not yet optimized skills, but unified format)
|
||||
* An experimental preview of the new Quick Dev is available, which will become the main Phase 4 development tool
|
||||
* Edge Case Hunter added as a parallel code review layer in Phase 4, improving code quality by exhaustively tracing branching paths and boundary conditions (#1791)
|
||||
* Documentation now available in Chinese (zh-CN) with complete translation (#1822, #1795)
|
||||
|
||||
### 💥 Breaking Changes
|
||||
|
||||
* Convert entire BMAD method to skills-based architecture with unified skill manifests (#1834)
|
||||
* Convert all core workflows from YAML+instructions to single workflow.md format
|
||||
* Migrate all remaining platforms to native Agent Skills format (#1841)
|
||||
* Remove legacy YAML/XML workflow engine plumbing (#1864)
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Add Pi coding agent as supported platform (#1854)
|
||||
* Add unified skill scanner decoupled from legacy collectors (#1859)
|
||||
* Add continuous delivery workflows for npm publishing with trusted OIDC publishing (#1872)
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* Update terminology from "commands" to "skills" across all documentation (#1850)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Fix code review removing mandatory minimum issue count that caused infinite review loops (#1913)
|
||||
* Fix silent loss of brainstorming ideas in PRD by adding reconciliation step (#1914)
|
||||
* Reduce npm tarball from 533 to 348 files (91% size reduction, 6.2 MB → 555 KB) via .npmignore (#1900)
|
||||
* Fix party-mode skill conversion review findings (#1919)
|
||||
|
||||
---
|
||||
|
||||
## [6.0.4]
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Add edge case hunter review task - new reusable review task that exhaustively traces branching paths and boundary conditions in code, reporting only unhandled gaps. Method-driven analysis complementary to adversarial review (#1790)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Fix brainstorming to not overwrite previous sessions; now prompts to continue existing brainstorming or start a new one when older brainstorming sessions are found
|
||||
* Fix installer templates - replace legacy `@` path prefixes with explicit `{project-root}` syntax for consistency (#1769)
|
||||
* Fix edge case hunter - remove zero-findings halt condition that was pressuring the LLM to hallucinate findings when none legitimately exist (#1797)
|
||||
* Fix broken docs domain references in README and GitHub issue templates (#1777)
|
||||
|
||||
---
|
||||
|
||||
## [6.0.3]
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Add bmad-os-root-cause-analysis skill for analyzing bug-fix commits and producing structured root cause analysis reports with pyramid communication format (#1741)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Fix installer to refuse installation when ancestor directory has BMAD commands, preventing duplicate command autocompletion in nested directories (#1735)
|
||||
* Fix OpenCode integration by replacing unsupported `name` frontmatter with `mode: all` and update directory names to plural form (#1764)
|
||||
* Fix CSV manifest pipeline double-escaping of quotes that was corrupting output files; switch Gemini templates to single quotes (#1746)
|
||||
* Fix workflow descriptions to use proper quotes so they format better in skill conversion and don't break yaml front matter
|
||||
* Fix workflow help task chaining by removing ambiguous "with-argument" clause that caused LLMs to misinterpret help.md as skill calls (#1740)
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* Standardize all workflow descriptions to use proper quotes to prevent breaking command or skill front matter during skill conversion
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
* Fix broken TEA hyperlinks to point to new repository URL (#1772)
|
||||
* Rebrand BMAD acronym to "Build More Architect Dreams" across documentation (#1765)
|
||||
|
||||
---
|
||||
|
||||
## [6.0.2]
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Add CodeBuddy platform support with installer configuration (#1483)
|
||||
* Add LLM audit prompt for file reference conventions - new audit tool using parallel subagents (#1720)
|
||||
* Migrate Codex installer from `.codex/prompts` to `.agents/skills` format to align with Codex CLI changes (#1729)
|
||||
* Convert review-pr and audit-file-refs tools to proper bmad-os skills with slash commands `bmad-os-review-pr` and `bmad-os-audit-file-refs` (#1732)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Fix 24 broken step references in create-architecture workflow after directory rename (#1734)
|
||||
* Fix step file path references in check-implementation-readiness workflow (#1709, #1716)
|
||||
* Fix 3 broken file references and enable strict file reference validation in CI (#1717)
|
||||
* Fix Rovo Dev integration with custom installer that generates prompts.yml manifest (#1701)
|
||||
* Fix 104 relative step file references to use standardized `{project-root}/_bmad/` paths across 68 files (#1722)
|
||||
* Fix code fence imbalance in step-03-starter.md that caused rendering issues (#1724)
|
||||
* Remove Windsurf from recommended/preferred IDEs list (#1727)
|
||||
* Fix default Codex install location from global to project for better defaults (#1698)
|
||||
* Add npx cache workaround to Quick Start for stale beta versions (#1685)
|
||||
* Add language instructions to replace placeholder text in Research overview (#1703)
|
||||
* Ignore `.junie/` IDE integration folder in git and prettier configs (#1719)
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* Update open source tool skills structure for future plugin migration
|
||||
* Standardize all workflow descriptions for skill generation with concise format and explicit trigger phrases
|
||||
* Remove `disable-model-invocation` flag from all IDE installer templates to enable workflow skill calls
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
* Elevate `bmad-help` as primary on-ramp across all documentation
|
||||
* Update workflow names with `bmad-bmm-` prefix and standardize table formatting
|
||||
* Clarify phase routing and catalog path in help task
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0]
|
||||
|
||||
V6 Stable Release! The End of Beta!
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* Add PRD workflow steps 2b (vision/differentiators) and 2c (executive summary) for more complete product requirements documentation
|
||||
* Add new `bmad uninstall` command with interactive and non-interactive modes for selective component removal
|
||||
* Add dedicated GitHub Copilot installer that generates enriched `.agent.md`, `.prompt.md` files and project configuration
|
||||
* Add TEA browser automation prerequisite prompts to guide Playwright CLI/MCP setup after configuration
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* Fix version comparison to use semantic versioning, preventing incorrect downgrade recommendations to older beta versions
|
||||
* Fix `--custom-content` flag to properly populate sources and selected files in module config
|
||||
* Fix module configuration UX messaging to show accurate completion status and improve feedback timing
|
||||
* Fix changelog URL in installer start message for proper GitHub resolution
|
||||
* Remove incorrect `mode: primary` from OpenCode agent template and restore `name` field across all templates
|
||||
* Auto-discover PRD files in validate-prd workflow to reduce manual path input
|
||||
* Fix installer non-interactive mode hanging and improve IDE configuration handling during updates
|
||||
* Fix workflow-level config.yaml copying for custom content modules
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* Remove alias variables from Phase 4 workflows, use canonical `{implementation_artifacts}` and `{planning_artifacts}`
|
||||
* Add missing `project_context` references to workflows for consistency
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
* Add post-install notes documentation for modules
|
||||
* Improve project-context documentation and fix folder structure
|
||||
* Add BMad Builder link to index for extenders
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-Beta.8]
|
||||
|
||||
**Release: February 8, 2026**
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **Non-Interactive Installation** — Full CI/CD support with 10 new CLI flags for automated deployments
|
||||
2. **Complete @clack/prompts Migration** — Unified CLI experience with consolidated installer output
|
||||
3. **CSV File Reference Validation** — Extended Layer 1 validator to catch broken workflow references in CSV files
|
||||
4. **Kiro IDE Support** — Standardized config-driven installation, replacing custom installer
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* **Non-Interactive Installation** — Added `--directory`, `--modules`, `--tools`, `--custom-content`, `--user-name`, `--communication-language`, `--document-output-language`, `--output-folder`, and `-y/--yes` flags for CI/CD automation (#1520)
|
||||
* **CSV File Reference Validation** — Extended validator to scan `.csv` files for broken workflow references, checking 501 references across 212 files (#1573)
|
||||
* **Kiro IDE Support** — Replaced broken custom installer with config-driven templates using `#[[file:...]]` syntax and `inclusion: manual` frontmatter (#1589)
|
||||
* **OpenCode Template Consolidation** — Combined split templates with `mode: primary` frontmatter for Tab-switching support, fixing agent discovery (#1556)
|
||||
* **Modules Reference Page** — Added official external modules reference documentation (#1540)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
* **Installer Streamlining** — Removed "None - Skip module installation" option, eliminated ~100 lines of dead code, and added ESM/.cjs support for module installers (#1590)
|
||||
* **CodeRabbit Workflow** — Changed `pull_request` to `pull_request_target` to fix 403 errors and enable reviews on fork PRs (#1583)
|
||||
* **Party Mode Return Protocol** — Added RETURN PROTOCOL to prevent lost-in-the-middle failures after Party Mode completes (#1569)
|
||||
* **Spacebar Toggle** — Fixed SPACE key not working in autocomplete multiselect prompts for tool/IDE selection (#1557)
|
||||
* **OpenCode Agent Routing** — Fixed agents installing to wrong directory by adding `targets` array for routing `.opencode/agent/` vs `.opencode/command/` (#1549)
|
||||
* **Technical Research Workflow** — Fixed step-05 routing to step-06 and corrected `stepsCompleted` values (#1547)
|
||||
* **Forbidden Variable Removal** — Removed `workflow_path` variable from 16 workflow step files (#1546)
|
||||
* **Kilo Installer** — Fixed YAML formatting issues by trimming activation header and converting to yaml.parse/stringify (#1537)
|
||||
* **bmad-help** — Now reads project-specific docs and respects `communication_language` setting (#1535)
|
||||
* **Cache Errors** — Removed `--prefer-offline` npm flag to prevent stale cache errors during installation (#1531)
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* **Complete @clack/prompts Migration** — Migrated 24 files from legacy libraries (ora, chalk, boxen, figlet, etc.), replaced ~100 console.log+chalk calls, consolidated installer output to single spinner, and removed 5 dependencies (#1586)
|
||||
* **Downloads Page Removal** — Removed downloads page, bundle generation, and archiver dependency in favor of GitHub's native archives (#1577)
|
||||
* **Workflow Verb Standardization** — Replaced "invoke/run" with "load and follow/load" in review workflow prompts (#1570)
|
||||
* **Documentation Language** — Renamed "brownfield" to "established projects" and flattened directory structure for accessibility (#1539)
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
* **Comprehensive Site Review** — Fixed broken directory tree diagram, corrected grammar/capitalization, added SEO descriptions, and reordered how-to guides (#1578)
|
||||
* **SEO Metadata** — Added description front matter to 9 documentation pages for search engine optimization (#1566)
|
||||
* **PR Template** — Added pull request template for consistent PR descriptions (#1554)
|
||||
* **Manual Release Cleanup** — Removed broken manual-release workflow and related scripts (#1576)
|
||||
|
||||
### 🔧 Maintenance
|
||||
|
||||
* **Dual-Mode AI Code Review** — Configured Augment Code (audit mode) and CodeRabbit (adversarial mode) for improved code quality (#1511)
|
||||
* **Package-Lock Sync** — Cleaned up 471 lines of orphaned dependencies after archiver removal (#1580)
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-Beta.7]
|
||||
|
||||
**Release: February 4, 2026**
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **Direct Workflow Invocation** — Agent workflows can now be run directly via slash commands instead of only through agent orchestration
|
||||
2. **Installer Workflow Support** — Installer now picks up `workflow-*.md` files, enabling multiple workflow files per directory
|
||||
|
||||
### 🎁 Features
|
||||
|
||||
* **Slash Command Workflow Access** — Research and PRD workflows now accessible via direct slash commands: `/domain-research`, `/market-research`, `/technical-research`, `/create-prd`, `/edit-prd`, `/validate-prd` (bd620e38, 731bee26)
|
||||
* **Version Checking** — CLI now checks npm for newer versions and displays a warning banner when updates are available (d37ee7f2)
|
||||
|
||||
### ♻️ Refactoring
|
||||
|
||||
* **Workflow File Splitting** — Split monolithic `workflow.md` files into specific `workflow-*.md` files for individual workflow invocation (bd620e38)
|
||||
* **Installer Multi-Workflow Support** — Installer manifest generator now supports `workflow-*.md` pattern, allowing multiple workflow files per directory (731bee26)
|
||||
* **Internal Skill Renaming** — Renamed internal project skills to use `bmad-os-` prefix for consistent naming (5276d58b)
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-Beta.6]
|
||||
|
||||
**Release: February 4, 2026**
|
||||
|
|
@ -178,7 +433,7 @@
|
|||
- 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
|
||||
- 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
|
||||
|
|
@ -1244,7 +1499,6 @@ Located in `src/modules/bmb/workflows/agent/data/`:
|
|||
|
||||
- **Workflow Vendoring**: Web bundler performs automatic cross-module dependency vendoring
|
||||
- **BMGD Module Extraction**: Game development split into standalone 4-phase structure
|
||||
- **Enhanced Dependency Resolution**: Better handling of web_bundle: false workflows
|
||||
- **Advanced Elicitation Fix**: Added missing CSV files to workflow bundles
|
||||
- **Claude Code Fix**: Resolved README slash command installation regression
|
||||
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ After searching, use the [feature request template](https://github.com/bmad-code
|
|||
|
||||
### Target Branch
|
||||
|
||||
Submit PRs to the `main` branch.
|
||||
Submit PRs to the `main` branch. We use trunk-based development. Every push to `main` auto-publishes to `npm` under the `next` tag. Stable releases are cut ~weekly to the `latest` tag.
|
||||
|
||||
### PR Size
|
||||
|
||||
|
|
@ -146,7 +146,15 @@ Keep messages under 72 characters. Each commit = one logical change.
|
|||
- 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`
|
||||
- Validate file references: `npm run validate:refs`
|
||||
|
||||
### File-Pattern-to-Validator Mapping
|
||||
|
||||
| File Pattern | Validator | Extraction Function |
|
||||
| ------------ | --------- | ------------------- |
|
||||
| `*.yaml`, `*.yml` | `validate-file-refs.js` | `extractYamlRefs` |
|
||||
| `*.md`, `*.xml` | `validate-file-refs.js` | `extractMarkdownRefs` |
|
||||
| `*.csv` | `validate-file-refs.js` | `extractCsvRefs` |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
128
README.md
128
README.md
|
|
@ -5,20 +5,32 @@
|
|||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
||||
**Build More Architect Dreams** — An AI-driven agile development module for the BMad Method Module Ecosystem, the best and most comprehensive Agile AI Driven Development framework that has true 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.
|
||||
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay for a gated community or courses.
|
||||
|
||||
## Why BMad?
|
||||
## Why the BMad Method?
|
||||
|
||||
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.
|
||||
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflows act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
||||
|
||||
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
|
||||
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
|
||||
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
||||
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
||||
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
|
||||
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
|
||||
- **AI Intelligent Help** — Invoke the `bmad-help` skill anytime for guidance on what's next
|
||||
- **Scale-Domain-Adaptive** — Automatically adjusts planning depth based on project complexity
|
||||
- **Structured Workflows** — Grounded in agile best practices across analysis, planning, architecture, and implementation
|
||||
- **Specialized Agents** — 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
||||
- **Party Mode** — Bring multiple agent personas into one session to collaborate and discuss
|
||||
- **Complete Lifecycle** — From brainstorming to deployment
|
||||
|
||||
[Learn more at **docs.bmad-method.org**](https://docs.bmad-method.org)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 What's Next for BMad?
|
||||
|
||||
**V6 is here and we're just getting started!** The BMad Method is evolving rapidly with optimizations including Cross Platform Agent Team and Sub Agent inclusion, Skills Architecture, BMad Builder v1, Dev Loop Automation, and so much more in the works.
|
||||
|
||||
**[📍 Check out the complete Roadmap →](https://docs.bmad-method.org/roadmap/)**
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
|
@ -28,95 +40,41 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
|||
npx bmad-method install
|
||||
```
|
||||
|
||||
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
||||
> Want the newest prerelease build? Use `npx bmad-method@next install`. Expect higher churn than the default install.
|
||||
|
||||
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
||||
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, etc.) in your project folder.
|
||||
|
||||
- `/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`
|
||||
**Non-Interactive Installation** (for CI/CD):
|
||||
|
||||
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!
|
||||
```bash
|
||||
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
||||
```
|
||||
|
||||
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.
|
||||
[See all installation options](https://docs.bmad-method.org/how-to/non-interactive-installation/)
|
||||
|
||||
### 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/).
|
||||
> **Not sure what to do?** Ask `bmad-help` — it tells you exactly what's next and what's optional. You can also ask questions like `bmad-help I just finished the architecture, what do I do next?`
|
||||
|
||||
## Modules
|
||||
|
||||
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 extends with official modules for specialized domains. Available during installation or anytime after.
|
||||
|
||||
| Module | GitHub | NPM | Purpose |
|
||||
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
||||
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
||||
| **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
|
||||
|
||||
---
|
||||
| Module | Purpose |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
||||
| **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | Core framework with 34+ workflows |
|
||||
| **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | Create custom BMad agents and workflows |
|
||||
| **[Test Architect (TEA)](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)** | Risk-based test strategy and automation |
|
||||
| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | Game development workflows (Unity, Unreal, Godot) |
|
||||
| **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | Innovation, brainstorming, design thinking |
|
||||
|
||||
## Documentation
|
||||
|
||||
**[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
|
||||
[BMad Method Docs Site](https://docs.bmad-method.org) — Tutorials, guides, concepts, and reference
|
||||
|
||||
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
||||
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
||||
- [Test Architect Migration Guide](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/migration/) — Upgrading from BMM-embedded TEA
|
||||
**Quick links:**
|
||||
- [Getting Started Tutorial](https://docs.bmad-method.org/tutorials/getting-started/)
|
||||
- [Upgrading from Previous Versions](https://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
||||
- [Test Architect Documentation](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
|
||||
### For v4 Users
|
||||
|
||||
- **[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
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,121 @@
|
|||

|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
[](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**突破性敏捷 AI 驱动开发方法** — 简称 “BMAD 方法论” ,BMAD方法论是由多个模块生态构成的AI驱动敏捷开发模块系统,这是最佳且最全面的敏捷 AI 驱动开发框架,具备真正的规模自适应人工智能,可适应快速开发,适应企业规模化开发。
|
||||
|
||||
**100% 免费且开源。** 无付费。无内容门槛。无封闭 Discord。我们赋能每个人,我们将为全球现在在人工智能领域发展的普通人提供公平的学习机会。
|
||||
|
||||
## 为什么选择 BMad 方法?
|
||||
|
||||
传统 AI 工具替你思考,产生平庸的结果。BMad 智能体和辅助工作流充当专家协作者,引导你通过结构化流程,与 AI 的合作发挥最佳思维,产出最有效优秀的结果。
|
||||
|
||||
- **AI 智能帮助** — 随时使用 `bmad-help` 获取下一步指导
|
||||
- **规模-领域自适应** — 根据项目复杂度自动调整规划深度
|
||||
- **结构化工作流** — 基于分析、规划、架构和实施的敏捷最佳实践
|
||||
- **专业智能体** — 12+ 领域专家(PM、架构师、开发者、UX、Scrum Master 等)
|
||||
- **派对模式** — 将多个智能体角色带入一个会话进行协作和讨论
|
||||
- **完整生命周期** — 从想法开始(头脑风暴)到部署发布
|
||||
|
||||
[在 **docs.bmad-method.org** 了解更多](https://docs.bmad-method.org/zh-cn/)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 BMad 的下一步是什么?
|
||||
|
||||
**V6 已到来,我们才刚刚开始!** BMad 方法正在快速发展,包括跨平台智能体团队和子智能体集成、技能架构、BMad Builder v1、开发循环自动化等优化,以及更多正在开发中的功能。
|
||||
|
||||
**[📍 查看完整路线图 →](https://docs.bmad-method.org/zh-cn/roadmap/)**
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
**先决条件**:[Node.js](https://nodejs.org) v20+
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
> 想要最新的预发布版本?使用 `npx bmad-method@next install`。相比默认安装,可能会有更多变更。
|
||||
|
||||
按照安装程序提示操作,然后在项目文件夹中打开你的 AI IDE(Claude Code、Cursor 等)。
|
||||
|
||||
**非交互式安装**(用于 CI/CD):
|
||||
|
||||
```bash
|
||||
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
||||
```
|
||||
|
||||
[查看非交互式安装选项](https://docs.bmad-method.org/zh-cn/how-to/non-interactive-installation/)
|
||||
|
||||
> **不确定该做什么?** 运行 `bmad-help` — 它会准确告诉你下一步做什么以及什么是可选的。你也可以问诸如 `bmad-help 我刚刚完成了架构设计,接下来该做什么?` 之类的问题。
|
||||
|
||||
## 模块
|
||||
|
||||
BMad 方法通过官方模块扩展到专业领域。可在安装期间或之后的任何时间使用。
|
||||
|
||||
| Module | Purpose |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
||||
| **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | 包含 34+ 工作流的核心框架 |
|
||||
| **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | 创建自定义 BMad 智能体和工作流 |
|
||||
| **[Test Architect (TEA)](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)** | 基于风险的测试策略和自动化 |
|
||||
| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | 游戏开发工作流(Unity、Unreal、Godot) |
|
||||
| **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | 创新、头脑风暴、设计思维 |
|
||||
|
||||
## 文档
|
||||
|
||||
[BMad 方法文档站点](https://docs.bmad-method.org/zh-cn/) — 教程、指南、概念和参考
|
||||
|
||||
**快速链接:**
|
||||
- [入门教程](https://docs.bmad-method.org/zh-cn/tutorials/getting-started/)
|
||||
- [从先前版本升级](https://docs.bmad-method.org/zh-cn/how-to/upgrade-to-v6/)
|
||||
- [测试架构师文档(英文)](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
|
||||
|
||||
## 社区
|
||||
|
||||
- [Discord](https://discord.gg/gk8jAdXWmj) — 获取帮助、分享想法、协作
|
||||
- [在 YouTube 上订阅](https://www.youtube.com/@BMadCode) — 教程、大师课和播客(2025 年 2 月推出)
|
||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — 错误报告和功能请求
|
||||
- [讨论](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — 社区对话
|
||||
|
||||
## 支持 BMad
|
||||
|
||||
BMad 对每个人都是免费的 — 并且永远如此。如果你想支持开发:
|
||||
|
||||
- ⭐ 请点击此页面右上角附近的项目星标图标
|
||||
- ☕ [请我喝咖啡](https://buymeacoffee.com/bmad) — 为开发提供动力
|
||||
- 🏢 企业赞助 — 在 Discord 上私信
|
||||
- 🎤 演讲与媒体 — 可参加会议、播客、采访(在 Discord 上联系 BM)
|
||||
|
||||
## 贡献
|
||||
|
||||
我们欢迎贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解指南。
|
||||
|
||||
## 许可证
|
||||
|
||||
MIT 许可证 — 详见 [LICENSE](LICENSE)。
|
||||
|
||||
---
|
||||
|
||||
**BMad** 和 **BMAD-METHOD** 是 BMad Code, LLC 的商标。详见 [TRADEMARK.md](TRADEMARK.md)。
|
||||
|
||||
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
||||
|
||||
请参阅 [CONTRIBUTORS.md](CONTRIBUTORS.md) 了解贡献者信息。
|
||||
|
||||
---
|
||||
## 术语说明
|
||||
|
||||
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
||||
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
|
||||
- **CI/CD**:持续集成/持续部署。一种自动化软件开发实践,用于频繁集成代码更改并自动部署。
|
||||
- **IDE**:集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。
|
||||
- **PM**:产品经理。负责产品规划、需求管理和团队协调的角色。
|
||||
- **UX**:用户体验。指用户在使用产品或服务过程中的整体感受和交互体验。
|
||||
- **Scrum Master**:Scrum 主管。敏捷开发 Scrum 框架中的角色,负责促进团队遵循 Scrum 流程。
|
||||
- **PRD**:产品需求文档。详细描述产品功能、需求和规格的文档。
|
||||
|
|
@ -6,4 +6,4 @@ template: splash
|
|||
|
||||
The page you're looking for doesn't exist or has been moved.
|
||||
|
||||
[Return to Home](/docs/index.md)
|
||||
[Return to Home](./index.md)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: "Documentation Style Guide"
|
||||
description: Project-specific documentation conventions based on Google style and Diataxis structure
|
||||
---
|
||||
|
||||
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.
|
||||
|
|
@ -58,13 +59,13 @@ Critical warnings only — data loss, security issues
|
|||
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
||||
```
|
||||
|
||||
**Commands:**
|
||||
**Skills:**
|
||||
|
||||
```md
|
||||
| Command | Agent | Purpose |
|
||||
| Skill | Agent | Purpose |
|
||||
| ------------ | ------- | ------------------------------------ |
|
||||
| `brainstorm` | Analyst | Brainstorm a new project |
|
||||
| `prd` | PM | Create Product Requirements Document |
|
||||
| `bmad-brainstorming` | Analyst | Brainstorm a new project |
|
||||
| `bmad-create-prd` | PM | Create Product Requirements Document |
|
||||
```
|
||||
|
||||
## Folder Structure Blocks
|
||||
|
|
@ -76,8 +77,10 @@ Show in "What You've Accomplished" sections:
|
|||
your-project/
|
||||
├── _bmad/ # BMad configuration
|
||||
├── _bmad-output/
|
||||
│ ├── PRD.md # Your requirements document
|
||||
│ └── bmm-workflow-status.yaml # Progress tracking
|
||||
│ ├── planning-artifacts/
|
||||
│ │ └── PRD.md # Your requirements document
|
||||
│ ├── implementation-artifacts/
|
||||
│ └── project-context.md # Implementation rules (optional)
|
||||
└── ...
|
||||
```
|
||||
````
|
||||
|
|
@ -96,7 +99,7 @@ your-project/
|
|||
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)
|
||||
12. Quick Reference (skills table)
|
||||
13. Common Questions (FAQ format)
|
||||
14. Getting Help (community links)
|
||||
15. Key Takeaways (tip admonition)
|
||||
|
|
@ -108,7 +111,7 @@ your-project/
|
|||
- [ ] "What You'll Learn" section present
|
||||
- [ ] Prerequisites in admonition
|
||||
- [ ] Quick Path TL;DR admonition at top
|
||||
- [ ] Tables for phases, commands, agents
|
||||
- [ ] Tables for phases, skills, agents
|
||||
- [ ] "What You've Accomplished" section present
|
||||
- [ ] Quick Reference table present
|
||||
- [ ] Common Questions section present
|
||||
|
|
@ -142,12 +145,12 @@ your-project/
|
|||
### Types
|
||||
|
||||
| Type | Example |
|
||||
| ----------------- | ---------------------------- |
|
||||
| ----------------- | ----------------------------- |
|
||||
| **Index/Landing** | `core-concepts/index.md` |
|
||||
| **Concept** | `what-are-agents.md` |
|
||||
| **Feature** | `quick-flow.md` |
|
||||
| **Feature** | `quick-dev.md` |
|
||||
| **Philosophy** | `why-solutioning-matters.md` |
|
||||
| **FAQ** | `brownfield-faq.md` |
|
||||
| **FAQ** | `established-projects-faq.md` |
|
||||
|
||||
### General Template
|
||||
|
||||
|
|
@ -240,7 +243,7 @@ your-project/
|
|||
1. Title + Hook
|
||||
2. Items (## for each item)
|
||||
- Brief description (one sentence)
|
||||
- **Commands:** or **Key Info:** as flat list
|
||||
- **Skills:** or **Key Info:** as flat list
|
||||
3. Universal/Shared (## section) (optional)
|
||||
```
|
||||
|
||||
|
|
@ -249,7 +252,7 @@ your-project/
|
|||
```text
|
||||
1. Title + Hook (one sentence purpose)
|
||||
2. Quick Facts (optional note admonition)
|
||||
- Module, Command, Input, Output as list
|
||||
- Module, Skill, Input, Output as list
|
||||
3. Purpose/Overview (## section)
|
||||
4. How to Invoke (code block)
|
||||
5. Key Sections (## for each aspect)
|
||||
|
|
@ -277,7 +280,7 @@ your-project/
|
|||
- Diagram or table showing organization
|
||||
3. Major Sections (## for each phase/category)
|
||||
- Items (### for each item)
|
||||
- Standardized fields: Command, Agent, Input, Output, Description
|
||||
- Standardized fields: Skill, Agent, Input, Output, Description
|
||||
4. Next Steps (optional)
|
||||
```
|
||||
|
||||
|
|
@ -325,7 +328,7 @@ Add italic context at definition start for limited-scope terms:
|
|||
- `*BMad Method/Enterprise.*`
|
||||
- `*Phase N.*`
|
||||
- `*BMGD.*`
|
||||
- `*Brownfield.*`
|
||||
- `*Established projects.*`
|
||||
|
||||
### Glossary Checklist
|
||||
|
||||
|
|
@ -350,7 +353,7 @@ Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
|||
|
||||
### Can I change my plan later?
|
||||
|
||||
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
||||
Yes. The SM agent has a `bmad-correct-course` workflow for handling scope changes.
|
||||
|
||||
**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
|
||||
```
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 126 KiB |
|
|
@ -1,375 +0,0 @@
|
|||
---
|
||||
title: "Game Types Reference"
|
||||
draft: true
|
||||
---
|
||||
|
||||
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 |
|
||||
|
|
@ -1,113 +0,0 @@
|
|||
---
|
||||
title: "BMGD Quick Guide"
|
||||
description: Quick reference for BMad Game Dev Studio
|
||||
draft: true
|
||||
---
|
||||
|
||||

|
||||
|
||||
# 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)
|
||||
|
|
@ -1,161 +0,0 @@
|
|||
---
|
||||
title: "Quick Flow Workflows"
|
||||
draft: true
|
||||
---
|
||||
|
||||
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.
|
Before Width: | Height: | Size: 118 KiB |
|
|
@ -1,74 +0,0 @@
|
|||
---
|
||||
title: Downloads
|
||||
---
|
||||
|
||||
Download BMad Method resources for offline use, AI training, or integration.
|
||||
|
||||
## Source Bundles
|
||||
|
||||
Download these from the `downloads/` folder on the documentation site.
|
||||
|
||||
| File | Description |
|
||||
| ------------------ | ------------------------------- |
|
||||
| `bmad-sources.zip` | Complete BMad source files |
|
||||
| `bmad-prompts.zip` | Agent and workflow prompts only |
|
||||
|
||||
## LLM-Optimized Files
|
||||
|
||||
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs.
|
||||
|
||||
| File | Description | Use Case |
|
||||
| --------------- | ----------------------------------- | -------------------------- |
|
||||
| `llms.txt` | Documentation index with summaries | Quick overview, navigation |
|
||||
| `llms-full.txt` | Complete documentation concatenated | Full context loading |
|
||||
|
||||
### Using with LLMs
|
||||
|
||||
**Claude Projects:**
|
||||
```
|
||||
Upload llms-full.txt as project knowledge
|
||||
```
|
||||
|
||||
**ChatGPT:**
|
||||
```
|
||||
Paste llms.txt for navigation, or sections from llms-full.txt as needed
|
||||
```
|
||||
|
||||
**API Usage:**
|
||||
```python
|
||||
import requests
|
||||
docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
|
||||
# Include in your system prompt or context
|
||||
```
|
||||
|
||||
## Installation Options
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
[More details](/docs/how-to/install-bmad.md)
|
||||
|
||||
## Version Information
|
||||
|
||||
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
|
||||
- **Release Notes:** Available on [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases)
|
||||
|
||||
## API Access
|
||||
|
||||
For programmatic access to BMad documentation:
|
||||
|
||||
```bash
|
||||
# Get documentation index
|
||||
curl https://bmad-code-org.github.io/BMAD-METHOD/llms.txt
|
||||
|
||||
# Get full documentation
|
||||
curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to improve BMad Method? Check out:
|
||||
|
||||
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
|
||||
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||
|
|
@ -1,11 +1,17 @@
|
|||
---
|
||||
title: "Advanced Elicitation"
|
||||
description: Push the LLM to rethink its work using structured reasoning methods
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
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.
|
||||
## What is Advanced Elicitation?
|
||||
|
||||
A structured second pass. Instead of asking the AI to "try again" or "make it better," you select a specific reasoning method and the AI re-examines its own output through that lens.
|
||||
|
||||
The difference matters. Vague requests produce vague revisions. A named method forces a particular angle of attack, surfacing insights that a generic retry would miss.
|
||||
|
||||
## When to Use It
|
||||
|
||||
|
|
@ -22,3 +28,22 @@ Workflows offer advanced elicitation at decision points - after the LLM has gene
|
|||
2. You pick one (or reshuffle for different options)
|
||||
3. Method is applied, improvements shown
|
||||
4. Accept or discard, repeat or continue
|
||||
|
||||
## Built-in Methods
|
||||
|
||||
Dozens of reasoning methods are available. A few examples:
|
||||
|
||||
- **Pre-mortem Analysis** - Assume the project already failed, work backward to find why
|
||||
- **First Principles Thinking** - Strip away assumptions, rebuild from ground truth
|
||||
- **Inversion** - Ask how to guarantee failure, then avoid those things
|
||||
- **Red Team vs Blue Team** - Attack your own work, then defend it
|
||||
- **Socratic Questioning** - Challenge every claim with "why?" and "how do you know?"
|
||||
- **Constraint Removal** - Drop all constraints, see what changes, add them back selectively
|
||||
- **Stakeholder Mapping** - Re-evaluate from each stakeholder's perspective
|
||||
- **Analogical Reasoning** - Find parallels in other domains and apply their lessons
|
||||
|
||||
And many more. The AI picks the most relevant options for your content - you choose which to run.
|
||||
|
||||
:::tip[Start Here]
|
||||
Pre-mortem Analysis is a good first pick for any spec or plan. It consistently finds gaps that a standard review misses.
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
---
|
||||
title: "Adversarial Review"
|
||||
description: Forced reasoning technique that prevents lazy "looks good" reviews
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Force deeper analysis by requiring problems to be found.
|
||||
|
|
@ -24,7 +26,7 @@ Normal reviews suffer from confirmation bias. You skim the work, nothing jumps o
|
|||
|
||||
## 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.
|
||||
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
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,15 @@
|
|||
---
|
||||
title: "Brainstorming"
|
||||
description: Interactive creative sessions using 60+ proven ideation techniques
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
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.
|
||||
Run `bmad-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:**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,55 +0,0 @@
|
|||
---
|
||||
title: "Brownfield Development FAQ"
|
||||
description: Common questions about brownfield development in the BMad Method
|
||||
---
|
||||
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
|
||||
|
||||
## Questions
|
||||
|
||||
- [Questions](#questions)
|
||||
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
|
||||
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
|
||||
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
||||
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
|
||||
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||
|
||||
### What is brownfield vs greenfield?
|
||||
|
||||
- **Greenfield** — New project, starting from scratch, clean slate
|
||||
- **Brownfield** — Existing project, working with established codebase and patterns
|
||||
|
||||
### Do I have to run document-project for brownfield?
|
||||
|
||||
Highly recommended, especially if:
|
||||
|
||||
- No existing documentation
|
||||
- Documentation is outdated
|
||||
- AI agents need context about existing code
|
||||
|
||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
||||
|
||||
### What if I forget to run document-project?
|
||||
|
||||
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
||||
|
||||
### Can I use Quick Spec Flow for brownfield projects?
|
||||
|
||||
Yes! Quick Spec Flow works great for brownfield. It will:
|
||||
|
||||
- Auto-detect your existing stack
|
||||
- Analyze brownfield code patterns
|
||||
- Detect conventions and ask for confirmation
|
||||
- Generate context-rich tech-spec that respects existing code
|
||||
|
||||
Perfect for bug fixes and small features in existing codebases.
|
||||
|
||||
### What if my existing code doesn't follow best practices?
|
||||
|
||||
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||
|
||||
- **Yes** → Maintain consistency with current codebase
|
||||
- **No** → Establish new standards (document why in tech-spec)
|
||||
|
||||
BMM respects your choice — it won't force modernization, but it will offer it.
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: "Established Projects FAQ"
|
||||
description: Common questions about using BMad Method on established projects
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
Quick answers to common questions about working on established projects with the BMad Method (BMM).
|
||||
|
||||
## Questions
|
||||
|
||||
- [Do I have to run document-project first?](#do-i-have-to-run-document-project-first)
|
||||
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
||||
- [Can I use Quick Flow for established projects?](#can-i-use-quick-flow-for-established-projects)
|
||||
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
||||
|
||||
### Do I have to run document-project first?
|
||||
|
||||
Highly recommended, especially if:
|
||||
|
||||
- No existing documentation
|
||||
- Documentation is outdated
|
||||
- AI agents need context about existing code
|
||||
|
||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
||||
|
||||
### What if I forget to run document-project?
|
||||
|
||||
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
||||
|
||||
### Can I use Quick Flow for established projects?
|
||||
|
||||
Yes! Quick Flow works great for established projects. It will:
|
||||
|
||||
- Auto-detect your existing stack
|
||||
- Analyze existing code patterns
|
||||
- Detect conventions and ask for confirmation
|
||||
- Generate context-rich tech-spec that respects existing code
|
||||
|
||||
Perfect for bug fixes and small features in existing codebases.
|
||||
|
||||
### What if my existing code doesn't follow best practices?
|
||||
|
||||
Quick Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||
|
||||
- **Yes** → Maintain consistency with current codebase
|
||||
- **No** → Establish new standards (document why in tech-spec)
|
||||
|
||||
BMM respects your choice — it won't force modernization, but it will offer it.
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
|
|
@ -1,13 +1,15 @@
|
|||
---
|
||||
title: "Party Mode"
|
||||
description: Multi-agent collaboration - get all your AI agents in one conversation
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
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.
|
||||
Run `bmad-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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
---
|
||||
title: "Preventing Agent Conflicts"
|
||||
description: How architecture prevents conflicts when multiple agents implement a system
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
||||
|
|
@ -69,7 +71,7 @@ Explicit documentation of:
|
|||
|
||||
Think of architecture as the shared context that all agents read before implementing:
|
||||
|
||||
```
|
||||
```text
|
||||
PRD: "What to build"
|
||||
↓
|
||||
Architecture: "How to build it"
|
||||
|
|
@ -106,5 +108,5 @@ Common decisions that prevent conflicts:
|
|||
- Document decisions that cross epic boundaries
|
||||
- Focus on conflict-prone areas
|
||||
- Update architecture as you learn
|
||||
- Use `correct-course` for significant changes
|
||||
- Use `bmad-correct-course` for significant changes
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -0,0 +1,157 @@
|
|||
---
|
||||
title: "Project Context"
|
||||
description: How project-context.md guides AI agents with your project's rules and preferences
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
The `project-context.md` file is your project's implementation guide for AI agents. Similar to a "constitution" in other development systems, it captures the rules, patterns, and preferences that ensure consistent code generation across all workflows.
|
||||
|
||||
## What It Does
|
||||
|
||||
AI agents make implementation decisions constantly — which patterns to follow, how to structure code, what conventions to use. Without clear guidance, they may:
|
||||
- Follow generic best practices that don't match your codebase
|
||||
- Make inconsistent decisions across different stories
|
||||
- Miss project-specific requirements or constraints
|
||||
|
||||
The `project-context.md` file solves this by documenting what agents need to know in a concise, LLM-optimized format.
|
||||
|
||||
## How It Works
|
||||
|
||||
Every implementation workflow automatically loads `project-context.md` if it exists. The architect workflow also loads it to respect your technical preferences when designing the architecture.
|
||||
|
||||
**Loaded by these workflows:**
|
||||
- `bmad-create-architecture` — respects technical preferences during solutioning
|
||||
- `bmad-create-story` — informs story creation with project patterns
|
||||
- `bmad-dev-story` — guides implementation decisions
|
||||
- `bmad-code-review` — validates against project standards
|
||||
- `bmad-quick-dev` — applies patterns when implementing tech-specs
|
||||
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — provides project-wide context
|
||||
|
||||
## When to Create It
|
||||
|
||||
The `project-context.md` file is useful at any stage of a project:
|
||||
|
||||
| Scenario | When to Create | Purpose |
|
||||
|----------|----------------|---------|
|
||||
| **New project, before architecture** | Manually, before `bmad-create-architecture` | Document your technical preferences so the architect respects them |
|
||||
| **New project, after architecture** | Via `bmad-generate-project-context` or manually | Capture architecture decisions for implementation agents |
|
||||
| **Existing project** | Via `bmad-generate-project-context` | Discover existing patterns so agents follow established conventions |
|
||||
| **Quick Flow project** | Before or during `bmad-quick-dev` | Ensure quick implementation respects your patterns |
|
||||
|
||||
:::tip[Recommended]
|
||||
For new projects, create it manually before architecture if you have strong technical preferences. Otherwise, generate it after architecture to capture those decisions.
|
||||
:::
|
||||
|
||||
## What Goes In It
|
||||
|
||||
The file has two main sections:
|
||||
|
||||
### Technology Stack & Versions
|
||||
|
||||
Documents the frameworks, languages, and tools your project uses with specific versions:
|
||||
|
||||
```markdown
|
||||
## Technology Stack & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State: Zustand (not Redux)
|
||||
- Testing: Vitest, Playwright, MSW
|
||||
- Styling: Tailwind CSS with custom design tokens
|
||||
```
|
||||
|
||||
### Critical Implementation Rules
|
||||
|
||||
Documents patterns and conventions that agents might otherwise miss:
|
||||
|
||||
```markdown
|
||||
## Critical Implementation Rules
|
||||
|
||||
**TypeScript Configuration:**
|
||||
- Strict mode enabled — no `any` types without explicit approval
|
||||
- Use `interface` for public APIs, `type` for unions/intersections
|
||||
|
||||
**Code Organization:**
|
||||
- Components in `/src/components/` with co-located `.test.tsx`
|
||||
- Utilities in `/src/lib/` for reusable pure functions
|
||||
- API calls use the `apiClient` singleton — never fetch directly
|
||||
|
||||
**Testing Patterns:**
|
||||
- Unit tests focus on business logic, not implementation details
|
||||
- Integration tests use MSW to mock API responses
|
||||
- E2E tests cover critical user journeys only
|
||||
|
||||
**Framework-Specific:**
|
||||
- All async operations use the `handleError` wrapper for consistent error handling
|
||||
- Feature flags accessed via `featureFlag()` from `@/lib/flags`
|
||||
- New routes follow the file-based routing pattern in `/src/app/`
|
||||
```
|
||||
|
||||
Focus on what's **unobvious** — things agents might not infer from reading code snippets. Don't document standard practices that apply universally.
|
||||
|
||||
## Creating the File
|
||||
|
||||
You have three options:
|
||||
|
||||
### Manual Creation
|
||||
|
||||
Create the file at `_bmad-output/project-context.md` and add your rules:
|
||||
|
||||
```bash
|
||||
# In your project root
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Edit it with your technology stack and implementation rules. The architect and implementation workflows will automatically find and load it.
|
||||
|
||||
### Generate After Architecture
|
||||
|
||||
Run the `bmad-generate-project-context` workflow after completing your architecture:
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
This scans your architecture document and project files to generate a context file capturing the decisions made.
|
||||
|
||||
### Generate for Existing Projects
|
||||
|
||||
For existing projects, run `bmad-generate-project-context` to discover existing patterns:
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
||||
|
||||
## Why It Matters
|
||||
|
||||
Without `project-context.md`, agents make assumptions that may not match your project:
|
||||
|
||||
| Without Context | With Context |
|
||||
|----------------|--------------|
|
||||
| Uses generic patterns | Follows your established conventions |
|
||||
| Inconsistent style across stories | Consistent implementation |
|
||||
| May miss project-specific constraints | Respects all technical requirements |
|
||||
| Each agent decides independently | All agents align with same rules |
|
||||
|
||||
This is especially important for:
|
||||
- **Quick Flow** — skips PRD and architecture, so context file fills the gap
|
||||
- **Team projects** — ensures all agents follow the same standards
|
||||
- **Existing projects** — prevents breaking established patterns
|
||||
|
||||
## Editing and Updating
|
||||
|
||||
The `project-context.md` file is a living document. Update it when:
|
||||
|
||||
- Architecture decisions change
|
||||
- New conventions are established
|
||||
- Patterns evolve during implementation
|
||||
- You identify gaps from agent behavior
|
||||
|
||||
You can edit it manually at any time, or re-run `bmad-generate-project-context` to update it after significant changes.
|
||||
|
||||
:::note[File Location]
|
||||
The default location is `_bmad-output/project-context.md`. Workflows search for it there, and also check `**/project-context.md` anywhere in your project.
|
||||
:::
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
title: "Quick Dev"
|
||||
description: Reduce human-in-the-loop friction without giving up the checkpoints that protect output quality
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Intent in, code changes out, with as few human-in-the-loop turns as possible — without sacrificing quality.
|
||||
|
||||
It lets the model run longer between checkpoints, then brings the human back only when the task cannot safely continue without human judgment or when it is time to review the end result.
|
||||
|
||||

|
||||
|
||||
## Why This Exists
|
||||
|
||||
Human-in-the-loop turns are necessary and expensive.
|
||||
|
||||
Current LLMs still fail in predictable ways: they misread intent, fill gaps with confident guesses, drift into unrelated work, and generate noisy review output. At the same time, constant human intervention limits development velocity. Human attention is the bottleneck.
|
||||
|
||||
`bmad-quick-dev` rebalances that tradeoff. It trusts the model to run unsupervised for longer stretches, but only after the workflow has created a strong enough boundary to make that safe.
|
||||
|
||||
## The Core Design
|
||||
|
||||
### 1. Compress intent first
|
||||
|
||||
The workflow starts by having the human and the model compress the request into one coherent goal. The input can begin as a rough expression of intent, but before the workflow runs autonomously it has to become small enough, clear enough, and contradiction-free enough to execute.
|
||||
|
||||
Intent can come in many forms: a couple of phrases, a bug tracker link, output from plan mode, text copied from a chat session, or even a story number from BMAD's own `epics.md`. In that last case, the workflow will not understand BMAD story-tracking semantics, but it can still take the story itself and run with it.
|
||||
|
||||
This workflow does not eliminate human control. It relocates it to a small number of high-value moments:
|
||||
|
||||
- **Intent clarification** - turning a messy request into one coherent goal without hidden contradictions
|
||||
- **Spec approval** - confirming that the frozen understanding is the right thing to build
|
||||
- **Review of the final product** - the primary checkpoint, where the human decides whether the result is acceptable at the end
|
||||
|
||||
### 2. Route to the smallest safe path
|
||||
|
||||
Once the goal is clear, the workflow decides whether this is a true one-shot change or whether it needs the fuller path. Small, zero-blast-radius changes can go straight to implementation. Everything else goes through planning so the model has a stronger boundary before it runs longer on its own.
|
||||
|
||||
### 3. Run longer with less supervision
|
||||
|
||||
After that routing decision, the model can carry more of the work on its own. On the fuller path, the approved spec becomes the boundary the model executes against with less supervision, which is the whole point of the design.
|
||||
|
||||
### 4. Diagnose failure at the right layer
|
||||
|
||||
If the implementation is wrong because the intent was wrong, patching the code is the wrong fix. If the code is wrong because the spec was weak, patching the diff is also the wrong fix. The workflow is designed to diagnose where the failure entered the system, go back to that layer, and regenerate from there.
|
||||
|
||||
Review findings are used to decide whether the problem came from intent, spec generation, or local implementation. Only truly local problems get patched locally.
|
||||
|
||||
### 5. Bring the human back only when needed
|
||||
|
||||
The intent interview is human-in-the-loop, but it is not the same kind of interruption as a recurring checkpoint. The workflow tries to keep those recurring checkpoints to a minimum. After the initial shaping of intent, the human mainly comes back when the workflow cannot safely continue without judgment and at the end, when it is time to review the result.
|
||||
|
||||
- **Intent-gap resolution** - stepping back in when review proves the workflow could not safely infer what was meant
|
||||
|
||||
Everything else is a candidate for longer autonomous execution. That tradeoff is deliberate. Older patterns spend more human attention on continuous supervision. Quick Dev spends more trust on the model, but saves human attention for the moments where human reasoning has the highest leverage.
|
||||
|
||||
## Why the Review System Matters
|
||||
|
||||
The review phase is not just there to find bugs. It is there to route correction without destroying momentum.
|
||||
|
||||
This workflow works best on a platform that can spawn subagents, or at least invoke another LLM through the command line and wait for a result. If your platform does not support that natively, you can add a skill to do it. Context-free subagents are a cornerstone of the review design.
|
||||
|
||||
Agentic reviews often go wrong in two ways:
|
||||
|
||||
- They generate too many findings, forcing the human to sift through noise.
|
||||
- They derail the current change by surfacing unrelated issues and turning every run into an ad hoc cleanup project.
|
||||
|
||||
Quick Dev addresses both by treating review as triage.
|
||||
|
||||
Some findings belong to the current change. Some do not. If a finding is incidental rather than causally tied to the current work, the workflow can defer it instead of forcing the human to handle it immediately. That keeps the run focused and prevents random tangents from consuming the budget of attention.
|
||||
|
||||
That triage will sometimes be imperfect. That is acceptable. It is usually better to misjudge some findings than to flood the human with thousands of low-value review comments. The system is optimizing for signal quality, not exhaustive recall.
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
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
|
||||
|
|
@ -1,6 +1,8 @@
|
|||
---
|
||||
title: "Why Solutioning Matters"
|
||||
description: Understanding why the solutioning phase is critical for multi-epic projects
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -8,7 +10,7 @@ Phase 3 (Solutioning) translates **what** to build (from Planning) into **how**
|
|||
|
||||
## The Problem Without Solutioning
|
||||
|
||||
```
|
||||
```text
|
||||
Agent 1 implements Epic 1 using REST API
|
||||
Agent 2 implements Epic 2 using GraphQL
|
||||
Result: Inconsistent API design, integration nightmare
|
||||
|
|
@ -18,7 +20,7 @@ When multiple agents implement different parts of a system without shared archit
|
|||
|
||||
## The Solution With Solutioning
|
||||
|
||||
```
|
||||
```text
|
||||
architecture workflow decides: "Use GraphQL for all APIs"
|
||||
All agents follow architecture decisions
|
||||
Result: Consistent implementation, no conflicts
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Page introuvable
|
||||
template: splash
|
||||
---
|
||||
|
||||
La page que vous recherchez n'existe pas ou a été déplacée.
|
||||
|
||||
[Retour à l'accueil](/fr/index.md)
|
||||
|
|
@ -0,0 +1,370 @@
|
|||
---
|
||||
title: "Guide de style de la documentation"
|
||||
description: Conventions de documentation spécifiques au projet, basées sur le style Google et la structure Diataxis
|
||||
---
|
||||
|
||||
Ce projet suit le [Guide de style de documentation pour développeurs Google](https://developers.google.com/style) et utilise [Diataxis](https://diataxis.fr/) pour structurer le contenu. Seules les conventions spécifiques au projet sont présentées ci-dessous.
|
||||
|
||||
## Règles spécifiques au projet
|
||||
|
||||
| Règle | Spécification |
|
||||
| --------------------------------------- | ------------------------------------------------------ |
|
||||
| Pas de règles horizontales (`---`) | Perturbe le flux de lecture des fragments |
|
||||
| Pas de titres `####` | Utiliser du texte en gras ou des admonitions |
|
||||
| Pas de sections « Related » ou « Next: » | La barre latérale gère la navigation |
|
||||
| Pas de listes profondément imbriquées | Diviser en sections à la place |
|
||||
| Pas de blocs de code pour non-code | Utiliser des admonitions pour les exemples de dialogue |
|
||||
| Pas de paragraphes en gras pour les appels | Utiliser des admonitions à la place |
|
||||
| 1-2 admonitions max par section | Les tutoriels permettent 3-4 par section majeure |
|
||||
| Cellules de tableau / éléments de liste | 1-2 phrases maximum |
|
||||
| Budget de titres | 8-12 `##` par doc ; 2-3 `###` par section |
|
||||
|
||||
## Admonitions (Syntaxe Starlight)
|
||||
|
||||
```md
|
||||
:::tip[Titre]
|
||||
Raccourcis, bonnes pratiques
|
||||
:::
|
||||
|
||||
:::note[Titre]
|
||||
Contexte, définitions, exemples, prérequis
|
||||
:::
|
||||
|
||||
:::caution[Titre]
|
||||
Mises en garde, problèmes potentiels
|
||||
:::
|
||||
|
||||
:::danger[Titre]
|
||||
Avertissements critiques uniquement — perte de données, problèmes de sécurité
|
||||
:::
|
||||
```
|
||||
|
||||
### Utilisations standards
|
||||
|
||||
| Admonition | Usage |
|
||||
| -------------------------- | ---------------------------------------- |
|
||||
| `:::note[Pré-requis]` | Dépendances avant de commencer |
|
||||
| `:::tip[Chemin rapide]` | Résumé TL;DR en haut du document |
|
||||
| `:::caution[Important]` | Mises en garde critiques |
|
||||
| `:::note[Exemple]` | Exemples de commandes/réponses |
|
||||
|
||||
## Formats de tableau standards
|
||||
|
||||
**Phases :**
|
||||
|
||||
```md
|
||||
| Phase | Nom | Ce qui se passe |
|
||||
| ----- | ---------- | --------------------------------------------------- |
|
||||
| 1 | Analyse | Brainstorm, recherche *(optionnel)* |
|
||||
| 2 | Planification | Exigences — PRD ou spécification technique *(requis)* |
|
||||
```
|
||||
|
||||
**Skills :**
|
||||
|
||||
```md
|
||||
| Skill | Agent | Objectif |
|
||||
| ------------------- | ------- | ----------------------------------------------- |
|
||||
| `bmad-brainstorming` | Analyste | Brainstorming pour un nouveau projet |
|
||||
| `bmad-create-prd` | PM | Créer un document d'exigences produit |
|
||||
```
|
||||
|
||||
## Blocs de structure de dossiers
|
||||
|
||||
À afficher dans les sections "Ce que vous avez accompli" :
|
||||
|
||||
````md
|
||||
```
|
||||
votre-projet/
|
||||
├── _bmad/ # Configuration BMad
|
||||
├── _bmad-output/
|
||||
│ ├── planning-artifacts/
|
||||
│ │ └── PRD.md # Votre document d'exigences
|
||||
│ ├── implementation-artifacts/
|
||||
│ └── project-context.md # Règles d'implémentation (optionnel)
|
||||
└── ...
|
||||
```
|
||||
````
|
||||
|
||||
## Structure des tutoriels
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (1-2 phrases décrivant le résultat)
|
||||
2. Notice de version/module (admonition info ou avertissement) (optionnel)
|
||||
3. Ce que vous allez apprendre (liste à puces des résultats)
|
||||
4. Prérequis (admonition info)
|
||||
5. Chemin rapide (admonition tip - résumé TL;DR)
|
||||
6. Comprendre [Sujet] (contexte avant les étapes - tableaux pour phases/agents)
|
||||
7. Installation (optionnel)
|
||||
8. Étape 1 : [Première tâche majeure]
|
||||
9. Étape 2 : [Deuxième tâche majeure]
|
||||
10. Étape 3 : [Troisième tâche majeure]
|
||||
11. Ce que vous avez accompli (résumé + structure de dossiers)
|
||||
12. Référence rapide (tableau des compétences)
|
||||
13. Questions courantes (format FAQ)
|
||||
14. Obtenir de l'aide (liens communautaires)
|
||||
15. Points clés à retenir (admonition tip)
|
||||
```
|
||||
|
||||
### Liste de vérification des tutoriels
|
||||
|
||||
- [ ] L'accroche décrit le résultat en 1-2 phrases
|
||||
- [ ] Section "Ce que vous allez apprendre" présente
|
||||
- [ ] Prérequis dans une admonition
|
||||
- [ ] Admonition TL;DR de chemin rapide en haut
|
||||
- [ ] Tableaux pour phases, skills, agents
|
||||
- [ ] Section "Ce que vous avez accompli" présente
|
||||
- [ ] Tableau de référence rapide présent
|
||||
- [ ] Section questions courantes présente
|
||||
- [ ] Section obtenir de l'aide présente
|
||||
- [ ] Admonition points clés à retenir à la fin
|
||||
|
||||
## Structure des guides pratiques (How-To)
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (une phrase : « Utilisez le workflow `X` pour... »)
|
||||
2. Quand utiliser ce guide (liste à puces de scénarios)
|
||||
3. Quand éviter ce guide (optionnel)
|
||||
4. Prérequis (admonition note)
|
||||
5. Étapes (sous-sections ### numérotées)
|
||||
6. Ce que vous obtenez (produits de sortie/artefacts)
|
||||
7. Exemple (optionnel)
|
||||
8. Conseils (optionnel)
|
||||
9. Prochaines étapes (optionnel)
|
||||
```
|
||||
|
||||
### Liste de vérification des guides pratiques
|
||||
|
||||
- [ ] L'accroche commence par « Utilisez le workflow `X` pour... »
|
||||
- [ ] "Quand utiliser ce guide" contient 3-5 points
|
||||
- [ ] Prérequis listés
|
||||
- [ ] Les étapes sont des sous-sections `###` numérotées avec des verbes d'action
|
||||
- [ ] "Ce que vous obtenez" décrit les artefacts produits
|
||||
|
||||
## Structure des explications
|
||||
|
||||
### Types
|
||||
|
||||
| Type | Exemple |
|
||||
| ----------------------- | ------------------------------------ |
|
||||
| **Index/Page d'accueil** | `core-concepts/index.md` |
|
||||
| **Concept** | `what-are-agents.md` |
|
||||
| **Fonctionnalité** | `quick-dev.md` |
|
||||
| **Philosophie** | `why-solutioning-matters.md` |
|
||||
| **FAQ** | `established-projects-faq.md` |
|
||||
|
||||
### Modèle général
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (1-2 phrases)
|
||||
2. Vue d'ensemble/Définition (ce que c'est, pourquoi c'est important)
|
||||
3. Concepts clés (sous-sections ###)
|
||||
4. Tableau comparatif (optionnel)
|
||||
5. Quand utiliser / Quand ne pas utiliser (optionnel)
|
||||
6. Diagramme (optionnel - mermaid, 1 max par doc)
|
||||
7. Prochaines étapes (optionnel)
|
||||
```
|
||||
|
||||
### Pages d'index/d'accueil
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (une phrase)
|
||||
2. Tableau de contenu (liens avec descriptions)
|
||||
3. Pour commencer (liste numérotée)
|
||||
4. Choisissez votre parcours (optionnel - arbre de décision)
|
||||
```
|
||||
|
||||
### Explications de concepts
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (ce que c'est)
|
||||
2. Types/Catégories (sous-sections ###) (optionnel)
|
||||
3. Tableau des différences clés
|
||||
4. Composants/Parties
|
||||
5. Lequel devriez-vous utiliser ?
|
||||
6. Création/Personnalisation (lien vers les guides pratiques)
|
||||
```
|
||||
|
||||
### Explications de fonctionnalités
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (ce que cela fait)
|
||||
2. Faits rapides (optionnel - "Idéal pour :", "Temps :")
|
||||
3. Quand utiliser / Quand ne pas utiliser
|
||||
4. Comment cela fonctionne (diagramme mermaid optionnel)
|
||||
5. Avantages clés
|
||||
6. Tableau comparatif (optionnel)
|
||||
7. Quand évoluer/mettre à niveau (optionnel)
|
||||
```
|
||||
|
||||
### Documents de philosophie/justification
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (le principe)
|
||||
2. Le problème
|
||||
3. La solution
|
||||
4. Principes clés (sous-sections ###)
|
||||
5. Avantages
|
||||
6. Quand cela s'applique
|
||||
```
|
||||
|
||||
### Liste de vérification des explications
|
||||
|
||||
- [ ] L'accroche énonce ce que le document explique
|
||||
- [ ] Contenu dans des sections `##` parcourables
|
||||
- [ ] Tableaux comparatifs pour 3+ options
|
||||
- [ ] Les diagrammes ont des étiquettes claires
|
||||
- [ ] Liens vers les guides pratiques pour les questions procédurales
|
||||
- [ ] 2-3 admonitions max par document
|
||||
|
||||
## Structure des références
|
||||
|
||||
### Types
|
||||
|
||||
| Type | Exemple |
|
||||
| ----------------------- | --------------------- |
|
||||
| **Index/Page d'accueil** | `workflows/index.md` |
|
||||
| **Catalogue** | `agents/index.md` |
|
||||
| **Approfondissement** | `document-project.md` |
|
||||
| **Configuration** | `core-tasks.md` |
|
||||
| **Glossaire** | `glossary/index.md` |
|
||||
| **Complet** | `bmgd-workflows.md` |
|
||||
|
||||
### Pages d'index de référence
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (une phrase)
|
||||
2. Sections de contenu (## pour chaque catégorie)
|
||||
- Liste à puces avec liens et descriptions
|
||||
```
|
||||
|
||||
### Référence de catalogue
|
||||
|
||||
```text
|
||||
1. Titre + Accroche
|
||||
2. Éléments (## pour chaque élément)
|
||||
- Brève description (une phrase)
|
||||
- **Skills :** ou **Infos clés :** sous forme de liste simple
|
||||
3. Universel/Partagé (## section) (optionnel)
|
||||
```
|
||||
|
||||
### Référence d'approfondissement d'élément
|
||||
|
||||
```text
|
||||
1. Titre + Accroche (objectif en une phrase)
|
||||
2. Faits rapides (admonition note optionnelle)
|
||||
- Module, Skill, Entrée, Sortie sous forme de liste
|
||||
3. Objectif/Vue d'ensemble (## section)
|
||||
4. Comment invoquer (bloc de code)
|
||||
5. Sections clés (## pour chaque aspect)
|
||||
- Utiliser ### pour les sous-options
|
||||
6. Notes/Mises en garde (admonition tip ou caution)
|
||||
```
|
||||
|
||||
### Référence de configuration
|
||||
|
||||
```text
|
||||
1. Titre + Accroche
|
||||
2. Table des matières (liens de saut si 4+ éléments)
|
||||
3. Éléments (## pour chaque config/tâche)
|
||||
- **Résumé en gras** — une phrase
|
||||
- **Utilisez-le quand :** liste à puces
|
||||
- **Comment cela fonctionne :** étapes numérotées (3-5 max)
|
||||
- **Sortie :** résultat attendu (optionnel)
|
||||
```
|
||||
|
||||
### Guide de référence complet
|
||||
|
||||
```text
|
||||
1. Titre + Accroche
|
||||
2. Vue d'ensemble (## section)
|
||||
- Diagramme ou tableau montrant l'organisation
|
||||
3. Sections majeures (## pour chaque phase/catégorie)
|
||||
- Éléments (### pour chaque élément)
|
||||
- Champs standardisés : Skill, Agent, Entrée, Sortie, Description
|
||||
4. Prochaines étapes (optionnel)
|
||||
```
|
||||
|
||||
### Liste de vérification des références
|
||||
|
||||
- [ ] L'accroche énonce ce que le document référence
|
||||
- [ ] La structure correspond au type de référence
|
||||
- [ ] Les éléments utilisent une structure cohérente
|
||||
- [ ] Tableaux pour les données structurées/comparatives
|
||||
- [ ] Liens vers les documents d'explication pour la profondeur conceptuelle
|
||||
- [ ] 1-2 admonitions max
|
||||
|
||||
## Structure du glossaire
|
||||
|
||||
Starlight génère la navigation "Sur cette page" à droite à partir des titres :
|
||||
|
||||
- Catégories en tant que titres `##` — apparaissent dans la navigation à droite
|
||||
- Termes dans des tableaux — lignes compactes, pas de titres individuels
|
||||
- Pas de TOC en ligne — la barre latérale à droite gère la navigation
|
||||
|
||||
### Format de tableau
|
||||
|
||||
```md
|
||||
## Nom de catégorie
|
||||
|
||||
| Terme | Définition |
|
||||
| ------------ | --------------------------------------------------------------------------------------------- |
|
||||
| **Agent** | Personnalité IA spécialisée avec une expertise spécifique qui guide les utilisateurs dans les workflows. |
|
||||
| **Workflow** | Processus guidé en plusieurs étapes qui orchestre les activités des agents IA pour produire des livrables. |
|
||||
```
|
||||
|
||||
### Règles de définition
|
||||
|
||||
| À faire | À ne pas faire |
|
||||
| --------------------------------- | --------------------------------------------- |
|
||||
| Commencer par ce que c'est ou ce que cela fait | Commencer par « C'est... » ou « Un [terme] est... » |
|
||||
| Se limiter à 1-2 phrases | Écrire des explications de plusieurs paragraphes |
|
||||
| Mettre le nom du terme en gras dans la cellule | Utiliser du texte simple pour les termes |
|
||||
|
||||
### Marqueurs de contexte
|
||||
|
||||
Ajouter un contexte en italique au début de la définition pour les termes à portée limitée :
|
||||
|
||||
- `*Quick Dev uniquement.*`
|
||||
- `*méthode BMad/Enterprise.*`
|
||||
- `*Phase N.*`
|
||||
- `*BMGD.*`
|
||||
- `*Projets établis.*`
|
||||
|
||||
### Liste de vérification du glossaire
|
||||
|
||||
- [ ] Termes dans des tableaux, pas de titres individuels
|
||||
- [ ] Termes alphabétisés au sein des catégories
|
||||
- [ ] Définitions de 1-2 phrases
|
||||
- [ ] Marqueurs de contexte en italique
|
||||
- [ ] Noms des termes en gras dans les cellules
|
||||
- [ ] Pas de définitions « Un [terme] est... »
|
||||
|
||||
## Sections FAQ
|
||||
|
||||
```md
|
||||
## Questions
|
||||
|
||||
- [Ai-je toujours besoin d'architecture ?](#ai-je-toujours-besoin-darchitecture)
|
||||
- [Puis-je modifier mon plan plus tard ?](#puis-je-modifier-mon-plan-plus-tard)
|
||||
|
||||
### Ai-je toujours besoin d'architecture ?
|
||||
|
||||
Uniquement pour les parcours méthode BMad et Enterprise. Quick Dev passe directement à l'implémentation.
|
||||
|
||||
### Puis-je modifier mon plan plus tard ?
|
||||
|
||||
Oui. Utilisez `bmad-correct-course` pour gérer les changements de portée.
|
||||
|
||||
**Une question sans réponse ici ?** [Ouvrez une issue](...) ou posez votre question sur [Discord](...).
|
||||
```
|
||||
|
||||
## Commandes de validation
|
||||
|
||||
Avant de soumettre des modifications de documentation :
|
||||
|
||||
```bash
|
||||
npm run docs:fix-links # Prévisualiser les corrections de format de liens
|
||||
npm run docs:fix-links -- --write # Appliquer les corrections
|
||||
npm run docs:validate-links # Vérifier que les liens existent
|
||||
npm run docs:build # Vérifier l'absence d'erreurs de build
|
||||
```
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: "Élicitation Avancée"
|
||||
description: Pousser le LLM à repenser son travail en utilisant des méthodes de raisonnement structurées
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Faites repenser au LLM ce qu'il vient de générer. Vous choisissez une méthode de raisonnement, il l'applique à sa propre sortie, et vous décidez de conserver ou non les améliorations.
|
||||
|
||||
## Qu'est-ce que l’Élicitation Avancée ?
|
||||
|
||||
Un second passage structuré. Au lieu de demander à l'IA de "réessayer" ou de "faire mieux", vous sélectionnez une méthode de raisonnement spécifique et l'IA réexamine sa propre sortie à travers ce prisme.
|
||||
|
||||
La différence est importante. Les demandes vagues produisent des révisions vagues. Une méthode nommée impose un angle d'attaque particulier, mettant en lumière des perspectives qu'un simple réajustement générique aurait manquées.
|
||||
|
||||
## Quand l'utiliser
|
||||
|
||||
- Après qu'un workflow a généré du contenu et vous souhaitez des alternatives
|
||||
- Lorsque la sortie semble correcte mais que vous soupçonnez qu'il y a davantage de profondeur
|
||||
- Pour tester les hypothèses ou trouver des faiblesses
|
||||
- Pour du contenu à enjeux élevés où la réflexion approfondie aide
|
||||
|
||||
Les workflows offrent l'élicitation aux points de décision - après que le LLM ait généré quelque chose, on vous demandera si vous souhaitez l'exécuter.
|
||||
|
||||
## Comment ça fonctionne
|
||||
|
||||
1. Le LLM suggère 5 méthodes pertinentes pour votre contenu
|
||||
2. Vous en choisissez une (ou remélangez pour différentes options)
|
||||
3. La méthode est appliquée, les améliorations sont affichées
|
||||
4. Acceptez ou rejetez, répétez ou continuez
|
||||
|
||||
## Méthodes intégrées
|
||||
|
||||
Des dizaines de méthodes de raisonnement sont disponibles. Quelques exemples :
|
||||
|
||||
- **Analyse Pré-mortem** - Suppose que le projet a déjà échoué, revient en arrière pour trouver pourquoi
|
||||
- **Pensée de Premier Principe** - Élimine les hypothèses, reconstruit à partir de la vérité de terrain
|
||||
- **Inversion** - Demande comment garantir l'échec, puis les évite
|
||||
- **Équipe Rouge vs Équipe Bleue** - Attaque votre propre travail, puis le défend
|
||||
- **Questionnement Socratique** - Conteste chaque affirmation avec "pourquoi ?" et "comment le savez-vous ?"
|
||||
- **Suppression des Contraintes** - Abandonne toutes les contraintes, voit ce qui change, les réajoute sélectivement
|
||||
- **Cartographie des Parties Prenantes** - Réévalue depuis la perspective de chaque partie prenante
|
||||
- **Raisonnement Analogique** - Trouve des parallèles dans d'autres domaines et applique leurs leçons
|
||||
|
||||
Et bien d'autres. L'IA choisit les options les plus pertinentes pour votre contenu - vous choisissez lesquelles exécuter.
|
||||
|
||||
:::tip[Commencez Ici]
|
||||
L'Analyse Pré-mortem est un bon premier choix pour toute spécification ou tout plan. Elle trouve systématiquement des lacunes qu'une révision standard manque.
|
||||
:::
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: "Revue Contradictoire"
|
||||
description: Technique de raisonnement forcée qui empêche les revues paresseuses du style "ça à l'air bon"
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Forcez une analyse plus approfondie en exigeant que des problèmes soient trouvés.
|
||||
|
||||
## Qu'est-ce que la Revue Contradictoire ?
|
||||
|
||||
Une technique de revue où le réviseur *doit* trouver des problèmes. Pas de "ça a l'air bon" autorisé. Le réviseur adopte une posture cynique - suppose que des problèmes existent et les trouve.
|
||||
|
||||
Il ne s'agit pas d'être négatif. Il s'agit de forcer une analyse authentique au lieu d'un coup d'œil superficiel qui valide automatiquement ce qui a été soumis.
|
||||
|
||||
**La règle fondamentale :** Il doit trouver des problèmes. Zéro constatation déclenche un arrêt - réanalyse ou explique pourquoi.
|
||||
|
||||
## Pourquoi Cela Fonctionne
|
||||
|
||||
Les revues normales souffrent du biais de confirmation[^1]. Il parcourt le travail rapidement, rien ne lui saute aux yeux, il l'approuve. L'obligation de "trouver des problèmes" brise ce schéma :
|
||||
|
||||
- **Force la rigueur** - Impossible d'approuver tant qu’il n'a pas examiné suffisamment en profondeur pour trouver des problèmes
|
||||
- **Détecte les oublis** - "Qu'est-ce qui manque ici ?" devient une question naturelle
|
||||
- **Améliore la qualité du signal** - Les constatations sont spécifiques et actionnables, pas des préoccupations vagues
|
||||
- **Asymétrie d'information**[^2] - Effectue les revues avec un contexte frais (sans accès au raisonnement original) pour évaluer l'artefact, pas l'intention
|
||||
|
||||
## Où Elle Est Utilisée
|
||||
|
||||
La revue contradictoire apparaît dans tous les workflows BMad - revue de code, vérifications de préparation à l'implémentation, validation de spécifications, et d'autres. Parfois c'est une étape obligatoire, parfois optionnelle (comme l'élicitation avancée ou le mode party). Le pattern s'adapte à n'importe quel artefact nécessitant un examen.
|
||||
|
||||
## Filtrage Humain Requis
|
||||
|
||||
Parce que l'IA est *instruite* de trouver des problèmes, elle trouvera des problèmes - même lorsqu'ils n'existent pas. Attendez-vous à des faux positifs : des détails présentés comme des problèmes, des malentendus sur l'intention, ou des préoccupations purement hallucinées[^3].
|
||||
|
||||
**C'est vous qui décidez ce qui est réel.** Examinez chaque constatation, ignorez le bruit, corrigez ce qui compte.
|
||||
|
||||
## Exemple
|
||||
|
||||
Au lieu de :
|
||||
|
||||
> "L'implémentation de l'authentification semble raisonnable. Approuvé."
|
||||
|
||||
Une revue contradictoire produit :
|
||||
|
||||
> 1. **ÉLEVÉ** - `login.ts:47` - Pas de limitation de débit sur les tentatives échouées
|
||||
> 2. **ÉLEVÉ** - Jeton de session stocké dans localStorage (vulnérable au XSS)
|
||||
> 3. **MOYEN** - La validation du mot de passe se fait côté client uniquement
|
||||
> 4. **MOYEN** - Pas de journalisation d'audit pour les tentatives de connexion échouées
|
||||
> 5. **FAIBLE** - Le nombre magique `3600` devrait être `SESSION_TIMEOUT_SECONDS`
|
||||
|
||||
La première revue pourrait manquer une vulnérabilité de sécurité. La seconde en a attrapé quatre.
|
||||
|
||||
## Itération et Rendements Décroissants
|
||||
|
||||
Après avoir traité les constatations, envisagez de relancer la revue. Une deuxième passe détecte généralement plus de problèmes. Une troisième n'est pas toujours inutile non plus. Mais chaque passe prend du temps, et vous finissez par atteindre des rendements décroissants[^4] - juste des détails et des faux problèmes.
|
||||
|
||||
:::tip[Meilleures Revues]
|
||||
Supposez que des problèmes existent. Cherchez ce qui manque, pas seulement ce qui ne va pas.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: **Biais de confirmation** : tendance cognitive à rechercher, interpréter et favoriser les informations qui confirment nos croyances préexistantes, tout en ignorant ou minimisant celles qui les contredisent.
|
||||
[^2]: **Asymétrie d'information** : situation où une partie dispose de plus ou de meilleures informations qu'une autre, conduisant potentiellement à des décisions ou jugements biaisés.
|
||||
[^3]: **Hallucination (IA)** : phénomène où un modèle d'IA génère des informations plausibles mais factuellement incorrectes ou inventées, présentées avec confiance comme si elles étaient vraies.
|
||||
[^4]: **Rendements décroissants** : principe selon lequel l'augmentation continue d'un investissement (temps, effort, ressources) finit par produire des bénéfices de plus en plus faibles proportionnellement.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: "Brainstorming"
|
||||
description: Sessions interactives créatives utilisant plus de 60 techniques d'idéation éprouvées
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Libérez votre créativité grâce à une exploration guidée.
|
||||
|
||||
## Qu'est-ce que le Brainstorming ?
|
||||
|
||||
Lancez `bmad-brainstorming` et vous obtenez un facilitateur créatif qui fait émerger vos idées - pas qui les génère pour vous. L'IA agit comme coach et guide, utilisant des techniques éprouvées pour créer les conditions où votre meilleure réflexion émerge.
|
||||
|
||||
**Idéal pour :**
|
||||
|
||||
- Surmonter les blocages créatifs
|
||||
- Générer des idées de produits ou de fonctionnalités
|
||||
- Explorer des problèmes sous de nouveaux angles
|
||||
- Développer des concepts bruts en plans d'action
|
||||
|
||||
## Comment ça fonctionne
|
||||
|
||||
1. **Configuration** - Définir le sujet, les objectifs, les contraintes
|
||||
2. **Choisir l'approche** - Choisir vous-même les techniques, obtenir des recommandations de l'IA, aller au hasard, ou suivre un flux progressif
|
||||
3. **Facilitation** - Travailler à travers les techniques avec des questions approfondies et un coaching collaboratif
|
||||
4. **Organiser** - Idées regroupées par thèmes et priorisées
|
||||
5. **Action** - Les meilleures idées reçoivent des prochaines étapes et des indicateurs de succès
|
||||
|
||||
Tout est capturé dans un document de session que vous pouvez consulter ultérieurement ou partager avec les parties prenantes.
|
||||
|
||||
:::note[Vos Idées]
|
||||
Chaque idée vient de vous. Le workflow crée les conditions propices à une vision nouvelle - vous en êtes la source.
|
||||
:::
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: "FAQ Projets Existants"
|
||||
description: Questions courantes sur l'utilisation de la méthode BMad sur des projets existants
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
Réponses rapides aux questions courantes sur l'utilisation de la méthode BMad (BMM) sur des projets existants.
|
||||
|
||||
## Questions
|
||||
|
||||
- [Dois-je d'abord exécuter document-project ?](#dois-je-dabord-exécuter-document-project)
|
||||
- [Que faire si j'oublie d'exécuter document-project ?](#que-faire-si-joublie-dexécuter-document-project)
|
||||
- [Puis-je utiliser Quick Dev pour les projets existants ?](#puis-je-utiliser-quick-dev-pour-les-projets-existants)
|
||||
- [Que faire si mon code existant ne suit pas les bonnes pratiques ?](#que-faire-si-mon-code-existant-ne-suit-pas-les-bonnes-pratiques)
|
||||
|
||||
### Dois-je d'abord exécuter `document-project` ?
|
||||
|
||||
Hautement recommandé, surtout si :
|
||||
|
||||
- Aucune documentation existante
|
||||
- La documentation est obsolète
|
||||
- Les agents IA ont besoin de contexte sur le code existant
|
||||
|
||||
Vous pouvez l'ignorer si vous disposez d'une documentation complète et à jour incluant `docs/index.md` ou si vous utiliserez d'autres outils ou techniques pour aider à la découverte afin que l'agent puisse construire sur un système existant.
|
||||
|
||||
### Que faire si j'oublie d'exécuter `document-project` ?
|
||||
|
||||
Ne vous inquiétez pas — vous pouvez le faire à tout moment. Vous pouvez même le faire pendant ou après un projet pour aider à maintenir la documentation à jour.
|
||||
|
||||
### Puis-je utiliser Quick Dev pour les projets existants ?
|
||||
|
||||
Oui ! Quick Dev fonctionne très bien pour les projets existants. Il va :
|
||||
|
||||
- Détecter automatiquement votre pile technologique existante
|
||||
- Analyser les patterns de code existants
|
||||
- Détecter les conventions et demander confirmation
|
||||
- Générer une spécification technique riche en contexte qui respecte le code existant
|
||||
|
||||
Parfait pour les corrections de bugs et les petites fonctionnalités dans des bases de code existantes.
|
||||
|
||||
### Que faire si mon code existant ne suit pas les bonnes pratiques ?
|
||||
|
||||
Quick Dev détecte vos conventions et demande : « Dois-je suivre ces conventions existantes ? » Vous décidez :
|
||||
|
||||
- **Oui** → Maintenir la cohérence avec la base de code actuelle
|
||||
- **Non** → Établir de nouvelles normes (documenter pourquoi dans la spécification technique)
|
||||
|
||||
BMM respecte votre choix — il ne forcera pas la modernisation, mais la proposera.
|
||||
|
||||
**Une question sans réponse ici ?** Veuillez [ouvrir un ticket](https://github.com/bmad-code-org/BMAD-METHOD/issues) ou poser votre question sur [Discord](https://discord.gg/gk8jAdXWmj) afin que nous puissions l'ajouter !
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
title: "Party Mode"
|
||||
description: Collaboration multi-agents - regroupez tous vos agents IA dans une seule conversation
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Regroupez tous vos agents IA dans une seule conversation.
|
||||
|
||||
## Qu'est-ce que le Party Mode ?
|
||||
|
||||
Lancez `bmad-party-mode` et vous avez toute votre équipe IA dans une même pièce - PM, Architecte, Développeur, Designer UX, selon vos besoins. BMad Master orchestre, en sélectionnant les agents pertinents à chaque message. Les agents répondent en personnage, sont en accord ou désaccord, et construisent sur les idées des autres.
|
||||
|
||||
La conversation continue aussi longtemps que vous le souhaitez. Posez des questions de suivi, remettez en question les réponses, redirigez la discussion - c'est un véritable échange avec vos agents jusqu'à ce que vous ayez terminé.
|
||||
|
||||
**Idéal pour :**
|
||||
|
||||
- Les grandes décisions avec des compromis
|
||||
- Les sessions de brainstorming
|
||||
- Les rétrospectives post-incident quand les choses tournent mal
|
||||
- Les rétrospectives de sprint et la planification
|
||||
|
||||
## Exemples
|
||||
|
||||
### Remettre en question une mauvaise architecture
|
||||
|
||||
**Vous :** « Ok l'équipe, notre dernier sprint a été un désastre. Le service d'authentification est tombé trois fois. Qui a cafouillé ? »
|
||||
|
||||
**Architecte :** « Le design était solide - authentification distribuée avec des fallbacks appropriés. Si l'implémentation a dévié des specs... »
|
||||
|
||||
**Développeur :** « J'ai suivi le document d'architecture à la lettre. Les specs ne prenaient pas en compte les race conditions lors de l'invalidation de sessions concurrentes. »
|
||||
|
||||
**PM :** « Vous avez tous les deux raté le vrai problème - nous n'avons pas validé les exigences de gestion des sessions dans le PRD. C'est de ma faute de ne pas l'avoir repéré. »
|
||||
|
||||
**TEA :** « Et j'aurais dû le repérer dans les tests d'intégration. Les scénarios de test ne couvraient pas l'invalidation concurrente. »
|
||||
|
||||
### Brainstorming créatif
|
||||
|
||||
**Vous :** « Comment rendre l'onboarding magique au lieu d'ennuyeux ? »
|
||||
|
||||
**Designer UX :** « Commençons par la divulgation progressive - révélons les fonctionnalités au fur et à mesure que les utilisateurs en ont besoin, pas d'un coup dans un tutoriel. »
|
||||
|
||||
**Storyteller :** « Et si l'onboarding était une histoire ? Chaque étape révèle le parcours d'un personnage - l'utilisateur EST le héros. »
|
||||
|
||||
**Game Designer :** « En partant de là - et si la première "quête" consistait à résoudre un vrai problème utilisateur ? Ils apprennent en faisant quelque chose d'utile. »
|
||||
|
||||
### Décision technique
|
||||
|
||||
**Vous :** « Monolithe ou microservices pour le MVP[^1] ? »
|
||||
|
||||
**Architecte :** « Commencez en monolithe. Les microservices ajoutent une complexité dont vous n'avez pas besoin à 1000 utilisateurs. »
|
||||
|
||||
**PM :** « D'accord. Le time-to-market[^2] compte plus que la scalabilité théorique. »
|
||||
|
||||
**Développeur :** « Monolithe avec des frontières de modules claires. On pourra extraire des services plus tard si nécessaire. »
|
||||
|
||||
:::tip[Meilleures décisions]
|
||||
De meilleures décisions grâce à des perspectives diverses. Bienvenue dans le party mode.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: MVP (Minimum Viable Product) : version minimale d'un produit contenant juste assez de fonctionnalités pour être utilisée par des utilisateurs précoces et valider les hypothèses de marché avant d'investir dans un développement plus complet.
|
||||
[^2]: Time-to-market : délai nécessaire pour concevoir, développer et lancer un produit sur le marché. Plus ce délai est court, plus l'entreprise peut prendre de l'avance sur ses concurrents.
|
||||
|
|
@ -0,0 +1,117 @@
|
|||
---
|
||||
title: "Prévention des conflits entre agents"
|
||||
description: Comment l'architecture empêche les conflits lorsque plusieurs agents implémentent un système
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
Lorsque plusieurs agents IA implémentent différentes parties d'un système, ils peuvent prendre des décisions techniques contradictoires. La documentation d'architecture prévient cela en établissant des standards partagés.
|
||||
|
||||
## Types de conflits courants
|
||||
|
||||
### Conflits de style d'API
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise REST avec `/users/{id}`
|
||||
- L'agent B utilise des mutations GraphQL
|
||||
- Résultat : Patterns d'API incohérents, consommateurs confus
|
||||
|
||||
Avec architecture :
|
||||
- L'ADR[^1] spécifie : « Utiliser GraphQL pour toute communication client-serveur »
|
||||
- Tous les agents suivent le même pattern
|
||||
|
||||
### Conflits de conception de base de données
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise des noms de colonnes en snake_case
|
||||
- L'agent B utilise des noms de colonnes en camelCase
|
||||
- Résultat : Schéma incohérent, requêtes illisibles
|
||||
|
||||
Avec architecture :
|
||||
- Un document de standards spécifie les conventions de nommage
|
||||
- Tous les agents suivent les mêmes patterns
|
||||
|
||||
### Conflits de gestion d'état
|
||||
|
||||
Sans architecture :
|
||||
- L'agent A utilise Redux pour l'état global
|
||||
- L'agent B utilise React Context
|
||||
- Résultat : Multiples approches de gestion d'état, complexité
|
||||
|
||||
Avec architecture :
|
||||
- L'ADR spécifie l'approche de gestion d'état
|
||||
- Tous les agents implémentent de manière cohérente
|
||||
|
||||
## Comment l'architecture prévient les conflits
|
||||
|
||||
### 1. Décisions explicites via les ADR[^1]
|
||||
|
||||
Chaque choix technologique significatif est documenté avec :
|
||||
- Contexte (pourquoi cette décision est importante)
|
||||
- Options considérées (quelles alternatives existent)
|
||||
- Décision (ce qui a été choisi)
|
||||
- Justification (pourquoi cela a-t-il été choisi)
|
||||
- Conséquences (compromis acceptés)
|
||||
|
||||
### 2. Guidance spécifique aux FR/NFR[^2]
|
||||
|
||||
L'architecture associe chaque exigence fonctionnelle à une approche technique :
|
||||
- FR-001 : Gestion des utilisateurs → Mutations GraphQL
|
||||
- FR-002 : Application mobile → Requêtes optimisées
|
||||
|
||||
### 3. Standards et conventions
|
||||
|
||||
Documentation explicite de :
|
||||
- La structure des répertoires
|
||||
- Les conventions de nommage
|
||||
- L'organisation du code
|
||||
- Les patterns de test
|
||||
|
||||
## L'architecture comme contexte partagé
|
||||
|
||||
Considérez l'architecture comme le contexte partagé que tous les agents lisent avant d'implémenter :
|
||||
|
||||
```text
|
||||
PRD : "Que construire"
|
||||
↓
|
||||
Architecture : "Comment le construire"
|
||||
↓
|
||||
L'agent A lit l'architecture → implémente l'Epic 1
|
||||
L'agent B lit l'architecture → implémente l'Epic 2
|
||||
L'agent C lit l'architecture → implémente l'Epic 3
|
||||
↓
|
||||
Résultat : Implémentation cohérente
|
||||
```
|
||||
|
||||
## Sujets clés des ADR
|
||||
|
||||
Décisions courantes qui préviennent les conflits :
|
||||
|
||||
| Sujet | Exemple de décision |
|
||||
| ---------------- | -------------------------------------------- |
|
||||
| Style d'API | GraphQL vs REST vs gRPC |
|
||||
| Base de données | PostgreSQL vs MongoDB |
|
||||
| Authentification | JWT vs Sessions |
|
||||
| Gestion d'état | Redux vs Context vs Zustand |
|
||||
| Styling | CSS Modules vs Tailwind vs Styled Components |
|
||||
| Tests | Jest + Playwright vs Vitest + Cypress |
|
||||
|
||||
## Anti-patterns à éviter
|
||||
|
||||
:::caution[Erreurs courantes]
|
||||
- **Décisions implicites** — « On décidera du style d'API au fur et à mesure » mène à l'incohérence
|
||||
- **Sur-documentation** — Documenter chaque choix mineur cause une paralysie analytique
|
||||
- **Architecture obsolète** — Les documents écrits une fois et jamais mis à jour poussent les agents à suivre des patterns dépassés
|
||||
:::
|
||||
|
||||
:::tip[Approche correcte]
|
||||
- Documenter les décisions qui traversent les frontières des epics
|
||||
- Se concentrer sur les zones sujettes aux conflits
|
||||
- Mettre à jour l'architecture au fur et à mesure des apprentissages
|
||||
- Utiliser `bmad-correct-course` pour les changements significatifs
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: ADR (Architecture Decision Record) : document qui consigne une décision d’architecture, son contexte, les options envisagées, le choix retenu et ses conséquences, afin d’assurer la traçabilité et la compréhension des décisions techniques dans le temps.
|
||||
[^2]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
---
|
||||
title: "Contexte du Projet"
|
||||
description: Comment project-context.md guide les agents IA avec les règles et préférences de votre projet
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Le fichier `project-context.md` est le guide d'implémentation de votre projet pour les agents IA. Similaire à une « constitution » dans d'autres systèmes de développement, il capture les règles, les patterns et les préférences qui garantissent une génération de code cohérente à travers tous les workflows.
|
||||
|
||||
## Ce Qu'il Fait
|
||||
|
||||
Les agents IA prennent constamment des décisions d'implémentation — quels patterns suivre, comment structurer le code, quelles conventions utiliser. Sans guidance claire, ils peuvent :
|
||||
- Suivre des bonnes pratiques génériques qui ne correspondent pas à votre codebase
|
||||
- Prendre des décisions incohérentes selon les différentes stories
|
||||
- Passer à côté d'exigences ou de contraintes spécifiques au projet
|
||||
|
||||
Le fichier `project-context.md` résout ce problème en documentant ce que les agents doivent savoir dans un format concis et optimisé pour les LLM.
|
||||
|
||||
## Comment Ça Fonctionne
|
||||
|
||||
Chaque workflow d'implémentation charge automatiquement `project-context.md` s'il existe. Le workflow architecte le charge également pour respecter vos préférences techniques lors de la conception de l'architecture.
|
||||
|
||||
**Chargé par ces workflows :**
|
||||
- `bmad-create-architecture` — respecte les préférences techniques pendant la phase de solutioning
|
||||
- `bmad-create-story` — informe la création de stories avec les patterns du projet
|
||||
- `bmad-dev-story` — guide les décisions d'implémentation
|
||||
- `bmad-code-review` — valide par rapport aux standards du projet
|
||||
- `bmad-quick-dev` — applique les patterns lors de l'implémentation des spécifications techniques
|
||||
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — fournit le contexte global du projet
|
||||
|
||||
## Quand Le Créer
|
||||
|
||||
Le fichier `project-context.md` est utile à n'importe quel stade d'un projet :
|
||||
|
||||
| Scénario | Quand Créer | Objectif |
|
||||
|------------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------|
|
||||
| **Nouveau projet, avant l'architecture** | Manuellement, avant `bmad-create-architecture` | Documenter vos préférences techniques pour que l'architecte les respecte |
|
||||
| **Nouveau projet, après l'architecture** | Via `bmad-generate-project-context` ou manuellement | Capturer les décisions d'architecture pour les agents d'implémentation |
|
||||
| **Projet existant** | Via `bmad-generate-project-context` | Découvrir les patterns existants pour que les agents suivent les conventions établies |
|
||||
| **Projet Quick Dev** | Avant ou pendant `bmad-quick-dev` | Garantir que l'implémentation rapide respecte vos patterns |
|
||||
|
||||
:::tip[Recommandé]
|
||||
Pour les nouveaux projets, créez-le manuellement avant l'architecture si vous avez de fortes préférences techniques. Sinon, générez-le après l'architecture pour capturer ces décisions.
|
||||
:::
|
||||
|
||||
## Ce Qu'il Contient
|
||||
|
||||
Le fichier a deux sections principales :
|
||||
|
||||
### Pile Technologique & Versions
|
||||
|
||||
Documente les frameworks, langages et outils utilisés par votre projet avec leurs versions spécifiques :
|
||||
|
||||
```markdown
|
||||
## Pile Technologique & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State: Zustand (pas Redux)
|
||||
- Testing: Vitest, Playwright, MSW
|
||||
- Styling: Tailwind CSS avec design tokens personnalisés
|
||||
```
|
||||
|
||||
### Règles Critiques d’Implémentation
|
||||
|
||||
Documente les patterns et conventions que les agents pourraient autrement manquer :
|
||||
|
||||
```markdown
|
||||
|
||||
## Règles Critiques d’Implémentation
|
||||
|
||||
**Configuration TypeScript :**
|
||||
- Mode strict activé — pas de types `any` sans approbation explicite
|
||||
- Utiliser `interface` pour les APIs publiques, `type` pour les unions/intersections
|
||||
|
||||
**Organisation du Code :**
|
||||
- Composants dans `/src/components/` avec fichiers `.test.tsx` co-localisés
|
||||
- Utilitaires dans `/src/lib/` pour les fonctions pures réutilisables
|
||||
- Les appels API utilisent le singleton `apiClient` — jamais de fetch direct
|
||||
|
||||
**Patterns de Tests :**
|
||||
- Les tests unitaires se concentrent sur la logique métier, pas sur les détails d’implémentation
|
||||
- Les tests d’intégration utilisent MSW pour simuler les réponses API
|
||||
- Les tests E2E couvrent uniquement les parcours utilisateurs critiques
|
||||
|
||||
**Spécifique au Framework :**
|
||||
- Toutes les opérations async utilisent le wrapper `handleError` pour une gestion cohérente des erreurs
|
||||
- Les feature flags sont accessibles via `featureFlag()` de `@/lib/flags`
|
||||
- Les nouvelles routes suivent le modèle de routage basé sur les fichiers dans `/src/app/`
|
||||
```
|
||||
|
||||
Concentrez-vous sur ce qui est **non évident** — des choses que les agents pourraient ne pas déduire en lisant des extraits de code. Ne documentez pas les pratiques standard qui s'appliquent universellement.
|
||||
|
||||
## Création du Fichier
|
||||
|
||||
Vous avez trois options :
|
||||
|
||||
### Création Manuelle
|
||||
|
||||
Créez le fichier `_bmad-output/project-context.md` et ajoutez vos règles :
|
||||
|
||||
```bash
|
||||
# Depuis la racine du projet
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Éditez-le avec votre pile technologique et vos règles d'implémentation. Les workflows architecture et implémentation le trouveront et le chargeront automatiquement.
|
||||
|
||||
### Générer Après L'Architecture
|
||||
|
||||
Exécutez le workflow `bmad-generate-project-context` après avoir terminé votre architecture :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Cela analyse votre document d'architecture et vos fichiers projet pour générer un fichier de contexte capturant les décisions prises.
|
||||
|
||||
### Générer Pour Les Projets Existants
|
||||
|
||||
Pour les projets existants, exécutez `bmad-generate-project-context` pour découvrir les patterns existants :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre codebase pour identifier les conventions, puis génère un fichier de contexte que vous pouvez examiner et affiner.
|
||||
|
||||
## Pourquoi C'est Important
|
||||
|
||||
Sans `project-context.md`, les agents font des suppositions qui peuvent ne pas correspondre à votre projet :
|
||||
|
||||
| Sans Contexte | Avec Contexte |
|
||||
|----------------------------------------------------|-------------------------------------------------|
|
||||
| Utilise des patterns génériques | Suit vos conventions établies |
|
||||
| Style incohérent selon les stories | Implémentation cohérente |
|
||||
| Peut manquer les contraintes spécifiques au projet | Respecte toutes les exigences techniques |
|
||||
| Chaque agent décide indépendamment | Tous les agents s'alignent sur les mêmes règles |
|
||||
|
||||
C'est particulièrement important pour :
|
||||
- **Quick Dev** — saute le PRD et l'architecture, le fichier de contexte comble le vide
|
||||
- **Projets d'équipe** — garantit que tous les agents suivent les mêmes standards
|
||||
- **Projets existants** — empêche de casser les patterns établis
|
||||
|
||||
## Édition et Mise à Jour
|
||||
|
||||
Le fichier `project-context.md` est un document vivant. Mettez-le à jour quand :
|
||||
|
||||
- Les décisions d'architecture changent
|
||||
- De nouvelles conventions sont établies
|
||||
- Les patterns évoluent pendant l'implémentation
|
||||
- Vous identifiez des lacunes dans le comportement des agents
|
||||
|
||||
Vous pouvez l'éditer manuellement à tout moment, ou réexécuter `bmad-generate-project-context` pour le mettre à jour après des changements significatifs.
|
||||
|
||||
:::note[Emplacement du Fichier]
|
||||
L'emplacement par défaut est `_bmad-output/project-context.md`. Les workflows le recherchent là, et vérifient également `**/project-context.md` n'importe où dans votre projet.
|
||||
:::
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: "Quick Dev"
|
||||
description: Réduire la friction de l’interaction humaine sans renoncer aux points de contrôle qui protègent la qualité des résultats
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Intention en entrée, modifications de code en sortie, avec aussi peu d'interactions humaines dans la boucle que possible — sans sacrifier la qualité.
|
||||
|
||||
Il permet au modèle de s'exécuter plus longtemps entre les points de contrôle, puis ne vous fait intervenir que lorsque la tâche ne peut pas se poursuivre en toute sécurité sans jugement humain, ou lorsqu'il est temps de revoir le résultat final.
|
||||
|
||||

|
||||
|
||||
## Pourquoi cette fonctionnalité existe
|
||||
|
||||
Les interactions humaines dans la boucle sont nécessaires et coûteuses.
|
||||
|
||||
Les LLM actuels échouent encore de manière prévisible : ils interprètent mal l'intention, comblent les lacunes avec des suppositions assurées, dérivent vers du travail non lié, et génèrent des résultats à réviser bruyants. En même temps, l'intervention humaine constante limite la fluidité du développement. L'attention humaine est le goulot d'étranglement.
|
||||
|
||||
`bmad-quick-dev` rééquilibre ce compromis. Il fait confiance au modèle pour s'exécuter sans surveillance sur de plus longues périodes, mais seulement après que le workflow ait créé une frontière suffisamment solide pour rendre cela sûr.
|
||||
|
||||
## La conception fondamentale
|
||||
|
||||
### 1. Compresser l'intention d'abord
|
||||
|
||||
Le workflow commence par compresser l’interaction de la personne et du modèle à partir de la requête en un objectif cohérent. L'entrée peut commencer sous forme d'une expression grossière de l'intention, mais avant que le workflow ne s'exécute de manière autonome, elle doit devenir suffisamment petite, claire et sans contradiction pour être exécutable.
|
||||
|
||||
L'intention peut prendre plusieurs formes : quelques phrases, un lien vers un outil de suivi de bugs, une sortie du mode planification, du texte copié depuis une session de chat, ou même un numéro de story depuis un fichier `epics.md` de BMAD. Dans ce dernier cas, le workflow ne comprendra pas la sémantique de suivi des stories de BMAD, mais il peut quand même prendre la story elle-même et l'exécuter.
|
||||
|
||||
Ce workflow n'élimine pas le contrôle humain. Il le déplace vers un nombre réduit d’étapes à forte valeur :
|
||||
|
||||
- **Clarification de l'intention** - transformer une demande confuse en un objectif cohérent sans contradictions cachées
|
||||
- **Approbation de la spécification** - confirmer que la compréhension figée correspond bien à ce qu'il faut construire
|
||||
- **Revue du produit final** - le point de contrôle principal, où la personne décide si le résultat est acceptable à la fin
|
||||
|
||||
### 2. Router vers le chemin le plus court et sûr
|
||||
|
||||
Une fois l'objectif clair, le workflow décide s'il s'agit d'un véritable changement en une seule étape ou s'il nécessite le chemin complet. Les petits changements à zéro impact peuvent aller directement à l'implémentation. Tout le reste passe par la planification pour que le modèle dispose d'un cadre plus solide avant de s'exécuter plus longtemps de manière autonome.
|
||||
|
||||
### 3. S'exécuter plus longtemps avec moins de supervision
|
||||
|
||||
Après cette décision de routage, le modèle peut prendre en charge une plus grande partie du travail par lui-même. Sur le chemin complet, la spécification approuvée devient le cadre dans lequel le modèle s'exécute avec moins de supervision, ce qui est tout l'intérêt de la conception.
|
||||
|
||||
### 4. Diagnostiquer les échecs au bon niveau
|
||||
|
||||
Si l'implémentation est incorrecte parce que l'intention était mauvaise, corriger le code n'est pas la bonne solution. Si le code est incorrect parce que la spécification était faible, corriger le diff n'est pas non plus la bonne solution. Le workflow est conçu pour diagnostiquer où l'échec est entré dans le système, revenir à ce niveau, et régénérer à partir de ce point.
|
||||
|
||||
Les résultats de la revue sont utilisés pour décider si le problème provenait de l'intention, de la génération de la spécification, ou de l'implémentation locale. Seuls les véritables problèmes locaux sont corrigés localement.
|
||||
|
||||
### 5. Ne faire intervenir l’humain que si nécessaire
|
||||
|
||||
L'entretien sur l'intention implique la personne dans la boucle, mais ce n'est pas le même type d'interruption qu'un point de contrôle récurrent. Le workflow essaie de garder ces points de contrôle récurrents au minimum. Après la mise en forme initiale de l'intention, la personne revient principalement lorsque le workflow ne peut pas continuer en toute sécurité sans jugement, et à la fin, lorsqu'il est temps de revoir le résultat.
|
||||
|
||||
- **Résolution des lacunes d'intention** - intervenir à nouveau lors de la revue prouve que le workflow n'a pas pu déduire correctement ce qui était voulu
|
||||
|
||||
Tout le reste est candidat à une exécution autonome plus longue. Ce compromis est délibéré. Les anciens patterns dépensent plus d'attention humaine en supervision continue. Quick Dev fait davantage confiance au modèle, mais préserve l'attention humaine pour les moments où le raisonnement humain a le plus d'impact.
|
||||
|
||||
## Pourquoi le système de revue est important
|
||||
|
||||
La phase de revue n'est pas seulement là pour trouver des bugs. Elle est là pour router la correction sans détruire l'élan.
|
||||
|
||||
Ce workflow fonctionne mieux sur une plateforme capable de générer des sous-agents[^1], ou au moins d'invoquer un autre LLM via la ligne de commande et d'attendre un résultat. Si votre plateforme ne supporte pas cela nativement, vous pouvez ajouter un skill pour le faire. Les sous-agents sans contexte sont une pierre angulaire de la conception de la revue.
|
||||
|
||||
Les revues agentiques[^2] échouent souvent de deux manières :
|
||||
|
||||
- Elles génèrent trop d’observations, forçant la personne à trier le bruit.
|
||||
- Elles déraillent des modifications actuelles en remontant des problèmes non liés et en transformant chaque exécution en un projet de nettoyage improvisé.
|
||||
|
||||
Quick Dev aborde ces deux problèmes en traitant la revue comme un triage[^3].
|
||||
|
||||
Lorsqu’une observation est fortuite plutôt que directement liée au travail en cours, le processus peut la mettre de côté au lieu d’obliger la personne à s’en occuper immédiatement. Cela permet de rester concentré sur l’exécution et d’éviter que des digressions aléatoires ne viennent épuiser le capital d’attention.
|
||||
|
||||
Ce triage sera parfois imparfait. C’est acceptable. Il est généralement préférable de mal juger certaines observations plutôt que d’inonder la personne de milliers de commentaires de revue à faible valeur. Le système optimise la qualité du rapport, pas d’être exhaustif.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Sous-agent : agent IA secondaire créé temporairement pour effectuer une tâche spécifique (comme une revue de code) de manière isolée, sans hériter du contexte complet de l’agent principal, ce qui permet une analyse plus objective et impartiale.
|
||||
[^2]: Revues agentiques (agentic review) : revue de code effectuée par un agent IA de manière autonome, capable d’analyser, d’identifier des problèmes et de formuler des recommandations sans intervention humaine directe.
|
||||
[^3]: Triage : processus de filtrage et de priorisation des observations issues d’une revue, afin de distinguer les problèmes pertinents à traiter immédiatement de ceux qui peuvent être mis de côté pour plus tard.
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
---
|
||||
title: "Pourquoi le Solutioning est Important"
|
||||
description: Comprendre pourquoi la phase de solutioning est critique pour les projets multi-epics
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
La Phase 3 (Solutioning) traduit le **quoi** construire (issu de la Planification) en **comment** le construire (conception technique). Cette phase évite les conflits entre agents dans les projets multi-epics en documentant les décisions architecturales avant le début de l'implémentation.
|
||||
|
||||
## Le Problème Sans Solutioning
|
||||
|
||||
```text
|
||||
Agent 1 implémente l'Epic 1 avec une API REST
|
||||
Agent 2 implémente l'Epic 2 avec GraphQL
|
||||
Résultat : Conception d'API incohérente, cauchemar d'intégration
|
||||
```
|
||||
|
||||
Lorsque plusieurs agents implémentent différentes parties d'un système sans orientation architecturale partagée, ils prennent des décisions techniques indépendantes qui peuvent entrer en conflit.
|
||||
|
||||
## La Solution Avec le Solutioning
|
||||
|
||||
```text
|
||||
le workflow architecture décide : "Utiliser GraphQL pour toutes les API"
|
||||
Tous les agents suivent les décisions d'architecture
|
||||
Résultat : Implémentation cohérente, pas de conflits
|
||||
```
|
||||
|
||||
En documentant les décisions techniques de manière explicite, tous les agents implémentent de façon cohérente et l'intégration devient simple.
|
||||
|
||||
## Solutioning vs Planification
|
||||
|
||||
| Aspect | Planification (Phase 2) | Solutioning (Phase 3) |
|
||||
|----------|--------------------------|-------------------------------------------------|
|
||||
| Question | Quoi et Pourquoi ? | Comment ? Puis Quelles unités de travail ? |
|
||||
| Sortie | FRs/NFRs (Exigences)[^1] | Architecture + Epics[^2]/Stories[^3] |
|
||||
| Agent | PM | Architect → PM |
|
||||
| Audience | Parties prenantes | Développeurs |
|
||||
| Document | PRD[^4] (FRs/NFRs) | Architecture + Fichiers Epics |
|
||||
| Niveau | Logique métier | Conception technique + Décomposition du travail |
|
||||
|
||||
## Principe Clé
|
||||
|
||||
**Rendre les décisions techniques explicites et documentées** pour que tous les agents implémentent de manière cohérente.
|
||||
|
||||
Cela évite :
|
||||
- Les conflits de style d'API (REST vs GraphQL)
|
||||
- Les incohérences de conception de base de données
|
||||
- Les désaccords sur la gestion du state
|
||||
- Les inadéquations de conventions de nommage
|
||||
- Les variations d'approche de sécurité
|
||||
|
||||
## Quand le Solutioning est Requis
|
||||
|
||||
| Parcours | Solutioning Requis ? |
|
||||
|-----------------------|-----------------------------|
|
||||
| Quick Dev | Non - l’ignore complètement |
|
||||
| Méthode BMad Simple | Optionnel |
|
||||
| Méthode BMad Complexe | Oui |
|
||||
| Enterprise | Oui |
|
||||
|
||||
:::tip[Règle Générale]
|
||||
Si vous avez plusieurs epics qui pourraient être implémentés par différents agents, vous avez besoin de solutioning.
|
||||
:::
|
||||
|
||||
## Conséquences de sauter la phase de Solutioning
|
||||
|
||||
Sauter le solutioning sur des projets complexes entraîne :
|
||||
|
||||
- **Des problèmes d'intégration** découverts en milieu de sprint[^5]
|
||||
- **Du travail répété** dû à des implémentations conflictuelles
|
||||
- **Un temps de développement plus long** globalement
|
||||
- **De la dette technique**[^6] due à des patterns incohérents
|
||||
|
||||
:::caution[Coût Multiplié]
|
||||
Détecter les problèmes d'alignement lors du solutioning est 10× plus rapide que de les découvrir pendant l'implémentation.
|
||||
:::
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
[^2]: Epic : dans les méthodologies agiles, une unité de travail importante qui peut être décomposée en plusieurs stories plus petites. Un epic représente généralement une fonctionnalité majeure ou un objectif métier.
|
||||
[^3]: Story (User Story) : description courte et simple d'une fonctionnalité du point de vue de l'utilisateur, utilisée dans les méthodologies agiles pour planifier et prioriser le travail.
|
||||
[^4]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^5]: Sprint : période de temps fixe (généralement 1 à 4 semaines) dans les méthodologies agiles durant laquelle l'équipe complète un ensemble prédéfini de tâches.
|
||||
[^6]: Dette technique : coût futur supplémentaire de travail résultant de choix de facilité ou de raccourcis pris lors du développement initial, nécessitant souvent une refonte ultérieure.
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
---
|
||||
title: "Comment personnaliser BMad"
|
||||
description: Personnalisez les agents, les workflows et les modules tout en préservant la compatibilité avec les mises à jour
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
Utilisez les fichiers `.customize.yaml` pour adapter le comportement, les personas[^1] et les menus des agents tout en préservant vos modifications lors des mises à jour.
|
||||
|
||||
## Quand utiliser cette fonctionnalité
|
||||
|
||||
- Vous souhaitez modifier le nom, la personnalité ou le style de communication d'un agent
|
||||
- Vous avez besoin que les agents se souviennent du contexte spécifique au projet
|
||||
- Vous souhaitez ajouter des éléments de menu personnalisés qui déclenchent vos propres workflows ou prompts
|
||||
- Vous voulez que les agents effectuent des actions spécifiques à chaque démarrage
|
||||
|
||||
:::note[Prérequis]
|
||||
- BMad installé dans votre projet (voir [Comment installer BMad](./install-bmad.md))
|
||||
- Un éditeur de texte pour les fichiers YAML
|
||||
:::
|
||||
|
||||
:::caution[Protégez vos personnalisations]
|
||||
Utilisez toujours les fichiers `.customize.yaml` décrits ici plutôt que de modifier directement les fichiers d'agents. L'installateur écrase les fichiers d'agents lors des mises à jour, mais préserve vos modifications dans les fichiers `.customize.yaml`.
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Localiser les fichiers de personnalisation
|
||||
|
||||
Après l'installation, vous trouverez un fichier `.customize.yaml` par agent dans :
|
||||
|
||||
```text
|
||||
_bmad/_config/agents/
|
||||
├── bmm-analyst.customize.yaml
|
||||
├── bmm-architect.customize.yaml
|
||||
└── ... (un fichier par agent installé)
|
||||
```
|
||||
|
||||
### 2. Modifier le fichier de personnalisation
|
||||
|
||||
Ouvrez le fichier `.customize.yaml` de l'agent que vous souhaitez modifier. Chaque section est facultative — personnalisez uniquement ce dont vous avez besoin.
|
||||
|
||||
| Section | Comportement | Objectif |
|
||||
| ------------------ | ------------ | ------------------------------------------------ |
|
||||
| `agent.metadata` | Remplace | Remplacer le nom d'affichage de l'agent |
|
||||
| `persona` | Remplace | Définir le rôle, l'identité, le style et les principes |
|
||||
| `memories` | Ajoute | Ajouter un contexte persistant que l'agent se rappelle toujours |
|
||||
| `menu` | Ajoute | Ajouter des éléments de menu personnalisés pour les workflows ou prompts |
|
||||
| `critical_actions` | Ajoute | Définir les instructions de démarrage de l'agent |
|
||||
| `prompts` | Ajoute | Créer des prompts réutilisables pour les actions du menu |
|
||||
|
||||
Les sections marquées **Remplace** écrasent entièrement les valeurs par défaut de l'agent. Les sections marquées **Ajoute** s'ajoutent à la configuration existante.
|
||||
|
||||
**Nom de l'agent**
|
||||
|
||||
Modifier la façon dont l'agent se présente :
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Bob l’éponge' # Par défaut : "Mary"
|
||||
```
|
||||
|
||||
**Persona**
|
||||
|
||||
Remplacer la personnalité, le rôle et le style de communication de l'agent :
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: 'Ingénieur Full-Stack Senior'
|
||||
identity: 'Habite dans un ananas (au fond de la mer)'
|
||||
communication_style: 'Style agaçant de Bob l’Éponge'
|
||||
principles:
|
||||
- 'Jamais de nidification, les devs Bob l’Éponge détestent plus de 2 niveaux d’imbrication'
|
||||
- 'Privilégier la composition à l’héritage'
|
||||
```
|
||||
|
||||
La section `persona`[^1] remplace entièrement le persona par défaut, donc incluez les quatre champs si vous la définissez.
|
||||
|
||||
**Souvenirs**
|
||||
|
||||
Ajouter un contexte persistant que l'agent gardera toujours en mémoire :
|
||||
|
||||
```yaml
|
||||
memories:
|
||||
- 'Travaille au Krusty Krab'
|
||||
- 'Célébrité préférée : David Hasselhoff'
|
||||
- 'Appris dans l’Epic 1 que ce n’est pas cool de faire semblant que les tests ont passé'
|
||||
```
|
||||
|
||||
**Éléments de menu**
|
||||
|
||||
Ajouter des entrées personnalisées au menu d'affichage de l'agent. Chaque élément nécessite un `trigger`, une cible (chemin `workflow` ou référence `action`), et une `description` :
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: 'my-custom/workflows/my-workflow.yaml'
|
||||
description: Mon workflow personnalisé
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
description: Déployer en production
|
||||
```
|
||||
|
||||
**Actions critiques**
|
||||
|
||||
Définir des instructions qui s'exécutent au démarrage de l'agent :
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Vérifier les pipelines CI avec le Skill XYZ et alerter l’utilisateur au réveil si quelque chose nécessite une attention urgente'
|
||||
```
|
||||
|
||||
**Prompts personnalisés**
|
||||
|
||||
Créer des prompts réutilisables que les éléments de menu peuvent référencer avec `action="#id"` :
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: deploy-prompt
|
||||
content: |
|
||||
Déployer la branche actuelle en production :
|
||||
1. Exécuter tous les tests
|
||||
2. Build le projet
|
||||
3. Exécuter le script de déploiement
|
||||
```
|
||||
|
||||
### 3. Appliquer vos modifications
|
||||
|
||||
Après modification, réinstallez pour appliquer les changements :
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
L'installateur détecte l'installation existante et propose ces options :
|
||||
|
||||
| Option | Ce qu'elle fait |
|
||||
| ----------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Quick Update** | Met à jour tous les modules vers la dernière version et applique les personnalisations |
|
||||
| **Modify BMad Installation** | Flux d'installation complet pour ajouter ou supprimer des modules |
|
||||
|
||||
Pour des modifications de personnalisation uniquement, **Quick Update** est l'option la plus rapide.
|
||||
|
||||
## Résolution des problèmes
|
||||
|
||||
**Les modifications n'apparaissent pas ?**
|
||||
|
||||
- Exécutez `npx bmad-method install` et sélectionnez **Quick Update** pour appliquer les modifications
|
||||
- Vérifiez que votre syntaxe YAML est valide (l'indentation compte)
|
||||
- Assurez-vous d'avoir modifié le bon fichier `.customize.yaml` pour l'agent
|
||||
|
||||
**L'agent ne se charge pas ?**
|
||||
|
||||
- Vérifiez les erreurs de syntaxe YAML à l'aide d'un validateur YAML en ligne
|
||||
- Assurez-vous de ne pas avoir laissé de champs vides après les avoir décommentés
|
||||
- Essayez de revenir au modèle d'origine et de reconstruire
|
||||
|
||||
**Besoin de réinitialiser un agent ?**
|
||||
|
||||
- Effacez ou supprimez le fichier `.customize.yaml` de l'agent
|
||||
- Exécutez `npx bmad-method install` et sélectionnez **Quick Update** pour restaurer les valeurs par défaut
|
||||
|
||||
## Personnalisation des workflows
|
||||
|
||||
La personnalisation des workflows et skills existants de la méthode BMad arrive bientôt.
|
||||
|
||||
## Personnalisation des modules
|
||||
|
||||
Les conseils sur la création de modules d'extension et la personnalisation des modules existants arrivent bientôt.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Persona : définition de la personnalité, du rôle et du style de communication d'un agent IA. Permet d'adapter le comportement et les réponses de l'agent selon les besoins du projet.
|
||||
|
|
@ -0,0 +1,122 @@
|
|||
---
|
||||
title: "Projets existants"
|
||||
description: Comment utiliser la méthode BMad sur des bases de code existantes
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Utilisez la méthode BMad efficacement lorsque vous travaillez sur des projets existants et des bases de code legacy.
|
||||
|
||||
Ce guide couvre le flux de travail essentiel pour l'intégration à des projets existants avec la méthode BMad.
|
||||
|
||||
:::note[Prérequis]
|
||||
- méthode BMad installée (`npx bmad-method install`)
|
||||
- Une base de code existante sur laquelle vous souhaitez travailler
|
||||
- Accès à un IDE IA (Claude Code ou Cursor)
|
||||
:::
|
||||
|
||||
## Étape 1 : Nettoyer les artefacts de planification terminés
|
||||
|
||||
Si vous avez terminé tous les epics et stories du PRD[^1] via le processus BMad, nettoyez ces fichiers. Archivez-les, supprimez-les, ou appuyez-vous sur l'historique des versions si nécessaire. Ne conservez pas ces fichiers dans :
|
||||
|
||||
- `docs/`
|
||||
- `_bmad-output/planning-artifacts/`
|
||||
- `_bmad-output/implementation-artifacts/`
|
||||
|
||||
## Étape 2 : Créer le contexte du projet
|
||||
|
||||
:::tip[Recommandé pour les projets existants]
|
||||
Générez `project-context.md` pour capturer les patterns et conventions de votre base de code existante. Cela garantit que les agents IA suivent vos pratiques établies lors de l'implémentation des modifications.
|
||||
:::
|
||||
|
||||
Exécutez le workflow de génération de contexte du projet :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Cela analyse votre base de code pour identifier :
|
||||
- La pile technologique et les versions
|
||||
- Les patterns d'organisation du code
|
||||
- Les conventions de nommage
|
||||
- Les approches de test
|
||||
- Les patterns spécifiques aux frameworks
|
||||
|
||||
Vous pouvez examiner et affiner le fichier généré, ou le créer manuellement à `_bmad-output/project-context.md` si vous préférez.
|
||||
|
||||
[En savoir plus sur le contexte du projet](../explanation/project-context.md)
|
||||
|
||||
## Étape 3 : Maintenir une documentation de projet de qualité
|
||||
|
||||
Votre dossier `docs/` doit contenir une documentation succincte et bien organisée qui représente fidèlement votre projet :
|
||||
|
||||
- L'intention et la justification métier
|
||||
- Les règles métier
|
||||
- L'architecture
|
||||
- Toute autre information pertinente sur le projet
|
||||
|
||||
Pour les projets complexes, envisagez d'utiliser le workflow `bmad-document-project`. Il offre des variantes d'exécution qui analyseront l'ensemble de votre projet et documenteront son état actuel réel.
|
||||
|
||||
## Étape 4 : Obtenir de l'aide
|
||||
|
||||
### BMad-Help : Votre point de départ
|
||||
|
||||
**Exécutez `bmad-help` chaque fois que vous n'êtes pas sûr de la prochaine étape.** Ce guide intelligent :
|
||||
|
||||
- Inspecte votre projet pour voir ce qui a déjà été fait
|
||||
- Affiche les options basées sur vos modules installés
|
||||
- Comprend les requêtes en langage naturel
|
||||
|
||||
```
|
||||
bmad-help J'ai une app Rails existante, par où dois-je commencer ?
|
||||
bmad-help Quelle est la différence entre quick-dev et la méthode complète ?
|
||||
bmad-help Montre-moi quels workflows sont disponibles
|
||||
```
|
||||
|
||||
BMad-Help s'exécute également **automatiquement à la fin de chaque workflow**, fournissant des conseils clairs sur exactement quoi faire ensuite.
|
||||
|
||||
### Choisir votre approche
|
||||
|
||||
Vous avez deux options principales selon l'ampleur des modifications :
|
||||
|
||||
| Portée | Approche recommandée |
|
||||
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Petites mises à jour ou ajouts** | Exécutez `bmad-quick-dev` pour clarifier l'intention, planifier, implémenter et réviser dans un seul workflow. La méthode BMad complète en quatre phases est probablement excessive. |
|
||||
| **Modifications ou ajouts majeurs** | Commencez avec la méthode BMad, en appliquant autant ou aussi peu de rigueur que nécessaire. |
|
||||
|
||||
### Pendant la création du PRD
|
||||
|
||||
Lors de la création d'un brief ou en passant directement au PRD[^1], assurez-vous que l'agent :
|
||||
|
||||
- Trouve et analyse votre documentation de projet existante
|
||||
- Lit le contexte approprié sur votre système actuel
|
||||
|
||||
Vous pouvez guider l'agent explicitement, mais l'objectif est de garantir que la nouvelle fonctionnalité s'intègre bien à votre système existant.
|
||||
|
||||
### Considérations UX
|
||||
|
||||
Le travail UX[^2] est optionnel. La décision dépend non pas de savoir si votre projet a une UX, mais de :
|
||||
|
||||
- Si vous allez travailler sur des modifications UX
|
||||
- Si des conceptions ou patterns UX significatifs sont nécessaires
|
||||
|
||||
Si vos modifications se résument à de simples mises à jour d'écrans existants qui vous satisfont, un processus UX complet n'est pas nécessaire.
|
||||
|
||||
### Considérations d'architecture
|
||||
|
||||
Lors de la création de l'architecture, assurez-vous que l'architecte :
|
||||
|
||||
- Utilise les fichiers documentés appropriés
|
||||
- Analyse la base de code existante
|
||||
|
||||
Soyez particulièrement attentif ici pour éviter de réinventer la roue ou de prendre des décisions qui ne s'alignent pas avec votre architecture existante.
|
||||
|
||||
## Plus d'informations
|
||||
|
||||
- **[Corrections rapides](./quick-fixes.md)** - Corrections de bugs et modifications ad-hoc
|
||||
- **[FAQ Projets existants](../explanation/established-projects-faq.md)** - Questions courantes sur le travail sur des projets établis
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: UX (User Experience) : expérience utilisateur, englobant l'ensemble des interactions et perceptions d'un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d'utilisation.
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: "Comment obtenir des réponses à propos de BMad"
|
||||
description: Utiliser un LLM pour répondre rapidement à vos questions sur BMad
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
## Commencez ici : BMad-Help
|
||||
|
||||
**Le moyen le plus rapide d'obtenir des réponses sur BMad est le skill `bmad-help`.** Ce guide intelligent répondra à plus de 80 % de toutes les questions et est disponible directement dans votre IDE pendant que vous travaillez.
|
||||
|
||||
BMad-Help est bien plus qu'un outil de recherche — il :
|
||||
- **Inspecte votre projet** pour voir ce qui a déjà été réalisé
|
||||
- **Comprend le langage naturel** — posez vos questions en français courant
|
||||
- **S'adapte à vos modules installés** — affiche les options pertinentes
|
||||
- **Se lance automatiquement après les workflows** — vous indique exactement quoi faire ensuite
|
||||
- **Recommande la première tâche requise** — plus besoin de deviner par où commencer
|
||||
|
||||
### Comment utiliser BMad-Help
|
||||
|
||||
Appelez-le par son nom dans votre session IA :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
:::tip
|
||||
Vous pouvez également utiliser `/bmad-help` ou `$bmad-help` selon votre plateforme, mais `bmad-help` tout seul devrait fonctionner partout.
|
||||
:::
|
||||
|
||||
Combinez-le avec une requête en langage naturel :
|
||||
|
||||
```
|
||||
bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ?
|
||||
bmad-help Quelles sont mes options pour le design UX ?
|
||||
bmad-help Je suis bloqué sur le workflow PRD
|
||||
bmad-help Montre-moi ce qui a été fait jusqu'à maintenant
|
||||
```
|
||||
|
||||
BMad-Help répond avec :
|
||||
- Ce qui est recommandé pour votre situation
|
||||
- Quelle est la première tâche requise
|
||||
- À quoi ressemble le reste du processus
|
||||
|
||||
## Quand utiliser ce guide
|
||||
|
||||
Utilisez cette section lorsque :
|
||||
- Vous souhaitez comprendre l'architecture ou les éléments internes de BMad
|
||||
- Vous avez besoin de réponses au-delà de ce que BMad-Help fournit
|
||||
- Vous faites des recherches sur BMad avant l'installation
|
||||
- Vous souhaitez explorer le code source directement
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Choisissez votre source
|
||||
|
||||
| Source | Idéal pour | Exemples |
|
||||
|-------------------------|------------------------------------------------------|---------------------------------------|
|
||||
| **Dossier `_bmad`** | Comment fonctionne BMad — agents, workflows, prompts | "Que fait l'agent Analyste ?" |
|
||||
| **Repo GitHub complet** | Historique, installateur, architecture | "Qu'est-ce qui a changé dans la v6 ?" |
|
||||
| **`llms-full.txt`** | Aperçu rapide depuis la documentation | "Expliquez les quatre phases de BMad" |
|
||||
|
||||
Le dossier `_bmad` est créé lorsque vous installez BMad. Si vous ne l'avez pas encore, clonez le repo à la place.
|
||||
|
||||
### 2. Pointez votre IA vers la source
|
||||
|
||||
**Si votre IA peut lire des fichiers (Claude Code, Cursor, etc.) :**
|
||||
|
||||
- **BMad installé :** Pointez vers le dossier `_bmad` et posez vos questions directement
|
||||
- **Vous voulez plus de contexte :** Clonez le [repo complet](https://github.com/bmad-code-org/BMAD-METHOD)
|
||||
|
||||
**Si vous utilisez ChatGPT ou Claude.ai (LLM en ligne) :**
|
||||
|
||||
Importez `llms-full.txt` dans votre session :
|
||||
|
||||
```text
|
||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
```
|
||||
|
||||
|
||||
### 3. Posez votre question
|
||||
|
||||
:::note[Exemple]
|
||||
**Q :** "Quel est le moyen le plus rapide de construire quelque chose avec BMad ?"
|
||||
|
||||
**R :** Utilisez le workflow Quick Dev : Lancez `bmad-quick-dev` — il clarifie votre intention, planifie, implémente, révise et présente les résultats dans un seul workflow, en sautant les phases de planification complètes.
|
||||
:::
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
Des réponses directes sur BMad — comment fonctionnent les agents, ce que font les workflows, pourquoi les choses sont structurées ainsi — sans attendre la réponse de quelqu'un.
|
||||
|
||||
## Conseils
|
||||
|
||||
- **Vérifiez les réponses surprenantes** — Les LLM font parfois des erreurs. Consultez le fichier source ou posez la question sur Discord.
|
||||
- **Soyez précis** — "Que fait l'étape 3 du workflow PRD ?" est mieux que "Comment fonctionne le PRD ?"
|
||||
|
||||
## Toujours bloqué ?
|
||||
|
||||
Avez-vous essayé l'approche LLM et avez encore besoin d'aide ? Vous avez maintenant une bien meilleure question à poser.
|
||||
|
||||
| Canal | Utilisé pour |
|
||||
| ------------------------- | ------------------------------------------- |
|
||||
| `#bmad-method-help` | Questions rapides (chat en temps réel) |
|
||||
| Forum `help-requests` | Questions détaillées (recherchables, persistants) |
|
||||
| `#suggestions-feedback` | Idées et demandes de fonctionnalités |
|
||||
| `#report-bugs-and-issues` | Rapports de bugs |
|
||||
|
||||
**Discord :** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
||||
|
||||
**GitHub Issues :** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (pour les bugs clairs)
|
||||
|
||||
*Toi !*
|
||||
*Bloqué*
|
||||
*dans la file d'attente—*
|
||||
*qui*
|
||||
*attends-tu ?*
|
||||
|
||||
*La source*
|
||||
*est là,*
|
||||
*facile à voir !*
|
||||
|
||||
*Pointez*
|
||||
*votre machine.*
|
||||
*Libérez-la.*
|
||||
|
||||
*Elle lit.*
|
||||
*Elle parle.*
|
||||
*Demandez—*
|
||||
|
||||
*Pourquoi attendre*
|
||||
*demain*
|
||||
*quand tu as déjà*
|
||||
*cette journée ?*
|
||||
|
||||
*—Claude*
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
---
|
||||
title: "Comment installer BMad"
|
||||
description: Guide étape par étape pour installer BMad dans votre projet
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
Utilisez la commande `npx bmad-method install` pour configurer BMad dans votre projet avec votre choix de modules et d'outils d'IA.
|
||||
|
||||
Si vous souhaitez utiliser un installateur non interactif et fournir toutes les options d'installation en ligne de commande, consultez [ce guide](./non-interactive-installation.md).
|
||||
|
||||
## Quand l'utiliser
|
||||
|
||||
- Démarrer un nouveau projet avec BMad
|
||||
- Ajouter BMad à une base de code existante
|
||||
- Mettre à jour une installation BMad existante
|
||||
|
||||
:::note[Prérequis]
|
||||
- **Node.js** 20+ (requis pour l'installateur)
|
||||
- **Git** (recommandé)
|
||||
- **Outil d'IA** (Claude Code, Cursor, ou similaire)
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Lancer l'installateur
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
:::tip[Vous voulez la dernière version préliminaire ?]
|
||||
Utilisez le dist-tag `next` :
|
||||
```bash
|
||||
npx bmad-method@next install
|
||||
```
|
||||
|
||||
Cela vous permet d'obtenir les nouvelles modifications plus tôt, avec un risque plus élevé de changements que l'installation par défaut.
|
||||
:::
|
||||
|
||||
:::tip[Version de développement]
|
||||
Pour installer la dernière version depuis la branche main (peut être instable) :
|
||||
```bash
|
||||
npx github:bmad-code-org/BMAD-METHOD install
|
||||
```
|
||||
:::
|
||||
|
||||
### 2. Choisir l'emplacement d'installation
|
||||
|
||||
L'installateur vous demandera où installer les fichiers BMad :
|
||||
|
||||
- Répertoire courant (recommandé pour les nouveaux projets si vous avez créé le répertoire vous-même et l'exécutez depuis ce répertoire)
|
||||
- Chemin personnalisé
|
||||
|
||||
### 3. Sélectionner vos outils d'IA
|
||||
|
||||
Choisissez les outils d'IA que vous utilisez :
|
||||
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Autres
|
||||
|
||||
Chaque outil a sa propre façon d'intégrer les skills. L'installateur crée de petits fichiers de prompt pour activer les workflows et les agents — il les place simplement là où votre outil s'attend à les trouver.
|
||||
|
||||
:::note[Activer les skills]
|
||||
Certaines plateformes nécessitent que les skills soient explicitement activés dans les paramètres avant d'apparaître. Si vous installez BMad et ne voyez pas les skills, vérifiez les paramètres de votre plateforme ou demandez à votre assistant IA comment activer les skills.
|
||||
:::
|
||||
|
||||
### 4. Choisir les modules
|
||||
|
||||
L'installateur affiche les modules disponibles. Sélectionnez ceux dont vous avez besoin — la plupart des utilisateurs veulent simplement **méthode BMad** (le module de développement logiciel).
|
||||
|
||||
### 5. Suivre les instructions
|
||||
|
||||
L'installateur vous guide pour le reste — contenu personnalisé, paramètres, etc.
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
```text
|
||||
votre-projet/
|
||||
├── _bmad/
|
||||
│ ├── bmm/ # Vos modules sélectionnés
|
||||
│ │ └── config.yaml # Paramètres du module (si vous devez les modifier)
|
||||
│ ├── core/ # Module core requis
|
||||
│ └── ...
|
||||
├── _bmad-output/ # Artefacts générés
|
||||
├── .claude/ # Skills Claude Code (si vous utilisez Claude Code)
|
||||
│ └── skills/
|
||||
│ ├── bmad-help/
|
||||
│ ├── bmad-persona/
|
||||
│ └── ...
|
||||
└── .cursor/ # Skills Cursor (si vous utilisez Cursor)
|
||||
└── skills/
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Vérifier l'installation
|
||||
|
||||
Exécutez `bmad-help` pour vérifier que tout fonctionne et voir quoi faire ensuite.
|
||||
|
||||
**BMad-Help est votre guide intelligent** qui va :
|
||||
- Confirmer que votre installation fonctionne
|
||||
- Afficher ce qui est disponible en fonction de vos modules installés
|
||||
- Recommander votre première étape
|
||||
|
||||
Vous pouvez aussi lui poser des questions :
|
||||
```
|
||||
bmad-help Je viens d'installer, que dois-je faire en premier ?
|
||||
bmad-help Quelles sont mes options pour un projet SaaS ?
|
||||
```
|
||||
|
||||
## Résolution de problèmes
|
||||
|
||||
**L'installateur affiche une erreur** — Copiez-collez la sortie dans votre assistant IA et laissez-le résoudre le problème.
|
||||
|
||||
**L'installateur a fonctionné mais quelque chose ne fonctionne pas plus tard** — Votre IA a besoin du contexte BMad pour vous aider. Consultez [Comment obtenir des réponses à propos de BMad](./get-answers-about-bmad.md) pour savoir comment diriger votre IA vers les bonnes sources.
|
||||
|
|
@ -0,0 +1,171 @@
|
|||
---
|
||||
title: Installation non-interactive
|
||||
description: Installer BMad en utilisant des options de ligne de commande pour les pipelines CI/CD et les déploiements automatisés
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Utilisez les options de ligne de commande pour installer BMad de manière non-interactive. Cela est utile pour :
|
||||
|
||||
## Quand utiliser cette méthode
|
||||
|
||||
- Déploiements automatisés et pipelines CI/CD
|
||||
- Installations scriptées
|
||||
- Installations par lots sur plusieurs projets
|
||||
- Installations rapides avec des configurations connues
|
||||
|
||||
:::note[Prérequis]
|
||||
Nécessite [Node.js](https://nodejs.org) v20+ et `npx` (inclus avec npm).
|
||||
:::
|
||||
|
||||
## Options disponibles
|
||||
|
||||
### Options d'installation
|
||||
|
||||
| Option | Description | Exemple |
|
||||
|------|-------------|---------|
|
||||
| `--directory <chemin>` | Répertoire d'installation | `--directory ~/projects/myapp` |
|
||||
| `--modules <modules>` | IDs de modules séparés par des virgules | `--modules bmm,bmb` |
|
||||
| `--tools <outils>` | IDs d'outils/IDE séparés par des virgules (utilisez `none` pour ignorer) | `--tools claude-code,cursor` ou `--tools none` |
|
||||
| `--custom-content <chemins>` | Chemins vers des modules personnalisés séparés par des virgules | `--custom-content ~/my-module,~/another-module` |
|
||||
| `--action <type>` | Action pour les installations existantes : `install` (par défaut), `update`, ou `quick-update` | `--action quick-update` |
|
||||
|
||||
### Configuration principale
|
||||
|
||||
| Option | Description | Par défaut |
|
||||
|------|-------------|---------|
|
||||
| `--user-name <nom>` | Nom à utiliser par les agents | Nom d'utilisateur système |
|
||||
| `--communication-language <langue>` | Langue de communication des agents | Anglais |
|
||||
| `--document-output-language <langue>` | Langue de sortie des documents | Anglais |
|
||||
| `--output-folder <chemin>` | Chemin du dossier de sortie | _bmad-output |
|
||||
|
||||
### Autres options
|
||||
|
||||
| Option | Description |
|
||||
|------|-------------|
|
||||
| `-y, --yes` | Accepter tous les paramètres par défaut et ignorer les invites |
|
||||
| `-d, --debug` | Activer la sortie de débogage pour la génération du manifeste |
|
||||
|
||||
## IDs de modules
|
||||
|
||||
IDs de modules disponibles pour l’option `--modules` :
|
||||
|
||||
- `bmm` — méthode BMad Master
|
||||
- `bmb` — BMad Builder
|
||||
|
||||
Consultez le [registre BMad](https://github.com/bmad-code-org) pour les modules externes disponibles.
|
||||
|
||||
## IDs d'outils/IDE
|
||||
|
||||
IDs d'outils disponibles pour l’option `--tools` :
|
||||
|
||||
**Recommandés :** `claude-code`, `cursor`
|
||||
|
||||
Exécutez `npx bmad-method install` de manière interactive une fois pour voir la liste complète actuelle des outils pris en charge, ou consultez la [configuration des codes de la plateforme](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
||||
|
||||
## Modes d'installation
|
||||
|
||||
| Mode | Description | Exemple |
|
||||
|------|-------------|---------|
|
||||
| Entièrement non-interactif | Fournir toutes les options pour ignorer toutes les invites | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
|
||||
| Semi-interactif | Fournir certains options ; BMad demande les autres | `npx bmad-method install --directory . --modules bmm` |
|
||||
| Paramètres par défaut uniquement | Accepter tous les paramètres par défaut avec `-y` | `npx bmad-method install --yes` |
|
||||
| Sans outils | Ignorer la configuration des outils/IDE | `npx bmad-method install --modules bmm --tools none` |
|
||||
|
||||
## Exemples
|
||||
|
||||
### Installation dans un pipeline CI/CD
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# install-bmad.sh
|
||||
|
||||
npx bmad-method install \
|
||||
--directory "${GITHUB_WORKSPACE}" \
|
||||
--modules bmm \
|
||||
--tools claude-code \
|
||||
--user-name "CI Bot" \
|
||||
--communication-language Français \
|
||||
--document-output-language Français \
|
||||
--output-folder _bmad-output \
|
||||
--yes
|
||||
```
|
||||
|
||||
### Mettre à jour une installation existante
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action update \
|
||||
--modules bmm,bmb,custom-module
|
||||
```
|
||||
|
||||
### Mise à jour rapide (conserver les paramètres)
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action quick-update
|
||||
```
|
||||
|
||||
### Installation avec du contenu personnalisé
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--modules bmm \
|
||||
--custom-content ~/my-custom-module,~/another-module \
|
||||
--tools claude-code
|
||||
```
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
- Un répertoire `_bmad/` entièrement configuré dans votre projet
|
||||
- Des agents et des flux de travail configurés pour vos modules et outils sélectionnés
|
||||
- Un dossier `_bmad-output/` pour les artefacts générés
|
||||
|
||||
## Validation et gestion des erreurs
|
||||
|
||||
BMad valide toutes les options fournis :
|
||||
|
||||
- **Directory** — Doit être un chemin valide avec des permissions d'écriture
|
||||
- **Modules** — Avertit des IDs de modules invalides (mais n'échoue pas)
|
||||
- **Tools** — Avertit des IDs d'outils invalides (mais n'échoue pas)
|
||||
- **Custom Content** — Chaque chemin doit contenir un fichier `module.yaml` valide
|
||||
- **Action** — Doit être l'une des suivantes : `install`, `update`, `quick-update`
|
||||
|
||||
Les valeurs invalides entraîneront soit :
|
||||
1. L’affichage d’un message d'erreur suivi d’un exit (pour les options critiques comme le répertoire)
|
||||
2. Un avertissement puis la continuation de l’installation (pour les éléments optionnels comme le contenu personnalisé)
|
||||
3. Un retour aux invites interactives (pour les valeurs requises manquantes)
|
||||
|
||||
:::tip[Bonnes pratiques]
|
||||
- Utilisez des chemins absolus pour `--directory` pour éviter toute ambiguïté
|
||||
- Testez les options localement avant de les utiliser dans des pipelines CI/CD
|
||||
- Combinez avec `-y` pour des installations vraiment sans surveillance
|
||||
- Utilisez `--debug` si vous rencontrez des problèmes lors de l'installation
|
||||
:::
|
||||
|
||||
## Résolution des problèmes
|
||||
|
||||
### L'installation échoue avec "Invalid directory"
|
||||
|
||||
- Le chemin du répertoire doit exister (ou son parent doit exister)
|
||||
- Vous avez besoin des permissions d'écriture
|
||||
- Le chemin doit être absolu ou correctement relatif au répertoire actuel
|
||||
|
||||
### Module non trouvé
|
||||
|
||||
- Vérifiez que l'ID du module est correct
|
||||
- Les modules externes doivent être disponibles dans le registre
|
||||
|
||||
### Chemin de contenu personnalisé invalide
|
||||
|
||||
Assurez-vous que chaque chemin de contenu personnalisé :
|
||||
- Pointe vers un répertoire
|
||||
- Contient un fichier `module.yaml` à la racine
|
||||
- Possède un champ `code` dans `module.yaml`
|
||||
|
||||
:::note[Toujours bloqué ?]
|
||||
Exécutez avec `--debug` pour une sortie détaillée, essayez le mode interactif pour isoler le problème, ou signalez-le à <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
|
||||
:::
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
---
|
||||
title: "Gérer le contexte du projet"
|
||||
description: Créer et maintenir project-context.md pour guider les agents IA
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
|
||||
Utilisez le fichier `project-context.md` pour garantir que les agents IA respectent les préférences techniques et les règles d'implémentation de votre projet tout au long des workflows. Pour vous assurer qu'il est toujours disponible, vous pouvez également ajouter la ligne `Le contexte et les conventions importantes du projet se trouvent dans [chemin vers le contexte du projet]/project-context.md` à votre fichier de contexte ou de règles permanentes (comme `AGENTS.md`).
|
||||
|
||||
:::note[Prérequis]
|
||||
- Méthode BMad installée
|
||||
- Connaissance de la pile technologique et des conventions de votre projet
|
||||
:::
|
||||
|
||||
## Quand utiliser cette fonctionnalité
|
||||
|
||||
- Vous avez des préférences techniques fortes avant de commencer l'architecture
|
||||
- Vous avez terminé l'architecture et souhaitez consigner les décisions pour l'implémentation
|
||||
- Vous travaillez sur une base de code existante avec des patterns établis
|
||||
- Vous remarquez que les agents prennent des décisions incohérentes entre les stories
|
||||
|
||||
## Étape 1 : Choisissez votre approche
|
||||
|
||||
**Création manuelle** — Idéal lorsque vous savez exactement quelles règles vous souhaitez documenter
|
||||
|
||||
**Génération après l'architecture** — Idéal pour capturer les décisions prises lors du solutioning
|
||||
|
||||
**Génération pour les projets existants** — Idéal pour découvrir les patterns dans les bases de code existantes
|
||||
|
||||
## Étape 2 : Créez le fichier
|
||||
|
||||
### Option A : Création manuelle
|
||||
|
||||
Créez le fichier à l'emplacement `_bmad-output/project-context.md` :
|
||||
|
||||
```bash
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Ajoutez votre pile technologique et vos règles d'implémentation :
|
||||
|
||||
```markdown
|
||||
---
|
||||
project_name: 'MonProjet'
|
||||
user_name: 'VotreNom'
|
||||
date: '2026-02-15'
|
||||
sections_completed: ['technology_stack', 'critical_rules']
|
||||
---
|
||||
|
||||
# Contexte de Projet pour Agents IA
|
||||
|
||||
## Pile Technologique & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State : Zustand
|
||||
- Tests : Vitest, Playwright
|
||||
- Styles : Tailwind CSS
|
||||
|
||||
## Règles d'Implémentation Critiques
|
||||
|
||||
**TypeScript :**
|
||||
- Mode strict activé, pas de types `any`
|
||||
- Utiliser `interface` pour les API publiques, `type` pour les unions
|
||||
|
||||
**Organisation du Code :**
|
||||
- Composants dans `/src/components/` avec tests co-localisés
|
||||
- Les appels API utilisent le singleton `apiClient` — jamais de fetch direct
|
||||
|
||||
**Tests :**
|
||||
- Tests unitaires axés sur la logique métier
|
||||
- Tests d'intégration utilisent MSW pour le mock API
|
||||
```
|
||||
|
||||
### Option B : Génération après l'architecture
|
||||
|
||||
Exécutez le workflow dans une nouvelle conversation :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre document d'architecture et vos fichiers projet pour générer un fichier de contexte qui capture les décisions prises.
|
||||
|
||||
### Option C : Génération pour les projets existants
|
||||
|
||||
Pour les projets existants, exécutez :
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
Le workflow analyse votre base de code pour identifier les conventions, puis génère un fichier de contexte que vous pouvez réviser et affiner.
|
||||
|
||||
## Étape 3 : Vérifiez le contenu
|
||||
|
||||
Révisez le fichier généré et assurez-vous qu'il capture :
|
||||
|
||||
- Les versions correctes des technologies
|
||||
- Vos conventions réelles (pas les bonnes pratiques génériques)
|
||||
- Les règles qui évitent les erreurs courantes
|
||||
- Les patterns spécifiques aux frameworks
|
||||
|
||||
Modifiez manuellement pour ajouter les éléments manquants ou supprimer les inexactitudes.
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
Un fichier `project-context.md` qui :
|
||||
|
||||
- Garantit que tous les agents suivent les mêmes conventions
|
||||
- Évite les décisions incohérentes entre les stories
|
||||
- Capture les décisions d'architecture pour l'implémentation
|
||||
- Sert de référence pour les patterns et règles de votre projet
|
||||
|
||||
## Conseils
|
||||
|
||||
:::tip[Bonnes pratiques]
|
||||
- **Concentrez-vous sur ce qui n'est pas évident** — Documentez les patterns que les agents pourraient manquer (par ex. « Utiliser JSDoc sur chaque classe publique »), et non les pratiques universelles comme « utiliser des noms de variables significatifs ».
|
||||
- **Gardez-le concis** — Ce fichier est chargé par chaque workflow d'implémentation. Les fichiers longs gaspillent le contexte. Excluez le contenu qui ne s'applique qu'à un périmètre restreint ou à des stories spécifiques.
|
||||
- **Mettez à jour si nécessaire** — Modifiez manuellement lorsque les patterns changent, ou régénérez après des changements d'architecture significatifs.
|
||||
- Fonctionne aussi bien pour Quick Dev que pour les projets complets méthode BMad.
|
||||
:::
|
||||
|
||||
## Prochaines étapes
|
||||
|
||||
- [**Explication du contexte projet**](../explanation/project-context.md) — En savoir plus sur son fonctionnement
|
||||
- [**Carte des workflows**](../reference/workflow-map.md) — Voir quels workflows chargent le contexte projet
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
title: "Corrections Rapides"
|
||||
description: Comment effectuer des corrections rapides et des modifications ciblées
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Utilisez **Quick Dev** pour les corrections de bugs, les refactorisations ou les petites modifications ciblées qui ne nécessitent pas la méthode BMad complète.
|
||||
|
||||
## Quand Utiliser Cette Approche
|
||||
|
||||
- Corrections de bugs avec une cause claire et connue
|
||||
- Petites refactorisations (renommage, extraction, restructuration) contenues dans quelques fichiers
|
||||
- Ajustements mineurs de fonctionnalités ou modifications de configuration
|
||||
- Mises à jour de dépendances
|
||||
|
||||
:::note[Prérequis]
|
||||
- Méthode BMad installée (`npx bmad-method install`)
|
||||
- Un IDE IA (Claude Code, Cursor, ou similaire)
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Démarrer une Nouvelle Conversation
|
||||
|
||||
Ouvrez une **nouvelle conversation** dans votre IDE IA. Réutiliser une session d'un workflow précédent peut causer des conflits de contexte.
|
||||
|
||||
### 2. Spécifiez Votre Intention
|
||||
|
||||
Quick Dev accepte l'intention en forme libre — avant, avec, ou après l'invocation. Exemples :
|
||||
|
||||
```text
|
||||
quick-dev — Corrige le bug de validation de connexion qui permet les mots de passe vides.
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev — corrige https://github.com/org/repo/issues/42
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev — implémente _bmad-output/implementation-artifacts/my-intent.md
|
||||
```
|
||||
|
||||
```text
|
||||
Je pense que le problème est dans le middleware d'auth, il ne vérifie pas l'expiration du token.
|
||||
Regardons... oui, src/auth/middleware.ts ligne 47 saute complètement la vérification exp. lance quick-dev
|
||||
```
|
||||
|
||||
```text
|
||||
quick-dev
|
||||
> Que voulez-vous faire ?
|
||||
Refactoriser UserService pour utiliser async/await au lieu des callbacks.
|
||||
```
|
||||
|
||||
Texte brut, chemins de fichiers, URLs d'issues GitHub, liens de trackers de bugs — tout ce que le LLM peut résoudre en une intention concrète.
|
||||
|
||||
### 3. Répondre aux Questions et Approuver
|
||||
|
||||
Quick Dev peut poser des questions de clarification ou présenter une courte spécification demandant votre approbation avant l'implémentation. Répondez à ses questions et approuvez lorsque vous êtes satisfait du plan.
|
||||
|
||||
### 4. Réviser et Pousser
|
||||
|
||||
Quick Dev implémente la modification, révise son propre travail, corrige les problèmes et effectue un commit local. Lorsqu'il a terminé, il ouvre les fichiers affectés dans votre éditeur.
|
||||
|
||||
- Parcourez le diff pour confirmer que la modification correspond à votre intention
|
||||
- Si quelque chose semble incorrect, dites à l'agent ce qu'il faut corriger — il peut itérer dans la même session
|
||||
|
||||
Une fois satisfait, poussez le commit. Quick Dev vous proposera de pousser et de créer une PR pour vous.
|
||||
|
||||
:::caution[Si Quelque Chose Casse]
|
||||
Si une modification poussée cause des problèmes inattendus, utilisez `git revert HEAD` pour annuler proprement le dernier commit. Ensuite, démarrez une nouvelle conversation et exécutez Quick Dev à nouveau pour essayer une approche différente.
|
||||
:::
|
||||
|
||||
## Ce Que Vous Obtenez
|
||||
|
||||
- Fichiers source modifiés avec la correction ou refactorisation appliquée
|
||||
- Tests passants (si votre projet a une suite de tests)
|
||||
- Un commit prêt à pousser avec un message de commit conventionnel
|
||||
|
||||
## Travail Différé
|
||||
|
||||
Quick Dev garde chaque exécution concentrée sur un seul objectif. Si votre demande contient plusieurs objectifs indépendants, ou si la revue remonte des problèmes préexistants non liés à votre modification, Quick Dev les diffère vers un fichier (`deferred-work.md` dans votre répertoire d'artefacts d'implémentation) plutôt que d'essayer de tout régler en même temps.
|
||||
|
||||
Consultez ce fichier après une exécution — c'est votre backlog[^1] de choses sur lesquelles revenir. Chaque élément différé peut être introduit dans une nouvelle exécution Quick Dev ultérieurement.
|
||||
|
||||
## Quand Passer à une Planification Formelle
|
||||
|
||||
Envisagez d'utiliser la méthode BMad complète lorsque :
|
||||
|
||||
- La modification affecte plusieurs systèmes ou nécessite des mises à jour coordonnées dans de nombreux fichiers
|
||||
- Vous n'êtes pas sûr de la portée et avez besoin d'une découverte des exigences d'abord
|
||||
- Vous avez besoin de documentation ou de décisions architecturales enregistrées pour l'équipe
|
||||
|
||||
Voir [Quick Dev](../explanation/quick-dev.md) pour plus d'informations sur la façon dont Quick Dev s'intègre dans la méthode BMad.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Backlog : liste priorisée de tâches ou d'éléments de travail à traiter ultérieurement, issue des méthodologies agiles.
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
title: "Guide de Division de Documents"
|
||||
description: Diviser les fichiers markdown volumineux en fichiers plus petits et organisés pour une meilleure gestion du contexte
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
Utilisez l'outil `bmad-shard-doc` si vous avez besoin de diviser des fichiers markdown volumineux en fichiers plus petits et organisés pour une meilleure gestion du contexte.
|
||||
|
||||
:::caution[Déprécié]
|
||||
Ceci n'est plus recommandé, et bientôt avec les workflows mis à jour et la plupart des LLM et outils majeurs supportant les sous-processus, cela deviendra inutile.
|
||||
:::
|
||||
|
||||
## Quand l’Utiliser
|
||||
|
||||
Utilisez ceci uniquement si vous remarquez que votre combinaison outil / modèle ne parvient pas à charger et lire tous les documents en entrée lorsque c'est nécessaire.
|
||||
|
||||
## Qu'est-ce que la Division de Documents ?
|
||||
|
||||
La division de documents divise les fichiers markdown volumineux en fichiers plus petits et organisés basés sur les titres de niveau 2 (`## Titre`).
|
||||
|
||||
### Architecture
|
||||
|
||||
```text
|
||||
Avant Division :
|
||||
_bmad-output/planning-artifacts/
|
||||
└── PRD.md (fichier volumineux de 50k tokens)
|
||||
|
||||
Après Division :
|
||||
_bmad-output/planning-artifacts/
|
||||
└── prd/
|
||||
├── index.md # Table des matières avec descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Sections supplémentaires
|
||||
```
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Exécuter l'Outil Shard-Doc
|
||||
|
||||
```bash
|
||||
/bmad-shard-doc
|
||||
```
|
||||
|
||||
### 2. Suivre le Processus Interactif
|
||||
|
||||
```text
|
||||
Agent : Quel document souhaitez-vous diviser ?
|
||||
Utilisateur : docs/PRD.md
|
||||
|
||||
Agent : Destination par défaut : docs/prd/
|
||||
Accepter la valeur par défaut ? [y/n]
|
||||
Utilisateur : y
|
||||
|
||||
Agent : Division de PRD.md...
|
||||
✓ 12 fichiers de section créés
|
||||
✓ index.md généré
|
||||
✓ Terminé !
|
||||
```
|
||||
|
||||
## Comment Fonctionne la Découverte de Workflow
|
||||
|
||||
Les workflows BMad utilisent un **système de découverte double** :
|
||||
|
||||
1. **Essaye d'abord le document entier** - Rechercher `document-name.md`
|
||||
2. **Vérifie la version divisée** - Rechercher `document-name/index.md`
|
||||
3. **Règle de priorité** - Le document entier a la priorité si les deux existent - supprimez le document entier si vous souhaitez que la version divisée soit utilisée à la place
|
||||
|
||||
## Support des Workflows
|
||||
|
||||
Tous les workflows BMM prennent en charge les deux formats :
|
||||
|
||||
- Documents entiers
|
||||
- Documents divisés
|
||||
- Détection automatique
|
||||
- Transparent pour l'utilisateur
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
---
|
||||
title: "Comment passer à la v6"
|
||||
description: Migrer de BMad v4 vers v6
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
Utilisez l'installateur BMad pour passer de la v4 à la v6, qui inclut une détection automatique des installations existantes et une assistance à la migration.
|
||||
|
||||
## Quand utiliser ce guide
|
||||
|
||||
- Vous avez BMad v4 installé (dossier `.bmad-method`)
|
||||
- Vous souhaitez migrer vers la nouvelle architecture v6
|
||||
- Vous avez des artefacts de planification existants à préserver
|
||||
|
||||
:::note[Prérequis]
|
||||
- Node.js 20+
|
||||
- Installation BMad v4 existante
|
||||
:::
|
||||
|
||||
## Étapes
|
||||
|
||||
### 1. Lancer l'installateur
|
||||
|
||||
Suivez les [Instructions d'installation](./install-bmad.md).
|
||||
|
||||
### 2. Gérer l'installation existante
|
||||
|
||||
Quand v4 est détecté, vous pouvez :
|
||||
|
||||
- Autoriser l'installateur à sauvegarder et supprimer `.bmad-method`
|
||||
- Quitter et gérer le nettoyage manuellement
|
||||
|
||||
Si vous avez nommé votre dossier de méthode bmad autrement, vous devrez supprimer le dossier vous-même manuellement.
|
||||
|
||||
### 3. Nettoyer les skills IDE
|
||||
|
||||
Supprimez manuellement les commandes/skills IDE v4 existants - par exemple si vous avez Claude Code, recherchez tous les dossiers imbriqués qui commencent par bmad et supprimez-les :
|
||||
|
||||
- `.claude/commands/`
|
||||
|
||||
Les nouveaux skills v6 sont installés dans :
|
||||
|
||||
- `.claude/skills/`
|
||||
|
||||
### 4. Migrer les artefacts de planification
|
||||
|
||||
**Si vous avez des documents de planification (Brief/PRD/UX/Architecture) :**
|
||||
|
||||
Déplacez-les dans `_bmad-output/planning-artifacts/` avec des noms descriptifs :
|
||||
|
||||
- Incluez `PRD` dans le nom de fichier pour les documents PRD[^1]
|
||||
- Incluez `brief`, `architecture`, ou `ux-design` selon le cas
|
||||
- Les documents divisés peuvent être dans des sous-dossiers nommés
|
||||
|
||||
**Si vous êtes en cours de planification :** Envisagez de redémarrer avec les workflows v6. Utilisez vos documents existants comme entrées - les nouveaux workflows de découverte progressive avec recherche web et mode plan IDE produisent de meilleurs résultats.
|
||||
|
||||
### 5. Migrer le développement en cours
|
||||
|
||||
Si vous avez des stories[^3] créées ou implémentées :
|
||||
|
||||
1. Terminez l'installation v6
|
||||
2. Placez `epics.md` ou `epics/epic*.md`[^2] dans `_bmad-output/planning-artifacts/`
|
||||
3. Lancez le workflow `bmad-sprint-planning`[^4]
|
||||
4. Indiquez quels epics/stories sont déjà terminés
|
||||
|
||||
## Ce que vous obtenez
|
||||
|
||||
**Structure unifiée v6 :**
|
||||
|
||||
```text
|
||||
votre-projet/
|
||||
├── _bmad/ # Dossier d'installation unique
|
||||
│ ├── _config/ # Vos personnalisations
|
||||
│ │ └── agents/ # Fichiers de personnalisation des agents
|
||||
│ ├── core/ # Framework core universel
|
||||
│ ├── bmm/ # Module BMad Method
|
||||
│ ├── bmb/ # BMad Builder
|
||||
│ └── cis/ # Creative Intelligence Suite
|
||||
└── _bmad-output/ # Dossier de sortie (était le dossier doc en v4)
|
||||
```
|
||||
|
||||
## Migration des modules
|
||||
|
||||
| Module v4 | Statut v6 |
|
||||
| ----------------------------- | ----------------------------------------- |
|
||||
| `.bmad-2d-phaser-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-2d-unity-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-godot-game-dev` | Intégré dans le Module BMGD |
|
||||
| `.bmad-infrastructure-devops` | Déprécié - nouvel agent DevOps bientôt disponible |
|
||||
| `.bmad-creative-writing` | Non adapté - nouveau module v6 bientôt disponible |
|
||||
|
||||
## Changements clés
|
||||
|
||||
| Concept | v4 | v6 |
|
||||
| ------------- | ------------------------------------- | ------------------------------------ |
|
||||
| **Core** | `_bmad-core` était en fait la méthode BMad | `_bmad/core/` est le framework universel |
|
||||
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||
| **Config** | Fichiers modifiés directement | `config.yaml` par module |
|
||||
| **Documents** | Division ou non division requise | Entièrement flexible, scan automatique |
|
||||
|
||||
## Glossaire
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Epic : dans les méthodologies agiles, une grande unité de travail qui peut être décomposée en plusieurs stories. Un epic représente généralement une fonctionnalité majeure ou un ensemble de capacités livrable sur plusieurs sprints.
|
||||
[^3]: Story (User Story) : une description courte et simple d'une fonctionnalité du point de vue de l'utilisateur. Les stories sont des unités de travail suffisamment petites pour être complétées en un sprint.
|
||||
[^4]: Sprint : dans Scrum, une période de temps fixe (généralement 1 à 4 semaines) pendant laquelle l'équipe travaille à livrer un incrément de produit potentiellement libérable.
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: Bienvenue dans la méthode BMad
|
||||
description: Framework de développement propulsé par l'IA avec des agents spécialisés, des workflows guidés et une planification intelligente
|
||||
---
|
||||
|
||||
La méthode BMad (**B**uild **M**ore **A**rchitect **D**reams) est un module[^1] de développement assisté par l'IA au sein de l'écosystème BMad, conçu pour vous faciliter la création de logiciels par un processus complet, de l'idéation et de la planification jusqu'à l'implémentation agentique. Elle fournit des agents[^2] IA spécialisés, des workflows guidés et une planification intelligente qui s'adapte à la complexité de votre projet, que vous corrigiez un bug ou construisiez une plateforme d'entreprise.
|
||||
|
||||
Si vous êtes à l'aise avec les assistants de codage IA comme Claude, Cursor ou GitHub Copilot, vous êtes prêt à commencer.
|
||||
|
||||
:::note[🚀 La V6 est là et ce n'est que le début !]
|
||||
Architecture par Skills, BMad Builder v1, automatisation Dev Loop, et bien plus encore en préparation. **[Consultez la Feuille de route →](./roadmap)**
|
||||
:::
|
||||
|
||||
## Première visite ? Commencez par un tutoriel
|
||||
|
||||
La façon la plus rapide de comprendre BMad est de l'essayer.
|
||||
|
||||
- **[Premiers pas avec BMad](./tutorials/getting-started.md)** — Installez et comprenez comment fonctionne BMad
|
||||
- **[Carte des workflows](./reference/workflow-map.md)** — Vue d'ensemble visuelle des phases BMM, des workflows et de la gestion du contexte
|
||||
|
||||
:::tip[Envie de plonger directement ?]
|
||||
Installez BMad et utilisez le skill[^3] `bmad-help` — il vous guidera entièrement en fonction de votre projet et de vos modules installés.
|
||||
:::
|
||||
|
||||
## Comment utiliser cette documentation
|
||||
|
||||
Cette documentation est organisée en quatre sections selon ce que vous essayez de faire :
|
||||
|
||||
| Section | Objectif |
|
||||
| ----------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| **Tutoriels** | Orientés apprentissage. Guides étape par étape qui vous accompagnent dans la construction de quelque chose. Commencez ici si vous êtes nouveau. |
|
||||
| **Guides pratiques** | Orientés tâches. Guides pratiques pour résoudre des problèmes spécifiques. « Comment personnaliser un agent ? » se trouve ici. |
|
||||
| **Explication** | Orientés compréhension. Explications en profondeur des concepts et de l'architecture. À lire quand vous voulez savoir *pourquoi*. |
|
||||
| **Référence** | Orientés information. Spécifications techniques pour les agents, workflows et configuration. |
|
||||
|
||||
## Étendre et personnaliser
|
||||
|
||||
Vous souhaitez étendre BMad avec vos propres agents, workflows ou modules ? Le **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** fournit le framework et les outils pour créer des extensions personnalisées, que vous ajoutiez de nouvelles capacités à BMad ou que vous construisiez des modules entièrement nouveaux à partir de zéro.
|
||||
|
||||
## Ce dont vous aurez besoin
|
||||
|
||||
BMad fonctionne avec tout assistant de codage IA qui prend en charge les prompts système personnalisés ou le contexte de projet. Les options populaires incluent :
|
||||
|
||||
- **[Claude Code](https://code.claude.com)** — Outil CLI d'Anthropic (recommandé)
|
||||
- **[Cursor](https://cursor.sh)** — Éditeur de code propulsé par l'IA
|
||||
- **[Codex CLI](https://github.com/openai/codex)** — Agent de codage terminal d'OpenAI
|
||||
|
||||
Vous devriez être à l'aise avec les concepts de base du développement logiciel comme le contrôle de version, la structure de projet et les workflows agiles. Aucune expérience préalable avec les systèmes d'agent de type BMad n'est requise — c'est justement le but de cette documentation.
|
||||
|
||||
## Rejoindre la communauté
|
||||
|
||||
Obtenez de l'aide, partagez ce que vous construisez ou contribuez à BMad :
|
||||
|
||||
- **[Discord](https://discord.gg/gk8jAdXWmj)** — Discutez avec d'autres utilisateurs de BMad, posez des questions, partagez des idées
|
||||
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Code source, issues et contributions
|
||||
- **[YouTube](https://www.youtube.com/@BMadCode)** — Tutoriels vidéo et démonstrations
|
||||
|
||||
## Prochaine étape
|
||||
|
||||
Prêt à vous lancer ? **[Commencez avec BMad](./tutorials/getting-started.md)** et construisez votre premier projet.
|
||||
|
||||
---
|
||||
## Glossaire
|
||||
|
||||
[^1]: **Module** : composant autonome du système BMad qui peut être installé et utilisé indépendamment, offrant des fonctionnalités spécifiques.
|
||||
|
||||
[^2]: **Agent** : assistant IA spécialisé avec une expertise spécifique qui guide les utilisateurs dans les workflows.
|
||||
|
||||
[^3]: **Skill** : capacité ou fonctionnalité invoquable d'un agent pour effectuer une tâche spécifique.
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
title: Agents
|
||||
description: Agents BMM par défaut avec leurs identifiants de skill, déclencheurs de menu et workflows principaux (Analyst, Architect, UX Designer, Technical Writer)
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
## Agents par défaut
|
||||
|
||||
Cette page liste les quatre agents BMM (suite Agile) par défaut installés avec la méthode BMad, ainsi que leurs identifiants de skill, déclencheurs de menu et workflows principaux. Chaque agent est invoqué en tant que skill.
|
||||
|
||||
## Notes
|
||||
|
||||
- Chaque agent est disponible en tant que skill, généré par l’installateur. L’identifiant de skill (par exemple, `bmad-analyst`) est utilisé pour invoquer l’agent.
|
||||
- Les déclencheurs sont les codes courts de menu (par exemple, `BP`) et les correspondances approximatives affichés dans chaque menu d’agent.
|
||||
- La génération de tests QA est gérée par le skill de workflow `bmad-qa-generate-e2e-tests`. L’architecte de tests complet (TEA) se trouve dans son propre module.
|
||||
|
||||
| Agent | Identifiant de skill | Déclencheurs | Workflows principaux |
|
||||
|------------------------|----------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Analyste (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `DP` | Brainstorming du projet, Recherche marché/domaine/technique, Création du brief[^1], Documentation du projet |
|
||||
| Architecte (Winston) | `bmad-architect` | `CA`, `IR` | Créer l’architecture, Préparation à l’implémentation |
|
||||
| Designer UX (Sally) | `bmad-ux-designer` | `CU` | Création du design UX[^2] |
|
||||
| Rédacteur Technique (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Documentation du projet, Rédaction de documents, Mise à jour des standards, Génération de diagrammes Mermaid, Validation de documents, Explication de concepts |
|
||||
|
||||
## Types de déclencheurs
|
||||
|
||||
Les déclencheurs de menu d'agent utilisent deux types d'invocation différents. Connaître le type utilisé par un déclencheur vous aide à fournir la bonne entrée.
|
||||
|
||||
### Déclencheurs de workflow (aucun argument nécessaire)
|
||||
|
||||
La plupart des déclencheurs chargent un fichier de workflow structuré. Tapez le code du déclencheur et l'agent démarre le workflow, vous demandant de saisir les informations à chaque étape.
|
||||
|
||||
Exemples : `BP` (Brainstorm Project), `CA` (Create Architecture), `CU` (Create UX Design)
|
||||
|
||||
### Déclencheurs conversationnels (arguments requis)
|
||||
|
||||
Certains déclencheurs lancent une conversation libre au lieu d'un workflow structuré. Ils s'attendent à ce que vous décriviez ce dont vous avez besoin à côté du code du déclencheur.
|
||||
|
||||
| Agent | Déclencheur | Ce qu'il faut fournir |
|
||||
| --- | --- | --- |
|
||||
| Rédacteur Technique (Paige) | `WD` | Description du document à rédiger |
|
||||
| Rédacteur Technique (Paige) | `US` | Préférences ou conventions à ajouter aux standards |
|
||||
| Rédacteur Technique (Paige) | `MG` | Description et type de diagramme (séquence, organigramme, etc.) |
|
||||
| Rédacteur Technique (Paige) | `VD` | Document à valider et domaines à examiner |
|
||||
| Rédacteur Technique (Paige) | `EC` | Nom du concept à expliquer |
|
||||
|
||||
**Exemple :**
|
||||
|
||||
```text
|
||||
WD Rédige un guide de déploiement pour notre configuration Docker
|
||||
MG Crée un diagramme de séquence montrant le flux d’authentification
|
||||
EC Explique le fonctionnement du système de modules
|
||||
```
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Brief : document synthétique qui formalise le contexte, les objectifs, le périmètre et les contraintes d’un projet ou d’une demande, afin d’aligner rapidement les parties prenantes avant le travail détaillé.
|
||||
[^2]: UX (User Experience) : expérience utilisateur, englobant l’ensemble des interactions et perceptions d’un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d’utilisation.
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
---
|
||||
title: Skills
|
||||
description: Référence des skills BMad — ce qu'ils sont, comment ils fonctionnent et où les trouver.
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
Les skills sont des prompts pré-construits qui chargent des agents, exécutent des workflows ou lancent des tâches dans votre IDE. L'installateur BMad les génère à partir de vos modules installés au moment de l'installation. Si vous ajoutez, supprimez ou modifiez des modules ultérieurement, relancez l'installateur pour garder les skills synchronisés (voir [Dépannage](#dépannage)).
|
||||
|
||||
## Skills vs. Déclencheurs du menu Agent
|
||||
|
||||
BMad offre deux façons de démarrer un travail, chacune ayant un usage différent.
|
||||
|
||||
| Mécanisme | Comment l'invoquer | Ce qui se passe |
|
||||
| --- | --- | --- |
|
||||
| **Skill** | Tapez le nom du skill (ex. `bmad-help`) dans votre IDE | Charge directement un agent, exécute un workflow ou lance une tâche |
|
||||
| **Déclencheur du menu agent** | Chargez d'abord un agent, puis tapez un code court (ex. `DS`) | L'agent interprète le code et démarre le workflow correspondant tout en préservant son persona |
|
||||
|
||||
Les déclencheurs du menu agent nécessitent une session agent active. Utilisez les skills lorsque vous savez quel workflow vous voulez. Utilisez les déclencheurs lorsque vous travaillez déjà avec un agent et souhaitez changer de tâche sans quitter la conversation.
|
||||
|
||||
## Comment les skills sont générés
|
||||
|
||||
Lorsque vous exécutez `npx bmad-method install`, l'installateur lit les manifests de chaque module sélectionné et écrit un skill par agent, workflow, tâche et outil. Chaque skill est un répertoire contenant un fichier `SKILL.md` qui indique à l'IA de charger le fichier source correspondant et de suivre ses instructions.
|
||||
|
||||
L'installateur utilise des modèles pour chaque type de skill :
|
||||
|
||||
| Type de skill | Ce que fait le fichier généré |
|
||||
| --- | --- |
|
||||
| **Lanceur d'agent** | Charge le fichier de persona de l'agent, active son menu et reste en caractère |
|
||||
| **Skill de workflow** | Charge la configuration du workflow et suit ses étapes |
|
||||
| **Skill de tâche** | Charge un fichier de tâche autonome et suit ses instructions |
|
||||
| **Skill d'outil** | Charge un fichier d'outil autonome et suit ses instructions |
|
||||
|
||||
:::note[Relancer l'installateur]
|
||||
Si vous ajoutez ou supprimez des modules, relancez l'installateur. Il régénère tous les fichiers de skill pour correspondre à votre sélection actuelle de modules.
|
||||
:::
|
||||
|
||||
## Emplacement des fichiers de skill
|
||||
|
||||
L'installateur écrit les fichiers de skill dans un répertoire spécifique à l'IDE à l'intérieur de votre projet. Le chemin exact dépend de l'IDE que vous avez sélectionné lors de l'installation.
|
||||
|
||||
| IDE / CLI | Répertoire des skills |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` |
|
||||
| Autres IDE | Consultez la sortie de l'installateur pour le chemin cible |
|
||||
|
||||
Chaque skill est un répertoire contenant un fichier `SKILL.md`. Par exemple, une installation Claude Code ressemble à :
|
||||
|
||||
```text
|
||||
.claude/skills/
|
||||
├── bmad-help/
|
||||
│ └── SKILL.md
|
||||
├── bmad-create-prd/
|
||||
│ └── SKILL.md
|
||||
├── bmad-analyst/
|
||||
│ └── SKILL.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
Le nom du répertoire détermine le nom du skill dans votre IDE. Par exemple, le répertoire `bmad-analyst/` enregistre le skill `bmad-analyst`.
|
||||
|
||||
## Comment découvrir vos skills
|
||||
|
||||
Tapez le nom du skill dans votre IDE pour l'invoquer. Certaines plateformes nécessitent d'activer les skills dans les paramètres avant qu'ils n'apparaissent.
|
||||
|
||||
Exécutez `bmad-help` pour obtenir des conseils contextuels sur votre prochaine étape.
|
||||
|
||||
:::tip[Découverte rapide]
|
||||
Les répertoires de skills générés dans votre projet sont la liste de référence. Ouvrez-les dans votre explorateur de fichiers pour voir chaque skill avec sa description.
|
||||
:::
|
||||
|
||||
## Catégories de skills
|
||||
|
||||
### Skills d'agent
|
||||
|
||||
Les skills d'agent chargent une persona[^2] IA spécialisée avec un rôle défini, un style de communication et un menu de workflows. Une fois chargé, l'agent reste en caractère et répond aux déclencheurs du menu.
|
||||
|
||||
| Exemple de skill | Agent | Rôle |
|
||||
| --- | --- | --- |
|
||||
| `bmad-analyst` | Mary (Analyste) | Brainstorming de projets, recherche, création de briefs |
|
||||
| `bmad-architect` | Winston (Architecte) | Conçoit l'architecture système |
|
||||
| `bmad-ux-designer` | Sally (Designer UX) | Crée les designs UX |
|
||||
| `bmad-tech-writer` | Paige (Rédacteur Technique) | Documente les projets, rédige des guides, génère des diagrammes |
|
||||
|
||||
Consultez [Agents](./agents.md) pour la liste complète des agents par défaut et leurs déclencheurs.
|
||||
|
||||
### Skills de workflow
|
||||
|
||||
Les skills de workflow exécutent un processus structuré en plusieurs étapes sans charger d'abord une persona d'agent. Ils chargent une configuration de workflow et suivent ses étapes.
|
||||
|
||||
| Exemple de skill | Objectif |
|
||||
| --- | --- |
|
||||
| `bmad-create-prd` | Créer un PRD[^1] |
|
||||
| `bmad-create-architecture` | Concevoir l'architecture système |
|
||||
| `bmad-create-epics-and-stories` | Créer des epics et des stories |
|
||||
| `bmad-dev-story` | Implémenter une story |
|
||||
| `bmad-code-review` | Effectuer une revue de code |
|
||||
| `bmad-quick-dev` | Flux rapide unifié — clarifier l'intention, planifier, implémenter, réviser, présenter |
|
||||
|
||||
Consultez la [Carte des workflows](./workflow-map.md) pour la référence complète des workflows organisés par phase.
|
||||
|
||||
### Skills de tâche et d'outil
|
||||
|
||||
Les tâches et outils sont des opérations autonomes qui ne nécessitent pas de contexte d'agent ou de workflow.
|
||||
|
||||
**BMad-Help : Votre guide intelligent**
|
||||
|
||||
`bmad-help` est votre interface principale pour découvrir quoi faire ensuite. Il inspecte votre projet, comprend les requêtes en langage naturel et recommande la prochaine étape requise ou optionnelle en fonction de vos modules installés.
|
||||
|
||||
:::note[Exemple]
|
||||
```
|
||||
bmad-help
|
||||
bmad-help J'ai une idée de SaaS et je connais toutes les fonctionnalités. Par où commencer ?
|
||||
bmad-help Quelles sont mes options pour le design UX ?
|
||||
```
|
||||
:::
|
||||
|
||||
**Autres tâches et outils principaux**
|
||||
|
||||
Le module principal inclut 11 outils intégrés — revues, compression, brainstorming, gestion de documents, et plus. Consultez [Outils principaux](./core-tools.md) pour la référence complète.
|
||||
|
||||
## Convention de nommage
|
||||
|
||||
Tous les skills utilisent le préfixe `bmad-` suivi d'un nom descriptif (ex. `bmad-analyst`, `bmad-create-prd`, `bmad-help`). Consultez [Modules](./modules.md) pour les modules disponibles.
|
||||
|
||||
## Dépannage
|
||||
|
||||
**Les skills n'apparaissent pas après l'installation.** Certaines plateformes nécessitent d'activer explicitement les skills dans les paramètres. Consultez la documentation de votre IDE ou demandez à votre assistant IA comment activer les skills. Vous devrez peut-être aussi redémarrer votre IDE ou recharger la fenêtre.
|
||||
|
||||
**Des skills attendus sont manquants.** L'installateur génère uniquement les skills pour les modules que vous avez sélectionnés. Exécutez à nouveau `npx bmad-method install` et vérifiez votre sélection de modules. Vérifiez que les fichiers de skill existent dans le répertoire attendu.
|
||||
|
||||
**Des skills d'un module supprimé apparaissent encore.** L'installateur ne supprime pas automatiquement les anciens fichiers de skill. Supprimez les répertoires obsolètes du répertoire de skills de votre IDE, ou supprimez tout le répertoire de skills et relancez l'installateur pour obtenir un ensemble propre.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d’aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Persona : dans le contexte de BMad, une persona désigne un agent IA avec un rôle défini, un style de communication et une expertise spécifiques (ex. Mary l'analyste, Winston l'architecte). Chaque persona garde son "caractère" pendant les interactions.
|
||||
|
|
@ -0,0 +1,298 @@
|
|||
---
|
||||
title: Outils Principaux
|
||||
description: Référence pour toutes les tâches et tous les workflows intégrés disponibles dans chaque installation BMad sans modules supplémentaires.
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Chaque installation BMad comprend un ensemble de compétences principales qui peuvent être utilisées conjointement avec tout ce que vous faites — des tâches et des workflows autonomes qui fonctionnent dans tous les projets, tous les modules et toutes les phases. Ceux-ci sont toujours disponibles, quels que soient les modules optionnels que vous installez.
|
||||
|
||||
:::tip[Raccourci Rapide]
|
||||
Exécutez n'importe quel outil principal en tapant son nom de compétence (par ex., `bmad-help`) dans votre IDE. Aucune session d'agent requise.
|
||||
:::
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
| Outil | Type | Objectif |
|
||||
|-----------------------------------------------------------------------|----------|------------------------------------------------------------------------------|
|
||||
| [`bmad-help`](#bmad-help) | Tâche | Obtenir des conseils contextuels sur la prochaine étape |
|
||||
| [`bmad-brainstorming`](#bmad-brainstorming) | Workflow | Faciliter des sessions de brainstorming interactives |
|
||||
| [`bmad-party-mode`](#bmad-party-mode) | Workflow | Orchestrer des discussions de groupe multi-agents |
|
||||
| [`bmad-distillator`](#bmad-distillator) | Tâche | Compression sans perte optimisée pour LLM de documents |
|
||||
| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Tâche | Pousser la sortie LLM à travers des méthodes de raffinement itératives |
|
||||
| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Tâche | Revue cynique qui trouve ce qui manque et ce qui ne va pas |
|
||||
| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Tâche | Analyse exhaustive des chemins de branchement pour les cas limites non gérés |
|
||||
| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Tâche | Révision de copie clinique pour la clarté de communication |
|
||||
| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Tâche | Édition structurelle — coupes, fusions et réorganisation |
|
||||
| [`bmad-shard-doc`](#bmad-shard-doc) | Tâche | Diviser les fichiers markdown volumineux en sections organisées |
|
||||
| [`bmad-index-docs`](#bmad-index-docs) | Tâche | Générer ou mettre à jour un index de tous les documents dans un dossier |
|
||||
|
||||
## bmad-help
|
||||
|
||||
**Votre guide intelligent pour la suite.** — Inspecte l'état de votre projet, détecte ce qui a été fait et recommande la prochaine étape requise ou facultative.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez terminé un workflow et voulez savoir ce qui suit
|
||||
- Vous êtes nouveau sur BMad et avez besoin d'orientation
|
||||
- Vous êtes bloqué et voulez des conseils contextuels
|
||||
- Vous avez installé de nouveaux modules et voulez voir ce qui est disponible
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse votre projet pour les artefacts existants (PRD, architecture, stories, etc.)
|
||||
2. Détecte quels modules sont installés et leurs workflows disponibles
|
||||
3. Recommande les prochaines étapes par ordre de priorité — étapes requises d'abord, puis facultatives
|
||||
4. Présente chaque recommandation avec la commande de compétence et une brève description
|
||||
|
||||
**Entrée :** Requête optionnelle en langage naturel (par ex., `bmad-help J'ai une idée de SaaS, par où commencer ?`)
|
||||
|
||||
**Sortie :** Liste priorisée des prochaines étapes recommandées avec les commandes de compétence
|
||||
|
||||
## bmad-brainstorming
|
||||
|
||||
**Génère des idées diverses à travers des techniques créatives interactives.** — Une session de brainstorming facilitée qui charge des méthodes d'idéation éprouvées depuis une bibliothèque de techniques et vous guide vers plus de 100 idées avant organisation.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous commencez un nouveau projet et devez explorer l’espace problème
|
||||
- Vous êtes bloqué dans la génération d'idées et avez besoin de créativité structurée
|
||||
- Vous voulez utiliser des cadres d'idéation éprouvés (SCAMPER, brainstorming inversé, etc.)
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Configure une session de brainstorming avec votre sujet
|
||||
2. Charge les techniques créatives depuis une bibliothèque de méthodes
|
||||
3. Vous guide à travers technique après technique, générant des idées
|
||||
4. Applique un protocole anti-biais — change de domaine créatif toutes les 10 idées pour éviter le regroupement
|
||||
5. Produit un document de session en mode ajout uniquement avec toutes les idées organisées par technique
|
||||
|
||||
**Entrée :** Sujet de brainstorming ou énoncé de problème, fichier de contexte optionnel
|
||||
|
||||
**Sortie :** `brainstorming-session-{date}.md` avec toutes les idées générées
|
||||
|
||||
:::note[Cible de Quantité]
|
||||
La magie se produit dans les idées 50–100. Le workflow encourage la génération de plus de 100 idées avant organisation.
|
||||
:::
|
||||
|
||||
## bmad-party-mode
|
||||
|
||||
**Orchestre des discussions de groupe multi-agents.** — Charge tous les agents BMad installés et facilite une conversation naturelle où chaque agent contribue depuis son expertise et personnalité uniques.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin de multiples perspectives d'experts sur une décision
|
||||
- Vous voulez que les agents remettent en question les hypothèses des autres
|
||||
- Vous explorez un sujet complexe qui couvre plusieurs domaines
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Charge le manifeste d'agents avec toutes les personnalités d'agents installées
|
||||
2. Analyse votre sujet pour sélectionner les 2–3 agents les plus pertinents
|
||||
3. Les agents prennent des tours pour contribuer, avec des échanges naturels et des désaccords
|
||||
4. Fait rouler la participation des agents pour assurer des perspectives diverses au fil du temps
|
||||
5. Quittez avec `goodbye`, `end party` ou `quit`
|
||||
|
||||
**Entrée :** Sujet de discussion ou question, ainsi que la spécification des personas que vous souhaitez faire participer (optionnel)
|
||||
|
||||
**Sortie :** Conversation multi-agents en temps réel avec des personnalités d'agents maintenues
|
||||
|
||||
## bmad-distillator
|
||||
|
||||
**Compression sans perte optimisée pour LLM de documents sources.** — Produit des distillats denses et efficaces en tokens qui préservent toute l'information pour la consommation par des LLM en aval. Vérifiable par reconstruction aller-retour.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document est trop volumineux pour la fenêtre de contexte d'un LLM
|
||||
- Vous avez besoin de versions économes en tokens de recherches, spécifications ou artefacts de planification
|
||||
- Vous voulez vérifier qu'aucune information n'est perdue pendant la compression
|
||||
- Les agents auront besoin de référencer et de trouver fréquemment des informations dedans
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. **Analyser** — Lit les documents sources, identifie la densité d'information et la structure
|
||||
2. **Compresser** — Convertit la prose en format dense de liste de points, supprime le formatage décoratif
|
||||
3. **Vérifier** — Vérifie l'exhaustivité pour s'assurer que toute l'information originale est préservée
|
||||
4. **Valider** (optionnel) — Le test de reconstruction aller-retour prouve la compression sans perte
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `source_documents` (requis) — Chemins de fichiers, chemins de dossiers ou motifs glob
|
||||
- `downstream_consumer` (optionnel) — Ce qui va le consommer (par ex., "création de PRD")
|
||||
- `token_budget` (optionnel) — Taille cible approximative
|
||||
- `--validate` (drapeau) — Exécuter le test de reconstruction aller-retour
|
||||
|
||||
**Sortie :** Fichier(s) markdown distillé(s) avec rapport de ratio de compression (par ex., "3.2:1")
|
||||
|
||||
## bmad-advanced-elicitation
|
||||
|
||||
**Passer la sortie du LLM à travers des méthodes de raffinement itératives.** — Sélectionne depuis une bibliothèque de techniques d'élicitation pour améliorer systématiquement le contenu à travers multiples passages.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- La sortie du LLM semble superficielle ou générique
|
||||
- Vous voulez explorer un sujet depuis de multiples angles analytiques
|
||||
- Vous raffinez un document critique et voulez une réflexion plus approfondie
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Charge le registre de méthodes avec plus de 5 techniques d'élicitation
|
||||
2. Sélectionne les 5 méthodes les mieux adaptées selon le type de contenu et la complexité
|
||||
3. Présente un menu interactif — choisissez une méthode, remélangez, ou listez tout
|
||||
4. Applique la méthode sélectionnée pour améliorer le contenu
|
||||
5. Re-présente les options pour l'amélioration itérative jusqu'à ce que vous sélectionniez "Procéder"
|
||||
|
||||
**Entrée :** Section de contenu à améliorer
|
||||
|
||||
**Sortie :** Version améliorée du contenu avec les améliorations appliquées
|
||||
|
||||
## bmad-review-adversarial-general
|
||||
|
||||
**Revue contradictoire qui suppose que des problèmes existent et les recherche.** — Adopte une perspective de réviseur sceptique et blasé avec zéro tolérance pour le travail bâclé. Cherche ce qui manque, pas seulement ce qui ne va pas.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin d'assurance qualité avant de finaliser un livrable
|
||||
- Vous voulez tester en conditions réelles une spécification, story ou document
|
||||
- Vous voulez trouver des lacunes de couverture que les revues optimistes manquent
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Lit le contenu avec une perspective contradictoire et critique
|
||||
2. Identifie les problèmes à travers l'exhaustivité, la justesse et la qualité
|
||||
3. Recherche spécifiquement ce qui manque — pas seulement ce qui est présent et faux
|
||||
4. Doit trouver un minimum de 10 problèmes ou réanalyse plus profondément
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (requis) — Diff, spécification, story, document ou tout artefact
|
||||
- `also_consider` (optionnel) — Domaines supplémentaires à garder à l'esprit
|
||||
|
||||
**Sortie :** Liste markdown de plus de 10 constatations avec descriptions
|
||||
|
||||
## bmad-review-edge-case-hunter
|
||||
|
||||
**Parcours tous les chemins de branchement et les conditions limites, ne rapporte que les cas non gérés.** — Méthodologie pure de traçage de chemin[^1] qui dérive mécaniquement les classes de cas limites. Orthogonale à la revue contradictoire — centrée sur la méthode, pas sur l'attitude.
|
||||
|
||||
**À utiliser quand :**
|
||||
|
||||
- Vous souhaitez une couverture exhaustive des cas limites pour le code ou la logique
|
||||
- Vous avez besoin d'un complément à la revue contradictoire (méthodologie différente, résultats différents)
|
||||
- Vous révisez un diff ou une fonction pour des conditions limites
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Énumère tous les chemins de branchement dans le contenu
|
||||
2. Dérive mécaniquement les classes de cas limites : else/default manquants, entrées non vérifiées, décalage d’unité, overflow arithmétique, coercition implicite des types, conditions de concurrence, écarts de timeout
|
||||
3. Teste chaque chemin contre les protections existantes
|
||||
4. Ne rapporte que les chemins non gérés — ignore silencieusement les chemins gérés
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (obligatoire) — Diff, fichier complet ou fonction
|
||||
- `also_consider` (facultatif) — Zones supplémentaires à garder à l’esprit
|
||||
|
||||
**Sortie :** Tableau JSON des résultats, chacun avec `location`, `trigger_condition`, `guard_snippet` et `potential_consequence`
|
||||
|
||||
:::note[Revue Complémentaire]
|
||||
Exécutez à la fois `bmad-review-adversarial-general` et `bmad-review-edge-case-hunter` pour une couverture orthogonale. La revue contradictoire détecte les problèmes de qualité et de complétude ; le chasseur de cas limites détecte les chemins non gérés.
|
||||
:::
|
||||
|
||||
## bmad-editorial-review-prose
|
||||
|
||||
**Relecture éditoriale clinique centrée sur la clarté de communication.** — Analyse le texte pour détecter les problèmes qui nuisent à la compréhension. Applique le Microsoft Writing Style Guide baseline. Préserve la voix de l’auteur.
|
||||
|
||||
**À utiliser quand :**
|
||||
|
||||
- Vous avez rédigé un document et souhaitez polir le style
|
||||
- Vous devez assurer la clarté pour un public spécifique
|
||||
- Vous voulez des corrections de communication sans modifier les choix stylistiques
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Lit le contenu en ignorant les blocs de code et le frontmatter
|
||||
2. Identifie les problèmes de communication (pas les préférences de style)
|
||||
3. Déduit les doublons du même problème à différents emplacements
|
||||
4. Produit un tableau de corrections en trois colonnes
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (obligatoire) — Markdown, texte brut ou XML
|
||||
- `style_guide` (facultatif) — Guide de style spécifique au projet
|
||||
- `reader_type` (facultatif) — `humans` (par défaut) pour clarté/fluide, ou `llm` pour précision/consistance
|
||||
|
||||
**Sortie :** Tableau Markdown en trois colonnes : Texte original | Texte révisé | Modifications
|
||||
|
||||
## bmad-editorial-review-structure
|
||||
|
||||
**Édition structurelle — propose des coupes, fusions, déplacements et condensations.** — Révise l'organisation du document et propose des changements substantiels pour améliorer la clarté et le flux avant la révision de copie.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document a été produit depuis de multiples sous-processus et a besoin de cohérence structurelle
|
||||
- Vous voulez réduire la longueur du document tout en préservant la compréhension
|
||||
- Vous devez identifier les violations de portée ou les informations critiques enfouies
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse le document contre 5 modèles de structure (Tutoriel, Référence, Explication, Prompt, Stratégique)
|
||||
2. Identifie les redondances, violations de portée et informations enfouies
|
||||
3. Produit des recommandations priorisées : COUPER, FUSIONNER, DÉPLACER, CONDENSER, QUESTIONNER, PRÉSERVER
|
||||
4. Estime la réduction totale en mots et pourcentage
|
||||
|
||||
**Entrée :**
|
||||
|
||||
- `content` (requis) — Document à réviser
|
||||
- `purpose` (optionnel) — Objectif prévu (par ex., "tutoriel de démarrage rapide")
|
||||
- `target_audience` (optionnel) — Qui lit ceci
|
||||
- `reader_type` (optionnel) — `humans` ou `llm`
|
||||
- `length_target` (optionnel) — Réduction cible (par ex., "30% plus court")
|
||||
|
||||
**Sortie :** Résumé du document, liste de recommandations priorisées et réduction estimée
|
||||
|
||||
## bmad-shard-doc
|
||||
|
||||
**Diviser les fichiers markdown volumineux en fichiers de sections organisés.** — Utilise les en-têtes de niveau 2 comme points de division pour créer un dossier de fichiers de sections autonomes avec un index.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Un document markdown est devenu trop volumineux pour être géré efficacement (plus de 500 lignes)
|
||||
- Vous voulez diviser un document monolithique en sections navigables
|
||||
- Vous avez besoin de fichiers séparés pour l'édition parallèle ou la gestion de contexte LLM
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Valide que le fichier source existe et est markdown
|
||||
2. Divise sur les en-têtes de niveau 2 (`##`) en fichiers de sections numérotées
|
||||
3. Crée un `index.md` avec manifeste de sections et liens
|
||||
4. Vous invite à supprimer, archiver ou conserver l'original
|
||||
|
||||
**Entrée :** Chemin du fichier markdown source, dossier de destination optionnel
|
||||
|
||||
**Sortie :** Dossier avec `index.md` et `01-{section}.md`, `02-{section}.md`, etc.
|
||||
|
||||
## bmad-index-docs
|
||||
|
||||
**Générer ou mettre à jour un index de tous les documents dans un dossier.** — Analyse un répertoire, lit chaque fichier pour comprendre son objectif et produit un `index.md` organisé avec liens et descriptions.
|
||||
|
||||
**Utilisez-le quand :**
|
||||
|
||||
- Vous avez besoin d'un index léger pour un scan LLM rapide des documents disponibles
|
||||
- Un dossier de documentation a grandi et a besoin d'une table des matières organisée
|
||||
- Vous voulez un aperçu auto-généré qui reste à jour
|
||||
|
||||
**Fonctionnement :**
|
||||
|
||||
1. Analyse le répertoire cible pour tous les fichiers non cachés
|
||||
2. Lit chaque fichier pour comprendre son objectif réel
|
||||
3. Groupe les fichiers par type, objectif ou sous-répertoire
|
||||
4. Génère des descriptions concises (3–10 mots chacune)
|
||||
|
||||
**Entrée :** Chemin du dossier cible
|
||||
|
||||
**Sortie :** `index.md` avec listes de fichiers organisées, liens relatifs et brèves descriptions
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: Path-tracing : méthode d'analyse qui suit systématiquement tous les chemins d'exécution possibles dans un programme pour identifier les cas non gérés.
|
||||
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Modules Officiels
|
||||
description: Modules additionnels pour créer des agents personnalisés, de l'intelligence créative, du développement de jeux et des tests
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
BMad s'étend via des modules officiels que vous sélectionnez lors de l'installation. Ces modules additionnels fournissent des agents, des workflows et des tâches spécialisés pour des domaines spécifiques, au-delà du noyau intégré et de BMM (suite Agile).
|
||||
|
||||
:::tip[Installer des Modules]
|
||||
Exécutez `npx bmad-method install` et sélectionnez les modules souhaités. L'installateur gère automatiquement le téléchargement, la configuration et l'intégration IDE.
|
||||
:::
|
||||
|
||||
## BMad Builder
|
||||
|
||||
Créez des agents personnalisés, des workflows et des modules spécifiques à un domaine avec une assistance guidée. BMad Builder est le méta-module pour étendre le framework lui-même.
|
||||
|
||||
- **Code :** `bmb`
|
||||
- **npm :** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||
- **GitHub :** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agent Builder — créez des agents IA spécialisés avec une expertise et un accès aux outils personnalisés
|
||||
- Workflow Builder — concevez des processus structurés avec des étapes et des points de décision
|
||||
- Module Builder — empaquetez des agents et des workflows dans des modules partageables et publiables
|
||||
- Configuration interactive avec support de configuration YAML et publication npm
|
||||
|
||||
## Creative Intelligence Suite
|
||||
|
||||
Outils basés sur l'IA pour la créativité structurée, l'idéation et l'innovation pendant le développement en phase amont. La suite fournit plusieurs agents qui facilitent le brainstorming, le design thinking et la résolution de problèmes en utilisant des cadres éprouvés.
|
||||
|
||||
- **Code :** `cis`
|
||||
- **npm :** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||
- **GitHub :** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agents Innovation Strategist, Design Thinking Coach et Brainstorming Coach
|
||||
- Problem Solver et Creative Problem Solver pour la pensée systématique et latérale
|
||||
- Storyteller et Presentation Master pour les récits et les présentations
|
||||
- Cadres d'idéation incluant SCAMPER[^1], Brainstorming inversé et reformulation de problèmes
|
||||
|
||||
## Game Dev Studio
|
||||
|
||||
Workflows de développement de jeux structurés adaptés pour Unity, Unreal, Godot et moteurs personnalisés. Supporte le prototypage rapide via Quick Dev et la production à grande échelle avec des sprints propulsés par epics.
|
||||
|
||||
- **Code :** `gds`
|
||||
- **npm :** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||
- **GitHub :** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Workflow de génération de Document de Design de Jeu (GDD[^3])
|
||||
- Mode Quick Dev pour le prototypage rapide
|
||||
- Support de design narratif pour les personnages, dialogues et construction de monde
|
||||
- Couverture de plus de 21 types de jeux avec des conseils d'architecture spécifiques au moteur
|
||||
|
||||
## Test Architect (TEA)
|
||||
|
||||
Stratégie de test de niveau entreprise, conseils d'automatisation et décisions de porte de release via un agent expert et neuf workflows structurés. TEA va bien au-delà du workflow QA intégré avec une priorisation basée sur les risques et une traçabilité des exigences.
|
||||
|
||||
- **Code :** `tea`
|
||||
- **npm :** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
- **GitHub :** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||
|
||||
**Fournit :**
|
||||
|
||||
- Agent Murat (Master Test Architect and Quality Advisor)
|
||||
- Workflows pour la conception de tests, ATDD, l'automatisation, la revue de tests et la traçabilité
|
||||
- Évaluation NFR[^2], configuration CI et scaffolding de framework
|
||||
- Priorisation P0-P3 avec Playwright Utils et intégrations MCP optionnelles
|
||||
|
||||
## Modules Communautaires
|
||||
|
||||
Les modules communautaires et une marketplace de modules sont à venir. Consultez l'[organisation GitHub BMad](https://github.com/bmad-code-org) pour les mises à jour.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: SCAMPER : acronyme anglais pour une technique de créativité structurée (Substitute, Combine, Adapt, Modify, Put to another use, Eliminate, Reverse) qui permet d'explorer systématiquement les modifications possibles d'un produit ou d'une idée pour générer des innovations.
|
||||
[^2]: NFR (Non-Functional Requirement) : exigence décrivant les contraintes de qualité du système (performance, sécurité, fiabilité, ergonomie) plutôt que ses fonctionnalités.
|
||||
[^3]: GDD (Game Design Document) : document de conception de jeu qui décrit en détail les mécaniques, l'univers, les personnages, les niveaux et tous les aspects du jeu à développer.
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
---
|
||||
title: Options de Testing
|
||||
description: Comparaison du workflow QA intégré avec le module Test Architect (TEA) pour l'automatisation des tests.
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
BMad propose deux approches de test : un workflow QA[^1] intégré pour une génération rapide de tests et un module Test Architect installable pour une stratégie de test de qualité entreprise.
|
||||
|
||||
## Lequel Choisir ?
|
||||
|
||||
| Facteur | QA Intégré | Module TEA |
|
||||
|-------------------------|----------------------------------------------|---------------------------------------------------------------------|
|
||||
| **Idéal pour** | Projets petits et moyens, couverture rapide | Grands projets, domaines réglementés ou complexes |
|
||||
| **Installation** | Rien à installer — inclus dans BMM | Installer séparément via `npx bmad-method install` |
|
||||
| **Approche** | Générer les tests rapidement, itérer ensuite | Planifier d'abord, puis générer avec traçabilité |
|
||||
| **Types de tests** | Tests API et E2E | API, E2E, ATDD[^2], NFR, et plus |
|
||||
| **Stratégie** | Chemin nominal + cas limites critiques | Priorisation basée sur les risques (P0-P3) |
|
||||
| **Nombre de workflows** | 1 (Automate) | 9 (conception, ATDD, automatisation, revue, traçabilité, et autres) |
|
||||
|
||||
:::tip[Commencez avec le QA Intégré]
|
||||
La plupart des projets devraient commencer avec le workflow QA intégré. Si vous avez ensuite besoin d'une stratégie de test, de murs de qualité ou de traçabilité des exigences, installez TEA en complément.
|
||||
:::
|
||||
|
||||
## Workflow QA Intégré
|
||||
|
||||
Le workflow QA intégré est inclus dans le module BMM (suite Agile). Il génère rapidement des tests fonctionnels en utilisant le framework de test existant de votre projet — aucune configuration ni installation supplémentaire requise.
|
||||
|
||||
**Déclencheur :** `QA` ou `bmad-qa-generate-e2e-tests`
|
||||
|
||||
### Ce que le Workflow QA Fait
|
||||
|
||||
Le workflow QA exécute un processus unique (Automate) qui parcourt cinq étapes :
|
||||
|
||||
1. **Détecte le framework de test** — analyse `package.json` et les fichiers de test existants pour identifier votre framework (Jest, Vitest, Playwright, Cypress, ou tout runner standard). Si aucun n'existe, analyse la pile technologique du projet et en suggère un.
|
||||
2. **Identifie les fonctionnalités** — demande ce qu'il faut tester ou découvre automatiquement les fonctionnalités dans le codebase.
|
||||
3. **Génère les tests API** — couvre les codes de statut, la structure des réponses, le chemin nominal, et 1-2 cas d'erreur.
|
||||
4. **Génére les tests E2E** — couvre les parcours utilisateur avec des localisateurs sémantiques et des assertions sur les résultats visibles.
|
||||
5. **Exécute et vérifie** — lance les tests générés et corrige immédiatement les échecs.
|
||||
|
||||
Le workflow QA produit un résumé de test sauvegardé dans le dossier des artefacts d'implémentation de votre projet.
|
||||
|
||||
### Patterns de Test
|
||||
|
||||
Les tests générés suivent une philosophie "simple et maintenable" :
|
||||
|
||||
- **APIs standard du framework uniquement** — pas d'utilitaires externes ni d'abstractions personnalisées
|
||||
- **Localisateurs sémantiques** pour les tests UI (rôles, labels, texte plutôt que sélecteurs CSS)
|
||||
- **Tests indépendants** sans dépendances d'ordre
|
||||
- **Pas d'attentes ou de sleeps codés en dur**
|
||||
- **Descriptions claires** qui se lisent comme de la documentation fonctionnelle
|
||||
|
||||
:::note[Portée]
|
||||
Le workflow QA génère uniquement des tests. Pour la revue de code et la validation des stories, utilisez plutôt le workflow Code Review (`CR`).
|
||||
:::
|
||||
|
||||
### Quand Utiliser le QA Intégré
|
||||
|
||||
- Couverture de test rapide pour une fonctionnalité nouvelle ou existante
|
||||
- Automatisation de tests accessible aux débutants sans configuration avancée
|
||||
- Patterns de test standards que tout développeur peut lire et maintenir
|
||||
- Projets petits et moyens où une stratégie de test complète n'est pas nécessaire
|
||||
|
||||
## Module Test Architect (TEA)
|
||||
|
||||
TEA est un module autonome qui fournit un agent expert (Murat) et neuf workflows structurés pour des tests de qualité entreprise. Il va au-delà de la génération de tests pour inclure la stratégie de test, la planification basée sur les risques, les murs de qualité et la traçabilité des exigences.
|
||||
|
||||
- **Documentation :** [TEA Module Docs](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
- **Installation :** `npx bmad-method install` et sélectionnez le module TEA
|
||||
- **npm :** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
|
||||
### Ce que TEA Fournit
|
||||
|
||||
| Workflow | Objectif |
|
||||
|-----------------------|--------------------------------------------------------------------------------------|
|
||||
| Test Design | Créer une stratégie de test complète liée aux exigences |
|
||||
| ATDD | Développement piloté par les tests d'acceptation avec critères des parties prenantes |
|
||||
| Automate | Générer des tests avec des patterns et utilitaires avancés |
|
||||
| Test Review | Valider la qualité et la couverture des tests par rapport à la stratégie |
|
||||
| Traceability | Remonter les tests aux exigences pour l'audit et la conformité |
|
||||
| NFR Assessment | Évaluer les exigences non-fonctionnelles (performance, sécurité) |
|
||||
| CI Setup | Configurer l'exécution des tests dans les pipelines d'intégration continue |
|
||||
| Framework Scaffolding | Configurer l'infrastructure de test et la structure du projet |
|
||||
| Release Gate | Prendre des décisions de livraison go/no-go basées sur les données |
|
||||
|
||||
TEA supporte également la priorisation basée sur les risques P0-P3 et des intégrations optionnelles avec Playwright Utils et les outils MCP.
|
||||
|
||||
### Quand Utiliser TEA
|
||||
|
||||
- Projets nécessitant une traçabilité des exigences ou une documentation de conformité
|
||||
- Équipes ayant besoin d'une priorisation des tests basée sur les risques sur plusieurs fonctionnalités
|
||||
- Environnements entreprise avec des murs de qualité formels avant livraison
|
||||
- Domaines complexes où la stratégie de test doit être planifiée avant d'écrire les tests
|
||||
- Projets ayant dépassé l'approche à workflow unique du QA intégré
|
||||
|
||||
## Comment les Tests S'Intègrent dans les Workflows
|
||||
|
||||
Le workflow Automate du QA intégré apparaît dans la Phase 4 (Implémentation) de la carte de workflow méthode BMad. Il est conçu pour s'exécuter **après qu'un epic complet soit terminé** — une fois que toutes les stories d'un epic ont été implémentées et revues. Une séquence typique :
|
||||
|
||||
1. Pour chaque story de l'epic : implémenter avec Dev Story (`DS`), puis valider avec Code Review (`CR`)
|
||||
2. Après la fin de l'epic : générer les tests avec le workflow QA (`QA`) ou le workflow Automate de TEA
|
||||
3. Lancer la rétrospective (`bmad-retrospective`) pour capturer les leçons apprises
|
||||
|
||||
Le workflow QA travaille directement à partir du code source sans charger les documents de planification (PRD, architecture). Les workflows TEA peuvent s'intégrer avec les artefacts de planification en amont pour la traçabilité.
|
||||
|
||||
Pour en savoir plus sur la place des tests dans le processus global, consultez la [Carte des Workflows](./workflow-map.md).
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: QA (Quality Assurance) : assurance qualité, ensemble des processus et activités visant à garantir que le produit logiciel répond aux exigences de qualité définies.
|
||||
[^2]: ATDD (Acceptance Test-Driven Development) : méthode de développement où les tests d'acceptation sont écrits avant le code, en collaboration avec les parties prenantes pour définir les critères de réussite.
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
title: "Carte des Workflows"
|
||||
description: Référence visuelle des phases et des résultats des workflows de la méthode BMad
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
La méthode BMad (BMM) est un module de l'écosystème BMad, conçu pour suivre les meilleures pratiques de l'ingénierie du contexte et de la planification. Les agents IA fonctionnent de manière optimale avec un contexte clair et structuré. Le système BMM construit ce contexte progressivement à travers 4 phases distinctes — chaque phase, et plusieurs workflows optionnels au sein de chaque phase, produisent des documents qui alimentent la phase suivante, afin que les agents sachent toujours quoi construire et pourquoi.
|
||||
|
||||
La logique et les concepts proviennent des méthodologies agiles qui ont été utilisées avec succès dans l'industrie comme cadre mental de référence.
|
||||
|
||||
Si à tout moment vous ne savez pas quoi faire, le skill `bmad-help` vous aidera à rester sur la bonne voie ou à savoir quoi faire ensuite. Vous pouvez toujours vous référer à cette page également — mais `bmad-help` est entièrement interactif et beaucoup plus rapide si vous avez déjà installé la méthode BMad. De plus, si vous utilisez différents modules qui ont étendu la méthode BMad ou ajouté d'autres modules complémentaires non extensifs — `bmad-help` évolue pour connaître tout ce qui est disponible et vous donner les meilleurs conseils du moment.
|
||||
|
||||
Note finale importante : Chaque workflow ci-dessous peut être exécuté directement avec l'outil de votre choix via un skill ou en chargeant d'abord un agent et en utilisant l'entrée du menu des agents.
|
||||
|
||||
<iframe src="/workflow-map-diagram-fr.html" title="Diagramme de la carte des workflows de la méthode BMad" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
||||
|
||||
<p style="font-size: 0.8rem; text-align: right; margin-top: -0.5rem; margin-bottom: 1rem;">
|
||||
<a href="/workflow-map-diagram-fr.html" target="_blank" rel="noopener noreferrer">Ouvrir le diagramme dans un nouvel onglet ↗</a>
|
||||
</p>
|
||||
|
||||
## Phase 1 : Analyse (Optionnelle)
|
||||
|
||||
Explorez l’espace problème et validez les idées avant de vous engager dans la planification.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------------------|
|
||||
| `bmad-brainstorming` | Brainstormez des idées de projet avec l'accompagnement guidé d'un coach de brainstorming | `brainstorming-report.md` |
|
||||
| `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validez les hypothèses de marché, techniques ou de domaine | Rapport de recherches |
|
||||
| `bmad-create-product-brief` | Capturez la vision stratégique | `product-brief.md` |
|
||||
|
||||
## Phase 2 : Planification
|
||||
|
||||
Définissez ce qu'il faut construire et pour qui.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|-------------------------|---------------------------------------------------------|--------------|
|
||||
| `bmad-create-prd` | Définissez les exigences (FRs/NFRs)[^1] | `PRD.md`[^2] |
|
||||
| `bmad-create-ux-design` | Concevez l'expérience utilisateur (lorsque l'UX compte) | `ux-spec.md` |
|
||||
|
||||
## Phase 3 : Solutioning
|
||||
|
||||
Décidez comment le construire et décomposez le travail en stories.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|---------------------------------------|---------------------------------------------------|------------------------------|
|
||||
| `bmad-create-architecture` | Rendez les décisions techniques explicites | `architecture.md` avec ADRs[^3] |
|
||||
| `bmad-create-epics-and-stories` | Décomposez les exigences en travail implémentable | Fichiers d'epic avec stories |
|
||||
| `bmad-check-implementation-readiness` | Vérification avant implémentation | Décision Passe/Réserves/Échec |
|
||||
|
||||
## Phase 4 : Implémentation
|
||||
|
||||
Construisez, une story à la fois. Bientôt disponible : automatisation complète de la phase 4 !
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|------------------------|-------------------------------------------------------------------------------------|----------------------------------|
|
||||
| `bmad-sprint-planning` | Initialisez le suivi (une fois par projet pour séquencer le cycle de développement) | `sprint-status.yaml` |
|
||||
| `bmad-create-story` | Préparez la story suivante pour implémentation | `story-[slug].md` |
|
||||
| `bmad-dev-story` | Implémentez la story | Code fonctionnel + tests |
|
||||
| `bmad-code-review` | Validez la qualité de l'implémentation | Approuvé ou changements demandés |
|
||||
| `bmad-correct-course` | Gérez les changements significatifs en cours de sprint | Plan mis à jour ou réorientation |
|
||||
| `bmad-sprint-status` | Suivez la progression du sprint et le statut des stories | Mise à jour du statut du sprint |
|
||||
| `bmad-retrospective` | Revue après complétion d'un epic | Leçons apprises |
|
||||
|
||||
## Quick Dev (Parcours Parallèle)
|
||||
|
||||
Sautez les phases 1-3 pour les travaux de faible envergure et bien compris.
|
||||
|
||||
| Workflow | Objectif | Produit |
|
||||
|------------------|-------------------------------------------------------------------------------------|-----------------------|
|
||||
| `bmad-quick-dev` | Flux rapide unifié — clarifie l'intention, planifie, implémente, révise et présente | `tech-spec.md` + code |
|
||||
|
||||
## Gestion du Contexte
|
||||
|
||||
Chaque document devient le contexte de la phase suivante. Le PRD[^2] indique à l'architecte quelles contraintes sont importantes. L'architecture indique à l'agent de développement quels modèles suivre. Les fichiers de story fournissent un contexte focalisé et complet pour l'implémentation. Sans cette structure, les agents prennent des décisions incohérentes.
|
||||
|
||||
### Contexte du Projet
|
||||
|
||||
:::tip[Recommandé]
|
||||
Créez `project-context.md` pour vous assurer que les agents IA suivent les règles et préférences de votre projet. Ce fichier fonctionne comme une constitution pour votre projet — il guide les décisions d'implémentation à travers tous les workflows. Ce fichier optionnel peut être généré à la fin de la création de l'architecture, ou dans un projet existant il peut également être généré pour capturer ce qui est important de conserver aligné avec les conventions actuelles.
|
||||
:::
|
||||
|
||||
**Comment le créer :**
|
||||
|
||||
- **Manuellement** — Créez `_bmad-output/project-context.md` avec votre pile technologique et vos règles d'implémentation
|
||||
- **Générez-le** — Exécutez `bmad-generate-project-context` pour l'auto-générer à partir de votre architecture ou de votre codebase
|
||||
|
||||
[**En savoir plus sur project-context.md**](../explanation/project-context.md)
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: FR / NFR (Functional / Non-Functional Requirement) : exigences décrivant respectivement **ce que le système doit faire** (fonctionnalités, comportements attendus) et **comment il doit le faire** (contraintes de performance, sécurité, fiabilité, ergonomie, etc.).
|
||||
[^2]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d’aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^3]: ADR (Architecture Decision Record) : document qui consigne une décision d’architecture, son contexte, les options envisagées, le choix retenu et ses conséquences, afin d’assurer la traçabilité et la compréhension des décisions techniques dans le temps.
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: Feuille de route
|
||||
description: La suite pour BMad - Fonctionnalités, améliorations et contributions de la communauté
|
||||
---
|
||||
|
||||
# La Méthode BMad : Feuille de route publique
|
||||
|
||||
La Méthode BMad, BMad Method Module (BMM) et BMad Builder (BMB) évoluent. Voici ce sur quoi nous travaillons et ce qui arrive prochainement.
|
||||
|
||||
<div class="roadmap-container">
|
||||
|
||||
<h2 class="roadmap-section-title">En cours</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧩</span>
|
||||
<h4>Architecture par Skills Universelle</h4>
|
||||
<p>Un skill, toutes les plateformes. Écrivez une fois, exécutez partout.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>BMad Builder v1</h4>
|
||||
<p>Créez des agents IA et des workflows prêts pour la production avec des évaluations, des équipes et dégradation gracieuse intégrées.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧠</span>
|
||||
<h4>Système de Contexte Projet</h4>
|
||||
<p>Votre IA comprend vraiment votre projet. Un contexte adapté au framework qui évolue avec votre base de code.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📦</span>
|
||||
<h4>Skills Centralisés</h4>
|
||||
<p>Installez une fois, utilisez partout. Partagez des skills entre projets sans l'encombrement de fichiers.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔄</span>
|
||||
<h4>Skills Adaptatifs</h4>
|
||||
<p>Des skills qui connaissent vos outils. Des variantes optimisées pour Claude, Codex, Kimi et OpenCode, et bien d'autres encore.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📝</span>
|
||||
<h4>Blog BMad Team Pros</h4>
|
||||
<p>Guides, articles et perspectives de l'équipe. Lancement prochainement.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Pour bien commencer</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏪</span>
|
||||
<h4>Marketplace de Skills</h4>
|
||||
<p>Découvrez, installez et mettez à jour des skills créés par la communauté. À une commande curl de super-pouvoirs.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎨</span>
|
||||
<h4>Personnalisation de Workflow</h4>
|
||||
<p>Faites-en le vôtre. Intégrez Jira, Linear, des sorties personnalisées à votre workflow, vos règles.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🚀</span>
|
||||
<h4>Optimisation Phases 1-3</h4>
|
||||
<p>Planification éclair avec collecte de contexte par sous-agents. Le mode YOLO rencontre l'excellence guidée.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌐</span>
|
||||
<h4>Prêt pour l'Entreprise</h4>
|
||||
<p>SSO, journaux d'audit, espaces de travail d'équipe. Toutes les choses ennuyantes qui feront dire oui aux entreprises.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">💎</span>
|
||||
<h4>Explosion de Modules Communautaires</h4>
|
||||
<p>Divertissement, sécurité, thérapie, jeu de rôle et bien plus encore. Étendez la plateforme de la Méthode BMad.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>Automatisation de la Boucle de Développement</h4>
|
||||
<p>Pilote automatique optionnel pour le développement. Laissez l'IA gérer le flux tout en maintenant une qualité optimale.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Communauté et Équipe</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎙️</span>
|
||||
<h4>Le Podcast de la Méthode BMad</h4>
|
||||
<p>Conversations sur le développement natif IA. Lancement le 1er mars 2026 !</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎓</span>
|
||||
<h4>Le Master Class de la Méthode BMad</h4>
|
||||
<p>Passez d'utilisateur à expert. Approfondissements dans chaque phase, chaque workflow, chaque secret.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>La Master Class BMad Builder</h4>
|
||||
<p>Construisez vos propres agents. Techniques avancées pour quand vous êtes prêt à créer, pas seulement à utiliser.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>BMad Prototype First</h4>
|
||||
<p>De l'idée au prototype fonctionnel en une seule session. Créez l'application de vos rêves comme une œuvre d'art.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌴</span>
|
||||
<h4>BMad BALM !</h4>
|
||||
<p>Gestion de vie native IA. Tâches, habitudes, objectifs : votre copilote IA pour tout.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🖥️</span>
|
||||
<h4>UI Officielle</h4>
|
||||
<p>Une belle interface pour tout l'écosystème BMad. La puissance de la CLI, le polissage de l'interface graphique.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔒</span>
|
||||
<h4>BMad in a Box</h4>
|
||||
<p>Auto-hébergé, isolé, niveau entreprise. Votre assistant IA, votre infrastructure, votre contrôle.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="text-align: center; margin-top: 3rem; padding: 2rem; background: var(--color-bg-card); border-radius: 12px; border: 1px solid var(--color-border);">
|
||||
<h3 style="margin: 0 0 1rem;">Envie de contribuer ?</h3>
|
||||
<p style="color: var(--slate-color-400); margin: 0;">
|
||||
Ce n'est qu'une liste partielle de ce qui est prévu. L'équipe Open Source BMad accueille les contributeurs !{" "}<br />
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD" style="color: var(--color-in-progress);">Rejoignez-nous sur GitHub</a> pour aider à façonner l'avenir du développement propulsé par l'IA.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1.5rem 0 0;">
|
||||
Vous aimez ce que nous construisons ? Nous apprécions le soutien ponctuel et mensuel sur{" "}<a href="https://buymeacoffee.com/bmad" style="color: var(--color-in-progress);">Buy Me a Coffee</a>.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1rem 0 0;">
|
||||
Pour les parrainages d'entreprise, les demandes de partenariat, les interventions, les formations ou les demandes médias :{" "}
|
||||
<a href="mailto:contact@bmadcode.com" style="color: var(--color-in-progress);">contact@bmadcode.com</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,279 @@
|
|||
---
|
||||
title: "Premiers pas"
|
||||
description: Installer BMad et construire votre premier projet
|
||||
---
|
||||
|
||||
Construisez des logiciels plus rapidement en utilisant des workflows propulsés par l'IA avec des agents spécialisés qui vous guident à travers la planification, l'architecture et l'implémentation.
|
||||
|
||||
## Ce que vous allez apprendre
|
||||
|
||||
- Installer et initialiser la méthode BMad pour un nouveau projet
|
||||
- Utiliser **BMad-Help** — votre guide intelligent qui sait quoi faire ensuite
|
||||
- Choisir la bonne voie de planification selon la taille de votre projet
|
||||
- Progresser à travers les phases, des exigences au code fonctionnel
|
||||
- Utiliser efficacement les agents et les workflows
|
||||
|
||||
:::note[Prérequis]
|
||||
- **Node.js 20+** — Requis pour l'installateur
|
||||
- **Git** — Recommandé pour le contrôle de version
|
||||
- **IDE IA** — Claude Code, Cursor, ou similaire
|
||||
- **Une idée de projet** — Même simple, elle fonctionne pour apprendre
|
||||
:::
|
||||
|
||||
:::tip[Le chemin le plus simple]
|
||||
**Installer** → `npx bmad-method install`
|
||||
**Demander** → `bmad-help que dois-je faire en premier ?`
|
||||
**Construire** → Laissez BMad-Help vous guider workflow par workflow
|
||||
:::
|
||||
|
||||
## Découvrez BMad-Help : votre guide intelligent
|
||||
|
||||
**BMad-Help est le moyen le plus rapide de démarrer avec BMad.** Vous n'avez pas besoin de mémoriser les workflows ou les phases — posez simplement la question, et BMad-Help va :
|
||||
|
||||
- **Inspecter votre projet** pour voir ce qui a déjà été fait
|
||||
- **Vous montrer vos options** en fonction des modules que vous avez installés
|
||||
- **Recommander la prochaine étape** — y compris la première tâche obligatoire
|
||||
- **Répondre aux questions** comme « J'ai une idée de SaaS, par où commencer ? »
|
||||
|
||||
### Comment utiliser BMad-Help
|
||||
|
||||
Exécutez-le dans votre IDE avec IA en invoquant la skill :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
Ou combinez-le avec une question pour obtenir des conseils adaptés au contexte :
|
||||
|
||||
```
|
||||
bmad-help J'ai une idée de produit SaaS, je connais déjà toutes les fonctionnalités que je veux. Par où dois-je commencer ?
|
||||
```
|
||||
|
||||
BMad-Help répondra avec :
|
||||
- Ce qui est recommandé pour votre situation
|
||||
- Quelle est la première tâche obligatoire
|
||||
- À quoi ressemble le reste du processus
|
||||
|
||||
### Il alimente aussi les workflows
|
||||
|
||||
BMad-Help ne se contente pas de répondre aux questions — **il s'exécute automatiquement à la fin de chaque workflow** pour vous dire exactement quoi faire ensuite. Pas de devinettes, pas de recherche dans la documentation — juste des conseils clairs sur le prochain workflow requis.
|
||||
|
||||
:::tip[Commencez ici]
|
||||
Après avoir installé BMad, invoquez immédiatement la skill `bmad-help`. Elle détectera les modules que vous avez installés et vous guidera vers le bon point de départ pour votre projet.
|
||||
:::
|
||||
|
||||
## Comprendre BMad
|
||||
|
||||
BMad vous aide à construire des logiciels grâce à des workflows guidés avec des agents IA spécialisés. Le processus suit quatre phases :
|
||||
|
||||
| Phase | Nom | Ce qui se passe |
|
||||
|-------|----------------|----------------------------------------------------------------|
|
||||
| 1 | Analyse | Brainstorming, recherche, product brief *(optionnel)* |
|
||||
| 2 | Planification | Créer les exigences (PRD[^1] ou spécification technique) |
|
||||
| 3 | Solutioning | Concevoir l'architecture *(BMad Method/Enterprise uniquement)* |
|
||||
| 4 | Implémentation | Construire epic[^2] par epic, story[^3] par story |
|
||||
|
||||
**[Ouvrir la carte des workflows](../reference/workflow-map.md)** pour explorer les phases, les workflows et la gestion du contexte.
|
||||
|
||||
Selon la complexité de votre projet, BMad propose trois voies de planification :
|
||||
|
||||
| Voie | Idéal pour | Documents créés |
|
||||
|------------------|------------------------------------------------------------------------------|----------------------------------------|
|
||||
| **Quick Dev** | Corrections de bugs, fonctionnalités simples, périmètre clair (1-15 stories) | Spécification technique uniquement |
|
||||
| **méthode BMad** | Produits, plateformes, fonctionnalités complexes (10-50+ stories) | PRD + Architecture + UX[^4] |
|
||||
| **Enterprise** | Conformité, systèmes multi-tenant[^5] (30+ stories) | PRD + Architecture + Security + DevOps |
|
||||
|
||||
:::note
|
||||
Les comptes de stories sont indicatifs, pas des définitions. Choisissez votre voie en fonction des besoins de planification, pas du calcul des stories.
|
||||
:::
|
||||
|
||||
## Installation
|
||||
|
||||
Ouvrez un terminal dans le répertoire de votre projet et exécutez :
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
Si vous souhaitez la version préliminaire la plus récente au lieu du canal de release par défaut, utilisez `npx bmad-method@next install`.
|
||||
|
||||
Lorsque vous êtes invité à sélectionner des modules, choisissez **méthode BMad**.
|
||||
|
||||
L'installateur crée deux dossiers :
|
||||
- `_bmad/` — agents, workflows, tâches et configuration
|
||||
- `_bmad-output/` — vide pour l'instant, mais c'est là que vos artefacts seront enregistrés
|
||||
|
||||
:::tip[Votre prochaine étape]
|
||||
Ouvrez votre IDE avec IA dans le dossier du projet et exécutez :
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
BMad-Help détectera ce que vous avez accompli et recommandera exactement quoi faire ensuite. Vous pouvez aussi lui poser des questions comme « Quelles sont mes options ? » ou « J'ai une idée de SaaS, par où devrais-je commencer ? »
|
||||
:::
|
||||
|
||||
:::note[Comment charger les agents et exécuter les workflows]
|
||||
Chaque workflow possède une **skill** que vous invoquez par nom dans votre IDE (par ex., `bmad-create-prd`). Votre outil IA reconnaîtra le nom `bmad-*` et l'exécutera.
|
||||
:::
|
||||
|
||||
:::caution[Nouveaux chats]
|
||||
Démarrez toujours un nouveau chat pour chaque workflow. Cela évite que les limitations de contexte ne causent des problèmes.
|
||||
:::
|
||||
|
||||
## Étape 1 : Créer votre plan
|
||||
|
||||
Travaillez à travers les phases 1-3. **Utilisez de nouveaux chats pour chaque workflow.**
|
||||
|
||||
:::tip[Contexte de projet (Optionnel)]
|
||||
Avant de commencer, envisagez de créer `project-context.md` pour documenter vos préférences techniques et règles d'implémentation. Cela garantit que tous les agents IA suivent vos conventions tout au long du projet.
|
||||
|
||||
Créez-le manuellement dans `_bmad-output/project-context.md` ou générez-le après l'architecture en utilisant `bmad-generate-project-context`. [En savoir plus](../explanation/project-context.md).
|
||||
:::
|
||||
|
||||
### Phase 1 : Analyse (Optionnel)
|
||||
|
||||
Tous les workflows de cette phase sont optionnels :
|
||||
- **brainstorming** (`bmad-brainstorming`) — Idéation guidée
|
||||
- **research** (`bmad-research`) — Recherche marché et technique
|
||||
- **create-product-brief** (`bmad-create-product-brief`) — Document de base recommandé
|
||||
|
||||
### Phase 2 : Planification (Requis)
|
||||
|
||||
**Pour les voies BMad Method et Enterprise :**
|
||||
1. Exécutez `bmad-create-prd` dans un nouveau chat
|
||||
2. Sortie : `PRD.md`
|
||||
|
||||
**Pour la voie Quick Dev :**
|
||||
- Utilisez le workflow `bmad-quick-dev` (`bmad-quick-dev`) à la place du PRD, puis passez à l'implémentation
|
||||
|
||||
:::note[Design UX (Optionnel)]
|
||||
Si votre projet a une interface utilisateur, exécutez le workflow de design UX (`bmad-create-ux-design`) après avoir créé votre PRD.
|
||||
:::
|
||||
|
||||
### Phase 3 : Solutioning (méthode BMad/Enterprise)
|
||||
|
||||
**Créer l'Architecture**
|
||||
1. Exécutez `bmad-create-architecture` dans un nouveau chat
|
||||
2. Sortie : Document d'architecture avec les décisions techniques
|
||||
|
||||
**Créer les Epics et Stories**
|
||||
|
||||
:::tip[Amélioration V6]
|
||||
Les epics et stories sont maintenant créés *après* l'architecture. Cela produit des stories de meilleure qualité car les décisions d'architecture (base de données, patterns d'API, pile technologique) affectent directement la façon dont le travail doit être décomposé.
|
||||
:::
|
||||
|
||||
1. Exécutez `bmad-create-epics-and-stories` dans un nouveau chat
|
||||
2. Le workflow utilise à la fois le PRD et l'Architecture pour créer des stories techniquement éclairées
|
||||
|
||||
**Vérification de préparation à l'implémentation** *(Hautement recommandé)*
|
||||
1. Exécutez `bmad-check-implementation-readiness` dans un nouveau chat
|
||||
2. Valide la cohérence entre tous les documents de planification
|
||||
|
||||
## Étape 2 : Construire votre projet
|
||||
|
||||
Une fois la planification terminée, passez à l'implémentation. **Chaque workflow doit s'exécuter dans un nouveau chat.**
|
||||
|
||||
### Initialiser la planification de sprint
|
||||
|
||||
Exécutez `bmad-sprint-planning` dans un nouveau chat. Cela crée `sprint-status.yaml` pour suivre tous les epics et stories.
|
||||
|
||||
### Le cycle de construction
|
||||
|
||||
Pour chaque story, répétez ce cycle avec de nouveaux chats :
|
||||
|
||||
| Étape | Workflow | Commande | Objectif |
|
||||
| ----- | --------------------- | --------------------- | ----------------------------------- |
|
||||
| 1 | `bmad-create-story` | `bmad-create-story` | Créer le fichier story depuis l'epic |
|
||||
| 2 | `bmad-dev-story` | `bmad-dev-story` | Implémenter la story |
|
||||
| 3 | `bmad-code-review` | `bmad-code-review` | Validation de qualité *(recommandé)* |
|
||||
|
||||
Après avoir terminé toutes les stories d'un epic, exécutez `bmad-retrospective` dans un nouveau chat.
|
||||
|
||||
## Ce que vous avez accompli
|
||||
|
||||
Vous avez appris les fondamentaux de la construction avec BMad :
|
||||
|
||||
- Installé BMad et configuré pour votre IDE
|
||||
- Initialisé un projet avec votre voie de planification choisie
|
||||
- Créé des documents de planification (PRD, Architecture, Epics & Stories)
|
||||
- Compris le cycle de construction pour l'implémentation
|
||||
|
||||
Votre projet contient maintenant :
|
||||
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/ # Configuration BMad
|
||||
├── _bmad-output/
|
||||
│ ├── planning-artifacts/
|
||||
│ │ ├── PRD.md # Votre document d'exigences
|
||||
│ │ ├── architecture.md # Décisions techniques
|
||||
│ │ └── epics/ # Fichiers epic et story
|
||||
│ ├── implementation-artifacts/
|
||||
│ │ └── sprint-status.yaml # Suivi de sprint
|
||||
│ └── project-context.md # Règles d'implémentation (optionnel)
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Référence rapide
|
||||
|
||||
| Workflow | Commande | Objectif |
|
||||
| ------------------------------------- | ------------------------------------------- | ------------------------------------------------ |
|
||||
| **`bmad-help`** ⭐ | `bmad-help` | **Votre guide intelligent — posez n'importe quelle question !** |
|
||||
| `bmad-create-prd` | `bmad-create-prd` | Créer le document d'exigences produit |
|
||||
| `bmad-create-architecture` | `bmad-create-architecture` | Créer le document d'architecture |
|
||||
| `bmad-generate-project-context` | `bmad-generate-project-context` | Créer le fichier de contexte projet |
|
||||
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | Décomposer le PRD en epics |
|
||||
| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Valider la cohérence de planification |
|
||||
| `bmad-sprint-planning` | `bmad-sprint-planning` | Initialiser le suivi de sprint |
|
||||
| `bmad-create-story` | `bmad-create-story` | Créer un fichier story |
|
||||
| `bmad-dev-story` | `bmad-dev-story` | Implémenter une story |
|
||||
| `bmad-code-review` | `bmad-code-review` | Revoir le code implémenté |
|
||||
|
||||
## Questions fréquentes
|
||||
|
||||
**Ai-je toujours besoin d'une architecture ?**
|
||||
Uniquement pour les voies méthode BMad et Enterprise. Quick Dev passe directement de la spécification technique (tech-spec) à l'implémentation.
|
||||
|
||||
**Puis-je modifier mon plan plus tard ?**
|
||||
Oui. Utilisez `bmad-correct-course` pour gérer les changements de périmètre.
|
||||
|
||||
**Et si je veux d'abord faire du brainstorming ?**
|
||||
Invoquez l'agent Analyst (`bmad-analyst`) et exécutez `bmad-brainstorming` (`bmad-brainstorming`) avant de commencer votre PRD.
|
||||
|
||||
**Dois-je suivre un ordre strict ?**
|
||||
Pas strictement. Une fois que vous maîtrisez le flux, vous pouvez exécuter les workflows directement en utilisant la référence rapide ci-dessus.
|
||||
|
||||
## Obtenir de l'aide
|
||||
|
||||
:::tip[Premier arrêt : BMad-Help]
|
||||
**Invoquez `bmad-help` à tout moment** — c'est le moyen le plus rapide de se débloquer. Posez n'importe quelle question :
|
||||
- « Que dois-je faire après l'installation ? »
|
||||
- « Je suis bloqué sur le workflow X »
|
||||
- « Quelles sont mes options pour Y ? »
|
||||
- « Montre-moi ce qui a été fait jusqu'ici »
|
||||
|
||||
BMad-Help inspecte votre projet, détecte ce que vous avez accompli et vous dit exactement quoi faire ensuite.
|
||||
:::
|
||||
|
||||
- **Pendant les workflows** — Les agents vous guident avec des questions et des explications
|
||||
- **Communauté** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
||||
|
||||
## Points clés à retenir
|
||||
|
||||
:::tip[Retenez ceci]
|
||||
- **Commencez par `bmad-help`** — Votre guide intelligent qui connaît votre projet et vos options
|
||||
- **Utilisez toujours de nouveaux chats** — Démarrez un nouveau chat pour chaque workflow
|
||||
- **La voie compte** — Quick Dev utilise `bmad-quick-dev` ; La méthode BMad/Enterprise nécessitent PRD et architecture
|
||||
- **BMad-Help s'exécute automatiquement** — Chaque workflow se termine par des conseils sur la prochaine étape
|
||||
:::
|
||||
|
||||
Prêt à commencer ? Installez BMad, invoquez `bmad-help`, et laissez votre guide intelligent vous montrer le chemin.
|
||||
|
||||
## Glossaire
|
||||
|
||||
[^1]: PRD (Product Requirements Document) : document de référence qui décrit les objectifs du produit, les besoins utilisateurs, les fonctionnalités attendues, les contraintes et les critères de succès, afin d'aligner les équipes sur ce qui doit être construit et pourquoi.
|
||||
[^2]: Epic : grand ensemble de fonctionnalités ou de travaux qui peut être décomposé en plusieurs user stories.
|
||||
[^3]: Story (User Story) : description courte et simple d'une fonctionnalité du point de vue de l'utilisateur ou du client. Elle représente une unité de travail implémentable en un court délai.
|
||||
[^4]: UX (User Experience) : expérience utilisateur, englobant l'ensemble des interactions et perceptions d'un utilisateur face à un produit. Le design UX vise à créer des interfaces intuitives, efficaces et agréables en tenant compte des besoins, comportements et contexte d'utilisation.
|
||||
[^5]: Multi-tenant : architecture logicielle où une seule instance de l'application sert plusieurs clients (tenants) tout en maintenant leurs données isolées et sécurisées les unes des autres.
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
---
|
||||
title: "How to Make Quick Fixes 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.
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Simple bug fixes
|
||||
- Small refactorings and changes that don't need extensive ideation, planning, or architectural shifts
|
||||
- Larger refactorings or improvement with built in tool planning and execution mode combination, or better yet use quick flow
|
||||
- Learning about your codebase
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Load an Agent
|
||||
|
||||
For quick fixes, you can use:
|
||||
|
||||
- **DEV agent** - For implementation-focused work
|
||||
- **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
|
||||
|
||||
Simply tell the agent what you need:
|
||||
|
||||
```
|
||||
Fix the login validation bug that allows empty passwords
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
Refactor the UserService to use async/await instead of callbacks
|
||||
```
|
||||
|
||||
### 3. Let the Agent Work
|
||||
|
||||
The agent will:
|
||||
|
||||
- Analyze the relevant code
|
||||
- Propose a solution
|
||||
- Implement the change
|
||||
- Run tests (if available)
|
||||
|
||||
### 4. Review and Commit
|
||||
|
||||
Review the changes made and commit when satisfied.
|
||||
|
||||
## Learning Your Codebase
|
||||
|
||||
This approach is also excellent for exploring unfamiliar code:
|
||||
|
||||
```
|
||||
Explain how the authentication system works in this codebase
|
||||
```
|
||||
|
||||
```
|
||||
Show me where error handling happens in the API layer
|
||||
```
|
||||
|
||||
LLMs are excellent at interpreting and analyzing code, whether it was AI-generated or not. Use the agent to:
|
||||
|
||||
- Learn about your project
|
||||
- Understand how things are built
|
||||
- Explore unfamiliar parts of the codebase
|
||||
|
||||
## When to Upgrade to Formal Planning
|
||||
|
||||
Consider using Quick Flow or full BMad Method when:
|
||||
|
||||
- The change affects multiple files or systems
|
||||
- You're unsure about the scope
|
||||
- The fix keeps growing in complexity
|
||||
- You need documentation for the change
|
||||
|
|
@ -1,33 +1,35 @@
|
|||
---
|
||||
title: "BMad Method Customization Guide"
|
||||
title: "How to Customize BMad"
|
||||
description: Customize agents, workflows, and modules while preserving update compatibility
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
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.
|
||||
Use the `.customize.yaml` files to tailor agent behavior, personas, and menus while preserving your changes across updates.
|
||||
|
||||
The Customization Guidance outlined here, while targeted at understanding BMad Method customization, applies to any other module use within the BMad Method.
|
||||
## When to Use This
|
||||
|
||||
## Types of Customization
|
||||
- You want to change an agent's name, personality, or communication style
|
||||
- You need agents to remember project-specific context
|
||||
- You want to add custom menu items that trigger your own workflows or prompts
|
||||
- You want agents to perform specific actions every time they start up
|
||||
|
||||
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.
|
||||
:::note[Prerequisites]
|
||||
- BMad installed in your project (see [How to Install BMad](./install-bmad.md))
|
||||
- A text editor for YAML files
|
||||
:::
|
||||
|
||||
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.
|
||||
:::caution[Keep Your Customizations Safe]
|
||||
Always use the `.customize.yaml` files described here rather than editing agent files directly. The installer overwrites agent files during updates, but preserves your `.customize.yaml` changes.
|
||||
:::
|
||||
|
||||
## Agent Customization
|
||||
## Steps
|
||||
|
||||
### Agent Customization Areas
|
||||
### 1. Locate Customization Files
|
||||
|
||||
- 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
|
||||
After installation, find one `.customize.yaml` file per agent in:
|
||||
|
||||
## How to customize an agent.
|
||||
|
||||
**1. Locate Customization Files**
|
||||
|
||||
After installation, find agent customization files in:
|
||||
|
||||
```
|
||||
```text
|
||||
_bmad/_config/agents/
|
||||
├── core-bmad-master.customize.yaml
|
||||
├── bmm-dev.customize.yaml
|
||||
|
|
@ -35,28 +37,22 @@ _bmad/_config/agents/
|
|||
└── ... (one file per installed agent)
|
||||
```
|
||||
|
||||
**2. Edit Any Agent**
|
||||
### 2. Edit the Customization File
|
||||
|
||||
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
||||
Open the `.customize.yaml` file for the agent you want to modify. Every section is optional -- customize only what you need.
|
||||
|
||||
**3. Rebuild the Agent**
|
||||
| Section | Behavior | Purpose |
|
||||
| ------------------ | -------- | ----------------------------------------------- |
|
||||
| `agent.metadata` | Replaces | Override the agent's display name |
|
||||
| `persona` | Replaces | Set role, identity, style, and principles |
|
||||
| `memories` | Appends | Add persistent context the agent always recalls |
|
||||
| `menu` | Appends | Add custom menu items for workflows or prompts |
|
||||
| `critical_actions` | Appends | Define startup instructions for the agent |
|
||||
| `prompts` | Appends | Create reusable prompts for menu actions |
|
||||
|
||||
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
||||
Sections marked **Replaces** overwrite the agent's defaults entirely. Sections marked **Appends** add to the existing configuration.
|
||||
|
||||
```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
|
||||
**Agent Name**
|
||||
|
||||
Change how the agent introduces itself:
|
||||
|
||||
|
|
@ -66,7 +62,7 @@ agent:
|
|||
name: 'Spongebob' # Default: "Amelia"
|
||||
```
|
||||
|
||||
#### Persona
|
||||
**Persona**
|
||||
|
||||
Replace the agent's personality, role, and communication style:
|
||||
|
||||
|
|
@ -80,45 +76,45 @@ persona:
|
|||
- 'Favor composition over inheritance'
|
||||
```
|
||||
|
||||
**Note:** The persona section replaces the entire default persona (not merged).
|
||||
The `persona` section replaces the entire default persona, so include all four fields if you set it.
|
||||
|
||||
#### Memories
|
||||
**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'
|
||||
- 'Favorite Celebrity: David Hasselhoff'
|
||||
- 'Learned in Epic 1 that it is not cool to just pretend that tests have passed'
|
||||
```
|
||||
|
||||
### Custom Menu Items
|
||||
**Menu Items**
|
||||
|
||||
Any custom items you add here will be included in the agents display menu.
|
||||
Add custom entries to the agent's display menu. Each item needs a `trigger`, a target (`workflow` path or `action` reference), and a `description`:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||
workflow: 'my-custom/workflows/my-workflow.yaml'
|
||||
description: My custom workflow
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
description: Deploy to production
|
||||
```
|
||||
|
||||
### Critical Actions
|
||||
**Critical Actions**
|
||||
|
||||
Add instructions that execute before the agent starts:
|
||||
Define instructions that run when the agent starts up:
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
|
||||
```
|
||||
|
||||
### Custom Prompts
|
||||
**Custom Prompts**
|
||||
|
||||
Define reusable prompts for `action="#id"` menu handlers:
|
||||
Create reusable prompts that menu items can reference with `action="#id"`:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
|
|
@ -130,29 +126,46 @@ prompts:
|
|||
3. Execute deployment script
|
||||
```
|
||||
|
||||
### 3. Apply Your Changes
|
||||
|
||||
After editing, reinstall to apply changes:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
The installer detects the existing installation and offers these options:
|
||||
|
||||
| Option | What It Does |
|
||||
| ---------------------------- | ------------------------------------------------------------------- |
|
||||
| **Quick Update** | Updates all modules to the latest version and applies customizations |
|
||||
| **Modify BMad Installation** | Full installation flow for adding or removing modules |
|
||||
|
||||
For customization-only changes, **Quick Update** is the fastest option.
|
||||
|
||||
## 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
|
||||
- Run `npx bmad-method install` and select **Quick Update** to apply changes
|
||||
- Check that your YAML syntax is valid (indentation matters)
|
||||
- Verify you edited the correct `.customize.yaml` file for the agent
|
||||
|
||||
**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
|
||||
- Check for YAML syntax errors using an online YAML validator
|
||||
- Ensure you did not leave fields empty after uncommenting them
|
||||
- Try reverting to the original template and rebuilding
|
||||
|
||||
**Need to reset?**
|
||||
**Need to reset an agent?**
|
||||
|
||||
- Remove content from the `.customize.yaml` file (or delete the file)
|
||||
- Run `npx bmad-method build <agent-name>` to regenerate defaults
|
||||
- Clear or delete the agent's `.customize.yaml` file
|
||||
- Run `npx bmad-method install` and select **Quick Update** to restore defaults
|
||||
|
||||
## Workflow Customization
|
||||
|
||||
Information about customizing existing BMad Method workflows and skills are coming soon.
|
||||
Customization of existing BMad Method workflows and skills is coming soon.
|
||||
|
||||
## Module Customization
|
||||
|
||||
Information on how to build expansion modules that augment BMad, or make other existing module customizations are coming soon.
|
||||
Guidance on building expansion modules and customizing existing modules is coming soon.
|
||||
|
|
|
|||
|
|
@ -1,20 +1,18 @@
|
|||
---
|
||||
title: "Brownfield Development"
|
||||
title: "Established Projects"
|
||||
description: How to use BMad Method on existing codebases
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Use BMad Method effectively when working on existing projects and legacy codebases.
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
||||
|
||||
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
||||
This guide covers the essential workflow for onboarding to existing projects with BMad Method.
|
||||
|
||||
:::note[Prerequisites]
|
||||
- BMad Method installed (`npx bmad-method install`)
|
||||
- An existing codebase you want to work on
|
||||
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
|
||||
- Access to an AI-powered IDE (Claude Code or Cursor)
|
||||
:::
|
||||
|
||||
## Step 1: Clean Up Completed Planning Artifacts
|
||||
|
|
@ -25,7 +23,30 @@ If you have completed all PRD epics and stories through the BMad process, clean
|
|||
- `_bmad-output/planning-artifacts/`
|
||||
- `_bmad-output/implementation-artifacts/`
|
||||
|
||||
## Step 2: Maintain Quality Project Documentation
|
||||
## Step 2: Create Project Context
|
||||
|
||||
:::tip[Recommended for Existing Projects]
|
||||
Generate `project-context.md` to capture your existing codebase patterns and conventions. This ensures AI agents follow your established practices when implementing changes.
|
||||
:::
|
||||
|
||||
Run the generate project context workflow:
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
This scans your codebase to identify:
|
||||
- Technology stack and versions
|
||||
- Code organization patterns
|
||||
- Naming conventions
|
||||
- Testing approaches
|
||||
- Framework-specific patterns
|
||||
|
||||
You can review and refine the generated file, or create it manually at `_bmad-output/project-context.md` if you prefer.
|
||||
|
||||
[Learn more about project context](../explanation/project-context.md)
|
||||
|
||||
## Step 3: Maintain Quality Project Documentation
|
||||
|
||||
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
|
||||
|
||||
|
|
@ -34,13 +55,25 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
|||
- Architecture
|
||||
- Any other relevant project information
|
||||
|
||||
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 `bmad-document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
|
||||
|
||||
## Step 3: Get Help
|
||||
|
||||
Get help to know what to do next based on your unique needs
|
||||
### BMad-Help: Your Starting Point
|
||||
|
||||
Run `bmad-help` to get guidance when you are not sure what to do next.
|
||||
**Run `bmad-help` anytime you're unsure what to do next.** This intelligent guide:
|
||||
|
||||
- Inspects your project to see what's already been done
|
||||
- Shows options based on your installed modules
|
||||
- Understands natural language queries
|
||||
|
||||
```
|
||||
bmad-help I have an existing Rails app, where should I start?
|
||||
bmad-help What's the difference between quick-flow and full method?
|
||||
bmad-help Show me what workflows are available
|
||||
```
|
||||
|
||||
BMad-Help also **automatically runs at the end of every workflow**, providing clear guidance on exactly what to do next.
|
||||
|
||||
### Choosing Your Approach
|
||||
|
||||
|
|
@ -48,8 +81,8 @@ You have two primary options depending on the scope of changes:
|
|||
|
||||
| Scope | Recommended Approach |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad method is likely overkill. |
|
||||
| **Major changes or additions** | Start with the BMad method, applying as much or as little rigor as needed. |
|
||||
| **Small updates or additions** | Run `bmad-quick-dev` to clarify intent, plan, implement, and review in a single workflow. The full four-phase BMad Method is likely overkill. |
|
||||
| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |
|
||||
|
||||
### During PRD Creation
|
||||
|
||||
|
|
@ -80,5 +113,5 @@ Pay close attention here to prevent reinventing the wheel or making decisions th
|
|||
|
||||
## More Information
|
||||
|
||||
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
|
||||
- **[Brownfield FAQ](/docs/explanation/brownfield-faq.md)** - Common questions about brownfield development
|
||||
- **[Quick Fixes](./quick-fixes.md)** - Bug fixes and ad-hoc changes
|
||||
- **[Established Projects FAQ](../explanation/established-projects-faq.md)** - Common questions about working on established projects
|
||||
|
|
@ -1,20 +1,55 @@
|
|||
---
|
||||
title: "How to Get Answers About BMad"
|
||||
description: Use an LLM to quickly answer your own BMad questions
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
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.
|
||||
## Start Here: BMad-Help
|
||||
|
||||
## When to Use This
|
||||
**The fastest way to get answers about BMad is the `bmad-help` skill.** This intelligent guide will answer upwards of 80% of all questions and is available to you directly in your IDE as you work.
|
||||
|
||||
- You have a question about how BMad works or what to do next with BMad
|
||||
- You want to understand a specific agent or workflow
|
||||
- You need quick answers without waiting for Discord
|
||||
BMad-Help is more than a lookup tool — it:
|
||||
- **Inspects your project** to see what's already been completed
|
||||
- **Understands natural language** — ask questions in plain English
|
||||
- **Varies based on your installed modules** — shows relevant options
|
||||
- **Auto-runs after workflows** — tells you exactly what to do next
|
||||
- **Recommends the first required task** — no guessing where to start
|
||||
|
||||
:::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.
|
||||
### How to Use BMad-Help
|
||||
|
||||
Call it by name in your AI session:
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
:::tip
|
||||
You can also use `/bmad-help` or `$bmad-help` depending on your platform, but just `bmad-help` should work everywhere.
|
||||
:::
|
||||
|
||||
Combine it with a natural language query:
|
||||
|
||||
```
|
||||
bmad-help I have a SaaS idea and know all the features. Where do I start?
|
||||
bmad-help What are my options for UX design?
|
||||
bmad-help I'm stuck on the PRD workflow
|
||||
bmad-help Show me what's been done so far
|
||||
```
|
||||
|
||||
BMad-Help responds with:
|
||||
- What's recommended for your situation
|
||||
- What the first required task is
|
||||
- What the rest of the process looks like
|
||||
|
||||
## When to Use This Guide
|
||||
|
||||
Use this section when:
|
||||
- You want to understand BMad's architecture or internals
|
||||
- You need answers outside of what BMad-Help provides
|
||||
- You're researching BMad before installing
|
||||
- You want to explore the source code directly
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Choose Your Source
|
||||
|
|
@ -38,18 +73,17 @@ The `_bmad` folder is created when you install BMad. If you don't have it yet, c
|
|||
|
||||
Fetch `llms-full.txt` into your session:
|
||||
|
||||
```
|
||||
```text
|
||||
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
||||
```
|
||||
|
||||
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
||||
|
||||
### 3. Ask Your Question
|
||||
|
||||
:::note[Example]
|
||||
**Q:** "Tell me the fastest way to build something with BMad"
|
||||
|
||||
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
||||
**A:** Use Quick Flow: Run `bmad-quick-dev` — it clarifies your intent, plans, implements, reviews, and presents results in a single workflow, skipping the full planning phases.
|
||||
:::
|
||||
|
||||
## What You Get
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
---
|
||||
title: "How to Install BMad"
|
||||
description: Step-by-step guide to installing BMad in your project
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
||||
|
||||
If you want to use a non interactive installer and provide all install options on the command line, see [this guide](./non-interactive-installation.md).
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Starting a new project with BMad
|
||||
|
|
@ -14,7 +18,7 @@ Use the `npx bmad-method install` command to set up BMad in your project with yo
|
|||
:::note[Prerequisites]
|
||||
- **Node.js** 20+ (required for the installer)
|
||||
- **Git** (recommended)
|
||||
- **AI tool** (Claude Code, Cursor, Windsurf, or similar)
|
||||
- **AI tool** (Claude Code, Cursor, or similar)
|
||||
:::
|
||||
|
||||
## Steps
|
||||
|
|
@ -25,6 +29,22 @@ Use the `npx bmad-method install` command to set up BMad in your project with yo
|
|||
npx bmad-method install
|
||||
```
|
||||
|
||||
:::tip[Want the newest prerelease build?]
|
||||
Use the `next` dist-tag:
|
||||
```bash
|
||||
npx bmad-method@next install
|
||||
```
|
||||
|
||||
This gets you newer changes earlier, with a higher chance of churn than the default install.
|
||||
:::
|
||||
|
||||
:::tip[Bleeding edge]
|
||||
To install the latest from the main branch (may be unstable):
|
||||
```bash
|
||||
npx github:bmad-code-org/BMAD-METHOD install
|
||||
```
|
||||
:::
|
||||
|
||||
### 2. Choose Installation Location
|
||||
|
||||
The installer will ask where to install BMad files:
|
||||
|
|
@ -38,10 +58,13 @@ 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.
|
||||
Each tool has its own way of integrating skills. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
||||
|
||||
:::note[Enabling Skills]
|
||||
Some platforms require skills to be explicitly enabled in settings before they appear. If you install BMad and don't see the skills, check your platform's settings or ask your AI assistant how to enable skills.
|
||||
:::
|
||||
|
||||
### 4. Choose Modules
|
||||
|
||||
|
|
@ -53,7 +76,7 @@ The installer guides you through the rest — custom content, settings, etc.
|
|||
|
||||
## What You Get
|
||||
|
||||
```
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/
|
||||
│ ├── bmm/ # Your selected modules
|
||||
|
|
@ -61,22 +84,33 @@ your-project/
|
|||
│ ├── core/ # Required core module
|
||||
│ └── ...
|
||||
├── _bmad-output/ # Generated artifacts
|
||||
└── .claude/ # Claude Code commands (if using Claude Code)
|
||||
├── .claude/ # Claude Code skills (if using Claude Code)
|
||||
│ └── skills/
|
||||
│ ├── bmad-help/
|
||||
│ ├── bmad-persona/
|
||||
│ └── ...
|
||||
└── .cursor/ # Cursor skills (if using Cursor)
|
||||
└── skills/
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
|
||||
Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next.
|
||||
Run `bmad-help` to verify everything works and see what to do next.
|
||||
|
||||
**Latest from main branch:**
|
||||
```bash
|
||||
npx github:bmad-code-org/BMAD-METHOD install
|
||||
**BMad-Help is your intelligent guide** that will:
|
||||
- Confirm your installation is working
|
||||
- Show what's available based on your installed modules
|
||||
- Recommend your first step
|
||||
|
||||
You can also ask it questions:
|
||||
```
|
||||
bmad-help I just installed, what should I do first?
|
||||
bmad-help What are my options for a SaaS project?
|
||||
```
|
||||
|
||||
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.
|
||||
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](./get-answers-about-bmad.md) for how to point your AI at the right sources.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,171 @@
|
|||
---
|
||||
title: Non-Interactive Installation
|
||||
description: Install BMad using command-line flags for CI/CD pipelines and automated deployments
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Use command-line flags to install BMad non-interactively. This is useful for:
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Automated deployments and CI/CD pipelines
|
||||
- Scripted installations
|
||||
- Batch installations across multiple projects
|
||||
- Quick installations with known configurations
|
||||
|
||||
:::note[Prerequisites]
|
||||
Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm).
|
||||
:::
|
||||
|
||||
## Available Flags
|
||||
|
||||
### Installation Options
|
||||
|
||||
| Flag | Description | Example |
|
||||
|------|-------------|---------|
|
||||
| `--directory <path>` | Installation directory | `--directory ~/projects/myapp` |
|
||||
| `--modules <modules>` | Comma-separated module IDs | `--modules bmm,bmb` |
|
||||
| `--tools <tools>` | Comma-separated tool/IDE IDs (use `none` to skip) | `--tools claude-code,cursor` or `--tools none` |
|
||||
| `--custom-content <paths>` | Comma-separated paths to custom modules | `--custom-content ~/my-module,~/another-module` |
|
||||
| `--action <type>` | Action for existing installations: `install` (default), `update`, or `quick-update` | `--action quick-update` |
|
||||
|
||||
### Core Configuration
|
||||
|
||||
| Flag | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `--user-name <name>` | Name for agents to use | System username |
|
||||
| `--communication-language <lang>` | Agent communication language | English |
|
||||
| `--document-output-language <lang>` | Document output language | English |
|
||||
| `--output-folder <path>` | Output folder path | _bmad-output |
|
||||
|
||||
### Other Options
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `-y, --yes` | Accept all defaults and skip prompts |
|
||||
| `-d, --debug` | Enable debug output for manifest generation |
|
||||
|
||||
## Module IDs
|
||||
|
||||
Available module IDs for the `--modules` flag:
|
||||
|
||||
- `bmm` — BMad Method Master
|
||||
- `bmb` — BMad Builder
|
||||
|
||||
Check the [BMad registry](https://github.com/bmad-code-org) for available external modules.
|
||||
|
||||
## Tool/IDE IDs
|
||||
|
||||
Available tool IDs for the `--tools` flag:
|
||||
|
||||
**Preferred:** `claude-code`, `cursor`
|
||||
|
||||
Run `npx bmad-method install` interactively once to see the full current list of supported tools, or check the [platform codes configuration](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
||||
|
||||
## Installation Modes
|
||||
|
||||
| Mode | Description | Example |
|
||||
|------|-------------|---------|
|
||||
| Fully non-interactive | Provide all flags to skip all prompts | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` |
|
||||
| Semi-interactive | Provide some flags; BMad prompts for the rest | `npx bmad-method install --directory . --modules bmm` |
|
||||
| Defaults only | Accept all defaults with `-y` | `npx bmad-method install --yes` |
|
||||
| Without tools | Skip tool/IDE configuration | `npx bmad-method install --modules bmm --tools none` |
|
||||
|
||||
## Examples
|
||||
|
||||
### CI/CD Pipeline Installation
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# install-bmad.sh
|
||||
|
||||
npx bmad-method install \
|
||||
--directory "${GITHUB_WORKSPACE}" \
|
||||
--modules bmm \
|
||||
--tools claude-code \
|
||||
--user-name "CI Bot" \
|
||||
--communication-language English \
|
||||
--document-output-language English \
|
||||
--output-folder _bmad-output \
|
||||
--yes
|
||||
```
|
||||
|
||||
### Update Existing Installation
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action update \
|
||||
--modules bmm,bmb,custom-module
|
||||
```
|
||||
|
||||
### Quick Update (Preserve Settings)
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--action quick-update
|
||||
```
|
||||
|
||||
### Installation with Custom Content
|
||||
|
||||
```bash
|
||||
npx bmad-method install \
|
||||
--directory ~/projects/myapp \
|
||||
--modules bmm \
|
||||
--custom-content ~/my-custom-module,~/another-module \
|
||||
--tools claude-code
|
||||
```
|
||||
|
||||
## What You Get
|
||||
|
||||
- A fully configured `_bmad/` directory in your project
|
||||
- Agents and workflows configured for your selected modules and tools
|
||||
- A `_bmad-output/` folder for generated artifacts
|
||||
|
||||
## Validation and Error Handling
|
||||
|
||||
BMad validates all provided flags:
|
||||
|
||||
- **Directory** — Must be a valid path with write permissions
|
||||
- **Modules** — Warns about invalid module IDs (but won't fail)
|
||||
- **Tools** — Warns about invalid tool IDs (but won't fail)
|
||||
- **Custom Content** — Each path must contain a valid `module.yaml` file
|
||||
- **Action** — Must be one of: `install`, `update`, `quick-update`
|
||||
|
||||
Invalid values will either:
|
||||
1. Show an error and exit (for critical options like directory)
|
||||
2. Show a warning and skip (for optional items like custom content)
|
||||
3. Fall back to interactive prompts (for missing required values)
|
||||
|
||||
:::tip[Best Practices]
|
||||
- Use absolute paths for `--directory` to avoid ambiguity
|
||||
- Test flags locally before using in CI/CD pipelines
|
||||
- Combine with `-y` for truly unattended installations
|
||||
- Use `--debug` if you encounter issues during installation
|
||||
:::
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Installation fails with "Invalid directory"
|
||||
|
||||
- The directory path must exist (or its parent must exist)
|
||||
- You need write permissions
|
||||
- The path must be absolute or correctly relative to the current directory
|
||||
|
||||
### Module not found
|
||||
|
||||
- Verify the module ID is correct
|
||||
- External modules must be available in the registry
|
||||
|
||||
### Custom content path invalid
|
||||
|
||||
Ensure each custom content path:
|
||||
- Points to a directory
|
||||
- Contains a `module.yaml` file in the root
|
||||
- Has a `code` field in the `module.yaml`
|
||||
|
||||
:::note[Still stuck?]
|
||||
Run with `--debug` for detailed output, try interactive mode to isolate the issue, or report at <https://github.com/bmad-code-org/BMAD-METHOD/issues>.
|
||||
:::
|
||||
|
|
@ -0,0 +1,127 @@
|
|||
---
|
||||
title: "Manage Project Context"
|
||||
description: Create and maintain project-context.md to guide AI agents
|
||||
sidebar:
|
||||
order: 8
|
||||
---
|
||||
|
||||
Use the `project-context.md` file to ensure AI agents follow your project's technical preferences and implementation rules throughout all workflows. To make sure this is always available, you can also add the line `Important project context and conventions are located in [path to project context]/project-context.md` to your tools context or always rules file (such as `AGENTS.md`)
|
||||
|
||||
:::note[Prerequisites]
|
||||
- BMad Method installed
|
||||
- Understanding of your project's technology stack and conventions
|
||||
:::
|
||||
|
||||
## When to Use This
|
||||
|
||||
- You have strong technical preferences before starting architecture
|
||||
- You've completed architecture and want to capture decisions for implementation
|
||||
- You're working on an existing codebase with established patterns
|
||||
- You notice agents making inconsistent decisions across stories
|
||||
|
||||
## Step 1: Choose Your Approach
|
||||
|
||||
**Manual creation** — Best when you know exactly what rules you want to document
|
||||
|
||||
**Generate after architecture** — Best for capturing decisions made during solutioning
|
||||
|
||||
**Generate for existing projects** — Best for discovering patterns in existing codebases
|
||||
|
||||
## Step 2: Create the File
|
||||
|
||||
### Option A: Manual Creation
|
||||
|
||||
Create the file at `_bmad-output/project-context.md`:
|
||||
|
||||
```bash
|
||||
mkdir -p _bmad-output
|
||||
touch _bmad-output/project-context.md
|
||||
```
|
||||
|
||||
Add your technology stack and implementation rules:
|
||||
|
||||
```markdown
|
||||
---
|
||||
project_name: 'MyProject'
|
||||
user_name: 'YourName'
|
||||
date: '2026-02-15'
|
||||
sections_completed: ['technology_stack', 'critical_rules']
|
||||
---
|
||||
|
||||
# Project Context for AI Agents
|
||||
|
||||
## Technology Stack & Versions
|
||||
|
||||
- Node.js 20.x, TypeScript 5.3, React 18.2
|
||||
- State: Zustand
|
||||
- Testing: Vitest, Playwright
|
||||
- Styling: Tailwind CSS
|
||||
|
||||
## Critical Implementation Rules
|
||||
|
||||
**TypeScript:**
|
||||
- Strict mode enabled, no `any` types
|
||||
- Use `interface` for public APIs, `type` for unions
|
||||
|
||||
**Code Organization:**
|
||||
- Components in `/src/components/` with co-located tests
|
||||
- API calls use `apiClient` singleton — never fetch directly
|
||||
|
||||
**Testing:**
|
||||
- Unit tests focus on business logic
|
||||
- Integration tests use MSW for API mocking
|
||||
```
|
||||
|
||||
### Option B: Generate After Architecture
|
||||
|
||||
Run the workflow in a fresh chat:
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
The workflow scans your architecture document and project files to generate a context file capturing the decisions made.
|
||||
|
||||
### Option C: Generate for Existing Projects
|
||||
|
||||
For existing projects, run:
|
||||
|
||||
```bash
|
||||
bmad-generate-project-context
|
||||
```
|
||||
|
||||
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
||||
|
||||
## Step 3: Verify Content
|
||||
|
||||
Review the generated file and ensure it captures:
|
||||
|
||||
- Correct technology versions
|
||||
- Your actual conventions (not generic best practices)
|
||||
- Rules that prevent common mistakes
|
||||
- Framework-specific patterns
|
||||
|
||||
Edit manually to add anything missing or remove inaccuracies.
|
||||
|
||||
## What You Get
|
||||
|
||||
A `project-context.md` file that:
|
||||
|
||||
- Ensures all agents follow the same conventions
|
||||
- Prevents inconsistent decisions across stories
|
||||
- Captures architecture decisions for implementation
|
||||
- Serves as a reference for your project's patterns and rules
|
||||
|
||||
## Tips
|
||||
|
||||
:::tip[Best Practices]
|
||||
- **Focus on the unobvious** — Document patterns agents might miss (e.g., "Use JSDoc on every public class"), not universal practices like "use meaningful variable names."
|
||||
- **Keep it lean** — This file is loaded by every implementation workflow. Long files waste context. Exclude content that only applies to narrow scope or specific stories.
|
||||
- **Update as needed** — Edit manually when patterns change, or re-generate after significant architecture changes.
|
||||
- Works for Quick Flow and full BMad Method projects alike.
|
||||
:::
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [**Project Context Explanation**](../explanation/project-context.md) — Learn more about how it works
|
||||
- [**Workflow Map**](../reference/workflow-map.md) — See which workflows load project context
|
||||
|
|
@ -0,0 +1,95 @@
|
|||
---
|
||||
title: "Quick Fixes"
|
||||
description: How to make quick fixes and ad-hoc changes
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
Use **Quick Dev** for bug fixes, refactorings, or small targeted changes that don't require the full BMad Method.
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Bug fixes with a clear, known cause
|
||||
- Small refactorings (rename, extract, restructure) contained within a few files
|
||||
- Minor feature tweaks or configuration changes
|
||||
- Dependency updates
|
||||
|
||||
:::note[Prerequisites]
|
||||
- BMad Method installed (`npx bmad-method install`)
|
||||
- An AI-powered IDE (Claude Code, Cursor, or similar)
|
||||
:::
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Start a Fresh Chat
|
||||
|
||||
Open a **fresh chat session** in your AI IDE. Reusing a session from a previous workflow can cause context conflicts.
|
||||
|
||||
### 2. Give It Your Intent
|
||||
|
||||
Quick Dev accepts free-form intent — before, with, or after the invocation. Examples:
|
||||
|
||||
```text
|
||||
run quick-dev — Fix the login validation bug that allows empty passwords.
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev — fix https://github.com/org/repo/issues/42
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev — implement the intent in _bmad-output/implementation-artifacts/my-intent.md
|
||||
```
|
||||
|
||||
```text
|
||||
I think the problem is in the auth middleware, it's not checking token expiry.
|
||||
Let me look at it... yeah, src/auth/middleware.ts line 47 skips
|
||||
the exp check entirely. run quick-dev
|
||||
```
|
||||
|
||||
```text
|
||||
run quick-dev
|
||||
> What would you like to do?
|
||||
Refactor UserService to use async/await instead of callbacks.
|
||||
```
|
||||
|
||||
Plain text, file paths, GitHub issue URLs, bug tracker links — anything the LLM can resolve to a concrete intent.
|
||||
|
||||
### 3. Answer Questions and Approve
|
||||
|
||||
Quick Dev may ask clarifying questions or present a short spec for your approval before implementing. Answer its questions and approve when you're satisfied with the plan.
|
||||
|
||||
### 4. Review and Push
|
||||
|
||||
Quick Dev implements the change, reviews its own work, patches issues, and commits locally. When it's done, it opens the affected files in your editor.
|
||||
|
||||
- Skim the diff to confirm the change matches your intent
|
||||
- If something looks off, tell the agent what to fix — it can iterate in the same session
|
||||
|
||||
Once satisfied, push the commit. Quick Dev will offer to push and create a PR for you.
|
||||
|
||||
:::caution[If Something Breaks]
|
||||
If a pushed change causes unexpected issues, use `git revert HEAD` to undo the last commit cleanly. Then start a fresh chat and run Quick Dev again to try a different approach.
|
||||
:::
|
||||
|
||||
## What You Get
|
||||
|
||||
- Modified source files with the fix or refactoring applied
|
||||
- Passing tests (if your project has a test suite)
|
||||
- A ready-to-push commit with a conventional commit message
|
||||
|
||||
## Deferred Work
|
||||
|
||||
Quick Dev keeps each run focused on a single goal. If your request contains multiple independent goals, or if the review surfaces pre-existing issues unrelated to your change, Quick Dev defers them to a file (`deferred-work.md` in your implementation artifacts directory) rather than trying to tackle everything at once.
|
||||
|
||||
Check this file after a run — it's your backlog of things to come back to. Each deferred item can be fed into a fresh Quick Dev run later.
|
||||
|
||||
## When to Upgrade to Formal Planning
|
||||
|
||||
Consider using the full BMad Method when:
|
||||
|
||||
- The change affects multiple systems or requires coordinated updates across many files
|
||||
- You are unsure about the scope and need requirements discovery first
|
||||
- You need documentation or architectural decisions recorded for the team
|
||||
|
||||
See [Quick Dev](../explanation/quick-dev.md) for more on how Quick Dev fits into the BMad Method.
|
||||
|
|
@ -1,34 +1,33 @@
|
|||
---
|
||||
title: "Document Sharding Guide"
|
||||
description: Split large markdown files into smaller organized files for better context management
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
|
||||
Use the `bmad-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
||||
|
||||
:::caution[Deprecated]
|
||||
This is no longer recommended, and soon with updated workflows and most major LLMs and tools supporting subprocesses this will be unnecessary.
|
||||
:::
|
||||
|
||||
## When to Use This
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
Only use this if you notice your chosen tool / model combination is failing to load and read all the documents as input when needed.
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
||||
|
||||
- **Selective Loading** - Workflows load only the sections they need
|
||||
- **Reduced Token Usage** - Massive efficiency gains for large projects
|
||||
- **Better Organization** - Logical section-based file structure
|
||||
- **Maintained Context** - Index file preserves document structure
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`).
|
||||
|
||||
### Architecture
|
||||
|
||||
```
|
||||
```text
|
||||
Before Sharding:
|
||||
docs/
|
||||
_bmad-output/planning-artifacts/
|
||||
└── PRD.md (large 50k token file)
|
||||
|
||||
After Sharding:
|
||||
docs/
|
||||
_bmad-output/planning-artifacts/
|
||||
└── prd/
|
||||
├── index.md # Table of contents with descriptions
|
||||
├── overview.md # Section 1
|
||||
|
|
@ -42,12 +41,12 @@ docs/
|
|||
### 1. Run the Shard-Doc Tool
|
||||
|
||||
```bash
|
||||
/bmad:core:tools:shard-doc
|
||||
/bmad-shard-doc
|
||||
```
|
||||
|
||||
### 2. Follow the Interactive Process
|
||||
|
||||
```
|
||||
```text
|
||||
Agent: Which document would you like to shard?
|
||||
User: docs/PRD.md
|
||||
|
||||
|
|
@ -61,28 +60,6 @@ Agent: Sharding PRD.md...
|
|||
✓ Complete!
|
||||
```
|
||||
|
||||
## What You Get
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
```markdown
|
||||
|
||||
## Sections
|
||||
|
||||
1. [Overview](./overview.md) - Project vision and objectives
|
||||
2. [User Requirements](./user-requirements.md) - Feature specifications
|
||||
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
|
||||
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
|
||||
...
|
||||
```
|
||||
|
||||
**Individual section files:**
|
||||
|
||||
- Named from heading text (kebab-case)
|
||||
- Contains complete section content
|
||||
- Preserves all markdown formatting
|
||||
- Can be read independently
|
||||
|
||||
## How Workflow Discovery Works
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
---
|
||||
title: "How to Upgrade to v6"
|
||||
description: Migrate from BMad v4 to v6
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
|
||||
|
|
@ -20,14 +22,7 @@ Use the BMad installer to upgrade from v4 to v6, which includes automatic detect
|
|||
|
||||
### 1. Run the Installer
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
The installer automatically detects:
|
||||
|
||||
- **Legacy v4 folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
|
||||
Follow the [Installer Instructions](./install-bmad.md).
|
||||
|
||||
### 2. Handle Legacy Installation
|
||||
|
||||
|
|
@ -35,20 +30,18 @@ When v4 is detected, you can:
|
|||
|
||||
- Allow the installer to back up and remove `.bmad-method`
|
||||
- Exit and handle cleanup manually
|
||||
- Keep both (not recommended for same project)
|
||||
|
||||
### 3. Clean Up IDE Commands
|
||||
If you named your bmad method folder something else - you will need to manually remove the folder yourself.
|
||||
|
||||
Manually remove legacy v4 IDE commands:
|
||||
### 3. Clean Up IDE Skills
|
||||
|
||||
- `.claude/commands/BMad/agents`
|
||||
- `.claude/commands/BMad/tasks`
|
||||
Manually remove legacy v4 IDE commands/skills - for example if you have Claude Code, look for any nested folders that start with bmad and remove them:
|
||||
|
||||
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
|
||||
- `.claude/commands/`
|
||||
|
||||
:::tip[Accidentally Deleted Commands?]
|
||||
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
|
||||
:::
|
||||
The new v6 skills are installed to:
|
||||
|
||||
- `.claude/skills/`
|
||||
|
||||
### 4. Migrate Planning Artifacts
|
||||
|
||||
|
|
@ -68,64 +61,40 @@ If you have stories created or implemented:
|
|||
|
||||
1. Complete the v6 installation
|
||||
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
|
||||
3. Run the Scrum Master's `sprint-planning` workflow
|
||||
3. Run the Scrum Master's `bmad-sprint-planning` workflow
|
||||
4. Tell the SM which epics/stories are already complete
|
||||
|
||||
### 6. Migrate Agent Customizations
|
||||
|
||||
**v4:** Modified agent files directly in `_bmad-*` folders
|
||||
|
||||
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
```yaml
|
||||
# _bmad/_config/agents/bmm-pm.customize.yaml
|
||||
persona:
|
||||
name: 'Captain Jack'
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors
|
||||
```
|
||||
|
||||
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
|
||||
|
||||
## What You Get
|
||||
|
||||
**v6 unified structure:**
|
||||
|
||||
```
|
||||
```text
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder
|
||||
├── _config/ # Your customizations
|
||||
│ └── agents/ # Agent customization files
|
||||
├── core/ # Universal core framework
|
||||
├── bmm/ # BMad Method module
|
||||
├── bmb/ # BMad Builder
|
||||
└── cis/ # Creative Intelligence Suite
|
||||
├── _bmad-output/ # Output folder (was doc folder in v4)
|
||||
├── _bmad/ # Single installation folder
|
||||
│ ├── _config/ # Your customizations
|
||||
│ │ └── agents/ # Agent customization files
|
||||
│ ├── core/ # Universal core framework
|
||||
│ ├── bmm/ # BMad Method module
|
||||
│ ├── bmb/ # BMad Builder
|
||||
│ └── cis/ # Creative Intelligence Suite
|
||||
└── _bmad-output/ # Output folder (was doc folder in v4)
|
||||
```
|
||||
|
||||
## Module Migration
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
|-----------|-----------|
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
|
||||
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
||||
| ----------------------------- | ----------------------------------------- |
|
||||
| `.bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
|
||||
| `.bmad-2d-unity-game-dev` | Integrated into BMGD Module |
|
||||
| `.bmad-godot-game-dev` | Integrated into BMGD Module |
|
||||
| `.bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
|
||||
| `.bmad-creative-writing` | Not adapted — new v6 module coming soon |
|
||||
|
||||
## Key Changes
|
||||
|
||||
| Concept | v4 | v6 |
|
||||
|---------|----|----|
|
||||
| ------------- | ------------------------------------- | ------------------------------------ |
|
||||
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
|
||||
| **Method** | `_bmad-method` | `_bmad/bmm/` |
|
||||
| **Config** | Modified files directly | `config.yaml` per module |
|
||||
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
|
||||
|
||||
## Tips
|
||||
|
||||
- **Back up first** — Keep your v4 installation until you verify v6 works
|
||||
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
|
||||
- **Rebuild after customizing** — Always run the installer after changing customize files
|
||||
|
|
|
|||
|
|
@ -1,19 +1,26 @@
|
|||
---
|
||||
title: Welcome to the BMad Method
|
||||
description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning
|
||||
---
|
||||
|
||||
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform.
|
||||
The BMad Method (**B**uild **M**ore **A**rchitect **D**reams) is an AI-driven development framework module within the BMad Method Ecosystem that helps you build software through the whole process from ideation and planning all the way through agentic implementation. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity, whether you're fixing a bug or building an enterprise platform.
|
||||
|
||||
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
|
||||
|
||||
---
|
||||
:::note[🚀 V6 is Here and We're Just Getting Started!]
|
||||
Skills Architecture, BMad Builder v1, Dev Loop Automation, and so much more in the works. **[Check out the Roadmap →](/roadmap/)**
|
||||
:::
|
||||
|
||||
## New Here? Start with a Tutorial
|
||||
|
||||
The fastest way to understand BMad is to try it.
|
||||
|
||||
- **[Get Started with BMad](/docs/tutorials/getting-started.md)** — Install and understand how BMad works
|
||||
- **[Workflow Map](/docs/reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management.
|
||||
- **[Get Started with BMad](./tutorials/getting-started.md)** — Install and understand how BMad works
|
||||
- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
|
||||
|
||||
:::tip[Just Want to Dive In?]
|
||||
Install BMad and use the `bmad-help` skill — it will guide you through everything based on your project and installed modules.
|
||||
:::
|
||||
|
||||
## How to Use These Docs
|
||||
|
||||
|
|
@ -26,7 +33,9 @@ These docs are organized into four sections based on what you're trying to do:
|
|||
| **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. |
|
||||
| **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. |
|
||||
|
||||
---
|
||||
## Extend and Customize
|
||||
|
||||
Want to expand BMad with your own agents, workflows, or modules? The **[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** provides the framework and tools for creating custom extensions, whether you're adding new capabilities to BMad or building entirely new modules from scratch.
|
||||
|
||||
## What You'll Need
|
||||
|
||||
|
|
@ -34,13 +43,10 @@ BMad works with any AI coding assistant that supports custom system prompts or p
|
|||
|
||||
- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
|
||||
- **[Cursor](https://cursor.sh)** — AI-first code editor
|
||||
- **[Windsurf](https://codeium.com/windsurf)** — Codeium's AI IDE
|
||||
- **[Roo Code](https://roocode.com)** — VS Code extension
|
||||
- **[Codex CLI](https://github.com/openai/codex)** — OpenAI's terminal coding agent
|
||||
|
||||
You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
|
||||
|
||||
---
|
||||
|
||||
## Join the Community
|
||||
|
||||
Get help, share what you're building, or contribute to BMad:
|
||||
|
|
@ -49,8 +55,6 @@ Get help, share what you're building, or contribute to BMad:
|
|||
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Source code, issues, and contributions
|
||||
- **[YouTube](https://www.youtube.com/@BMadCode)** — Video tutorials and walkthroughs
|
||||
|
||||
---
|
||||
|
||||
## Next Step
|
||||
|
||||
Ready to dive in? **[Get Started with BMad](/docs/tutorials/getting-started.md)** and build your first project.
|
||||
Ready to dive in? **[Get Started with BMad](./tutorials/getting-started.md)** and build your first project.
|
||||
|
|
|
|||
|
|
@ -1,22 +1,58 @@
|
|||
---
|
||||
title: Agents
|
||||
description: Default BMM agents with their skill IDs, menu triggers, and primary workflows
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
This page lists the default BMM (Agile suite) agents that install with BMAD Method, along with their menu triggers and primary workflows.
|
||||
## Default Agents
|
||||
|
||||
Notes:
|
||||
This page lists the default BMM (Agile suite) agents that install with BMad Method, along with their skill IDs, menu triggers, and primary workflows. Each agent is invoked as a skill.
|
||||
|
||||
## Notes
|
||||
|
||||
- Each agent is available as a skill, generated by the installer. The skill ID (e.g., `bmad-dev`) is used to invoke the agent.
|
||||
- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu.
|
||||
- Slash commands are generated separately. See `docs/reference/commands.md` for the slash command list and where they are defined.
|
||||
- QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.
|
||||
|
||||
| Agent | Triggers | Primary workflows |
|
||||
| --------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
||||
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
||||
| Architect (Winston) | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
||||
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
||||
| Developer (Amelia) | `DS`, `CR` | Dev Story, Code Review |
|
||||
| QA Engineer (Quinn) | `QA` | Automate (generate tests for existing features) |
|
||||
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
||||
| UX Designer (Sally) | `CU` | Create UX Design |
|
||||
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
||||
| Agent | Skill ID | Triggers | Primary workflows |
|
||||
| --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
||||
| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
||||
| Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
||||
| Scrum Master (Bob) | `bmad-sm` | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
||||
| Developer (Amelia) | `bmad-dev` | `DS`, `CR` | Dev Story, Code Review |
|
||||
| QA Engineer (Quinn) | `bmad-qa` | `QA` | Automate (generate tests for existing features) |
|
||||
| Quick Flow Solo Dev (Barry) | `bmad-master` | `QD`, `CR` | Quick Dev, Code Review |
|
||||
| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Create UX Design |
|
||||
| Technical Writer (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
||||
|
||||
## Trigger Types
|
||||
|
||||
Agent menu triggers use two different invocation types. Knowing which type a trigger uses helps you provide the right input.
|
||||
|
||||
### Workflow triggers (no arguments needed)
|
||||
|
||||
Most triggers load a structured workflow file. Type the trigger code and the agent starts the workflow, prompting you for input at each step.
|
||||
|
||||
Examples: `CP` (Create PRD), `DS` (Dev Story), `CA` (Create Architecture), `QD` (Quick Dev)
|
||||
|
||||
### Conversational triggers (arguments required)
|
||||
|
||||
Some triggers start a free-form conversation instead of a structured workflow. These expect you to describe what you need alongside the trigger code.
|
||||
|
||||
| Agent | Trigger | What to provide |
|
||||
| --- | --- | --- |
|
||||
| Technical Writer (Paige) | `WD` | Description of the document to write |
|
||||
| Technical Writer (Paige) | `US` | Preferences or conventions to add to standards |
|
||||
| Technical Writer (Paige) | `MG` | Diagram description and type (sequence, flowchart, etc.) |
|
||||
| Technical Writer (Paige) | `VD` | Document to validate and focus areas |
|
||||
| Technical Writer (Paige) | `EC` | Concept name to explain |
|
||||
|
||||
**Example:**
|
||||
|
||||
```text
|
||||
WD Write a deployment guide for our Docker setup
|
||||
MG Create a sequence diagram showing the auth flow
|
||||
EC Explain how the module system works
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,34 +1,134 @@
|
|||
---
|
||||
title: Commands
|
||||
description: How BMAD commands are generated and where to find them.
|
||||
title: Skills
|
||||
description: Reference for BMad skills — what they are, how they work, and where to find them.
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
# Commands
|
||||
Skills are pre-built prompts that load agents, run workflows, or execute tasks inside your IDE. The BMad installer generates them from your installed modules at install time. If you later add, remove, or change modules, re-run the installer to keep skills in sync (see [Troubleshooting](#troubleshooting)).
|
||||
|
||||
BMAD slash commands are generated by the installer for your IDE and **reflect the modules you have installed**.
|
||||
That means the authoritative list lives **in your project**, not in a static docs page.
|
||||
## Skills vs. Agent Menu Triggers
|
||||
|
||||
## How to Discover Commands (Recommended)
|
||||
BMad offers two ways to start work, and they serve different purposes.
|
||||
|
||||
- Type `/bmad` in your IDE and use autocomplete to browse agents/workflows.
|
||||
- Run `/bmad-help` to get guided next steps and context-aware recommendations.
|
||||
| Mechanism | How you invoke it | What happens |
|
||||
| --- | --- | --- |
|
||||
| **Skill** | Type the skill name (e.g. `bmad-help`) in your IDE | Directly loads an agent, runs a workflow, or executes a task |
|
||||
| **Agent menu trigger** | Load an agent first, then type a short code (e.g. `DS`) | The agent interprets the code and starts the matching workflow while staying in character |
|
||||
|
||||
## Where Commands Are Generated
|
||||
Agent menu triggers require an active agent session. Use skills when you know which workflow you want. Use triggers when you are already working with an agent and want to switch tasks without leaving the conversation.
|
||||
|
||||
The installer writes command files into your project (example paths for Claude Code):
|
||||
## How Skills Are Generated
|
||||
|
||||
- `.claude/commands/bmad/<module>/agents/`
|
||||
- `.claude/commands/bmad/<module>/workflows/`
|
||||
When you run `npx bmad-method install`, the installer reads the manifests for every selected module and writes one skill per agent, workflow, task, and tool. Each skill is a directory containing a `SKILL.md` file that instructs the AI to load the corresponding source file and follow its instructions.
|
||||
|
||||
These folders are the **canonical, project-specific command list**.
|
||||
The installer uses templates for each skill type:
|
||||
|
||||
## Common Commands
|
||||
| Skill type | What the generated file does |
|
||||
| --- | --- |
|
||||
| **Agent launcher** | Loads the agent persona file, activates its menu, and stays in character |
|
||||
| **Workflow skill** | Loads the workflow config and follows its steps |
|
||||
| **Task skill** | Loads a standalone task file and follows its instructions |
|
||||
| **Tool skill** | Loads a standalone tool file and follows its instructions |
|
||||
|
||||
- `/bmad-help` - Interactive help and next-step guidance
|
||||
- `/bmad:<module>:agents:<agent>` - Load an agent (e.g. `/bmad:bmm:agents:dev`)
|
||||
- `/bmad:<module>:workflows:<workflow>` - Run a workflow (e.g. `/bmad:bmm:workflows:create-prd`)
|
||||
:::note[Re-running the installer]
|
||||
If you add or remove modules, run the installer again. It regenerates all skill files to match your current module selection.
|
||||
:::
|
||||
|
||||
## Why This Page Is Short
|
||||
## Where Skill Files Live
|
||||
|
||||
BMAD is modular, so the exact commands vary by install.
|
||||
Use your IDE's autocomplete or the generated command folders above to see *everything* available.
|
||||
The installer writes skill files into an IDE-specific directory inside your project. The exact path depends on which IDE you selected during installation.
|
||||
|
||||
| IDE / CLI | Skills directory |
|
||||
| --- | --- |
|
||||
| Claude Code | `.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` |
|
||||
| Other IDEs | See the installer output for the target path |
|
||||
|
||||
Each skill is a directory containing a `SKILL.md` file. For example, a Claude Code installation looks like:
|
||||
|
||||
```text
|
||||
.claude/skills/
|
||||
├── bmad-help/
|
||||
│ └── SKILL.md
|
||||
├── bmad-create-prd/
|
||||
│ └── SKILL.md
|
||||
├── bmad-dev/
|
||||
│ └── SKILL.md
|
||||
└── ...
|
||||
```
|
||||
|
||||
The directory name determines the skill name in your IDE. For example, the directory `bmad-dev/` registers the skill `bmad-dev`.
|
||||
|
||||
## How to Discover Your Skills
|
||||
|
||||
Type the skill name in your IDE to invoke it. Some platforms require you to enable skills in settings before they appear.
|
||||
|
||||
Run `bmad-help` for context-aware guidance on your next step.
|
||||
|
||||
:::tip[Quick discovery]
|
||||
The generated skill directories in your project are the canonical list. Open them in your file explorer to see every skill with its description.
|
||||
:::
|
||||
|
||||
## Skill Categories
|
||||
|
||||
### Agent Skills
|
||||
|
||||
Agent skills load a specialized AI persona with a defined role, communication style, and menu of workflows. Once loaded, the agent stays in character and responds to menu triggers.
|
||||
|
||||
| Example skill | Agent | Role |
|
||||
| --- | --- | --- |
|
||||
| `bmad-dev` | Amelia (Developer) | Implements stories with strict adherence to specs |
|
||||
| `bmad-pm` | John (Product Manager) | Creates and validates PRDs |
|
||||
| `bmad-architect` | Winston (Architect) | Designs system architecture |
|
||||
| `bmad-sm` | Bob (Scrum Master) | Manages sprints and stories |
|
||||
|
||||
See [Agents](./agents.md) for the full list of default agents and their triggers.
|
||||
|
||||
### Workflow Skills
|
||||
|
||||
Workflow skills run a structured, multi-step process without loading an agent persona first. They load a workflow configuration and follow its steps.
|
||||
|
||||
| Example skill | Purpose |
|
||||
| --- | --- |
|
||||
| `bmad-create-prd` | Create a Product Requirements Document |
|
||||
| `bmad-create-architecture` | Design system architecture |
|
||||
| `bmad-create-epics-and-stories` | Create epics and stories |
|
||||
| `bmad-dev-story` | Implement a story |
|
||||
| `bmad-code-review` | Run a code review |
|
||||
| `bmad-quick-dev` | Unified quick flow — clarify intent, plan, implement, review, present |
|
||||
|
||||
See [Workflow Map](./workflow-map.md) for the complete workflow reference organized by phase.
|
||||
|
||||
### Task and Tool Skills
|
||||
|
||||
Tasks and tools are standalone operations that do not require an agent or workflow context.
|
||||
|
||||
**BMad-Help: Your Intelligent Guide**
|
||||
|
||||
`bmad-help` is your primary interface for discovering what to do next. It inspects your project, understands natural language queries, and recommends the next required or optional step based on your installed modules.
|
||||
|
||||
:::note[Example]
|
||||
```
|
||||
bmad-help
|
||||
bmad-help I have a SaaS idea and know all the features. Where do I start?
|
||||
bmad-help What are my options for UX design?
|
||||
```
|
||||
:::
|
||||
|
||||
**Other Core Tasks and Tools**
|
||||
|
||||
The core module includes 11 built-in tools — reviews, compression, brainstorming, document management, and more. See [Core Tools](./core-tools.md) for the complete reference.
|
||||
|
||||
## Naming Convention
|
||||
|
||||
All skills use the `bmad-` prefix followed by a descriptive name (e.g., `bmad-dev`, `bmad-create-prd`, `bmad-help`). See [Modules](./modules.md) for available modules.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Skills not appearing after install.** Some platforms require skills to be explicitly enabled in settings. Check your IDE's documentation or ask your AI assistant how to enable skills. You may also need to restart your IDE or reload the window.
|
||||
|
||||
**Expected skills are missing.** The installer only generates skills for modules you selected. Run `npx bmad-method install` again and verify your module selection. Check that the skill files exist in the expected directory.
|
||||
|
||||
**Skills from a removed module still appear.** The installer does not delete old skill files automatically. Remove the stale directories from your IDE's skills directory, or delete the entire skills directory and re-run the installer for a clean set.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,293 @@
|
|||
---
|
||||
title: Core Tools
|
||||
description: Reference for all built-in tasks and workflows available in every BMad installation without additional modules.
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
Every BMad installation includes a set of core skills that can be used in conjunction with any anything you are doing — standalone tasks and workflows that work across all projects, all modules, and all phases. These are always available regardless of which optional modules you install.
|
||||
|
||||
:::tip[Quick Path]
|
||||
Run any core tool by typing its skill name (e.g., `bmad-help`) in your IDE. No agent session required.
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
||||
| Tool | Type | Purpose |
|
||||
| --- | --- | --- |
|
||||
| [`bmad-help`](#bmad-help) | Task | Get context-aware guidance on what to do next |
|
||||
| [`bmad-brainstorming`](#bmad-brainstorming) | Workflow | Facilitate interactive brainstorming sessions |
|
||||
| [`bmad-party-mode`](#bmad-party-mode) | Workflow | Orchestrate multi-agent group discussions |
|
||||
| [`bmad-distillator`](#bmad-distillator) | Task | Lossless LLM-optimized compression of documents |
|
||||
| [`bmad-advanced-elicitation`](#bmad-advanced-elicitation) | Task | Push LLM output through iterative refinement methods |
|
||||
| [`bmad-review-adversarial-general`](#bmad-review-adversarial-general) | Task | Cynical review that finds what's missing and what's wrong |
|
||||
| [`bmad-review-edge-case-hunter`](#bmad-review-edge-case-hunter) | Task | Exhaustive branching-path analysis for unhandled edge cases |
|
||||
| [`bmad-editorial-review-prose`](#bmad-editorial-review-prose) | Task | Clinical copy-editing for communication clarity |
|
||||
| [`bmad-editorial-review-structure`](#bmad-editorial-review-structure) | Task | Structural editing — cuts, merges, and reorganization |
|
||||
| [`bmad-shard-doc`](#bmad-shard-doc) | Task | Split large markdown files into organized sections |
|
||||
| [`bmad-index-docs`](#bmad-index-docs) | Task | Generate or update an index of all docs in a folder |
|
||||
|
||||
## bmad-help
|
||||
|
||||
**Your intelligent guide to what comes next.** — Inspects your project state, detects what's been done, and recommends the next required or optional step.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You finished a workflow and want to know what's next
|
||||
- You're new to BMad and need orientation
|
||||
- You're stuck and want context-aware advice
|
||||
- You installed new modules and want to see what's available
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Scans your project for existing artifacts (PRD, architecture, stories, etc.)
|
||||
2. Detects which modules are installed and their available workflows
|
||||
3. Recommends next steps in priority order — required steps first, then optional
|
||||
4. Presents each recommendation with the skill command and a brief description
|
||||
|
||||
**Input:** Optional query in natural language (e.g., `bmad-help I have a SaaS idea, where do I start?`)
|
||||
|
||||
**Output:** Prioritized list of recommended next steps with skill commands
|
||||
|
||||
## bmad-brainstorming
|
||||
|
||||
**Generate diverse ideas through interactive creative techniques.** — A facilitated brainstorming session that loads proven ideation methods from a technique library and guides you toward 100+ ideas before organizing.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You're starting a new project and need to explore the problem space
|
||||
- You're stuck generating ideas and need structured creativity
|
||||
- You want to use proven ideation frameworks (SCAMPER, reverse brainstorming, etc.)
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Sets up a brainstorming session with your topic
|
||||
2. Loads creative techniques from a method library
|
||||
3. Guides you through technique after technique, generating ideas
|
||||
4. Applies anti-bias protocol — shifts creative domain every 10 ideas to prevent clustering
|
||||
5. Produces an append-only session document with all ideas organized by technique
|
||||
|
||||
**Input:** Brainstorming topic or problem statement, optional context file
|
||||
|
||||
**Output:** `brainstorming-session-{date}.md` with all generated ideas
|
||||
|
||||
:::note[Quantity Target]
|
||||
The magic happens in ideas 50–100. The workflow encourages generating 100+ ideas before organization.
|
||||
:::
|
||||
|
||||
## bmad-party-mode
|
||||
|
||||
**Orchestrate multi-agent group discussions.** — Loads all installed BMad agents and facilitates a natural conversation where each agent contributes from their unique expertise and personality.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You need multiple expert perspectives on a decision
|
||||
- You want agents to challenge each other's assumptions
|
||||
- You're exploring a complex topic that spans multiple domains
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Loads the agent manifest with all installed agent personalities
|
||||
2. Analyzes your topic to select 2–3 most relevant agents
|
||||
3. Agents take turns contributing, with natural cross-talk and disagreements
|
||||
4. Rotates agent participation to ensure diverse perspectives over time
|
||||
5. Exit with `goodbye`, `end party`, or `quit`
|
||||
|
||||
**Input:** Discussion topic or question, along with specification of personas you would like to participate (optional)
|
||||
|
||||
**Output:** Real-time multi-agent conversation with maintained agent personalities
|
||||
|
||||
## bmad-distillator
|
||||
|
||||
**Lossless LLM-optimized compression of source documents.** — Produces dense, token-efficient distillates that preserve all information for downstream LLM consumption. Verifiable through round-trip reconstruction.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- A document is too large for an LLM's context window
|
||||
- You need token-efficient versions of research, specs, or planning artifacts
|
||||
- You want to verify no information is lost during compression
|
||||
- Agents will need to frequently reference and find information in it
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. **Analyze** — Reads source documents, identifies information density and structure
|
||||
2. **Compress** — Converts prose to dense bullet-point format, strips decorative formatting
|
||||
3. **Verify** — Checks completeness to ensure all original information is preserved
|
||||
4. **Validate** (optional) — Round-trip reconstruction test proves lossless compression
|
||||
|
||||
**Input:**
|
||||
|
||||
- `source_documents` (required) — File paths, folder paths, or glob patterns
|
||||
- `downstream_consumer` (optional) — What consumes this (e.g., "PRD creation")
|
||||
- `token_budget` (optional) — Approximate target size
|
||||
- `--validate` (flag) — Run round-trip reconstruction test
|
||||
|
||||
**Output:** Distillate markdown file(s) with compression ratio report (e.g., "3.2:1")
|
||||
|
||||
## bmad-advanced-elicitation
|
||||
|
||||
**Push LLM output through iterative refinement methods.** — Selects from a library of elicitation techniques to systematically improve content through multiple passes.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- LLM output feels shallow or generic
|
||||
- You want to explore a topic from multiple analytical angles
|
||||
- You're refining a critical document and want deeper thinking
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Loads method registry with 5+ elicitation techniques
|
||||
2. Selects 5 best-fit methods based on content type and complexity
|
||||
3. Presents an interactive menu — pick a method, reshuffle, or list all
|
||||
4. Applies the selected method to enhance the content
|
||||
5. Re-presents options for iterative improvement until you select "Proceed"
|
||||
|
||||
**Input:** Content section to enhance
|
||||
|
||||
**Output:** Enhanced version of the content with improvements applied
|
||||
|
||||
## bmad-review-adversarial-general
|
||||
|
||||
**Cynical review that assumes problems exist and searches for them.** — Takes a skeptical, jaded reviewer perspective with zero patience for sloppy work. Looks for what's missing, not just what's wrong.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You need quality assurance before finalizing a deliverable
|
||||
- You want to stress-test a spec, story, or document
|
||||
- You want to find gaps in coverage that optimistic reviews miss
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Reads the content with a cynical, critical perspective
|
||||
2. Identifies issues across completeness, correctness, and quality
|
||||
3. Searches specifically for what's missing — not just what's present and wrong
|
||||
4. Must find a minimum of 10 issues or re-analyzes deeper
|
||||
|
||||
**Input:**
|
||||
|
||||
- `content` (required) — Diff, spec, story, doc, or any artifact
|
||||
- `also_consider` (optional) — Additional areas to keep in mind
|
||||
|
||||
**Output:** Markdown list of 10+ findings with descriptions
|
||||
|
||||
## bmad-review-edge-case-hunter
|
||||
|
||||
**Walk every branching path and boundary condition, report only unhandled cases.** — Pure path-tracing methodology that mechanically derives edge classes. Orthogonal to adversarial review — method-driven, not attitude-driven.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You want exhaustive edge case coverage for code or logic
|
||||
- You need a complement to adversarial review (different methodology, different findings)
|
||||
- You're reviewing a diff or function for boundary conditions
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Enumerates all branching paths in the content
|
||||
2. Derives edge classes mechanically: missing else/default, unguarded inputs, off-by-one, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
3. Tests each path against existing guards
|
||||
4. Reports only unhandled paths — silently discards handled ones
|
||||
|
||||
**Input:**
|
||||
|
||||
- `content` (required) — Diff, full file, or function
|
||||
- `also_consider` (optional) — Additional areas to keep in mind
|
||||
|
||||
**Output:** JSON array of findings, each with `location`, `trigger_condition`, `guard_snippet`, and `potential_consequence`
|
||||
|
||||
:::note[Complementary Reviews]
|
||||
Run both `bmad-review-adversarial-general` and `bmad-review-edge-case-hunter` together for orthogonal coverage. The adversarial review catches quality and completeness issues; the edge case hunter catches unhandled paths.
|
||||
:::
|
||||
|
||||
## bmad-editorial-review-prose
|
||||
|
||||
**Clinical copy-editing focused on communication clarity.** — Reviews text for issues that impede comprehension. Applies Microsoft Writing Style Guide baseline. Preserves author voice.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You've drafted a document and want to polish the writing
|
||||
- You need to ensure clarity for a specific audience
|
||||
- You want communication fixes without style opinion changes
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Reads the content, skipping code blocks and frontmatter
|
||||
2. Identifies communication issues (not style preferences)
|
||||
3. Deduplicates same issues across multiple locations
|
||||
4. Produces a three-column fix table
|
||||
|
||||
**Input:**
|
||||
|
||||
- `content` (required) — Markdown, plain text, or XML
|
||||
- `style_guide` (optional) — Project-specific style guide
|
||||
- `reader_type` (optional) — `humans` (default) for clarity/flow, or `llm` for precision/consistency
|
||||
|
||||
**Output:** Three-column markdown table: Original Text | Revised Text | Changes
|
||||
|
||||
## bmad-editorial-review-structure
|
||||
|
||||
**Structural editing — proposes cuts, merges, moves, and condensing.** — Reviews document organization and proposes substantive changes to improve clarity and flow before copy editing.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- A document was produced from multiple subprocesses and needs structural coherence
|
||||
- You want to reduce document length while preserving comprehension
|
||||
- You need to identify scope violations or buried critical information
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Analyzes document against 5 structure models (Tutorial, Reference, Explanation, Prompt, Strategic)
|
||||
2. Identifies redundancies, scope violations, and buried information
|
||||
3. Produces prioritized recommendations: CUT, MERGE, MOVE, CONDENSE, QUESTION, PRESERVE
|
||||
4. Estimates total reduction in words and percentage
|
||||
|
||||
**Input:**
|
||||
|
||||
- `content` (required) — Document to review
|
||||
- `purpose` (optional) — Intended purpose (e.g., "quickstart tutorial")
|
||||
- `target_audience` (optional) — Who reads this
|
||||
- `reader_type` (optional) — `humans` or `llm`
|
||||
- `length_target` (optional) — Target reduction (e.g., "30% shorter")
|
||||
|
||||
**Output:** Document summary, prioritized recommendation list, and estimated reduction
|
||||
|
||||
## bmad-shard-doc
|
||||
|
||||
**Split large markdown files into organized section files.** — Uses level-2 headers as split points to create a folder of self-contained section files with an index.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- A markdown document has grown too large to manage effectively (500+ lines)
|
||||
- You want to break a monolithic doc into navigable sections
|
||||
- You need separate files for parallel editing or LLM context management
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Validates the source file exists and is markdown
|
||||
2. Splits on level-2 (`##`) headers into numbered section files
|
||||
3. Creates an `index.md` with section manifest and links
|
||||
4. Prompts you to delete, archive, or keep the original
|
||||
|
||||
**Input:** Source markdown file path, optional destination folder
|
||||
|
||||
**Output:** Folder with `index.md` and `01-{section}.md`, `02-{section}.md`, etc.
|
||||
|
||||
## bmad-index-docs
|
||||
|
||||
**Generate or update an index of all documents in a folder.** — Scans a directory, reads each file to understand its purpose, and produces an organized `index.md` with links and descriptions.
|
||||
|
||||
**Use it when:**
|
||||
|
||||
- You need a lightweight index for quick LLM scanning of available docs
|
||||
- A documentation folder has grown and needs an organized table of contents
|
||||
- You want an auto-generated overview that stays current
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Scans the target directory for all non-hidden files
|
||||
2. Reads each file to understand its actual purpose
|
||||
3. Groups files by type, purpose, or subdirectory
|
||||
4. Generates concise descriptions (3–10 words each)
|
||||
|
||||
**Input:** Target folder path
|
||||
|
||||
**Output:** `index.md` with organized file listings, relative links, and brief descriptions
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
---
|
||||
title: Official Modules
|
||||
description: Add-on modules for building custom agents, creative intelligence, game development, and testing
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
BMad extends through official modules that you select during installation. These add-on modules provide specialized agents, workflows, and tasks for specific domains beyond the built-in core and BMM (Agile suite).
|
||||
|
||||
:::tip[Installing Modules]
|
||||
Run `npx bmad-method install` and select the modules you want. The installer handles downloading, configuration, and IDE integration automatically.
|
||||
:::
|
||||
|
||||
## BMad Builder
|
||||
|
||||
Create custom agents, workflows, and domain-specific modules with guided assistance. BMad Builder is the meta-module for extending the framework itself.
|
||||
|
||||
- **Code:** `bmb`
|
||||
- **npm:** [`bmad-builder`](https://www.npmjs.com/package/bmad-builder)
|
||||
- **GitHub:** [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Agent Builder -- create specialized AI agents with custom expertise and tool access
|
||||
- Workflow Builder -- design structured processes with steps and decision points
|
||||
- Module Builder -- package agents and workflows into shareable, publishable modules
|
||||
- Interactive setup with YAML configuration and npm publishing support
|
||||
|
||||
## Creative Intelligence Suite
|
||||
|
||||
AI-powered tools for structured creativity, ideation, and innovation during early-stage development. The suite provides multiple agents that facilitate brainstorming, design thinking, and problem-solving using proven frameworks.
|
||||
|
||||
- **Code:** `cis`
|
||||
- **npm:** [`bmad-creative-intelligence-suite`](https://www.npmjs.com/package/bmad-creative-intelligence-suite)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Innovation Strategist, Design Thinking Coach, and Brainstorming Coach agents
|
||||
- Problem Solver and Creative Problem Solver for systematic and lateral thinking
|
||||
- Storyteller and Presentation Master for narratives and pitches
|
||||
- Ideation frameworks including SCAMPER, Reverse Brainstorming, and problem reframing
|
||||
|
||||
## Game Dev Studio
|
||||
|
||||
Structured game development workflows adapted for Unity, Unreal, Godot, and custom engines. Supports rapid prototyping through Quick Flow and full-scale production with epic-driven sprints.
|
||||
|
||||
- **Code:** `gds`
|
||||
- **npm:** [`bmad-game-dev-studio`](https://www.npmjs.com/package/bmad-game-dev-studio)
|
||||
- **GitHub:** [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Game Design Document (GDD) generation workflow
|
||||
- Quick Dev mode for rapid prototyping
|
||||
- Narrative design support for characters, dialogue, and world-building
|
||||
- Coverage for 21+ game types with engine-specific architecture guidance
|
||||
|
||||
## Test Architect (TEA)
|
||||
|
||||
Enterprise-grade test strategy, automation guidance, and release gate decisions through an expert agent and nine structured workflows. TEA goes well beyond the built-in QA agent with risk-based prioritization and requirements traceability.
|
||||
|
||||
- **Code:** `tea`
|
||||
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
- **GitHub:** [bmad-code-org/bmad-method-test-architecture-enterprise](https://github.com/bmad-code-org/bmad-method-test-architecture-enterprise)
|
||||
|
||||
**Provides:**
|
||||
|
||||
- Murat agent (Master Test Architect and Quality Advisor)
|
||||
- Workflows for test design, ATDD, automation, test review, and traceability
|
||||
- NFR assessment, CI setup, and framework scaffolding
|
||||
- P0-P3 prioritization with optional Playwright Utils and MCP integrations
|
||||
|
||||
## Community Modules
|
||||
|
||||
Community modules and a module marketplace are coming. Check the [BMad GitHub organization](https://github.com/bmad-code-org) for updates.
|
||||
|
|
@ -1,21 +1,106 @@
|
|||
---
|
||||
title: Testing Options
|
||||
description: Comparing the built-in QA agent (Quinn) with the Test Architect (TEA) module for test automation.
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
# Testing Options
|
||||
BMad provides two testing paths: a built-in QA agent for fast test generation and an installable Test Architect module for enterprise-grade test strategy.
|
||||
|
||||
BMad provides a built-in QA agent for quick test automation and a separate Test Architect (TEA) module for advanced testing.
|
||||
## Which Should You Use?
|
||||
|
||||
## Built-in QA (Quinn)
|
||||
| Factor | Quinn (Built-in QA) | TEA Module |
|
||||
| --- | --- | --- |
|
||||
| **Best for** | Small-medium projects, quick coverage | Large projects, regulated or complex domains |
|
||||
| **Setup** | Nothing to install -- included in BMM | Install separately via `npx bmad-method install` |
|
||||
| **Approach** | Generate tests fast, iterate later | Plan first, then generate with traceability |
|
||||
| **Test types** | API and E2E tests | API, E2E, ATDD, NFR, and more |
|
||||
| **Strategy** | Happy path + critical edge cases | Risk-based prioritization (P0-P3) |
|
||||
| **Workflow count** | 1 (Automate) | 9 (design, ATDD, automate, review, trace, and others) |
|
||||
|
||||
Use the built-in QA agent for fast, straightforward test coverage:
|
||||
:::tip[Start with Quinn]
|
||||
Most projects should start with Quinn. If you later need test strategy, quality gates, or requirements traceability, install TEA alongside it.
|
||||
:::
|
||||
|
||||
- Trigger: `QA` or `bmad-bmm-qa-automate`
|
||||
- Best for: small projects, quick coverage, standard patterns
|
||||
## Built-in QA Agent (Quinn)
|
||||
|
||||
Quinn is the built-in QA agent in the BMM (Agile suite) module. It generates working tests quickly using your project's existing test framework -- no configuration or additional installation required.
|
||||
|
||||
**Trigger:** `QA` or `bmad-qa-generate-e2e-tests`
|
||||
|
||||
### What Quinn Does
|
||||
|
||||
Quinn runs a single workflow (Automate) that walks through five steps:
|
||||
|
||||
1. **Detect test framework** -- scans `package.json` and existing test files for your framework (Jest, Vitest, Playwright, Cypress, or any standard runner). If none exists, analyzes the project stack and suggests one.
|
||||
2. **Identify features** -- asks what to test or auto-discovers features in the codebase.
|
||||
3. **Generate API tests** -- covers status codes, response structure, happy path, and 1-2 error cases.
|
||||
4. **Generate E2E tests** -- covers user workflows with semantic locators and visible-outcome assertions.
|
||||
5. **Run and verify** -- executes the generated tests and fixes failures immediately.
|
||||
|
||||
Quinn produces a test summary saved to your project's implementation artifacts folder.
|
||||
|
||||
### Test Patterns
|
||||
|
||||
Generated tests follow a "simple and maintainable" philosophy:
|
||||
|
||||
- **Standard framework APIs only** -- no external utilities or custom abstractions
|
||||
- **Semantic locators** for UI tests (roles, labels, text rather than CSS selectors)
|
||||
- **Independent tests** with no order dependencies
|
||||
- **No hardcoded waits or sleeps**
|
||||
- **Clear descriptions** that read as feature documentation
|
||||
|
||||
:::note[Scope]
|
||||
Quinn generates tests only. For code review and story validation, use the Code Review workflow (`CR`) instead.
|
||||
:::
|
||||
|
||||
### When to Use Quinn
|
||||
|
||||
- Quick test coverage for a new or existing feature
|
||||
- Beginner-friendly test automation without advanced setup
|
||||
- Standard test patterns that any developer can read and maintain
|
||||
- Small-medium projects where comprehensive test strategy is unnecessary
|
||||
|
||||
## Test Architect (TEA) Module
|
||||
|
||||
TEA is a standalone module with advanced testing workflows (test design, ATDD, automate, review, trace, NFR assessment).
|
||||
TEA is a standalone module that provides an expert agent (Murat) and nine structured workflows for enterprise-grade testing. It goes beyond test generation into test strategy, risk-based planning, quality gates, and requirements traceability.
|
||||
|
||||
- Documentation: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
||||
- Install: `npx bmad-method@alpha install` and select the TEA module
|
||||
- **Documentation:** [TEA Module Docs](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
||||
- **Install:** `npx bmad-method install` and select the TEA module
|
||||
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
||||
|
||||
### What TEA Provides
|
||||
|
||||
| Workflow | Purpose |
|
||||
| --- | --- |
|
||||
| Test Design | Create a comprehensive test strategy tied to requirements |
|
||||
| ATDD | Acceptance-test-driven development with stakeholder criteria |
|
||||
| Automate | Generate tests with advanced patterns and utilities |
|
||||
| Test Review | Validate test quality and coverage against strategy |
|
||||
| Traceability | Map tests back to requirements for audit and compliance |
|
||||
| NFR Assessment | Evaluate non-functional requirements (performance, security) |
|
||||
| CI Setup | Configure test execution in continuous integration pipelines |
|
||||
| Framework Scaffolding | Set up test infrastructure and project structure |
|
||||
| Release Gate | Make data-driven go/no-go release decisions |
|
||||
|
||||
TEA also supports P0-P3 risk-based prioritization and optional integrations with Playwright Utils and MCP tooling.
|
||||
|
||||
### When to Use TEA
|
||||
|
||||
- Projects that require requirements traceability or compliance documentation
|
||||
- Teams that need risk-based test prioritization across many features
|
||||
- Enterprise environments with formal quality gates before release
|
||||
- Complex domains where test strategy must be planned before tests are written
|
||||
- Projects that have outgrown Quinn's single-workflow approach
|
||||
|
||||
## How Testing Fits into Workflows
|
||||
|
||||
Quinn's Automate workflow appears in Phase 4 (Implementation) of the BMad Method workflow map. It is designed to run **after a full epic is complete** — once all stories in an epic have been implemented and code-reviewed. A typical sequence:
|
||||
|
||||
1. For each story in the epic: implement with Dev (`DS`), then validate with Code Review (`CR`)
|
||||
2. After the epic is complete: generate tests with Quinn (`QA`) or TEA's Automate workflow
|
||||
3. Run retrospective (`bmad-retrospective`) to capture lessons learned
|
||||
|
||||
Quinn works directly from source code without loading planning documents (PRD, architecture). TEA workflows can integrate with upstream planning artifacts for traceability.
|
||||
|
||||
For more on where testing fits in the overall process, see the [Workflow Map](./workflow-map.md).
|
||||
|
|
|
|||
|
|
@ -1,86 +1,88 @@
|
|||
---
|
||||
title: "Workflow Map"
|
||||
description: Visual reference for BMad Method workflow phases and outputs
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
The BMad Method (BMM) is a module in the BMad Ecosystem, targeted at following the best practices of context engineering and planning. AI agents work best with clear, structured context. The BMM system builds that context progressively across 4 distinct phases - each phase, and multiple workflows optionally within each phase, produce documents that inform the next, so agents always know what to build and why.
|
||||
|
||||
The rationale and concepts come from agile methodologies that have been used across the industry with great success as a mental framework.
|
||||
|
||||
If at anytime you are unsure what to do, the `/bmad-help` command will help you stay on track or know what to do next. You can always refer to this for reference also - but /bmad-help is fully interactive and much quicker if you have already installed the BMadMethod. Additionally, if you are using different modules that have extended the BMad Method or added other complimentary non extension modules - the /bmad-help evolves to know all that is available to give you the best in the moment advice.
|
||||
If at any time you are unsure what to do, the `bmad-help` skill will help you stay on track or know what to do next. You can always refer to this for reference also - but `bmad-help` is fully interactive and much quicker if you have already installed the BMad Method. Additionally, if you are using different modules that have extended the BMad Method or added other complementary non-extension modules - `bmad-help` evolves to know all that is available to give you the best in-the-moment advice.
|
||||
|
||||
Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu.
|
||||
Final important note: Every workflow below can be run directly with your tool of choice via skill or by loading an agent first and using the entry from the agents menu.
|
||||
|
||||
<iframe src="/workflow-map-diagram.html" width="100%" height="100%" frameborder="0" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
||||
<iframe src="/workflow-map-diagram.html" title="BMad Method Workflow Map Diagram" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
||||
|
||||
*[Interactive diagram - hover over outputs to see artifact flows]*
|
||||
<p style="font-size: 0.8rem; text-align: right; margin-top: -0.5rem; margin-bottom: 1rem;">
|
||||
<a href="/workflow-map-diagram.html" target="_blank" rel="noopener noreferrer">Open diagram in new tab ↗</a>
|
||||
</p>
|
||||
|
||||
## Phase 1: Analysis (Optional)
|
||||
|
||||
Explore the problem space and validate ideas before committing to planning.
|
||||
|
||||
| Workflow | Purpose | Produces |
|
||||
| ---------------------- | -------------------------------------------------------------------------- | ------------------------- |
|
||||
| `brainstorm` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` |
|
||||
| `research` | Validate market, technical, or domain assumptions | Research findings |
|
||||
| `create-product-brief` | Capture strategic vision | `product-brief.md` |
|
||||
| ------------------------------- | -------------------------------------------------------------------------- | ------------------------- |
|
||||
| `bmad-brainstorming` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` |
|
||||
| `bmad-domain-research`, `bmad-market-research`, `bmad-technical-research` | Validate market, technical, or domain assumptions | Research findings |
|
||||
| `bmad-create-product-brief` | Capture strategic vision | `product-brief.md` |
|
||||
|
||||
## Phase 2: Planning
|
||||
|
||||
Define what to build and for whom.
|
||||
|
||||
| Workflow | Purpose | Produces |
|
||||
| ------------------ | ---------------------------------------- | ------------ |
|
||||
| `create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
|
||||
| `create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
|
||||
| --------------------------- | ---------------------------------------- | ------------ |
|
||||
| `bmad-create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
|
||||
| `bmad-create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
|
||||
|
||||
## Phase 3: Solutioning
|
||||
|
||||
Decide how to build it and break work into stories.
|
||||
|
||||
| Workflow | Purpose | Produces |
|
||||
| -------------------------------- | ------------------------------------------ | --------------------------- |
|
||||
| `create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
|
||||
| `create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
|
||||
| `check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
|
||||
| ----------------------------------------- | ------------------------------------------ | --------------------------- |
|
||||
| `bmad-create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
|
||||
| `bmad-create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
|
||||
| `bmad-check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
|
||||
|
||||
## Phase 4: Implementation
|
||||
|
||||
Build it, one story at a time.
|
||||
Build it, one story at a time. Coming soon, full phase 4 automation!
|
||||
|
||||
| Workflow | Purpose | Produces |
|
||||
| ----------------- | -------------------------------------- | ----------------------------- |
|
||||
| `sprint-planning` | Initialize tracking (once per project) | `sprint-status.yaml` |
|
||||
| `create-story` | Prepare next story for implementation | `story-[slug].md` |
|
||||
| `dev-story` | Implement the story | Working code + tests |
|
||||
| `automate` (QA) | Generate tests for existing features | Test suite |
|
||||
| `code-review` | Validate implementation quality | Approved or changes requested |
|
||||
| `correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
|
||||
| `retrospective` | Review after epic completion | Lessons learned |
|
||||
|
||||
**Quinn (QA Agent):** Built-in QA agent for test automation. Trigger with `QA` or `bmad-bmm-qa-automate`. Generates standard API and E2E tests using your project's test framework. Beginner-friendly, no configuration needed. For advanced test strategy, install [Test Architect (TEA)](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/) module.
|
||||
| -------------------------- | ------------------------------------------------------------------------ | -------------------------------- |
|
||||
| `bmad-sprint-planning` | Initialize tracking (once per project to sequence the dev cycle) | `sprint-status.yaml` |
|
||||
| `bmad-create-story` | Prepare next story for implementation | `story-[slug].md` |
|
||||
| `bmad-dev-story` | Implement the story | Working code + tests |
|
||||
| `bmad-code-review` | Validate implementation quality | Approved or changes requested |
|
||||
| `bmad-correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
|
||||
| `bmad-sprint-status` | Track sprint progress and story status | Sprint status update |
|
||||
| `bmad-retrospective` | Review after epic completion | Lessons learned |
|
||||
|
||||
## Quick Flow (Parallel Track)
|
||||
|
||||
Skip phases 1-3 for small, well-understood work.
|
||||
|
||||
| Workflow | Purpose | Produces |
|
||||
| ------------ | ------------------------------------------ | --------------------------------------------- |
|
||||
| `quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) |
|
||||
| `quick-dev` | Implement from spec or direct instructions | Working code + tests |
|
||||
| ------------------ | --------------------------------------------------------------------------- | ---------------------- |
|
||||
| `bmad-quick-dev` | Unified quick flow — clarify intent, plan, implement, review, and present | `tech-spec.md` + code |
|
||||
|
||||
## Context Management
|
||||
|
||||
Each document becomes context for the next phase. The PRD tells the architect what constraints matter. The architecture tells the dev agent which patterns to follow. Story files give focused, complete context for implementation. Without this structure, agents make inconsistent decisions.
|
||||
|
||||
For brownfield projects, `document-project` creates or updates `project-context.md` - what exists in the codebase and the rules all implementation workflows must observe. Run it just before Phase 4, and again when something significant changes - structure, architecture, or those rules. You can also edit `project-context.md` by hand.
|
||||
### Project Context
|
||||
|
||||
All implementation workflows load `project-context.md` if it exists. Additional context per workflow:
|
||||
:::tip[Recommended]
|
||||
Create `project-context.md` to ensure AI agents follow your project's rules and preferences. This file works like a constitution for your project — it guides implementation decisions across all workflows. This optional file can be generated at the end of Architecture Creation, or in an existing project it can be generated also to capture whats important to keep aligned with current conventions.
|
||||
:::
|
||||
|
||||
| Workflow | Also Loads |
|
||||
| -------------- | ---------------------------- |
|
||||
| `create-story` | epics, PRD, architecture, UX |
|
||||
| `dev-story` | story file |
|
||||
| `code-review` | architecture, story file |
|
||||
| `quick-spec` | planning docs (if exist) |
|
||||
| `quick-dev` | tech-spec |
|
||||
**How to create it:**
|
||||
|
||||
- **Manually** — Create `_bmad-output/project-context.md` with your technology stack and implementation rules
|
||||
- **Generate it** — Run `bmad-generate-project-context` to auto-generate from your architecture or codebase
|
||||
|
||||
[**Learn more about project-context.md**](../explanation/project-context.md)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: Roadmap
|
||||
description: What's next for BMad - Features, improvements, and community contributions
|
||||
---
|
||||
|
||||
# The BMad Method: Public Roadmap
|
||||
|
||||
The BMad Method, BMad Method Module (BMM), and BMad Builder (BMB) are evolving. Here's what we're working on and what's coming next.
|
||||
|
||||
<div class="roadmap-container">
|
||||
|
||||
<h2 class="roadmap-section-title">In Progress</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧩</span>
|
||||
<h4>Universal Skills Architecture</h4>
|
||||
<p>One skill, any platform. Write once, run everywhere.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>BMad Builder v1</h4>
|
||||
<p>Craft production-ready AI agents and workflows with evals, teams, and graceful degradation built in.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🧠</span>
|
||||
<h4>Project Context System</h4>
|
||||
<p>Your AI actually understands your project. Framework-aware context that evolves with your codebase.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📦</span>
|
||||
<h4>Centralized Skills</h4>
|
||||
<p>Install once, use everywhere. Share skills across projects without the file clutter.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔄</span>
|
||||
<h4>Adaptive Skills</h4>
|
||||
<p>Skills that know your tool. Optimized variants for Claude, Codex, Kimi, and OpenCode, plus many more.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">📝</span>
|
||||
<h4>BMad Team Pros Blog</h4>
|
||||
<p>Guides, articles and insights from the team. Launching soon.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Getting Started</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏪</span>
|
||||
<h4>Skill Marketplace</h4>
|
||||
<p>Discover, install, and update community-built skills. One curl command away from superpowers.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎨</span>
|
||||
<h4>Workflow Customization</h4>
|
||||
<p>Make it yours. Integrate Jira, Linear, custom outputs your workflow, your rules.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🚀</span>
|
||||
<h4>Phase 1-3 Optimization</h4>
|
||||
<p>Lightning-fast planning with sub-agent context gathering. YOLO mode meets guided excellence.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌐</span>
|
||||
<h4>Enterprise Ready</h4>
|
||||
<p>SSO, audit logs, team workspaces. All the boring stuff that makes companies say yes.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">💎</span>
|
||||
<h4>Community Modules Explosion</h4>
|
||||
<p>Entertainment, security, therapy, roleplay and much more. Expand the BMad Method platform.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>Dev Loop Automation</h4>
|
||||
<p>Optional autopilot for development. Let AI handle the flow while keeping quality sky-high.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 class="roadmap-section-title">Community and Team</h2>
|
||||
|
||||
<div class="roadmap-future">
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎙️</span>
|
||||
<h4>The BMad Method Podcast</h4>
|
||||
<p>Conversations about AI-native development. Launching March 1, 2026!</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🎓</span>
|
||||
<h4>The BMad Method Master Class</h4>
|
||||
<p>Go from user to expert. Deep dives into every phase, every workflow, every secret.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🏗️</span>
|
||||
<h4>The BMad Builder Master Class</h4>
|
||||
<p>Build your own agents. Advanced techniques for when you are ready to create, not just use.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">⚡</span>
|
||||
<h4>BMad Prototype First</h4>
|
||||
<p>Idea to working prototype in one session. Craft your dream app like a work of art.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🌴</span>
|
||||
<h4>BMad BALM!</h4>
|
||||
<p>Life management for the AI-native. Tasks, habits, goals your AI copilot for everything.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🖥️</span>
|
||||
<h4>Official UI</h4>
|
||||
<p>A beautiful interface for the entire BMad ecosystem. CLI power, GUI polish.</p>
|
||||
</div>
|
||||
<div class="roadmap-future-card">
|
||||
<span class="roadmap-emoji">🔒</span>
|
||||
<h4>BMad in a Box</h4>
|
||||
<p>Self-hosted, air-gapped, enterprise-grade. Your AI assistant, your infrastructure, your control.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="text-align: center; margin-top: 3rem; padding: 2rem; background: var(--color-bg-card); border-radius: 12px; border: 1px solid var(--color-border);">
|
||||
<h3 style="margin: 0 0 1rem;">Want to Contribute?</h3>
|
||||
<p style="color: var(--slate-color-400); margin: 0;">
|
||||
This is only a partial list of what's planned. The BMad Open Source team welcomes contributors!{" "}<br />
|
||||
<a href="https://github.com/bmad-code-org/BMAD-METHOD" style="color: var(--color-in-progress);">Join us on GitHub</a> to help shape the future of AI-driven development.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1.5rem 0 0;">
|
||||
Love what we're building? We appreciate both one-time and monthly{" "}<a href="https://buymeacoffee.com/bmad" style="color: var(--color-in-progress);">support</a>.
|
||||
</p>
|
||||
<p style="color: var(--slate-color-400); margin: 1rem 0 0;">
|
||||
For corporate sponsorship, partnership inquiries, speaking engagements, training, or media enquiries:{" "}
|
||||
<a href="mailto:contact@bmadcode.com" style="color: var(--color-in-progress);">contact@bmadcode.com</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -8,6 +8,7 @@ Build software faster using AI-powered workflows with specialized agents that gu
|
|||
## What You'll Learn
|
||||
|
||||
- Install and initialize BMad Method for a new project
|
||||
- Use **BMad-Help** — your intelligent guide that knows what to do next
|
||||
- Choose the right planning track for your project size
|
||||
- Progress through phases from requirements to working code
|
||||
- Use agents and workflows effectively
|
||||
|
|
@ -15,15 +16,50 @@ Build software faster using AI-powered workflows with specialized agents that gu
|
|||
:::note[Prerequisites]
|
||||
- **Node.js 20+** — Required for the installer
|
||||
- **Git** — Recommended for version control
|
||||
- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar
|
||||
- **AI-powered IDE** — Claude Code, Cursor, or similar
|
||||
- **A project idea** — Even a simple one works for learning
|
||||
:::
|
||||
|
||||
:::tip[Quick Path]
|
||||
:::tip[The Easiest Path]
|
||||
**Install** → `npx bmad-method install`
|
||||
**Plan** → PM creates PRD, Architect creates architecture
|
||||
**Build** → SM manages sprints, DEV implements stories
|
||||
**Fresh chats** for each workflow to avoid context issues.
|
||||
**Ask** → `bmad-help what should I do first?`
|
||||
**Build** → Let BMad-Help guide you workflow by workflow
|
||||
:::
|
||||
|
||||
## Meet BMad-Help: Your Intelligent Guide
|
||||
|
||||
**BMad-Help is the fastest way to get started with BMad.** You don't need to memorize workflows or phases — just ask, and BMad-Help will:
|
||||
|
||||
- **Inspect your project** to see what's already been done
|
||||
- **Show your options** based on which modules you have installed
|
||||
- **Recommend what's next** — including the first required task
|
||||
- **Answer questions** like "I have a SaaS idea, where do I start?"
|
||||
|
||||
### How to Use BMad-Help
|
||||
|
||||
Run it in your AI IDE by invoking the skill:
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
Or combine it with a question for context-aware guidance:
|
||||
|
||||
```
|
||||
bmad-help I have an idea for a SaaS product, I already know all the features I want. where do I get started?
|
||||
```
|
||||
|
||||
BMad-Help will respond with:
|
||||
- What's recommended for your situation
|
||||
- What the first required task is
|
||||
- What the rest of the process looks like
|
||||
|
||||
### It Powers Workflows Too
|
||||
|
||||
BMad-Help doesn't just answer questions — **it automatically runs at the end of every workflow** to tell you exactly what to do next. No guessing, no searching docs — just clear guidance on the next required workflow.
|
||||
|
||||
:::tip[Start Here]
|
||||
After installing BMad, invoke the `bmad-help` skill immediately. It will detect what modules you have installed and guide you to the right starting point for your project.
|
||||
:::
|
||||
|
||||
## Understanding BMad
|
||||
|
|
@ -37,7 +73,7 @@ BMad helps you build software through guided workflows with specialized AI agent
|
|||
| 3 | Solutioning | Design architecture *(BMad Method/Enterprise only)* |
|
||||
| 4 | Implementation | Build epic by epic, story by story |
|
||||
|
||||
**[Open the Workflow Map](/docs/reference/workflow-map.md)** to explore phases, workflows, and context management.
|
||||
**[Open the Workflow Map](../reference/workflow-map.md)** to explore phases, workflows, and context management.
|
||||
|
||||
Based on your project's complexity, BMad offers three planning tracks:
|
||||
|
||||
|
|
@ -59,16 +95,26 @@ Open a terminal in your project directory and run:
|
|||
npx bmad-method install
|
||||
```
|
||||
|
||||
If you want the newest prerelease build instead of the default release channel, use `npx bmad-method@next install`.
|
||||
|
||||
When prompted to select modules, choose **BMad Method**.
|
||||
|
||||
The installer creates two folders:
|
||||
- `_bmad/` — agents, workflows, tasks, and configuration
|
||||
- `_bmad-output/` — empty for now, but this is where your artifacts will be saved
|
||||
|
||||
Open your AI IDE in the project folder. Run the `help` workflow (`/bmad-help`) to see what to do next — it detects what you've completed and recommends the next step.
|
||||
:::tip[Your Next Step]
|
||||
Open your AI IDE in the project folder and run:
|
||||
|
||||
```
|
||||
bmad-help
|
||||
```
|
||||
|
||||
BMad-Help will detect what you've completed and recommend exactly what to do next. You can also ask it questions like "What are my options?" or "I have a SaaS idea, where should I start?"
|
||||
:::
|
||||
|
||||
:::note[How to Load Agents and Run Workflows]
|
||||
Each workflow has a **slash command** you run in your IDE (e.g., `/bmad-bmm-create-prd`). Running a workflow command automatically loads the appropriate agent — you don't need to load agents separately. You can also load an agent directly for general conversation (e.g., `/bmad-agent-bmm-pm` for the PM agent).
|
||||
Each workflow has a **skill** you invoke by name in your IDE (e.g., `bmad-create-prd`). Your AI tool will recognize the `bmad-*` name and run it — you don't need to load agents separately. You can also invoke an agent skill directly for general conversation (e.g., `bmad-pm` for the PM agent).
|
||||
:::
|
||||
|
||||
:::caution[Fresh Chats]
|
||||
|
|
@ -79,32 +125,38 @@ Always start a fresh chat for each workflow. This prevents context limitations f
|
|||
|
||||
Work through phases 1-3. **Use fresh chats for each workflow.**
|
||||
|
||||
:::tip[Project Context (Optional)]
|
||||
Before starting, consider creating `project-context.md` to document your technical preferences and implementation rules. This ensures all AI agents follow your conventions throughout the project.
|
||||
|
||||
Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `bmad-generate-project-context`. [Learn more](../explanation/project-context.md).
|
||||
:::
|
||||
|
||||
### Phase 1: Analysis (Optional)
|
||||
|
||||
All workflows in this phase are optional:
|
||||
- **brainstorming** (`/bmad-brainstorming`) — Guided ideation
|
||||
- **research** (`/bmad-bmm-research`) — Market and technical research
|
||||
- **create-product-brief** (`/bmad-bmm-create-product-brief`) — Recommended foundation document
|
||||
- **brainstorming** (`bmad-brainstorming`) — Guided ideation
|
||||
- **research** (`bmad-research`) — Market and technical research
|
||||
- **create-product-brief** (`bmad-create-product-brief`) — Recommended foundation document
|
||||
|
||||
### Phase 2: Planning (Required)
|
||||
|
||||
**For BMad Method and Enterprise tracks:**
|
||||
1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
|
||||
2. Run the `prd` workflow (`/bmad-bmm-create-prd`)
|
||||
1. Invoke the **PM agent** (`bmad-pm`) in a new chat
|
||||
2. Run the `bmad-create-prd` workflow (`bmad-create-prd`)
|
||||
3. Output: `PRD.md`
|
||||
|
||||
**For Quick Flow track:**
|
||||
- Use the `quick-spec` workflow (`/bmad-bmm-quick-spec`) instead of PRD, then skip to implementation
|
||||
- Run `bmad-quick-dev` — it handles planning and implementation in a single workflow, skip to implementation
|
||||
|
||||
:::note[UX Design (Optional)]
|
||||
If your project has a user interface, load the **UX-Designer agent** (`/bmad-agent-bmm-ux-designer`) and run the UX design workflow (`/bmad-bmm-create-ux-design`) after creating your PRD.
|
||||
If your project has a user interface, invoke the **UX-Designer agent** (`bmad-ux-designer`) and run the UX design workflow (`bmad-create-ux-design`) after creating your PRD.
|
||||
:::
|
||||
|
||||
### Phase 3: Solutioning (BMad Method/Enterprise)
|
||||
|
||||
**Create Architecture**
|
||||
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
|
||||
2. Run `create-architecture` (`/bmad-bmm-create-architecture`)
|
||||
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat
|
||||
2. Run `bmad-create-architecture` (`bmad-create-architecture`)
|
||||
3. Output: Architecture document with technical decisions
|
||||
|
||||
**Create Epics and Stories**
|
||||
|
|
@ -113,13 +165,13 @@ If your project has a user interface, load the **UX-Designer agent** (`/bmad-age
|
|||
Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down.
|
||||
:::
|
||||
|
||||
1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
|
||||
2. Run `create-epics-and-stories` (`/bmad-bmm-create-epics-and-stories`)
|
||||
1. Invoke the **PM agent** (`bmad-pm`) in a new chat
|
||||
2. Run `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`)
|
||||
3. The workflow uses both PRD and Architecture to create technically-informed stories
|
||||
|
||||
**Implementation Readiness Check** *(Highly Recommended)*
|
||||
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
|
||||
2. Run `check-implementation-readiness` (`/bmad-bmm-check-implementation-readiness`)
|
||||
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat
|
||||
2. Run `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`)
|
||||
3. Validates cohesion across all planning documents
|
||||
|
||||
## Step 2: Build Your Project
|
||||
|
|
@ -128,7 +180,7 @@ Once planning is complete, move to implementation. **Each workflow should run in
|
|||
|
||||
### Initialize Sprint Planning
|
||||
|
||||
Load the **SM agent** (`/bmad-agent-bmm-sm`) and run `sprint-planning` (`/bmad-bmm-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
|
||||
Invoke the **SM agent** (`bmad-sm`) and run `bmad-sprint-planning` (`bmad-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
|
||||
|
||||
### The Build Cycle
|
||||
|
||||
|
|
@ -136,11 +188,11 @@ For each story, repeat this cycle with fresh chats:
|
|||
|
||||
| Step | Agent | Workflow | Command | Purpose |
|
||||
| ---- | ----- | -------------- | -------------------------- | ---------------------------------- |
|
||||
| 1 | SM | `create-story` | `/bmad-bmm-create-story` | Create story file from epic |
|
||||
| 2 | DEV | `dev-story` | `/bmad-bmm-dev-story` | Implement the story |
|
||||
| 3 | DEV | `code-review` | `/bmad-bmm-code-review` | Quality validation *(recommended)* |
|
||||
| 1 | SM | `bmad-create-story` | `bmad-create-story` | Create story file from epic |
|
||||
| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implement the story |
|
||||
| 3 | DEV | `bmad-code-review` | `bmad-code-review` | Quality validation *(recommended)* |
|
||||
|
||||
After completing all stories in an epic, load the **SM agent** (`/bmad-agent-bmm-sm`) and run `retrospective` (`/bmad-bmm-retrospective`).
|
||||
After completing all stories in an epic, invoke the **SM agent** (`bmad-sm`) and run `bmad-retrospective` (`bmad-retrospective`).
|
||||
|
||||
## What You've Accomplished
|
||||
|
||||
|
|
@ -153,30 +205,34 @@ You've learned the foundation of building with BMad:
|
|||
|
||||
Your project now has:
|
||||
|
||||
```
|
||||
```text
|
||||
your-project/
|
||||
├── _bmad/ # BMad configuration
|
||||
├── _bmad-output/
|
||||
│ ├── PRD.md # Your requirements document
|
||||
│ ├── architecture.md # Technical decisions
|
||||
│ ├── epics/ # Epic and story files
|
||||
│ └── sprint-status.yaml # Sprint tracking
|
||||
│ ├── planning-artifacts/
|
||||
│ │ ├── PRD.md # Your requirements document
|
||||
│ │ ├── architecture.md # Technical decisions
|
||||
│ │ └── epics/ # Epic and story files
|
||||
│ ├── implementation-artifacts/
|
||||
│ │ └── sprint-status.yaml # Sprint tracking
|
||||
│ └── project-context.md # Implementation rules (optional)
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Command | Agent | Purpose |
|
||||
| -------------------------------- | ------------------------------------------ | --------- | ------------------------------------ |
|
||||
| `help` | `/bmad-help` | Any | Get guidance on what to do next |
|
||||
| `prd` | `/bmad-bmm-create-prd` | PM | Create Product Requirements Document |
|
||||
| `create-architecture` | `/bmad-bmm-create-architecture` | Architect | Create architecture document |
|
||||
| `create-epics-and-stories` | `/bmad-bmm-create-epics-and-stories` | PM | Break down PRD into epics |
|
||||
| `check-implementation-readiness` | `/bmad-bmm-check-implementation-readiness` | Architect | Validate planning cohesion |
|
||||
| `sprint-planning` | `/bmad-bmm-sprint-planning` | SM | Initialize sprint tracking |
|
||||
| `create-story` | `/bmad-bmm-create-story` | SM | Create a story file |
|
||||
| `dev-story` | `/bmad-bmm-dev-story` | DEV | Implement a story |
|
||||
| `code-review` | `/bmad-bmm-code-review` | DEV | Review implemented code |
|
||||
| ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- |
|
||||
| **`bmad-help`** ⭐ | `bmad-help` | Any | **Your intelligent guide — ask anything!** |
|
||||
| `bmad-create-prd` | `bmad-create-prd` | PM | Create Product Requirements Document |
|
||||
| `bmad-create-architecture` | `bmad-create-architecture` | Architect | Create architecture document |
|
||||
| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Create project context file |
|
||||
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Break down PRD into epics |
|
||||
| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | Validate planning cohesion |
|
||||
| `bmad-sprint-planning` | `bmad-sprint-planning` | SM | Initialize sprint tracking |
|
||||
| `bmad-create-story` | `bmad-create-story` | SM | Create a story file |
|
||||
| `bmad-dev-story` | `bmad-dev-story` | DEV | Implement a story |
|
||||
| `bmad-code-review` | `bmad-code-review` | DEV | Review implemented code |
|
||||
|
||||
## Common Questions
|
||||
|
||||
|
|
@ -184,26 +240,36 @@ your-project/
|
|||
Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.
|
||||
|
||||
**Can I change my plan later?**
|
||||
Yes. The SM agent has a `correct-course` workflow (`/bmad-bmm-correct-course`) for handling scope changes.
|
||||
Yes. The SM agent has a `bmad-correct-course` workflow (`bmad-correct-course`) for handling scope changes.
|
||||
|
||||
**What if I want to brainstorm first?**
|
||||
Load the Analyst agent (`/bmad-agent-bmm-analyst`) and run `brainstorming` (`/bmad-brainstorming`) before starting your PRD.
|
||||
Invoke the Analyst agent (`bmad-analyst`) and run `bmad-brainstorming` (`bmad-brainstorming`) before starting your PRD.
|
||||
|
||||
**Do I need to follow a strict order?**
|
||||
Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.
|
||||
|
||||
## Getting Help
|
||||
|
||||
:::tip[First Stop: BMad-Help]
|
||||
**Invoke `bmad-help` anytime** — it's the fastest way to get unstuck. Ask it anything:
|
||||
- "What should I do after installing?"
|
||||
- "I'm stuck on workflow X"
|
||||
- "What are my options for Y?"
|
||||
- "Show me what's been done so far"
|
||||
|
||||
BMad-Help inspects your project, detects what you've completed, and tells you exactly what to do next.
|
||||
:::
|
||||
|
||||
- **During workflows** — Agents guide you with questions and explanations
|
||||
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
||||
- **Stuck?** — Run `help` (`/bmad-help`) to see what to do next
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
:::tip[Remember These]
|
||||
- **Start with `bmad-help`** — Your intelligent guide that knows your project and options
|
||||
- **Always use fresh chats** — Start a new chat for each workflow
|
||||
- **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture
|
||||
- **Use `help` (`/bmad-help`) when stuck** — It detects your progress and suggests next steps
|
||||
- **Track matters** — Quick Flow uses `bmad-quick-dev`; Method/Enterprise need PRD and architecture
|
||||
- **BMad-Help runs automatically** — Every workflow ends with guidance on what's next
|
||||
:::
|
||||
|
||||
Ready to start? Install BMad and let the agents guide you through your first project.
|
||||
Ready to start? Install BMad, invoke `bmad-help`, and let your intelligent guide lead the way.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: 页面未找到
|
||||
template: splash
|
||||
---
|
||||
|
||||
|
||||
您查找的页面不存在或已被移动。
|
||||
|
||||
[返回首页](./index.md)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue