Skip to content

Commit e8e1c5d

Browse files
committed
Polish Chinese docs and resource translations
1 parent b6fcf38 commit e8e1c5d

18 files changed

Lines changed: 129 additions & 127 deletions

File tree

README-CN.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> 这是一门项目制课程:系统学习如何通过环境、状态、验证与控制机制,让 Codex 和 Claude Code 更可靠地工作。
44
5-
[English Version](./README.md)
5+
[英文版](./README.md)
66

77
本课程仍在持续建设中,内容后续可能会调整。
88

@@ -18,7 +18,7 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
1818
- 哪些规矩必须遵守
1919
- 怎么保持干净、不留烂摊子
2020

21-
这门课是**强实践导向**的。我们不会只停留在"概念解释",而是会让 Codex 或 Claude Code 在同一个不断演化的 Electron 应用上反复工作,并比较弱 harness 与强 harness 的差异。
21+
这门课是**强实践导向**的。我们不会只停留在概念解释,而是会让 Codex 或 Claude Code 在同一个不断演化的 Electron 应用上反复工作,并比较弱 harness 与强 harness 的差异。
2222

2323
课程真正关心的问题是:
2424

@@ -29,11 +29,11 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
2929

3030
## 核心观点
3131

32-
以后让模型干活,人只需要定好规则和边界——这就是 harness。
32+
以后让模型干活,人只需要定好规则和边界这就是 harness。
3333

3434
**这事的关键:** 模型很强,但不代表它能自动靠谱地完成真实工程任务。它需要一套明确的规则来约束自己的行为范围、需要清晰的交接机制来维持长时任务的连续性、需要验证手段来确认自己做对了。
3535

36-
我们不是在尝试"让模型本身更聪明",而是研究:怎么给模型搭建一个靠谱的工作环境,让同一个模型做出更可靠的工作。
36+
我们不是在尝试让模型本身更聪明”,而是在研究:怎么给模型搭建一个靠谱的工作环境,让同一个模型做出更可靠的工作。
3737

3838
## 快速开始
3939

@@ -69,7 +69,7 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
6969
- [`clean-state-checklist.md`](./docs/resources/zh/templates/clean-state-checklist.md) —— 每次会话结束前的清理清单
7070
- [`evaluator-rubric.md`](./docs/resources/zh/templates/evaluator-rubric.md) —— 评审 agent 产出质量的评分表
7171

72-
每个文件的详细用法写在 [中文模板指南](./docs/resources/zh/templates/index.md)。英文版见 [English template guide](./docs/resources/en/templates/index.md)
72+
每个文件的详细用法写在 [中文模板指南](./docs/resources/zh/templates/index.md)。英文版见 [英文模板指南](./docs/resources/en/templates/index.md)
7373

7474
如果你想直接用 OpenAI 那篇 harness engineering 文章里的更完整高级结构,可以继续看
7575
[`docs/resources/zh/openai-advanced/`](./docs/resources/zh/openai-advanced/index.md)
@@ -103,25 +103,25 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
103103

104104
### 资料库
105105

106-
- [Resource Library 总览](./docs/resources/index.md)
106+
- [资料库总览](./docs/resources/index.md)
107107
- [中文资料库](./docs/resources/zh/index.md)
108-
- [English Resource Library](./docs/resources/en/index.md)
108+
- [英文资料库](./docs/resources/en/index.md)
109109

110110
## 学习路径推荐
111111

112112
这门课按顺序来效果最好,每一阶段都建立在前一个的基础上。
113113

114-
**第一阶段 — 先看到问题。** 读 Lecture 01-02,做 Project 01。你会跑两次同样的任务:一次只给提示词,一次加了最基本的规则。差距一目了然。
114+
**第一阶段 — 先看到问题。** 读讲义 01-02,做项目 01。你会跑两次同样的任务:一次只给提示词,一次加了最基本的规则。差距一目了然。
115115

