《用户手册》模板 - 1107(2)

用户手册编写规范

d． 输入媒体――例如键盘、穿孔卡片、磁带；

e． 限制――出于安全、保密考虑而对访问这些输入数据所加的限制；

f． 质量管理――例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，如建立出错情况的记录等；

g． 支配――例如如何确定输入数据是保留还是废弃，是否要分配给其他的接受者等。

4.2.2 输入格式

说明对初始输入数据和参量的格式要求，包括语法规则和有关约定，如：

a． 长度――例如字符数＼行，字符数＼项； b． 格式基准――例如以左面的边沿为基准； c． 标号――例如标记或标识符；

d． 顺序――例如各个数据项的次序及位置；

e． 标点――例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等；

f． 词汇表――给出允许使用的字符组合的列表，禁止使用的字符组合的列表等； g． 省略和重复――给出用来表示输入元素可省略或重复的表示方式； h． 控制――给出用来表示输入开始或结束的控制信息。

4.2.3 输入举例

为每个完整的输入形式提供样本，包括：

a． 控制或首部――例如用来表示输入的种类和类型的信息，标识符输入日期，正文起点和对所用编码的规定；

b． 主体――输入数据的主体，包括数据文卷的输入表述部分； c． 尾部――用来表示输入结束的控制信息，累计字符总数等； d． 省略――指出哪些输入数据是可省略的； e． 重复――指出哪些输入数据是重复的。

第 4 页

用户手册编写规范

4.3 输出

对每项输出作出说明。

4.3.1 输出数据的现实背景

说明输出数据的现实背景，主要是：

a． 使用――这些输出数据是给谁的，用来干什么； b． 使用频度――例如每周的、定期的或备查阅的； c． 媒体――打印、CRT显示、磁带、卡片、磁盘； d． 质量管理――例如关于合理性检验、出错纠正的规定；

e． 支配――例如如何确定输出数据是保留还是废弃，是否要分配给其他接受者等。

4.3.2 输出格式

给出对每一类输出信息的解释，主要是：

a． 首部――如输出数据的标识符，输出日期和输出编号； b． 主体――输出信息的主体，包括分栏标题； c． 尾部――包括累计总数，结束标记。

4.2.3 输出举例

为每种输出类型提供例子。对例子中的每一项，说明：

a． 定义――每项输出信息的意义和用途；

b． 来源――是从特定的输入中抽出、从数据库文卷取出、或从软件的计算过程中得到； c． 特性――输出的值域、计量单位、在什么情况下可缺省等。

4.4 文卷查询

这一条的编写针对具有查询能力的软件，内容包括：同数据库查询有关的初始化、准备、及处理所需要的详细规定，说明查询的能力、方式、所使用的命令和所要求的控制规定。

第 5 页

用户手册编写规范

4.5 出错处理和恢复

列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力，用户必须遵循的处理过程。

4.6 终端操作

当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排、连接步骤、数据和参数输入步骤以及控制规定，说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程序等。