首页 > 代码库 > 写文档的一些感触

写文档的一些感触

软工写文档也有一个多星期了,还没有写完,感觉太慢了~

对于软工文档,最大的感觉就是不知道该怎么写。问过一个师哥,师哥说这次写主要是为了让我们先了解一下写文档,现在让我们真正写那肯定是写不好的。后面还会有项目来练习的。

        真正优秀的程序员应该不单是编程高手,同时也应该是写文档的高手。大多数程序员是不喜欢写文档的。文档种类多,要求多。需求的改变和代码的改变都会让文档如同一张过时的废纸一样。很多程序员不写文档照样能编出程序来,文档的好处更多的体现在公司、用户和后续程序员身上。这样即使程序员走了,只要有文档,公司再招新人,照应运转。

         而且,写文档是一个很繁琐的过程,哪里有编程有意思。想写好文档更是不容易的。自己写了好几个文档,还是感觉表达的不够清楚。再往细里写吧,感觉头都要大了~其实看别人文档也是,抱怨别人文档写的不够清楚。体会最深的就是在敲机房的时候,报表不知道该怎么做。然后就去搜别人的博客。看了好多个前人写的文档。看完的感受就是还是不知道该怎么做报表。最后好不容易找到昌哥写的一个做报表的博客,才做出来的。他们能写出来博客,应该说明他们会了吧,但是不知道是我愚钝还是他们表达的不清楚~所以,当时就下决心如果写就写清楚了。让大家都能看懂!

有人说博客是写给自己看的,也有人说博客是写给别人看的。各有各的观点吧,但是还是希望能写清楚就尽量写清楚了。

接着说写文档吧,不得不承认文档时很重要的一个东西。它有助于管理人员监督和管理软件开发,有助于维护人员进行修改和扩充,而且,自己以后可能也需要返回看文档的。

不管怎么说,作为一个程序员,尤其想成为优秀程序员,一定要学会写文档。不只是为了方便别人,还为了方便自己。


写文档的一些感触