bmad-method 6.0.5-next.0 → 6.0.5-next.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yaml +0 -110
- package/CHANGELOG.md +2 -2
- package/README.md +3 -3
- package/README_CN.md +2 -2
- package/docs/explanation/quick-dev-new-preview.md +73 -0
- package/docs/explanation/quick-flow.md +4 -0
- package/docs/how-to/get-answers-about-bmad.md +12 -8
- package/docs/how-to/install-bmad.md +9 -0
- package/docs/reference/testing.md +4 -4
- package/docs/tutorials/getting-started.md +40 -38
- package/docs/zh-cn/how-to/established-projects.md +4 -4
- package/docs/zh-cn/how-to/get-answers-about-bmad.md +6 -6
- package/docs/zh-cn/how-to/install-bmad.md +3 -3
- package/docs/zh-cn/index.md +1 -1
- package/docs/zh-cn/reference/commands.md +20 -20
- package/docs/zh-cn/reference/workflow-map.md +2 -2
- package/docs/zh-cn/tutorials/getting-started.md +40 -40
- package/package.json +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +17 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +30 -12
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +5 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +4 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.md +4 -7
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md +1 -3
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md +2 -2
- package/src/bmm/workflows/qa-generate-e2e-tests/checklist.md +1 -1
- package/src/core/module-help.csv +4 -4
- package/src/core/tasks/bmad-editorial-review-prose/SKILL.md +6 -0
- package/src/core/tasks/bmad-editorial-review-prose/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-editorial-review-prose/workflow.md +81 -0
- package/src/core/tasks/bmad-editorial-review-structure/SKILL.md +6 -0
- package/src/core/tasks/bmad-editorial-review-structure/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-editorial-review-structure/workflow.md +174 -0
- package/src/core/tasks/bmad-help/workflow.md +4 -4
- package/src/core/tasks/bmad-index-docs/SKILL.md +6 -0
- package/src/core/tasks/bmad-index-docs/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-index-docs/workflow.md +61 -0
- package/src/core/tasks/bmad-shard-doc/SKILL.md +6 -0
- package/src/core/tasks/bmad-shard-doc/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-shard-doc/workflow.md +100 -0
- package/tools/build-docs.mjs +1 -0
- package/tools/cli/installers/lib/core/installer.js +1 -1
- package/tools/docs/fix-refs.md +1 -1
- package/website/public/diagrams/quick-dev-diagram.png +0 -0
- package/.claude/skills/bmad-os-audit-file-refs/SKILL.md +0 -6
- package/.claude/skills/bmad-os-audit-file-refs/prompts/instructions.md +0 -59
- package/.claude/skills/bmad-os-changelog-social/SKILL.md +0 -177
- package/.claude/skills/bmad-os-changelog-social/examples/discord-example.md +0 -53
- package/.claude/skills/bmad-os-changelog-social/examples/linkedin-example.md +0 -49
- package/.claude/skills/bmad-os-changelog-social/examples/twitter-example.md +0 -55
- package/.claude/skills/bmad-os-diataxis-style-fix/SKILL.md +0 -6
- package/.claude/skills/bmad-os-diataxis-style-fix/prompts/instructions.md +0 -229
- package/.claude/skills/bmad-os-draft-changelog/SKILL.md +0 -6
- package/.claude/skills/bmad-os-draft-changelog/prompts/instructions.md +0 -82
- package/.claude/skills/bmad-os-findings-triage/SKILL.md +0 -6
- package/.claude/skills/bmad-os-findings-triage/prompts/agent-prompt.md +0 -104
- package/.claude/skills/bmad-os-findings-triage/prompts/instructions.md +0 -286
- package/.claude/skills/bmad-os-gh-triage/SKILL.md +0 -6
- package/.claude/skills/bmad-os-gh-triage/prompts/agent-prompt.md +0 -60
- package/.claude/skills/bmad-os-gh-triage/prompts/instructions.md +0 -74
- package/.claude/skills/bmad-os-release-module/SKILL.md +0 -6
- package/.claude/skills/bmad-os-release-module/prompts/instructions.md +0 -53
- package/.claude/skills/bmad-os-review-pr/SKILL.md +0 -6
- package/.claude/skills/bmad-os-review-pr/prompts/instructions.md +0 -288
- package/.claude/skills/bmad-os-review-prompt/SKILL.md +0 -177
- package/.claude/skills/bmad-os-root-cause-analysis/SKILL.md +0 -12
- package/.claude/skills/bmad-os-root-cause-analysis/prompts/instructions.md +0 -74
- package/src/core/tasks/bmad-skill-manifest.yaml +0 -19
- package/src/core/tasks/editorial-review-prose.xml +0 -102
- package/src/core/tasks/editorial-review-structure.xml +0 -208
- package/src/core/tasks/index-docs.xml +0 -65
- package/src/core/tasks/shard-doc.xml +0 -108
|
@@ -56,85 +56,6 @@ jobs:
|
|
|
56
56
|
run: |
|
|
57
57
|
# npm trusted publishing requires Node >= 22.14.0 and npm >= 11.5.1.
|
|
58
58
|
npm install --global npm@11.6.2
|
|
59
|
-
echo "Node: $(node --version)"
|
|
60
|
-
echo "npm: $(npm --version)"
|
|
61
|
-
|
|
62
|
-
- name: Debug npm auth config surface
|
|
63
|
-
run: |
|
|
64
|
-
USERCONFIG=$(npm config get userconfig)
|
|
65
|
-
echo "npm userconfig: $USERCONFIG"
|
|
66
|
-
if [ -f "$USERCONFIG" ]; then
|
|
67
|
-
if rg -n "_authToken|always-auth|registry.npmjs.org" "$USERCONFIG" >/dev/null 2>&1; then
|
|
68
|
-
echo "npm userconfig contains registry auth-related entries"
|
|
69
|
-
rg -n "_authToken|always-auth|registry.npmjs.org" "$USERCONFIG" | sed -E 's/(_authToken=).*/\1***MASKED***/'
|
|
70
|
-
else
|
|
71
|
-
echo "npm userconfig has no registry auth-related entries"
|
|
72
|
-
fi
|
|
73
|
-
else
|
|
74
|
-
echo "npm userconfig file not found"
|
|
75
|
-
fi
|
|
76
|
-
|
|
77
|
-
- name: Debug trusted publishing identity
|
|
78
|
-
run: |
|
|
79
|
-
echo "GitHub workflow context:"
|
|
80
|
-
echo " repository: ${{ github.repository }}"
|
|
81
|
-
echo " repository_owner: ${{ github.repository_owner }}"
|
|
82
|
-
echo " ref: ${{ github.ref }}"
|
|
83
|
-
echo " event_name: ${{ github.event_name }}"
|
|
84
|
-
echo " workflow: ${{ github.workflow }}"
|
|
85
|
-
echo " workflow_ref: ${{ github.workflow_ref }}"
|
|
86
|
-
echo " actor: ${{ github.actor }}"
|
|
87
|
-
echo " selected_channel: ${{ inputs.channel || 'n/a' }}"
|
|
88
|
-
echo " selected_bump: ${{ inputs.bump || 'n/a' }}"
|
|
89
|
-
if [ "${NODE_AUTH_TOKEN+x}" = "x" ]; then
|
|
90
|
-
if [ -n "$NODE_AUTH_TOKEN" ]; then
|
|
91
|
-
echo " node_auth_token_state: set-nonempty"
|
|
92
|
-
else
|
|
93
|
-
echo " node_auth_token_state: set-empty"
|
|
94
|
-
fi
|
|
95
|
-
else
|
|
96
|
-
echo " node_auth_token_state: unset"
|
|
97
|
-
fi
|
|
98
|
-
|
|
99
|
-
WORKFLOW_FILE=$(node -e "
|
|
100
|
-
const ref = process.argv[1] || '';
|
|
101
|
-
const match = ref.match(/\.github\/workflows\/([^@]+)@/);
|
|
102
|
-
process.stdout.write(match ? match[1] : '');
|
|
103
|
-
" "${{ github.workflow_ref }}")
|
|
104
|
-
echo " workflow_filename_for_npm: ${WORKFLOW_FILE:-unknown}"
|
|
105
|
-
|
|
106
|
-
echo "OIDC claims (sanitized):"
|
|
107
|
-
RESPONSE=$(curl -fsS -H "Authorization: Bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "${ACTIONS_ID_TOKEN_REQUEST_URL}&audience=npm:registry.npmjs.org")
|
|
108
|
-
ID_TOKEN=$(node -e "
|
|
109
|
-
const fs = require('fs');
|
|
110
|
-
const data = JSON.parse(fs.readFileSync(0, 'utf8'));
|
|
111
|
-
process.stdout.write(data.value || '');
|
|
112
|
-
" <<<"$RESPONSE")
|
|
113
|
-
|
|
114
|
-
node -e "
|
|
115
|
-
const token = process.argv[1];
|
|
116
|
-
if (!token) {
|
|
117
|
-
console.log(JSON.stringify({ error: 'missing_id_token' }, null, 2));
|
|
118
|
-
process.exit(0);
|
|
119
|
-
}
|
|
120
|
-
const payloadPart = token.split('.')[1] || '';
|
|
121
|
-
const padded = payloadPart.replace(/-/g, '+').replace(/_/g, '/') + '='.repeat((4 - (payloadPart.length % 4)) % 4);
|
|
122
|
-
const claims = JSON.parse(Buffer.from(padded, 'base64').toString('utf8'));
|
|
123
|
-
const out = {
|
|
124
|
-
iss: claims.iss,
|
|
125
|
-
sub: claims.sub,
|
|
126
|
-
aud: claims.aud,
|
|
127
|
-
repository: claims.repository,
|
|
128
|
-
repository_owner: claims.repository_owner,
|
|
129
|
-
workflow: claims.workflow,
|
|
130
|
-
workflow_ref: claims.workflow_ref,
|
|
131
|
-
job_workflow_ref: claims.job_workflow_ref,
|
|
132
|
-
ref: claims.ref,
|
|
133
|
-
environment: claims.environment || null,
|
|
134
|
-
runner_environment: claims.runner_environment || null,
|
|
135
|
-
};
|
|
136
|
-
console.log(JSON.stringify(out, null, 2));
|
|
137
|
-
" "$ID_TOKEN"
|
|
138
59
|
|
|
139
60
|
- name: Configure git user
|
|
140
61
|
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
|
@@ -175,17 +96,6 @@ jobs:
|
|
|
175
96
|
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
|
176
97
|
run: 'npm version ${{ inputs.bump }} -m "chore(release): v%s [skip ci]"'
|
|
177
98
|
|
|
178
|
-
- name: Debug publish target and registry state
|
|
179
|
-
run: |
|
|
180
|
-
echo "Local package target:"
|
|
181
|
-
node -e "
|
|
182
|
-
const pkg = require('./package.json');
|
|
183
|
-
console.log(JSON.stringify({ name: pkg.name, version: pkg.version }, null, 2));
|
|
184
|
-
"
|
|
185
|
-
|
|
186
|
-
echo "Registry package view (bmad-method):"
|
|
187
|
-
npm view bmad-method name version dist-tags --json || true
|
|
188
|
-
|
|
189
99
|
- name: Publish prerelease to npm
|
|
190
100
|
if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.channel == 'next')
|
|
191
101
|
run: npm publish --tag next --provenance
|
|
@@ -194,26 +104,6 @@ jobs:
|
|
|
194
104
|
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
|
195
105
|
run: npm publish --tag latest --provenance
|
|
196
106
|
|
|
197
|
-
- name: Print npm debug logs
|
|
198
|
-
if: always()
|
|
199
|
-
run: |
|
|
200
|
-
LOG_DIR="$HOME/.npm/_logs"
|
|
201
|
-
echo "npm log directory: $LOG_DIR"
|
|
202
|
-
ls -la "$LOG_DIR" || true
|
|
203
|
-
|
|
204
|
-
found=0
|
|
205
|
-
for file in "$LOG_DIR"/*-debug-0.log; do
|
|
206
|
-
[ -e "$file" ] || continue
|
|
207
|
-
found=1
|
|
208
|
-
echo "::group::npm-debug $(basename "$file")"
|
|
209
|
-
cat "$file"
|
|
210
|
-
echo "::endgroup::"
|
|
211
|
-
done
|
|
212
|
-
|
|
213
|
-
if [ "$found" -eq 0 ]; then
|
|
214
|
-
echo "No npm *-debug-0.log files found."
|
|
215
|
-
fi
|
|
216
|
-
|
|
217
107
|
- name: Push version commit and tag
|
|
218
108
|
if: github.event_name == 'workflow_dispatch' && inputs.channel == 'latest'
|
|
219
109
|
run: git push origin main --follow-tags
|
package/CHANGELOG.md
CHANGED
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
* Add CodeBuddy platform support with installer configuration (#1483)
|
|
48
48
|
* Add LLM audit prompt for file reference conventions - new audit tool using parallel subagents (#1720)
|
|
49
49
|
* Migrate Codex installer from `.codex/prompts` to `.agents/skills` format to align with Codex CLI changes (#1729)
|
|
50
|
-
* Convert review-pr and audit-file-refs tools to proper bmad-os skills with slash commands
|
|
50
|
+
* 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)
|
|
51
51
|
|
|
52
52
|
### 🐛 Bug Fixes
|
|
53
53
|
|
|
@@ -365,7 +365,7 @@ V6 Stable Release! The End of Beta!
|
|
|
365
365
|
- TEA documentation restructured using Diátaxis framework (25 docs)
|
|
366
366
|
- Style guide optimized for LLM readers (367 lines, down from 767)
|
|
367
367
|
- Glossary rewritten using table format (123 lines, down from 373)
|
|
368
|
-
- README overhaul with numbered command flows and prominent
|
|
368
|
+
- README overhaul with numbered command flows and prominent `bmad-help` callout
|
|
369
369
|
- New workflow map diagram with interactive HTML
|
|
370
370
|
- New editorial review tasks for document quality
|
|
371
371
|
- E2E testing methodology for Game Dev Studio
|
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
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.
|
|
15
15
|
|
|
16
|
-
- **AI Intelligent Help** —
|
|
16
|
+
- **AI Intelligent Help** — Invoke the `bmad-help` skill anytime for guidance on what's next
|
|
17
17
|
- **Scale-Domain-Adaptive** — Automatically adjusts planning depth based on project complexity
|
|
18
18
|
- **Structured Workflows** — Grounded in agile best practices across analysis, planning, architecture, and implementation
|
|
19
19
|
- **Specialized Agents** — 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
|
@@ -40,7 +40,7 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
|
|
40
40
|
npx bmad-method install
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
>
|
|
43
|
+
> Want the newest prerelease build? Use `npx bmad-method@next install`. Expect higher churn than the default install.
|
|
44
44
|
|
|
45
45
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, etc.) in your project folder.
|
|
46
46
|
|
|
@@ -52,7 +52,7 @@ npx bmad-method install --directory /path/to/project --modules bmm --tools claud
|
|
|
52
52
|
|
|
53
53
|
[See all installation options](https://docs.bmad-method.org/how-to/non-interactive-installation/)
|
|
54
54
|
|
|
55
|
-
> **Not sure what to do?**
|
|
55
|
+
> **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?`
|
|
56
56
|
|
|
57
57
|
## Modules
|
|
58
58
|
|
package/README_CN.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
传统 AI 工具替你思考,产生平庸的结果。BMad 智能体和辅助工作流充当专家协作者,引导你通过结构化流程,与 AI 的合作发挥最佳思维,产出最有效优秀的结果。
|
|
15
15
|
|
|
16
|
-
- **AI 智能帮助** — 随时使用
|
|
16
|
+
- **AI 智能帮助** — 随时使用 `bmad-help` 获取下一步指导
|
|
17
17
|
- **规模-领域自适应** — 根据项目复杂度自动调整规划深度
|
|
18
18
|
- **结构化工作流** — 基于分析、规划、架构和实施的敏捷最佳实践
|
|
19
19
|
- **专业智能体** — 12+ 领域专家(PM、架构师、开发者、UX、Scrum Master 等)
|
|
@@ -52,7 +52,7 @@ npx bmad-method install --directory /path/to/project --modules bmm --tools claud
|
|
|
52
52
|
|
|
53
53
|
[查看所有安装选项](http://docs.bmad-method.org/how-to/non-interactive-installation/)
|
|
54
54
|
|
|
55
|
-
> **不确定该做什么?** 运行
|
|
55
|
+
> **不确定该做什么?** 运行 `bmad-help` — 它会准确告诉你下一步做什么以及什么是可选的。你也可以问诸如 `bmad-help 我刚刚完成了架构设计,接下来该做什么?` 之类的问题。
|
|
56
56
|
|
|
57
57
|
## 模块
|
|
58
58
|
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Quick Dev New Preview"
|
|
3
|
+
description: Reduce human-in-the-loop friction without giving up the checkpoints that protect output quality
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 2
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
`bmad-quick-dev-new-preview` is an experimental attempt to radically improve Quick Flow: intent in, code changes out, with lower ceremony and fewer human-in-the-loop turns without sacrificing quality.
|
|
9
|
+
|
|
10
|
+
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.
|
|
11
|
+
|
|
12
|
+

|
|
13
|
+
|
|
14
|
+
## Why This Exists
|
|
15
|
+
|
|
16
|
+
Human-in-the-loop turns are necessary and expensive.
|
|
17
|
+
|
|
18
|
+
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.
|
|
19
|
+
|
|
20
|
+
This experimental version of Quick Flow is an attempt to rebalance 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.
|
|
21
|
+
|
|
22
|
+
## The Core Design
|
|
23
|
+
|
|
24
|
+
### 1. Compress intent first
|
|
25
|
+
|
|
26
|
+
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.
|
|
27
|
+
|
|
28
|
+
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.
|
|
29
|
+
|
|
30
|
+
This workflow does not eliminate human control. It relocates it to a small number of high-value moments:
|
|
31
|
+
|
|
32
|
+
- **Intent clarification** - turning a messy request into one coherent goal without hidden contradictions
|
|
33
|
+
- **Spec approval** - confirming that the frozen understanding is the right thing to build
|
|
34
|
+
- **Review of the final product** - the primary checkpoint, where the human decides whether the result is acceptable at the end
|
|
35
|
+
|
|
36
|
+
### 2. Route to the smallest safe path
|
|
37
|
+
|
|
38
|
+
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.
|
|
39
|
+
|
|
40
|
+
### 3. Run longer with less supervision
|
|
41
|
+
|
|
42
|
+
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 experiment.
|
|
43
|
+
|
|
44
|
+
### 4. Diagnose failure at the right layer
|
|
45
|
+
|
|
46
|
+
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.
|
|
47
|
+
|
|
48
|
+
Review findings are used to decide whether the problem came from intent, spec generation, or local implementation. Only truly local problems get patched locally.
|
|
49
|
+
|
|
50
|
+
### 5. Bring the human back only when needed
|
|
51
|
+
|
|
52
|
+
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.
|
|
53
|
+
|
|
54
|
+
- **Intent-gap resolution** - stepping back in when review proves the workflow could not safely infer what was meant
|
|
55
|
+
|
|
56
|
+
Everything else is a candidate for longer autonomous execution. That tradeoff is deliberate. Older patterns spend more human attention on continuous supervision. Quick Dev New Preview spends more trust on the model, but saves human attention for the moments where human reasoning has the highest leverage.
|
|
57
|
+
|
|
58
|
+
## Why the Review System Matters
|
|
59
|
+
|
|
60
|
+
The review phase is not just there to find bugs. It is there to route correction without destroying momentum.
|
|
61
|
+
|
|
62
|
+
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.
|
|
63
|
+
|
|
64
|
+
Agentic reviews often go wrong in two ways:
|
|
65
|
+
|
|
66
|
+
- They generate too many findings, forcing the human to sift through noise.
|
|
67
|
+
- They derail the current change by surfacing unrelated issues and turning every run into an ad hoc cleanup project.
|
|
68
|
+
|
|
69
|
+
Quick Dev New Preview addresses both by treating review as triage.
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
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.
|
|
@@ -7,6 +7,10 @@ sidebar:
|
|
|
7
7
|
|
|
8
8
|
Skip the ceremony. Quick Flow takes you from idea to working code in two skills - no Product Brief, no PRD, no Architecture doc.
|
|
9
9
|
|
|
10
|
+
:::tip[Want a Unified Variant?]
|
|
11
|
+
If you want one workflow to clarify, plan, implement, review, and present in a single run, see [Quick Dev New Preview](./quick-dev-new-preview.md).
|
|
12
|
+
:::
|
|
13
|
+
|
|
10
14
|
## When to Use It
|
|
11
15
|
|
|
12
16
|
- Bug fixes and patches
|
|
@@ -7,7 +7,7 @@ sidebar:
|
|
|
7
7
|
|
|
8
8
|
## Start Here: BMad-Help
|
|
9
9
|
|
|
10
|
-
**The fastest way to get answers about BMad is
|
|
10
|
+
**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.
|
|
11
11
|
|
|
12
12
|
BMad-Help is more than a lookup tool — it:
|
|
13
13
|
- **Inspects your project** to see what's already been completed
|
|
@@ -18,19 +18,23 @@ BMad-Help is more than a lookup tool — it:
|
|
|
18
18
|
|
|
19
19
|
### How to Use BMad-Help
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Call it by name in your AI session:
|
|
22
22
|
|
|
23
23
|
```
|
|
24
|
-
|
|
24
|
+
bmad-help
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
:::tip
|
|
28
|
+
You can also use `/bmad-help` or `$bmad-help` depending on your platform, but just `bmad-help` should work everywhere.
|
|
29
|
+
:::
|
|
30
|
+
|
|
31
|
+
Combine it with a natural language query:
|
|
28
32
|
|
|
29
33
|
```
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
+
bmad-help I have a SaaS idea and know all the features. Where do I start?
|
|
35
|
+
bmad-help What are my options for UX design?
|
|
36
|
+
bmad-help I'm stuck on the PRD workflow
|
|
37
|
+
bmad-help Show me what's been done so far
|
|
34
38
|
```
|
|
35
39
|
|
|
36
40
|
BMad-Help responds with:
|
|
@@ -29,6 +29,15 @@ If you want to use a non interactive installer and provide all install options o
|
|
|
29
29
|
npx bmad-method install
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
+
:::tip[Want the newest prerelease build?]
|
|
33
|
+
Use the `next` dist-tag:
|
|
34
|
+
```bash
|
|
35
|
+
npx bmad-method@next install
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This gets you newer changes earlier, with a higher chance of churn than the default install.
|
|
39
|
+
:::
|
|
40
|
+
|
|
32
41
|
:::tip[Bleeding edge]
|
|
33
42
|
To install the latest from the main branch (may be unstable):
|
|
34
43
|
```bash
|
|
@@ -95,11 +95,11 @@ TEA also supports P0-P3 risk-based prioritization and optional integrations with
|
|
|
95
95
|
|
|
96
96
|
## How Testing Fits into Workflows
|
|
97
97
|
|
|
98
|
-
Quinn's Automate workflow appears in Phase 4 (Implementation) of the BMad Method workflow map. A typical sequence:
|
|
98
|
+
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:
|
|
99
99
|
|
|
100
|
-
1.
|
|
101
|
-
2.
|
|
102
|
-
3.
|
|
100
|
+
1. For each story in the epic: implement with Dev (`DS`), then validate with Code Review (`CR`)
|
|
101
|
+
2. After the epic is complete: generate tests with Quinn (`QA`) or TEA's Automate workflow
|
|
102
|
+
3. Run retrospective (`bmad-retrospective`) to capture lessons learned
|
|
103
103
|
|
|
104
104
|
Quinn works directly from source code without loading planning documents (PRD, architecture). TEA workflows can integrate with upstream planning artifacts for traceability.
|
|
105
105
|
|
|
@@ -22,7 +22,7 @@ Build software faster using AI-powered workflows with specialized agents that gu
|
|
|
22
22
|
|
|
23
23
|
:::tip[The Easiest Path]
|
|
24
24
|
**Install** → `npx bmad-method install`
|
|
25
|
-
**Ask** →
|
|
25
|
+
**Ask** → `bmad-help what should I do first?`
|
|
26
26
|
**Build** → Let BMad-Help guide you workflow by workflow
|
|
27
27
|
:::
|
|
28
28
|
|
|
@@ -59,7 +59,7 @@ BMad-Help will respond with:
|
|
|
59
59
|
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.
|
|
60
60
|
|
|
61
61
|
:::tip[Start Here]
|
|
62
|
-
After installing BMad,
|
|
62
|
+
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.
|
|
63
63
|
:::
|
|
64
64
|
|
|
65
65
|
## Understanding BMad
|
|
@@ -95,6 +95,8 @@ Open a terminal in your project directory and run:
|
|
|
95
95
|
npx bmad-method install
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
+
If you want the newest prerelease build instead of the default release channel, use `npx bmad-method@next install`.
|
|
99
|
+
|
|
98
100
|
When prompted to select modules, choose **BMad Method**.
|
|
99
101
|
|
|
100
102
|
The installer creates two folders:
|
|
@@ -105,14 +107,14 @@ The installer creates two folders:
|
|
|
105
107
|
Open your AI IDE in the project folder and run:
|
|
106
108
|
|
|
107
109
|
```
|
|
108
|
-
|
|
110
|
+
bmad-help
|
|
109
111
|
```
|
|
110
112
|
|
|
111
113
|
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?"
|
|
112
114
|
:::
|
|
113
115
|
|
|
114
116
|
:::note[How to Load Agents and Run Workflows]
|
|
115
|
-
Each workflow has a **skill** you invoke in your IDE (e.g.,
|
|
117
|
+
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).
|
|
116
118
|
:::
|
|
117
119
|
|
|
118
120
|
:::caution[Fresh Chats]
|
|
@@ -126,35 +128,35 @@ Work through phases 1-3. **Use fresh chats for each workflow.**
|
|
|
126
128
|
:::tip[Project Context (Optional)]
|
|
127
129
|
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.
|
|
128
130
|
|
|
129
|
-
Create it manually at `_bmad-output/project-context.md` or generate it after architecture using
|
|
131
|
+
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).
|
|
130
132
|
:::
|
|
131
133
|
|
|
132
134
|
### Phase 1: Analysis (Optional)
|
|
133
135
|
|
|
134
136
|
All workflows in this phase are optional:
|
|
135
|
-
- **brainstorming** (
|
|
136
|
-
- **research** (
|
|
137
|
-
- **create-product-brief** (
|
|
137
|
+
- **brainstorming** (`bmad-brainstorming`) — Guided ideation
|
|
138
|
+
- **research** (`bmad-research`) — Market and technical research
|
|
139
|
+
- **create-product-brief** (`bmad-create-product-brief`) — Recommended foundation document
|
|
138
140
|
|
|
139
141
|
### Phase 2: Planning (Required)
|
|
140
142
|
|
|
141
143
|
**For BMad Method and Enterprise tracks:**
|
|
142
|
-
1. Invoke the **PM agent** (
|
|
143
|
-
2. Run the `bmad-create-prd` workflow (
|
|
144
|
+
1. Invoke the **PM agent** (`bmad-pm`) in a new chat
|
|
145
|
+
2. Run the `bmad-create-prd` workflow (`bmad-create-prd`)
|
|
144
146
|
3. Output: `PRD.md`
|
|
145
147
|
|
|
146
148
|
**For Quick Flow track:**
|
|
147
|
-
- Use the `bmad-quick-spec` workflow (
|
|
149
|
+
- Use the `bmad-quick-spec` workflow (`bmad-quick-spec`) instead of PRD, then skip to implementation
|
|
148
150
|
|
|
149
151
|
:::note[UX Design (Optional)]
|
|
150
|
-
If your project has a user interface, invoke the **UX-Designer agent** (
|
|
152
|
+
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.
|
|
151
153
|
:::
|
|
152
154
|
|
|
153
155
|
### Phase 3: Solutioning (BMad Method/Enterprise)
|
|
154
156
|
|
|
155
157
|
**Create Architecture**
|
|
156
|
-
1. Invoke the **Architect agent** (
|
|
157
|
-
2. Run `bmad-create-architecture` (
|
|
158
|
+
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat
|
|
159
|
+
2. Run `bmad-create-architecture` (`bmad-create-architecture`)
|
|
158
160
|
3. Output: Architecture document with technical decisions
|
|
159
161
|
|
|
160
162
|
**Create Epics and Stories**
|
|
@@ -163,13 +165,13 @@ If your project has a user interface, invoke the **UX-Designer agent** (`/bmad-u
|
|
|
163
165
|
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.
|
|
164
166
|
:::
|
|
165
167
|
|
|
166
|
-
1. Invoke the **PM agent** (
|
|
167
|
-
2. Run `bmad-create-epics-and-stories` (
|
|
168
|
+
1. Invoke the **PM agent** (`bmad-pm`) in a new chat
|
|
169
|
+
2. Run `bmad-create-epics-and-stories` (`bmad-create-epics-and-stories`)
|
|
168
170
|
3. The workflow uses both PRD and Architecture to create technically-informed stories
|
|
169
171
|
|
|
170
172
|
**Implementation Readiness Check** *(Highly Recommended)*
|
|
171
|
-
1. Invoke the **Architect agent** (
|
|
172
|
-
2. Run `bmad-check-implementation-readiness` (
|
|
173
|
+
1. Invoke the **Architect agent** (`bmad-architect`) in a new chat
|
|
174
|
+
2. Run `bmad-check-implementation-readiness` (`bmad-check-implementation-readiness`)
|
|
173
175
|
3. Validates cohesion across all planning documents
|
|
174
176
|
|
|
175
177
|
## Step 2: Build Your Project
|
|
@@ -178,7 +180,7 @@ Once planning is complete, move to implementation. **Each workflow should run in
|
|
|
178
180
|
|
|
179
181
|
### Initialize Sprint Planning
|
|
180
182
|
|
|
181
|
-
Invoke the **SM agent** (
|
|
183
|
+
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.
|
|
182
184
|
|
|
183
185
|
### The Build Cycle
|
|
184
186
|
|
|
@@ -186,11 +188,11 @@ For each story, repeat this cycle with fresh chats:
|
|
|
186
188
|
|
|
187
189
|
| Step | Agent | Workflow | Command | Purpose |
|
|
188
190
|
| ---- | ----- | -------------- | -------------------------- | ---------------------------------- |
|
|
189
|
-
| 1 | SM | `bmad-create-story` |
|
|
190
|
-
| 2 | DEV | `bmad-dev-story` |
|
|
191
|
-
| 3 | DEV | `bmad-code-review` |
|
|
191
|
+
| 1 | SM | `bmad-create-story` | `bmad-create-story` | Create story file from epic |
|
|
192
|
+
| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | Implement the story |
|
|
193
|
+
| 3 | DEV | `bmad-code-review` | `bmad-code-review` | Quality validation *(recommended)* |
|
|
192
194
|
|
|
193
|
-
After completing all stories in an epic, invoke the **SM agent** (
|
|
195
|
+
After completing all stories in an epic, invoke the **SM agent** (`bmad-sm`) and run `bmad-retrospective` (`bmad-retrospective`).
|
|
194
196
|
|
|
195
197
|
## What You've Accomplished
|
|
196
198
|
|
|
@@ -221,16 +223,16 @@ your-project/
|
|
|
221
223
|
|
|
222
224
|
| Workflow | Command | Agent | Purpose |
|
|
223
225
|
| ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- |
|
|
224
|
-
| **`bmad-help`** ⭐ |
|
|
225
|
-
| `bmad-create-prd` |
|
|
226
|
-
| `bmad-create-architecture` |
|
|
227
|
-
| `bmad-generate-project-context` |
|
|
228
|
-
| `bmad-create-epics-and-stories` |
|
|
229
|
-
| `bmad-check-implementation-readiness` |
|
|
230
|
-
| `bmad-sprint-planning` |
|
|
231
|
-
| `bmad-create-story` |
|
|
232
|
-
| `bmad-dev-story` |
|
|
233
|
-
| `bmad-code-review` |
|
|
226
|
+
| **`bmad-help`** ⭐ | `bmad-help` | Any | **Your intelligent guide — ask anything!** |
|
|
227
|
+
| `bmad-create-prd` | `bmad-create-prd` | PM | Create Product Requirements Document |
|
|
228
|
+
| `bmad-create-architecture` | `bmad-create-architecture` | Architect | Create architecture document |
|
|
229
|
+
| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | Create project context file |
|
|
230
|
+
| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | Break down PRD into epics |
|
|
231
|
+
| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | Validate planning cohesion |
|
|
232
|
+
| `bmad-sprint-planning` | `bmad-sprint-planning` | SM | Initialize sprint tracking |
|
|
233
|
+
| `bmad-create-story` | `bmad-create-story` | SM | Create a story file |
|
|
234
|
+
| `bmad-dev-story` | `bmad-dev-story` | DEV | Implement a story |
|
|
235
|
+
| `bmad-code-review` | `bmad-code-review` | DEV | Review implemented code |
|
|
234
236
|
|
|
235
237
|
## Common Questions
|
|
236
238
|
|
|
@@ -238,10 +240,10 @@ your-project/
|
|
|
238
240
|
Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.
|
|
239
241
|
|
|
240
242
|
**Can I change my plan later?**
|
|
241
|
-
Yes. The SM agent has a `bmad-correct-course` workflow (
|
|
243
|
+
Yes. The SM agent has a `bmad-correct-course` workflow (`bmad-correct-course`) for handling scope changes.
|
|
242
244
|
|
|
243
245
|
**What if I want to brainstorm first?**
|
|
244
|
-
Invoke the Analyst agent (
|
|
246
|
+
Invoke the Analyst agent (`bmad-analyst`) and run `bmad-brainstorming` (`bmad-brainstorming`) before starting your PRD.
|
|
245
247
|
|
|
246
248
|
**Do I need to follow a strict order?**
|
|
247
249
|
Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.
|
|
@@ -249,7 +251,7 @@ Not strictly. Once you learn the flow, you can run workflows directly using the
|
|
|
249
251
|
## Getting Help
|
|
250
252
|
|
|
251
253
|
:::tip[First Stop: BMad-Help]
|
|
252
|
-
**
|
|
254
|
+
**Invoke `bmad-help` anytime** — it's the fastest way to get unstuck. Ask it anything:
|
|
253
255
|
- "What should I do after installing?"
|
|
254
256
|
- "I'm stuck on workflow X"
|
|
255
257
|
- "What are my options for Y?"
|
|
@@ -264,10 +266,10 @@ BMad-Help inspects your project, detects what you've completed, and tells you ex
|
|
|
264
266
|
## Key Takeaways
|
|
265
267
|
|
|
266
268
|
:::tip[Remember These]
|
|
267
|
-
- **Start with
|
|
269
|
+
- **Start with `bmad-help`** — Your intelligent guide that knows your project and options
|
|
268
270
|
- **Always use fresh chats** — Start a new chat for each workflow
|
|
269
271
|
- **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture
|
|
270
272
|
- **BMad-Help runs automatically** — Every workflow ends with guidance on what's next
|
|
271
273
|
:::
|
|
272
274
|
|
|
273
|
-
Ready to start? Install BMad,
|
|
275
|
+
Ready to start? Install BMad, invoke `bmad-help`, and let your intelligent guide lead the way.
|
|
@@ -61,16 +61,16 @@ sidebar:
|
|
|
61
61
|
|
|
62
62
|
### BMad-Help:你的起点
|
|
63
63
|
|
|
64
|
-
**随时运行
|
|
64
|
+
**随时运行 `bmad-help`,当你不确定下一步该做什么时。** 这个智能指南:
|
|
65
65
|
|
|
66
66
|
- 检查你的项目以查看已经完成了什么
|
|
67
67
|
- 根据你安装的模块显示选项
|
|
68
68
|
- 理解自然语言查询
|
|
69
69
|
|
|
70
70
|
```
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
71
|
+
bmad-help 我有一个现有的 Rails 应用,我应该从哪里开始?
|
|
72
|
+
bmad-help quick-flow 和完整方法有什么区别?
|
|
73
|
+
bmad-help 显示我有哪些可用的工作流程
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
BMad-Help 还会在**每个工作流程结束时自动运行**,提供关于下一步该做什么的清晰指导。
|
|
@@ -7,7 +7,7 @@ sidebar:
|
|
|
7
7
|
|
|
8
8
|
## 从这里开始:BMad-Help
|
|
9
9
|
|
|
10
|
-
**获取关于 BMad 答案的最快方式是
|
|
10
|
+
**获取关于 BMad 答案的最快方式是 `bmad-help`。** 这个智能指南可以回答超过 80% 的问题,并且直接在您的 IDE 中可用,方便您工作时使用。
|
|
11
11
|
|
|
12
12
|
BMad-Help 不仅仅是一个查询工具——它:
|
|
13
13
|
- **检查您的项目**以查看已完成的内容
|
|
@@ -21,16 +21,16 @@ BMad-Help 不仅仅是一个查询工具——它:
|
|
|
21
21
|
只需使用斜杠命令运行它:
|
|
22
22
|
|
|
23
23
|
```
|
|
24
|
-
|
|
24
|
+
bmad-help
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
或者结合自然语言查询:
|
|
28
28
|
|
|
29
29
|
```
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
30
|
+
bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始?
|
|
31
|
+
bmad-help 我在 UX 设计方面有哪些选择?
|
|
32
|
+
bmad-help 我在 PRD 工作流上卡住了
|
|
33
|
+
bmad-help 向我展示到目前为止已完成的内容
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
BMad-Help 会回应:
|
|
@@ -77,7 +77,7 @@ your-project/
|
|
|
77
77
|
|
|
78
78
|
## 验证安装
|
|
79
79
|
|
|
80
|
-
运行
|
|
80
|
+
运行 `bmad-help` 来验证一切正常并查看下一步操作。
|
|
81
81
|
|
|
82
82
|
**BMad-Help 是你的智能向导**,它会:
|
|
83
83
|
- 确认你的安装正常工作
|
|
@@ -86,8 +86,8 @@ your-project/
|
|
|
86
86
|
|
|
87
87
|
你也可以向它提问:
|
|
88
88
|
```
|
|
89
|
-
|
|
90
|
-
|
|
89
|
+
bmad-help 我刚安装完成,应该先做什么?
|
|
90
|
+
bmad-help 对于 SaaS 项目我有哪些选项?
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
## 故障排除
|
package/docs/zh-cn/index.md
CHANGED
|
@@ -19,7 +19,7 @@ BMad 方法(**B**reakthrough **M**ethod of **A**gile AI **D**riven Development
|
|
|
19
19
|
- **[工作流地图](./reference/workflow-map.md)** — BMM 阶段、工作流和上下文管理的可视化概览
|
|
20
20
|
|
|
21
21
|
:::tip[只想直接上手?]
|
|
22
|
-
安装 BMad 并运行
|
|
22
|
+
安装 BMad 并运行 `bmad-help` — 它会根据您的项目和已安装的模块引导您完成所有操作。
|
|
23
23
|
:::
|
|
24
24
|
|
|
25
25
|
## 如何使用本文档
|