软件用户手册.docx

软件用户手册.docx

《软件用户手册.docx》由会员分享，可在线阅读，更多相关《软件用户手册.docx（8页珍藏版）》请在冰豆网上搜索。

软件用户手册

标识：

编号：

版本：

XX信息系统

XX系统技术文件

XXX软件

软件用户手册

公司名称

二○二年月

目次

范围

标识

本文档适用的软件：

a）软件标识：

；

b）软件名称：

；

c）软件简称：

；

d）软件版本号：

。

注1：

本节应包含本文档适用的系统和软件的完整标识，适用时，包括其标识号、名称、简称和版本号等。

其中版本号为本文档对应的软件的版本号。

注2：

在形成最后文档时，需要删除文档中所有的注。

系统概述

。

注：

本节应概述本文档所适用的系统和软件的用途，还应描述下列内容：

a）系统与软件的一般特性；

b）概述系统开发、运行和维护的历史；

c）标识项目的需方、用户、开发方和保障机构等；

d）标识当前和计划的运行现场；

e）列出其他有关文档。

文档概述

本文档适用于

注：

a）概括本文档的用途（包括其来源、作用、是编写哪些文档的依据等）；

b）概括本文档具体包括的主要内容；

c）描述与它的使用有关的私密性要求。

1引用文档

注1：

本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。

注2：

引用文件为必备的一般要素，其排列顺序为：

文件、法规、标准、工程规范；文件、法规按照国家、公司、部门顺序排列，标准、工程规范先按照代号的拉丁字母顺序排列，再按照顺序号排列。

注3：

表的格式如下：

a）表题与表内容在同一页，设置“与下段同页”选项，表头进行标题行重复；

b）表题置于表的编号之后，表的编号与表题之间空一个字，置于表上方居中位置，段前/段后0.5行，1.25倍行距；

c）表格采用封闭式，用细实线（0.5磅）；

d）表头用宋体5号，表中内容用宋体5号，段前/段后0.2行，单倍行距。

表1引用文档一览表

序号

文档标识

标题

修订版本

日期

编写单位/来源

1

2

3

软件综述

软件应用

注：

从以下几部分进行说明：

a）组成软件的各段的名称、前缀、版本和用途；

b）软件在能力、操作上的改进；

c）软件的使用人员；

d）软件的典型应用模式和部署方式，并配以示例图。

e）对软件主要实现的功能、特点进行简要的介绍

软件清单

注：

标识使软件运行而必须安装的所有软件文件（对每个段/构件需分别描述），包括数据库和数据文件。

可以在备注中每份软件文件的私密性和私密性要求进行说明。

操作系统等支持系统在3.3.2说明，此处主要描述软件本身的文件。

表2软件清单

软件名称

版本号

用途

备注

软件环境

注：

描述用户安装并运行该软件所需的硬件、软件、手工操作和其它的资源。

1.1.1硬件资源要求

表3硬件环境

序号

硬件名称

硬件型号

数量

用途

1

2

注：

用文字或下表说明软件运行所需的计算机设备，包括需要的内存数量、需要的辅存数量及外围设备（诸如打印机和其它的输入/输出设备）；以及必须提供的通信设备。

其中硬件型号中可以说明对硬件性能的要求，如内存容量、硬盘容量等。

1.1.2软件资源要求

表4软件环境

序号

软件名称

版本号

用途

1

2

注：

软件运行所需的其它软件，例如操作系统、数据库、数据文件、实用程序和其它的支持系统。

1.1.3手工操作资源要求

注：

说明软件运行所需提供的表格、规程或其他的手工操作。

1.1.4其它资源要求

注：

如存在的话，给出必须提供的其它设施、设备、网络、通讯等资源。

否则本节可省略。

软件组织和操作概述

表5软件组织和操作概述

序号

软件逻辑部件

用途/操作概述

用户期望的性能特性

备注

1

2

3

注：

本节从用户的角度出发，简要描述软件的组织与操作。

可包括该软件执行的功能与接口系统、组织或位置之间的关系；为管理软件而采取的监督措施（例如口令）等内容。

a）软件逻辑部件：

指从用户的角度来说明逻辑部件；

b）用途/操作概述：

简单描述相应内容，具体操作在第4节描述；

c）性能特征：

如输入的类型、数量、速度；输出的类型、数量、精度和速度；响应时间和影响因素；处理时间和影响因素；预计的错误率；预计的可靠性；

意外事故及运行的备用状态和方式

注：

（若适用）本条应说明在紧急时刻以及在不同运行状态和方式下用户处理软件的差异。

私密性

注：

本条应包含与该软件有关的私密性和私密性要求的概述。

（若适用）应包括对非法制作软件或文档拷贝的警告。

帮助和问题报告

注：

提供联系点和应遵循的手续，以便用户获得帮助和报告在使用软件时遇到的问题。

软件的版权

注：

介绍软件的版权所有者，如遇到非法复制软件可能的话应作出告警。

软件入门

注：

说明面向首次/临时的用户的逐步过程。

应向用户提供足够的细节，以使用户在学习软件的功能细节前能可靠的访问软件。

在合适的地方应包含用“警告”或“注意”标记的安全提示。

软件的首次用户

1.1.5熟悉设备

注：

（若适用）本条应描述软件使用前，需要相关硬件的设置。

可包含如下内容：

a）显示屏幕的大小，是否设置多屏；

