zh-tech-writing

Installation
SKILL.md

中文技术文档写作

目标:写出像资深工程师写的中文技术文档。平实、具体、短句。

流程

写新文档:

  1. 先想清楚读者是谁,读完要能做成什么事。一句话说不清,先问用户。
  2. 按下面的“句子”“语气”“段落与结构”“排版”写。
  3. 自检:拿“AI 腔清单”逐条对照全文,命中的全部改掉。
  4. 跑 autocorrect --fix <文件>,修空格和标点。命令不存在就跳过,改为按“排版”手动检查。
  5. 手动检查 autocorrect 管不到的:引号、省略号、破折号。

修改已有文档:

  1. 通读全文,再动手。
  2. 用户只要意见:按“原句 → 改后 → 原因”列出问题,不改文件。
  3. 否则直接改,然后做上面的第 3~5 步。最后用两三句话说明改了哪几类问题。
Installs
164
GitHub Stars
377
First Seen
Sep 24, 2026