软工文档总结

         软工文档在经历各种不愿意写之后终于完工了，软工文档在我们软件开发的过程中有很大的作用，从软件的设计，需求分析、到程序的编码、软件测试，再到运行和维护，在每个阶段都要产生相应的文档来指导我们的开发过程中的工作。有了这些文档，可以让我们的开发过程更加有顺序，有目标，有规律。这些文档也是方便软件后期的运行和维护工作的进行。每个文档都有不同的目的，下边介绍在开发的过程中，相应的阶段都产生了那些文档和这些文档都有什么作用。

每个阶段的文档：

 

每个文档的编写目的和读者：

1、可行性研究分析报告：

      在从技术、经济、管理和开发环境等几个方面，分析了一个软件是否可以开发，需求方和开发商共同讨论项目中的项目开发方案。

    预期读者：软件开发商、项目经理、需求分析员、客户等。

2、项目开发计划：

      对将要开发的系统的开发过程，所需要的费用，开发的进度，人员分工和配置，开发环境和运行环境进行说明，为下一步的开发工作做进一步的准备。

      预期的读者：开发人员，用户，分析员，项目经理。

3、软件需求说明书：

      软件需求说明书是需求分析阶段的一个文档，是对软件目标及范围的求精和细化，深入描述软件的功能和性能以及软件的约束范围，使用户和软件开发者对该软件的初始规定有一个大概的了解，有利于对项目的回溯和指导后者的开发和维护。

    文档读者：开发人员、用户、项目经理。

4、概要设计说明书：

      本阶段的主要任务是在用户的需求分析阶段的基础上，对机房收费系统做概要设计，为在需求分析阶段得到的目标系统的物理模型确定一个合理的软件系统的体系结构。包括合理的划分组成系统的模块、模块间的调用关系及模块间的接口，并且为软件系统提供所用的数据结构或者数据库结构。同时为下一阶段的详细设计做参考。

    本文档的主要读者为：项目设计人员、项目编写人员、项目经理。

5、详细设计说明书：

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

    本文档的预期读者是：程序开发人员、程序测试人员、项目经理

 

6、数据库设计说明书：

      本文档描述了系统的系统数据库的设计，提供了数据库设计的可视性以及软件支持所需的信息，应用于机房收费系统开发前期，为后期的数据库设计指引方向，也可以为系统程序设计提供借鉴与参照。

    预期读者为：数据库设计师，数据库管理员、项目经理。

 

7、数据要求说明书：

      编写数据库要求说明书的目的是明确后方系统中各项功能和非功能性需求实现是所需要的数据，根据此数据设计数据库。同时为概要设计和详细设计人员提供设计依据，其他本项目组的开发人员也可以参阅。

    本文档的读者对象为：数据库设计人员、系统测试人员。

 

8、测试计划：

      测试计划是描述将要进行测试活动的范围、方法、资源和时间进度的文档。他确定了测试项，要测试的特征、测试任务，谁来完成每项任务以及需要制定应急方案的所有风险等。

     预期读者：系统编程人员和项目测试人员、项目经理

9、测试分析报告：

      测试分析报告是在测试的基础上，对测试的结果以及测试的数据加以记录和分析总结，他是测试过程中的一个重要环节。对今后软件的功能的加强起着关键作用。另外，他还有利于今后软件开发者阅读源程序，根据测试提供的数据和结果，分析源代码，掌握各函数的功能和局限性，从而缩短软件开发者的在开发者的在开发时间和所耗费的精力、资金。

     预期读者：项目经理、开发人员。

 

10、操作手册；

      本手册的目的在于告诉此系统的使用者，本系统提供了那些功能，以及如何正确地、有效的来使用这些功能。

     预期的读者是：机房收费系统的用户。

 

11、用户手册：

      编写此文档的主要目的是为了给使用者一个使用指南，以便为首次使用该系统的用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决的方法。

     预期读者：软件使用者。

 

12、开发进度月报：

       记录每个月的开发进度和本月所进行的开发工作有哪些，并及时的发现工作的存在的问题，为以后的开发提供经验和指导，提高接下来的开发工作，为最后的项目总结提供参考。

      预期读者：项目经、开发人员。

  如有错误，欢迎大家指出~~~