116-
**第二阶段 — 让项目对 agent 友好。** Lecture 03-04,Project 02。你会重组项目结构,让 agent 能读懂,并且加上跨会话的持久文件。
116+
**第二阶段 — 让项目对 agent 友好。** 讲义 03-04,项目 02。你会重组项目结构,让 agent 能读懂,并且加上跨会话的持久文件。
117117

118-
**第三阶段 — 让会话接得上。** Lecture 05-06,Project 03。这里开始有意思了——让 agent 在你关掉会话后重新打开,还能从上次停下的地方接着干。
118+
**第三阶段 — 让会话接得上。** 讲义 05-06,项目 03。这里开始有意思了让 agent 在你关掉会话后重新打开,还能从上次停下的地方接着干。
119119

120-
**第四阶段 — 加上反馈和范围控制。** Lecture 07-08,Project 04。防止 agent 做多了或做少了,用运行反馈让它保持在正轨上。
120+
**第四阶段 — 加上反馈和范围控制。** 讲义 07-08,项目 04。防止 agent 做多了或做少了,用运行反馈让它保持在正轨上。
121121

122-
**第五阶段 — 验证和自查。** Lecture 09-10,Project 05。让 agent 学会验证自己的工作,而不是做完就说"好了"
122+
**第五阶段 — 验证和自查。** 讲义 09-10,项目 05。让 agent 学会验证自己的工作,而不是做完就说“好了”
123123

124-
**第六阶段 — 全部串起来。** Lecture 11-12,Project 06。这是 capstone。你将从零开始搭建一套完整的 harness,把前面学的全用上。
124+
**第六阶段 — 全部串起来。** 讲义 11-12,项目 06。这是综合项目。你将从零开始搭建一套完整的 harness,把前面学的全用上。
125125

126126
每个阶段大约一周(兼职节奏)。想快的话,前三个阶段一个周末就能跑完。
127127

@@ -131,7 +131,7 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
131131

132132
- 已经在使用 coding agent、希望提升稳定性和质量的工程师
133133
- 想系统理解 harness 设计的研究者或构建者
134-
- 需要理解"环境设计如何影响 agent 表现"的技术负责人
134+
- 需要理解环境设计如何影响 agent 表现的技术负责人
135135

136136
这门课不适合:
137137

@@ -156,7 +156,7 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
156156
- 允许 agent 运行命令
157157
- 检查输出并重复执行任务
158158

159-
如果你没有这类工具,仍然可以阅读课程内容,但无法按预期完成课程 project
159+
如果你没有这类工具,仍然可以阅读课程内容,但无法按预期完成课程项目
160160

161161
## 本地预览
162162

@@ -200,7 +200,7 @@ npm run docs:dev
200200

201201
## 贯穿项目
202202

203-
本课程的大多数 project 都围绕同一个产品展开
203+
本课程的大多数项目都围绕同一个产品展开
204204

205205
- 一个基于 Electron 的个人知识库桌面应用
206206

@@ -210,7 +210,7 @@ npm run docs:dev
210210
- 管理文档库
211211
- 处理与索引文档
212212
- 对导入内容发起 AI 问答
213-
- 返回带引用的 grounded 回答
213+
- 返回带引用且可追溯的回答
214214

215215
之所以选择这个项目,是因为它同时具备:
216216

@@ -222,29 +222,29 @@ npm run docs:dev
222222

223223
本课程包含两类内容:
224224

225-
- **Lectures**:12 个概念单元,每个单元只回答一个核心问题
226-
- **Projects**:6 个实践项目,把 lecture 里的方法落实到同一个 Electron 应用上
225+
- **讲义**:12 个概念单元,每个单元只回答一个核心问题
226+
- **项目**:6 个实践项目,把讲义里的方法落实到同一个 Electron 应用上
227227

228228
每个 project 都要求你:
229229

