软件用户手册模板.doc

.软件用户手册模板 PAGE PAGE 1 ———————————————————————————————— 作者： ———————————————————————————————— 日期： xxx公司技术文件 第 册 共 册 本册共 页 文件名称：XXX软件用户手册 文件编号：XXX-B16-XXXXXX 项目名称： 项目编号： 物料编码： 版 本 号： 文件密级：秘密 文件状态：CFC 受控标识：受控 拟制： 年 月 日 审核： 年 月 日 会签： 批准： 年 月 日 文件发放范围： ×××－××－×××××× ××××××× ×/×× ××× PAGE I 修订页 序号 版本号 修订内容简述 拟制/日期 审核 批准 A B PAGE I 引言 版权声明 版权声明，并说明相关的字样徽标。 编写目的、版本、面向用户 说明： 该用户手册所描述的软件系统的名称； 该软件手册的版本、使用对象、编写目的。 特殊说明 列出该手册中用到的专门术语的定义和外文首字母组词的原词组以及特殊图标的说明。 目 录 TOC \o 1-3 \h \z \u 引言 I 版权声明 I 编写目的、版本、面向用户 I 特殊说明 I 1产品概述 1 1.1 功能概述 1 1.2 运行环境 1 1.2.1 硬件环境 1 1.2.2 软件环境 1 1.2.3 数据结构 1 1.3 软件安装 1 2 软件使用介绍 1 2.1 概述 1 2.2 运行界面 1 2.2.1 运行情况 1 2.2.2 输出格式 1 2.2.3 其他说明 2 3 使用举例 2 4 常见问题处理 2 5 相关文件 2 第 PAGE 2页，共 页 1产品概述 功能概述 结合本软件产品的开发目的逐项地说明本软件所具有各项功能、适用范围、特性、本软件的适应能力等。 运行环境 硬件环境 列出为运行该软件产品所要求的硬设备的最小配置，如： 处理机的型号、内存容量； 所要求的外存储器、媒体、记录格式、设备的型号规格和台数、联机／脱机； 软件环境 说明为运行本软件所需要的支持软件，如： 操作系统的名称、版本号； 程序语言的编译／汇编系统的名称和版本号； 数据库管理系统的名称和版本号； 其他支持软件。 数据结构 列出为支持本软件的运行所需要的数据库或数据文卷。 软件安装 安装与初始化：逐步说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。 软件使用介绍 概述 整体上对该软件的说明，罗列该软件的运行中需要注意的一些参数、设置。 运行界面 介绍软件的运行界面的结构、特色、操作等。 运行情况 针对软件运行后的使用流程，主要是 具体使用方法 正常情况的处理 限制 特殊情况的处理 输出格式 说明对软件运行的结果的格式要求，包括语法规则和有关约定，如： 长度—一例如字符数／行，字符数／项； 格式基准——例如以左面的边沿为基准； 标号——例如标记或标识符； 顺序——例如各个数据项的次序及位置； 标点——例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等。 词汇表——给出允许使用的字符组合的列表，禁止使用＊的字符组合的列表等； 其他说明 3 使用举例 4 常见问题处理 列出由软件产生时的修改纠正工作。指出为了确保再启动和恢复的能力，用户必须遵循的处理过程。 5 相关文件 《软件用户手册编写规范》 《软件用户手册检查单》