# Chinese Document Writing > 用于撰写、改写、润色或审校中文技术文档、产品说明、README、操作手册、知识库文章、发布说明、接口文档和 FAQ。适用于需要统一中文标题层级、段落结构、句式风格、数字写法、标点、引用与文件命名规范的场景，尤其当用户要求“按中文技术文档规范”输出时使用。 Use when this capability is needed. - Skill: `tomevault-io/chinese-document-writing` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/chinese-document-writing` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/chinese-document-writing/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Coding & Dev Tools - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/chinese-document-writing --- # 中文文档书写 ## 概述 这个 skill 用于把零散信息整理成清晰、一致、可维护的中文文档，或把现有中文文档改写成更符合技术写作规范的版本。 优先目标是让文档做到四件事：结构清楚、句子简洁、术语一致、可直接交付。 ## 何时使用 在以下场景触发： - 用户要求撰写或改写中文技术文档。 - 用户要求润色 README、教程、FAQ、接口文档、变更说明、安装指南、操作手册或知识库文章。 - 用户明确要求“符合中文文档规范”“统一风格”“检查排版和标点”。 - 你发现当前任务的主要难点不是代码，而是文档结构、表达质量和书写规范。 以下场景通常不需要触发： - 只需翻译单个短句或单个 UI 文案。 - 用户只要求总结代码逻辑，且不需要形成正式文档。 ## 工作流 ### 1. 判断文档类型 先判断输出属于哪一类，再决定结构： - `README`：介绍、安装、快速开始、常见用法、FAQ。 - 教程/手册：简介、前置条件、安装、设置、基础使用、进阶使用、附录。 - API 文档：概览、认证、参数、返回值、错误、示例。 - 发布说明：版本信息、变更摘要、不兼容改动、迁移方式、已知问题。 如不确定，先阅读 [templates.md](references/templates.md) 选择最接近的模板。 ### 2. 组织信息 先把用户输入按下面顺序整理： 1. 目标读者是谁。 2. 读者要完成什么任务。 3. 必须先知道哪些前置条件。 4. 正文应该按什么顺序展开。 5. 哪些内容必须引用来源、版本或外部链接。 如果材料不完整，优先交付结构清晰的正式文档，不输出占位符，不写“待补充”。 ### 3. 起草正文 起草时始终遵守 [style-rules.md](references/style-rules.md)： - 标题层级连续，不跳级。 - 段落只表达一个主题，长度保持短小。 - 中文表达优先使用主动句、肯定句、常用词。 - 数字、单位、百分比、时间、范围和货币写法统一。 - 中文句子使用全角标点；英文整句使用半角标点。 - 引用第三方内容时标明来源。 ### 4. 做最终自检 交付前逐项核对 [checklist.md](references/checklist.md)。 如果是整篇重写或新建文档，必须完整检查。 如果是局部润色，至少检查本次改动涉及的标题、段落、标点、数字和引用。 ## 输出要求 - 默认输出简体中文。 - 默认保留 Markdown 结构，除非用户明确要求其他格式。 - 标题应概括内容，不做口号式表达。 - 句子尽量短，避免长句、双重否定、堆叠修饰语。 - 术语首次出现时，必要时补中文解释或中英文对照；后文保持一致。 - 不使用夸张语气、营销语气、感叹号连用或口语化表达。 ## 常见改写策略 - 杂乱段落：先提炼中心句，再拆成 2～4 个短段。 - 跳级标题：补足缺失层级，或把孤立下级标题提升一级。 - 说明不清：改成“前提 -> 操作 -> 结果”。 - 句子过长：拆分为多个简单句或并列句。 - 数字混乱：统一空格、单位、范围和千分号格式。 - 引用缺失：在段末、图下注或文首补充来源。 ## 参考文件 - [style-rules.md](references/style-rules.md)：核心中文文档风格规则。 - [templates.md](references/templates.md)：常见文档结构模板。 - [checklist.md](references/checklist.md)：交付前自检清单。 --- > Source: [yuluo-yx/skills](https://github.com/yuluo-yx/skills) — distributed by [TomeVault](https://tomevault.io).