软件工程文档

软件文档介绍：

       软件组成包括：程序、数据以及相关文档，因此软件工程文档是软件工程的一部分。文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间起着多种桥梁作用。

       软件工程文档可分为：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、测试计划、测试分析报告、质量保证计划书、操作手册、用户使用手册、开发进度月报、项目开发总结报告，接下来就各文档说明的问题及提到的作用做简单的介绍。

       可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

       项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需要的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

       软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是是开发工作的基础。

       数据要求说明书：给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷做好准备。

概要设计说明书：是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

       详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

       测试计划：为做好组装测试和确认测试，需要为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

       测试分析报告：测试工作完成后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

用户手册：详细描述软件的功能、性能和用户界面，是用户了解如何使用该软件。

       操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

       开发进度月报：该月报是软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的计划等。

       项目开发总结报告：软件项目开发完成后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需要对开发工作做出评价，总结出经验和教训。

总结：

       文档是很多系统开发过程的基础，只有编写正确、完善的文档，才能顺利的进行系统开发。高质量的文档编写是百利而无一害的，在今后的开发过程中也应引起足够的重视。