Skip to content

Commit 0d7d7da

Browse files
lrliangleonalexeyv
authored
docs(zh-cn-reference): refresh workflow and skill references (#2100)
我统一修订中文 reference 中 workflow-map、commands、agents、core-tools 四页，改正过时命名与调用方式，并将术语切换到当前 skills 体系。此前这些页面混用了旧版前缀和命令语义，容易让用户在查阅阶段误用流程；现在页面结构与英文源和现行实现保持一致，同时优先串联中文路径以提升检索效率。 Feishu: https://feishu.cn/wiki/TODO Made-with: Cursor Co-authored-by: leon <leon.liang@hairobotics.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
1 parent a04635e commit 0d7d7da

4 files changed

Lines changed: 311 additions & 411 deletions

File tree

‎docs/zh-cn/reference/agents.md‎

Lines changed: 51 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,62 @@
11
---
22
title: "智能体"
3-
description: 默认 BMM 智能体及其菜单触发器和主要工作流
3+
description: 默认 BMM 智能体的 skill ID、触发器与主要 workflow 速查。
44
sidebar:
55
order: 2
66
---
77

8-
## 默认智能体
8+
本页列出 BMad Method 默认提供的 BMM（Agile 套件）智能体，包括它们的 skill ID、菜单触发器和主要 workflow。
99

10-
本页列出了随 BMad Method 安装的默认 BMM（Agile 套件）智能体，以及它们的菜单触发器和主要工作流。
10+
## 默认智能体列表
1111

12-
## 注意事项
12+
| 智能体 | Skill ID | 触发器 | 主要 workflow |
13+
| --- | --- | --- | --- |
14+
| Analyst (Mary) | `bmad-analyst` | `BP`、`RS`、`CB`、`DP` | Brainstorm、Research、Create Brief、Document Project |
15+
| Product Manager (John) | `bmad-pm` | `CP`、`VP`、`EP`、`CE`、`IR`、`CC` | Create/Validate/Edit PRD、Create Epics and Stories、Implementation Readiness、Correct Course |
16+
| Architect (Winston) | `bmad-architect` | `CA`、`IR` | Create Architecture、Implementation Readiness |
17+
| Scrum Master (Bob) | `bmad-sm` | `SP`、`CS`、`ER`、`CC` | Sprint Planning、Create Story、Epic Retrospective、Correct Course |
18+
| Developer (Amelia) | `bmad-dev` | `DS`、`CR` | Dev Story、Code Review |
19+
| QA Engineer (Quinn) | `bmad-qa` | `QA` | Automate（为既有功能生成测试） |
20+
| Quick Flow Solo Dev (Barry) | `bmad-master` | `QD`、`CR` | Quick Dev、Code Review |
21+
| UX Designer (Sally) | `bmad-ux-designer` | `CU` | Create UX Design |
22+
| Technical Writer (Paige) | `bmad-tech-writer` | `DP`、`WD`、`US`、`MG`、`VD`、`EC` | Document Project、Write Document、Update Standards、Mermaid Generate、Validate Doc、Explain Concept |
1323

14-
- 触发器是显示在每个智能体菜单中的简短菜单代码（例如 `CP`）和模糊匹配。
15-
- 斜杠命令是单独生成的。斜杠命令列表及其定义位置请参阅[命令](./commands.md)。
16-
- QA（Quinn）是 BMM 中的轻量级测试自动化智能体。完整的测试架构师（TEA）位于其独立模块中。
24+
## 使用说明
1725

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) | `QD`, `CR` | 快速开发、代码评审 |
27-
| UX Designer (Sally) | `CU` | 创建 UX 设计 |
28-
| Technical Writer (Paige) | `DP`, `WD`, `US`, `MG`, `VD`, `EC` | 文档化项目、撰写文档、更新标准、Mermaid 生成、验证文档、解释概念 |
26+
- `Skill ID` 是直接调用该智能体的名称（例如 `bmad-dev`）
27+
- 触发器是进入智能体会话后可使用的菜单短码
28+
- QA（Quinn）是 BMM 内置轻量测试角色；完整 TEA 能力位于独立模块
2929

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**：一种用于生成图表和流程图的文本语法。
30+
## 触发器类型
31+
32+
### 工作流触发器（通常不需要额外参数）
33+
34+
多数触发器会直接启动结构化 workflow。你只需输入触发码，然后按流程提示提供信息。
35+
36+
示例：`CP`（Create PRD）、`DS`（Dev Story）、`CA`（Create Architecture）、`QD`（Quick Dev）
37+
38+
### 会话触发器（需要附带说明）
39+
40+
部分触发器进入自由对话模式，需要你在触发码后描述需求。
41+
42+
| 智能体 | 触发器 | 你需要提供的内容 |
43+
| --- | --- | --- |
44+
| Technical Writer (Paige) | `WD` | 要撰写的文档主题与目标 |
45+
| Technical Writer (Paige) | `US` | 要补充到标准中的偏好/规范 |
46+
| Technical Writer (Paige) | `MG` | 图示类型与图示内容描述 |
47+
| Technical Writer (Paige) | `VD` | 待验证文档与关注点 |
48+
| Technical Writer (Paige) | `EC` | 需要解释的概念名称 |
49+
50+
示例：
51+
52+
```text
53+
WD 写一份 Docker 部署指南
54+
MG 画一个认证流程的时序图
55+
EC 解释模块系统如何运作
56+
```
57+
58+
## 相关参考
59+
60+
- [技能（Skills）参考](./commands.md)
61+
- [工作流地图](./workflow-map.md)
62+
- [核心工具参考](./core-tools.md)

