From ba2a5cc6a063757f724939e4e3044f602131bca4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=A2=81=E5=B1=B1=E6=B2=B3?= <392425595@qq.com> Date: Mon, 23 Mar 2026 00:09:23 +0800 Subject: [PATCH] docs(zh-cn): align getting-started tutorial workflows (#2093) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(zh-cn): align getting-started tutorial workflows 我按英文源文更新中文入门教程中的命令、工作流和智能体调用方式， 并统一步骤叙述与导航语义，减少术语漂移和旧命令误导。 Feishu: https://www.feishu.cn/ Made-with: Cursor * docs(zh-cn): fix tutorial skill names 我将入门教程阶段 1 中过时或不可用的技能名替换为当前可调用的技能名。 此前 `bmad-research` 与 `bmad-create-product-brief` 可能导致新用户执行受阻；现在改为具体研究技能与 `bmad-product-brief`，提升教程可执行性。 Feishu: Made-with: Cursor --------- Co-authored-by: leon Co-authored-by: Alex Verkhovsky --- docs/zh-cn/tutorials/getting-started.md | 97 +++++++++---------------- 1 file changed, 36 insertions(+), 61 deletions(-) diff --git a/docs/zh-cn/tutorials/getting-started.md b/docs/zh-cn/tutorials/getting-started.md index 86c68203a..468ff189e 100644 --- a/docs/zh-cn/tutorials/getting-started.md +++ b/docs/zh-cn/tutorials/getting-started.md @@ -37,13 +37,13 @@ description: 安装 BMad 并构建你的第一个项目 ### 如何使用 BMad-Help -只需在 AI IDE 中使用斜杠命令运行它： +在你的 AI IDE 中直接调用技能名： ``` bmad-help ``` -或者结合问题以获得上下文感知的指导： +也可以带着问题一起调用，获得更贴合上下文的建议： ``` bmad-help 我有一个 SaaS 产品的想法，我已经知道我想要的所有功能。我应该从哪里开始？ @@ -70,7 +70,7 @@ BMad 通过带有专门 AI 智能体的引导工作流帮助你构建软件。 | ---- | -------------- | -------------------------------------------------- | | 1 | 分析 | 头脑风暴、研究、产品简报 *（可选）* | | 2 | 规划 | 创建需求（PRD 或技术规范） | -| 3 | 解决方案设计 | 设计架构 *（仅限 BMad Method/Enterprise only）* | +| 3 | 解决方案设计 | 设计架构 *（仅适用于 BMad Method/Enterprise）* | | 4 | 实现 | 逐个史诗、逐个故事地构建 | **[打开工作流地图](../reference/workflow-map.md)** 以探索阶段、工作流和上下文管理。 @@ -95,6 +95,8 @@ BMad 通过带有专门 AI 智能体的引导工作流帮助你构建软件。 npx bmad-method install ``` +如果你想使用最新预发布版本（而不是默认发布通道），可以改用 `npx bmad-method@next install`。 + 当提示选择模块时，选择 **BMad Method**。 安装程序会创建两个文件夹： @@ -112,7 +114,7 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 ::: :::note[如何加载智能体和运行工作流] -每个工作流都有一个你在 IDE 中运行的**斜杠命令**（例如 `bmad-bmm-create-prd`）。运行工作流命令会自动加载相应的智能体 —— 你不需要单独加载智能体。你也可以直接加载智能体进行一般对话（例如，加载 PM 智能体使用 `bmad-agent-bmm-pm`）。 +每个工作流都可以通过技能名直接调用（例如 `bmad-create-prd`）。你的 AI IDE 会识别 `bmad-*` 技能并执行，无需额外单独加载智能体。你也可以直接调用智能体技能进行通用对话（例如 PM 智能体用 `bmad-pm`）。 ::: :::caution[新对话] @@ -126,35 +128,35 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 :::tip[项目上下文（可选）] 在开始之前，考虑创建 `project-context.md` 来记录你的技术偏好和实现规则。这确保所有 AI 智能体在整个项目中遵循你的约定。 -在 `_bmad-output/project-context.md` 手动创建它，或在架构之后使用 `bmad-bmm-generate-project-context` 生成它。[了解更多](../explanation/project-context.md)。 +在 `_bmad-output/project-context.md` 手动创建它，或在架构之后使用 `bmad-generate-project-context` 生成它。[了解更多](../explanation/project-context.md)。 ::: ### 阶段 1：分析（可选） 此阶段中的所有工作流都是可选的： - **头脑风暴**（`bmad-brainstorming`） — 引导式构思 -- **研究**（`bmad-bmm-research`） — 市场和技术研究 -- **创建产品简报**（`bmad-bmm-create-product-brief`） — 推荐的基础文档 +- **研究**（`bmad-market-research` / `bmad-domain-research` / `bmad-technical-research`） — 市场、领域和技术研究 +- **创建产品简报**（`bmad-product-brief`） — 推荐的基础文档 ### 阶段 2：规划（必需） **对于 BMad Method 和 Enterprise 路径：** -1. 在新对话中加载 **PM 智能体**（`bmad-agent-bmm-pm`） -2. 运行 `prd` 工作流（`bmad-bmm-create-prd`） +1. 在新对话中调用 **PM 智能体**（`bmad-pm`） +2. 运行 `bmad-create-prd` 工作流（`bmad-create-prd`） 3. 输出：`PRD.md` **对于 Quick Flow 路径：** -- 运行 `bmad-bmm-quick-dev` — 它在单个工作流中处理规划和实现，跳转到实现 +- 运行 `bmad-quick-dev` —— 它会在一个工作流里同时处理规划与实现，可直接进入实现阶段 :::note[UX 设计（可选）] -如果你的项目有用户界面，在创建 PRD 后加载 **UX-Designer 智能体**（`bmad-agent-bmm-ux-designer`）并运行 UX 设计工作流（`bmad-bmm-create-ux-design`）。 +如果你的项目有用户界面，在创建 PRD 后调用 **UX-Designer 智能体**（`bmad-ux-designer`），然后运行 UX 设计工作流（`bmad-create-ux-design`）。 ::: ### 阶段 3：解决方案设计（BMad Method/Enterprise） **创建架构** -1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`） -2. 运行 `create-architecture`（`bmad-bmm-create-architecture`） +1. 在新对话中调用 **Architect 智能体**（`bmad-architect`） +2. 运行 `bmad-create-architecture`（`bmad-create-architecture`） 3. 输出：包含技术决策的架构文档 **创建史诗和故事** @@ -163,13 +165,13 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 史诗和故事现在在架构*之后*创建。这会产生更高质量的故事，因为架构决策（数据库、API 模式、技术栈）直接影响工作应该如何分解。 ::: -1. 在新对话中加载 **PM 智能体**（`bmad-agent-bmm-pm`） -2. 运行 `create-epics-and-stories`（`bmad-bmm-create-epics-and-stories`） +1. 在新对话中调用 **PM 智能体**（`bmad-pm`） +2. 运行 `bmad-create-epics-and-stories`（`bmad-create-epics-and-stories`） 3. 工作流使用 PRD 和架构来创建技术信息丰富的故事 **实现就绪检查** *（强烈推荐）* -1. 在新对话中加载 **Architect 智能体**（`bmad-agent-bmm-architect`） -2. 运行 `check-implementation-readiness`（`bmad-bmm-check-implementation-readiness`） +1. 在新对话中调用 **Architect 智能体**（`bmad-architect`） +2. 运行 `bmad-check-implementation-readiness`（`bmad-check-implementation-readiness`） 3. 验证所有规划文档之间的一致性 ## 步骤 2：构建你的项目 @@ -178,7 +180,7 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 ### 初始化冲刺规划 -加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `sprint-planning`（`bmad-bmm-sprint-planning`）。这将创建 `sprint-status.yaml` 来跟踪所有史诗和故事。 +调用 **SM 智能体**（`bmad-sm`）并运行 `bmad-sprint-planning`（`bmad-sprint-planning`）。这会创建 `sprint-status.yaml` 来跟踪所有史诗和故事。 ### 构建周期 @@ -186,11 +188,11 @@ BMad-Help 将检测你已完成的内容，并准确推荐下一步该做什么 | 步骤 | 智能体 | 工作流 | 命令 | 目的 | | ---- | ------ | ------------ | ----------------------- | ------------------------------- | -| 1 | SM | `create-story` | `bmad-bmm-create-story` | 从史诗创建故事文件 | -| 2 | DEV | `dev-story` | `bmad-bmm-dev-story` | 实现故事 | -| 3 | DEV | `code-review` | `bmad-bmm-code-review` | 质量验证 *（推荐）* | +| 1 | SM | `bmad-create-story` | `bmad-create-story` | 从史诗创建故事文件 | +| 2 | DEV | `bmad-dev-story` | `bmad-dev-story` | 实现故事 | +| 3 | DEV | `bmad-code-review` | `bmad-code-review` | 质量验证 *（推荐）* | -完成史诗中的所有故事后，加载 **SM 智能体**（`bmad-agent-bmm-sm`）并运行 `retrospective`（`bmad-bmm-retrospective`）。 +完成史诗中的所有故事后，调用 **SM 智能体**（`bmad-sm`）并运行 `bmad-retrospective`（`bmad-retrospective`）。 ## 你已完成的工作 @@ -221,16 +223,16 @@ your-project/ | 工作流 | 命令 | 智能体 | 目的 | | ----------------------------------- | --------------------------------------- | -------- | -------------------------------------------- | -| **`help`** ⭐ | `bmad-help` | 任意 | **你的智能向导 —— 随时询问任何问题！** | -| `prd` | `bmad-bmm-create-prd` | PM | 创建产品需求文档 | -| `create-architecture` | `bmad-bmm-create-architecture` | Architect | 创建架构文档 | -| `generate-project-context` | `bmad-bmm-generate-project-context` | Analyst | 创建项目上下文文件 | -| `create-epics-and-stories` | `bmad-bmm-create-epics-and-stories` | PM | 将 PRD 分解为史诗 | -| `check-implementation-readiness` | `bmad-bmm-check-implementation-readiness` | Architect | 验证规划一致性 | -| `sprint-planning` | `bmad-bmm-sprint-planning` | SM | 初始化冲刺跟踪 | -| `create-story` | `bmad-bmm-create-story` | SM | 创建故事文件 | -| `dev-story` | `bmad-bmm-dev-story` | DEV | 实现故事 | -| `code-review` | `bmad-bmm-code-review` | DEV | 审查已实现的代码 | +| **`bmad-help`** ⭐ | `bmad-help` | 任意 | **你的智能向导 —— 随时询问任何问题！** | +| `bmad-create-prd` | `bmad-create-prd` | PM | 创建产品需求文档 | +| `bmad-create-architecture` | `bmad-create-architecture` | Architect | 创建架构文档 | +| `bmad-generate-project-context` | `bmad-generate-project-context` | Analyst | 创建项目上下文文件 | +| `bmad-create-epics-and-stories` | `bmad-create-epics-and-stories` | PM | 将 PRD 分解为史诗 | +| `bmad-check-implementation-readiness` | `bmad-check-implementation-readiness` | Architect | 验证规划一致性 | +| `bmad-sprint-planning` | `bmad-sprint-planning` | SM | 初始化冲刺跟踪 | +| `bmad-create-story` | `bmad-create-story` | SM | 创建故事文件 | +| `bmad-dev-story` | `bmad-dev-story` | DEV | 实现故事 | +| `bmad-code-review` | `bmad-code-review` | DEV | 审查已实现的代码 | ## 常见问题 @@ -238,10 +240,10 @@ your-project/ 仅对于 BMad Method 和 Enterprise 路径。Quick Flow 从技术规范跳转到实现。 **我可以稍后更改我的计划吗？** -可以。SM 智能体有一个 `correct-course` 工作流（`bmad-bmm-correct-course`）用于处理范围变更。 +可以。SM 智能体提供 `bmad-correct-course` 工作流（`bmad-correct-course`）来处理范围变化。 **如果我想先进行头脑风暴怎么办？** -在开始 PRD 之前，加载 Analyst 智能体（`bmad-agent-bmm-analyst`）并运行 `brainstorming`（`bmad-brainstorming`）。 +在开始 PRD 之前，调用 Analyst 智能体（`bmad-analyst`）并运行 `bmad-brainstorming`（`bmad-brainstorming`）。 **我需要遵循严格的顺序吗？** 不一定。一旦你了解了流程，你可以使用上面的快速参考直接运行工作流。 @@ -271,30 +273,3 @@ BMad-Help 检查你的项目，检测你已完成的内容，并确切地告诉 ::: 准备好开始了吗？安装 BMad，运行 `bmad-help`，让你的智能向导为你引路。 - ---- -## 术语说明 - -- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。 -- **epic**：史诗。软件开发中用于组织和管理大型功能或用户需求的高级工作项。 -- **story**：故事。敏捷开发中的用户故事，描述用户需求的小型工作项。 -- **PRD**：产品需求文档（Product Requirements Document）。详细描述产品功能、需求和目标的文档。 -- **workflow**：工作流。一系列有序的任务或步骤，用于完成特定目标。 -- **sprint**：冲刺。敏捷开发中的固定时间周期，用于完成预定的工作。 -- **IDE**：集成开发环境（Integrated Development Environment）。提供代码编辑、调试等功能的软件工具。 -- **artifact**：工件。软件开发过程中产生的文档、代码或其他可交付成果。 -- **retrospective**：回顾。敏捷开发中的会议，用于反思和改进团队工作流程。 -- **tech-spec**：技术规范（Technical Specification）。描述系统技术实现细节的文档。 -- **UX**：用户体验（User Experience）。用户在使用产品过程中的整体感受和交互体验。 -- **PM**：产品经理（Product Manager）。负责产品规划、需求管理和团队协调的角色。 -- **SM**：Scrum Master。敏捷开发中的角色，负责促进 Scrum 流程和团队协作。 -- **DEV**：开发者（Developer）。负责编写代码和实现功能的角色。 -- **Architect**：架构师。负责系统架构设计和技术决策的角色。 -- **Analyst**：分析师。负责需求分析、市场研究等工作的角色。 -- **npx**：Node Package eXecute。Node.js 包执行器，用于运行 npm 包而无需安装。 -- **Node.js**：基于 Chrome V8 引擎的 JavaScript 运行时环境。 -- **Git**：分布式版本控制系统。 -- **SaaS**：软件即服务（Software as a Service）。通过互联网提供软件服务的模式。 -- **DevOps**：开发运维（Development and Operations）。强调开发和运维协作的实践和方法。 -- **multi-tenant**：多租户。一种软件架构，允许单个实例为多个客户（租户）提供服务。 -- **compliance**：合规性。遵守法律、法规和行业标准的要求。