如何更好的写文档
本文档的目的是为了表述项目事项，方便他人阅读。从文本格式、句子、风格、中英文、段落等挑出八条约定。
（1）全角中文字符与半角英文字符之间，应有一个半角空格。
错误：本文介绍如何快速启动Windows系统。
正确：本文介绍如何快速启动 Windows 系统。
（2）避免使用长句，符号分隔的20字内，单一句话尽量不要超过100字。
错误：本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
正确：本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。
（3）尽量使用简单句和并列句，避免使用复合句。
并列句：他昨天生病了，没有参加会议。
复合句：那个昨天生病的人没有参加会议。
（4）同样一个意思，尽量使用肯定句表达，不使用否定句表达。
错误：请确认没有接通装置的电源。
正确：请确认装置的电源已关闭。
（5）避免使用双重否定句。
错误：没有删除权限的用户，不能删除此文件。
正确：用户必须拥有删除权限，才能删除此文件。
（6）使用代词时（比如“其”、“该”、“此”、“这”等词），必须明确指代的内容，保证只有一个含义。
错误：从管理系统可以监视中继系统和受其直接控制的分配系统。
正确：从管理系统可以监视两个系统：中继系统和受中继系统直接控制的分配系统。
（7）表示中文时，英文省略号（⋯）应改为中文省略号（……）。
英文：5 minutes later⋯
中文：5 分钟过去了……
（8）一个段落的长度不能超过七行，最佳段落长度小于等于四行。
参考：
中文技术文档的写作规范：https://github.com/ruanyf/document-style-guide