《软工文档》总结

             首次接触文档，一开始写时，感觉不知道如何下手，就看原文档，按着原文档写，写了几个后，就感觉有点思路了，发现写文档的思路大同小异。百度到写软件开发文档的作用为：软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。以下是我对文档的理解与总结。

首先：弄清楚该文档产生于软件开发的哪个阶段

其次：要弄清楚写该文档的目的，即我为什么要写该文档

然后：要弄清楚该文档的阅读者是谁

最后：根据阅读者的需求写文档，细化写文档的过程，具体到各方面

下面就以机房收费系统为例，说明各个文档的大体流程

       机房收费系统总共写了13个文档（其实数据库设计、数据要求说明书可看做一个，即总共12个文档），分别为：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、数据库设计说明书、数据要求说明书、测试计划、测试分析报告、项目开发总结报告、操作手册、用户手册、开发进度月报

总结：

系统声明周期分为：软件计划阶段、软件需求分析阶段、软件设计阶段、软件实现阶段、软件测试阶段、运行与维护阶段，各阶段都会产生相应的文档。

各阶段产生的报告：

下面是我查到的在软件生存周期各阶段生成的文档的图标（感觉很直观）：

一：可行性研究报告

产生于软件计划阶段

研究廊坊师范学院是否具有研究机房收费系统的必要性和可能性

软件开发人员、软件维护人员、系统管理人员

二：项目开发计划

产生于软件计划、需求分析阶段

在项目开发阶段前首先对开发有个计划，对项目的整个开发过程的一些条件等有一些基本了解

系统分析人员、软件开发人员

三：软件需求说明书

产生于软件需求分析阶段

对所开发项目做全面细致的用户需求分析，明确所要开发软件的功能、性能与界面，是系统分析人员及软件开发人员清楚了解用户的需求，在此基础上完成概要设计说明书、详细设计说明书等

系统分析人员、软件开发人员

四：概要设计说明书

产生于软件设计阶段

简单的介绍系统的大概的物理模型，完成系统概要流程图

软件开发人员

五：详细设计说明书

产生于软件设计阶段

在概要设计的基础上进一步明确系统结构，表示出软件结构的图表，完成算法色痕迹、数据结构设计、物理结构设计等，详细地描述每个模块，包括算法和逻辑流程，为下一不系统的实现和测试做准备

软件设计人员，程序测试人员

六：数据库设计说明书

产生于软件设计阶段

完成系统的大致设计并明确系统的数据结构与软件结构，进一步细化软件设计阶段所得到的软件总体概貌，把它加工成在细节上非常接近于源程序的软件表述，即软件需求转化成软件标识

数据库管理员、数据库设计者

七：数据要求说明书

产生于软件设计阶段

明确待软件的各个功能或非功能性需求实现时所需的数据。根据此数据设计数据库

程序测试人员、数据库设计者

八：测试计划

产生于软件分析、设计阶段

明确各测试项，包括测试范围，方法、资源等，并确定谁来完成每项任务及制定应急方案。

程序测试人员、程序编码人员

九：测试分析报告

产生于软件测试阶段

对测试的结果、数据进行记录、分析，有利于软件开发者阅读源程序，根据测试的数据和结构，进一步分析源代码，掌握各函数的功能和局限性，从而缩短软件开发的时间和所耗费的精力、资金。

软件开发人员

十：项目开发总结报告

产生于软件测试阶段

对于整个系统的开发过程做一个总结和补充说明，整理好系统的基本流程，理清实际系统和预期系统之间的差距，对于系统的优化有很好的指导作用

软件维护人员、软件开发人员

十一：操作手册

产生于软件分析、设计、实现阶段

告诉软件使用者有哪些功能，使用户更好的操作软件

软件使用者

十二：用户手册

产生于软件设计、实现阶段

给用户提供一个指南手册，给软件首次使用者说明使用方法，并且给已经使用过或正在使用的用户提供他们在使用过程中遇到的问题的解决方法。

软件使用者

十三：开发进度月报

生存于软件生存周期的各个阶段

对本月进行的主要活动、遇到的问题进行说明，说明软件的名称及开始、结束时间，实际进行程度与预期进行程度做对比，一遍以后项目开发更好的进行.