17、软件文档：精确性与实用性的关键

软件文档：精确性与实用性的关键

在软件开发领域，软件文档常常处于被忽视的地位。许多计算机科学研究人员并不将软件文档视为计算机科学的重要主题，他们认为其中缺乏数学、算法和计算模型，因而对其兴趣寥寥。然而，这种忽视却可能导致软件质量、使用情况、资源和动力陷入恶性循环。为了培养出能生产可靠软件的专业软件行业，为程序开发者和维护者准备组织良好、精确的文档是至关重要的。

软件开发与编程的差异

很多刚进入计算机领域的人会误以为“软件开发”就是“编程”的另一种说法。实际上，编程只是软件开发的一小部分。软件通常是一组人编写的程序，供另一组人重复使用，这与为自己使用或单次使用而编写程序有很大不同。

为自己使用编写程序时，用户就是创作者本身，能够理解程序并知道如何使用它。例如，用户能理解错误消息的来源或其他故障的原因，不需要专门的手册来解释参数含义、输入格式或兼容性问题。如果忘记了某些细节，还可以通过研究代码来解答疑问。但如果程序是供陌生人使用，这些手册就必不可少了。

而当为单次使用编写程序时，无需设计易于更改或维护多个版本的程序。但成功的软件产品会使用多年，可能同时存在多个版本，更新和改进程序的成本往往远超最初的开发成本。因此，设计程序时应尽量使其易于更改，并确保软件产品线的成员有尽可能多的共性，这些共性需要记录在文档中，以便在修订单个成员时保持一致。正是软件开发与编程在多人参与和多版本使用方面的差异，使得文档对于软件开发变得尤为重要。

文档的定义与特性

文档是对系统的书面描述，具有官方地位或权威性，可作为证据。在开发过程中，文档通常具有约束力，限制了可创建的内容。若需要偏离文档，必须经过相关负责人的批准。

文档应