HITZoneII 版 (精华区)

发信人: Kermit (从小就笨), 信区: HITZoneII
标  题: 文档编制的质量要求
发信站: 哈工大紫丁香 (Thu Oct 17 18:17:27 2002) , 转信


 
 

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

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

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

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

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

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

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


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

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

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




--

※ 来源:．哈工大紫丁香 http://bbs.hit.edu.cn [FROM: 211.155.255.130]