Skip to content

Commit 90d9d88

Browse files
lrliangleonalexeyv
authored
docs(zh-cn): refine story 2.5 and 2.6 how-to guides (#2097)
* docs(zh-cn-how-to): refine stories 2.5 and 2.6 docs 我澄清中文自定义与文档分片指南,保留命令、路径和配置键名的技术准确性,降低高级操作误解。 我同步修正 v4 到 v6 升级步骤中的旧新路径与工作流命名,帮助迁移时按当前约定执行。 feishu: https://feishu.cn/wiki/TODO Made-with: Cursor * docs(zh-cn-how-to): clarify shard output precedence 我在“你将获得”中补充完整文档与分片文档并存时的读取优先级说明。 此前“可保留”表述容易让用户误以为分片会自动生效;现在明确并存不建议且默认优先读取完整文档。 Feishu: <https://www.feishu.cn/> Made-with: Cursor --------- Co-authored-by: leon <leon.liang@hairobotics.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
1 parent 0c24547 commit 90d9d88

3 files changed

Lines changed: 118 additions & 136 deletions

File tree

docs/zh-cn/how-to/customize-bmad.md

Lines changed: 50 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -5,66 +5,66 @@ sidebar:
55
order: 7
66
---
77

8-
使用 `.customize.yaml` 文件来调整智能体行为、角色和菜单,同时在更新过程中保留您的更改
8+
使用 `.customize.yaml` 文件,自定义智能体(agent)的行为、角色(persona)和菜单,同时在后续更新中保留你的改动
99

1010
## 何时使用此功能
1111

12-
- 您想要更改智能体的名称、个性或沟通风格
13-
- 您需要智能体记住项目特定的上下文
14-
- 您想要添加自定义菜单项来触发您自己的工作流或提示
15-
- 您希望智能体在每次启动时执行特定操作
12+
- 你想修改智能体名称、身份设定或沟通风格
13+
- 你需要让智能体长期记住项目约束和背景信息
14+
- 你希望增加自定义菜单项,触发自己的工作流或提示
15+
- 你希望智能体每次启动都先执行固定动作
1616

1717
:::note[前置条件]
18-
- 在项目中安装了 BMad(参见[如何安装 BMad](./install-bmad.md)
18+
- 已在项目中安装 BMad(参见[如何安装 BMad](./install-bmad.md)
1919
- 用于编辑 YAML 文件的文本编辑器
2020
:::
2121

2222
:::caution[保护您的自定义配置]
23-
始终使用此处描述的 `.customize.yaml` 文件,而不是直接编辑智能体文件。安装程序在更新期间会覆盖智能体文件,但会保留您的 `.customize.yaml` 更改
23+
始终通过 `.customize.yaml` 自定义,不要直接改动智能体源文件。安装程序在更新时会覆盖智能体文件,但会保留 `.customize.yaml` 的内容
2424
:::
2525

2626
## 步骤
2727

2828
### 1. 定位自定义文件
2929

30-
安装后,在以下位置为每个智能体找到一个 `.customize.yaml` 文件
30+
安装完成后,每个已安装智能体都会在下面目录生成一个 `.customize.yaml`
3131

3232
```text
3333
_bmad/_config/agents/
3434
├── core-bmad-master.customize.yaml
3535
├── bmm-dev.customize.yaml
3636
├── bmm-pm.customize.yaml
37-
└── ...(每个已安装的智能体一个文件
37+
└── ...(每个已安装智能体一个文件
3838
```
3939

4040
### 2. 编辑自定义文件
4141

42-
打开您想要修改的智能体的 `.customize.yaml` 文件。每个部分都是可选的——只自定义您需要的内容
42+
打开目标智能体的 `.customize.yaml`。各段都可选,只改你需要的部分即可
4343

44-
| 部分 | 行为 | 用途 |
44+
| 部分 | 作用方式 | 用途 |
4545
| ------------------ | -------- | ---------------------------------------------- |
46-
| `agent.metadata` | 替换 | 覆盖智能体的显示名称 |
47-
| `persona` | 替换 | 设置角色、身份、风格和原则 |
48-
| `memories` | 追加 | 添加智能体始终会记住的持久上下文 |
49-
| `menu` | 追加 | 为工作流或提示添加自定义菜单项 |
50-
| `critical_actions` | 追加 | 定义智能体的启动指令 |
51-
| `prompts` | 追加 | 创建可重复使用的提示供菜单操作使用 |
46+
| `agent.metadata` | 覆盖 | 覆盖智能体显示名称 |
47+
| `persona` | 覆盖 | 设置角色、身份、风格和原则 |
48+
| `memories` | 追加 | 添加智能体长期记忆的上下文 |
49+
| `menu` | 追加 | 增加指向工作流或提示的菜单项 |
50+
| `critical_actions` | 追加 | 定义智能体启动时要执行的动作 |
51+
| `prompts` | 追加 | 创建可复用提示,供菜单 `action` 引用 |
5252

53-
标记为 **替换** 的部分会完全覆盖智能体的默认设置。标记为 **追加** 的部分会添加到现有配置中
53+
标记为 **覆盖** 的部分会完全替换默认配置;标记为 **追加** 的部分会在默认配置基础上累加
5454

55-
**智能体名称**
55+
**智能体名称`agent.metadata`**
5656

57-
更改智能体的自我介绍方式
57+
修改智能体的显示名称
5858

5959
```yaml
6060
agent:
6161
metadata:
6262
name: 'Spongebob' # 默认值:"Amelia"
6363
```
6464
65-
**角色**
65+
**角色`persona`)**
6666

67-
替换智能体的个性、角色和沟通风格
67+
替换智能体的人设、职责和沟通风格
6868

6969
```yaml
7070
persona:
@@ -76,11 +76,11 @@ persona:
7676
- 'Favor composition over inheritance'
7777
```
7878

79-
`persona` 部分会替换整个默认角色,因此如果您设置它,请包含所有四个字段
79+
`persona` 会覆盖默认整段配置,所以启用时请把四个字段都填全
8080

81-
**记忆**
81+
**记忆(`memories`)**
8282

83-
添加智能体将始终记住的持久上下文
83+
添加智能体会长期记住的上下文
8484

8585
```yaml
8686
memories:
@@ -89,9 +89,9 @@ memories:
8989
- 'Learned in Epic 1 that it is not cool to just pretend that tests have passed'
9090
```
9191

92-
**菜单项**
92+
**菜单项(`menu`)**
9393

94-
向智能体的显示菜单添加自定义条目。每个条目需要一个 `trigger`、一个目标(`workflow` 路径或 `action` 引用)和一个 `description`:
94+
给智能体菜单添加自定义项。每个条目都需要 `trigger`、目标(`workflow` 路径或 `action` 引用) `description`:
9595

9696
```yaml
9797
menu:
@@ -103,18 +103,18 @@ menu:
103103
description: Deploy to production
104104
```
105105

106-
**关键操作**
106+
**启动关键动作(`critical_actions`)**
107107

108-
定义智能体启动时运行的指令
108+
定义智能体启动时执行的指令
109109

110110
```yaml
111111
critical_actions:
112112
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
113113
```
114114

115-
**自定义提示**
115+
**可复用提示(`prompts`)**
116116

117-
创建可重复使用的提示,菜单项可以通过 `action="#id"` 引用
117+
创建可复用提示,菜单项可通过 `action="#id"` 调用
118118

119119
```yaml
120120
prompts:
@@ -126,56 +126,51 @@ prompts:
126126
3. Execute deployment script
127127
```
128128

129-
### 3. 应用您的更改
129+
### 3. 应用更改
130130

131-
编辑后,重新安装以应用更改
131+
编辑完成后,重新安装以应用配置
132132

133133
```bash
134134
npx bmad-method install
135135
```
136136

137-
安装程序会检测现有安装并提供以下选项
137+
安装程序会识别现有安装,并给出以下选项
138138

139-
| Option | What It Does |
139+
| 选项 | 作用 |
140140
| ---------------------------- | ------------------------------------------------------------------- |
141-
| **Quick Update** | 将所有模块更新到最新版本并应用自定义配置 |
142-
| **Modify BMad Installation** | 用于添加或删除模块的完整安装流程 |
141+
| **Quick Update** | 更新所有模块到最新版本,并应用你的自定义配置 |
142+
| **Modify BMad Installation** | 进入完整安装流程,用于增删模块 |
143143

144-
对于仅自定义配置的更改,**Quick Update** 是最快的选项
144+
如果只是调整 `.customize.yaml`,优先选 **Quick Update**。
145145

146-
## 故障排除
146+
## 故障排查
147147

148-
**更改未生效?**
148+
**改动没有生效?**
149149

150150
- 运行 `npx bmad-method install` 并选择 **Quick Update** 以应用更改
151-
- 检查您的 YAML 语法是否有效(缩进很重要
152-
- 验证您编辑的是该智能体正确的 `.customize.yaml` 文件
151+
- 检查 YAML 语法是否正确(尤其是缩进
152+
- 确认你编辑的是目标智能体对应的 `.customize.yaml`
153153

154154
**智能体无法加载?**
155155

156156
- 使用在线 YAML 验证器检查 YAML 语法错误
157-
- 确保在取消注释后没有留下空字段
158-
- 尝试恢复到原始模板并重新构建
157+
- 确保取消注释后没有遗留空字段
158+
- 可先回退到模板,再逐项恢复自定义配置
159159

160-
**需要重置智能体?**
160+
**需要重置某个智能体?**
161161

162162
- 清空或删除智能体的 `.customize.yaml` 文件
163163
- 运行 `npx bmad-method install` 并选择 **Quick Update** 以恢复默认设置
164164

165165
## 工作流自定义
166166

167-
对现有 BMad Method 工作流和技能的自定义即将推出
167+
对现有 BMad Method 工作流和技能的深度自定义能力即将推出
168168

169169
## 模块自定义
170170

171171
关于构建扩展模块和自定义现有模块的指南即将推出。
172172

173-
---
174-
## 术语说明
175-
176-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
177-
- **workflow**:工作流。指一系列有序的任务或步骤,用于完成特定目标。
178-
- **persona**:角色。指智能体的身份、个性、沟通风格和行为原则的集合。
179-
- **memory**:记忆。指智能体持久存储的上下文信息,用于在对话中保持连贯性。
180-
- **critical action**:关键操作。指智能体启动时必须执行的指令或任务。
181-
- **prompt**:提示。指发送给智能体的输入文本,用于引导其生成特定响应或执行特定操作。
173+
## 后续步骤
174+
175+
- [文档分片指南](./shard-large-documents.md) - 了解如何管理超长文档
176+
- [命令参考](../reference/commands.md) - 查看可用命令和工作流入口

docs/zh-cn/how-to/shard-large-documents.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ sidebar:
55
order: 9
66
---
77

8-
如果需要将大型 Markdown 文件拆分为更小、组织良好的文件以更好地管理上下文,请使用 `shard-doc` 工具
8+
当单个 Markdown 文档过大、影响模型读取时,可使用 `bmad-shard-doc` 工作流把文档拆成按章节组织的小文件,降低上下文压力
99

1010
:::caution[已弃用]
11-
不再推荐使用此方法,随着工作流程的更新以及大多数主要 LLM 和工具支持子进程,这很快将变得不再必要
11+
这是兼容性方案,默认不推荐。随着工作流更新,以及主流模型/工具逐步支持子进程(subprocesses),很多场景将不再需要手动分片
1212
:::
1313

1414
## 何时使用
1515

16-
仅当你发现所选工具/模型组合无法在需要时加载和读取所有文档作为输入时,才使用此方法。
16+
- 你确认当前工具/模型在关键步骤无法一次读入完整文档
17+
- 文档体量已明显影响工作流稳定性或响应质量
18+
- 你需要保留原文结构,但希望按 `##` 章节拆分维护
1719

1820
## 什么是文档分片?
1921

20-
文档分片根据二级标题`## Heading`将大型 Markdown 文件拆分为更小、组织良好的文件
22+
文档分片会按二级标题`## Heading`把大型 Markdown 文件拆成多个子文件,并生成一个 `index.md` 作为入口
2123

2224
### 架构
2325

@@ -38,16 +40,16 @@ _bmad-output/planning-artifacts/
3840

3941
## 步骤
4042

41-
### 1. 运行 Shard-Doc 工具
43+
### 1. 运行 `bmad-shard-doc` 工作流
4244

4345
```bash
4446
/bmad-shard-doc
4547
```
4648

47-
### 2. 遵循交互式流程
49+
### 2. 按交互流程完成分片
4850

4951
```text
50-
智能体:您想要分片哪个文档
52+
智能体:你想分片哪个文档
5153
用户:docs/PRD.md
5254
5355
智能体:默认目标位置:docs/prd/
@@ -60,27 +62,21 @@ _bmad-output/planning-artifacts/
6062
✓ 完成!
6163
```
6264

63-
## 工作流程发现机制
65+
## 工作流发现机制
6466

65-
BMad 工作流程使用**双重发现系统**
67+
BMad 工作流使用**双重发现机制**
6668

67-
1. **首先尝试完整文档** - 查找 `document-name.md`
68-
2. **检查分片版本** - 查找 `document-name/index.md`
69-
3. **优先级规则** - 如果两者都存在,完整文档优先 - 如果希望使用分片版本,请删除完整文档
69+
1. **先查完整文档** - 查找 `document-name.md`
70+
2. **再查分片入口** - 查找 `document-name/index.md`
71+
3. **优先级规则** - 若两者并存,默认优先完整文档;若你要强制使用分片版本,请删除或重命名完整文档
7072

71-
## 工作流程支持
73+
## 你将获得
7274

73-
所有 BMM 工作流程都支持这两种格式:
75+
- 原始完整文档(可保留,但不建议与分片长期并存;并存时默认优先读取完整文档)
76+
- 分片目录(如 `document-name/index.md` + 各章节文件)
77+
- 对工作流透明的自动识别行为(无需额外配置)
7478

75-
- 完整文档
76-
- 分片文档
77-
- 自动检测
78-
- 对用户透明
79+
## 后续步骤
7980

80-
---
81-
## 术语说明
82-
83-
- **sharding**:分片。将大型文档或数据集拆分为更小、更易管理的部分的过程。
84-
- **token**:令牌。在自然语言处理和大型语言模型中,文本的基本单位,通常对应单词或字符的一部分。
85-
- **subprocesses**:子进程。由主进程创建的独立执行单元,可以并行运行以执行特定任务。
86-
- **agent**:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
81+
- [如何自定义 BMad](./customize-bmad.md) - 了解高级配置与工作流定制边界
82+
- [如何升级到 v6](./upgrade-to-v6.md) - 在迁移过程中处理文档与目录结构变化

0 commit comments

Comments
 (0)