软件产品使用说明书格式样本.doc

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出错解决和恢复
列出由软件产生出错编码或条件以及应由顾客承担修改纠正工作。指出为了保证再启动和恢复能力，顾客必要遵循解决过程。