用户手册 (用户手册)

用户手册

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

基本介绍

中文名：用户手册外文名：user handset属于：详细描述软体的功能目的：用户了解如何使用该软体定义：专门术语定义和缩写词的原意

内容

编写内容要求如下。(1)引言①编写目的：阐明编写手册的目的，指明读者对象。②项目背景：说明项目的来源、委託单位、开发单位及主管部门。③定义：列出手册中用到的专门术语定义和缩写词的原意。④参考资料：列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，包括项目的计画任务书，契约或批文；项目开发计画；需求规格说明书；概要设计说明书；详细设计说明书；测试计画；手册中引用的其他资料、採用的软体工程标準或软体工程规範。(2)软体概述①目标。②功能。③性能。包括数据精确度(包括输入、输出及处理数据的精度)，时间特性(如回响时间、处理时间、数据传输时间等)，灵活性(在操作方式、运行环境需做某些变更时软体的适应能力)。(3)运行环境①硬体：列出软体系统运行时所需的硬体最小配置，如计算机型号、主存容量；外存储器、媒体、记录格式、设备型号及数量；输入、输出设备；数据传输设备及数据转换设备的型号及数量。②支持软体：作业系统名称及版本号；语言编译系统的名称及版本号；资料库管理系统的名称及版本号；其他必要的支持软体。(4)使用说明①安装和初始化：给出程式的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软体开发工具等。②输入：给出输入数据或参数的要求。③输出：给出每项输出数据的说明。④出错和恢复：出错信息及其含义、用户应採取的措施，如修改、恢复、再启动等。⑤求助查询：说明如何操作。(5)运行说明①运行表：列出每种可能的运行情况，说明其运行目的。②运行步骤：按顺序说明每种运行的步骤，应包括运行控制；操作信息(运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项)；输入/输出档案(给出建立和更新档案的有关信息，如档案的名称及编号、记录媒体、存留的目录、档案的支配[说明确定保留档案或废弃档案的準则，分发档案的对象，占用硬体的优先权及保密控制等])；启动或恢复过程。(6)非常规过程：提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。(7)操作命令一览表：按字母顺序逐个列出全部操作命令的格式、功能及参数说明。(8)程式档案(或命令档案)和数据档案一览表：按档案名称字母顺序或按功能与模组分类顺序逐个列出档案名称称、标识符及说明。(9)用户操作举例。

测试

用户手册是用户文档中最重要的一部分，下面详细介绍用户手册测试的要点。1．用户手册的完整性重点考察用户手册内容的全面性与完整性，从总体上把握用户手册的质量。这一项看似简单，但在实际测试中很多开发者还是无法做到这一基本标準。很多软体由于开发过于仓促，在付诸使用时，用户手册中缺少关于某些模组的说明，让用户使用起来比较困难。优秀的用户手册内容应该是包括软体的所有功能模组。2．用户手册的描述与软体实际功能的一致性考察用户手册与软体实际功能的一致程度。当确认用户手册基本完整后，还要注意用户手册与实际功能描述是否一致。这种问题往往是由于用户手册跟不上软体版本的更新速度造成的。对用户来说，容易造成对描述不一致的功能的误解和疑惑，进而影响用户对软体的使用。优秀的用户手册应该根据软体的升级而及时更新，手册描述应该与软体实际功能保持一致。3．用户手册的易理解性考察用户手册对关键、重要的操作有无图文说明，文字、图表是否易于理解。对于关键、重要的操作仅仅只有文字说明肯定是不够的，应该附以图表使说明更为直观、明了。优秀的用户手册应该是图文并举，易于理解。4．用户手册提供学习操作的实例考察对主要功能和关键操作提供的套用实例是否丰富，提供的实例描述是否详细。当前大量软体的用户手册只有简单的图文说明，而无套用实例。这样的用户手册看起来就像是软体界面的简单複製，对于用户来说，实际上没有什幺帮助。例如财务软体，用户手册就应该提供具体建账实例及具体账务处理的实例，这样才能使用户看完用户手册后，能够独立完成新账簿的建立并逐渐学会使用软体处理账务信息。优秀的用户手册不仅要对主要功能和关键操作提供套用实例，而且对实例的描述应做到详细、充分，易于用户理解。5．用户手册的印刷与包装质量考察用户手册包装的商品化程度，印刷质量。有些用户手册是简单列印、装订而成，过于粗糙，不易于用户保存。优秀的用户手册应提供商品化包装，并且印刷精美。在对用户手册进行测试时，应该拿着它坐在计算机前，认真的进行如下操作。(1)準确按照手册描述使用程式。(2)尝试每一条建议。(3)检查每条陈述。(4)查找容易误导用户的内容。

案例

案例：软体产品“用户手册”的标準档案