《软工文档》-总结

【前言】
软工文档写完有几天了，一直拖着没有写一个总结…现在对软工文档进行一个系统的总结吧！个人理解如下：
在做一个项目之前，首先要对本项目做一个可行性研究；然后再做一个项目开发计划；有了开发计划之后，就要对项目进行具体的了解：了解客户的需求是什么；然后根据客户的需求，写出本项目的设计说明书，如何进行设计，有一个详细的说明文档，即概要设计和详细设计说明书；接下来就是数据库的设计和编码过程了，这个阶段需要有一个数据库设计和要求说明书；编码过程之后就要进行测试，然后需求做一个测试计划以及测试完成之后的测试分析报告；测试完成之后需要对项目的整个开发进行一个总结，需要写一个项目开发总结报告；最后项目完成，需要交付使用了，此时需要有操作手册和用户手册，让使用者更快地熟悉操作流程和软件环境。
【内容】
1.导图

2.读者
可行性研究报告：系统管理员、开发人员和维护人员
项目开发计划：系统分析员和开发人员
软件需求说明书：开发人员和用户代表
概要开发设计说明书：开发人员
详细设计说明书：开发人员、测试人员
数据库设计说明书：程序员、数据库管理员
测试计划：开发人员、测试人员
测试分析报告：开发人员
项目开发总结报告：开发人员
操作手册：用户
用户手册：用户
开发进度月报：项目开发人员、用户代表
3.目的与意义
可行性研究报告
该项目是否可行，比如：法律可行性、技术可行性、经济可行性等。
项目开发计划
对整个项目的各个阶段做出一个大致的计划，以及系统配置等。
软件需求说明书
阐述用户对项目的一些需求，进一步确定软件的功能和性能。
概要设计说明书
概要地说明整个系统的体系结构，具体任务是将一个复杂系统进行模块划分，建立模块与模块之间的联系。
详细设计说明书
在概要设计的基础上，进一步细化系统结构，如具体的算法、数据库的结构设计等。
数据库设计说明书
提供了数据库的设计的理论支持，对数据库中使用的所有标识、逻辑结构和物理结构做出具体的设计规定。
数据要求说明书
对本系统中的数据有一个清晰的要求和说明。
测试计划
描述将要进行测试活动的范围，方法，资源和时间进度的文档。目的就是尽可能多的找到系统中的漏洞，并且设计出测试用例，对系统进行测试。
测试分析报告
测试分析报告是在测试的基础上，对测试的结果以及测试的数据等加以记录和分析总结，描述系统是否符合需求。
项目开发总结报告
说明整个项目的开发流程，程序开发中的状况、最终结果，总结经验教训，对整个开发的评价。
操作手册
告诉使用者，本系统提供了那些功能，以及如何正确地、有效地来使用这些功能，如何进行操作。
用户手册
为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决问题的方法。
开发进度月报
汇报项目的进展情况以及项目开发过程中遇到的问题等。
4.总结
第一次开始写文档，刚开始写的时候不知道从哪里入手，写着写着就有点感觉了，思路也清晰了不少。每个文档中的主角是根据项目的实际情况进行分析设计编写的，配角是每个文档不变的那些内容，比如说：该文档的编写目的、背景等，每个文档都有自己的编写目的、背景。