【软工文档】-总结

前言

软件工程的视频和文档已经完成了，接下来就是激动人心的总结环节。软工视频之前也是已经总结就不再说，这次来说一说我对软工文档的理解和看法。

收获

首先，软工文档，也就是计划，设计，描述，使用软件的一些文件，最大的特点就是固定不变，给不同的人来阅读，在软件开发过程中，文档起到了桥梁的作用。

另外，从别处文档总结处看到了文档分类，画了一个类似分类，帮助大家学习13个国家统一规定的相关知识。

各个文档的内容：

1.可行性研究报告：说明软件开发项目在经济、技术、法律因素上的可行性，列出为了达到开发目的可供选择的几种实施方案，并说明选定实施方案的理由。

2.项目开发计划：为软件开发项目的实施方案制定具体的计划，包括各部分的负责人、开发进度、经费预算、技术所需硬件及软件资源等。

3.软件需求说明书：对开发软件功能、需求、用户界面及运行环境等作出详细说明。是用户和开发人员对软件需求理解的基础上达成的协议，是开发工作的基础。

4.数据库设计说明书：本软件数据存储对数据库的要求，包括数据库的外部设计、结构设计及数据字典和安全保密性设计等。

5.数据要求说明书：本说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护数据做准备。

6.概要设计说明书：本说明书应说明功能分配、模块划分、程序结构、各种接口的设计、运行和出错处理的设计，为接下来的详细设计打出框架。

7.详细设计说明书：对概要设计说明书中各种设计进行详细的实现规划、包括算法及逻辑流程等。

8.用户手册：详细描述软件的功能、性质与用户界面，说明书要使用户了解如何使用该软件，能够任意操作该软件。

9.操作手册：为操作软件提供软件运行的相关知识，包括具体的操作方法。

10.测试计划：为软件进行测试，为做好测试，需要为组织和实施测试制定计划。计划应包括测试内容、进度、要求、测试用例的选取规则、测试结果允许的误差范围等。

11.测试分析报告：测试计划设计完成后，就要进行测试，测试完成后，要提交测试计划中各项计划的实施进度及测试结果，并对结果加以分析，提出测试的结论和意见。

12.开发进度月表：按月向管理部门提交的项目进度及进展报告。包括进度计划和实际执行请扩的比较、成果、遇到的问题和解决办法以及下个月的计划等。

13.项目开发总结报告：软件项目开发完成之后，要与项目的实施计划对比，总结进度、成果、成本和投入的执行情况，对开发工作作出评价，并总结经验及教训。

最后看看这些文档的宏观作用，要完成的任务，用一张图展示一下：

借鉴后修改

下面解释一下上边几个简单的字符：

1.“什么”，即做什么，是否有需求需要满足；

2.“何处”，即从何处，所开发软件在环境中实现所需信息从哪里来；

3.“何时”，即从什么时候干，开发工作时间安排；

4.“谁”，即开发工作是谁来干；

5.“如何”，即某些需求是怎么实现的；

6.“为何”，即为什么要进行软件开发或维护工作。

后记

以上是我对软工文档的一个总结，有一部分是借鉴其他人的形式。文档在写之前，有必要清除个文档的作用及目标，软件开发过程之间的关系。简单理解，不足之处，还望不吝赐教。

师傅验项目的时候还讲到了各种图，对这些图的理解还不够透彻，待熟悉之后再来分享。