【软件工程】文档总结

前言

编写完文档，了解到了文档的重要性，也感受到了编写文档的工作比编程的工作还复杂。软件工程的学习暂时告一段落，对十三个文档什么阶段编写，以及每个文档的用途，以及各个文档的目标用户做了总结，详情见下文。

各阶段编写文档

各文档读者

各文档用途

◇可行性研究报告
说明该软件项目的实现在技术上、经济上和社会因素上的可行性。简答来说：研究该软件项目能不能做。
◇项目开发计划
为软件项目实施方案制定出的具体计划。简单来说：如何做。
◇软件需求说明书
对目标软件的功能、性能、用户界面及运行环境等作出详细的说明。简单来说：做成什么样。
◇概要设计说明书
该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
◇详细设计说明书
着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
◇数据库设计说明书
描述对数据库的设计阶段的工作成果。
◇数据要求说明书
给出数据逻辑描述和数据采集的各项要求,为生成和维护系统的数据文件做好准备。
◇测试计划
为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
◇测试分析报告
测试工作完成后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。
◇项目开发总结报告
软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
◇操作手册
本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
◇用户手册
详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
◇开发进度月报
该月报是软件人员按月向管理部门提交的项目进展情况的报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。