61、系统开发中的文档编写与测试设计

系统开发中的文档编写与测试设计

1. 文档开发概述

系统文档开发应贯穿于整个系统开发过程。从很多方面来看，系统的文档本身也可视为一个系统，因此其开发过程与软件开发有相似之处，但更为简单。在这个过程中，创建用例和开发文档的用户界面是很有意义的做法。

文档主要分为系统文档和用户文档这两种基本类型。系统文档旨在帮助程序员和系统分析师理解应用程序软件，以便在系统安装后进行构建或维护。它在很大程度上是系统分析和设计过程的副产品，会随着项目的推进而逐步创建。项目的每一个步骤和阶段都会产生一些文档，这些文档对于理解系统的构建方式至关重要，并且会被存储在项目文件夹中。在许多面向对象的开发环境中，还可以在一定程度上实现类和方法详细文档的自动化创建。例如在 Java 中，如果程序员使用 javadoc 风格的注释，就可以利用 javadoc 实用工具自动创建记录类及其方法的 HTML 页面。

用户文档，像用户手册、培训手册和在线帮助系统等，则是为了帮助用户操作该系统而设计的。尽管大多数项目团队期望用户在操作前接受培训并阅读用户手册，但实际情况并非总是如此。如今，尤其是对于微型计算机的商业软件包，用户在未接受培训或未阅读手册的情况下就开始使用软件的情况更为常见。接下来，我们将重点关注用户文档。

2. 用户文档的开发

2.1 开发时间与成本

用户文档的开发常常被推迟到项目的最后阶段，然而这是一种危险的策略。开发高质量的文档所需的时间往往超出人们的预期，因为它不仅仅是简单地写几页内容，还包括文档的设计（无论是纸质还是在线形式）、文本编写、编辑以及测试等工作。对于纸质文档，每单倍行距的页面大约需要三个小时；对于在线文档，每个屏幕大约需要两个