230230
- 让 Codex 或 Claude Code 执行真实任务
231231
- 比较弱 harness 与强 harness 的差别
232232
- 观察可靠性、连续性、验证质量、可维护性的变化
233233

234-
最后一个 project 同时也是整个课程的 capstone harness。
234+
最后一个项目同时也是整个课程的综合 harness。
235235

236236
## 课程组织方式
237237

238-
- 每个 lecture 聚焦一个问题
239-
- 整门课配套 6 个 project
240-
- 每个 project 都要求 agent 真正干活
241-
- 每个 project 都要做弱 harness / 强 harness 对照
242-
- 我们关心的是效果变化,而不是"写了多少说明文档"
238+
- 每个讲义聚焦一个问题
239+
- 整门课配套 6 个项目
240+
- 每个项目都要求 agent 真正干活
241+
- 每个项目都要做弱 harness / 强 harness 对照
242+
- 我们关心的是效果变化,而不是写了多少说明文档
243243

244244
## 仓库结构
245245

246246
- `docs/lectures/` - 全部讲义
247-
- `docs/projects/` - 全部实践项目,包括 capstone
247+
- `docs/projects/` - 全部实践项目,包括综合项目
248248
- `docs/resources/` - 中英双语的可复用模板、检查清单和方法参考
249249

250-
每个 lecture 都带一个 `code/` 目录,用来放小型真实示例和 supporting artifacts
250+
每个讲义都带一个 `code/` 目录,用来放小型真实示例和配套材料

docs/index.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
4343
4444
- [Lecture 01. 为什么强模型依然会失败](/lectures/lecture-01-why-capable-agents-still-fail/)
4545
- [Lecture 02. 什么才算 harness](/lectures/lecture-02-what-a-harness-actually-is/)
46-
- [Lecture 03. 为什么仓库必须成为 system of record](/lectures/lecture-03-why-the-repository-must-become-the-system-of-record/)
46+
- [Lecture 03. 为什么仓库必须成为唯一事实来源](/lectures/lecture-03-why-the-repository-must-become-the-system-of-record/)
4747
- [Lecture 04. 为什么一个巨大的 instruction 文件会失败](/lectures/lecture-04-why-one-giant-instruction-file-fails/)
4848
- [Lecture 05. 为什么长时任务会失去连续性](/lectures/lecture-05-why-long-running-tasks-lose-continuity/)
4949
- [Lecture 06. 为什么初始化必须是独立阶段](/lectures/lecture-06-why-initialization-needs-its-own-phase/)
50-
- [Lecture 07. 为什么 scope 必须被显式化](/lectures/lecture-07-why-agents-overreach-and-under-finish/)
50+
- [Lecture 07. 为什么任务边界必须被显式化](/lectures/lecture-07-why-agents-overreach-and-under-finish/)
5151
- [Lecture 08. 为什么验证必须外部化](/lectures/lecture-08-why-feature-lists-are-harness-primitives/)
52-
- [Lecture 09. 为什么 runtime feedback 必须进入 harness](/lectures/lecture-09-why-agents-declare-victory-too-early/)
52+
- [Lecture 09. 为什么运行时反馈必须进入 harness](/lectures/lecture-09-why-agents-declare-victory-too-early/)
5353
- [Lecture 10. 为什么完整验证才算真的验证](/lectures/lecture-10-why-end-to-end-testing-changes-results/)
5454
- [Lecture 11. 为什么可观测性必须进入 harness](/lectures/lecture-11-why-observability-belongs-inside-the-harness/)
5555
- [Lecture 12. 为什么每次会话都必须干净收尾](/lectures/lecture-12-why-every-session-must-leave-a-clean-state/)
@@ -58,18 +58,18 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
5858

