开源项目 · ste-zh
ste-zh:让 AI Agent 用简化技术中文汇报
ste-zh 是一个 Agent skill,让编程 Agent 用受控的中文汇报工作。它借鉴航空工业写作标准 ASD-STE100(简化技术英语)的原则,让汇报结论先行,并如实写明验证了什么。
在 GitHub 上查看 ste-zh · 繁体中文版(ste-zht)
它解决什么问题
Agent 的日常汇报常常过程冗长、推测含糊,或者漏掉关键的验证证据。你必须读完全文,才知道工作是否真的完成。ste-zh 规定一种固定的汇报写法,让答案出现在第一行。
改写前后对比
同一个 Bug 修复的两种汇报。内容节选并简化自仓库中的结果汇报示例。
| 常见汇报 | ste-zh 汇报 |
|---|---|
好的,我先看了一下登录相关的代码,发现问题应该是出在 token 刷新的逻辑上,大概是并发的时候两个请求同时去刷新导致的。然后我对 auth/refresh.ts 进行了修改,加了一个锁来实现串行化处理,另外顺手把一些日志之类的也优化了一下。测试基本都跑过了,应该没什么问题,不过 iOS 那边因为没有环境暂时没法验证。 | 已完成:登录刷新逻辑的代码修改。iOS 端未验证。 原因:两个请求同时刷新 token。后完成的刷新使先拿到的 token 失效。 验证: npm test auth — 48 项通过,0 项失败。iOS 端未验证:本机没有 iOS 构建环境。 |
汇报有哪些变化
- 关键信息先行
- 首句按回复类型写:结果汇报写状态与完成范围,进度说明写当前动作。
- 状态固定
- 工作状态与验证状态分开写,并各自限定范围。「已完成」不自动表示「已验证」。
- 如实写验证
- 修复效果和检查结果要写明检查方法、结果与覆盖范围。读取资料不能代替运行验证。
- 一词一义
- 规范用词,使用主动语态和短句,减少歧义。
- 选项化决策
- 需要人工决定时,Agent 列出带推荐项的编号选项,你回复数字即可。
ste-zh 只规范 Agent 写给你的文字,不影响项目代码、代码注释、Commit 信息和生成的文件。
安装 ste-zh
推荐使用 skills 命令行工具,它支持 Claude Code、Cursor、Codex 等环境:
# 所有项目通用
npx skills add dualface/ste-zh -g
# 只安装到当前项目
npx skills add dualface/ste-zh
# 只为 Claude Code 安装
npx skills add dualface/ste-zh -g -a claude-code
手动安装时,把仓库克隆到 Agent 的 skills 目录。这个 skill 的名称是 ste,所以目标目录必须命名为 ste:
git clone https://github.com/dualface/ste-zh.git ~/.claude/skills/ste
使用 ste-zh
在对话中输入 /ste 或「用 STE 规范输出」即可启用,当前会话的所有汇报都会遵守规范。发送「停止 ste」即可退出。如果希望每个会话都默认启用,在 Agent 的全局规则中写入「每个会话开始时加载 ste skill」。
这个 skill 靠 Agent 遵守指令生效,没有程序强制执行。在极长的会话中或发生上下文压缩后,Agent 可能遗忘规范,重新发送 /ste 即可恢复。
在手机上阅读汇报
结论先行的汇报更适合在小屏幕上阅读。用 QuickTUI 可以在手机上查看汇报并回复选项编号。使用 Kander 同时运行多张任务卡时,这种写法同样方便。
与 ASD-STE100 的关系
ASD-STE100 由 ASD 维护,只规定英文。ste-zh 是独立的个人开源项目,提炼了它的原则,并改写为一套独立的中文规则。本项目未收录标准原文与受控词典,与 ASD 无隶属关系。ASD-STE100 与 Simplified Technical English 的权利属于 ASD。
常见问题
ste-zh 免费吗?
免费。ste-zh 采用 MIT 许可证开源。
支持繁体中文吗?
支持。繁体中文版是 ste-zht。
支持哪些 Agent?
支持 SKILL.md 规范的 Agent 都可以使用。skills 命令行工具支持 Claude Code、Cursor、Codex 等环境。