by leter
写中文技术文档的 Agent Skill，基于阮一峰《中文技术文档的写作规范》：短句、平实、没有 AI 腔
# Add to your Claude Code skills
git clone https://github.com/leter/zh-tech-writingGuides for using ai agents skills like zh-tech-writing.
See how zh-tech-writing compares with popular alternatives.
zh-tech-writing is an open-source ai agents skill for AI coding assistants such as Claude Code, Codex CLI, and ChatGPT, built by leter. 写中文技术文档的 Agent Skill，基于阮一峰《中文技术文档的写作规范》：短句、平实、没有 AI 腔. It has 82 GitHub stars.
zh-tech-writing'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/leter/zh-tech-writing" and add it to your Claude Code skills directory (see the Installation section above).
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 zh-tech-writing against similar tools.
No comments yet. Be the first to share your thoughts!
⚠️ 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
一个写中文技术文档的 Agent Skill。用它写 README、设计文档、接口说明和教程，读起来像工程师写的，没有 AI 腔。
规则基于阮一峰的《中文技术文档的写作规范》整理，另外补充了一份“AI 腔清单”。
适用于 Claude Code，以及其他支持 Agent Skills 的工具。
下面是一段常见的 AI 写法：
随着微服务架构的不断发展，配置管理已经成为一个不容忽视的问题。值得注意的是，ConfigHub 不仅提供了强大的配置管理能力，更实现了与现有系统的无缝集成——让你轻松应对各种复杂场景！
用这个 skill 以后：
ConfigHub 用来集中管理多个服务的配置。修改配置后，服务会在 5 秒内加载新值，不用重启。接入时，在启动命令里加上
--config-hub=<地址>即可。
改动有三处：
事实需要来自你的项目。skill 找不到事实时，会删掉空话，或者直接问你。
用 skills 命令行工具安装到全局：
npx skills add leter/zh-tech-writing -g
也可以手动安装。把 skills/zh-tech-writing 目录复制到 ~/.claude/skills/ 下面：
git clone https://github.com/leter/zh-tech-writing.git
cp -r zh-tech-writing/skills/zh-tech-writing ~/.claude/skills/
autocorrect 是一个命令行工具。它会自动在中英文之间补空格，并把中文句子里的半角标点改成全角。装了它，AI 写完文档后会按 skill 的要求运行一遍；没装就跳过这一步。
# macOS
brew install autocorrect
# Linux：从 Releases 页面下载二进制文件，放到 PATH 里的任意目录
# https://github.com/huacnlee/autocorrect/releases
# 已经装了 Rust 工具链
cargo install autocorrect
装好后运行 autocorrect -V，能看到版本号就说明装好了。
你让 AI 写或修改中文技术文档时，skill 通常会自动加载。比如：
帮我给这个项目写一份 README
把 docs/deploy.md 改得更易读一些
也可以手动调用：
/zh-tech-writing 改一下 docs/api.md
如果只想看修改意见，不想让它直接改文件，就说出来：
/zh-tech-writing 检查 docs/api.md，只列问题，不要改
它会按“原句 → 改后 → 原因”的格式列出问题。
skill 让 AI 按下面的流程写文档：
autocorrect --fix，修正空格和标点。主要规则：
完整规则见 SKILL.md。
skills/zh-tech-writing/
├── SKILL.md 主文件：流程、核心规则、AI 腔清单
└── references/
├── typography.md 数字、标点、英文缩写的细则
└── manual-structure.md 产品手册的目录结构和文件命名
references/ 下的文件只在需要时读取。比如，文档里有数字范围时才读 typography.md。
——，省略号用 ……。