5959
> 项目正文目前仍以英文为主,中文先提供导览和学习路径。
6060
61-
- [Project 01. 基线 vs 最小 harness](/projects/project-01-baseline-vs-minimal-harness/)
62-
- [Project 02. Agent-readable workspace 与 continuity scaffold](/projects/project-02-agent-readable-workspace/)
63-
- [Project 03. Scope control 与 grounded verification](/projects/project-03-multi-session-continuity/)
64-
- [Project 04. Runtime feedback 与 structural control](/projects/project-04-incremental-indexing/)
65-
- [Project 05. Evaluator loop 与三角色升级](/projects/project-05-grounded-qa-verification/)
66-
- [Project 06. Benchmark、cleanup 与 capstone harness](/projects/project-06-runtime-observability-and-debugging/)
61+
- [Project 01. 基线提示词 vs 最小 harness](/projects/project-01-baseline-vs-minimal-harness/)
62+
- [Project 02. 让项目对 agent 可读,并接住上次的工作](/projects/project-02-agent-readable-workspace/)
63+
- [Project 03. 让 agent 在会话重启后继续推进](/projects/project-03-multi-session-continuity/)
64+
- [Project 04. 用运行时反馈修正 agent 的行为](/projects/project-04-incremental-indexing/)
65+
- [Project 05. 让 agent 学会评审并验证自己的工作](/projects/project-05-grounded-qa-verification/)
66+
- [Project 06. 基准测试、清理与综合 harness](/projects/project-06-runtime-observability-and-debugging/)
6767

6868
### 资料库
6969

7070
- [资料库总览](/resources/)
7171
- [中文资料库](/resources/zh/)
72-
- [English Resource Library](/resources/en/)
72+
- [英文资料库](/resources/en/)
7373

7474
## 快速开始
7575

@@ -86,16 +86,16 @@ Harness engineering 指的是:围绕模型搭建一整套工作环境,让它
8686
- 评审模板:[`evaluator-rubric.md`](/resources/zh/templates/evaluator-rubric.md)
8787
- 启动脚本参考:`docs/resources/zh/templates/init.sh`
8888

89-
English version:
89+
英文版本:
9090

91-
- Entry: [English Home](/en/)
92-
- Library: [English Resource Library](/resources/en/)
93-
- Root instructions: [`AGENTS.md`](/resources/en/templates/AGENTS.md) or [`CLAUDE.md`](/resources/en/templates/CLAUDE.md)
94-
- Feature state: [`feature_list.json`](/resources/en/templates/feature_list.json)
95-
- Progress log: [`claude-progress.md`](/resources/en/templates/claude-progress.md)
96-
- Session handoff: [`session-handoff.md`](/resources/en/templates/session-handoff.md)
97-
- Clean-exit checklist: [`clean-state-checklist.md`](/resources/en/templates/clean-state-checklist.md)
98-
- Evaluator rubric: [`evaluator-rubric.md`](/resources/en/templates/evaluator-rubric.md)
91+
- 入口:[English Home](/en/)
92+
- 资料库:[英文资料库](/resources/en/)
93+
- 根指令文件:[`AGENTS.md`](/resources/en/templates/AGENTS.md) [`CLAUDE.md`](/resources/en/templates/CLAUDE.md)
94+
- 功能状态文件:[`feature_list.json`](/resources/en/templates/feature_list.json)
95+
- 进度记录文件:[`claude-progress.md`](/resources/en/templates/claude-progress.md)
96+
- 会话交接文件:[`session-handoff.md`](/resources/en/templates/session-handoff.md)
97+
- 收尾检查清单:[`clean-state-checklist.md`](/resources/en/templates/clean-state-checklist.md)
98+
- 评审模板:[`evaluator-rubric.md`](/resources/en/templates/evaluator-rubric.md)
9999

100100
推荐最小起步组合:
101101

@@ -110,12 +110,12 @@ English version:
110110

111111
这门课适合按 6 个单元推进:
112112

