软工文档总结

        在进行完软工视频，接下来就是软工文档，这时候心里就一个疑问“从何入手开始写？”，对软工文档刚刚接触，没有一点头绪，根本不知道从哪里开始下手，问了一下15期的师哥师姐，主要问了一下为什么写文档和写文档的目的又是什么？        

        首先，什么是软工文档？（软件工程文档就是表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。）那么我们为什么写文档呢？

        1.方便各个开发人员之间的交流，节省时间 
        2.可以提高软件开发效率，保证软件的质量 
        3.将开发过程的事件记录在文档中，即使公司有人跳槽了，也可以帮助新来的人员快速了解开发业务。

      在写文档过程中没有想到会是这么的复杂和涉及的知识点之多。每个文档涉及到的人员不同，不同的文档不同身份的人去看，总之会感觉十分复杂。

       每个文档的作用分别是什么：

1.可行性分析研究：明确所要开发的软件具有的功能，性能，限制，环境等。考虑机房收费系统的法律可行性，技术可行性和经济可行性。项目分析员进行下一步工作的前提，使软件开发人员在定义阶段较早的认识到系统方案的缺陷，提高机房收费管理的水平，达到节约时间，提高效率，快捷效率的管理目的，从而降低人力，物力，财力消耗。本次编写目的是为了分析廊坊师范学院是否具备研发机房收费系统的必要性和可能性。

预期读者：项目开发人员和管理人员

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

预期读者：项目开发人员和管理人员

3.软件需求说明书：对软件目标及范围的精确和细化，深入描述了软件的功能及软件的约束范围，进一步确定软件的功能和性能，从而使用户和软件开发者对该软件的初始的规定有一个大概的了解，有利于对项目的回溯以及对每个功能标准记性定位。

预期读者：系统分析人员，开发人员，项目管理人员，用户

4.概要设计说明书：说明整个系统的体系结构，以及需求用例的各个功能点在结构中的体现，为系统的详细设计人员进行详细设计师的输入参考文档。

预期读者：开发人员

5.详细设计说明书：为了得出系统的精确描述，设计出程序的蓝图，式程序员根据此蓝图写出代码。

预期读者：开发人员，测试人员

6.数据库设计说明书：提供了数据库设计的可视性以及软件支持所需的信息，应用于机房收费系统的开发前期，主要叙述了用户对项目的一些要求，进一步确定软件的功能和性能，对每个功能标准进行定位，为后期数据库设计指引方向，也可以为系统程序设计提供借鉴与参照。

预期读者：开发人员和数据库管理人员

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

预期读者：开发人员，数据库设计人员，

8.测试计划：测试计划是描述将要进行测试活动的范围、方法、资源和时间进度的文档。目的就是尽可能多的找到系统中的漏洞，并且设计出测试用例，对系统进行测试。

预期读者：开发人员、测试人员

9.测试分析报告：在测试分析的基础上，进行测试后需要对测试的结果以及测试的数据等加以记录和分析总结，它是测试过程的一个重要的环节，同时，它也是对软件性能的一个总的分析和对认识不足的说明。为以后的软件开发程序提供了丰富的经验。

预期读者：软件开发者，测试分析人员

10.项目开发总结报告：机房收费系统的开发基本已经完成，此项目开发总结报告，是在分析我们在开发过程总结经验和教训，为我们以后的开发项目积累经验，从而减少成本。

预期读者：所有参与项目相关人员

11.操作手册：编写操作手册的目的是让使用此软件的人了解整个操作步骤和正确使用系统，保证系统的安全性和完整性。

预期读者：开发人员，用户等。

12.用户手册：编写本文档的主要目的是给使用者提供一个使用指南，以便为首次使用该该系统的用户说明使用方法，以及给正在使用或即将使用的用户在使用的过程中遇到的问题提供解决的办法。

预期读者：开发人员，用户等

13.开发进度报告：对项目的开发进度，耗资和当前状态进行跟进，以及经费进行总结并且实时列出下个月的计划，从而实现时间金额资源的充分 利用。