中文文档排版指南

标题

  1. 一级标题下,不能直接出现三级标题。
  2. 标题要避免孤立编号(即同级标题只有一个)。
  3. 下级标题不重复上一级标题的名字。
  4. 谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。

段落

  • 一个段落只能有一个主题,或一个中心句子。
  • 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。
  • 一个段落的长度不能超过七行,最佳段落长度小于等于四行。
  • 段落的句子语气要使用陈述和肯定语气,避免使用感叹语气。
  • 段落之间使用一个空行隔开。
  • 段落开头不要留出空白字符。

文本

名词

  1. 专有名词使用正确的大小写。
  2. 不要使用不地道的缩写。

句子

  1. 避免使用长句。
  2. 尽量使用简单句和并列句,避免使用复合句。
  3. 同样一个意思,尽量使用肯定句表达,不使用否定句表达。
  4. 避免使用双重否定句。

写作风格

  1. 尽量不使用被动语态,改为使用主动语态。
  2. 不使用非正式的语言风格。
  3. 不使用冷僻、生造或者文言文的词语,而要使用现代汉语的常用表达方式。
  4. 用对“的”、“地”、“得”。
  5. 使用代词时(比如“其”、“该”、“此”、“这”等词),必须明确指代的内容,保证只有一个含义。
  6. 名词前不要使用过多的形容词。

英文处理

  1. 英文原文如果使用了复数形式,翻译成中文时,应该将其还原为单数形式。
  2. 外文缩写可以使用半角圆点(.)表示缩写。
  3. 表示中文时,英文省略号()应改为中文省略号(……)。
  4. 英文书名或电影名改用中文表达时,双引号应改为书名号。
  5. 第一次出现英文词汇时,在括号中给出中文标注。此后再次出现时,直接使用英文缩写即可。
  6. 专有名词中每个词第一个字母均应大写,非专有名词则不需要大写。

标点

  1. 中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致。
  2. 如果整句为英文,则该句使用英文/半角标点。
  3. 句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。

空格

  1. 中文与英文之间、中文与数字之间、英文与数字之间增加空格。
  2. 一段文字中有超链接的部分,在超链接的前后增加空格。
  3. 数字与单位之间、全角标点与其他字符之间不加空格。
  4. 对于有特殊用法的专有名词,如 4K、1080p、iOS 10 等,英文和数字之间是否空格以官方标准为准。

样式

LaTeX 公式

笔记

脚注

参考文献

  • ruanyf/document-style-guide:中文技术文档的写作规范
  • sparanoid/chinese-copywriting-guidelines:中文文案排版指北