113-
- **Unit 1**: Lecture 01-02 + Project 01
114-
- **Unit 2**: Lecture 03-04 + Project 02
115-
- **Unit 3**: Lecture 05-06 + Project 03
116-
- **Unit 4**: Lecture 07-08 + Project 04
117-
- **Unit 5**: Lecture 09-10 + Project 05
118-
- **Unit 6**: Lecture 11-12 + Project 06
113+
- **单元 1**Lecture 01-02 + Project 01
114+
- **单元 2**Lecture 03-04 + Project 02
115+
- **单元 3**Lecture 05-06 + Project 03
116+
- **单元 4**Lecture 07-08 + Project 04
117+
- **单元 5**Lecture 09-10 + Project 05
118+
- **单元 6**Lecture 11-12 + Project 06
119119

120120
如果你想慢一点,也可以把每个单元当成一周来学。
121121

docs/resources/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# 资料库
22

3-
这里是课程的双语 starter library,用来把课程里的方法整理成可直接复用的模板、检查清单和参考材料。
3+
这里是课程的双语资料库,用来把课程里的方法整理成可直接复用的模板、检查清单和参考材料。
44

5-
英文入口见:[English Resource Overview](/en/resources)
5+
英文入口见:[英文资料总览](/en/resources)
66

77
## 先看中文
88

99
- [中文资料库总览](./zh/index.md)
1010
- [中文模板](./zh/templates/index.md)
1111
- [中文参考](./zh/reference/index.md)
1212

13-
## English Resources
13+
## 英文资料
1414

15-
- [English Resource Library](./en/index.md)
16-
- [English Templates](./en/templates/index.md)
17-
- [English Reference](./en/reference/index.md)
15+
- [英文资料库](./en/index.md)
16+
- [英文模板](./en/templates/index.md)
17+
- [英文参考](./en/reference/index.md)
1818

1919
## 这里能找到什么
2020

2121
- 根指令模板
2222
- 功能状态与进度文件
2323
- 会话交接与收尾检查清单
2424
- 启动脚本参考
25-
- initializer 与 coding-agent 工作流说明
25+
- 初始化代理与编码代理的工作流说明
2626
- 适合更长周期协作的 OpenAI 风格高级仓库骨架
2727

2828
## 推荐最小起步
@@ -32,11 +32,11 @@
3232
- `claude-progress.md`
3333
- `init.sh`
3434

35-
先从这四个文件开始,再根据项目复杂度补充 handoff、evaluator 和质量治理材料
35+
先从这四个文件开始,再根据项目复杂度补充交接、评审和质量治理材料
3636

3737
## 高级资源包
3838

39-
如果最小 harness 已经不够,可以继续看 OpenAI 风格的 advanced pack
39+
如果最小 harness 已经不够,可以继续看 OpenAI 风格的高级资源包
4040

4141
- 中文:[`zh/openai-advanced/index.md`](./zh/openai-advanced/index.md)
42-
- English[`en/openai-advanced/index.md`](./en/openai-advanced/index.md)
42+
- 英文[`en/openai-advanced/index.md`](./en/openai-advanced/index.md)

docs/resources/zh/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
- [`templates/`](./templates/index.md):可以直接复制到真实仓库里的模板
3939
- [`reference/`](./reference/index.md):方法说明、启动流程和问题对照表
40-
- [`openai-advanced/`](./openai-advanced/index.md):更完整的 OpenAI 风格高级资源包,包括 repo skeleton、质量文档、执行计划和系统级治理文件
40+
- [`openai-advanced/`](./openai-advanced/index.md):更完整的 OpenAI 风格高级资源包,包括仓库骨架、质量文档、执行计划和系统级治理文件
4141

4242
## 推荐最小组合
4343

docs/resources/zh/openai-advanced/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ agent-first world》里更完整、更高阶的仓库组织方式整理成可以
66
当最小 harness 已经不够用,而你的仓库开始需要下面这些能力时,就该看这一套:
77

