leter/zh-tech-writing

写中文技术文档的 Agent Skill,基于阮一峰《中文技术文档的写作规范》:短句、平实、没有 AI 腔

解决的问题

它消除了中文技术文档中的“AI 风格”写作。许多 LLM 产生的文本过于冗长、充满营销术语,并使用重复的句子结构,对工程师来说感觉不自然。此项目提供一套规则与工作流程,确保技术文档(README、设计文档、API 规格、教程)简洁、事实导向且专业。

运作方式

它以“Agent Skill”的形式实现,兼容于 Claude Code 等工具。它引导 AI 遵循特定的写作流程:

  1. 受众定义:识别目标读者与期望结果。
  2. 基于规则的草稿:应用严格的句子长度规则(每个子句少于 20 字)、主动语态与直接动词。
  3. AI 风格清除:使用 14 点“AI 风格检查清单”来识别并移除陈词滥调、营销形容词与翻译式措辞。
  4. 自动格式化:与 autocorrect 工具集成,自动修正中英文字符间距与标点符号。
  5. 手动精修:对引号、省略号等特定符号进行最终检查。

适用对象

开发者与技术写作者,希望 AI 生成的中文文档听起来像是由人类工程师撰写,而非通用的 AI 助理。

重点特色

  • 事实导向:以具体事实、数字与错误消息取代模糊形容词(例如“强大”、“无缝”)。
  • 标准化:基于阮一峰的中文技术文档写作指南等既有准则。
  • 工具集成:与 skills CLI 兼容,并通过 autocorrect 支持自动标点修正。
  • 可自定义工作流程:可直接改写文件,或提供“原文 → 修改 → 原因”格式的建议改进清单。

相关

  • 项目
  • 项目
  • 项目
  • 项目