Markdown文档编写规则：文本

本文转载自阮一峰的 Github。

字间距

在中文字符和英文字符之间，应该添加一个英文空格符。即一句话中既有中文又有英文，那么在英文的前、后都应该插入一个英文空格符。

错误：我对嵌入式Linux开发很感兴趣。

正确：我对嵌入式 Linux 开发很感兴趣。

中文字符和阿拉伯数字之间，加不加英文空格符都可以，但需要保证风格的一致性。如果要加空格符，那所有的阿拉伯数字都加，别一会加一会不加的。

风格1: 2019年4月18日，老王的儿子小王出生了。

风格2: 2019 年 4 月 18 日，老王的儿子小王出生了。

英文的百分号，同阿拉伯数字的处理方法相同。

英文的单位，如果不翻译，那么单位前面的阿拉伯数字和单位之间不要留空格。

错误：公司为每位员工配置了一块 512 GB 的固态硬盘。

正确：公司为每位员工配置了一块 512GB 的固态硬盘。

如果英文字符、阿拉伯数字紧邻着一个中文的标点符号，那么字符与标点符号之间不用插入空格。

错误：老王很喜欢 Kobe Bryant 。

正确：老王很喜欢 Kobe Bryant。

句子

避免使用长句。一个句子建议不要超过 100 字或者正文的 3 行。

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

写作风格

尽量使用主动语态，少使用被动语态。

TODO::
错误：假如此软件尚未被安装，

正确：假如尚未安装这个软件，

对于正式文档，不要使用非正式的语言风格。

TODO::
错误：Lady Gaga 的演唱会真是酷毙了，从没看过这么给力的表演！！！

正确：无法参加本次活动，我深感遗憾。

正确使用“的”、“地”、“得”。

“的”用于形容词和名词之间。

“地”用于副词和动词之间。

“得”用于动词和副词之间。

她露出了开心的笑容。

她开心地笑了。

她笑得很开心。

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

错误：从管理系统可以监视中继系统和受其直接控制的分配系统。

正确：从管理系统可以监视两个系统：中继系统和受中继系统直接控制的分配系统。

不要使用过多的形容词来修饰同一个名词。

错误：此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。

正确：此设备必须在技师的指导下使用，且指导技师必须接受过由本公司举办的正式设备培训。

单个句子的长度尽量保持在 20 个字以内；20～29 个字的句子，可以接受；30～39 个字的句子，语义必须明确，才能接受；多于 40 个字的句子，在任何情况下都不能接受。

错误：本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。

正确：本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。

同样的一个一次，能使用肯定句，就不用要使用否定句。

错误：请确认没有接通装置的电源。

正确：请确认装置的电源已关闭。

避免使用双重否定句。

错误：没有删除权限的用户，不能删除此文件。

正确：用户必须拥有删除权限，才能删除此文件。

英文处理

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

英文：⋯information stored in random access memory (RAMs)⋯

中文：……存储在随机存取存储器（RAM）里的信息……

外文缩写可以使用英文句号(.)表示缩写。

U.S.A.

Apple, Inc.

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

英文：5 minutes later⋯

中文：5 分钟过去了⋯⋯

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

英文：He published an article entitled "The Future of the Aviation".

中文：他发表了一篇名为《航空业的未来》的文章。

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

IOC（International Olympic Committee，国际奥林匹克委员会）。这样定义后，便可以直接使用“IOC”了。

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

“American Association of Physicists in Medicine”（美国医学物理学家协会）是专有名词，需要大写。

“online transaction processing”（在线事务处理）不是专有名词，不应大写。

参考链接：阮一峰的Github