本文转载了阮一峰的《中文技术文档的写作规范》。

本站之前发布的文章有许多并没有遵循这一规范（例如中英文之间应有空格）。在今后的工作和写作中，我会尽量书写规范的文档，提高文章的易读性。

标题分为四级。

下面是示例。

（1）一级标题下，不能直接出现三级标题。

示例：下面的文章结构，缺少二级标题。

（2）标题要避免孤立编号（即同级标题只有一个）。

示例：下面的文章结构，二级标题 A只包含一个三级标题，完全可以省略 三级标题 A。

（3）下级标题不重复上一级标题的名字。

示例：下面的文章结构，二级标题与下属的三级标题同名，建议避免。

（4）谨慎使用四级标题，尽量避免出现，保持层级的简单，防止出现过于复杂的章节。

如果三级标题下有并列性的内容，建议只使用项目列表（Item list）。

示例：下面的结构二要好于结构一。结构一适用的场景，主要是较长篇幅的内容。

（1）全角中文字符与半角英文字符之间，应有一个半角空格。

（2）全角中文字符与半角阿拉伯数字之间，有没有半角空格都可，但必须保证风格统一，不能两种风格混杂。

半角的百分号，视同阿拉伯数字。

（3）英文单位若不翻译，单位前的阿拉伯数字与单位符号之间，应留出适当的空隙。

（4）半角英文字符和半角阿拉伯数字，与全角标点符号之间不留空格。

（1）避免使用长句。

不包含任何标点符号的单个句子，或者以逗号分隔的句子构件，长度尽量保持在 20 个字以内；20 ～ 29 个字的句子，可以接受；30 ～ 39 个字的句子，语义必须明确，才能接受；多于 40 个字的句子，任何情况下都不能接受。

逗号分割的长句，总长度不应该超过 100 字或者正文的 3 行。

（2）尽量使用简单句和并列句，避免使用复合句。

（3）同样一个意思，尽量使用肯定句表达，不使用否定句表达。

（4）避免使用双重否定句。

（1）尽量不使用被动语态，改为使用主动语态。

（2）不使用非正式的语言风格。

（3）不使用冷僻、生造或者文言文的词语，而要使用现代汉语的常用表达方式。

（4）用对“的”、“地”、“得”。

（5）使用代词时（比如“其”、“该”、“此”、“这”等词），必须明确指代的内容，保证只有一个含义。

（6）名词前不要使用过多的形容词。

（1）英文原文如果使用了复数形式，翻译成中文时，应该将其还原为单数形式。

（2）外文缩写可以使用半角圆点 (.) 表示缩写。

（3）表示中文时，英文省略号（...）应改为中文省略号（⋯⋯）。

（4）英文书名或电影名改用中文表达时，双引号应改为书名号。

（5）第一次出现英文词汇时，在括号中给出中文标注。此后再次出现时，直接使用英文缩写即可。

（6）专有名词中每个词第一个字母均应大写，非专有名词则不需要大写。

引用第三方内容时，应注明出处。

如果是全篇转载，请在全文开头显著位置注明作者和出处，并链接至原文。

使用外部图片时，必须在图片下方或文末标明来源。

阿拉伯数字一律使用半角形式，不得使用全角形式。

数值为千位以上，应添加千分号（半角逗号）。

对于 4 位的数值，千分号是选用的，比如 1000和 1,000都可以接受。对于 4 位以上的数值，应添加千分号。

货币应为阿拉伯数字，并在数字前写出货币符号，或在数字后写出货币中文名称。

英文的货币名称，建议参考国际标准 ISO 4217。

表示数值范围时，用波浪线（～）或一字线（—）连接。参见《标点符号》一节的“连接号”部分。

带有单位或百分号时，两个数字建议都要加上单位或百分号。

数字的增加要使用“增加了”、“增加到”。“了”表示增量，“到”表示定量。

数字的减少要使用“降低了”、“降低到”。“了”表示增量，“到”表示定量。

不能用“降低 N 倍”或“减少 N 倍”的表示法，要用“降低百分之几”或“减少百分之几”。因为减少（或降低）一倍表示数值原来为一百，现在等于零。

（1）中文语句的标点符号，均应该采取全角符号，这样可以与全角文字保持视觉的一致。

（2）如果整句为英文，则该句使用英文/半角标点。

（3）句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。

（4）点号（句号、逗号、顿号、分号、冒号）不得出现在标题的末尾，而标号（引号、括号、破折号、省略号、书名号、着重号、间隔号、叹号、问号）可以。

（1）中文语句的结尾处应该用全角句号（。）。

（2）句子末尾用括号加注时，句号应在括号之外。

（1）逗号（，）表示句子内部的一般性停顿。

（2）注意避免“一逗到底”，即整个段落除了结尾，全部停顿都使用逗号。

（1）句子内部的并列词，应该用全角顿号 (、) 分隔，而不用逗号，即使并列词是英语也是如此。

（2）英文句子中，并列词语之间使用半角逗号（,）分隔。

（3）中文句子内部的并列词，最后一个尽量使用（和）来连接，使句子读起来更加连贯，下面两个句子都可以，第二个更优。

（1）分号（；）表示复句内部并列分句之间的停顿。

（1）引用时，应该使用全角双引号（“ ”），注意前后双引号不同。

（2）引号里面还要用引号时，外面一层用双引号，里面一层用单引号（‘ ’），注意前后单引号不同。

（1）补充说明时，使用全角圆括号（（）），括号前后不加空格。

（2）几种括号的中英文名称。

（1）全角冒号（：）常用在需要解释的词语后边，引出解释和说明。

（2）表示时间时，应使用半角冒号（:）。

（1）省略号（⋯⋯）表示语句未完、或者语气的不连续。

（2）省略号占两个汉字空间、包含六个省略点，不要使用 。或 ...等非标准形式。

（3）省略号不应与“等”这个词一起使用。

（1）应该使用平静的语气叙述，尽量避免使用感叹号（！）。

（2）不得多个感叹号连用，比如 ！！和 !!!。

（1）破折号 ————一般用于进一步解释。

（2）破折号应占两个汉字的位置。如果破折号本身只占一个汉字的位置，那么前后应该留出一个半角空格。

（1）连接号用于连接两个类似的词。

（2）以下场合应该使用直线连接号（-），占一个半角字符的位置。

（3）数值范围（例如日期、时间或数字）应该使用波浪连接号（～）或一字号（—），占一个全角字符的位置。

注意，波浪连接号前后两个值都建议加上单位。

（4）波浪连接号也可以用汉字“至”代替。

软件手册是一部完整的书，建议采用下面的结构。

下面是两个真实范例，可参考。

文档的文件名不得含有空格。

文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。

文件名建议只使用小写字母，不使用大写字母。

为了醒目，某些说明文件的文件名，可以使用大写字母，比如 README、LICENSE。

文件名包含多个单词时，单词之间建议使用半角的连词线（-）分隔。