bmad-method 6.0.3 → 6.0.5-next.0
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/.augment/code_review_guidelines.yaml +2 -42
- package/.claude/skills/bmad-os-findings-triage/SKILL.md +6 -0
- package/.claude/skills/bmad-os-findings-triage/prompts/agent-prompt.md +104 -0
- package/.claude/skills/bmad-os-findings-triage/prompts/instructions.md +286 -0
- package/.claude/skills/bmad-os-review-pr/SKILL.md +1 -1
- package/.claude/skills/bmad-os-review-pr/prompts/instructions.md +63 -6
- package/.claude/skills/bmad-os-review-prompt/SKILL.md +177 -0
- package/.claude/skills/bmad-os-root-cause-analysis/SKILL.md +12 -0
- package/.claude/skills/bmad-os-root-cause-analysis/prompts/instructions.md +74 -0
- package/.github/ISSUE_TEMPLATE/config.yaml +1 -1
- package/.github/ISSUE_TEMPLATE/documentation.yaml +1 -1
- package/.github/workflows/publish.yaml +243 -0
- package/CHANGELOG.md +32 -0
- package/CONTRIBUTING.md +1 -1
- package/README.md +8 -8
- package/README_CN.md +121 -0
- package/docs/_STYLE_GUIDE.md +10 -10
- package/docs/explanation/brainstorming.md +1 -1
- package/docs/explanation/party-mode.md +1 -1
- package/docs/explanation/preventing-agent-conflicts.md +1 -1
- package/docs/explanation/project-context.md +15 -15
- package/docs/explanation/quick-flow.md +9 -9
- package/docs/how-to/established-projects.md +7 -7
- package/docs/how-to/get-answers-about-bmad.md +2 -2
- package/docs/how-to/install-bmad.md +16 -6
- package/docs/how-to/project-context.md +2 -2
- package/docs/how-to/quick-fixes.md +5 -5
- package/docs/how-to/shard-large-documents.md +1 -1
- package/docs/how-to/upgrade-to-v6.md +8 -5
- package/docs/index.md +2 -2
- package/docs/reference/agents.md +14 -14
- package/docs/reference/commands.md +64 -70
- package/docs/reference/testing.md +1 -1
- package/docs/reference/workflow-map.md +19 -19
- package/docs/tutorials/getting-started.md +34 -34
- package/docs/zh-cn/404.md +9 -0
- package/docs/zh-cn/_STYLE_GUIDE.md +370 -0
- package/docs/zh-cn/explanation/advanced-elicitation.md +62 -0
- package/docs/zh-cn/explanation/adversarial-review.md +71 -0
- package/docs/zh-cn/explanation/brainstorming.md +43 -0
- package/docs/zh-cn/explanation/established-projects-faq.md +60 -0
- package/docs/zh-cn/explanation/party-mode.md +79 -0
- package/docs/zh-cn/explanation/preventing-agent-conflicts.md +137 -0
- package/docs/zh-cn/explanation/project-context.md +176 -0
- package/docs/zh-cn/explanation/quick-flow.md +93 -0
- package/docs/zh-cn/explanation/why-solutioning-matters.md +90 -0
- package/docs/zh-cn/how-to/customize-bmad.md +182 -0
- package/docs/zh-cn/how-to/established-projects.md +134 -0
- package/docs/zh-cn/how-to/get-answers-about-bmad.md +144 -0
- package/docs/zh-cn/how-to/install-bmad.md +105 -0
- package/docs/zh-cn/how-to/non-interactive-installation.md +181 -0
- package/docs/zh-cn/how-to/project-context.md +152 -0
- package/docs/zh-cn/how-to/quick-fixes.md +140 -0
- package/docs/zh-cn/how-to/shard-large-documents.md +86 -0
- package/docs/zh-cn/how-to/upgrade-to-v6.md +120 -0
- package/docs/zh-cn/index.md +69 -0
- package/docs/zh-cn/reference/agents.md +41 -0
- package/docs/zh-cn/reference/commands.md +166 -0
- package/docs/zh-cn/reference/modules.md +94 -0
- package/docs/zh-cn/reference/testing.md +122 -0
- package/docs/zh-cn/reference/workflow-map.md +104 -0
- package/docs/zh-cn/roadmap.mdx +152 -0
- package/docs/zh-cn/tutorials/getting-started.md +300 -0
- package/package.json +1 -1
- package/src/bmm/agents/analyst.agent.yaml +1 -1
- package/src/bmm/agents/bmad-skill-manifest.yaml +39 -0
- package/src/bmm/agents/dev.agent.yaml +2 -2
- package/src/bmm/agents/pm.agent.yaml +1 -1
- package/src/bmm/agents/qa.agent.yaml +1 -1
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +6 -2
- package/src/bmm/agents/sm.agent.yaml +4 -4
- package/src/bmm/agents/tech-writer/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +1 -1
- package/src/bmm/module-help.csv +11 -10
- package/src/bmm/workflows/1-analysis/create-product-brief/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
- package/src/bmm/workflows/1-analysis/research/bmad-skill-manifest.yaml +14 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/bmad-skill-manifest.yaml +14 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-architecture/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +2 -2
- package/src/bmm/workflows/4-implementation/code-review/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/code-review/discover-inputs.md +88 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.md +271 -0
- package/src/bmm/workflows/4-implementation/correct-course/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
- package/src/bmm/workflows/4-implementation/correct-course/{instructions.md → workflow.md} +79 -12
- package/src/bmm/workflows/4-implementation/create-story/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +9 -10
- package/src/bmm/workflows/4-implementation/create-story/discover-inputs.md +88 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.md +388 -0
- package/src/bmm/workflows/4-implementation/dev-story/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/dev-story/{instructions.xml → workflow.md} +49 -2
- package/src/bmm/workflows/4-implementation/retrospective/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/retrospective/{instructions.md → workflow.md} +64 -23
- package/src/bmm/workflows/4-implementation/sprint-planning/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +1 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/{instructions.md → workflow.md} +55 -10
- package/src/bmm/workflows/4-implementation/sprint-status/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/4-implementation/sprint-status/{instructions.md → workflow.md} +45 -8
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/SKILL.md +6 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/bmad-skill-manifest.yaml +1 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-01-clarify-and-route.md +54 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-02-plan.md +39 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-03-implement.md +35 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-04-review.md +55 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/steps/step-05-present.md +19 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/tech-spec-template.md +90 -0
- package/src/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/workflow.md +84 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +8 -14
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +4 -6
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +1 -1
- package/src/bmm/workflows/document-project/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/document-project/instructions.md +5 -7
- package/src/bmm/workflows/document-project/workflow.md +39 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +0 -1
- package/src/bmm/workflows/document-project/workflows/deep-dive-workflow.md +42 -0
- package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +0 -1
- package/src/bmm/workflows/document-project/workflows/full-scan-workflow.md +42 -0
- package/src/bmm/workflows/generate-project-context/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
- package/src/bmm/workflows/qa-generate-e2e-tests/bmad-skill-manifest.yaml +3 -0
- package/src/bmm/workflows/qa-generate-e2e-tests/checklist.md +1 -1
- package/src/bmm/workflows/qa-generate-e2e-tests/{instructions.md → workflow.md} +40 -7
- package/src/core/agents/bmad-master.agent.yaml +1 -1
- package/src/core/agents/bmad-skill-manifest.yaml +3 -0
- package/src/core/module-help.csv +3 -2
- package/src/core/module.yaml +1 -1
- package/src/core/tasks/bmad-help/SKILL.md +6 -0
- package/src/core/tasks/bmad-help/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/{help.md → bmad-help/workflow.md} +6 -4
- package/src/core/tasks/bmad-review-adversarial-general/SKILL.md +6 -0
- package/src/core/tasks/bmad-review-adversarial-general/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-review-adversarial-general/workflow.md +32 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/SKILL.md +6 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/bmad-skill-manifest.yaml +1 -0
- package/src/core/tasks/bmad-review-edge-case-hunter/workflow.md +62 -0
- package/src/core/tasks/bmad-skill-manifest.yaml +19 -0
- package/src/core/workflows/advanced-elicitation/bmad-skill-manifest.yaml +3 -0
- package/src/core/workflows/advanced-elicitation/workflow.md +138 -0
- package/src/core/workflows/brainstorming/bmad-skill-manifest.yaml +3 -0
- package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +31 -18
- package/src/core/workflows/brainstorming/steps/step-01b-continue.md +1 -1
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +3 -3
- package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +2 -2
- package/src/core/workflows/brainstorming/workflow.md +5 -3
- package/src/core/workflows/party-mode/bmad-skill-manifest.yaml +3 -0
- package/src/core/workflows/party-mode/workflow.md +1 -1
- package/src/utility/agent-components/activation-steps.txt +2 -2
- package/src/utility/agent-components/handler-multi.txt +1 -2
- package/test/adversarial-review-tests/README.md +3 -3
- package/test/adversarial-review-tests/test-cases.yaml +2 -2
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +1 -1
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +1 -1
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +1 -2
- package/test/fixtures/file-refs-csv/valid/bmm-style.csv +1 -1
- package/test/test-file-refs-csv.js +1 -1
- package/test/test-install-to-bmad.js +154 -0
- package/test/test-installation-components.js +1586 -2
- package/test/test-workflow-path-regex.js +88 -0
- package/tools/cli/installers/install-messages.yaml +1 -1
- package/tools/cli/installers/lib/core/installer.js +34 -1
- package/tools/cli/installers/lib/core/manifest-generator.js +332 -41
- package/tools/cli/installers/lib/ide/_base-ide.js +24 -15
- package/tools/cli/installers/lib/ide/_config-driven.js +547 -53
- package/tools/cli/installers/lib/ide/manager.js +26 -62
- package/tools/cli/installers/lib/ide/platform-codes.yaml +116 -29
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +1 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +7 -0
- package/tools/cli/installers/lib/ide/shared/path-utils.js +68 -3
- package/tools/cli/installers/lib/ide/shared/skill-manifest.js +90 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +2 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +6 -145
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +1 -1
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +1 -1
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml +1 -1
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml +1 -1
- package/tools/cli/installers/lib/ide/templates/combined/opencode-agent.md +1 -1
- package/tools/cli/installers/lib/ide/templates/combined/opencode-task.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/opencode-tool.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md +0 -1
- package/tools/cli/installers/lib/modules/manager.js +9 -132
- package/tools/cli/lib/agent/compiler.js +1 -10
- package/tools/cli/lib/agent-analyzer.js +2 -14
- package/tools/cli/lib/yaml-xml-builder.js +1 -18
- package/tools/docs/native-skills-migration-checklist.md +281 -0
- package/tools/platform-codes.yaml +1 -1
- package/tools/schema/agent.js +1 -3
- package/tools/validate-file-refs.js +2 -0
- package/website/astro.config.mjs +24 -3
- package/website/src/content/config.ts +2 -1
- package/website/src/content/i18n/zh-CN.json +28 -0
- package/src/bmm/workflows/4-implementation/code-review/instructions.xml +0 -227
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +0 -43
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +0 -53
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +0 -346
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +0 -52
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +0 -20
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +0 -52
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +0 -47
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +0 -25
- package/src/bmm/workflows/document-project/workflow.yaml +0 -22
- package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +0 -31
- package/src/bmm/workflows/document-project/workflows/full-scan.yaml +0 -31
- package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +0 -42
- package/src/core/tasks/review-adversarial-general.xml +0 -49
- package/src/core/tasks/workflow.xml +0 -235
- package/src/core/workflows/advanced-elicitation/workflow.xml +0 -118
- package/src/utility/agent-components/handler-validate-workflow.txt +0 -7
- package/src/utility/agent-components/handler-workflow.txt +0 -10
- package/tools/cli/installers/lib/ide/codex.js +0 -440
- package/tools/cli/installers/lib/ide/github-copilot.js +0 -699
- package/tools/cli/installers/lib/ide/kilo.js +0 -269
- package/tools/cli/installers/lib/ide/rovodev.js +0 -257
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +0 -14
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +0 -15
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +0 -13
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +0 -5
package/README_CN.md
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+

