软件中文档和技术一样重要

    下面谈一谈我对文档的认识。

          首先举个例子：搞软件编程的大家都看过API手册吧，仔细想一想你看过的那款手册你感觉最让你看下去，而且还更加容易看下去。

         我个人的感受是微软的文档，给客户呈现的非常的详细而且有层次感，一个API函数用了很多的文字去阐释这个函数。这就说明了一个问题，搞软件的编出好的程序很重要，但是文档一样重要，微软都能做的这么好，而且也成为软件业的巨头，那我们的标杆，那是我们的学习的旗帜。

          软件文档能起到多种桥梁作用，使它有助于程序员编制程序，有助于管理人员监督和管理软件开发，有助于用户了解软件的工作和应做的操作，有助于维护人员进行有效的修改和扩充，文档的编制必须保证一定的质量。质量差的软件文档不仅使读者难于理解，给使用者造成许多不便，而且会削弱对 软件的管理(管理人员难以确认和评价开发工作的进展)，增高软件的成本(一些工作可能被迫返工)，甚至造成更加有害的后果(如误操作等)。 造成软件文档质量不高的原因可能是： 缺乏实践经验，缺乏评价文档质量的标准。不重视文档编写工作或是对文档编写工作的安排不恰当。 最常见到的情况是，软件开发过程中不能按给出的进度，分阶段及时完成文档的编制工作，而是在开发工作接近完成时集中人力和时间专门编写文档。另一方面，和程序工作相比，许多 人对编制文档不感兴趣。于是在程序工作完成以后，不得不应付一下，把要求提供的文档赶写出来。这样的做法不可能得到高质 量的文档。实际上，要得到真正高质量的文档并不容易，除去应在认识上对文档工作给予足够的重视外，常常需要经过编写初稿， 听取意见进行修改，甚至要经过重新改写的过程。 高质量的文档应当体现在以下一些方面：

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

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

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

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

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

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

         对于编程来说编程人员编出好的程序来很好，如何将这些东西呈献给客户（只懂业务，不懂程序的）这就是一种变通，一种向微软学习的方向。

        但愿中国的软件也认识到自己的不足，加强程序后期的维护建设，加强程序的可用性，加强文档的建设，这样中国的软件业迟早要飞起来的!

         希望我们每个人都要贡献自己的力量让行动照亮前行的路。