Skill · 中文写作

冯大辉那份 1483 星的中文技术写作规范,装进 Agent 之后是另一回事

准确先于修辞,清晰先于热闹。区别在于:这次不是人记住它,是 Agent 替你执行它。

目录

先说结论:这可能是目前中文 Agent 生态里最值得装的一个写作类 Skill。

仓库:https://github.com/Fenng/Tech-Doc-Style-Chinese ,作者 Fenng(冯大辉),MIT 协议,我装的是 v0.3.2(2026-09-29 发布)。写这篇文章时 1483 星、81 fork。

它跟「写作建议」的区别

网上讲中文技术写作的文章很多,问题是你看完就忘了,下次写还是老样子。

这份东西不一样:它是一个 SKILL.md,装进 Agent 的 skills 目录之后,每次写中文技术内容都会自动加载。规则不再依赖你的记忆力,而是变成 Agent 的默认行为。

覆盖范围:文档首页、产品介绍、更新日志、API 文档、参数说明、错误码、操作手册、故障排查、运维 Runbook、界面文案、按钮和提示信息。

最聪明的设计:先判断「任务模式」

大多数写作提示词一上来就改,它不。它要求先分清四种模式,因为不同模式的边界完全不同:

模式能做什么不能做什么
撰写先确定受众、类型、事实来源、篇幅缺关键事实时先标记缺口,不许编
改写保留事实、逻辑、信息层级、限制、例外不能顺手删掉条件和例外
校对只改错字、标点、留白、大小写、术语一致不许动结构、语气和事实表达
审阅先列问题再给建议,按影响排序并引用原文未经授权不直接改文件

「校对」这条最值钱。让 AI 帮你校稿,最怕的就是它顺手把你的结构和语气也改了——这个 Skill 明确禁止。

几条我会长期照着做的规则

挑最容易被忽略的几条(都写在 references/terminology-and-typography.md 里):

  1. 中文正文用直角引号 「」,嵌套用 『』。不是 ""。
  2. 中文与英文、数字、版本号之间加一个半角空格:使用 API 获取数据、等待 3 秒、版本 2.0 已发布。全角标点两侧不加空格。
  3. 中文段落在源文件里一段一行,不要为了控制行宽硬换行。Markdown 里那种手动断行会让 diff 和后续处理全乱。
  4. 不要直接批量跑排版替换工具——先保护 Markdown、代码和机器可读内容。这条是血泪经验,批量替换最容易把代码块和 URL 搞坏。
  5. 同一概念用同一术语,不为了「避免重复」换同义词。技术文档里「回调 / 回执 / 通知」混用是灾难。
  6. 不改写代码字面量、JSON 键名、URL、API 路径、数据库字段名、命令、配置项。这条写在适用范围里,属于红线。

还有一句我很喜欢:准确先于修辞,清晰先于热闹。默认不直接称呼读者,避免问候式开场、宣传口号和黑话堆叠。

两个能直接跑的脚本

规范之外,仓库还带了两个可执行的检查器,不是摆设:

# 检查文案规则(标点、留白、大小写、术语)
python scripts/lint_copy_rules.py README.md docs/

# 严格模式:警告和风格提示也当失败
python scripts/lint_copy_rules.py --strict docs/

# 检查 Markdown 段落硬换行(只查不改)
python scripts/unwrap_md_paragraphs.py --check .

# 展开硬换行,直接写回
python scripts/unwrap_md_paragraphs.py docs/ README.md

第二个脚本专门处理「中文段落被硬换行切断」的问题,拼接时会按中西文留白规则处理边界——中文与中文之间不加空格,中文与半角英文、数字之间加一个。

作者自己在发布说明里写了:本地验证跑通 88 个回归测试 + 严格文案检查 + 段落硬换行检查。这种把规范做成可测试项目的做法,比写一百条「建议」管用。

装在哪

把仓库放进你的 skills 目录即可,我装到了:

C:\Users\LH\.workbuddy-ai\skills\tech-doc-style-chinese\

目录结构:SKILL.md(主规范)、NoCode-Skill.md、references/(4 份细化参考)、scripts/(2 个检查器)、agents/。

安全方面我扫过了:没有下载即执行、没有 eval、没有删文件动作,subprocess 只出现在测试里,外联域名只有 example.com。可以放心装。

我准备怎么用它

  • 站点文章发布前跑一遍 --check:我自己的 Hugo 文章经常有手滑的硬换行和中英留白不一致,交给脚本比肉眼靠谱。
  • 牙科公众号初稿校对:用「校对」模式,让它只改标点和术语,不许动结构和语气——科普文最怕被改出一股说明书味。
  • API / 界面文案:错误提示要写清「发生了什么 + 影响是什么 + 怎么恢复」,这套规则可以直接当评审清单。

两点提醒

  1. 项目约定优先于 Skill 自带示例。它会要求先读目标项目自己的 AGENTS.md、术语表和品牌规范,不要把仓库里的示例约定当成你的约定。
  2. 受控中文技术写作那套规则不要机械套到品牌文案和叙事文本上。它是给操作手册、故障排查、运维 Runbook 用的。

来源:Fenng/Tech-Doc-Style-Chinese,本文基于 v0.3.2(2026-09-29)实际安装并阅读源码后写成,星数与日期为 2026-10-11 实时查询。

— 完 —

返回首页

留言

还没有留言,来当第一个吧。

加载留言中…

写留言

无需登录,直接留言;想回复别人,点留言下方的「回复」。