|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/bmad-method)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](https://nodejs.org)
|
|
6
|
+
[](https://discord.gg/gk8jAdXWmj)
|
|
7
|
+
|
|
8
|
+
**突破性敏捷 AI 驱动开发方法** — 简称 “BMAD 方法论” ,BMAD方法论是由多个模块生态构成的AI驱动敏捷开发模块系统,这是最佳且最全面的敏捷 AI 驱动开发框架,具备真正的规模自适应人工智能,可适应快速开发,适应企业规模化开发。
|
|
9
|
+
|
|
10
|
+
**100% 免费且开源。** 无付费。无内容门槛。无封闭 Discord。我们赋能每个人,我们将为全球现在在人工智能领域发展的普通人提供公平的学习机会。
|
|
11
|
+
|
|
12
|
+
## 为什么选择 BMad 方法?
|
|
13
|
+
|
|
14
|
+
传统 AI 工具替你思考,产生平庸的结果。BMad 智能体和辅助工作流充当专家协作者,引导你通过结构化流程,与 AI 的合作发挥最佳思维,产出最有效优秀的结果。
|
|
15
|
+
|
|
16
|
+
- **AI 智能帮助** — 随时使用 `/bmad-help` 获取下一步指导
|
|
17
|
+
- **规模-领域自适应** — 根据项目复杂度自动调整规划深度
|
|
18
|
+
- **结构化工作流** — 基于分析、规划、架构和实施的敏捷最佳实践
|
|
19
|
+
- **专业智能体** — 12+ 领域专家(PM、架构师、开发者、UX、Scrum Master 等)
|
|
20
|
+
- **派对模式** — 将多个智能体角色带入一个会话进行协作和讨论
|
|
21
|
+
- **完整生命周期** — 从想法开始(头脑风暴)到部署发布
|
|
22
|
+
|
|
23
|
+
[在 **docs.bmad-method.org** 了解更多](http://docs.bmad-method.org)
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 🚀 BMad 的下一步是什么?
|
|
28
|
+
|
|
29
|
+
**V6 已到来,我们才刚刚开始!** BMad 方法正在快速发展,包括跨平台智能体团队和子智能体集成、技能架构、BMad Builder v1、开发循环自动化等优化,以及更多正在开发中的功能。
|
|
30
|
+
|
|
31
|
+
**[📍 查看完整路线图 →](http://docs.bmad-method.org/roadmap/)**
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 快速开始
|
|
36
|
+
|
|
37
|
+
**先决条件**:[Node.js](https://nodejs.org) v20+
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx bmad-method install
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
> 如果你获得的是过时的测试版,请使用:`npx bmad-method@6.0.1 install`
|
|
44
|
+
|
|
45
|
+
按照安装程序提示操作,然后在项目文件夹中打开你的 AI IDE(Claude Code、Cursor 等)。
|
|
46
|
+
|
|
47
|
+
**非交互式安装**(用于 CI/CD):
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
[查看所有安装选项](http://docs.bmad-method.org/how-to/non-interactive-installation/)
|
|
54
|
+
|
|
55
|
+
> **不确定该做什么?** 运行 `/bmad-help` — 它会准确告诉你下一步做什么以及什么是可选的。你也可以问诸如 `/bmad-help 我刚刚完成了架构设计,接下来该做什么?` 之类的问题。
|
|
56
|
+
|
|
57
|
+
## 模块
|
|
58
|
+
|
|
59
|
+
BMad 方法通过官方模块扩展到专业领域。可在安装期间或之后的任何时间使用。
|
|
60
|
+
|
|
61
|
+
| Module | Purpose |
|
|
62
|
+
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
63
|
+
| **[BMad Method (BMM)](https://github.com/bmad-code-org/BMAD-METHOD)** | 包含 34+ 工作流的核心框架 |
|
|
64
|
+
| **[BMad Builder (BMB)](https://github.com/bmad-code-org/bmad-builder)** | 创建自定义 BMad 智能体和工作流 |
|
|
65
|
+
| **[Test Architect (TEA)](https://github.com/bmad-code-org/tea)** | 基于风险的测试策略和自动化 |
|
|
66
|
+
| **[Game Dev Studio (BMGD)](https://github.com/bmad-code-org/bmad-module-game-dev-studio)** | 游戏开发工作流(Unity、Unreal、Godot) |
|
|
67
|
+
| **[Creative Intelligence Suite (CIS)](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)** | 创新、头脑风暴、设计思维 |
|
|
68
|
+
|
|
69
|
+
## 文档
|
|
70
|
+
|
|
71
|
+
[BMad 方法文档站点](http://docs.bmad-method.org) — 教程、指南、概念和参考
|
|
72
|
+
|
|
73
|
+
**快速链接:**
|
|
74
|
+
- [入门教程](http://docs.bmad-method.org/tutorials/getting-started/)
|
|
75
|
+
- [从先前版本升级](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
|
76
|
+
- [测试架构师文档](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## 社区
|
|
80
|
+
|
|
81
|
+
- [Discord](https://discord.gg/gk8jAdXWmj) — 获取帮助、分享想法、协作
|
|
82
|
+
- [在 YouTube 上订阅](https://www.youtube.com/@BMadCode) — 教程、大师课和播客(2025 年 2 月推出)
|
|
83
|
+
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — 错误报告和功能请求
|
|
84
|
+
- [讨论](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — 社区对话
|
|
85
|
+
|
|
86
|
+
## 支持 BMad
|
|
87
|
+
|
|
88
|
+
BMad 对每个人都是免费的 — 并且永远如此。如果你想支持开发:
|
|
89
|
+
|
|
90
|
+
- ⭐ 请点击此页面右上角附近的项目星标图标
|
|
91
|
+
- ☕ [请我喝咖啡](https://buymeacoffee.com/bmad) — 为开发提供动力
|
|
92
|
+
- 🏢 企业赞助 — 在 Discord 上私信
|
|
93
|
+
- 🎤 演讲与媒体 — 可参加会议、播客、采访(在 Discord 上联系 BM)
|
|
94
|
+
|
|
95
|
+
## 贡献
|
|
96
|
+
|
|
97
|
+
我们欢迎贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解指南。
|
|
98
|
+
|
|
99
|
+
## 许可证
|
|
100
|
+
|
|
101
|
+
MIT 许可证 — 详见 [LICENSE](LICENSE)。
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
**BMad** 和 **BMAD-METHOD** 是 BMad Code, LLC 的商标。详见 [TRADEMARK.md](TRADEMARK.md)。
|
|
106
|
+
|
|
107
|
+
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
|
108
|
+
|
|
109
|
+
请参阅 [CONTRIBUTORS.md](CONTRIBUTORS.md) 了解贡献者信息。
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
## 术语说明
|
|
113
|
+
|
|
114
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
115
|
+
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
|
|
116
|
+
- **CI/CD**:持续集成/持续部署。一种自动化软件开发实践,用于频繁集成代码更改并自动部署。
|
|
117
|
+
- **IDE**:集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。
|
|
118
|
+
- **PM**:产品经理。负责产品规划、需求管理和团队协调的角色。
|
|
119
|
+
- **UX**:用户体验。指用户在使用产品或服务过程中的整体感受和交互体验。
|
|
120
|
+
- **Scrum Master**:Scrum 主管。敏捷开发 Scrum 框架中的角色,负责促进团队遵循 Scrum 流程。
|
|
121
|
+
- **PRD**:产品需求文档。详细描述产品功能、需求和规格的文档。
|
package/docs/_STYLE_GUIDE.md
CHANGED
|
@@ -59,13 +59,13 @@ Critical warnings only — data loss, security issues
|
|
|
59
59
|
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
**
|
|
62
|
+
**Skills:**
|
|
63
63
|
|
|
64
64
|
```md
|
|
65
|
-
|
|
|
65
|
+
| Skill | Agent | Purpose |
|
|
66
66
|
| ------------ | ------- | ------------------------------------ |
|
|
67
|
-
| `
|
|
68
|
-
| `prd` | PM | Create Product Requirements Document |
|
|
67
|
+
| `bmad-brainstorming` | Analyst | Brainstorm a new project |
|
|
68
|
+
| `bmad-create-prd` | PM | Create Product Requirements Document |
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
## Folder Structure Blocks
|
|
@@ -99,7 +99,7 @@ your-project/
|
|
|
99
99
|
9. Step 2: [Second Major Task]
|
|
100
100
|
10. Step 3: [Third Major Task]
|
|
101
101
|
11. What You've Accomplished (summary + folder structure)
|
|
102
|
-
12. Quick Reference (
|
|
102
|
+
12. Quick Reference (skills table)
|
|
103
103
|
13. Common Questions (FAQ format)
|
|
104
104
|
14. Getting Help (community links)
|
|
105
105
|
15. Key Takeaways (tip admonition)
|
|
@@ -111,7 +111,7 @@ your-project/
|
|
|
111
111
|
- [ ] "What You'll Learn" section present
|
|
112
112
|
- [ ] Prerequisites in admonition
|
|
113
113
|
- [ ] Quick Path TL;DR admonition at top
|
|
114
|
-
- [ ] Tables for phases,
|
|
114
|
+
- [ ] Tables for phases, skills, agents
|
|
115
115
|
- [ ] "What You've Accomplished" section present
|
|
116
116
|
- [ ] Quick Reference table present
|
|
117
117
|
- [ ] Common Questions section present
|
|
@@ -243,7 +243,7 @@ your-project/
|
|
|
243
243
|
1. Title + Hook
|
|
244
244
|
2. Items (## for each item)
|
|
245
245
|
- Brief description (one sentence)
|
|
246
|
-
- **
|
|
246
|
+
- **Skills:** or **Key Info:** as flat list
|
|
247
247
|
3. Universal/Shared (## section) (optional)
|
|
248
248
|
```
|
|
249
249
|
|
|
@@ -252,7 +252,7 @@ your-project/
|
|
|
252
252
|
```text
|
|
253
253
|
1. Title + Hook (one sentence purpose)
|
|
254
254
|
2. Quick Facts (optional note admonition)
|
|
255
|
-
- Module,
|
|
255
|
+
- Module, Skill, Input, Output as list
|
|
256
256
|
3. Purpose/Overview (## section)
|
|
257
257
|
4. How to Invoke (code block)
|
|
258
258
|
5. Key Sections (## for each aspect)
|
|
@@ -280,7 +280,7 @@ your-project/
|
|
|
280
280
|
- Diagram or table showing organization
|
|
281
281
|
3. Major Sections (## for each phase/category)
|
|
282
282
|
- Items (### for each item)
|
|
283
|
-
- Standardized fields:
|
|
283
|
+
- Standardized fields: Skill, Agent, Input, Output, Description
|
|
284
284
|
4. Next Steps (optional)
|
|
285
285
|
```
|
|
286
286
|
|
|
@@ -353,7 +353,7 @@ Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
|
|
|
353
353
|
|
|
354
354
|
### Can I change my plan later?
|
|
355
355
|
|
|
356
|
-
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
|
|
356
|
+
Yes. The SM agent has a `bmad-correct-course` workflow for handling scope changes.
|
|
357
357
|
|
|
358
358
|
**Have a question not answered here?** [Open an issue](...) or ask in [Discord](...).
|
|
359
359
|
```
|
|
@@ -9,7 +9,7 @@ Unlock your creativity through guided exploration.
|
|
|
9
9
|
|
|
10
10
|
## What is Brainstorming?
|
|
11
11
|
|
|
12
|
-
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.
|
|
12
|
+
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.
|
|
13
13
|
|
|
14
14
|
**Good for:**
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ Get all your AI agents in one conversation.
|
|
|
9
9
|
|
|
10
10
|
## What is Party Mode?
|
|
11
11
|
|
|
12
|
-
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.
|
|
12
|
+
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.
|
|
13
13
|
|
|
14
14
|
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.
|
|
15
15
|
|
|
@@ -108,5 +108,5 @@ Common decisions that prevent conflicts:
|
|
|
108
108
|
- Document decisions that cross epic boundaries
|
|
109
109
|
- Focus on conflict-prone areas
|
|
110
110
|
- Update architecture as you learn
|
|
111
|
-
- Use `correct-course` for significant changes
|
|
111
|
+
- Use `bmad-correct-course` for significant changes
|
|
112
112
|
:::
|
|
@@ -21,12 +21,12 @@ The `project-context.md` file solves this by documenting what agents need to kno
|
|
|
21
21
|
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.
|
|
22
22
|
|
|
23
23
|
**Loaded by these workflows:**
|
|
24
|
-
- `create-architecture` — respects technical preferences during solutioning
|
|
25
|
-
- `create-story` — informs story creation with project patterns
|
|
26
|
-
- `dev-story` — guides implementation decisions
|
|
27
|
-
- `code-review` — validates against project standards
|
|
28
|
-
- `quick-dev` — applies patterns when implementing tech-specs
|
|
29
|
-
- `sprint-planning`, `retrospective`, `correct-course` — provides project-wide context
|
|
24
|
+
- `bmad-create-architecture` — respects technical preferences during solutioning
|
|
25
|
+
- `bmad-create-story` — informs story creation with project patterns
|
|
26
|
+
- `bmad-dev-story` — guides implementation decisions
|
|
27
|
+
- `bmad-code-review` — validates against project standards
|
|
28
|
+
- `bmad-quick-dev` — applies patterns when implementing tech-specs
|
|
29
|
+
- `bmad-sprint-planning`, `bmad-retrospective`, `bmad-correct-course` — provides project-wide context
|
|
30
30
|
|
|
31
31
|
## When to Create It
|
|
32
32
|
|
|
@@ -34,10 +34,10 @@ The `project-context.md` file is useful at any stage of a project:
|
|
|
34
34
|
|
|
35
35
|
| Scenario | When to Create | Purpose |
|
|
36
36
|
|----------|----------------|---------|
|
|
37
|
-
| **New project, before architecture** | Manually, before `create-architecture` | Document your technical preferences so the architect respects them |
|
|
38
|
-
| **New project, after architecture** | Via `generate-project-context` or manually | Capture architecture decisions for implementation agents |
|
|
39
|
-
| **Existing project** | Via `generate-project-context` | Discover existing patterns so agents follow established conventions |
|
|
40
|
-
| **Quick Flow project** | Before or during `quick-dev` | Ensure quick implementation respects your patterns |
|
|
37
|
+
| **New project, before architecture** | Manually, before `bmad-create-architecture` | Document your technical preferences so the architect respects them |
|
|
38
|
+
| **New project, after architecture** | Via `bmad-generate-project-context` or manually | Capture architecture decisions for implementation agents |
|
|
39
|
+
| **Existing project** | Via `bmad-generate-project-context` | Discover existing patterns so agents follow established conventions |
|
|
40
|
+
| **Quick Flow project** | Before or during `bmad-quick-dev` | Ensure quick implementation respects your patterns |
|
|
41
41
|
|
|
42
42
|
:::tip[Recommended]
|
|
43
43
|
For new projects, create it manually before architecture if you have strong technical preferences. Otherwise, generate it after architecture to capture those decisions.
|
|
@@ -107,20 +107,20 @@ Edit it with your technology stack and implementation rules. The architect and i
|
|
|
107
107
|
|
|
108
108
|
### Generate After Architecture
|
|
109
109
|
|
|
110
|
-
Run the `generate-project-context` workflow after completing your architecture:
|
|
110
|
+
Run the `bmad-generate-project-context` workflow after completing your architecture:
|
|
111
111
|
|
|
112
112
|
```bash
|
|
113
|
-
|
|
113
|
+
bmad-generate-project-context
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
This scans your architecture document and project files to generate a context file capturing the decisions made.
|
|
117
117
|
|
|
118
118
|
### Generate for Existing Projects
|
|
119
119
|
|
|
120
|
-
For existing projects, run `generate-project-context` to discover existing patterns:
|
|
120
|
+
For existing projects, run `bmad-generate-project-context` to discover existing patterns:
|
|
121
121
|
|
|
122
122
|
```bash
|
|
123
|
-
|
|
123
|
+
bmad-generate-project-context
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
|
@@ -150,7 +150,7 @@ The `project-context.md` file is a living document. Update it when:
|
|
|
150
150
|
- Patterns evolve during implementation
|
|
151
151
|
- You identify gaps from agent behavior
|
|
152
152
|
|
|
153
|
-
You can edit it manually at any time, or re-run `generate-project-context` to update it after significant changes.
|
|
153
|
+
You can edit it manually at any time, or re-run `bmad-generate-project-context` to update it after significant changes.
|
|
154
154
|
|
|
155
155
|
:::note[File Location]
|
|
156
156
|
The default location is `_bmad-output/project-context.md`. Workflows search for it there, and also check `**/project-context.md` anywhere in your project.
|
|
@@ -5,7 +5,7 @@ sidebar:
|
|
|
5
5
|
order: 1
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
Skip the ceremony. Quick Flow takes you from idea to working code in two
|
|
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
10
|
## When to Use It
|
|
11
11
|
|
|
@@ -23,16 +23,16 @@ Skip the ceremony. Quick Flow takes you from idea to working code in two command
|
|
|
23
23
|
- Anything where requirements are unclear or contested
|
|
24
24
|
|
|
25
25
|
:::caution[Scope Creep]
|
|
26
|
-
If you start a Quick Flow and realize the scope is bigger than expected, `quick-dev` will detect this and offer to escalate. You can switch to a full PRD workflow at any point without losing your work.
|
|
26
|
+
If you start a Quick Flow and realize the scope is bigger than expected, `bmad-quick-dev` will detect this and offer to escalate. You can switch to a full PRD workflow at any point without losing your work.
|
|
27
27
|
:::
|
|
28
28
|
|
|
29
29
|
## How It Works
|
|
30
30
|
|
|
31
|
-
Quick Flow has two
|
|
31
|
+
Quick Flow has two skills, each backed by a structured workflow. You can run them together or independently.
|
|
32
32
|
|
|
33
33
|
### quick-spec: Plan
|
|
34
34
|
|
|
35
|
-
Run `quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
|
|
35
|
+
Run `bmad-quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
|
|
36
36
|
|
|
37
37
|
1. **Understand** - You describe what you want to build. Barry scans the codebase to ask informed questions, then captures a problem statement, solution approach, and scope boundaries.
|
|
38
38
|
2. **Investigate** - Barry reads relevant files, maps code patterns, identifies files to modify, and documents the technical context.
|
|
@@ -43,15 +43,15 @@ The output is a `tech-spec-{slug}.md` file saved to your project's implementatio
|
|
|
43
43
|
|
|
44
44
|
### quick-dev: Build
|
|
45
45
|
|
|
46
|
-
Run `quick-dev` and Barry implements the work. It operates in two modes:
|
|
46
|
+
Run `bmad-quick-dev` and Barry implements the work. It operates in two modes:
|
|
47
47
|
|
|
48
48
|
- **Tech-spec mode** - Point it at a spec file (`quick-dev tech-spec-auth.md`) and it executes every task in order, writes tests, and verifies acceptance criteria.
|
|
49
49
|
- **Direct mode** - Give it instructions directly (`quick-dev "refactor the auth middleware"`) and it gathers context, builds a mental plan, and executes.
|
|
50
50
|
|
|
51
|
-
After implementation, `quick-dev` runs a self-check audit against all tasks and acceptance criteria, then triggers an adversarial code review of the diff. Findings are presented for you to resolve before wrapping up.
|
|
51
|
+
After implementation, `bmad-quick-dev` runs a self-check audit against all tasks and acceptance criteria, then triggers an adversarial code review of the diff. Findings are presented for you to resolve before wrapping up.
|
|
52
52
|
|
|
53
53
|
:::tip[Fresh Context]
|
|
54
|
-
For best results, run `quick-dev` in a new conversation after finishing `quick-spec`. This gives the implementation agent clean context focused solely on building.
|
|
54
|
+
For best results, run `bmad-quick-dev` in a new conversation after finishing `bmad-quick-spec`. This gives the implementation agent clean context focused solely on building.
|
|
55
55
|
:::
|
|
56
56
|
|
|
57
57
|
## What Quick Flow Skips
|
|
@@ -65,9 +65,9 @@ The full BMad Method produces a Product Brief, PRD, Architecture doc, and Epic/S
|
|
|
65
65
|
|
|
66
66
|
## Escalating to Full BMad Method
|
|
67
67
|
|
|
68
|
-
Quick Flow includes built-in guardrails for scope detection. When you run `quick-dev` with a direct request, it evaluates signals like multi-component mentions, system-level language, and uncertainty about approach. If it detects the work is bigger than a quick flow:
|
|
68
|
+
Quick Flow includes built-in guardrails for scope detection. When you run `bmad-quick-dev` with a direct request, it evaluates signals like multi-component mentions, system-level language, and uncertainty about approach. If it detects the work is bigger than a quick flow:
|
|
69
69
|
|
|
70
|
-
- **Light escalation** - Recommends running `quick-spec` first to create a plan
|
|
70
|
+
- **Light escalation** - Recommends running `bmad-quick-spec` first to create a plan
|
|
71
71
|
- **Heavy escalation** - Recommends switching to the full BMad Method PRD process
|
|
72
72
|
|
|
73
73
|
You can also escalate manually at any time. Your tech-spec work carries forward - it becomes input for the broader planning process rather than being discarded.
|
|
@@ -32,7 +32,7 @@ Generate `project-context.md` to capture your existing codebase patterns and con
|
|
|
32
32
|
Run the generate project context workflow:
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
|
|
35
|
+
bmad-generate-project-context
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
This scans your codebase to identify:
|
|
@@ -55,22 +55,22 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
|
|
|
55
55
|
- Architecture
|
|
56
56
|
- Any other relevant project information
|
|
57
57
|
|
|
58
|
-
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.
|
|
58
|
+
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.
|
|
59
59
|
|
|
60
60
|
## Step 3: Get Help
|
|
61
61
|
|
|
62
62
|
### BMad-Help: Your Starting Point
|
|
63
63
|
|
|
64
|
-
**Run
|
|
64
|
+
**Run `bmad-help` anytime you're unsure what to do next.** This intelligent guide:
|
|
65
65
|
|
|
66
66
|
- Inspects your project to see what's already been done
|
|
67
67
|
- Shows options based on your installed modules
|
|
68
68
|
- Understands natural language queries
|
|
69
69
|
|
|
70
70
|
```
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
71
|
+
bmad-help I have an existing Rails app, where should I start?
|
|
72
|
+
bmad-help What's the difference between quick-flow and full method?
|
|
73
|
+
bmad-help Show me what workflows are available
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
BMad-Help also **automatically runs at the end of every workflow**, providing clear guidance on exactly what to do next.
|
|
@@ -81,7 +81,7 @@ You have two primary options depending on the scope of changes:
|
|
|
81
81
|
|
|
82
82
|
| Scope | Recommended Approach |
|
|
83
83
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
84
|
-
| **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. |
|
|
84
|
+
| **Small updates or additions** | Use `bmad-quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill. |
|
|
85
85
|
| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |
|
|
86
86
|
|
|
87
87
|
### During PRD Creation
|
|
@@ -18,7 +18,7 @@ BMad-Help is more than a lookup tool — it:
|
|
|
18
18
|
|
|
19
19
|
### How to Use BMad-Help
|
|
20
20
|
|
|
21
|
-
Run it with just the
|
|
21
|
+
Run it with just the skill name:
|
|
22
22
|
|
|
23
23
|
```
|
|
24
24
|
/bmad-help
|
|
@@ -81,7 +81,7 @@ https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
|
81
81
|
:::note[Example]
|
|
82
82
|
**Q:** "Tell me the fastest way to build something with BMad"
|
|
83
83
|
|
|
84
|
-
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
|
|
84
|
+
**A:** Use Quick Flow: Run `bmad-quick-spec` to write a technical specification, then `bmad-quick-dev` to implement it—skipping the full planning phases.
|
|
85
85
|
:::
|
|
86
86
|
|
|
87
87
|
## What You Get
|
|
@@ -51,7 +51,11 @@ Pick which AI tools you use:
|
|
|
51
51
|
- Cursor
|
|
52
52
|
- Others
|
|
53
53
|
|
|
54
|
-
Each tool has its own way of integrating
|
|
54
|
+
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.
|
|
55
|
+
|
|
56
|
+
:::note[Enabling Skills]
|
|
57
|
+
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.
|
|
58
|
+
:::
|
|
55
59
|
|
|
56
60
|
### 4. Choose Modules
|
|
57
61
|
|
|
@@ -71,13 +75,19 @@ your-project/
|
|
|
71
75
|
│ ├── core/ # Required core module
|
|
72
76
|
│ └── ...
|
|
73
77
|
├── _bmad-output/ # Generated artifacts
|
|
74
|
-
├── .claude/ # Claude Code
|
|
75
|
-
└──
|
|
78
|
+
├── .claude/ # Claude Code skills (if using Claude Code)
|
|
79
|
+
│ └── skills/
|
|
80
|
+
│ ├── bmad-help/
|
|
81
|
+
│ ├── bmad-persona/
|
|
82
|
+
│ └── ...
|
|
83
|
+
└── .cursor/ # Cursor skills (if using Cursor)
|
|
84
|
+
└── skills/
|
|
85
|
+
└── ...
|
|
76
86
|
```
|
|
77
87
|
|
|
78
88
|
## Verify Installation
|
|
79
89
|
|
|
80
|
-
Run
|
|
90
|
+
Run `bmad-help` to verify everything works and see what to do next.
|
|
81
91
|
|
|
82
92
|
**BMad-Help is your intelligent guide** that will:
|
|
83
93
|
- Confirm your installation is working
|
|
@@ -86,8 +96,8 @@ Run `/bmad-help` to verify everything works and see what to do next.
|
|
|
86
96
|
|
|
87
97
|
You can also ask it questions:
|
|
88
98
|
```
|
|
89
|
-
|
|
90
|
-
|
|
99
|
+
bmad-help I just installed, what should I do first?
|
|
100
|
+
bmad-help What are my options for a SaaS project?
|
|
91
101
|
```
|
|
92
102
|
|
|
93
103
|
## Troubleshooting
|
|
@@ -77,7 +77,7 @@ sections_completed: ['technology_stack', 'critical_rules']
|
|
|
77
77
|
Run the workflow in a fresh chat:
|
|
78
78
|
|
|
79
79
|
```bash
|
|
80
|
-
|
|
80
|
+
bmad-generate-project-context
|
|
81
81
|
```
|
|
82
82
|
|
|
83
83
|
The workflow scans your architecture document and project files to generate a context file capturing the decisions made.
|
|
@@ -87,7 +87,7 @@ The workflow scans your architecture document and project files to generate a co
|
|
|
87
87
|
For existing projects, run:
|
|
88
88
|
|
|
89
89
|
```bash
|
|
90
|
-
|
|
90
|
+
bmad-generate-project-context
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
The workflow analyzes your codebase to identify conventions, then generates a context file you can review and refine.
|
|
@@ -30,18 +30,18 @@ If you are unsure, start with the DEV agent. You can always escalate to Quick Fl
|
|
|
30
30
|
|
|
31
31
|
## Steps
|
|
32
32
|
|
|
33
|
-
### 1.
|
|
33
|
+
### 1. Invoke the DEV Agent
|
|
34
34
|
|
|
35
|
-
Start a **fresh chat** in your AI IDE and
|
|
35
|
+
Start a **fresh chat** in your AI IDE and invoke the DEV agent skill:
|
|
36
36
|
|
|
37
37
|
```text
|
|
38
|
-
|
|
38
|
+
bmad-dev
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
This loads the agent's persona and capabilities into the session. If you decide you need Quick Flow instead,
|
|
41
|
+
This loads the agent's persona and capabilities into the session. If you decide you need Quick Flow instead, invoke the **Quick Flow Solo Dev** agent skill in a fresh chat:
|
|
42
42
|
|
|
43
43
|
```text
|
|
44
|
-
|
|
44
|
+
bmad-quick-flow-solo-dev
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Once the Solo Dev agent is loaded, describe your change and ask it to create a **quick-spec**. The agent drafts a lightweight spec capturing what you want to change and how. After you approve the quick-spec, tell the agent to start the **Quick Flow dev cycle** -- it will implement the change, run tests, and perform a self-review, all guided by the spec you just approved.
|
|
@@ -5,7 +5,7 @@ sidebar:
|
|
|
5
5
|
order: 8
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
Use the `shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
|
8
|
+
Use the `bmad-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
|
|
9
9
|
|
|
10
10
|
:::caution[Deprecated]
|
|
11
11
|
This is no longer recommended, and soon with updated workflows and most major LLMs and tools supporting subprocesses this will be unnecessary.
|
|
@@ -33,12 +33,15 @@ When v4 is detected, you can:
|
|
|
33
33
|
|
|
34
34
|
If you named your bmad method folder something else - you will need to manually remove the folder yourself.
|
|
35
35
|
|
|
36
|
-
### 3. Clean Up IDE
|
|
36
|
+
### 3. Clean Up IDE Skills
|
|
37
37
|
|
|
38
|
-
Manually remove legacy v4 IDE commands - for example if you have
|
|
38
|
+
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:
|
|
39
39
|
|
|
40
|
-
- `.claude/commands
|
|
41
|
-
|
|
40
|
+
- `.claude/commands/`
|
|
41
|
+
|
|
42
|
+
The new v6 skills are installed to:
|
|
43
|
+
|
|
44
|
+
- `.claude/skills/`
|
|
42
45
|
|
|
43
46
|
### 4. Migrate Planning Artifacts
|
|
44
47
|
|
|
@@ -58,7 +61,7 @@ If you have stories created or implemented:
|
|
|
58
61
|
|
|
59
62
|
1. Complete the v6 installation
|
|
60
63
|
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
|
|
61
|
-
3. Run the Scrum Master's `sprint-planning` workflow
|
|
64
|
+
3. Run the Scrum Master's `bmad-sprint-planning` workflow
|
|
62
65
|
4. Tell the SM which epics/stories are already complete
|
|
63
66
|
|
|
64
67
|
## What You Get
|
package/docs/index.md
CHANGED
|
@@ -3,7 +3,7 @@ title: Welcome to the BMad Method
|
|
|
3
3
|
description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
The BMad Method (**B**
|
|
6
|
+
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.
|
|
7
7
|
|
|
8
8
|
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
|
|
9
9
|
|
|
@@ -19,7 +19,7 @@ The fastest way to understand BMad is to try it.
|
|
|
19
19
|
- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
|
|
20
20
|
|
|
21
21
|
:::tip[Just Want to Dive In?]
|
|
22
|
-
Install BMad and
|
|
22
|
+
Install BMad and use the `bmad-help` skill — it will guide you through everything based on your project and installed modules.
|
|
23
23
|
:::
|
|
24
24
|
|
|
25
25
|
## How to Use These Docs
|
package/docs/reference/agents.md
CHANGED
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Agents
|
|
3
|
-
description: Default BMM agents with their menu triggers and primary workflows
|
|
3
|
+
description: Default BMM agents with their skill IDs, menu triggers, and primary workflows
|
|
4
4
|
sidebar:
|
|
5
5
|
order: 2
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Default Agents
|
|
9
9
|
|
|
10
|
-
This page lists the default BMM (Agile suite) agents that install with BMad Method, along with their menu triggers and primary workflows.
|
|
10
|
+
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.
|
|
11
11
|
|
|
12
12
|
## Notes
|
|
13
13
|
|
|
14
|
+
- Each agent is available as a skill, generated by the installer. The skill ID (e.g., `bmad-dev`) is used to invoke the agent.
|
|
14
15
|
- Triggers are the short menu codes (e.g., `CP`) and fuzzy matches shown in each agent menu.
|
|
15
|
-
- Slash commands are generated separately. See [Commands](./commands.md) for the slash command list and where they are defined.
|
|
16
16
|
- QA (Quinn) is the lightweight test automation agent in BMM. The full Test Architect (TEA) lives in its own module.
|
|
17
17
|
|
|
18
|
-
| Agent | Triggers | Primary workflows |
|
|
19
|
-
| --------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
-
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
|
21
|
-
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
|
22
|
-
| Architect (Winston) | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
|
23
|
-
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
|
24
|
-
| Developer (Amelia) | `DS`, `CR` | Dev Story, Code Review |
|
|
25
|
-
| QA Engineer (Quinn) | `QA` | Automate (generate tests for existing features) |
|
|
26
|
-
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
|
27
|
-
| UX Designer (Sally) | `CU` | Create UX Design |
|
|
28
|
-
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|
|
18
|
+
| Agent | Skill ID | Triggers | Primary workflows |
|
|
19
|
+
| --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `DP` | Brainstorm Project, Research, Create Brief, Document Project |
|
|
21
|
+
| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Create/Validate/Edit PRD, Create Epics and Stories, Implementation Readiness, Correct Course |
|
|
22
|
+
| Architect (Winston) | `bmad-architect` | `CA`, `IR` | Create Architecture, Implementation Readiness |
|
|
23
|
+
| Scrum Master (Bob) | `bmad-sm` | `SP`, `CS`, `ER`, `CC` | Sprint Planning, Create Story, Epic Retrospective, Correct Course |
|
|
24
|
+
| Developer (Amelia) | `bmad-dev` | `DS`, `CR` | Dev Story, Code Review |
|
|
25
|
+
| QA Engineer (Quinn) | `bmad-qa` | `QA` | Automate (generate tests for existing features) |
|
|
26
|
+
| Quick Flow Solo Dev (Barry) | `bmad-master` | `QS`, `QD`, `CR` | Quick Spec, Quick Dev, Code Review |
|
|
27
|
+
| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Create UX Design |
|
|
28
|
+
| Technical Writer (Paige) | `bmad-tech-writer` | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | Document Project, Write Document, Update Standards, Mermaid Generate, Validate Doc, Explain Concept |
|