中文技术写作规范与审校：把英文技术内容或口语化表达，改写成简洁、专业、无翻译腔的中文。适用于写文档、README、发布说明、技术博客、产品文案与对外邮件。含标点与中英混排规则、常见病句对照表和终稿检查清单。
下载这个 Skill 需要先登录（免费注册，只需用户名和密码）。去登录 →
按元信息、示例、可执行性、完整性等 13 项自动检查，供作者自查改进；不影响用户评分。
# 中文技术写作 给技术内容写中文时，最大的问题不是"不够华丽"，而是**翻译腔、冗余、指代不清**。这个技能给出一套可直接执行的写作与审校规则。 ## 何时启用 - 写或改 README、API 文档、发布说明（changelog）、故障复盘 - 把英文文档、论文摘要、开源项目介绍翻成中文 - 写技术博客、公众号文章、产品更新说明 - 审校别人写的技术文案，去掉"机翻感" ## 三条硬规则 ### 1. 结论先行 第一段就把"这是什么、解决什么问题、给谁用"说清楚。不要用"随着人工智能技术的飞速发展……"这类铺垫开头。 - 差：在当前数字化转型的大背景下，我们针对用户在配置环节中遇到的诸多痛点，进行了全面的优化与升级。 - 好：配置文件现在支持热重载，改完保存即可生效，不用重启服务。 ### 2. 一句一件事 中文技术写作最常见的毛病是一句话套三层从句。把长句拆成短句，每句只表达一个意思。 - 差：由于该接口在并发量较高的情况下会出现响应延迟增加的问题，因此我们对底层查询逻辑进行了重构，从而使得性能得到了显著提升。 - 好：这个接口在并发高时响应变慢。我们重写了底层查询，现在 P99 从 800ms 降到 120ms。 ### 3. 能用动词就不用名词化 "进行优化""做出处理""实现提升"都是名词化堆砌，直接写动作。 | 别写 | 写成 | | --- | --- | | 对配置进行修改 | 改配置 | | 实现对错误的捕获 | 捕获错误 | | 进行了性能方面的优化 | 优化了性能 | | 对该问题进行分析 | 分析这个问题 | ## 中英混排与标点 1. 中文句子用**全角标点**（，。；：！？），英文单词、代码、路径内部用半角。 2. 中文与英文/数字之间加一个空格：`使用 Redis 缓存`、`耗时 120 ms`、`共 3 个节点`。 3. 不要混用顿号和逗号列举；并列短词用顿号（`A、B、C`），并列长句用逗号。 4. 括号：中文语境用全角括号（），括号内是纯英文时用半角 ()。 5. 省略号用 `……`（六点），不用 `...` 表示中文语气的停顿。 6. 数字与单位之间加空格，百分比不加空格：`8 GB`、`30%`、`第 3 章`。 7. 引号用中文引号「」或""，代码里的字符串标识符用反引号包裹。 ## 术语处理 - **首次出现**给中英对照：`幂等（idempotent）`，之后统一用中文。 - 已被行业接受的英文词不要硬翻：`token`、`commit`、`prompt`、`webhook` 保留英文更清楚。 - 全篇术语必须一致：不要一会儿"接口"一会儿"API"一会儿"服务端点"。 - 自造译名是最容易翻车的地方：不确定就用英文原词 + 一句解释。 ## 常见病句对照 | 病句 | 问题 | 改法 | | --- | --- | --- | | 通过使用缓存的方式，使得性能得到了提升 | 名词化 + 冗余 | 加了缓存，性能提升约 40% | | 该功能目前暂不支持 | 语义重复 | 暂不支持该功能 | | 我们发现了一个问题，该问题的原因是由于…… | 指代啰嗦 | 问题出在…… | | 建议用户可以对配置进行调整 | 语气叠加 | 建议调整配置 | | 这不仅提升了效率，同时也降低了成本 | 套话 | 效率提高，成本下降 | | 经过测试，功能正常 | 信息量为零 | 测试通过：登录、下单、退款 3 条主链路 | ## 结构模板 ### README / 项目介绍 ``` 一句话：它是什么 + 解决什么问题 快速开始：3 行以内能跑起来 核心能力：3-5 条，每条一句 配置说明：表格 常见问题：3-5 条真实提问 ``` ### 变更说明（changelog） ``` ## v1.4.0 新增：xxx（谁受益、怎么用） 修复：xxx（原来什么表现，现在什么表现） 破坏性变更：xxx（升级要做什么） ``` ### 故障复盘 ``` 现象：什么时间、谁发现、影响范围 时间线：按分钟列关键动作 根因：一句话说清，不甩锅 修复：做了什么 后续：3 条具体改进，带负责人和时间 ``` ## 审校清单（交付前逐条过） - [ ] 第一段是否直接给出了结论或用途 - [ ] 有没有超过 40 字的句子（有就拆） - [ ] 有没有"进行/实现/使得"这类空动词 - [ ] 中英文之间是否有空格，标点是否全角 - [ ] 术语是否全篇一致，首次出现是否有对照 - [ ] 有没有"随着……的发展""在……背景下"这类铺垫 - [ ] 有没有承诺性表述但没有依据（"大幅提升""业界领先"） - [ ] 代码块是否标了语言、能否直接复制运行 ## 反向提醒 不要为了"专业"而写长句和术语堆砌。读者要的是**能在 30 秒内知道该做什么**。宁可短、具体、带数字，也不要完整、正确、但没人读完。