如何写好文档

最近做项目的时候需要阅读很多文档，并且需要写一些文档，今天总结一些关于如何写好的文档的个人经验，和大家分享。

1. 文档要服务于受众
请努力做到，使读者读文档时候不会遇到任何困难，例如把该解释的定义解释清楚。如果可以的话，写之前请分析一下读者和要表达的内容。

2. 不要写那些你自己也没理解的东西
我们读一些文档的时候常常感到一头雾水，其实是因为这个文档的作者其实自己也并不是完全搞明白这个东西，文档上的描述其实只是东拼西凑的资料。

3. 使用好的规范，好的格式，你的文档就成功了一半
例如当我们对于一个技术进行描述的时候，我们必须让读者不需要前后翻页，就可以跟上我们的描述。保持格式的一致性很重要。其实不仅需要写规范，而且还需要使用正确的语法，消除错别字。当然了，写中文比较不容易出现这些问题。但是写英文文档就会常常出现这种问题，这就需要认真对待。

4. 使用短句，显示精华
这只是文档，所以不要卖弄文采。长的复杂的句子，并不是知识性文章的标志。

5. 使用常见的词
这样会让读者更容易进入“状态”。还要注意做到统一术语。

6. 只写需要的，并尽可能少写
这其实就是我德国同事常常说的：“so viel wie noetig，so wenig wie moeglich”。这样会让文档的读者尊敬你，因为你让他们节约了时间。