说明编写这份用户手册的目的,指出预期的读者。
说明:
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
列出有用的参考资料,如:
结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。
逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度,包括传输中的精度要求。
定量地说明本软件的时间特性,如响应时间,更新处理时间,数据传输、转换时间,计算时间等。
说明本软件所具有的灵活性,即当用户需求(如对操作方式、运行环境、结果精度、时间特性等的要求)有某些变化时,本软件的适应能力。
说明本软件在安全、保密方面的设计考虑和实际达到的能力。
列出为运行本软件所要求的硬设备的最小配置,如:
说明为运行本软件所需要的支持软件,如:
列出为支持本软件的运行所需要的数据库或数据文卷。
在本章,首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。
一步一步地说明为使用本软件而需进行的安装与初始化过程,包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。
规定输入数据和参量的准备要求。
说明输入数据的现实背景,主要是
说明对初始输入数据和参量的格式要求,包括语法规则和有关约定,如:
为每个完整的输入形式提供样本,包括:
说明输出数据的现实背景,主要是:
给出对每一类输出信息的解释,主要是:
为每种输出类型提供例子。对例子中的每一项,说明:
这一条的编写针对具有查询能力的软件,内容包括:同数据库查询有关的初始化、准备、及处理所需 要的详细规定,说明查询的能力、方式,所使用的命令和所要求的控制规定。
列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力,用户必须遵循的处理过程。
当软件是在多终端系统上工作时,应编写本条,以说明终端的配置安排、连接步释、数据和参数输入步骤以及控制规定.说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程序等。