软工文档总结

前言

软工文档中介绍了在开发软件的前期所需要的所有文档，文档是软件的骨架，代码是文档的血液，本软工文档共十三个文档从开发前到开发中到最后的测试完毕递交用户。

总体思维导图：

文档预期读者：

编写目的

可行性研究报告：

为了提高机房的 力度，增加学校的收入，机房收费系统是必不可少的。机房收费系统可以提高管理效率，快捷准确的管理数据。从而降低成本和人力资源。编写文档的目的是针对该系统的可行性研究和经济性进行分析，研究一下廊坊师范学院是否具备研究该系统的必要。

项目开发计划：

通过可行性研究，已经明确了系统要解决的问题，所以就要写出具体的项目开发流程，提出项目开发目的，确定详细的项目实施范围、定义递交的工作成果、评估实施过程中主要风险、制定项目实施的时间计划、成本和预算计划、人力资源计划等。为项目整体进展提供计划基础，实现以文档驱动软件，高效分工并完成各项任务。

软件需求说明书：

软件需求说明书是需求文档阶段的一个文档，是对软件目标及范围的求精和细化，深入描写叙述的功能和性能以及软件的约束范围，使用户和软件开发人员对软件的初始规定有个大致了解。有利于读项目的回溯和知道兴许的开发和维护。

概要设计说明书：

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

详细设计说明书：

该文档是在概要设计的基础上，进一步的喜欢结构，展示了软件结构的图表，物理设计，数据结构设计，以及算法设计，详细的介绍了系统各个模块是如何实现的，包括设计到的算法，逻辑流程图等，为下一步系统的实现和测试做准备。

数据库设计说明书：

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

数据要求说明书：

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

测试计划：

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

测试分析报告：

测试分析报告是完成系统测试之后生成或编写的文档。将主要测试项目、测试方法、测试结果等，整理出来。

项目开发总结报告：

机房收费系统的开发工作已经 基本完成。写此项目开发总结报告，以方便我们在以后的项目开发中更好的实施项目的制定开发，让我们在今后的项目开发中有更多的资料来规范我们的开发过程和提高我们的开发效率，从而创造更多的公司效益。

操作手册：

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

进度月报：

开发中的软件系统的名称和标识符：机房收费系统/charge-sys
分项目名称和标识符：一般用户模块/操作员模块/管理员模块
分项目负责人签名：白爱民
本期月报编写人签名：白爱民
本期月报的编号及所报告的年月：01 2015年9月

用户手册：

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

后记：

从文档的整体看是为了我们软件的大体进行，大多数文档必须是在开发之前写完的，编写中期和后期的事情可随时间往后延写，但是有些系统也不需要文档的支持但是大多数还是需要文档的，所以文档的学习是我们重中之重。