软工文档总结

前言：

文档是软件工程的灵魂，它在整个软件生命周期的各个阶起到了重要的桥梁作用。软件=程序+数据+文档，没有文档的软件，称不上软件。

正文：

软件文档有：

1.文档的作用：

1.1 、在很大的程度上，文档是软件开发的规范和指南。

1.2、提高软件开发过程的能见度，把开发的过程记录在文档中。

1.3、提高开发效率，文档可帮助开发人员进行时间规划和周密思考。

1.4、提供对软件的运行，维护和培训相关信息，便于人员管理，开发人员和操作人员和用户之间的交流与协作。

1.5、管理人员在检查软件开发进度和质量时，有据可查。

2.文档预期读者：

 

3、文档编写目的：

3.1、可行性研究报告：

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

3.2、项目开发计划：

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

3.3、软件需求说明书：

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

3.4、概要设计说明书：

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

3.5、详细设计说明书：

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

3.6、数据库设计说明书：

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

3.7、数据要求说明书：

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

3.8、测试计划：

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

3.9、测试分析报告：

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

3.10、项目开发总结报告：

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

3.11、操作手册：

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

3.12、进度月报：

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

3.13、用户手册：

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

4.文档总结:
文档时软件开发和运维阶段的宝典，是软件开发过程中不可缺少的一部分。第一次写文档很迷茫，不知如何下手，最后站在巨人的肩膀上看问题，这样会看的更远，而且有方向去看。经过一周的学习文档，终于写完了，现在回头想想文档原来是给软件做辅助的。如果可以说软件是骨架，那么文档就是骨架上的肉。它把软件很好的封装起来。