最近写文档心得

机房收费系统临近开学的时候,就按计划完成了。软工视频也看完了,尽管很多地方的知识,都谈不上理解,只能说是过了一遍。其实软工等于看了三遍。第一遍当然是看视频,每当看完一章之后,我都会用思维导图进行总结。这一遍下来,等于又看了一遍;最后,等视频看完之后,自己又对软工知识进行整理,然后整理在博客上。下来之后,等于又是一遍。

最近一直在写机房收费系统的文档。提起文档,真的很头疼啊——全身头疼。做机房收费系统的感受是,一开始感觉很难,但是一开了个小头,就行如流水一般做下来了;而写文档一开始的时候感觉很好写,不就是写字吗,可是想把文档写好,起码自己看过去,真的不简单啊。

一开始很纠结究竟要怎么写文档、要写多少文档。自己看视频的时候,就将一些需要写成的文档都总结到一个单独的导图里了。等看完视频开始写文档的时候,真的好多啊……后来,不得不上网看看。在网上看到了贾林的思路。依他的导图,他应该是写了视频中所提到的所有文档。后来又看到了得鹏的博客,他应该就是写了视频中所包含的文档……

我知道文档对于我们程序员来说,非常的重要。

记得上次九期开见面会的时候,陈伟东师哥在视频里说过。他最近一直在忙的系统,文档不是很全,所以实施起来非常不方便,程序的很多地方阅读起来非常的费劲;记得师哥写过一篇博客,不是郗晓勇师哥就是纪争光师哥写的,我找了,不过没有找到,感兴趣的可以自己搜一下。他文章里提到的就是写文档的重要性,没有文档是多么的寸步难行。

其实,我最纠结的就是这里了。文档很重要,但是写不好。

看了自己之前写过的可行性分析文档、需求规格说明书文档,总感觉写的很没有逻辑,有拼凑的意思。总之很牵强。

依我的思路,跟贾林有相仿的地方。就是尽量向多里写。只要视频中提到的文档,不管怎样,都给他来一遍。

可是实施起来,真的不容易。提起了需求规格说明书,可是又着实头疼了。包括概要设计说明书和详细设计说明书,网上的文档格式跟米老师给的模版大相径庭……无语了,没办法,折中着取吧……

这几天最纠结的就是数据流图、数据字典了。这一块儿的东西,总感觉写的不伦不类的,感觉特别扭。有的东西自己写了看着都不舒服。

其实也没啥,就是感觉写文档写郁闷了,出来发泄一下。估计也到点了,该去写文档了。。。。。

posted on 2011-09-19 20:06  刘正权的博客  阅读(366)  评论(0编辑  收藏  举报