‎docs/zh-cn/reference/commands.md‎

Lines changed: 71 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -1,166 +1,122 @@
11
---
2-
title: "命令"
3-
description: BMad 斜杠命令参考——它们是什么、如何工作以及在哪里找到它们。
2+
title: "技能（Skills）"
3+
description: BMad 技能参考：它们是什么、如何生成以及如何调用。
44
sidebar:
55
order: 3
66
---
77

8-
斜杠命令是预构建的提示词，用于在 IDE 中加载智能体、运行工作流或执行任务。BMad 安装程序在安装时根据已安装的模块生成这些命令。如果您后续添加、删除或更改模块，请重新运行安装程序以保持命令同步（参见[故障排除](#troubleshooting)）。
8+
每次运行 `npx bmad-method install`，BMad 会基于你选择的模块生成一组 **skills**。你可以直接输入 skill 名称调用 workflow、任务、工具或智能体角色。
99

10-
## 命令与智能体菜单触发器
10+
## Skills 与菜单触发器的区别
1111

12-
BMad 提供两种开始工作的方式，它们服务于不同的目的。
13-
14-
| 机制 | 调用方式 | 发生什么 |
12+
| 机制 | 调用方式 | 适用场景 |
1513
| --- | --- | --- |
16-
| **斜杠命令** | 在 IDE 中输入 `bmad-...` | 直接加载智能体、运行工作流或执行任务 |
17-
| **智能体菜单触发器** | 先加载智能体，然后输入简短代码（例如 `DS`） | 智能体解释代码并启动匹配的工作流，同时保持角色设定 |
18-
19-
智能体菜单触发器需要活动的智能体会话。当您知道要使用哪个工作流时，使用斜杠命令。当您已经与智能体一起工作并希望在不离开对话的情况下切换任务时，使用触发器。
14+
| **Skill** | 直接输入 skill 名（如 `bmad-help`） | 你已明确要运行哪个功能 |
15+
| **智能体菜单触发器** | 先加载智能体，再输入短触发码（如 `DS`） | 你在智能体会话内连续切换任务 |
2016

21-
## 命令如何生成
17+
菜单触发器依赖“已激活的智能体会话”；skill 可独立运行。
2218

23-
当您运行 `npx bmad-method install` 时，安装程序会读取每个选定模块的清单，并为每个智能体、工作流、任务和工具编写一个命令文件。每个文件都是一个简短的 Markdown 提示词，指示 AI 加载相应的源文件并遵循其指令。
19+
## Skills 如何生成
2420

25-
安装程序为每种命令类型使用模板：
21+
安装程序会读取已选模块，为每个 agent / workflow / task / tool 生成一个 skill 目录，目录中包含 `SKILL.md` 入口文件。
2622

27-
| 命令类型 | 生成的文件的作用 |
23+
| Skill 类型 | 生成行为 |
2824
| --- | --- |
29-
| **智能体启动器** | 加载智能体角色文件，激活其菜单，并保持角色设定 |
30-
| **工作流命令** | 加载工作流引擎（`workflow.xml`）并传递工作流配置 |
31-
| **任务命令** | 加载独立任务文件并遵循其指令 |
32-
| **工具命令** | 加载独立工具文件并遵循其指令 |
25+
| Agent launcher | 加载角色设定并激活菜单 |
26+
| Workflow skill | 加载 workflow 配置并执行步骤 |
27+
| Task skill | 执行独立任务 |
28+
| Tool skill | 执行独立工具 |
3329

34-
:::note[重新运行安装程序]
35-
如果您添加或删除模块，请再次运行安装程序。它会重新生成所有命令文件以匹配您当前的模块选择。
30+
:::note[模块变更后要重装]
31+
当你新增、删除或切换模块后，请重新运行安装程序，避免 skill 列表与模块状态不一致。
3632
:::
3733

38-
## 命令文件的位置
34+
## Skill 文件位置
3935

40-
安装程序将命令文件写入项目内 IDE 特定的目录中。确切路径取决于您在安装期间选择的 IDE。
41-
42-
| IDE / CLI | 命令目录 |
36+
| IDE / CLI | Skills 目录 |
4337
| --- | --- |
44-
| Claude Code | `.claude/commands/` |
45-
| Cursor | `.cursor/commands/` |
46-
| Windsurf | `.windsurf/workflows/` |
47-
| 其他 IDE | 请参阅安装程序输出中的目标路径 |
38+
| Claude Code | `.claude/skills/` |
39+
| Cursor | `.cursor/skills/` |
40+
| Windsurf | `.windsurf/skills/` |
41+
| 其他 IDE | 以安装器输出路径为准 |
4842

49-
所有 IDE 都在其命令目录中接收一组扁平的命令文件。例如，Claude Code 安装看起来像：
43+
示例（Claude Code）：
5044

5145
```text
52-
.claude/commands/
53-
├── bmad-agent-bmm-dev.md
54-
├── bmad-agent-bmm-pm.md
55-
├── bmad-bmm-create-prd.md
56-
├── bmad-editorial-review-prose.md
57-
├── bmad-help.md
46+
.claude/skills/
47+
├── bmad-help/
48+
│ └── SKILL.md
49+
├── bmad-create-prd/
50+
│ └── SKILL.md
51+
├── bmad-dev/
52+
│ └── SKILL.md
5853
└── ...
5954
```
6055

61-
文件名决定了 IDE 中的技能名称。例如，文件 `bmad-agent-bmm-dev.md` 注册技能 `bmad-agent-bmm-dev`。
62-
63-
## 如何发现您的命令
56+
skill 目录名就是调用名，例如 `bmad-dev/` 对应 skill `bmad-dev`。
6457

65-
在 IDE 中输入 `/bmad` 并使用自动完成功能浏览可用命令。
58+
## 如何发现可用 skills
6659

67-
运行 `bmad-help` 获取关于下一步的上下文感知指导。
60+
- 在 IDE 中直接输入 `bmad-` 前缀查看补全候选
61+
- 运行 `bmad-help` 获取基于当前项目状态的下一步建议
62+
- 打开 skills 目录查看完整清单（这是最权威来源）
6863

69-
:::tip[快速发现]
70-
项目中生成的命令文件夹是权威列表。在文件资源管理器中打开它们以查看每个命令及其描述。
64+
:::tip[快速定位]
65+
不确定该跑哪个 workflow 时，先执行 `bmad-help`，通常比人工翻文档更快。
7166
:::
7267

73-
## 命令类别
68+
## Skill 分类与示例
7469

75-
### 智能体命令
70+
### 智能体技能（Agent Skills）
7671

77-
智能体命令加载具有定义角色、沟通风格和工作流菜单的专业化 AI 角色。加载后，智能体保持角色设定并响应菜单触发器。
72+
加载一个角色化智能体，并保持其 persona 与菜单上下文。
7873

79-
| 示例命令 | 智能体 | 角色 |
74+
| 示例 skill | 角色 | 用途 |
8075
| --- | --- | --- |
81-
| `bmad-agent-bmm-dev` | Amelia（开发者） | 严格按照规范实现故事 |
82-
| `bmad-agent-bmm-pm` | John（产品经理） | 创建和验证 PRD |
83-
| `bmad-agent-bmm-architect` | Winston（架构师） | 设计系统架构 |
84-
| `bmad-agent-bmm-sm` | Bob（Scrum Master） | 管理冲刺和故事 |
76+
| `bmad-dev` | Developer（Amelia） | 按规范实现 story |
77+
| `bmad-pm` | Product Manager（John） | 创建与校验 PRD |
78+
| `bmad-architect` | Architect（Winston） | 架构设计与约束定义 |
79+
| `bmad-sm` | Scrum Master（Bob） | 冲刺与 story 流程管理 |
8580

86-
参见[智能体](./agents.md)获取默认智能体及其触发器的完整列表。
81+
完整列表见 [智能体参考](./agents.md)。
8782

88-
### 工作流命令
83+
### Workflow Skills
8984

90-
工作流命令运行结构化的多步骤过程，而无需先加载智能体角色。它们加载工作流引擎并传递特定的工作流配置。
85+
无需先加载 agent，直接运行结构化流程。
9186

92-
| 示例命令 | 目的 |
87+
| 示例 skill | 用途 |
9388
| --- | --- |
94-
| `bmad-bmm-create-prd` | 创建产品需求文档 |
95-
| `bmad-bmm-create-architecture` | 设计系统架构 |
96-
| `bmad-bmm-dev-story` | 实现故事 |
97-
| `bmad-bmm-code-review` | 运行代码审查 |
98-
| `bmad-bmm-quick-dev` | 统一快速流程 — 澄清意图、规划、实现、审查、呈现 |
89+
| `bmad-create-prd` | 创建 PRD |
90+
| `bmad-create-architecture` | 创建架构方案 |
91+
| `bmad-create-epics-and-stories` | 拆分 epics/stories |
92+
| `bmad-dev-story` | 实现指定 story |
93+
| `bmad-code-review` | 代码评审 |
94+
| `bmad-quick-dev` | 快速流程（澄清→规划→实现→审查→呈现） |
9995

100-
参见[工作流地图](./workflow-map.md)获取按阶段组织的完整工作流参考。
96+
按阶段查看见 [工作流地图](./workflow-map.md)。
10197

102-
### 任务和工具命令
98+
### Task / Tool Skills
10399

104-
任务和工具是独立的操作，不需要智能体或工作流上下文。
100+
独立任务，不依赖特定智能体上下文。
105101

106-
#### BMad-Help：您的智能向导
102+
**`bmad-help`** 是最常用入口：它会读取项目状态并给出“下一步建议 + 对应 skill”。
107103

108-
**`bmad-help`** 是您发现下一步操作的主要界面。它不仅仅是一个查找工具——它是一个智能助手，可以：
104+
更多核心任务和工具见 [核心工具参考](./core-tools.md)。
109105

110-
- **检查您的项目**以查看已经完成的工作
111-
- **理解自然语言查询**——用简单的英语提问
112-
- **根据已安装的模块而变化**——根据您拥有的内容显示选项
113-
- **在工作流后自动调用**——每个工作流都以清晰的下一步结束
114-
- **推荐第一个必需任务**——无需猜测从哪里开始
106+
## 命名规则
115107

116-
**示例：**
108+
所有技能统一以 `bmad-` 开头，后接语义化名称（如 `bmad-dev`、`bmad-create-prd`、`bmad-help`）。
117109

118-
```
119-
bmad-help
120-
bmad-help 我有一个 SaaS 想法并且知道所有功能。我应该从哪里开始？
121-
bmad-help 我在 UX 设计方面有哪些选择？
122-
bmad-help 我在 PRD 工作流上卡住了
123-
```
110+
## 故障排查
124111

125-
#### 其他任务和工具
112+
**安装后看不到 skills：** 某些 IDE 需要手动启用 skills，或重启 IDE 才会刷新。
126113

127-
| 示例命令 | 目的 |
128-
| --- | --- |
129-
| `bmad-shard-doc` | 将大型 Markdown 文件拆分为较小的部分 |
130-
| `bmad-index-docs` | 索引项目文档 |
131-
| `bmad-editorial-review-prose` | 审查文档散文质量 |
114+
**缺少预期 skill：** 可能模块未安装或安装时未勾选。重新运行安装程序并确认模块选择。
132115

133-
## 命名约定
116+
**已移除模块的 skills 仍存在：** 安装器不会自动清理历史目录。手动删除旧 skill 目录后再重装可获得干净结果。
134117

135-
命令名称遵循可预测的模式。
118+
## 相关参考
136119

137-
| 模式 | 含义 | 示例 |
138-
| --- | --- | --- |
139-
| `bmad-agent-<module>-<name>` | 智能体启动器 | `bmad-agent-bmm-dev` |
140-
| `bmad-<module>-<workflow>` | 工作流命令 | `bmad-bmm-create-prd` |
141-
| `bmad-<name>` | 核心任务或工具 | `bmad-help` |
142-
143-
模块代码：`bmm`（敏捷套件）、`bmb`（构建器）、`tea`（测试架构师）、`cis`（创意智能）、`gds`（游戏开发工作室）。参见[模块](./modules.md)获取描述。
144-
145-
## 故障排除
146-
147-
**安装后命令未出现。** 重启您的 IDE 或重新加载窗口。某些 IDE 会缓存命令列表，需要刷新才能获取新文件。
148-
149-
**预期的命令缺失。** 安装程序仅为您选择的模块生成命令。再次运行 `npx bmad-method install` 并验证您的模块选择。检查命令文件是否存在于预期目录中。
150-
151-
**已删除模块的命令仍然出现。** 安装程序不会自动删除旧的命令文件。从 IDE 的命令目录中删除过时的文件，或删除整个命令目录并重新运行安装程序以获取一组干净的命令。
152-
153-
---
154-
## 术语说明
155-
156-
- **slash command**：斜杠命令。以 `/` 开头的命令，用于在 IDE 中快速执行特定操作。
157-
- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。
158-
- **workflow**：工作流。一系列结构化的步骤，用于完成特定任务或流程。
159-
- **IDE**：集成开发环境。用于软件开发的综合应用程序，提供代码编辑、调试、构建等功能。
160-
- **persona**：角色设定。为智能体定义的特定角色、性格和行为方式。
161-
- **trigger**：触发器。用于启动特定操作或流程的机制。
162-
- **manifest**：清单。描述模块或组件的元数据文件。
163-
- **installer**：安装程序。用于安装和配置软件的工具。
164-
- **PRD**：产品需求文档。描述产品功能、需求和规范的文档。
165-
- **SaaS**：软件即服务。通过互联网提供软件服务的模式。
166-
- **UX**：用户体验。用户在使用产品或服务过程中的整体感受和交互体验。
120+
- [智能体参考](./agents.md)
121+
- [核心工具参考](./core-tools.md)
122+
- [模块参考](./modules.md)

0 commit comments

Comments
 (0)