b）相关硬件设备驱动的安装与设置。

1.1.6访问控制

注：

若适用，应说明有关软件初试权限的获得和设置，可包括：

怎样获得和从谁那里获得口令；如何在用户的控制下添加，删除或更改口令等内容。

否则，用“不适用”注明。

1.1.7安装与设置

注：

描述为标识或授权用户在设备上访问或安装软件，本条可分章节分别说明软件的安装、配置和卸载过程。

a）如果软件只能在集成框架下运行，应描述在集成框架下的安装、配置和卸载的步骤。

b）如果软件还可以离开集成框架单独运行，并且能实现完整的业务功能。

还应描述软件在单独运行时的安装、配置和卸载的步骤。

安装

安装前准备

注：

描述安装前的注意事项。

可包括：

安装人员的身份限制；对已有旧版本该软件的更新与卸载；以及其它安装前必须进行的配置等信息。

如没有该方面的需求，用“无”标明。

安装步骤

注：

逐步描述用户安装本软件的过程步骤。

如有可能，以图示并配以文字说明的形式进行。

安装后验证

注：

说明用户验证软件安装成功，并能正常使用的方法/标志。

设置

注：

描述用户安装完成软件后需进行的配置信息。

如license的配置；数据库的配置等方面。

根据实际情况可分小节进行。

启动过程

注：

提供开始启动软件开始工作的步骤，包括任何可用的选项。

停止和挂起工作

注：

描述用户如何停止或中断软件的使用和如何判断是否是正常结束或终止。

软件的重置与恢复

注：

本节描写软件中止运行后用户如何使软件重新启动、恢复运行。

卸载

注：

说明用户卸载已安装软件的方法。

卸载过程还应说明卸载软件后，需手工清除的软件临时文件、注册表信息、软件配置信息的删除方法，以保证用户能完全删除软件及其垃圾信息，不影响用户重新安装软件。

如有可能，以图示并配以文字说明的形式进行。

2使用指南

注：

本章应向用户提供使用软件的过程。

如果过程太长或太复杂，可按本章相同的段结构编制第6章，第7章……，如让第5章成为菜单的指南，让第6章成为使用的命令语言的指南，让第7章成为功能的指南等。

能力

注：

简述事务、菜单、功能或其它的处理相互之间的关系。

约定

注：

描述软件使用的任何约定，例如使用的颜色、使用的警告铃声、使用的缩略词语表和使用的命名或编码规则等。

处理规程

注：

以下各小节可按功能，菜单，屏幕组织。

应描述完成过程必需的次序。

2.1.1（软件的使用）

注：

a）从5.3.1开始编号，逐个描述软件使用的各方面，标题用被描述的功能，菜单，事务或其它的过程所替代。

b）描述时应并给出以下项的选项与实例，包括：

菜单、图标、数据项表、用户输入、可能影响软件与用户的接口的其它软硬件的输入、输出、诊断或错误消息、或报警和能提供联机描述或指导信息的帮助设施。

通常情况下应给出各操作步骤出现界面的实例，并说明完成的功能以及各界面所涉及的操作等内容。

c）用户需使用一种一致的描述风格，例如对菜单的描述应保持一致，对事务描述应保持一致。

描述风格要求规定如下：

菜单选项：

如，菜单“文件”；

进入下一级菜单选项：

如，菜单“文件”→“保存”；

按钮：

如，【确定】、【删除】。

有关的处理

注：

本节应标识和描述不是由用户直接调用的，且未在5.3节中描述，而是由该软件执行的相关的批处理、脱机处理或后台处理等。

数据备份

注：

如存在，描述创建和保留备份数据的过程，这些备份数据在发生错误、缺陷、误动作或事故时可以用来代替主要的数据拷贝。

否则，用“不适用”注明。

错误、故障和紧急情况下的恢复

注：

本条应给出从发生错误或故障中重启或恢复的详细规程，以及确保紧急事件下运行连续性的详细规程。

消息

注：

本节列出完成用户功能时可能发生的所有错误消息，诊断消息和信息消息，或引用列出这些消息的附录。

应标识和描述每一条消息的含义和消息出现后要采取的动作。

表6消息

消息类别

序号

消息名称

消息内容

消息含义

需采取的动作

错误消息

诊断消息

快速参考指南

注：

如存在，本节应概括常用的功能键、控制序列、格式、命令或软件使用的其它方面。

如相关信息已在5.3节描述，此处可引用或省略。

否则，用“不适用”注明。

3典型业务流程

注：

本条主要针对提供开发接口的软件和有界面的软件。

对于在运行过程中不需用户操作的服务软件，此节可省略。

本条应按用户的业务工作来组织，描述如何使用本软件执行最典型的业务流程。

当用户在实现某项业务工作时，需要软件的多个功能进行组合，此节要描述清楚多个功能的操作顺序和步骤，具体每个步骤的操作方法可引用5.3节中的相关章节。

例：

分步骤描述如何利用指挥所配置管理工具进行指挥所的开设过程，包括建立指挥所机构、部署服务器、客户机、分发软件、角色用户的授权等。

注释

注：

本章应包含有助于理解本文档的所有信息（例如背景、术语、缩略语或公式）。

附录

注：

附录可用来提供那些为便于文档维护而单独出版的信息（例如图表、分类数据）。

为便于处理，附录可单独装订成册。

附录应按数字顺序（1，2等）编排。