经过几天的学习,软工文档的编写就告一段落了,这个项目主要是让我们明白一个正常的项目的开发流程是什么样的。首先我们想一下问什么要编写文档,文档就好像是规矩、条令,在文档中会说明项目的整个生命周期内的所有问题,包括如何计划、如何开发和如何维护,我们需要按照文档中编写的内容和流程来进行开发,避免发生很多错误,也可以取得更高的效率。在每一个阶段都会有一个自己对应的文档说明,如下图所示:
每一个具体的文档都有自己的编写目的和预期读者:
文档名称 | 编写目的 | 预期读者 |
可行性研究报告 | 从技术、经济、法律等各个方面判断项目的可行性 | 开发人员、管理人员、维护人员 |
项目开发计划 | 制定整个项目的开发过程中的具体计划 |
本项目任务提出者、项目组全体成员、用户 |
软件需求说明书 | 阐述项目的需求、为开发维护提供基础 | 开发人员、用户 |
概要设计说明书 | 为被开发项目做一个总体的结构设计 | 开发人员 |
详细设计说明书 | 进一步细化系统结构、详细介绍系统各个模块 |
开发人员、用户 |
数据库设计说明书 | 说明数据库的设计为系统软件编程和维护提供基础 |
开发人员、测试人员、维护人员 |
数据要求说明书 |
详细的提供系统中各个数据的流向 | 开发人员、测试人员、维护人员 |
测试计划 | 制定测试的计划和方案,以及测试所需要的数据 | 开发人员、测试人员 |
测试分析报告 | 分析测试结果,为以后的开发工作提供经验 | 开发人员 |
项目开发总结报告 |
分析开发过程中的经验和教训,提供经验 |
所有参与项目相关人员。 |
操作手册 | 向用户介绍项目的具体功能和一些操作方法 | 用户、维护人员 |
用户手册 |
让用户了解此系统的功能,使用方法 | 用户 |
开发进度月报 | 总结当月进度,发现问题并解决,以免延误工期 | 开发人员、管理人员 |