软件工程之软工文档总结

开篇前言

在学习软件工程的视频的时候，老师介绍到软件开发是根据文档驱动的，但是在整个系统开发过程中文档驱动是如何进行工作的。各个文档在系统开发起到了怎样的作用。

系统开发的过程

在结构化系统开发方法系统的整个开发过程分为总体规划、系统分析、系统设计、系统实施、运行维护和系统评价6个主要阶段。在不同的阶段中需要对不同的文档进行编写。下面根据上文提出的系统的生命周期对各个文档的作用进行介绍。

各个文档的内容

1.可行性研究报告：说明该软件项目的实现在技术上、经济上和管理上的可行性，是开发人员对现有系统的初步的调查，反应了开发人员对系统开发的看法。这个阶段完成与系统的总体规划。

2.项目开发计划：为软件项目实施计划制定出具体计划，应该包括各部分的负责人员、开发进度以及软件资源等。主要给管理部门作为开发阶段评审的参考。系统的总体规划开始编写完成与系统的分析

3.软件需求说明书：对软件开发的功能用户界面以及运行环境进行详细的说明。软件的分析完成

4.数据要求说明书：该文档给出数据逻辑描述和数据采集的各项要求。软件的分析完成

5.概要设计说明书：对系统的功能的分配、程序总体的结构、输入输出以及接口设计等，主要是为了程序开发者使用。系统的实施过程完成

6.详细设计说明书：重复的对软件每一个功能是如何实现的，逻辑流程以及功能的介绍进行详细的介绍。系统的实施过程完成

7.用户手册：描述软件的功能性能，使用方式，让用户更快的了解系统。系统的分析过程开始编写，系统的实施过程完成过程结束之前完成。

8.操作手册：本文档主要在与告诉用户系统提供了那些功能，对用户提供一个正确的引导。主要服务对象为使用者。

9.测试计划：描述了测试活动的范围，确定了测试项，测试任务，列出每一项测试的风险。系统分析开始编写在系统设计完成之前完成

10.测试分析报告：对软件系统中的测试人员进行分析说明，以及对系统的各个功能进行说明。主要服务对象为系统开发人员。        在系统的评价过程中进行编写。

11.开发进度月报：本文档是为了软件人员向管理部门提供的项目进度情况报告，主要包含进度计划于实际执行情况的比较、阶段成果。    贯穿整个系统开发。

12.项目开发总结报告：软件项目开发完成之后应于项目实施计划进行比较，在进度、成果、资源利用等方面对整个系统进行评价。   在系统开发中的系统评价。

13.软件维护修改定义：为以后系统的维护提供方便。 在软件工程中的运行维护完成。

对文档第一验收评价：

文档第一次验收过程中师傅给出的建议是图画的非常的少，需要在各个文档开发中加上UML中的图，因为一个图胜过万语千言，比如在系统开发月报中加上甘特图，这样自己的整个文档变得非常的清晰。毕竟是第一次学习文档，自己感受并不是特别的深刻。希望自己在学习UML之后对文档中的图有全新的认识。