写作规范
本问记录该网站的写作规范。
标题
(1) 标题最多允许四级。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
(2) 一级标题作为文章主题，有且只有一个。
(3) 标题避免重复，如二级标题不能与一级标题重复。
(4) 尽量避免使用四级标题。
间距
(1) 全角中文字符与半角英文字符之间，应有一个半角空格。
错误：本文介绍如何快速启动Windows系统。
正确：本文介绍如何快速启动 Windows 系统。
(2) 全角中文字符与半角阿拉伯数字之间，应有一个半角空格。
错误：2011年5月15日，我订购了5台笔记本电脑与10台平板电脑。
正确：2011 年 5 月 15 日，我订购了 5 台笔记本电脑与 10 台平板电脑。
(3) 英文单位若不翻译，单位前的阿拉伯数字与单位符号之间，应留出适当的空隙。
例 1：一部容量为 16 GB 的智能手机
例 2：1 h = 60 min = 3,600 s
(4) 半角英文字符和半角阿拉伯数字，与全角标点符号之间不留空格。
错误：他的电脑是 MacBook Air 。
正确：他的电脑是 MacBook Air。
句子
(1) 避免使用长句。
以逗号隔开的句子长度保持在 20 个字以内。
以句号隔开的句子长度保持在 100 个字符以内。
(2) 尽量使用简单句和并列句，避免使用复合句。
并列句：他昨天生病了，没有参加会议。
复合句：那个昨天生病的人没有参加会议。
(3) 同样一个意思，尽量使用肯定句表达，不使用否定句表达。
错误：请确认没有接通装置的电源。
正确：请确认装置的电源已关闭。
(4) 避免使用双重否定句。
错误：没有删除权限的用户，不能删除此文件。
正确：用户必须拥有删除权限，才能删除此文件。
写作风格
(1) 尽量不使用被动语态，改为使用主动语态。
错误：假如此软件尚未被安装，
正确：假如尚未安装这个软件，
(2) 不使用非正式的语言风格。
错误：啊啊啊 Lady Gaga 的演唱会好酷！！！
正确：无法参加本次活动，我深感遗憾。
(3) 不使用冷僻、生造或者文言文的词语，而要使用现代汉语的常用表达方式。
错误：这是唯二的快速启动的方法。
正确：这是仅有的两种快速启动的方法。
(4) 名词前不要使用过多的形容词。
英文处理
(1) 英文原文如果使用了复数形式，翻译成中文时，应该将其还原为单数形式。
英文：information stored in random access memory (RAMs)
中文：存储在随机存取存储器（RAM）里的信息
(2) 外文缩写可以使用半角圆点(.)表示缩写。
U.S.A.
Apple, Inc.
(3) 英文书名或电影名改用中文表达时，双引号应改为书名号。
英文：He published an article entitled "The Future of the Aviation".
中文：他发表了一篇名为《航空业的未来》的文章。
(4) 第一次出现英文词汇时，在括号中给出中文标注。此后再次出现时，直接使用英文缩写即可。
IOC（International Olympic Committee，国际奥林匹克委员会）。这样定义后，便可以直接使用 IOC 了。
(5) 专有名词中每个词第一个字母均应大写，非专有名词则不需要大写。
“American Association of Physicists in Medicine”（美国医学物理学家协会）是专有名词，需要大写。
“online transaction processing”（在线事务处理）不是专有名词，不应大写。
文件名
(1) 文档的文件名不得含有空格。
(2) 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。
错误：名词解释.md
正确：glossary.md
(3) 文件名建议只使用小写字母，不使用大写字母。
错误：TroubleShooting.md
正确：troubleshooting.md
(4) 文件名包含多个单词时，单词之间建议使用半角的连词线（-）分隔。
错误：advanced_usage.md
正确：advanced-usage.md
段落
(1) 一个段落只能有一个主题，或一个中心句子。
(2) 段落的中心句子放在段首，对全段内容进行概述。后面陈述的句子为中心句子服务。
(3) 一个段落的长度尽量不超过三句话。
(4) 段落的句子语气要使用陈述和肯定语气，避免使用感叹语气。
(5) 段落之间使用一个空行隔开。
(6) 段落开头不要留出空白字符。
引用
(1) 引用第三方内容时，应注明出处。
One man’s constant is another man’s variable. — Alan Perlis
(2) 如果是全篇转载，请在全文开头显著位置注明作者和出处，并链接至原文。
本文转载自 WikiQuote
(3) 使用外部图片时，必须在图片下方或文末标明来源。
本文部分图片来自 Wikipedia
数值
(1) 阿拉伯数字一律使用半角形式。
(2) 数值为千位以上，应添加千分号（半角逗号）。
XXX 公司的实收资本为 ￥1,258,000 人民币。
(3) 货币应为阿拉伯数字，并在数字前写出货币符号，或在数字后写出货币中文名称。
$1,000
1,000 美元
(4) 表示数值范围时，用一字线（—）连接。
132 kg - 234 kg
67% - 89%
(5) 数字的增加要使用增加了、增加到。了表示增量，到表示定量。
增加到过去的两倍（过去为一，现在为二）
增加了两倍（过去为一，现在为三）
标点符号
(1) 句子末尾用括号加注时，句号应在括号之外。
错误：关于文件的输出，请参照第 1.3 节（见第 26 页。）
正确：关于文件的输出，请参照第 1.3 节（见第 26 页）。
(2) 注意避免一逗到底，即整个段落除了结尾，全部停顿都使用逗号。
(3) 补充说明时，使用全角圆括号（），括号前后不加空格。
参考链接
- 阮一峰 - 中文技术文档的写作规范