中文技术文档写作规范 概述 中文技术文档最常见的问题不是内容不够,而是 读起来别扭 ——中英文挤在一起没有空格、全角半角混用、一股机翻味。本技能提供一套完整的中文技术文档写作规范,让你的文档 专业、好读、不出戏 。 核心原则: 排版服务于阅读体验,规范服务于一致性,内容服务于读者。 参考标准: 中文文案排版指北 中文排版规范 空格 中英文之间加空格: 中文与数字之间加空格: 数字与单位之间加空格: 例外:度数、百分比等不加空格: 链接前后加空格: 标点符号 中文语境使用全角标点: 全角标点与英文/数字之间不加空格: 括号的使用: 引号的使用: 数字 中英混排最佳实践 术语处理原则 保留英文的情况: - 专有名词:React、Kubernetes、Redis、MySQL - 行业通用缩写:API、SDK、CLI、ORM、CI/CD - 命令和代码: 、 - 协议和标准:HTTP、TCP/IP、JSON、REST - 没有公认中文翻译的术语:debounce、throttle、middleware 翻译为中文的情况: - 有公认翻译的通用概念:数据库、服务器、浏览器、框架 - 描述性短语:version control → 版本控制,load balancing → 负载均衡 - 文档标题和章节名(尽量中文,技术名词可保留英文) 首次出现标注翻译 技术术语首次出现时,标注中英对照:…