用户手册

出自 MBA智库百科(https://wiki.mbalib.com/)

　　用户手册是详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

　　编写内容要求如下。

　　(1)引言

　　①编写目的：阐明编写手册的目的，指明读者对象。

　　②项目背景：说明项目的来源、委托单位、开发单位及主管部门。

　　③定义：列出手册中用到的专门术语定义和缩写词的原意。

　　④参考资料：列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，包括项目的计划任务书，合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划；手册中引用的其他资料、采用的软件工程标准或软件工程规范。

　　(2)软件概述

　　①目标。

　　②功能。

　　③性能。包括数据精确度(包括输入、输出及处理数据的精度)，时间特性(如响应时间、处理时间、数据传输时问等)，灵活性(在操作方式、运行环境需做某些变更时软件的适应能力)。

　　(3)运行环境

　　①硬件：列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量；外存储器、媒体、记录格式、设备型号及数量；输入、输出设备；数据传输设备及数据转换设备的型号及数量。

　　②支持软件：操作系统名称及版本号；语言编译系统的名称及版本号；数据库管理系统的名称及版本号；其他必要的支持软件。

　　(4)使用说明

　　①安装和初始化：给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件开发工具等。

　　②输入：给出输入数据或参数的要求。

　　③输出：给出每项输出数据的说明。

　　④出错和恢复：出错信息及其含义、用户应采取的措施，如修改、恢复、再启动等。

　　⑤求助查询：说明如何操作。

　　(5)运行说明

　　①运行表：列出每种可能的运行情况，说明其运行目的。

　　②运行步骤：按顺序说明每种运行的步骤，应包括运行控制；操作信息(运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项)；输入／输出文件(给出建立和更新文件的有关信息，如文件的名称及编号、记录媒体、存留的目录、文件的支配[说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等])；启动或恢复过程。

　　(6)常规过程：提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

　　(7)操作命令一览表：按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

　　(8)程序文件(或命令文件)和数据文件一览表：按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

　　(9)用户操作举例。

　　用户手册是用户文档中最重要的一部分，下面详细介绍用户手册测试的要点。

　　1．用户手册的完整性

　　重点考察用户手册内容的全面性与完整性，从总体上把握用户手册的质量。这一项看似简单，但在实际测试中很多开发者还是无法做到这一基本标准。很多软件由于开发过于仓促，在付诸使用时，用户手册中缺少关于某些模块的说明，让用户使用起来比较困难。优秀的用户手册内容应该是包括软件的所有功能模块。

　　2．用户手册的描述与软件实际功能的一致性

　　考察用户手册与软件实际功能的二致程度。当确认用户手册基本完整后，还要注意用户手册与实际功能描述是否一致。这种问题往往是由于用户手册跟不上软件版本的更新速度造成的。对用户来说，容易造成对描述不一致的功能的误解和疑惑，进而影响用户对软件的使用。优秀的用户手册应该根据软件的升级而及时更新，手册描述应该与软件实际功能保持一致。

　　3．用户手册的易理解性

　　考察用户手册对关键、重要的操作有无图文说明，文字、图表是否易于理解。对于关键、重要的操作仅仅只有文字说明肯定是不够的，应该附以图表使说明更为直观、明了。优秀的用户手册应该是图文并举，易于理解。

　　4．用户手册提供学习操作的实例

　　考察对主要功能和关键操作提供的应用实例是否丰富，提供的实例描述是否详细。当前大量软件的用户手册只有简单的图文说明，而无应用实例。这样的用户手册看起来就像是软件界面的简单复制，对于用户来说，实际上没有什么帮助。例如财务软件，用户手册就应该提供具体建账实例及具体账务处理的实例，这样才能使用户看完用户手册后，能够独立完成新账簿的建立并逐渐学会使用软件处理账务信息。优秀的用户手册不仅要对主要功能和关键操作提供应用实例，而且对实例的描述应做到详细、充分，易于用户理解。

　　5．用户手册的印刷与包装质量

　　考察用户手册包装的商品化程度，印刷质量。有些用户手册是简单打印、装订而成，过于粗糙，不易于用户保存。优秀的用户手册应提供商品化包装，并且印刷精美。

　　在对用户手册进行测试时，应该拿着它坐在计算机前，认真的进行如下操作。

　　(1)准确按照手册描述使用程序。

　　(2)尝试每一条建议。

　　(3)检查每条陈述。

　　(4)查找容易误导用户的内容。

　　案例：软件产品“用户手册”的标准档案

　　1.引言

　　1．1  编写目的

　　说明编写用户手册的目的，指出预期的读者。

　　1．2  背景

　　说明：

　　(1)用户手册所描述的软件系统的名称。

　　(2)该软件项目的任务提出者、开发者、用户(或首批用户)及安装此软件的计算中心。

　　1．3定义

　　列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

　　1．4  参考资料

　　列出有用的参考资料，例如：

　　(1)[[项目]]的经核准的计划任务书或[[合同]]、上级机关的批文。

　　(2)属于本项目的其他已发表文件。

　　(3)本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料的来源。

　　2.用途

　　2．1  功能

　　结合本软件的开发目的逐项地说明本软件所具有的各项功能以及它们的极限范围。

　　2．2  性能

　　2．2．1精度

　　说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度要求。

　　2．2．2时间特性

　　定量地说明本软件的时间特性，如响应时间、更新处理时间、数据传输和转换时间以及计算时间等。

　　2．2．3灵活性

　　说明本软件所具有的灵活性，即当用户需求(如对操作方式、运行环境、结果精度、时间特性等的要求)发生变化时，本软件的适应能力。

　　2．3安全保密

　　说明本软件在安全、保密方面的设计考虑和实际达到的能力。

　　3运行环境

　　3．1硬设备

　　列出为运行本软件所要求的硬设备的最小配置，例如：

　　(1)处理机的型号、内存容量。

　　(2)所要求的外存储器、[[媒体]]、记录格式、设备的型号和台数、[[联机]]／[[脱机]]。

　　(3)I／O设备(联机／脱机)。

　　(4)数据传输设备和转换设备的型号、台数。

　　3．2  支持软件

　　说明为运行本软件所需要的支持软件，例如：

　　(1)操作系统的名称和版本号。

　　(2)程序语言的编译／汇编系统的名称和版本号。

　　(3)[[数据库管理系统]]的名称和版本号。

　　(4)其他支持软件。

　　3．3[[数据结构]]

　　列出为支持本软件的运行所需要的数据库或数据文卷。

　　4.使用过程

　　在本章，首先用图表的形式说明软件的功能与系统的输入源机构、输出接收机乖之间的关系。

　　4．1  安装与初始化

　　按步骤说明因使用本软件而需进行的安装与初始化过程，包括程序的存储形式安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。
表征安装工千完成的测试实例等。如果有的话，还应说明安装过程中用到的[[专用软件]]。

　　4．2输入

　　规定输入数据和参量的准备要求。

　　4．2．1  输入数据的现实背景    ’

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

　　(1)情况，如人员变动、库存缺货。

　　(2)情况出现的频度，如是周期性的、随机的、一项操作状态的函数。

　　(3)情况来源，如人事部门、仓库管理部门。

　　(4)输入媒体，如键盘、穿孔卡片、磁带。

　　(5)限制，即出于安全和保密考虑而对访问这些输入数据所加的限制。

　　(6)[[质量管理]]，如对输入数据合理性的检验以及当输入数据有错误时应采取的措施，建立出错情况记录等。

　　(7)支配，如确定输入数据是保留还是废弃、是否要分配给其他的接受者等。

　　4．2．2输入格式

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

　　(1)长度，如字符数(行)、字符数(项)。

　　(2)格式基准，如以左面的边沿为基准。

　　(3)标号，如标记或标识符。

　　(4)顺序，如各个数据项的次序和位置。

　　(5)标点，如因表示行、数据组的开始或结束而使用的空格、斜线、星号和字符组等。

　　(6)词汇表，如给出允许使用的字符组合的列表，禁止使用六的字符组合的列表等。

　　(7)省略和重复，如给出用来表示输入元素可省略或重复的表示方式。

　　(8)控制，如给出用来表示输入开始或结束的[[控制信息]]。

　　4．2．3  输入举例

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

　　(1)控制或首部，如用来表示输入的种类和类型的[[信息]]、标识符输入日期，正文起点和对所用编码的规定。

　　(2)主体，输入数据的主体，包括数据文卷的输入表述部分。

　　(3)尾部，用来表示输入结束的[[控制信息]]，如累计字符总数等。

　　(4)省略，指出哪些输入数据是可省略的。

　　(5)重复，指出哪些输入数据是重复的。

　　4．3输出

　　4．3．1输出数据的现实背景

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

　　(1)使用，这些输出数据是给谁的，用来干什么。

　　(2)使用频度，如每周的、定期的被查阅的[[次数]]。

　　(3)媒体，如打印、CRI显示、磁带、卡片、磁盘。

　　(4)[[质量管理]]，如关于合理性检验、出错纠正的规定。

　　(5)支配，如确定输出数据是保留还是废弃，是否要分配给其他接受者等。

　　4.32 输出格式

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

　　(1)首部，如输出数据的标识符，输出日期和输出编号。

　　(2)主体，输出信息的主体，包括分栏标题。

　　(3)尾部，包括累计总数和结束标记。

　　4.3.3输出举例

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

　　(1)定义，如每项输出信息的意义和用途。

　　(2)来源，如从特定的输入中抽出、从数据库文卷中取出或从软件的计算过程中得到的。

　　(3)特性，如输出的值域、计量单位、在什么情况下可默认等。

　　4.4文件查询

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

　　4.5出错处理和恢复

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

　　4.6终端操作

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