教务系统总结四(思想)

来源:互联网 发布:奥运会没人申办知乎 编辑:程序博客网 时间:2024/03/28 19:56

          完成了系统的合作开发,接下来就是软考复习了。由于任务较多,所以没有时间来更改和完善这个系统了。为了记录下系统的每一个细节,也为了以后更改这个系统更容易上手,所以我们需要做一项工作:完善文档。

         如果没有记错,文档一共写过四次了:第一次是做第一遍机房收费系统前让写文档,那个时候还不明白文档时什么东西,看到那些写得特别的规矩的东西感觉都不知道是干什么用的。。第二次写文档是用三层架构来设计机房收费系统,这一次是先做图,然后写文档,这次大概知道有什么内容可以写,但是写得不规范。第三次是合作开发的时候写文档,这个时候明白了文档具体的内容和格式要求,然后大部分的文档当时就用EA生成了,这样一份正规的文档就脱颖而出了。但是一直没有明白一个问题:写这些文档到底起什么作用呢。直到这次其实才有点明白。老师让补全文档,由于我们之前做工程过程中所有的资料都是用到什么就直接写一份什么,所以系统的应该有什么文档也不太清楚,所以就按照以前写文档的形式,写了个概要设计和需求分析,然后有个数据库的文档,然后其他的详细设计就通过EA用代码直接生成了。就这样完成了所有文档,然后交工。当时是雪歧师姐检查的我们的文档,当时看完我们的文档,就说了一句,要什么没什么。然后告诉我们:既然做就要认认真真的去做,不要用工具随便生成来应付。同时告诉我们这次文档主要是为了让我们记录下我们工程里面的一些细节的东西以防以后修改的时候忘记了,然后让我们具体记录下自己工程的断点,以便以后容易上手。就这样,我们把文档一点一点写全了。(需求,概要,详细,数据库文档,组间接口文档,断点文档)。这就是我们的第四次文档,当写完这些文档后才明白其实文档不是什么形式化的东西,文档就是为了一个目标:让一个没有参加这个工程开发的人能够通过文档看懂这个工程,让开发过这个工程的人随时能够很容易的想起这个工程的每一部分的设计。这就达到了写文档的目的。

       通过写文档也明白了一个道理:对任何一项工作我们都应该本着负责的态度去做。否则我们做的都将是无用功。

 

      

原创粉丝点击