文档编制的质量要求

转载 2006年06月02日 10:34:00
文档编制的质量要求

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

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

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

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

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

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

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

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

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

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

 

  文档的管理和维护  

    在整个软件生存期中,各种文档作为半成品或是最终成品, 会不断地生成、修改或补充。为了最终得到高质量的产品,达到上 节提出的质量要求,必须加强对文档的管理。以下几个方面是应注意做到的:

①软件开发小组应设一位文档保管人员,负责集中保管本 项目已有文档的两套主文本。两套文本内容完全一致。其中的一套可按一定手续,办理借阅。

②软件开发小组的成员可根据工作需要在自己手中保存一些个人文档。这些一般都应是主文本的复制件,并注意和主文本保持一致,在作必要的修改时,也应先修改主文本。

③开发人员个人只保存着主文本中与他工作相关的部分文档。

④在新文档取代了旧文档时,管理人员应及时注销旧文档。 在文档内容有更动时,管理人员应随时修订主文本,使其及时反映更新了的内容。

⑤项目开发结束时,文档管理人员应收回开发人员的个人文档。发现个人文档与主文本有差别时,应立即着手解决。这常常是未及时修订主文本造成的。

⑥在软件开发过程中,可能发现需要修改已完成的文档,特别是规模较大的项目,主文本的修改必须特别谨慎。修改以前要充分估计修改可能带来的影响,并且要按照:提议、评议、审核、批准和实施等步骤加以严格的控制。

相关文章推荐

计算机软件文档编制规范

GB8567目前最新的版本是2006年发布的【计算机软件文档编制规范】,你所找的88年的版本是已经作废的标准,说的是【计算机软件产品开发文件编制指南】已经被现在这个2006的代替了。应以2006年的为...

硬件开发文档编制规范详解

硬件开发文档编制规范详解   1、硬件需求说明书 硬件需求说明书是描写硬件开发目标,基本功能、基本配置,主要性能指标、 运行环 ...

敏捷文档编制路线图

John是一家大型公司的长期分析师,负责捕获新的软件产品及现有软件产品的需求。他用SRS(软件需求规格说明书)记录所有客户对正在开发或维护的特定产品的需求。 Jane是同一家公司的开发人员。她通...

计算机软件文档编制规范

  • 2015-12-24 16:08
  • 1.84MB
  • 下载

专业的LaTeX: 在Linux下编写高质量的文档

专业的LaTeX: 在Linux下编写高质量的文档 (2009-10-29 13:59:54) 标签: linux 排版 latex dvi 导言 美国 杂谈 ...

计算机软件文档编制规范

  • 2015-12-17 14:27
  • 794KB
  • 下载

Android Studio官方文档之用注解检查改善代码质量

Android Studio官方文档之用注解检查改善代码质量
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)