文档带来的思考和对文档的修改

时间:2021-09-19 15:05:25

前几天云姐验收了文档,写了验收收费系统的验收报告,和一些心得体会。

首先,没有重视文档,感觉文档对于代码和图来说在心里没有那么重要。

其实嘴里一直在说文档的重要性,重要性,比什么都重要,但是一直进不了心里去,为什么??

归根到底,这个东西做起来没有什么成就感,不像代码做起来,写出代码来了,功能实现了,感觉到甜头了,所以我们愿意做这个东西。

听过吃瓜子理论,人们为什么都爱吃瓜子(不爱吃的除外)。第一:吃瓜子这个动作很简单,第二:每嗑瓜子一下就能得到一点回报。所以一点一点孜孜不倦的吃,重复的也是一个动作,因为有了回报,所以人们不会烦。

想到现在的写文档,写代码,画图,这些东西。哪些和吃瓜子是一样的,自己感觉写代码跟这个理论很像,每写出一段代码,就像吃到了瓜子一样那么香,所以我们都热衷于写代码,而忽略了文档。

怎么办?烦了,很枯燥,很无味。忍着吧。记得刚进提高班的时候曹贵生师哥就说过一句话,前途是光明的,道路是曲折的(可能也是枯燥的),要想成功,忍着吧。

身在这个环境,大家都一样,米老师带了十多年提高班了,到现在还没有什么回报,肯定也烦透了,这就是一流人与不入流人的区别。

你做一些事情,投入了很多,看似没有回报,那是还没到时候,就像写文档,就像办提高班……想成为伟人吗?先写好文档吧,忍着吧,待着吧,每个人成为高手之前都是寂寞的。

 

附:自己验收中的各种问题

大体上的错误:

1.各种命名都不规范,包括变量命名,类命名。

把各层的类,变量,接口等等能改的都进行了重新命名。(参照提高班命名规范)

2.注释不完全,不规范。

补全了注释,对一些类进行了类注释,方法都进行了标准注释。个别重要的命名判断都添加了相应的注释。

3.文档写了,但是写的很少,文档不健全。

进行了相应的文档补充,画了数据流图,对文档进行了补充,把文档欠缺的部分进行了补充,其中包括需求分析,概要设计,详细设计。其中详细设计中增加了原来画的UML图,配合文字进行了详细设计的完善。最后又添加了开发计划和用户手册的编写。

4.UML

图的问题不大,主要要求研究了一下变量生命周期和UML图中一个过程的对应关系。在网上进行了一些查询,资料挺少,到现在也不是很明白一个变量的生命周期在UML中是怎么对应的。

5.功能实现:大查询处时间查询有问题

之前做的根据时间查询是字符串转换成时间类型在比较,经常出错,之后根据时间查询改用datetimepicker代替文本框输入,实现了根据时间查询的功能。

 

针对文档细节问题:

1.       能测试的尽量测试出来,例:程序所占硬盘,内存大小。

2.       数据流图的问题,角色不完整,数据流不完整。

3.       整体目录问题,目录级别错误。

4.       文档不全,没有用户手册和项目开发计划。

5.       按照模板写的时候有一些不懂是什么意思,比如数据流量,要求最低配置等,就胡写了一通,知之为知之不知为不知,不会就干脆不写。

6.       用户手册中不用术语,用了术语也应该在后面添加相应的解释,用户不是你,不可能什么都懂。

7.       对待文档要负责,问题永远不可能解决完,做什么事肯定也完美不了,但是最起码要有负责的态度,你对它负责了,它才会对你负责。

 

针对上面的一些问题,我在文档中都做了相应的修改。