软工文档总结

软工文档的项目要完成了，我有必要梳理一下自己的思路，做一下总结。

 

软工文档一共包括十三个部分，分别是：

1.可行性研究报告

2.项目开发计划

3.软件需求说明书

4.概要设计说明书

5.详细设计说明书

6.数据库设计说明书

7.数据要求说明书

8.测试计划

9.测试分析报告

10.项目开发总结报告

11.操作手册

12.用户手册

13.开发进度月报

 

初次接触软工文档的孩子们肯定会有疑惑：我去！这么多文档，都是怎么写的呢？都有什么作用呢？

别急，我按照我的思路，谈谈自己的浅见。

 

软件开发文档到底是什么东东？

 

查阅百度百科我们可以得知：软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。

可见软件开发文档是非常重要的，而且我们通过学习过《软工视频》和《软件开发工具》可知：软件等于程序加文档。这更突显了软件开发文档的重要性，所以我们需认真的接触加了解。

 

 

它们各有什么作用呢？

米老师说一图胜万言，于是我列了一个表：

文档类型	文档名称	编写的目的和意义	预期读者
开发文档	可行性研究报告	从各个方面分析此软件开发的必要性和可能性， 是项目分析员进行进一步工作的前提 , 是软件开发人员正确成功的开发项目的前提与基础 。	系统管理人员、开发人员、维护人员
	概要设计说明书	主要目的是为详细设计说明书提供基础。主要内容包括总体设计、接口设计、运行设计、系统数据结构的设计、系统出错处理设计。主要解决了实现该系统需求的程序模块设计问题。	系统管理人员、开发人员、维护人员
	详细设计说明书	是在机房收费系统概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。	项目设计者和程序员
	数据库设计说明书	对数据库的设计方法作出具体规定。提供了数据库设计的可视性以及软件支持所需的信息。主要内容包括外部设计、结构设计、运用设计。	数据库设计师、数据库管理员
	数据要求说明书	主要意义是明确机房收费系统中各项功能和非功能性需求实现时所需要的数据。同时为概要设计和详细设计人员提供设计依据。主要内容包括数据的描述如静态、动态输入、动态输出、内部生成、约定、采集。	数据库设计人员、系统测试人员
管理文档	项目开发计划	对开发系统做规划，拟出详细的计划，主要包括人员组织、时间进度、设备、开发/运行环境、成本费用。方便相关人员根据本计划开展和检查本项目的开发工作。	用户、开发者、管理者、分析人员
	测试计划	概括了测试的主要目的，明确测试的方法、测试流程、测试范围、所花费的资源和时间	测试人员
	测试分析报告	主要是对测试的结果进行统计和分析总结。它不仅对软件的功能的加强起着关键作用，还有利于今后软件开发者阅读源程序， 从而进行有益的改进。	软件开发人员
	项目开发总结报告	对整个项目进行总结，回顾整个项目开发的全过程，总结各个阶段中的经验和出现的问题，找出不足之处和可取之处，并进行中肯的评价分析，为以后的项目开发积累经验和教训。	项目开发人员
	开发进度月报	主要的作用是及时向项目管理人员汇报项目开发的进展情况。主要内容包括进度、资额耗用、经费支出以及下月计划。	管理人员
用户文档	软件需求说明书	编写此文档是为了了解用户的需求，收集需求的改变，方便了设计人员、分析人员与用户之间的联系和交流。为软件开发工作提供基础和依据，同时为确认测试和验收提供依据。	系统开发人员、用户、系统测试人员
	操作手册	为用户编写，告诉用户此软件所包含的功能和如何使用这些功能。	用户
	用户手册	为用户提供一个使用指南，为用户提供该软件的安装和初始化方法，并且为用户提供一些基础的排除问题和故障的方法。	用户

 

 

我们该如何写文档呢？

 

个人觉得哈，按照一般要求，结合自己的实际情况，按照每个文档不同的读者的实际要求，用心的写下来，就是一份不错的文档。