编写软件用户手册的指南

1简介

1.1写作目的

1.2背景

1.3定义

1.4参考

2次使用

2.1功能

2.2性能

2.2.1精度

2.2.2时间特征

2.2.3灵活性

2.3安全保密

3个操作环境

3.1硬设备

3.2支持软件

3.3数据结构

4个使用过程

4.1安装和初始化

4.2输入

4.2.1输入数据的现实背景

4.2.2输入格式

4.2.3输入示例

4.3输出说明每个输出

4.3.1输出数据的现实背景

4.3.2输出格式

4.3.3输出示例

4.5错误处理和恢复

4.6终端操作

用户手册（GB8567——88）

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. 媒体打印，CRI显示，磁带，卡，磁盘，

d. 质量管理-例如，关于合理性检查和错误纠正的规定；

e. 支配地位-例如，如何确定输出数据是保留还是被丢弃，以及是否将其分发给其他接收者.

4.3.2输出格式对每种类型的输出信息进行了解释，主要是:

a. 第一部分，例如输出数据的标识，输出日期和输出编号；

b. 主体-输出信息的主体，包括列标题；

c. 尾巴-包括累计总数，结束标记.

4.3.3输出示例提供每种输出类型的示例. 对于示例中的每个项目，请解释:

a. 定义-每个输出消息的含义和目的；

b. 源是从特定的输入中提取的，是从文件中提取的，还是从软件的计算过程中提取的；

c. 特性-输出值范围，度量单位，在何种情况下可以默认设置等.

4.4本文查询是针对具有查询功能的软件编写的. 内容包括: 有关查询的初始化，准备和处理的详细要求，说明查询功能，方法，使用的命令以及所需的控制规则.

4.5错误处理和恢复列出了软件生成的错误代码或条件，以及用户应执行的更正和更正工作. 指出用户必须遵循的过程，以确保重新启动和恢复的能力.

4.6终端操作当软件在多终端系统上运行时，应写这篇文章来解释终端的配置安排，连接步骤，数据和参数输入步骤以及控制规则. 解释通过终端操作，语言，流程和辅助程序查询，检索和修改数据文件的功能.

本文来自电脑杂谈，转载请注明本文网址：
http://www.pc-fly.com/a/jisuanjixue/article-276714-1.html