by mzopedia
简明技术中文 / Simplified Technical Chinese: a controlled language for Chinese technical writing, modelled on ASD-STE100. 40 rules, a one-meaning-one-word vocabulary, a zero-dependency checker, and an agent skill for Claude Code, Codex and Cursor.
# Add to your Claude Code skills
git clone https://github.com/mzopedia/simplified-technical-chineseGuides for using ai agents skills like simplified-technical-chinese.
See how simplified-technical-chinese compares with popular alternatives.
simplified-technical-chinese is an open-source ai agents skill for AI coding assistants such as Claude Code, Codex CLI, and ChatGPT, built by mzopedia. 简明技术中文 / Simplified Technical Chinese: a controlled language for Chinese technical writing, modelled on ASD-STE100. 40 rules, a one-meaning-one-word vocabulary, a zero-dependency checker, and an agent skill for Claude Code, Codex and Cursor. It has 52 GitHub stars.
simplified-technical-chinese's catalog security scan is still queued. You can run an instant dependency and prompt-injection check now with the "Scan for vulnerabilities" button above.
Clone the repository with "git clone https://github.com/mzopedia/simplified-technical-chinese" and add it to your Claude Code skills directory (see the Installation section above). simplified-technical-chinese ships a SKILL.md manifest, so compatible agents can discover and load it automatically.
simplified-technical-chinese is primarily written in Python. It is open-source under mzopedia on GitHub, so you can review or fork the full source.
Yes. SkillsLLM lists many other AI Agents skills you can browse and compare side by side. Open the AI Agents category from the badge at the top of this page, or use the Related Skills and comparison links further down to weigh simplified-technical-chinese against similar tools.
No comments yet. Be the first to share your thoughts!
Available after the catalog security scan passes.
⚠️ Third-Party Software Notice
This skill is third-party open-source software developed and hosted independently on GitHub. SkillsLLM is an informational directory and does not control or maintain the underlying repository.
Any security checks, ratings, or warnings displayed by SkillsLLM are automated and limited in scope. They do not constitute a security certification or guarantee that the software is safe, error-free, or free from malicious code, vulnerabilities, compromised dependencies, or prompt-injection risks.
Review the source code, permissions, dependencies, and configuration before installing or running any third-party skill. Use is at your own risk. To the maximum extent permitted by applicable law, SkillsLLM is not liable for losses arising from third-party software.
The deep catalog scan for this skill is still queued. Run an instant dependency check now instead.
See comparison
目标:读者读一遍就不会读错。做法:限制用词,限制句式,一句一事。
完整规则见 规范.md,词表见 词表.md。本文件只列最常用的部分。
用户没有说明时用常规模式。
字数算法:每个汉字计 1,每个英文单词或数字串计 1,行内代码计 1,标点不计。
词:
句:
段和步骤:
数字:
标记:
最常撞上的 20 条。完整表见 词表.md。
| 不用 | 用 |
|---|---|
| 「进行安装」 | 安装 |
| 「相关配置」 | 写出具体对象 |
| 「支持 A、B 等」 | 列全,或「包括 3 种:A、B、C」 |
| 「10 以上」 | 大于 10 / 不小于 10 |
| 「大概 5 秒左右」 | 5 秒 |
| 「尽快」 | 30 分钟内 |
| 「如果失败的话」 | 如果失败 |
| 「检查一下」 | 检查 |
| 「出现错误的情况」 | 出现错误时 |
| 「应该」「务必」「一定要」 | 必须(强制)/ 建议(推荐) |
| 「不得」「不准」 | 禁止 |
| 「单击」「点按」 | 点击 |
| 「删掉」「去掉」 | 删除 |
| 「开启功能」 | 启用功能 |
| 「打开程序」 | 启动程序 |
| 「登出」 | 退出登录 |
| 「键入」 | 输入 |
| 「入参」「出参」 | 参数 / 返回值 |
| 「登陆」「帐号」「缺省」 | 登录、账号、默认 |
| 「报错」(名词) | 错误 |
一词一义里最常错的 4 个:
判断内容类型。营销、叙事、法律原文不用本规范。
判断模式。默认常规模式。
写或改写。先定术语,再写句子。操作内容用编号列表。
如果结果保存成了文件,运行检查脚本:
python3 tools/check.py 文件.md
聊天回答这类没有编号步骤的内容,加 --kind 描述。
修复全部【必须】级别的发现。【建议】级别的按判断处理。
改写别人的文稿时,不改变事实、数字、条件和确定程度。原文说「可能」,改写后仍是「可能」。
脚本只查句法。它查不出事实错误、术语选错、逻辑顺序错。它用「编号列表项」判断操作句,用「的」的数量近似长定语,用几个标记词近似被动句。所有发现都要人工确认。
Simplified Technical Chinese(STC)。一套受控的中文写法,用于技术说明、操作步骤、接口文档和 AI 的解释性回答。目标是读者读一遍就不会读错。
它借鉴 ASD-STE100(Simplified Technical English)的方法:限制用词,限制句式,一句一事。它不是 ASD-STE100 的译本,与 ASD 没有关系。
English. STC is a controlled language for Chinese technical writing, modelled on the method of ASD-STE100: a numbered rule set, a controlled vocabulary (one meaning, one word), and a zero-dependency checker. It is not a translation of STE and is not affiliated with ASD. The rules are written for the ambiguities of Chinese: nominalised verbs (进行 + verb), long pre-nominal modifiers, the inclusive/exclusive ambiguity of 以上/以下, permission vs ability of 可以, and object restrictions on 打开/关闭/启动.
节选自 examples/before.md:
改写前:用户首先需要登陆到目标服务器,然后切换到 /opt 目录并且创建一个用于存放采集器配置文件以及运行时产生的临时数据的工作目录。
节选自 examples/after.md:
- 登录目标服务器。
- 切换到
/opt目录。- 创建工作目录
/opt/collector。工作目录存放配置文件和临时数据。
检查脚本对改写前那一句的输出:
examples/before.md:11: [1.3][必须] 禁用词「登陆」,改用:登录
examples/before.md:11: [2.1][必须] 操作句 56 字,不超过 30 字
examples/before.md:11: [4.1][建议] 禁用词「然后」,改用:拆成编号步骤
examples/before.md:11: [4.1][必须] 禁用词「并且」,改用:拆句
整篇改写前的文档有 34 条【必须】级别的发现,改写后是 0 条。
2026 年 10 月,Andrej Karpathy 发帖说,让大模型用 ASD-STE100 来解释东西,读起来清楚得多。ASD-STE100 是航空维修手册用的受控英语:53 条写作规则,加一本约 900 个词的词典,每个词只有一个意思。
中文没有对应的东西。已有的中文技术写作规范管排版、标点和文档结构,见和现有项目的区别。它们都没有做 STE 的核心:编号规则、受控词表、可以自动检查的句法约束。本项目补这一块。
| 文件 | 内容 |
|---|---|
| 规范.md | 写作规则。6 节,40 条,每条带「不批准 / 批准」例句。规则分【必须】和【建议】两级 |
| 词表.md | 受控词表。禁用词及替换、选词表(一个意义一个词)、一词一义限定。约 170 条 |
| tools/check.py | 检查脚本。零依赖,Python 3.9 及以上。读规范和词表,输出行号、规则号、级别 |
| SKILL.md | 给 Claude Code、Codex、Cursor 这类 agent 用的技能文件 |
| examples/ | 改写前后的完整示例 |
规则的六节:词、句、段、步骤与警告、数字时间与范围、术语与标记。最常用的几条:
用 skills 安装器:
npx skills add mzopedia/simplified-technical-chinese
或手动复制。Claude Code 的全局技能目录是 ~/.claude/skills/:
git clone --depth 1 https://github.com/mzopedia/simplified-technical-chinese.git ~/.claude/skills/simplified-technical-chinese
装好后,agent 在写中文技术说明时会按规范写,并在保存成文件后运行检查脚本。
不装技能时,把下面这段放进系统提示或对话里:
用简明技术中文回答。规则:一句只说一件事,操作句不超过 30 字,描述句不超过 40 字;操作步骤用编号列表,动词开头,不写「请」「您」;用主动句;条件写在动作前面;一个概念全文只用一个词;不用「进行」「相关」「等」「以上」「尽快」「大概」;不用反问和感叹;数字后不用「以上」「以下」,写「大于」「不小于」。
这对应规范的常规模式,也就是 Karpathy 说的「做到八成」。要全部规则时,把 规范.md 整个给模型。
读 规范.md。写完后用检查脚本过一遍:
python3 tools/check.py 文档.md
在 CI 里用 --strict,有【必须】级别的发现时退出码为 1:
python3 tools/check.py --strict docs/*.md
python3 tools/check.py 文件.md [更多文件]
--strict 有【必须】级别的发现时退出码为 1
--json JSON 输出
--kind 操作|描述 强制按一种句型检查。聊天回答用「描述」
--max-op 30 操作句字数上限
--max-desc 40 描述句字数上限
--no-vocab 不检查词表
--check-counterexamples 也检查「不批准:」开头的反例行
脚本能稳定查出的:
脚本查不出的:事实是否正确、术语选得对不对、逻辑顺序、一词一义限定。也查不出定语长度、指代是否清楚、缩写是否一致、步骤里的警告和原因。这几条规则在真实文档上校准时精确率太低,只留在规范文本里由人判断,见 docs/校准报告.md。脚本用编号列表项判断操作句。所有发现都要人工确认。
脚本不检查的内容:
stc: 指令除外<!-- stc:off --> 和 <!-- stc:on --> 之间的内容;<!-- stc:skip --> 跳过它后面的一段| 项目 | 管什么 | 本项目的关系 |
|---|---|---|
| ruanyf/document-style-guide | 标题、段落、数值、标点、文档结构 | 互补。本规范不管排版 |
| yikeke/zh-style-guide | 语言风格、标点、文档元素 | 互补 |
| Fenng/Tech-Doc-Style-Chinese | 事实保真、改写流程、术语排版,有一节受控写作原则 | 它有 6 条原则和改写样例,没有编号规则和词表,并且明确不把句长做成硬规则。本项目做的正是这部分 |
写完整文档时,建议三者配合:用本规范管句子和用词,用上面的项目管排版和结构。
0.2。规则、阈值和自动检查的词表在 350 万字真实中文技术文档上校准过。语料是 8 个开源项目的中文文档,共 2856 个文件。它们是 TiDB、Kubernetes、MDN、Vue、Vite、Ant Design 的文档,以及《Rust 程序设计语言》中文版和阮一峰的 ES6 教程。
脚本执行的每条规则都在真实文本上抽样判定过,错多于对的规则已从脚本移除。好文档上的提示从每万字 194 条降到 88 条,其中一半以上是句长提示。不算句长,从 151 条降到 40 条。句长上限取好文档句长分布的 90 分位:90% 的操作句不超过 33 字,90% 的描述句不超过 41 字。细节见 docs/校准报告.md。
规范、本文件和 SKILL.md 自身都通过了检查脚本(0 条【必须】),CI 每次提交都会复查。
已知问题:
提一个词的方法:开 issue,写清四项:词、意义、建议的处理(禁用 / 选词 / 限定)、一个例句。
改词表时保持表格的列顺序,「自动检查」列只填「是」或「否」。改完运行测试:
python3 -m unittest discover tests