（八）写文档的一些感想

代码的工作完成以后感觉博客要写什么实在不好把握，最近都在写文档，那么我就说说写文档的一些感受吧。

在学校也要写文档，不过一般都是以报告的形式，这次的文档主要是介绍如何将OData插件整合到SugarCRM中，所以偏向于指导性的文档。自己在完成这次项目的过程中也是阅读了许多文档，所以在读别人文档时自己感受到的一些不好的地方就需要借鉴和改进。比如有的时候看到别人的文档写修改某个设置的时候没有提到不同环境下怎么修改，于是自己在写的时候就会注意，尽量将不同环境下的设置都讲清楚。又比如一些专业单词的使用要注意普遍化和专业化，既不能太过通俗，又不能说的别人根本不懂是什么意思。

另外，我觉得写这次的文档就是要告诉别人怎么做，所以要将一些关键点讲清楚，讲明白，重复工作量的地方该略过的就略过，言简意赅要格外注意。

其实代码写的好是一方面，另一方面就是文档写的清晰明了，读起来顺畅通顺。这是第一次写这类的文档，我想以后会写的更好一些。