软件工程的收获(8)——文档总结

前言

从软件工程的文档有很多,12个,贯穿了整个软件的开发过程。在整个软件的开发过程中,不同阶段的文档将不同阶段不同受众群体的人们联系到了一起,使其可以彼此交流。帮助人们理清自己的思路,文档在这个过程中起到了深远的影响。
在这里插入图片描述

可行性报告

目的

从各个方面评估项目的可行性,并提出建议,是整个软件开发过程中的重要依据之一。

沟通人群

系统管理员,开发人员和维护人员

内容

1.经济可行性
2.技术可行性
3.操作可行性
4.法律可行性
5.时间可行性

概要设计说明书

目的

详细说明系统的设计思考,提供继续设计基础。

沟通人群

开发人员

内容

1.总体设计
2.接口设计
3.数据结构设计
4.运行设计
5.出错处理设计
6.安全保密设计
7.维护设计

项目开发计划

目的

对整个项目各个阶段的规划说明

沟通人群

系统分析员和开发人员

软件需求说明书

目的

描述用户对项目的一些需求,进一步确定软件的功能和性能

沟通人群

开发人员和用户代表

详细设计说明书

目的

确定软件细节上的问题,比如软件数据库的数据结构,逻辑算法等。

沟通人群

开发人员、测试人员

数据库设计说明书

目的

为数据库的设计提供理论支持,对数据库中的数据类型,标识,逻辑结构,物理结构制定具体的设计规定

沟通人群

程序员、数据库管理员

测试计划

目的

描述准备进行测试的活动范围,方法资源和时间进度的文档。目的就是尽可能多的找出软件中的问题,并且设计出足够多的测试用例,对软件进行测试。

沟通人群

开发人员、测试人员

测试分析报告

目的

测试分析报告是在测试的基础上,对软件测试的结果及数据加以记录和分析总结。

沟通人群

开发人员

项目开发总结报告

目的

对整个开发项目进行总结报告,总结开发经验,对软件系统进行评测,以便下次开发使用。

沟通人群

开发人员

操作手册

目的

给客户提供使用指南,为使用该软件系统的用户说明软件系统的使用方法,以期解决客户使用过程中的问题。

沟通人群

用户

用户手册

目的

给客户提供使用指南,为使用该软件系统的用户说明使用方法,以及给已经使用过或者在使用过程中遇到问题的客户提供解决问题的方法

沟通人群

用户

开发进度月报

目的

回报项目开发过程的进展情况,处理过程中发现,出现的问题

沟通人群

项目开发人员、用户代表

总结

软件的文档的目的是使不同的受众人群在软件系统开发过程中,互相沟通理解软件开发的实际需求,使得不同受众人群相互协助得以成功的开发软件。因此软件文档的好坏就取决于看文档的群体能否成功的理解文档,为了达成这一目的我们需要尽可能地站在读者的角度来编写。

猜你喜欢

转载自blog.csdn.net/s310040799/article/details/89735976