软件工程文档总结

        在学习软工这个阶段的时候，看视频写文档，刚开始真的不知道该如何去写。然后参照模板一个一个的去写，尽量贴合，看别人的博客，看看他们是怎么写的。只要写了一个就感觉后面的很轻松了。下面是对软工文档的总结，欢迎批评指正：

一、总介绍：

        软件工程文档是贯穿整个软件工程生命周期的相关记录，在整个软件的定义、开发、维护阶段起着至关重要的总用。我理解的软工文档是为软件设计的计划、运行、维护等方方面面提供依据，使整个软件参与人员都能明确自己要做什么，做的是什么，对软件有一个更为全面深刻的理解。

        一共有13个文档：01可行性研究报告、02项目开发计划、03软件需求说明书、04概要设计说明书、05详细设计说明书、06 1数据库设计说明书、06 2数据要求说明书、07测试计划、08测试分析报告、09项目开发总结报告、10操作手册、11用户手册、12开发进度月报。

二、分类：

三、各个文档的详细介绍：

01、可行性研究报告：

        可行性研究的目的是为了对问题进行研究，以最小的代价在最短的时间内确定问题是否可解。此可行性研究报告对《机房收费管理系统》软件进行了全面细致的市场调研，明确所要开发软件具有的功能、性能、前提、限制、环境等，综合论证项目开发的必要性。

        编写人员：系统分析员。

        预期读者：负责审批的人、开发人员、维护人员。（负责审批的人看过之后确定系统可以开发，文档将交给开发人员和维护人员参考）。

02、项目开发计划：

        主要对开发机房收费系统的费用、时间、进度、人员组织、硬件设备的配置、开发环境和运行环境的配置进行说明，为开发的下一步做准备。

        预期读者：系统分析员、系统开发人员。

        应有图：甘特图。

03、软件需求说明书：

       该说明书主要是了解用户对软件的需求，做出相关分析，不断与用户进行交流，明确系统能够做什么，使功能更加完善。

        预期读者：系统开发人员、用户。

        应有图：用例图。

04、概要设计说明书：

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

        预期读者：项目设计人员、项目编码人员。

        应有图：架构图、包图、类图。

05、详细设计说明书：

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

        预期读者：系统开发人员、程序测试人员。

        应有图：类图、时序图、活动图、状态图。

06 1、数据库设计说明书：

        本文档描述了机房收费系统的数据库的设计，提供了数据库的设计的理论支持，应用与机房收费系统开发前期，为后期的数据库设计指引了方向，也为系统程序设计提供借鉴与参考

        预期读者：数据库设计人员、数据库管理员。

06 2、数据要求说明书

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

        预期读者：数据库设计人员、系统测试人员。

07、测试计划

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

08、测试分析报告

        本文档是在测试分析文档的基础上，对测试设计进行了详细的分析，包括数据和测试结果等的记录和分析。对其将预期结果和测试结果进行比较后，对系统进行完善。

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

09、项目开发总结报告

        机房收费系统的开发工作已经基本完成，需对其开发研究的过程进行总结，此文档的目的就是为以后的研发过程提供良好的项目规划和参考，提供开发水平和效率。
        预期读者：项目经理、项目开发人员。

10、操作手册

        本文档的目的在于告诉机房收费系统的使用者，本系统提供了那些功能，以及如何正确地、有效地来使用这些功能。（从系统层面描述）
        预期读者：用户。

11、用户手册

        本文档的主要目的是为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决问题的方法。 （从用户需求方面描述）
        预期读者：用户。

12、开发进度月报

        本文档是按照月周期对工程的进度和状态、经费支出与状态，以及下个月的工作计划和相关建议进行记录和汇报。对进度进行总结，及时发现在开发过程中存在的问题，为以后的开发提供经验教训，提高接下来项目的开发进度。

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

四、总结：

        软工文档是软件工程的灵魂，与软件的生命周期各个阶段交相呼应。文档直接的描述了软件设计的各个方面，程序员们根据文档就能自主编写软件。所以说，软工文档对于软件的整个开发过程是十分重要的。总结是为了理清思路，还有很多不足之处，欢迎指正，共同进步！