• 软件测试技术
  • 软件测试博客
  • 软件测试视频
  • 开源软件测试技术
  • 软件测试论坛
  • 软件测试沙龙
  • 软件测试资料下载
  • 软件测试杂志
  • 软件测试人才招聘
    暂时没有公告

字号: | 推荐给好友 上一篇 | 下一篇

软件开发文档编制的质量要求

发布: 2008-2-03 12:25 | 作者: 51CTO  | 来源: 51CTO  | 查看: 149次 | 进入软件测试论坛讨论

领测软件测试网

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

  造成软件文档质量不高的原因可能是: 

  · 缺乏实践经验,缺乏评价文档质量的标准。  

  · 不重视文档编写工作或是对文档编写工作的安排不恰当。  

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

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

  ①针对性  

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

  ②精确性  

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

  ③清晰性  

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

  ④完整性  

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

  ⑤灵活性  

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

  ⑥可追溯性  

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

延伸阅读

文章来源于领测软件测试网 https://www.ltesting.net/

TAG: 软件开发 文档编制 质量要求


关于领测软件测试网 | 领测软件测试网合作伙伴 | 广告服务 | 投稿指南 | 联系我们 | 网站地图 | 友情链接
版权所有(C) 2003-2010 TestAge(领测软件测试网)|领测国际科技(北京)有限公司|软件测试工程师培训网 All Rights Reserved
北京市海淀区中关村南大街9号北京理工科技大厦1402室 京ICP备10010545号-5
技术支持和业务联系:info@testage.com.cn 电话:010-51297073

软件测试 | 领测国际ISTQBISTQB官网TMMiTMMi认证国际软件测试工程师认证领测软件测试网