本文主要是介绍软工文档编写总结,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
从看视频之前,就知道最后需要完成的是编写文档。可是最后视频看完后,对文档的编写一点头绪都没有。
在师父的英明指导下,这项工作终于不再是止步不前了。师父说,文档最重要的就是:每份文档应该在什么阶段编写、由谁编写、写给谁看以及每份文档其中包含什么内容。
有了这个思路,文档编写轻松了许多。所以,自己就将软件开发的生命周期与文档编写再次联系起来,各个不同阶段,就会相应地产生一份不同的文档。
所以,在之前总结的基础上,将需要产生的相应的文档添加上去。下面便是每个生命周期与各个文档的对应:
下面具体看各个文档:
阶段一:软件开发的分析阶段
本阶段包含三个文档,最初的可行性研究报告,就是对这项软件开发工作的是否可行进行分析。一开始,需要对项目的各方面都有所了解,加之对现有系统情况的把握,确定如何做到一个全新系统的方案。另外,加上对经济以及社会因素的考虑,最后得出该方案是否可行的结论。
对项目做完可行性研究后,可行的话,就需要开始总体规划,这时期就需要一个项目开发计划文档。其中内容包括对项目的概述、实施计划、支持条件等。
每款软件的开发最后都是需要面向用户的,所以对用户的需求必须做到清楚了解和认识。相应地,产生软件需求说明书,主要是综合用户各方面条件,对软件的目标、运行环境都加以说明。
阶段二:软件开发的设计阶段
本阶段共包含7个文档,从总体设计到最后的开发总结,每一个文档都是关键的一步。只有走好每一步,最后才有可能会更好。文档的内容要点就不再加以说明了。
阶段三:软件开发的维护阶段
本阶段虽然只需要编写一个文档,但工作任务还是繁重的。程序维护手册,主要包括对系统的用途、安全等方面的一个说明和对设备、软件及数据库方面操作环境的阐述,都是以便对程序更好地维护;其中每个维护过程也需要在文档中记录下来,包括约定、验证、出错及纠正方法。
除了软件开发整个生命周期的三个阶段,其实还需要编写一些其他管理性质的文档,如用户手册等。这可以算是后期的工作。除此之外,一个软件开发项目可能历时很久,所以就需要有个进度报告,从而有个看得见的文档,对系统的每一步都做好规划,因而保证开发工作能够如期完成。
阶段四:软件开发其他文档编写
从头至尾,共12篇文档,它们的完成,才算是一个软件开发项目真正完工。
对于这个阶段的学习,自己最大的感受就是:思路决定出路。自己的思路有了,才可能会看到一条光明的出路。之所以最初不知道如何开始,就是没有找到一条思路去做。在师父指导后,思路清晰了,后面的路也就顺畅了很多。
这篇关于软工文档编写总结的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!