软件工程文档说明

经历1个多月的时间，软件工程视频和相关文档学习已近尾声，每个人都有不同程度的收获吧，来看看我的感受如何：

         通过对软工视频的学习，已了解软工视频大致是在为写文档做预习，一个软件工程必不可少的一部分就是文档的编辑，文档亦难亦不难。不难在我们都能理解每一份文档，并且知道每份文档主要内容有什么，而难亦在怎么将文档的主要内容写出来，用什么表示主要内容，可以让读者更清晰的了解你需要表达什么内容。

         通过一次文档的验收，暴露了我们很多问题，即使写的再详细，由于我们缺少经验，总是或多或少的存在某些问题。

         比如，对于可行性研究报告主要给要看这份文档的人指出项目开发的实际效益，主要从技术与经济方面，而我的文档中掺杂着一些详细到具体功能的描述，这个是需求或者详细设计文档中的内容，从而使可行性研究报告过于赘余，其他文档也都存在这样的一些问题。

         下面我来好好的总结下每份文档中都主要该有什么内容吧。

1.对于可行性研究报告

简单说来就是个老板看的，要让老板看到有利益，才会同意开发这个项目，说白了就是别人投资需要让人看到未来。所以，要对与能创造利益有关的一切因素谈起。这需要从经济、技术、生产、供销直到社会各种环境、法律等各种因素进行具体调查、研究、分析，确定有利和不利的因素、项目是否可行，估计成功率大小、经济效益和社会效果程度，从而为决策者和主管机关同意开发项目提供依据。

2.项目开发计划

是创建一个项目开发过程的总体计划，为项目负责人提供一个框架，使之能合理地估算软件项目开发所需的资源、经费和开发进度，并为项目配置提供信息辅助，也控制软件项目开发过程按此计划进行。在项目开发计划书中，最主要的是必须要有相关表示项目计划的图例（主要有甘特图、工程网络图、时标网络图），以便项目负责人能把控项目进度，了解什么时间段做好什么工作。

3.软件需求说明书

通俗一点，就是指出软件有什么优点（或功能），此优点（或功能）是用户与开发人员都认可的。官方定义是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。包含硬件、功能、性能、输入输出、接口界面、警示信息、保密安全、数据与数据库、文档和法规的要求。实际上，对于需求，达到用户需求的才可以，因而要从输入/输出和它们的关系入手，也方便软件开发人员了解需要什么功能的编程。对于功能，没有什么比让用户看到一个系统功能的模型图更有效的了，于是就用到了用例图或者原型图。

用例图是静态的系统模型，如 

原型图（原型设计）就如一个完整的系统，应有的功能都可以操作，就像一个实际系统的虚拟（动态）模型

输入/输出即可用IPO图表示：

而他们之间的具体关系，可以用ER图表示：

 

4.概要设计说明书

简单点就是指模块之间及模块内大功能的说明，详细的要说明对程序 系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。本文档中需要有类图、界面、原型图（也与功能的实现有关）。

5.详细设计说明书

是概要设计说明书的细致化，将各个功能都详细的设计出来，方便编程人员更好地编程出符合需求的程序。本文档描述的是关于项目最基层的工作内容，只根据概要设计说明书设计，只说明程序设计，而其他可以不编写。本文档需要包括构架图、类图、时序图、及定义代码规范等内容。

6.数据库设计说明书

指所见项目需要创建什么样的数据库，数据库表结构的设计、字段详细说明、视图说明，及其相对应的SQL语句说明。通俗一点，就是数据库的设计规范。

7.测试计划

就是对编程好的软件进行测试。测试计划需要包括测试用例（从输入/输出举例说明），测试方法有黑/白盒测试法等，禁忌最好不要测试人员和开发人员同一人。

测试计划编写的六要素：

1）why——为什么要进行这些测试；

2) what—测试哪些方面，不同阶段的工作内容；

3) when——测试不同阶段的起止时间；

4) where——相应文档，缺陷的存放位置，测试环境等；

5) who——项目有关人员组成，安排哪些测试人员进行测试；

6) how——如何去做，使用哪些测试工具以及测试方法进行测试。

8.测试分析报告

就是将测试结果记录下来，并通过专业人士的分析（即评估），然后整合起来交给。

9.质量保证计划书

指在整个工程执行过程中，如何保证工程的质量满足合同和标书规定的有关质量保证方面的文件，包括设计、生产、施工、培训等过程中的质量保证，每项内容的质量保证措施，如何设立质量控制点，如何进行质量控制的操作等。

质量保证计划应包含编制依据、适用范围和时限、管理职责、合同评审、文件和资料控制、采购控制、施工过程控制、检验和试验、工程项目的不合格品控制和预防纠正措施、物资搬运和储存管理、标识与可追溯性、用工制度与培训、质量记录和记录表格以及质量计划的修订等内容。说得简单些，质量保证计划就是监督和控制影响软件开发质量有关的因素。

10.操作手册

了解操作手册需要了解操作的含义。操作指人活动的一种行为，是一种技能。操作也是按照一定的规范和要领操纵动作，故而操作手册就是指对软件可以按照一定规范和要领进行操作。所以，这一文档需要编写的就是对软件操作的规范。

11.用户使用手册

同上，需要了解使用的含义。使用即利用某种工具而实现某个目的。故而用户使用手册就是利用软件得到结果。这部分主要是描述怎么利用该软件达到目的，即了解软件的功能。

用户使用手册与操作手册的区别之一就是用户使用手册有“帮助”的内容。

12.项目开发进度月报

主要记录实际每月工作进度，用表格形式记录下来，以便相关人员可以调控项目开发进度，从而实现资源的合理利用。