项目名称 用户操作手册 部门: 项目: 密级: 日期:
编写说明
类别:项目文档 密级: 撰稿人: 修改人:
存放位置: 编辑软件:
版本信息:
版本 修改点说明
目录1页
目录
1
引言 ....................................................................................................................................... 1-1 1.1 1.2 1.3 1.4 2
编写目的 ................................................................................................................... 1-1 项目背景 ................................................................................................................... 1-1 术语定义 ................................................................................................................... 1-1 参考资料 ................................................................................................................... 1-1
软件概述 ............................................................................................................................... 2-3 2.1 2.2 2.3
目标 ........................................................................................................................... 2-3 功能 ........................................................................................................................... 2-3 性能 ........................................................................................................................... 2-3
3 运行环境 ............................................................................................................................... 3-4 3.1 3.2
硬件 ........................................................................................................................... 3-4 支持软件 ................................................................................................................... 3-4
4 使用说明 ............................................................................................................................... 4-5 4.1 4.2 4.2.1 4.2.2 4.2.3 4.3 4.3.1 4.3.2 4.3.3 4.4 4.5
安装和初始化 ........................................................................................................... 4-5 输入 ........................................................................................................................... 4-5
数据背景 ....................................................................................................... 4-5 数据格式 ....................................................................................................... 4-5 输入举例 ....................................................................................................... 4-6
输出 ........................................................................................................................... 4-6
数据背景 ....................................................................................................... 4-6 数据格式 ....................................................................................................... 4-6 举例 ............................................................................................................... 4-6
出错和恢复 ............................................................................................................... 4-6 求助查询 ................................................................................................................... 4-6
5 运行说明 ............................................................................................................................... 5-7
目录2页
5.1 5.2 5.2.1 5.2.2 5.2.3 5.2.4 6 7 8 9
运行表 ....................................................................................................................... 5-7 运行步骤 ................................................................................................................... 5-7
运行控制 ....................................................................................................... 5-7 操作信息 ....................................................................................................... 5-7 输入/输出文件 ........................................................................................... 5-7 启动或恢复过程 ........................................................................................... 5-8
非常规过程 ........................................................................................................................... 6-9 操作命令一览表 ..................................................................................................................6-10 程序文件(或命令文件)和数据文件一览表 ....................................................................... 6-11 用户操作举例 ......................................................................................................................6-12
目录3页
1 引言
1.1 编写目的
阐明编写手册的目的,指明读者对象。
1.2 项目背景
说明项目来源、委托单位、开发单位及主管部门。
1.3 术语定义
列出手册中使用的专门术语的定义和缩写词的原意。
序号 缩略语 说明/定义 英文全称 中文译名 1.4 参考资料
列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括: a. 项目的计划任务书、合同或批文; b. 项目开发计划; c. 需求规格说明书; d. 概要设计说明书; e. 详细设计说明书; f. 测试计划;
g. 手册中引用的其他资料、采用的软件工程标准或软件工程规范。
1-1页
文档编号 文档名称 作者/修订者 版本号 备注 其它
编号 文档名称 作者/修订者 发布日期 出版单位 备注 1-2页
2 软件概述
2.1 目标
2.2 功能
2.3 性能
a. 数据精确度 [包括输入、输出及处理数据的精度] b. 时间特性 [如响应时间、处理时间、数据传输时间等] c. 灵活性 [在操作方式、运行环境需做某些变更时软件的适应能力]
2-3页
3 运行环境
3.1 硬件
列出软件系统运行时所需的硬件最小配置,如
a. 计算机型号、主存容量
b. 外存储器、媒体、记录格式、设备型号及数量; c. 输入、输出设备;
d. 数据传输设备及数据转换设备的型号及数量。
3.2 支持软件
a. 操作系统名称及版本号;
b. 语言编译系统或汇编系统的名称及版本号; c. 数据库管理系统的名称及版本号; d. 其他必要的支持软件;
3-4页
4 使用说明
4.1 安装和初始化
给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。
4.2 输入
给出输入数据或参数的要求。
4.2.1 数据背景
说明数据来源、存储媒体、出现频度、限制和质量管理等。
4.2.2 数据格式
如:
a. 长度; b. 格式基准; c. 标号; d. 顺序; e. 分隔符; f. 词汇表; g. 省赂和重复; h. 控制
4-5页
4.2.3 输入举例
4.3 输出
给出每项输出数据的说明
4.3.1 数据背景
说明输出数据的去向、使用频度、存放媒体及质量管理等。
4.3.2 数据格式
详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。
4.3.3 举例
4.4 出错和恢复
给出:
a. 出错信息及其含意;
b. 用户应采取的措施,如修改、恢复、再启动。
4.5 求助查询
说明如何操作。
4-6页
5 运行说明
5.1 运行表
列出每种可能的运行情况,说明其运行目的。
5.2 运行步骤
按顺序说明每种运行的步骤,应包括以下步骤:
5.2.1 运行控制
5.2.2 操作信息
a. 运行目的; b. 操作要求; c. 启动方法; d. 预计运行时间; e. 操作命令格式及说明; f. 其他事项。
5.2.3 输入/输出文件
给出建立或更新文件的有关信息,如:
a. 文件的名称及编号; b. 记录媒体; c. 文件的保存目录; d. 文件的支配
说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保
5-7页
密控制等。
5.2.4 启动或恢复过程
5-8页
6 非常规过程
提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作 以及维护人员须知的操作和注意事项。
6-9页
7 操作命令一览表
按字母顺序逐个列出全部操作命令的格式、功能及参数说明。
6-10页
8 程序文件(或命令文件)和数据文件一览表
按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。
6-11页
9 用户操作举例
6-12页
因篇幅问题不能全部显示,请点此查看更多更全内容