skills

About

chinese-document-writing 是一个面向 Codex 和 Claude Code 的中文技术文档写作技能，用来让 AI 按统一规范撰写、改写、润色和审校 README、安装指南、FAQ、接口文档、发布说明和操作手册。 它解决的问题很具体：AI 可以很快写出一段中文说明，但常见问题是标题层级跳跃、句子过长、标点混用、数字写法不统一、术语前后不一致，最后还需要人工重新整理一遍。这个 Skill 把中文技术文档的结构模板、风格规则和交付前自检清单放到一个可复用目录里，让 AI 在处理中文文档时先按文档类型组织内容，再统一表达和格式。 目前仓库里收录的技能是 chinese-document-writing，包含： SKILL.md：定义触发条件、工作流和输出要求。 references/style-rules.md：中文技术文档风格规则。 references/templates.md：README、教程、API 文档、发布说明等常见结构模板。 references/checklist.md：交付前自检清单。 agents/openai.yaml：客户端展示名称与默认提示词。 scripts/install-chinese-document-writing.sh：一键安装脚本。 适合的场景： 把杂乱的中文 README 改写成正式项目文档。 统一团队文档里的标题层级、标点、数字和术语风格。 把零散笔记整理成安装指南、操作手册或知识库文章。 审校 FAQ、产品说明、接口文档和发布说明。 安装方式： bash git clone cd skills bash scripts/install-chinese-document-writing.sh 默认会同时安装到： Codex：~/.codex/skills/chinese-document-writing Claude Code：~/.claude/skills/chinese-document-writing 也可以只安装到其中一个客户端： bash bash scripts/install-chinese-document-writing.sh --codex-only bash bash scripts/install-chinese-document-writing.sh --claude-only 安装后可以这样使用： text 使用 $chinese-document-writing 把这份安装指南改写成正式中文技术文档。 text 使用 $chinese-document-writing 审校这份 README，统一标题层级、标点和术语。 这个仓库本质上不是在线服务，也不绑定特定模型；它更像是一套可以放进本地 AI 编程助手里的中文技术写作规范包。当前 Skill 的中文技术文档规范整理参考了 ruanyf/document-style-guide，并针对 AI 写作流程补充了触发条件、模板选择、风格规则和最终自检步骤。 项目许可证为 MIT。它比较适合经常维护中文 README、项目文档、内部知识库、接口文档和发布说明的开发者或团队。

Discovery history

1. 阮一峰周刊·用户投稿

   May 16, 2026 · 1 observations