08-软件用户手册

1 范  围

1.1  标  识

包含该文档所适用的软件标识号、标题和版本号。

1.2 系统概述

简述文档所适用的系统和软件的用途。应描述系统和软件的一般特性；概述系统开发、运行和维护的历史（若有）；标识项目的需方、用户、开发方和保障机构；标识当前的和计划的运行现场；列出其它相关文档。

1.3  文档概述

概述文档的用途（包括其来源、作用、是编写哪些文档的依据等）和主要内容，并描述与其使用有关的保密性或私密性要求。

2  引用文档

列出该文档中引用到的所有文档的编号、标题、修订版及日期。本章还应标识所有不能通过正常政府采购活动得到的文档的来源。

3  软件概述

3.1 软件应用

简要说明该软件期望的用途。描述其能力、操作上的改进和从软件的使用中得到的利益。

3.2 软件清单

标识为使该软件得以运行而必须安装的所有软件文件，包括数据库和数据文件。标识还应包括对每个文件的保密性和私密性考虑，还应标识在紧急情况下为继续或恢复运行所必需的软件。

3.3 软件环境

标识用户为了安装和运行该软件所必需的硬件、软件、手工操作及其它资源。通常应包括如下各项的标识：

a）必须提供的计算机设备，包括所需内存容量，所需辅存容量以及外部设备，例如打印机及其它输入/输出设备

b）必须提供的通信设备

c）必须提供的其它软件，例如操作系统、数据库、数据文件、实用程序及其它支撑系统

d）必须提供的表格、规程或其它手工操作

e）必须提供的其它设施、设备或资源

3.4  软件组织和操作概述

从用户的观点提供该软件的组织和操作的简要说明，通常该说明应包含：

a）从用户观点看的软件逻辑组成，以及每个成分的用途/操作概述

b）用户期望的性能特征，例如：

1）所接收输入的类型、数量和速率

2）该软件所产生输出的类型、数量、精度、速率

3）典型的响应时间和影响它的因素

4）典型的处理时间和影响它的因素

5）诸如可追踪的事件数等的限制

6）预期的出错率

7）预期的可靠性

c）该软件所执行的功能与所接口的系统、组织或席位的关系

d）可用于管理该软件的监督控制（例如口令）

3.5  意外情况以及替代的操作状态与方式

通常应阐述在紧急情况下和在不同的操作状态和方式下，用户使用该软件的差异。

3.6  保密性

概述与该软件相关的保密性考虑。通常应包括遇到软件或文档未经授权的复制时发出告警。

3.7 帮助及问题报告

指明使用该软件遇到问题时，从那里和履行什么手续便可获得帮助并报告问题。

4 访问软件

包含面向首次/临时用户的分步规程。应足够详尽，使得用户在学习软件的详细功能之前，能可靠地访问该软件。

4.1  软件的首次用户

4.1.1  熟悉设备

适当地说明下列各项：

a）加电和调整规程

b）显示屏的尺寸和能力

c）光标的外观，当显示多于一个光标时如何标识活动光标，如何定位光标，以及如何使用光标

d）键盘的布局，不同类型的键及指点设备的作用

e）关电规程，若需要特别的操作序列的话

4.1.2  访问控制

综述用户可见的软件访问和安全特性。通常应列出下列各项：

a）如何获得口令以及从谁那里获得口令

b）如何在用户的控制下增、删、改口令

c）与用户生成的输出报告或其它介质的储存和标记有关的保密性、私密性考虑

4.1.3  安装与设置

描述用户为了达到如下目的而应执行的所有规程：被标识或被授权在设备上访问或安装该软件，执行安装，配置该软件，删除或重写以前的文件或数据，键入供软件操作用的参数。

4.2 启动一次会话

提供开始工作的分步规程，包括任何可用的选项。给出问题判定检查表，以应付遇到的困难。

4.3  停止和暂停工作

描述用户如何才能停止或中断软件的使用，如何判定是否出现了正常的终止或停止。

5  处理参考指南

注：向用户提供使用该软件的规程。如果规程太复杂或太长，可以增加第6章，第7章，…其结构与本章相同，但采用有意义的章标题。本文档的组织依赖于被描述软件的特性。例如，一种方法是根据用户工作的组织、分配给他们的席位、他们的工作现场，或他们必须执行的任务等来分章节。而对另一软件来说，可能是第5章介绍菜单，第6章介绍所使用的命令语言，第7章介绍功能更好些。详细的规程最好在5.3节的子节中给出。根据软件的设计，这些子节可逐一地按功能、按菜单、按交易或按别的什么方式加以组织。应在适当处纳入用“警告”标志的安全提示。

5.1  能  力

简要说明交易、菜单、功能或其它处理的相互关系，以提供该软件的使用概述。

5.2  约  定

描述该软件所采用的任何约定，例如显示色彩、缩略语、以及命名或编码规则的使用。

5.3  处理规程

注：阐述以下各节的组织，例如是按功能、菜单，还是按屏幕来组织。执行这些规程的任何必要的顺序也应予以说明。

5.3.X （软件使用的一个方面）

标题应标识所要描述的功能、菜单、交易或其它处理。本节应对以下各项加以描述并给出适当的选择和例子：菜单，图标，数据录入表格，用户输入，可能会影响该软件与用户之间的接口的、来自其它软硬件的输入，输出，诊断或出错消息或告警，以及提供联机描述或导航信息的帮助设施。提供这些信息的格式可针对该软件的特点，但应使用一致的表现风格，即菜单的描述彼此要一致，交易的描述彼此也要一致。

5.4  相关处理

标识和描述不是由用户直接调用的，且未在5.3节中描述，而是由该软件执行的任何相关的批处理、脱机处理或后台处理。任何支持这类处理的用户职责也应予以指出。

5.5  数据备份

描述创建和维护备分数据的规程，备分数据可在错误、缺陷、故障或事故中被用来置换数据的主拷贝。

5.6  从错误、故障和紧急事件中恢复

提供在处理期间出现错误或故障时的重启或恢复规程，以及在紧急事件中确保操作的连续性的规程。

5.7 消  息

列出或引用附录列出执行任何用户功能期间可能出现的所有出错消息、诊断消息和通知消息。每个消息的含义和其出现后应采取的动作应予以标识和说明。

5.8  快速引用指南

通常应为使用该软件提供或引用一个快速引用卡或快速引用页。该快速引用指南通常应摘要指出经常使用的功能键、控制序列、格式、命令或软件使用的其它方面。