软件产品使用说明书格式模板.doc

软件产品使用说明书格式

10

资料内容仅供参考，如有不当或者侵权，请联系本人改正或者删除。

NBC可视化协同办公系统
使用说明书

文件状态:
【 】草稿
【 】正式发布
【√】正在修改
项目名称
Project
文档名称
使用说明书
文件标识
YGWY-Project- PM-UM
当前版本
V0.1
作者
欧顺寅
完成时间
YYYY-MM-DD
页数

密级
中

北京阳光伟业科技发展有限公司
5月

文档控制
修改记录

起止日期
修改类型*
作者
参与者
版本
备注
YYYY-MM-DD——YYYY-MM-DD
A

V0.1

* 修改类型分为 A—Added M—Modified D—Deleted

审阅人
姓名
职位
审阅签字

存档
存档号
地点/位置
备注

姓名
职位
审阅签字

目录
1 概述 4
1.1背景 4
1.2应用领域与使用对象 4
1.4参考资料 4
1.5术语与缩写解释 4
2 系统综述 4
2.1系统结构 4
2.2系统功能简介 5
2.3性能 5
2.4版权声明 5
3 运行环境 5
3.1硬件设备要求 5
3.2支持软件 5
3.3数据结构 5
4 系统操作说明 6
4.1安装与初始化 6
4.2子模块名称1 6
4.2.1业务需求描述 6
4.2.2界面截屏以及界面字段解释 6
4.2.3操作说明 6
4.3子模块名称2 6
4.3.1业务需求描述 6
4.3.2界面截屏以及界面字段解释 6
4.3.3操作说明 7
4.4出错处理和恢复 7

1 概述
1.1背景
系统的开发背景和编写这个手册的目的。
1.2应用领域与使用对象
描述软件所能使用的领域以及使用对象等。
1.4参考资料
列出有关资料的作者、 标题、 编号、 发表日期、 出版单位或资料来源, 可包括
Ø 与该产品有关的已发表的资料
Ø 文档中所引用的资料, 所采用的软件标准或规范或业务规则
编号
资料名称
简介
作者
日期
出版单位

列出编写本说明书时查阅的Internet上杂志、 专业著作、 技术标准以及她们的网址
网址
简介

1.5术语与缩写解释
列出本文中用到的专门术语的定义
缩写、 术语
解释

2 系统综述
2.1系统结构
结合系统所具有的功能包括输入、 处理和输出提供该软件的总体结构图表。
2.2系统功能简介
结合本软件的开发实际逐项地说明本软件所有具有各项功能。
2.3性能
给出一般情况下的运行性能指数等。
2.4版权声明
声明版权所有者以及盗版应承当的法律责任。
3 运行环境
3.1硬件设备要求
列出本软件所要求的硬设备的最小配置, 如:
1、 处理器的型号、 内存、 硬盘容量;
2、 所要求的外存储器、 媒体、 记录格式、 设备的型号和台数、 联机/脱机;
3、 I/O设备( 联机/脱机) ;
4、 数据传输设备和转换设备的型号、 台数
3.2支持软件
说明为运行本软件所需要的支持软件, 如:
1、 操作系统的名称、 版本号;
2、 程序语言的编译/汇编系统的名称和版本号;
3、 数据库系统的名称和版本号;
4、 其它支持软件。
3.3数据结构
列出为支持本软件的运行所需要的数据库或数据问卷。

4 系统操作说明
首先用图表的形式说明软件的功能同系统的输入源机构、 输出接收机构之间的关系。
4.1安装与初始化
说明为使用本软件而需进行的安装与初始化过程, 包括程序的存储形式、 安装与初始化过程中的全部操作命令、 系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话, 还应说明安装过程中所需用到的专用软件。
4.2子模块名称1
4.2.1业务需求描述
描述该模块能实现什么业务功能
4.2.2界面截屏以及界面字段解释
对设计到该子模块功能的所有UI界面进行截屏, 并在各个截屏之后对页面上的字段业务含义进行解释。
4.2.3操作说明
对该子模块的用户操作做一个详细的说明, 尽量包含界面上的各个按钮和链接, 并对该操作以后会出现什么结果, 达到什么功能详加说明。此处为用户手册的重点部分, 如果有必要的话, 此处能够分为很多更小的模块来分别进行操作说明。
4.3子模块名称2
4.3.1业务需求描述
描述该模块能实现什么业务功能
4.3.2界面截屏以及界面字段解释
对设计到该子模块功能的所有UI界面进行截屏, 并在各个截屏之后对页面上的字段业务含义进行解释。
4.3.3操作说明
对该子模块的用户操作做一个详细的说明, 尽量包含界面上的各个按钮和链接, 并对该操作以后会出现什么结果, 达到什么功能详加说明。此处为用户手册的重点部分, 如果有必要的话, 此处能够分为很多更小的模块来分别进行操作说明。
4.4出错处理和恢复
列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力, 用户必须遵循的处理过程。