软件工程文档总结

爱被打了一巴掌 2022-08-24 15:24 220阅读 0赞

经过几天的奋战，软件工程的文档终于写完了。可能是第一次接触文档，感觉很陌生。

虽然照着模版，站在巨人的肩膀上把文档写完了。可是，以现在的知识，对文档的认识和了解还远远不够。这就需要在以后的学习中，要多加注意这部分。

在软件开发过程中，软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料。文档在开发过程中就起到关键作用，从某种意义上来说，文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。

## 一、 下面就宏观的说一下这些文档： ##

**1.可行性分析报告：**说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由

**2.项目开发计划：**为软件项目实施方案制订出具体计划，应该包括各种部分工作的负责人员、开发进度、开发经费的预算、所需的硬件及软件资源等。

**3.软件需求说明书：**对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

**4.概要设计说明书：**该说明书是概要实际阶段的工作成果，它应该说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。

**5.详细设计说明书：**着重描述每一模块是怎样实现的，包括算法、逻辑流程等。

**6.数据库设计说明书：**描述数据库的设计方法（外部设计、结构设计、运行设计）、设计原则、表结构等

**7.数据要求说明书：**主要给出逻辑上的数据描述及要求，根据项目特点进行数据分析，为以后的数据管理和数据库建立等做好说明和准备。

**8.测试计划：**为做好集成测试和验收测试，需为如何组织测试制定实施计划。计划内容应包括：测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

**9.测试分析报告：**测试工作完成后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

**10.项目开发总结报告：**软件项目开发完成后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结经验教训。

**11.操作手册：**为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的

**12.用户手册：**详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

**13.开发进度月报：**该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

## 二、 各个文档在软件生存周期中的分布 ##

<table> 
 <tbody> 
 <tr> 
 <td> &nbsp; </td> 
 <td> 软件计划 </td> 
 <td> 需求分析 </td> 
 <td> 软件设计 </td> 
 <td> 程序编写 </td> 
 <td> 软件测试 </td> 
 <td> 运行与维护 </td> 
 </tr> 
 <tr> 
 <td> 可行性研究报告 </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 项目开发计划 </td> 
 <td> √ </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 软件需求说明书 </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 概要设计说明书 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 详细设计说明书 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 数据库设计说明书 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 数据要求说明书 </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 测试计划 </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> √ </td> 
 </tr> 
 <tr> 
 <td> 测试分析报告 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 项目开发总结报告 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 操作手册 </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 用户手册 </td> 
 <td> &nbsp; </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> 开发进度月报 </td> 
 <td> √ </td> 
 <td> √ </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

罗马不是一天建成的，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程师们是如何的完善文档规范。所以文档在软件开发过程中的重要性，不言而喻。

以上仅是个人看法，如有不足之处，还望指正。