软件项目文档.docxVIP

软件项目文档

文档的治理和爱护

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

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

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

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

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

项目开发终止时，文档治理人员应收回开发人员的个人文档。发觉个人文档与主文本有差别时，应赶忙着手解决。这常常是未及时修订主文本造成的。

在软件开发过程中，可能发觉需要修改巳完成的文档，专门是规模较大的项目，主文本的修改必须专门慎重。修改往常要充分估量修改可能带来的阻碍，同时要按照：提议、评议、审核、批准和实施等步骤加以严格的操纵。

文档编制的质量要求

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

造成软件文档质量不高的缘故可能是：

?缺乏实践体会，缺乏评判文档质量的标准。

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

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

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

针对性；文档编制往常应分清读者对象，按不同的类型、不同层次的读者，决定如何样适应他们的需要。例如，治理文档要紧是面向治理人员的，用户文档要紧是面向用户的，这两类文档不应像开发文档（面向软件开发人员）那样过多地使用软件的专业术语。

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

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

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

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

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

程序文档合一与动态文档

专门多企业差不多建立了许多庞大的运算机治理系统，而且将不断地推出新的系统。满足经营的需求须不断爱护、改造运算机系统，但同时又要不阻碍现行生产，因此必须建立一整套机制来评判、操纵和完成对系统的爱护。在软件爱护过程中，提出程序与文档合一的概念在软件开发的同时建立动态文档。

程序与文档合一概念的提出

一、目前软件的状况

程序与文档的形式分离，不仅是用各自独立的形式存放，而且使用不同的工具在不同的时刻里书写和检