【软件工程】文档总结

前言

文档写完了，第一次写文档。刚开始学习写文档，真的很痛苦，看着模板，看着那一个个大标题小标题，代表着我好难，有时候自己写着文档的时候就感觉到自己写的不是文档，很好笑，很现实。但是，每个文档我都是认真的写完的，所有文档都写完了，所以我还是有收获的。

重要性

文档的作用很多，不仅仅是为了用户、程序员提供一个可靠地依据。无论是对于用户还是对于程序员都做到有据可循，编程结束后如果出现什么差错，检查这是谁的问题，当然就得根据文档，文档就相当于法律条文，明确规定各自的任务，不符合用户需求就是程序员的问题，这样公司就会遭受损失。
同时，文档也为系统的维护，提供有利的技术支撑，相信大家都知道，做一个软件系统很容易，后期的维护工作才是一个优秀的编程团队要考虑的问题。

文档导图

为了能够准确把控写好每一个文档，宏观把控是不可少的，我们必须对这12个文档进行分类、汇总，找到一个适合自己的思路，捋清各个文档之间的关系，这样对我们写文档的帮助是很大的。下面就是我对这些文档的初步认识。

1.开发文档：这类文档在软件项目开发过程中，体现了软件开发人员前一段工作的成果，同时又是后一段工作的依据。具有着里程碑的作用，同时也利于维护人员的维护工作。
2. 管理文档：这类文档在软件项目开发过程中，由软件开发人员制定的需提交管理部门的一些工作计划、工作方案和工作报告。通过阅读这些文档，管理人员能够了解软件项目开发活动安排、进度、资源使用等情况。
3. 用户文档：这类文档是软件开发人员为使用该软件的用户提供的有关本产品使用、操作的资料。

各文档介绍

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

文档预期读者

文档名称	编写人员	预期读者
可行性分析报告	分析员、管理员	管理人员、开发人员
软件需求说明书	开发人员	开发人员、测试人员
项目开发计划	开发人员	开发人员、管理人员
数据要求说明书	开发人员、分析人员	开发人员、测试人员
数据库设计文档	开发人员	开发人员、测试人员
概要设计文档	管理人员、开发人员	开发人员、测试人员
详细设计文档	开发人员	开发人员、测试人员、维护人员
测试计划	开发人员	测试人员、开发人员、威化人员
测试分析报告	测试人员	开发人员、维护人员
项目开发总结报告	管理人员	管理人员
用户手册	开发人员	用户、操作员
开发进度月报	管理人员	管理人员

总结

第一次的文档编写，有时候在写文档的时候就发现，自己平时想对软件的一些规则和约束，文档上都有，并且文档上包括的更加全面。软工文档让我学习了很多，同时我还有很多还可以完善和修改的地方。总之，软工文档让我迈出了更专业的一步。