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
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "管理项目上下文"
|
|
3
|
+
description: 创建并维护 project-context.md 以指导 AI 智能体
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 7
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
使用 `project-context.md` 文件确保 AI 智能体在所有工作流程中遵循项目的技术偏好和实现规则。
|
|
9
|
+
|
|
10
|
+
:::note[前置条件]
|
|
11
|
+
- 已安装 BMad Method
|
|
12
|
+
- 了解项目的技术栈和约定
|
|
13
|
+
:::
|
|
14
|
+
|
|
15
|
+
## 何时使用
|
|
16
|
+
|
|
17
|
+
- 在开始架构设计之前有明确的技术偏好
|
|
18
|
+
- 已完成架构设计并希望为实施捕获决策
|
|
19
|
+
- 正在处理具有既定模式的现有代码库
|
|
20
|
+
- 注意到智能体在不同用户故事中做出不一致的决策
|
|
21
|
+
|
|
22
|
+
## 步骤 1:选择方法
|
|
23
|
+
|
|
24
|
+
**手动创建** — 当您确切知道要记录哪些规则时最佳
|
|
25
|
+
|
|
26
|
+
**架构后生成** — 最适合捕获解决方案制定过程中所做的决策
|
|
27
|
+
|
|
28
|
+
**为现有项目生成** — 最适合在现有代码库中发现模式
|
|
29
|
+
|
|
30
|
+
## 步骤 2:创建文件
|
|
31
|
+
|
|
32
|
+
### 选项 A:手动创建
|
|
33
|
+
|
|
34
|
+
在 `_bmad-output/project-context.md` 创建文件:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
mkdir -p _bmad-output
|
|
38
|
+
touch _bmad-output/project-context.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
添加技术栈和实现规则:
|
|
42
|
+
|
|
43
|
+
```markdown
|
|
44
|
+
---
|
|
45
|
+
project_name: 'MyProject'
|
|
46
|
+
user_name: 'YourName'
|
|
47
|
+
date: '2026-02-15'
|
|
48
|
+
sections_completed: ['technology_stack', 'critical_rules']
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
# AI 智能体的项目上下文
|
|
52
|
+
|
|
53
|
+
## 技术栈与版本
|
|
54
|
+
|
|
55
|
+
- Node.js 20.x, TypeScript 5.3, React 18.2
|
|
56
|
+
- 状态管理:Zustand
|
|
57
|
+
- 测试:Vitest, Playwright
|
|
58
|
+
- 样式:Tailwind CSS
|
|
59
|
+
|
|
60
|
+
## 关键实现规则
|
|
61
|
+
|
|
62
|
+
**TypeScript:**
|
|
63
|
+
- 启用严格模式,不使用 `any` 类型
|
|
64
|
+
- 公共 API 使用 `interface`,联合类型使用 `type`
|
|
65
|
+
|
|
66
|
+
**代码组织:**
|
|
67
|
+
- 组件位于 `/src/components/` 并附带同位置测试
|
|
68
|
+
- API 调用使用 `apiClient` 单例 — 绝不直接使用 fetch
|
|
69
|
+
|
|
70
|
+
**测试:**
|
|
71
|
+
- 单元测试专注于业务逻辑
|
|
72
|
+
- 集成测试使用 MSW 进行 API 模拟
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 选项 B:架构后生成
|
|
76
|
+
|
|
77
|
+
在新的聊天中运行工作流程:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
/bmad-bmm-generate-project-context
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
工作流程扫描架构文档和项目文件,生成捕获所做决策的上下文文件。
|
|
84
|
+
|
|
85
|
+
### 选项 C:为现有项目生成
|
|
86
|
+
|
|
87
|
+
对于现有项目,运行:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
/bmad-bmm-generate-project-context
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
工作流程分析代码库以识别约定,然后生成上下文文件供您审查和完善。
|
|
94
|
+
|
|
95
|
+
## 步骤 3:验证内容
|
|
96
|
+
|
|
97
|
+
审查生成的文件并确保它捕获了:
|
|
98
|
+
|
|
99
|
+
- 正确的技术版本
|
|
100
|
+
- 实际约定(而非通用最佳实践)
|
|
101
|
+
- 防止常见错误的规则
|
|
102
|
+
- 框架特定的模式
|
|
103
|
+
|
|
104
|
+
手动编辑以添加任何缺失内容或删除不准确之处。
|
|
105
|
+
|
|
106
|
+
## 您将获得
|
|
107
|
+
|
|
108
|
+
一个 `project-context.md` 文件,它:
|
|
109
|
+
|
|
110
|
+
- 确保所有智能体遵循相同的约定
|
|
111
|
+
- 防止在不同用户故事中做出不一致的决策
|
|
112
|
+
- 为实施捕获架构决策
|
|
113
|
+
- 作为项目模式和规则的参考
|
|
114
|
+
|
|
115
|
+
## 提示
|
|
116
|
+
|
|
117
|
+
:::tip[关注非显而易见的内容]
|
|
118
|
+
记录智能体可能遗漏的模式,例如"在每个公共类、函数和变量上使用 JSDoc 风格注释",而不是像"使用有意义的变量名"这样的通用实践,因为 LLM 目前已经知道这些。
|
|
119
|
+
:::
|
|
120
|
+
|
|
121
|
+
:::tip[保持精简]
|
|
122
|
+
此文件由每个实施工作流程加载。长文件会浪费上下文。不要包含仅适用于狭窄范围或特定用户故事或功能的内容。
|
|
123
|
+
:::
|
|
124
|
+
|
|
125
|
+
:::tip[根据需要更新]
|
|
126
|
+
当模式发生变化时手动编辑,或在重大架构更改后重新生成。
|
|
127
|
+
:::
|
|
128
|
+
|
|
129
|
+
:::tip[适用于所有项目类型]
|
|
130
|
+
对于快速流程和完整的 BMad Method 项目同样有用。
|
|
131
|
+
:::
|
|
132
|
+
|
|
133
|
+
## 后续步骤
|
|
134
|
+
|
|
135
|
+
- [**项目上下文说明**](../explanation/project-context.md) — 了解其工作原理
|
|
136
|
+
- [**工作流程图**](../reference/workflow-map.md) — 查看哪些工作流程加载项目上下文
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
## 术语说明
|
|
140
|
+
|
|
141
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
142
|
+
- **workflow**:工作流程。指完成特定任务的一系列步骤或过程。
|
|
143
|
+
- **codebase**:代码库。指项目的所有源代码和资源的集合。
|
|
144
|
+
- **implementation**:实施。指将设计或架构转化为实际代码的过程。
|
|
145
|
+
- **architecture**:架构。指系统的整体结构和设计。
|
|
146
|
+
- **stack**:技术栈。指项目使用的技术组合,如编程语言、框架、工具等。
|
|
147
|
+
- **convention**:约定。指团队或项目中遵循的编码规范和最佳实践。
|
|
148
|
+
- **singleton**:单例。一种设计模式,确保类只有一个实例。
|
|
149
|
+
- **co-located**:同位置。指相关文件(如测试文件)与主文件放在同一目录中。
|
|
150
|
+
- **mocking**:模拟。在测试中用模拟对象替代真实对象的行为。
|
|
151
|
+
- **context**:上下文。指程序运行时的环境信息或背景信息。
|
|
152
|
+
- **LLM**:大语言模型。Large Language Model 的缩写,指大型语言模型。
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "快速修复"
|
|
3
|
+
description: 如何进行快速修复和临时更改
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 5
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
直接使用 **DEV 智能体**进行 bug 修复、重构或小型针对性更改,这些操作不需要完整的 BMad Method 或 Quick Flow。
|
|
9
|
+
|
|
10
|
+
## 何时使用此方法
|
|
11
|
+
|
|
12
|
+
- 原因明确且已知的 bug 修复
|
|
13
|
+
- 包含在少数文件中的小型重构(重命名、提取、重组)
|
|
14
|
+
- 次要功能调整或配置更改
|
|
15
|
+
- 探索性工作,以了解不熟悉的代码库
|
|
16
|
+
|
|
17
|
+
:::note[前置条件]
|
|
18
|
+
- 已安装 BMad Method(`npx bmad-method install`)
|
|
19
|
+
- AI 驱动的 IDE(Claude Code、Cursor 或类似工具)
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
## 选择你的方法
|
|
23
|
+
|
|
24
|
+
| 情况 | 智能体 | 原因 |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| 修复特定 bug 或进行小型、范围明确的更改 | **DEV agent** | 直接进入实现,无需规划开销 |
|
|
27
|
+
| 更改涉及多个文件,或希望先有书面计划 | **Quick Flow Solo Dev** | 在实现前创建 quick-spec,使智能体与你的标准保持一致 |
|
|
28
|
+
|
|
29
|
+
如果不确定,请从 DEV 智能体开始。如果更改范围扩大,你始终可以升级到 Quick Flow。
|
|
30
|
+
|
|
31
|
+
## 步骤
|
|
32
|
+
|
|
33
|
+
### 1. 加载 DEV 智能体
|
|
34
|
+
|
|
35
|
+
在 AI IDE 中启动一个**新的聊天**,并使用斜杠命令加载 DEV 智能体:
|
|
36
|
+
|
|
37
|
+
```text
|
|
38
|
+
/bmad-agent-bmm-dev
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
这会将智能体的角色和能力加载到会话中。如果你决定需要 Quick Flow,请在新的聊天中加载 **Quick Flow Solo Dev** 智能体:
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
/bmad-agent-bmm-quick-flow-solo-dev
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
加载 Solo Dev 智能体后,描述你的更改并要求它创建一个 **quick-spec**。智能体会起草一个轻量级规范,捕获你想要更改的内容和方式。批准 quick-spec 后,告诉智能体开始 **Quick Flow 开发周期**——它将实现更改、运行测试并执行自我审查,所有这些都由你刚刚批准的规范指导。
|
|
48
|
+
|
|
49
|
+
:::tip[新聊天]
|
|
50
|
+
加载智能体时始终启动新的聊天会话。重用之前工作流的会话可能导致上下文冲突。
|
|
51
|
+
:::
|
|
52
|
+
|
|
53
|
+
### 2. 描述更改
|
|
54
|
+
|
|
55
|
+
用通俗语言告诉智能体你需要什么。具体说明问题,如果你知道相关代码的位置,也请说明。
|
|
56
|
+
|
|
57
|
+
:::note[示例提示词]
|
|
58
|
+
**Bug 修复** -- "修复允许空密码的登录验证 bug。验证逻辑位于 `src/auth/validate.ts`。"
|
|
59
|
+
|
|
60
|
+
**重构** -- "重构 UserService 以使用 async/await 而不是回调。"
|
|
61
|
+
|
|
62
|
+
**配置更改** -- "更新 CI 流水线以在运行之间缓存 node_modules。"
|
|
63
|
+
|
|
64
|
+
**依赖更新** -- "将 express 依赖升级到最新的 v5 版本并修复任何破坏性更改。"
|
|
65
|
+
:::
|
|
66
|
+
|
|
67
|
+
你不需要提供每个细节。智能体会读取相关的源文件,并在需要时提出澄清问题。
|
|
68
|
+
|
|
69
|
+
### 3. 让智能体工作
|
|
70
|
+
|
|
71
|
+
智能体将:
|
|
72
|
+
|
|
73
|
+
- 读取并分析相关的源文件
|
|
74
|
+
- 提出解决方案并解释其推理
|
|
75
|
+
- 在受影响的文件中实现更改
|
|
76
|
+
- 如果存在测试套件,则运行项目的测试套件
|
|
77
|
+
|
|
78
|
+
如果你的项目有测试,智能体会在进行更改后自动运行它们,并迭代直到测试通过。对于没有测试套件的项目,请手动验证更改(运行应用、访问端点、检查输出)。
|
|
79
|
+
|
|
80
|
+
### 4. 审查和验证
|
|
81
|
+
|
|
82
|
+
在提交之前,审查更改内容:
|
|
83
|
+
|
|
84
|
+
- 通读 diff 以确认更改符合你的意图
|
|
85
|
+
- 自己运行应用程序或测试以再次检查
|
|
86
|
+
- 如果看起来有问题,告诉智能体需要修复什么——它可以在同一会话中迭代
|
|
87
|
+
|
|
88
|
+
满意后,使用描述修复的清晰消息提交更改。
|
|
89
|
+
|
|
90
|
+
:::caution[如果出现问题]
|
|
91
|
+
如果提交的更改导致意外问题,请使用 `git revert HEAD` 干净地撤销最后一次提交。然后启动与 DEV 智能体的新聊天以尝试不同的方法。
|
|
92
|
+
:::
|
|
93
|
+
|
|
94
|
+
## 学习你的代码库
|
|
95
|
+
|
|
96
|
+
DEV 智能体也适用于探索不熟悉的代码。在新的聊天中加载它并提出问题:
|
|
97
|
+
|
|
98
|
+
:::note[示例提示词]
|
|
99
|
+
"解释此代码库中的身份验证系统是如何工作的。"
|
|
100
|
+
|
|
101
|
+
"向我展示 API 层中的错误处理发生在哪里。"
|
|
102
|
+
|
|
103
|
+
"`ProcessOrder` 函数的作用是什么,什么调用了它?"
|
|
104
|
+
:::
|
|
105
|
+
|
|
106
|
+
使用智能体了解你的项目,理解组件如何连接,并在进行更改之前探索不熟悉的区域。
|
|
107
|
+
|
|
108
|
+
## 你将获得
|
|
109
|
+
|
|
110
|
+
- 已应用修复或重构的修改后的源文件
|
|
111
|
+
- 通过的测试(如果你的项目有测试套件)
|
|
112
|
+
- 描述更改的干净提交
|
|
113
|
+
|
|
114
|
+
不会生成规划产物——这就是这种方法的意义所在。
|
|
115
|
+
|
|
116
|
+
## 何时升级到正式规划
|
|
117
|
+
|
|
118
|
+
在以下情况下考虑使用 [Quick Flow](../explanation/quick-flow.md) 或完整的 BMad Method:
|
|
119
|
+
|
|
120
|
+
- 更改影响多个系统或需要在许多文件中进行协调更新
|
|
121
|
+
- 你不确定范围,需要规范来理清思路
|
|
122
|
+
- 修复在工作过程中变得越来越复杂
|
|
123
|
+
- 你需要为团队记录文档或架构决策
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
## 术语说明
|
|
127
|
+
|
|
128
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
129
|
+
- **quick-spec**:快速规范。一种轻量级的规范文档,用于快速捕获和描述更改的内容和方式。
|
|
130
|
+
- **Quick Flow**:快速流程。BMad Method 中的一种工作流程,用于快速实现小型更改。
|
|
131
|
+
- **refactoring**:重构。在不改变代码外部行为的情况下改进其内部结构的过程。
|
|
132
|
+
- **breaking changes**:破坏性更改。可能导致现有代码或功能不再正常工作的更改。
|
|
133
|
+
- **test suite**:测试套件。一组用于验证软件功能的测试用例集合。
|
|
134
|
+
- **CI pipeline**:CI 流水线。持续集成流水线,用于自动化构建、测试和部署代码。
|
|
135
|
+
- **async/await**:异步编程语法。JavaScript/TypeScript 中用于处理异步操作的语法糖。
|
|
136
|
+
- **callbacks**:回调函数。作为参数传递给其他函数并在适当时候被调用的函数。
|
|
137
|
+
- **endpoint**:端点。API 中可访问的特定 URL 路径。
|
|
138
|
+
- **diff**:差异。文件或代码更改前后的对比。
|
|
139
|
+
- **commit**:提交。将更改保存到版本控制系统的操作。
|
|
140
|
+
- **git revert HEAD**:Git 命令,用于撤销最后一次提交。
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "文档分片指南"
|
|
3
|
+
description: 将大型 Markdown 文件拆分为更小的组织化文件,以更好地管理上下文
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 8
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
如果需要将大型 Markdown 文件拆分为更小、组织良好的文件以更好地管理上下文,请使用 `shard-doc` 工具。
|
|
9
|
+
|
|
10
|
+
:::caution[已弃用]
|
|
11
|
+
不再推荐使用此方法,随着工作流程的更新以及大多数主要 LLM 和工具支持子进程,这很快将变得不再必要。
|
|
12
|
+
:::
|
|
13
|
+
|
|
14
|
+
## 何时使用
|
|
15
|
+
|
|
16
|
+
仅当你发现所选工具/模型组合无法在需要时加载和读取所有文档作为输入时,才使用此方法。
|
|
17
|
+
|
|
18
|
+
## 什么是文档分片?
|
|
19
|
+
|
|
20
|
+
文档分片根据二级标题(`## Heading`)将大型 Markdown 文件拆分为更小、组织良好的文件。
|
|
21
|
+
|
|
22
|
+
### 架构
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
分片前:
|
|
26
|
+
_bmad-output/planning-artifacts/
|
|
27
|
+
└── PRD.md(大型 50k token 文件)
|
|
28
|
+
|
|
29
|
+
分片后:
|
|
30
|
+
_bmad-output/planning-artifacts/
|
|
31
|
+
└── prd/
|
|
32
|
+
├── index.md # 带有描述的目录
|
|
33
|
+
├── overview.md # 第 1 节
|
|
34
|
+
├── user-requirements.md # 第 2 节
|
|
35
|
+
├── technical-requirements.md # 第 3 节
|
|
36
|
+
└── ... # 其他章节
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 步骤
|
|
40
|
+
|
|
41
|
+
### 1. 运行 Shard-Doc 工具
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
/bmad-shard-doc
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 2. 遵循交互式流程
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
智能体:您想要分片哪个文档?
|
|
51
|
+
用户:docs/PRD.md
|
|
52
|
+
|
|
53
|
+
智能体:默认目标位置:docs/prd/
|
|
54
|
+
接受默认值?[y/n]
|
|
55
|
+
用户:y
|
|
56
|
+
|
|
57
|
+
智能体:正在分片 PRD.md...
|
|
58
|
+
✓ 已创建 12 个章节文件
|
|
59
|
+
✓ 已生成 index.md
|
|
60
|
+
✓ 完成!
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## 工作流程发现机制
|
|
64
|
+
|
|
65
|
+
BMad 工作流程使用**双重发现系统**:
|
|
66
|
+
|
|
67
|
+
1. **首先尝试完整文档** - 查找 `document-name.md`
|
|
68
|
+
2. **检查分片版本** - 查找 `document-name/index.md`
|
|
69
|
+
3. **优先级规则** - 如果两者都存在,完整文档优先 - 如果希望使用分片版本,请删除完整文档
|
|
70
|
+
|
|
71
|
+
## 工作流程支持
|
|
72
|
+
|
|
73
|
+
所有 BMM 工作流程都支持这两种格式:
|
|
74
|
+
|
|
75
|
+
- 完整文档
|
|
76
|
+
- 分片文档
|
|
77
|
+
- 自动检测
|
|
78
|
+
- 对用户透明
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
## 术语说明
|
|
82
|
+
|
|
83
|
+
- **sharding**:分片。将大型文档或数据集拆分为更小、更易管理的部分的过程。
|
|
84
|
+
- **token**:令牌。在自然语言处理和大型语言模型中,文本的基本单位,通常对应单词或字符的一部分。
|
|
85
|
+
- **subprocesses**:子进程。由主进程创建的独立执行单元,可以并行运行以执行特定任务。
|
|
86
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "如何升级到 v6"
|
|
3
|
+
description: 从 BMad v4 迁移到 v6
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 3
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
使用 BMad 安装程序从 v4 升级到 v6,其中包括自动检测旧版安装和迁移辅助。
|
|
9
|
+
|
|
10
|
+
## 何时使用本指南
|
|
11
|
+
|
|
12
|
+
- 您已安装 BMad v4(`.bmad-method` 文件夹)
|
|
13
|
+
- 您希望迁移到新的 v6 架构
|
|
14
|
+
- 您有需要保留的现有规划产物
|
|
15
|
+
|
|
16
|
+
:::note[前置条件]
|
|
17
|
+
- Node.js 20+
|
|
18
|
+
- 现有的 BMad v4 安装
|
|
19
|
+
:::
|
|
20
|
+
|
|
21
|
+
## 步骤
|
|
22
|
+
|
|
23
|
+
### 1. 运行安装程序
|
|
24
|
+
|
|
25
|
+
按照[安装程序说明](./install-bmad.md)操作。
|
|
26
|
+
|
|
27
|
+
### 2. 处理旧版安装
|
|
28
|
+
|
|
29
|
+
当检测到 v4 时,您可以:
|
|
30
|
+
|
|
31
|
+
- 允许安装程序备份并删除 `.bmad-method`
|
|
32
|
+
- 退出并手动处理清理
|
|
33
|
+
|
|
34
|
+
如果您将 bmad method 文件夹命名为其他名称 - 您需要手动删除该文件夹。
|
|
35
|
+
|
|
36
|
+
### 3. 清理 IDE 命令
|
|
37
|
+
|
|
38
|
+
手动删除旧版 v4 IDE 命令 - 例如如果您使用 claude,查找任何以 bmad 开头的嵌套文件夹并删除它们:
|
|
39
|
+
|
|
40
|
+
- `.claude/commands/BMad/agents`
|
|
41
|
+
- `.claude/commands/BMad/tasks`
|
|
42
|
+
|
|
43
|
+
### 4. 迁移规划产物
|
|
44
|
+
|
|
45
|
+
**如果您有规划文档(Brief/PRD/UX/Architecture):**
|
|
46
|
+
|
|
47
|
+
将它们移动到 `_bmad-output/planning-artifacts/` 并使用描述性名称:
|
|
48
|
+
|
|
49
|
+
- 在文件名中包含 `PRD` 用于 PRD 文档
|
|
50
|
+
- 相应地包含 `brief`、`architecture` 或 `ux-design`
|
|
51
|
+
- 分片文档可以放在命名的子文件夹中
|
|
52
|
+
|
|
53
|
+
**如果您正在进行规划:** 考虑使用 v6 工作流重新开始。将现有文档作为输入——新的渐进式发现工作流配合网络搜索和 IDE 计划模式会产生更好的结果。
|
|
54
|
+
|
|
55
|
+
### 5. 迁移进行中的开发
|
|
56
|
+
|
|
57
|
+
如果您已创建或实现了故事:
|
|
58
|
+
|
|
59
|
+
1. 完成 v6 安装
|
|
60
|
+
2. 将 `epics.md` 或 `epics/epic*.md` 放入 `_bmad-output/planning-artifacts/`
|
|
61
|
+
3. 运行 Scrum Master 的 `sprint-planning` 工作流
|
|
62
|
+
4. 告诉 SM 哪些史诗/故事已经完成
|
|
63
|
+
|
|
64
|
+
## 您将获得
|
|
65
|
+
|
|
66
|
+
**v6 统一结构:**
|
|
67
|
+
|
|
68
|
+
```text
|
|
69
|
+
your-project/
|
|
70
|
+
├── _bmad/ # 单一安装文件夹
|
|
71
|
+
│ ├── _config/ # 您的自定义配置
|
|
72
|
+
│ │ └── agents/ # 智能体自定义文件
|
|
73
|
+
│ ├── core/ # 通用核心框架
|
|
74
|
+
│ ├── bmm/ # BMad Method 模块
|
|
75
|
+
│ ├── bmb/ # BMad Builder
|
|
76
|
+
│ └── cis/ # Creative Intelligence Suite
|
|
77
|
+
└── _bmad-output/ # 输出文件夹(v4 中为 doc 文件夹)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## 模块迁移
|
|
81
|
+
|
|
82
|
+
| v4 模块 | v6 状态 |
|
|
83
|
+
| ----------------------------- | ----------------------------------------- |
|
|
84
|
+
| `.bmad-2d-phaser-game-dev` | 已集成到 BMGD 模块 |
|
|
85
|
+
| `.bmad-2d-unity-game-dev` | 已集成到 BMGD 模块 |
|
|
86
|
+
| `.bmad-godot-game-dev` | 已集成到 BMGD 模块 |
|
|
87
|
+
| `.bmad-infrastructure-devops` | 已弃用 — 新的 DevOps 智能体即将推出 |
|
|
88
|
+
| `.bmad-creative-writing` | 未适配 — 新的 v6 模块即将推出 |
|
|
89
|
+
|
|
90
|
+
## 主要变更
|
|
91
|
+
|
|
92
|
+
| 概念 | v4 | v6 |
|
|
93
|
+
| ------------ | --------------------------------------- | ------------------------------------ |
|
|
94
|
+
| **核心** | `_bmad-core` 实际上是 BMad Method | `_bmad/core/` 是通用框架 |
|
|
95
|
+
| **方法** | `_bmad-method` | `_bmad/bmm/` |
|
|
96
|
+
| **配置** | 直接修改文件 | 每个模块使用 `config.yaml` |
|
|
97
|
+
| **文档** | 需要设置分片或非分片 | 完全灵活,自动扫描 |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
## 术语说明
|
|
101
|
+
|
|
102
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
103
|
+
- **epic**:史诗。在敏捷开发中,指大型的工作项,可分解为多个用户故事。
|
|
104
|
+
- **story**:故事。在敏捷开发中,指用户故事,描述用户需求的功能单元。
|
|
105
|
+
- **Scrum Master**:Scrum 主管。敏捷开发 Scrum 框架中的角色,负责促进团队流程和移除障碍。
|
|
106
|
+
- **sprint-planning**:冲刺规划。Scrum 框架中的会议,用于确定下一个冲刺期间要完成的工作。
|
|
107
|
+
- **sharded**:分片。将大型文档拆分为多个较小的文件以便于管理和处理。
|
|
108
|
+
- **PRD**:产品需求文档(Product Requirements Document)。描述产品功能、需求和特性的文档。
|
|
109
|
+
- **Brief**:简报。概述项目目标、范围和关键信息的文档。
|
|
110
|
+
- **UX**:用户体验(User Experience)。用户在使用产品或服务过程中的整体感受和交互体验。
|
|
111
|
+
- **Architecture**:架构。系统的结构设计,包括组件、模块及其相互关系。
|
|
112
|
+
- **BMGD**:BMad Game Development。BMad 游戏开发模块。
|
|
113
|
+
- **DevOps**:开发运维(Development Operations)。结合开发和运维的实践,旨在缩短系统开发生命周期。
|
|
114
|
+
- **BMad Method**:BMad 方法。BMad 框架的核心方法论模块。
|
|
115
|
+
- **BMad Builder**:BMad 构建器。BMad 框架的构建工具。
|
|
116
|
+
- **Creative Intelligence Suite**:创意智能套件。BMad 框架中的创意工具集合。
|
|
117
|
+
- **IDE**:集成开发环境(Integrated Development Environment)。提供代码编辑、调试等功能的软件开发工具。
|
|
118
|
+
- **progressive discovery**:渐进式发现。逐步深入探索和理解需求的过程。
|
|
119
|
+
- **web search**:网络搜索。通过互联网检索信息的能力。
|
|
120
|
+
- **plan mode**:计划模式。IDE 中的一种工作模式,用于规划和设计任务。
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 欢迎使用 BMad 方法
|
|
3
|
+
description: 具备专业智能体、引导式工作流和智能规划的 AI 驱动开发框架
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
BMad 方法(**B**reakthrough **M**ethod of **A**gile AI **D**riven Development,敏捷 AI 驱动开发的突破性方法)是 BMad 方法生态系统中的一个 AI 驱动开发框架模块,帮助您完成从构思和规划到智能体实现的整个软件开发过程。它提供专业的 AI 智能体、引导式工作流和智能规划,能够根据您项目的复杂度进行调整,无论是修复错误还是构建企业平台。
|
|
7
|
+
|
|
8
|
+
如果您熟悉使用 Claude、Cursor 或 GitHub Copilot 等 AI 编码助手,就可以开始使用了。
|
|
9
|
+
|
|
10
|
+
:::note[🚀 V6 已发布,我们才刚刚起步!]
|
|
11
|
+
技能架构、BMad Builder v1、开发循环自动化以及更多功能正在开发中。**[查看路线图 →](/roadmap/)**
|
|
12
|
+
:::
|
|
13
|
+
|
|
14
|
+
## 新手入门?从教程开始
|
|
15
|
+
|
|
16
|
+
理解 BMad 的最快方式是亲自尝试。
|
|
17
|
+
|
|
18
|
+
- **[BMad 入门指南](./tutorials/getting-started.md)** — 安装并了解 BMad 的工作原理
|
|
19
|
+
- **[工作流地图](./reference/workflow-map.md)** — BMM 阶段、工作流和上下文管理的可视化概览
|
|
20
|
+
|
|
21
|
+
:::tip[只想直接上手?]
|
|
22
|
+
安装 BMad 并运行 `/bmad-help` — 它会根据您的项目和已安装的模块引导您完成所有操作。
|
|
23
|
+
:::
|
|
24
|
+
|
|
25
|
+
## 如何使用本文档
|
|
26
|
+
|
|
27
|
+
本文档根据您的目标分为四个部分:
|
|
28
|
+
|
|
29
|
+
| 部分 | 用途 |
|
|
30
|
+
| ----------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| **教程** | 以学习为导向。通过分步指南引导您构建内容。如果您是新手,请从这里开始。 |
|
|
32
|
+
| **操作指南** | 以任务为导向。解决特定问题的实用指南。"如何自定义智能体?"等内容位于此处。 |
|
|
33
|
+
| **说明** | 以理解为导向。深入探讨概念和架构。当您想知道*为什么*时阅读。 |
|
|
34
|
+
| **参考** | 以信息为导向。智能体、工作流和配置的技术规范。 |
|
|
35
|
+
|
|
36
|
+
## 扩展和自定义
|
|
37
|
+
|
|
38
|
+
想要使用自己的智能体、工作流或模块来扩展 BMad 吗?**[BMad Builder](https://bmad-builder-docs.bmad-method.org/)** 提供了创建自定义扩展的框架和工具,无论是为 BMad 添加新功能还是从头开始构建全新的模块。
|
|
39
|
+
|
|
40
|
+
## 您需要什么
|
|
41
|
+
|
|
42
|
+
BMad 可与任何支持自定义系统提示词或项目上下文的 AI 编码助手配合使用。热门选项包括:
|
|
43
|
+
|
|
44
|
+
- **[Claude Code](https://code.claude.com)** — Anthropic 的 CLI 工具(推荐)
|
|
45
|
+
- **[Cursor](https://cursor.sh)** — AI 优先的代码编辑器
|
|
46
|
+
- **[Codex CLI](https://github.com/openai/codex)** — OpenAI 的终端编码智能体
|
|
47
|
+
|
|
48
|
+
您应该熟悉版本控制、项目结构和敏捷工作流等基本软件开发概念。无需具备 BMad 风格智能体系统的先验经验——这正是本文档的作用。
|
|
49
|
+
|
|
50
|
+
## 加入社区
|
|
51
|
+
|
|
52
|
+
获取帮助、分享您的构建内容,或为 BMad 做出贡献:
|
|
53
|
+
|
|
54
|
+
- **[Discord](https://discord.gg/gk8jAdXWmj)** — 与其他 BMad 用户聊天、提问、分享想法
|
|
55
|
+
- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — 源代码、问题和贡献
|
|
56
|
+
- **[YouTube](https://www.youtube.com/@BMadCode)** — 视频教程和演练
|
|
57
|
+
|
|
58
|
+
## 下一步
|
|
59
|
+
|
|
60
|
+
准备开始了吗?**[BMad 入门指南](./tutorials/getting-started.md)** 并构建您的第一个项目。
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
## 术语说明
|
|
64
|
+
|
|
65
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
66
|
+
- **AI-driven**:AI 驱动。指由人工智能技术主导或驱动的系统或方法。
|
|
67
|
+
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
|
|
68
|
+
- **prompt**:提示词。指输入给 AI 模型的指令或问题,用于引导其生成特定输出。
|
|
69
|
+
- **context**:上下文。指在特定场景下理解信息所需的背景信息或环境。
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "智能体"
|
|
3
|
+
description: 默认 BMM 智能体及其菜单触发器和主要工作流
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 2
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 默认智能体
|
|
9
|
+
|
|
10
|
+
本页列出了随 BMad Method 安装的默认 BMM(Agile 套件)智能体,以及它们的菜单触发器和主要工作流。
|
|
11
|
+
|
|
12
|
+
## 注意事项
|
|
13
|
+
|
|
14
|
+
- 触发器是显示在每个智能体菜单中的简短菜单代码(例如 `CP`)和模糊匹配。
|
|
15
|
+
- 斜杠命令是单独生成的。斜杠命令列表及其定义位置请参阅[命令](./commands.md)。
|
|
16
|
+
- QA(Quinn)是 BMM 中的轻量级测试自动化智能体。完整的测试架构师(TEA)位于其独立模块中。
|
|
17
|
+
|
|
18
|
+
| 智能体 | 触发 | 主要工作流 |
|
|
19
|
+
| --------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| Analyst (Mary) | `BP`, `RS`, `CB`, `DP` | 头脑风暴项目、研究、创建简报、文档化项目 |
|
|
21
|
+
| Product Manager (John) | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | 创建/验证/编辑 PRD、创建史诗和用户故事、实施就绪、纠正方向 |
|
|
22
|
+
| Architect (Winston) | `CA`, `IR` | 创建架构、实施就绪 |
|
|
23
|
+
| Scrum Master (Bob) | `SP`, `CS`, `ER`, `CC` | 冲刺规划、创建用户故事、史诗回顾、纠正方向 |
|
|
24
|
+
| Developer (Amelia) | `DS`, `CR` | 开发用户故事、代码评审 |
|
|
25
|
+
| QA Engineer (Quinn) | `QA` | 自动化(为现有功能生成测试) |
|
|
26
|
+
| Quick Flow Solo Dev (Barry) | `QS`, `QD`, `CR` | 快速规格、快速开发、代码评审 |
|
|
27
|
+
| UX Designer (Sally) | `CU` | 创建 UX 设计 |
|
|
28
|
+
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | 文档化项目、撰写文档、更新标准、Mermaid 生成、验证文档、解释概念 |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
## 术语说明
|
|
32
|
+
|
|
33
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
34
|
+
- **BMM**:BMad Method 中的默认智能体套件,涵盖敏捷开发流程中的各类角色。
|
|
35
|
+
- **PRD**:产品需求文档(Product Requirements Document)。
|
|
36
|
+
- **Epic**:史诗。大型功能或需求集合,可拆分为多个用户故事。
|
|
37
|
+
- **Story**:用户故事。描述用户需求的简短陈述。
|
|
38
|
+
- **Sprint**:冲刺。敏捷开发中的固定时间周期迭代。
|
|
39
|
+
- **QA**:质量保证(Quality Assurance)。
|
|
40
|
+
- **TEA**:测试架构师(Test Architect)。
|
|
41
|
+
- **Mermaid**:一种用于生成图表和流程图的文本语法。
|