用户手册编写规范.doc

案卷号 日期 ＜项目名称＞ 用 户 手 册 作 者 完成日期 签 收 人 签收日期 修改情况记录 版本号 修改批准人 修改人 安装日期 签收人 用户手册编写规范 目录 1 引言1 1.1 编写目的1 1.2 背景1 1.3 定义1 1.4 参考资料1 2 用途1 2.1 功能1 2.2 性能2 2.2.1 精度2 2.2.2 时间特性2 2.2.3 灵活性2 2.3 安全保密2 3 运行环境2 3.1 硬设备2 3.2 支持软件3 3.3 数据结构3 4 使用过程3 4.1 安装与初始化3 4.2 输入3 4.2.1 输入数据的现实背景3 4.2.2 输入格式4 4.2.3 输入举例4 4.3 输出5 4.3.1 输出数据的现实背景5 4.3.2 输出格式5 4.2.3 输出举例5 4.4 文卷查询5 4.5 出错处理和恢复6 4.6 终端操作6 用户手册编写规范 1 引言 1.1 编写目的 说明编写这份用户手册的目的，指出预期的读者范围。 1.2 背景 说明 a． 这份用户手册所描述的软件系统的名称； b． 列出本项目的任务提出者、开发者、用户（或首批用户）以及安装该软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如 a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其他已发表的文件； c． 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 用途 2.1 功能 结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。 2.2 性能 2.2.1 精度 逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度要求。 2.2.2 时间特性 定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。 2.2.3 灵活性 说明本软件所具有的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时间特性等的要求）有某些变化时，本软件的适应能力。 2.3 安全保密 说明本软件在安全、保密方面的设计考虑和实际达到的能力。 3 运行环境 3.1 硬设备 列出为运行本软件所要求的硬设备的最小配置，如 a． 处理机的型号、内存容量； b． 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机＼脱机； c． I＼O设备（联机＼脱机）； d． 数据传输设备和转换设备的型号、台数。 3.2 支持软件 说明为运行本软件所需要的支持软件，如 a． 操作系统的名称、版本号； b． 程序语言的编译＼汇编系统的名称和版本号； c． 数据库管理系统的名称和版本号； d． 其他支持软件。 3.3 数据结构 列出为支持本软件的运行所需要的数据库或数据文卷。 4 使用过程 在本章，首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。 4.1 安装与初始化 一步一步地说明为使用使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复、表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。 4.2 输入 规定输入数据和参量的准备要求。 4.2.1 输入数据的现实背景 说明输入数据的现实背景，主要是 a． 情况例如人员变动、库存缺货； b． 情况出现的频度例如是周期性的、随机的、一项操作状态的函数； c． 情况来源例如人事部门、仓库管理部门； d． 输入媒体例如键盘、穿孔卡片、磁带； e． 限制出于安全、保密考虑而对访问这些输入数据所加的限制； f． 质量管理例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，如建立出错情况的记录等； g． 支配例如如何确定输入数据是保留还是废弃，是否要分配给其他的接受者等。 4.2.2 输入格式 说明对初始输入数据和参量的格式要求，包括语法规则和有关约定，如 a． 长度例如字符数＼行，字符数＼项； b． 格式基准例如以左面的边沿为基准； c． 标号例如标记或标识符； d． 顺序例如各个数据项的次序及位置； e． 标点例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等； f． 词汇表给出允许使用的字符组合的列表，禁止使用的字符组合的列表等； g． 省略和重复给出用来表示输入元素可省略或重复的表示方式； h． 控制给出用来表示输入开始或结束的控制信息。 4.2.3 输入举例 为每个完整的输入形式提供样本，包括 a． 控制或首部例如用来表示输入的种类和类型的信息，标识符输入日期，正文起点和对所用编码的规定； b． 主体输入数据的主体，包括数据文卷的输入表述部分； c． 尾部用来表示输入结束的控制信息，累计字符总数等； d． 省略指出哪些输入数据是可省略的； e． 重复指出哪些输入数据是重复的。 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 文卷查询 这一条的编写针对具有查询能力的软件，内容包括同数据库查询有关的初始化、准备、及处理所需要的详细规定，说明查询的能力、方式、所使用的命令和所要求的控制规定。 4.5 出错处理和恢复 列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力，用户必须遵循的处理过程。 4.6 终端操作 当软件是在多终端系统上工作时，应编写本条，以说明终端的配置安排、连接步骤、数据和参数输入步骤以及控制规定，说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程序等。 第 6 页