88
- 一个简短、负责路由的 `AGENTS.md`
9-
- 放在仓库里的 system-of-record 文档体系
9+
- 放在仓库里的“唯一事实来源”文档体系
1010
- 活跃执行计划与已完成计划的分层管理
1111
- 明确的产品、可靠性、安全、前端治理文件
1212
- 按产品领域和架构层持续更新的质量评分
13-
- 面向模型阅读的 reference 材料目录
13+
- 面向模型阅读的参考材料目录
1414
- 针对架构、知识沉淀、运行验证的标准 SOP
1515

1616
## 包含的目录骨架
1717

18-
[`repo-template/`](./repo-template/index.md) 里提供了一套可直接复制的 starter
18+
[`repo-template/`](./repo-template/index.md) 里提供了一套可直接复制的起步
1919
结构,核心布局如下:
2020

2121
```text
@@ -54,23 +54,23 @@ docs/
5454
[`repo-template/`](./repo-template/index.md) 里的骨架复制到你的仓库。
5555
3. 保持 `AGENTS.md` 很短,把深层规则拆到 `docs/` 里。
5656
4. 把质量文档、可靠性文档、执行计划当成日常开发的一部分,而不是事后补写。
57-
5. 把生成物和外部 reference 明确收进仓库,避免 agent 依赖聊天上下文或人的记忆。
57+
5. 把生成物和外部参考材料明确收进仓库,避免 agent 依赖聊天上下文或人的记忆。
5858

5959
## SOP 资料库
6060

6161
[`sops/`](./sops/index.md) 把文章里的几张关键图,整理成可以逐步执行的标准流程:
6262

6363
- 分层领域架构搭建 SOP
6464
- 把不可见知识编码进仓库的 SOP
65-
- 本地 observability stack 与 feedback loop SOP
65+
- 本地可观测性栈与反馈回路 SOP
6666
- 用 Chrome DevTools 做 UI 验证闭环的 SOP
6767

6868
## 设计原则
6969

7070
- 短入口,深链接
71-
- 仓库就是 system of record
71+
- 仓库就是唯一事实来源
7272
- 机械约束优先于口头约定
7373
- 计划、质量和技术债都和代码一起版本化
74-
- cleanup 与 harness 简化是常规工作,不是临时救火
74+
- 清理与 harness 简化是常规工作,不是临时救火
7575

7676
这套资源包是有倾向性的模板,不是必须逐字照抄。最好的用法是把它当成一套高质量起点,再按你的项目改造。

docs/resources/zh/openai-advanced/repo-template/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AGENTS.md
22

3-
这个仓库面向长时运行的 coding-agent 工作流。保持这个文件简短,把它当成 system-of-record 文档的入口和路由层,而不是一个不断膨胀的大说明书。
3+
这个仓库面向长时运行的 coding-agent 工作流。保持这个文件简短,把它当成“唯一事实来源”文档的入口和路由层,而不是一个不断膨胀的大说明书。
44

55
## 开工流程
66

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Core Beliefs
1+
# 核心信念
22

3-
- 仓库就是 agent 的 system of record
3+
- 仓库就是 agent 的唯一事实来源
44
- `AGENTS.md` 是路由器,不是百科全书。
55
- 验证证据比自信更重要。
66
- 一次做好一个有边界的任务,胜过同时开很多半成品。
77
- 反复出现的人类反馈要升级成可复用的 harness 规则。
8-
- cleanup 与 simplification 都是交付的一部分,不是事后补救。
8+
- 清理与简化都是交付的一部分,不是事后补救。
99
- 如果 agent 不能在仓库里发现某个事实,就把这个事实视为运行上不存在。

docs/resources/zh/openai-advanced/repo-template/docs/exec-plans/active/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Active Plans
1+
# 当前执行计划
22

33
这个文件夹里每一份 markdown 都代表一份当前仍在执行的计划。
44

0 commit comments

Comments
 (0)