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

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

1. 文档开发概述

在系统开发的整个过程中，文档的开发是必不可少的。从某种程度上说，系统文档本身也可视为一个系统。因此，文档开发可以采用与软件开发类似但更为简单的方法，创建用例并开发文档的用户界面是很有意义的。

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

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

2. 用户文档开发的重要性与时间规划

用户文档的开发往往被推迟到项目的最后阶段，这是一种危险的策略。开发高质量的文档所需的时间比许多人预期的要长，因为它不仅仅是写几页内容那么简单。生成文档需要进行文档设计（无论是纸质还是在线）、撰写文本、编辑文档以及测试文档。对于高质量的文档，纸质文档通常每页（单倍行距）大约需要三个小时，而在线文档每个屏幕大约需要两个小时。例如，一个十页的用户手册和一套二十个帮助屏幕的“简单”文档，大