支持中心
定制开发服务
知识中心Q&A
下载中心
服务体系
服务热线
防伪查询
联系我们

了解更多详细信息请致电

400-677-0389

或给我们留言

在线留言

您所在的位置: 首页>支持中心 > 知识中心Q&A > 定制开发知识 >

软件开发文档编写的质量决定软件开发的成败

作者: 点击量: 2015-03-03 16:15:30
内容导读: 为使软件开发文档能起到多种桥梁作用,有助于软件开发人员编制程序,有助于管理人员监督和管理软件开发,有助于用户了解软件的工作和应做的操作,有助于维护人员进行有效的修改和扩充,软件开发文档的编制必须保证一定的质量。质量差的软件开发文档不仅使读

 

为使软件开发文档能起到多种桥梁作用,有助于软件开发人员编制程序,有助于管理人员监督和管理软件开发,有助于用户了解软件的工作和应做的操作,有助于维护人员进行有效的修改和扩充,软件开发文档的编制必须保证一定的质量。质量差的软件开发文档不仅使读者难于理解,给使用者造成许多不便,而且会削弱对软件的管理(管理人员难以确认和评价开发工作的进展),增高软件的成本(一些工作可能被迫返工),甚至造成更加有害的后果(如误操作等)

造成软件开发文档质量不高的原因可能是:缺乏实践经验,缺乏评价软件开发文档质量的标准。不重视软件开发文档编写工作或是对软件开发文档编写工作的安排不恰当。

最常见到的情况是,软件开发过程中不能按给出的进度,分阶段及时完成软件开发文档的编制工作,而是在开发工作接近完成时集中人力和时间专门编写软件开发文档。另一方面,和程序工作相比,许多人对编制软件开发文档不感兴趣。于是在程序工作完成以后,不得不应付一下,把要求提供的软件开发文档赶写出来。这样的做法不可能得到高质量的软件开发文档。实际上,要得到真正高质量的软件开发文档并不容易,除去应在认识上对软件开发文档工作给予足够的重视外,常常需要经过编写初稿,听取意见进行修改,甚至要经过重新改写的过程。

高质量的软件开发文档应当体现在以下一些方面:

①针对性

软件开发文档编制以前应分清读者对象,按不同的类型、不同层次的读者,决定怎样适应他们的需要。例如,管理软件开发文档主要是面向管理人员的,用户软件开发文档主要是面向用户的,这两类软件开发文档不应像开发软件开发文档(面向软件开发人员)那样过多地使用软件的专业术语。

②精确性

软件开发文档的行文应当十分确切,不能出现多义性的描述。同一课题若干软件开发文档内容应该协调一致,应是没矛盾的。

③清晰性

软件开发文档编写应力求简明,如有可能,配以适当的图表,以增强其清晰性。

④完整性

任何一个软件开发文档都应当是完整的、独立的,它应自成体系。例如,前言部分应作一般性介绍,正文给出中心内容,必要时还有附录,列出参考资料等。同一课题的几个软件开发文档之间可能有些部分相同,这些重复是必要的。例如,同一项目的用户手册和操作册中关于本项目功能、性能、实现环境等方面的描述是没有差别的。特别要避免在软件开发文档中出现转引其它软件开发文档内容的情况。比如,一些段落并未具体描述,而用"见××软件开发文档××节"的方式,这将给读者带来许多不便。

⑤灵活性

各个不同的软件项目,其规模和复杂程度有着许多实际差别,不能一律看待。图6所列软件开发文档是针对中等规模的软件而言的。对于较小的或比较简单的项目,可做适当调整或合并。比如,可将用户手册和操作手册合并成用户操作手册;软件需求说明书可包括对数据的要求,从而去掉数据要求说明书;概要设计说明书与详细设计说明书合并成软件设计说明书等。

⑥可追溯性

由于各开发阶段编制的软件开发文档与各阶段完成的工作有着紧密的关系,前后两个阶段生成的软件开发文档,随着开发工作的逐步扩展,具有一定的继承关系。在一个项目各开发阶段之间提供软件开发文档必定存在着可追溯的关系。例如,某一项软件需求,必定在设计说明书,测试计划以至用户手册中有所体现。必要时应能做到跟踪追查。

 

选购指南:

本公司主要为山东地区供应各品种型的开发济南桌面软件开发济南网页软件开发济南APP软件开发济南WinCE嵌入式软件开发具体包含如:家电公司管理软件电脑公司管理系统软件公司管理系统手机店管理系统森普P6综合业务支撑平台政府办公平台济南财务济南软件开发济南HR济南软件开发可以满足各种大中小型各类企业的管理需要。

如需了解本公司的详细业务情况,敬请访问本公司官方网站:https://www.simpro.cn

公司名称:森普信息集团(北京·济南·上海·西安)

公司网址:https://www.simpro.cn

业务QQ:176099777

联系电话:400-677-0389

业务咨询
咨询在线客服
合作加盟
咨询在线客服

我们的微信

我们的微博

点击图标进入帮助中心
我们的微信

扫描关注微信

我们的微博

扫描微博交流