中文文档排版参考——中英文空格、全半角标点、术语保留、链接格式、中文文案排版指北约定。仅在用户显式 /chinese-documentation 时调用，不要根据上下文自动触发。

中文技术文档写作规范概述中文技术文档最常见的问题不是内容不够，而是读起来别扭 ——中英文挤在一起没有空格、全角半角混用、一股机翻味。本技能提供一套完整的中文技术文档写作规范，让你的文档专业、好读、不出戏。核心原则：排版服务于阅读体验，规范服务于一致性，内容服务于读者。参考标准： [中文文案排版指北](https://github.com/sparanoid/chinese copywriting guidelines) 中文排版规范空格中英文之间加空格：中文与数字之间加空格：数字与单位之间加空格：例外：度数、百分比等不加空格：链接前后加空格：标点符号中文语境使用全角标点：全角标点与英文/数字之间不加空格：括号的使用：引号的使用：数字中英混排最佳实践术语处理原则保留英文的情况：专有名词：React、Kubernetes、Redis、MySQL 行业通用缩写：API、SDK、CLI、ORM、CI/CD 命令和代码： npm install 、 git commit 协议和标准：HTTP、TCP/IP、JSON、REST 没有公认中文翻译的术语：debounce、throttle、middleware 翻译为中文的情况：有公认翻译的通用概念：数据库、服务器、浏览器、框架描述性短语：version control → 版本控制，load balancing → 负载均衡文档标题和章节名（尽量中文，技术名词可保留英文）首次出现标注翻译技术术语首次出现时，标注中英对照：避免过度翻译 API 文档中英对照格式接口文档模板 json { "product id": "prod abc123", "quantity": 2, "address id": "addr xyz789", "coupon code": "SUMMER2024" } \ json { "code": 0, "message": "success", "data": { "order id": "ord 20240315001", "status": "pending", "total amount": 9900, "created at": "2024 03 15T10:30:00+08:00" } } \ 金额表示约定 README.md 中文模板国内开源项目常用的 README 结构： bash npm install your package \ typescript import { YourPackage } from 'your package'; const client = new YourPackage({ apiKey: 'your key' }); const result = await client.doSomething(); \ bash 克隆项目 git clone https://gitee.com/your org/your project.git 安装依赖 npm install 启动开发服务器 npm run dev 运行测试 npm test \ 常见问题与避坑指南问题一：机翻味特征：句式生硬、不符合中文表达习惯。要点：避免被动语态（"被用来" → "用于"）避免冗余代词（"你想要" → 直接说）避免直译英文句式问题二：句式欧化特征：长定语、多重从句、一句话说不完。要点：长句拆成短句把定语从句改成并列句一句话只说一件事问题三：过度翻译问题四：中英标点混用问题五：缺乏结构化写作检查清单在发布文档前，逐项检查：排版 [ ] 中英文之间有空格 [ ] 中文与数字之间有空格 [ ] 中文语境使用全角标点 [ ] 英文/代码部分使用半角标点 [ ] 没有全角半角标点混用术语 [ ] 专有名词保留英文原文 [ ] 首次出现的术语标注了中英对照 [ ] 没有过度翻译业界通用术语 [ ] 术语使用前后一致内容 [ ] 句子简短，没有欧化长句 [ ] 没有不必要的被动语态 [ ] 用列表和表格组织结构化信息 [ ] 代码示例可以直接运行 [ ] 没有"机翻味" 格式 [ ] 标题层级正确（不跳级） [ ] 代码块标注了语言类型 [ ] 链接可以正常访问 [ ] 图片有 alt 文本