中文文档格式规范

原文：中文文档格式规范

格式规范的目的是统一文档风格，使其更易于阅读和维护。以下规则适用于技术文档、Wiki、README 等中文文本。

中英文混排

技术文档中大量使用英文专有名词和缩写，中英文混排不可避免。

选择明确、简洁的表达

选择中文还是英文，以最能明确、简洁地传达含义为原则。已被广泛接受的英文名词和缩写应直接使用，无需翻译。例如 NBA 不必写成”北美职业篮球联赛”。

专有名词使用正确的大小写

大部分专有名词有其官方拼写，不应随意更改大小写：

正确：

使用 GitHub 登录

错误：

使用 Github 登录

空格

空格直接影响中英文混排的可读性。

中文与英文之间加空格

正确：

本站点使用 Jekyll 搭建，应用 HPSTR 主题。文章保存在 _posts 目录下。

错误：

本站点使用Jekyll搭建，应用HPSTR主题。文章保存在_posts目录下。

完整示例：

请尽量避免直接使用系统自带的 Ruby，推荐使用 rbenv 来管理本地 Ruby 运行环境，同时使用 ruby-build 来安装 Ruby，现使用的 Ruby 版本为 2.1.1。

中文与数字之间加空格

正确：

今天出去买菜花了 5000 元

错误：

今天出去买菜花了5000元

数字与单位之间加空格

正确：

带宽有 1 Gbps，硬盘一共有 10 TB。

错误：

带宽有 1Gbps，硬盘一共有 10TB。

链接前后加空格

正确：

请 点击这里 进行订阅。

错误：

请点击这里进行订阅。

标点符号

中文语境使用全角标点

在中文排版中，一律使用全角标点符号，包括括号和引号：

正确：

核磁共振成像（NMRI）是什么原理都不知道？JFGI！

错误：

核磁共振成像(NMRI)是什么原理都不知道?JFGI!

完整英文句子内使用半角标点

当引用完整的英文句子时，句子内部保持半角标点：

正确：

乔帮主那句话怎么说的？“Stay hungry, stay foolish.”

错误：

乔帮主那句话怎么说的？“Stay hungry，stay foolish。”

原则：外层中文引用使用全角标点，内部英文内容保持半角标点。

用词

使用简体中文

除非有明确的读者需求，一律使用简体中文。

使用大陆通用词汇

相关链接

• 中文文案排版指北
• 维基百科：格式手册