很多人都是喜欢做实事，不喜欢写文档；讨厌别人不写文档，但自己也不喜欢写。但是为了让知识有传承，还是得硬着头皮去写。

    image.png

    一个好的文档应该包含四个部分：Tutorail、How-To、Explanation、Reference。即教程、指南、解释、参考。
    每一个部分都是不同的写作模式，有不同的侧重点。别人在阅读技术文档时，在不同的时间需要读不同的文档，所有的文档类型都要有，而且不要交叉。

    从上图可以看出，图中有四个象限，如果你没有时间读四个文档，你可以先两个两个读：

    • 当你在调研、学习时，应该读左边两个；
    • 当你想实际练习一下，或者做一个简单的演示系统时，读上面两个；
    • 当你继续工作，把系统做的更实用、更完美时，读右边两个；
    • 当你想进一步改进系统、调优、甚至进一步扩展时，就需要完全了解整个系统的原理，读下面两个。

    image.png
    通过使用上述规则，文档作者和读者都很明确什么内容应该放在哪里，以及应该到哪里去找。理解了这些规则，作者就知道如何写、写什么，以及写到哪里。这就是传说中的事半功倍。
    推荐大家都好好看看那篇文章，我们也在不断学习，争取我们的文档也能早日进化到理想的样子。