bmad-method 6.0.4 → 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/.github/workflows/publish.yaml +243 -0
- package/CONTRIBUTING.md +1 -1
- 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 +1 -1
- 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 -3
- 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-03-technique-execution.md +1 -1
- package/src/core/workflows/brainstorming/workflow.md +1 -1
- package/src/core/workflows/party-mode/bmad-skill-manifest.yaml +3 -0
- 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/lib/core/installer.js +34 -1
- package/tools/cli/installers/lib/core/manifest-generator.js +328 -35
- package/tools/cli/installers/lib/ide/_base-ide.js +24 -15
- package/tools/cli/installers/lib/ide/_config-driven.js +472 -53
- package/tools/cli/installers/lib/ide/manager.js +23 -61
- package/tools/cli/installers/lib/ide/platform-codes.yaml +108 -30
- 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/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/review-edge-case-hunter.xml +0 -63
- 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,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "快速流程"
|
|
3
|
+
description: 小型变更的快速通道 - 跳过完整方法论
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
跳过繁琐流程。快速流程通过两条命令将你从想法带到可运行的代码 - 无需产品简报、无需 PRD、无需架构文档。
|
|
9
|
+
|
|
10
|
+
## 何时使用
|
|
11
|
+
|
|
12
|
+
- Bug 修复和补丁
|
|
13
|
+
- 重构现有代码
|
|
14
|
+
- 小型、易于理解的功能
|
|
15
|
+
- 原型设计和探索性开发
|
|
16
|
+
- 单智能体工作,一名开发者可以掌控完整范围
|
|
17
|
+
|
|
18
|
+
## 何时不使用
|
|
19
|
+
|
|
20
|
+
- 需要利益相关者对齐的新产品或平台
|
|
21
|
+
- 跨越多个组件或团队的主要功能
|
|
22
|
+
- 需要架构决策的工作(数据库架构、API 契约、服务边界)
|
|
23
|
+
- 需求不明确或有争议的任何工作
|
|
24
|
+
|
|
25
|
+
:::caution[Scope Creep]
|
|
26
|
+
如果你启动快速流程后发现范围超出预期,`quick-dev` 会检测到并提供升级选项。你可以在任何时间切换到完整的 PRD 工作流程,而不会丢失你的工作。
|
|
27
|
+
:::
|
|
28
|
+
|
|
29
|
+
## 工作原理
|
|
30
|
+
|
|
31
|
+
快速流程有两条命令,每条都由结构化的工作流程支持。你可以一起运行它们,也可以独立运行。
|
|
32
|
+
|
|
33
|
+
### quick-spec:规划
|
|
34
|
+
|
|
35
|
+
运行 `quick-spec`,Barry(Quick Flow 智能体)会引导你完成对话式发现过程:
|
|
36
|
+
|
|
37
|
+
1. **理解** - 你描述想要构建的内容。Barry 扫描代码库以提出有针对性的问题,然后捕获问题陈述、解决方案方法和范围边界。
|
|
38
|
+
2. **调查** - Barry 读取相关文件,映射代码模式,识别需要修改的文件,并记录技术上下文。
|
|
39
|
+
3. **生成** - 生成完整的技术规范,包含有序的实现任务(具体文件路径和操作)、Given/When/Then 格式的验收标准、测试策略和依赖项。
|
|
40
|
+
4. **审查** - 展示完整规范供你确认。你可以在最终定稿前进行编辑、提问、运行对抗性审查或使用高级启发式方法进行优化。
|
|
41
|
+
|
|
42
|
+
输出是一个 `tech-spec-{slug}.md` 文件,保存到项目的实现工件文件夹中。它包含新智能体实现功能所需的一切 - 无需对话历史。
|
|
43
|
+
|
|
44
|
+
### quick-dev:构建
|
|
45
|
+
|
|
46
|
+
运行 `quick-dev`,Barry 实现工作。它以两种模式运行:
|
|
47
|
+
|
|
48
|
+
- **技术规范模式** - 指向规范文件(`quick-dev tech-spec-auth.md`),它按顺序执行每个任务,编写测试,并验证验收标准。
|
|
49
|
+
- **直接模式** - 直接给出指令(`quick-dev "refactor the auth middleware"`),它收集上下文,构建心智计划,并执行。
|
|
50
|
+
|
|
51
|
+
实现后,`quick-dev` 针对所有任务和验收标准运行自检审计,然后触发差异的对抗性代码审查。发现的问题会呈现给你,以便在收尾前解决。
|
|
52
|
+
|
|
53
|
+
:::tip[Fresh Context]
|
|
54
|
+
为获得最佳效果,在完成 `quick-spec` 后,在新对话中运行 `quick-dev`。这为实现智能体提供了专注于构建的干净上下文。
|
|
55
|
+
:::
|
|
56
|
+
|
|
57
|
+
## 快速流程跳过的内容
|
|
58
|
+
|
|
59
|
+
完整的 BMad 方法在编写任何代码之前会生成产品简报、PRD、架构文档和 Epic/Story 分解。Quick Flow 用单个技术规范替代所有这些。这之所以有效,是因为 Quick Flow 针对以下变更:
|
|
60
|
+
|
|
61
|
+
- 产品方向已确立
|
|
62
|
+
- 架构决策已做出
|
|
63
|
+
- 单个开发者可以推理完整范围
|
|
64
|
+
- 需求可以在一次对话中涵盖
|
|
65
|
+
|
|
66
|
+
## 升级到完整 BMad 方法
|
|
67
|
+
|
|
68
|
+
快速流程包含内置的范围检测护栏。当你使用直接请求运行 `quick-dev` 时,它会评估多组件提及、系统级语言和方法不确定性等信号。如果检测到工作超出快速流程范围:
|
|
69
|
+
|
|
70
|
+
- **轻度升级** - 建议先运行 `quick-spec` 创建计划
|
|
71
|
+
- **重度升级** - 建议切换到完整的 BMad 方法 PRD 流程
|
|
72
|
+
|
|
73
|
+
你也可以随时手动升级。你的技术规范工作会继续推进 - 它将成为更广泛规划过程的输入,而不是被丢弃。
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
## 术语说明
|
|
77
|
+
|
|
78
|
+
- **Quick Flow**:快速流程。BMad 方法中用于小型变更的简化工作流程,跳过完整的产品规划和架构文档阶段。
|
|
79
|
+
- **PRD**:Product Requirements Document,产品需求文档。详细描述产品功能、需求和验收标准的文档。
|
|
80
|
+
- **Product Brief**:产品简报。概述产品愿景、目标和范围的高层文档。
|
|
81
|
+
- **Architecture doc**:架构文档。描述系统架构、组件设计和技术决策的文档。
|
|
82
|
+
- **Epic/Story**:史诗/故事。敏捷开发中的工作单元,Epic 是大型功能集合,Story 是具体用户故事。
|
|
83
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
84
|
+
- **Scope Creep**:范围蔓延。项目范围在开发过程中逐渐扩大,超出原始计划的现象。
|
|
85
|
+
- **tech-spec**:技术规范。详细描述技术实现方案、任务分解和验收标准的文档。
|
|
86
|
+
- **slug**:短标识符。用于生成 URL 或文件名的简短、唯一的字符串标识。
|
|
87
|
+
- **Given/When/Then**:一种行为驱动开发(BDD)的测试场景描述格式,用于定义验收标准。
|
|
88
|
+
- **adversarial review**:对抗性审查。一种代码审查方法,模拟攻击者视角以发现潜在问题和漏洞。
|
|
89
|
+
- **elicitation**:启发式方法。通过提问和对话引导来获取信息、澄清需求的技术。
|
|
90
|
+
- **stakeholder**:利益相关者。对项目有利益或影响的个人或组织。
|
|
91
|
+
- **API contracts**:API 契约。定义 API 接口规范、请求/响应格式和行为约定的文档。
|
|
92
|
+
- **service boundaries**:服务边界。定义服务职责范围和边界的架构概念。
|
|
93
|
+
- **spikes**:探索性开发。用于探索技术可行性或解决方案的短期研究活动。
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "为什么解决方案阶段很重要"
|
|
3
|
+
description: 理解为什么解决方案阶段对于多史诗项目至关重要
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 3
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
阶段 3(解决方案)将构建**什么**(来自规划)转化为**如何**构建(技术设计)。该阶段通过在实施开始前记录架构决策,防止多史诗项目中的智能体冲突。
|
|
10
|
+
|
|
11
|
+
## 没有解决方案阶段的问题
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
智能体 1 使用 REST API 实现史诗 1
|
|
15
|
+
智能体 2 使用 GraphQL 实现史诗 2
|
|
16
|
+
结果:API 设计不一致,集成噩梦
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
当多个智能体在没有共享架构指导的情况下实现系统的不同部分时,它们会做出可能冲突的独立技术决策。
|
|
20
|
+
|
|
21
|
+
## 有解决方案阶段的解决方案
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
架构工作流决定:"所有 API 使用 GraphQL"
|
|
25
|
+
所有智能体遵循架构决策
|
|
26
|
+
结果:实现一致,无冲突
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
通过明确记录技术决策,所有智能体都能一致地实现,集成变得简单直接。
|
|
30
|
+
|
|
31
|
+
## 解决方案阶段 vs 规划阶段
|
|
32
|
+
|
|
33
|
+
| 方面 | 规划(阶段 2) | 解决方案(阶段 3) |
|
|
34
|
+
| -------- | ----------------------- | --------------------------------- |
|
|
35
|
+
| 问题 | 做什么和为什么? | 如何做?然后是什么工作单元? |
|
|
36
|
+
| 输出 | FRs/NFRs(需求) | 架构 + 史诗/用户故事 |
|
|
37
|
+
| 智能体 | PM | 架构师 → PM |
|
|
38
|
+
| 受众 | 利益相关者 | 开发人员 |
|
|
39
|
+
| 文档 | PRD(FRs/NFRs) | 架构 + 史诗文件 |
|
|
40
|
+
| 层级 | 业务逻辑 | 技术设计 + 工作分解 |
|
|
41
|
+
|
|
42
|
+
## 核心原则
|
|
43
|
+
|
|
44
|
+
**使技术决策明确且有文档记录**,以便所有智能体一致地实现。
|
|
45
|
+
|
|
46
|
+
这可以防止:
|
|
47
|
+
- API 风格冲突(REST vs GraphQL)
|
|
48
|
+
- 数据库设计不一致
|
|
49
|
+
- 状态管理分歧
|
|
50
|
+
- 命名约定不匹配
|
|
51
|
+
- 安全方法差异
|
|
52
|
+
|
|
53
|
+
## 何时需要解决方案阶段
|
|
54
|
+
|
|
55
|
+
| 流程 | 需要解决方案阶段? |
|
|
56
|
+
|-------|----------------------|
|
|
57
|
+
| Quick Flow | 否 - 完全跳过 |
|
|
58
|
+
| BMad Method Simple | 可选 |
|
|
59
|
+
| BMad Method Complex | 是 |
|
|
60
|
+
| Enterprise | 是 |
|
|
61
|
+
|
|
62
|
+
:::tip[经验法则]
|
|
63
|
+
如果你有多个可能由不同智能体实现的史诗,你需要解决方案阶段。
|
|
64
|
+
:::
|
|
65
|
+
|
|
66
|
+
## 跳过的代价
|
|
67
|
+
|
|
68
|
+
在复杂项目中跳过解决方案阶段会导致:
|
|
69
|
+
|
|
70
|
+
- **集成问题**在冲刺中期发现
|
|
71
|
+
- **返工**由于实现冲突
|
|
72
|
+
- **开发时间更长**整体
|
|
73
|
+
- **技术债务**来自不一致模式
|
|
74
|
+
|
|
75
|
+
:::caution[成本倍增]
|
|
76
|
+
在解决方案阶段发现对齐问题比在实施期间发现要快 10 倍。
|
|
77
|
+
:::
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
## 术语说明
|
|
81
|
+
|
|
82
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
83
|
+
- **epic**:史诗。在敏捷开发中,指一个大型的工作项,可分解为多个用户故事。
|
|
84
|
+
- **REST API**:表述性状态传递应用程序接口。一种基于 HTTP 协议的 Web API 设计风格。
|
|
85
|
+
- **GraphQL**:一种用于 API 的查询语言和运行时环境。
|
|
86
|
+
- **FRs/NFRs**:功能需求/非功能需求。Functional Requirements/Non-Functional Requirements 的缩写。
|
|
87
|
+
- **PRD**:产品需求文档。Product Requirements Document 的缩写。
|
|
88
|
+
- **PM**:产品经理。Product Manager 的缩写。
|
|
89
|
+
- **sprint**:冲刺。敏捷开发中的固定时间周期,通常为 1-4 周。
|
|
90
|
+
- **technical debt**:技术债务。指为了短期目标而选择的不完美技术方案,未来需要付出额外成本来修复。
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "如何自定义 BMad"
|
|
3
|
+
description: 自定义智能体、工作流和模块,同时保持更新兼容性
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 7
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
使用 `.customize.yaml` 文件来调整智能体行为、角色和菜单,同时在更新过程中保留您的更改。
|
|
9
|
+
|
|
10
|
+
## 何时使用此功能
|
|
11
|
+
|
|
12
|
+
- 您想要更改智能体的名称、个性或沟通风格
|
|
13
|
+
- 您需要智能体记住项目特定的上下文
|
|
14
|
+
- 您想要添加自定义菜单项来触发您自己的工作流或提示
|
|
15
|
+
- 您希望智能体在每次启动时执行特定操作
|
|
16
|
+
|
|
17
|
+
:::note[前置条件]
|
|
18
|
+
- 在项目中安装了 BMad(参见[如何安装 BMad](./install-bmad.md))
|
|
19
|
+
- 用于编辑 YAML 文件的文本编辑器
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
:::caution[保护您的自定义配置]
|
|
23
|
+
始终使用此处描述的 `.customize.yaml` 文件,而不是直接编辑智能体文件。安装程序在更新期间会覆盖智能体文件,但会保留您的 `.customize.yaml` 更改。
|
|
24
|
+
:::
|
|
25
|
+
|
|
26
|
+
## 步骤
|
|
27
|
+
|
|
28
|
+
### 1. 定位自定义文件
|
|
29
|
+
|
|
30
|
+
安装后,在以下位置为每个智能体找到一个 `.customize.yaml` 文件:
|
|
31
|
+
|
|
32
|
+
```text
|
|
33
|
+
_bmad/_config/agents/
|
|
34
|
+
├── core-bmad-master.customize.yaml
|
|
35
|
+
├── bmm-dev.customize.yaml
|
|
36
|
+
├── bmm-pm.customize.yaml
|
|
37
|
+
└── ...(每个已安装的智能体一个文件)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 2. 编辑自定义文件
|
|
41
|
+
|
|
42
|
+
打开您想要修改的智能体的 `.customize.yaml` 文件。每个部分都是可选的——只自定义您需要的内容。
|
|
43
|
+
|
|
44
|
+
| 部分 | 行为 | 用途 |
|
|
45
|
+
| ------------------ | -------- | ---------------------------------------------- |
|
|
46
|
+
| `agent.metadata` | 替换 | 覆盖智能体的显示名称 |
|
|
47
|
+
| `persona` | 替换 | 设置角色、身份、风格和原则 |
|
|
48
|
+
| `memories` | 追加 | 添加智能体始终会记住的持久上下文 |
|
|
49
|
+
| `menu` | 追加 | 为工作流或提示添加自定义菜单项 |
|
|
50
|
+
| `critical_actions` | 追加 | 定义智能体的启动指令 |
|
|
51
|
+
| `prompts` | 追加 | 创建可重复使用的提示供菜单操作使用 |
|
|
52
|
+
|
|
53
|
+
标记为 **替换** 的部分会完全覆盖智能体的默认设置。标记为 **追加** 的部分会添加到现有配置中。
|
|
54
|
+
|
|
55
|
+
**智能体名称**
|
|
56
|
+
|
|
57
|
+
更改智能体的自我介绍方式:
|
|
58
|
+
|
|
59
|
+
```yaml
|
|
60
|
+
agent:
|
|
61
|
+
metadata:
|
|
62
|
+
name: 'Spongebob' # 默认值:"Amelia"
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**角色**
|
|
66
|
+
|
|
67
|
+
替换智能体的个性、角色和沟通风格:
|
|
68
|
+
|
|
69
|
+
```yaml
|
|
70
|
+
persona:
|
|
71
|
+
role: 'Senior Full-Stack Engineer'
|
|
72
|
+
identity: 'Lives in a pineapple (under the sea)'
|
|
73
|
+
communication_style: 'Spongebob annoying'
|
|
74
|
+
principles:
|
|
75
|
+
- 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
|
|
76
|
+
- 'Favor composition over inheritance'
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
`persona` 部分会替换整个默认角色,因此如果您设置它,请包含所有四个字段。
|
|
80
|
+
|
|
81
|
+
**记忆**
|
|
82
|
+
|
|
83
|
+
添加智能体将始终记住的持久上下文:
|
|
84
|
+
|
|
85
|
+
```yaml
|
|
86
|
+
memories:
|
|
87
|
+
- 'Works at Krusty Krab'
|
|
88
|
+
- 'Favorite Celebrity: David Hasslehoff'
|
|
89
|
+
- 'Learned in Epic 1 that it is not cool to just pretend that tests have passed'
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**菜单项**
|
|
93
|
+
|
|
94
|
+
向智能体的显示菜单添加自定义条目。每个条目需要一个 `trigger`、一个目标(`workflow` 路径或 `action` 引用)和一个 `description`:
|
|
95
|
+
|
|
96
|
+
```yaml
|
|
97
|
+
menu:
|
|
98
|
+
- trigger: my-workflow
|
|
99
|
+
workflow: 'my-custom/workflows/my-workflow.yaml'
|
|
100
|
+
description: My custom workflow
|
|
101
|
+
- trigger: deploy
|
|
102
|
+
action: '#deploy-prompt'
|
|
103
|
+
description: Deploy to production
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**关键操作**
|
|
107
|
+
|
|
108
|
+
定义智能体启动时运行的指令:
|
|
109
|
+
|
|
110
|
+
```yaml
|
|
111
|
+
critical_actions:
|
|
112
|
+
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**自定义提示**
|
|
116
|
+
|
|
117
|
+
创建可重复使用的提示,菜单项可以通过 `action="#id"` 引用:
|
|
118
|
+
|
|
119
|
+
```yaml
|
|
120
|
+
prompts:
|
|
121
|
+
- id: deploy-prompt
|
|
122
|
+
content: |
|
|
123
|
+
Deploy the current branch to production:
|
|
124
|
+
1. Run all tests
|
|
125
|
+
2. Build the project
|
|
126
|
+
3. Execute deployment script
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### 3. 应用您的更改
|
|
130
|
+
|
|
131
|
+
编辑后,重新编译智能体以应用更改:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
npx bmad-method install
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
安装程序会检测现有安装并提供以下选项:
|
|
138
|
+
|
|
139
|
+
| Option | What It Does |
|
|
140
|
+
| ---------------------------- | ------------------------------------------------------------------- |
|
|
141
|
+
| **Quick Update** | 将所有模块更新到最新版本并重新编译所有智能体 |
|
|
142
|
+
| **Recompile Agents** | 仅应用自定义配置,不更新模块文件 |
|
|
143
|
+
| **Modify BMad Installation** | 用于添加或删除模块的完整安装流程 |
|
|
144
|
+
|
|
145
|
+
对于仅自定义配置的更改,**Recompile Agents** 是最快的选项。
|
|
146
|
+
|
|
147
|
+
## 故障排除
|
|
148
|
+
|
|
149
|
+
**更改未生效?**
|
|
150
|
+
|
|
151
|
+
- 运行 `npx bmad-method install` 并选择 **Recompile Agents** 以应用更改
|
|
152
|
+
- 检查您的 YAML 语法是否有效(缩进很重要)
|
|
153
|
+
- 验证您编辑的是该智能体正确的 `.customize.yaml` 文件
|
|
154
|
+
|
|
155
|
+
**智能体无法加载?**
|
|
156
|
+
|
|
157
|
+
- 使用在线 YAML 验证器检查 YAML 语法错误
|
|
158
|
+
- 确保在取消注释后没有留下空字段
|
|
159
|
+
- 尝试恢复到原始模板并重新构建
|
|
160
|
+
|
|
161
|
+
**需要重置智能体?**
|
|
162
|
+
|
|
163
|
+
- 清空或删除智能体的 `.customize.yaml` 文件
|
|
164
|
+
- 运行 `npx bmad-method install` 并选择 **Recompile Agents** 以恢复默认设置
|
|
165
|
+
|
|
166
|
+
## 工作流自定义
|
|
167
|
+
|
|
168
|
+
对现有 BMad Method 工作流和技能的自定义即将推出。
|
|
169
|
+
|
|
170
|
+
## 模块自定义
|
|
171
|
+
|
|
172
|
+
关于构建扩展模块和自定义现有模块的指南即将推出。
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
## 术语说明
|
|
176
|
+
|
|
177
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
178
|
+
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
|
|
179
|
+
- **persona**:角色。指智能体的身份、个性、沟通风格和行为原则的集合。
|
|
180
|
+
- **memory**:记忆。指智能体持久存储的上下文信息,用于在对话中保持连贯性。
|
|
181
|
+
- **critical action**:关键操作。指智能体启动时必须执行的指令或任务。
|
|
182
|
+
- **prompt**:提示。指发送给智能体的输入文本,用于引导其生成特定响应或执行特定操作。
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "既有项目"
|
|
3
|
+
description: 如何在现有代码库中使用 BMad Method
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 6
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
在现有项目和遗留代码库上工作时,有效使用 BMad Method。
|
|
9
|
+
|
|
10
|
+
本指南涵盖了使用 BMad Method 接入现有项目的核心工作流程。
|
|
11
|
+
|
|
12
|
+
:::note[前置条件]
|
|
13
|
+
- 已安装 BMad Method(`npx bmad-method install`)
|
|
14
|
+
- 一个你想要处理的现有代码库
|
|
15
|
+
- 访问 AI 驱动的 IDE(Claude Code 或 Cursor)
|
|
16
|
+
:::
|
|
17
|
+
|
|
18
|
+
## 步骤 1:清理已完成的规划产物
|
|
19
|
+
|
|
20
|
+
如果你通过 BMad 流程完成了所有 PRD 史诗和用户故事,请清理这些文件。归档它们、删除它们,或者在需要时依赖版本历史。不要将这些文件保留在:
|
|
21
|
+
|
|
22
|
+
- `docs/`
|
|
23
|
+
- `_bmad-output/planning-artifacts/`
|
|
24
|
+
- `_bmad-output/implementation-artifacts/`
|
|
25
|
+
|
|
26
|
+
## 步骤 2:创建项目上下文
|
|
27
|
+
|
|
28
|
+
:::tip[推荐用于既有项目]
|
|
29
|
+
生成 `project-context.md` 以捕获你现有代码库的模式和约定。这确保 AI 智能体在实施变更时遵循你既定的实践。
|
|
30
|
+
:::
|
|
31
|
+
|
|
32
|
+
运行生成项目上下文工作流程:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
/bmad-bmm-generate-project-context
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
这将扫描你的代码库以识别:
|
|
39
|
+
- 技术栈和版本
|
|
40
|
+
- 代码组织模式
|
|
41
|
+
- 命名约定
|
|
42
|
+
- 测试方法
|
|
43
|
+
- 框架特定模式
|
|
44
|
+
|
|
45
|
+
你可以查看和完善生成的文件,或者如果你更喜欢,可以在 `_bmad-output/project-context.md` 手动创建它。
|
|
46
|
+
|
|
47
|
+
[了解更多关于项目上下文](../explanation/project-context.md)
|
|
48
|
+
|
|
49
|
+
## 步骤 3:维护高质量项目文档
|
|
50
|
+
|
|
51
|
+
你的 `docs/` 文件夹应包含简洁、组织良好的文档,准确代表你的项目:
|
|
52
|
+
|
|
53
|
+
- 意图和业务理由
|
|
54
|
+
- 业务规则
|
|
55
|
+
- 架构
|
|
56
|
+
- 任何其他相关的项目信息
|
|
57
|
+
|
|
58
|
+
对于复杂项目,考虑使用 `document-project` 工作流程。它提供运行时变体,将扫描你的整个项目并记录其实际当前状态。
|
|
59
|
+
|
|
60
|
+
## 步骤 3:获取帮助
|
|
61
|
+
|
|
62
|
+
### BMad-Help:你的起点
|
|
63
|
+
|
|
64
|
+
**随时运行 `/bmad-help`,当你不确定下一步该做什么时。** 这个智能指南:
|
|
65
|
+
|
|
66
|
+
- 检查你的项目以查看已经完成了什么
|
|
67
|
+
- 根据你安装的模块显示选项
|
|
68
|
+
- 理解自然语言查询
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
/bmad-help 我有一个现有的 Rails 应用,我应该从哪里开始?
|
|
72
|
+
/bmad-help quick-flow 和完整方法有什么区别?
|
|
73
|
+
/bmad-help 显示我有哪些可用的工作流程
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
BMad-Help 还会在**每个工作流程结束时自动运行**,提供关于下一步该做什么的清晰指导。
|
|
77
|
+
|
|
78
|
+
### 选择你的方法
|
|
79
|
+
|
|
80
|
+
根据变更范围,你有两个主要选项:
|
|
81
|
+
|
|
82
|
+
| 范围 | 推荐方法 |
|
|
83
|
+
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
|
|
84
|
+
| **小型更新或添加** | 使用 `quick-flow-solo-dev` 创建技术规范并实施变更。完整的四阶段 BMad Method 可能有些过度。 |
|
|
85
|
+
| **重大变更或添加** | 从 BMad Method 开始,根据需要应用或多或少的严谨性。 |
|
|
86
|
+
|
|
87
|
+
### 在创建 PRD 期间
|
|
88
|
+
|
|
89
|
+
在创建简报或直接进入 PRD 时,确保智能体:
|
|
90
|
+
|
|
91
|
+
- 查找并分析你现有的项目文档
|
|
92
|
+
- 阅读关于你当前系统的适当上下文
|
|
93
|
+
|
|
94
|
+
你可以明确地指导智能体,但目标是确保新功能与你的现有系统良好集成。
|
|
95
|
+
|
|
96
|
+
### UX 考量
|
|
97
|
+
|
|
98
|
+
UX 工作是可选的。决定不取决于你的项目是否有 UX,而取决于:
|
|
99
|
+
|
|
100
|
+
- 你是否将处理 UX 变更
|
|
101
|
+
- 是否需要重要的新 UX 设计或模式
|
|
102
|
+
|
|
103
|
+
如果你的变更只是对你满意的现有屏幕进行简单更新,则不需要完整的 UX 流程。
|
|
104
|
+
|
|
105
|
+
### 架构考量
|
|
106
|
+
|
|
107
|
+
在进行架构工作时,确保架构师:
|
|
108
|
+
|
|
109
|
+
- 使用适当的已记录文件
|
|
110
|
+
- 扫描现有代码库
|
|
111
|
+
|
|
112
|
+
在此处要密切注意,以防止重新发明轮子或做出与你现有架构不一致的决定。
|
|
113
|
+
|
|
114
|
+
## 更多信息
|
|
115
|
+
|
|
116
|
+
- **[快速修复](./quick-fixes.md)** - 错误修复和临时变更
|
|
117
|
+
- **[既有项目 FAQ](../explanation/established-projects-faq.md)** - 关于在既有项目上工作的常见问题
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
## 术语说明
|
|
121
|
+
|
|
122
|
+
- **BMad Method**:BMad 方法。一种结构化的软件开发方法论,用于指导从分析到实施的完整流程。
|
|
123
|
+
- **PRD**:产品需求文档(Product Requirements Document)。描述产品功能、需求和目标的文档。
|
|
124
|
+
- **epic**:史诗。大型功能或用户故事的集合,通常需要较长时间完成。
|
|
125
|
+
- **story**:用户故事。描述用户需求的简短陈述,通常遵循"作为...我想要...以便于..."的格式。
|
|
126
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
127
|
+
- **IDE**:集成开发环境(Integrated Development Environment)。提供代码编辑、调试、构建等功能的软件工具。
|
|
128
|
+
- **UX**:用户体验(User Experience)。用户在使用产品或服务过程中的整体感受和交互体验。
|
|
129
|
+
- **tech-spec**:技术规范(Technical Specification)。描述技术实现细节、架构设计和开发标准的文档。
|
|
130
|
+
- **quick-flow**:快速流程。BMad Method 中的一种简化工作流程,适用于小型变更或快速迭代。
|
|
131
|
+
- **legacy codebase**:遗留代码库。指历史遗留的、可能缺乏文档或使用过时技术的代码集合。
|
|
132
|
+
- **project context**:项目上下文。描述项目技术栈、约定、模式等背景信息的文档。
|
|
133
|
+
- **artifact**:产物。在开发过程中生成的文档、代码或其他输出物。
|
|
134
|
+
- **runtime variant**:运行时变体。在程序运行时可选择或切换的不同实现方式或配置。
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "如何获取关于 BMad 的答案"
|
|
3
|
+
description: 使用 LLM 快速回答您自己的 BMad 问题
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 4
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 从这里开始:BMad-Help
|
|
9
|
+
|
|
10
|
+
**获取关于 BMad 答案的最快方式是 `/bmad-help`。** 这个智能指南可以回答超过 80% 的问题,并且直接在您的 IDE 中可用,方便您工作时使用。
|
|
11
|
+
|
|
12
|
+
BMad-Help 不仅仅是一个查询工具——它:
|
|
13
|
+
- **检查您的项目**以查看已完成的内容
|
|
14
|
+
- **理解自然语言**——用简单的英语提问
|
|
15
|
+
- **根据您安装的模块变化**——显示相关选项
|
|
16
|
+
- **在工作流后自动运行**——告诉您接下来该做什么
|
|
17
|
+
- **推荐第一个必需任务**——无需猜测从哪里开始
|
|
18
|
+
|
|
19
|
+
### 如何使用 BMad-Help
|
|
20
|
+
|
|
21
|
+
只需使用斜杠命令运行它:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
/bmad-help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
或者结合自然语言查询:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
/bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始?
|
|
31
|
+
/bmad-help 我在 UX 设计方面有哪些选择?
|
|
32
|
+
/bmad-help 我在 PRD 工作流上卡住了
|
|
33
|
+
/bmad-help 向我展示到目前为止已完成的内容
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
BMad-Help 会回应:
|
|
37
|
+
- 针对您情况的建议
|
|
38
|
+
- 第一个必需任务是什么
|
|
39
|
+
- 流程的其余部分是什么样的
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 何时使用本指南
|
|
44
|
+
|
|
45
|
+
在以下情况下使用本节:
|
|
46
|
+
- 您想了解 BMad 的架构或内部机制
|
|
47
|
+
- 您需要 BMad-Help 提供范围之外的答案
|
|
48
|
+
- 您在安装前研究 BMad
|
|
49
|
+
- 您想直接探索源代码
|
|
50
|
+
|
|
51
|
+
## 步骤
|
|
52
|
+
|
|
53
|
+
### 1. 选择您的来源
|
|
54
|
+
|
|
55
|
+
| 来源 | 最适合用于 | 示例 |
|
|
56
|
+
| -------------------- | ----------------------------------------- | ---------------------------- |
|
|
57
|
+
| **`_bmad` 文件夹** | BMad 如何工作——智能体、工作流、提示词 | "PM 智能体做什么?" |
|
|
58
|
+
| **完整的 GitHub 仓库** | 历史、安装程序、架构 | "v6 中有什么变化?" |
|
|
59
|
+
| **`llms-full.txt`** | 来自文档的快速概述 | "解释 BMad 的四个阶段" |
|
|
60
|
+
|
|
61
|
+
`_bmad` 文件夹在您安装 BMad 时创建。如果您还没有它,请改为克隆仓库。
|
|
62
|
+
|
|
63
|
+
### 2. 将您的 AI 指向来源
|
|
64
|
+
|
|
65
|
+
**如果您的 AI 可以读取文件(Claude Code、Cursor 等):**
|
|
66
|
+
|
|
67
|
+
- **已安装 BMad:** 指向 `_bmad` 文件夹并直接提问
|
|
68
|
+
- **想要更深入的上下文:** 克隆[完整仓库](https://github.com/bmad-code-org/BMAD-METHOD)
|
|
69
|
+
|
|
70
|
+
**如果您使用 ChatGPT 或 Claude.ai:**
|
|
71
|
+
|
|
72
|
+
将 `llms-full.txt` 获取到您的会话中:
|
|
73
|
+
|
|
74
|
+
```text
|
|
75
|
+
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### 3. 提出您的问题
|
|
80
|
+
|
|
81
|
+
:::note[示例]
|
|
82
|
+
**问:** "告诉我用 BMad 构建某物的最快方式"
|
|
83
|
+
|
|
84
|
+
**答:** 使用快速流程:运行 `quick-spec` 编写技术规范,然后运行 `quick-dev` 实现它——跳过完整的规划阶段。
|
|
85
|
+
:::
|
|
86
|
+
|
|
87
|
+
## 您将获得什么
|
|
88
|
+
|
|
89
|
+
关于 BMad 的直接答案——智能体如何工作、工作流做什么、为什么事物以这种方式构建——无需等待其他人回应。
|
|
90
|
+
|
|
91
|
+
## 提示
|
|
92
|
+
|
|
93
|
+
- **验证令人惊讶的答案**——LLM 偶尔会出错。检查源文件或在 Discord 上询问。
|
|
94
|
+
- **具体化**——"PRD 工作流的第 3 步做什么?"比"PRD 如何工作?"更好
|
|
95
|
+
|
|
96
|
+
## 仍然卡住了?
|
|
97
|
+
|
|
98
|
+
尝试了 LLM 方法但仍需要帮助?您现在有一个更好的问题可以问。
|
|
99
|
+
|
|
100
|
+
| 频道 | 用于 |
|
|
101
|
+
| ------------------------- | ------------------------------------------- |
|
|
102
|
+
| `#bmad-method-help` | 快速问题(实时聊天) |
|
|
103
|
+
| `help-requests` 论坛 | 详细问题(可搜索、持久) |
|
|
104
|
+
| `#suggestions-feedback` | 想法和功能请求 |
|
|
105
|
+
| `#report-bugs-and-issues` | 错误报告 |
|
|
106
|
+
|
|
107
|
+
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
|
|
108
|
+
|
|
109
|
+
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)(用于明确的错误)
|
|
110
|
+
|
|
111
|
+
*你!*
|
|
112
|
+
*卡住*
|
|
113
|
+
*在队列中——*
|
|
114
|
+
*等待*
|
|
115
|
+
*等待谁?*
|
|
116
|
+
|
|
117
|
+
*来源*
|
|
118
|
+
*就在那里,*
|
|
119
|
+
*显而易见!*
|
|
120
|
+
|
|
121
|
+
*指向*
|
|
122
|
+
*你的机器。*
|
|
123
|
+
*释放它。*
|
|
124
|
+
|
|
125
|
+
*它读取。*
|
|
126
|
+
*它说话。*
|
|
127
|
+
*尽管问——*
|
|
128
|
+
|
|
129
|
+
*为什么要等*
|
|
130
|
+
*明天*
|
|
131
|
+
*当你拥有*
|
|
132
|
+
*今天?*
|
|
133
|
+
|
|
134
|
+
*—Claude*
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
## 术语说明
|
|
138
|
+
|
|
139
|
+
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
|
|
140
|
+
- **LLM**:大语言模型。基于深度学习的自然语言处理模型,能够理解和生成人类语言。
|
|
141
|
+
- **SaaS**:软件即服务。一种通过互联网提供软件应用的交付模式。
|
|
142
|
+
- **UX**:用户体验。用户在使用产品或服务过程中建立的主观感受和评价。
|
|
143
|
+
- **PRD**:产品需求文档。详细描述产品功能、特性和需求的正式文档。
|
|
144
|
+
- **IDE**:集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。
|