1、文档设计单位 文档编写日期 以上使用正文题目,宋体,小三号,加粗;段前0.5行,段后0.5行,居中 更新历史 编写人 日期 版本号 变更内容 表格中的行标题文字:居左,无缩进,宋体,五号,加粗;单倍行距;段前0磅,段后0磅; 表格中的列标题文字:居中,宋体,五号,加粗; 表格中的正文文字:居左,无缩进,宋体,五号,常规;段前0磅,段后0磅 模板版本V2.5 第3页,共14页 正文题目:段前0.5行,段后0.5行,居中,采用Word自动生成目录,生成到三级标题1. 引言 . 5 1.1 编写目的 . 5 1.1.1 背景 . 5 1.2 主要业务名词和术语定义 . 5 1.3 参考文献 * .
2、5 1.4 文档组织 . 5 2. 系统概述 . 6 2.1 系统简介 . 6 2.2 系统功能简介 . 6 2.3 系统运行环境 . 6 2.3.1 软件环境 . 6 2.3.2 硬件环境 . 6 3. 系统基本操作说明 . 6 3.1 概述 . 6 3.2 系统登录 . 6 3.3 菜单介绍 . 6 3.4 界面显示特性 . 7 3.5 鼠标通用操作 . 7 3.6 键盘通用操作 . 7 3.7 退出系统 . 7 4. 系统操作说明 . 7 4.1 概述 * . 7 4.2 模块名称1 . 7 4.3 模块名称2 . 8 5. 操作说明 * . 8 6. 附录 * . 8 6.1 错误提示
3、信息 . 8 6.2 命令速查表 . 8 6.3 数据文件格式 . 8 6.4 其它信息 . 8 模板版本V2.5 第4页,共14页 1. 引言 宋体,小三号,加粗;段前13磅,段后13磅,与下段同页;1级 引言部分应包括:1.1 编写目的 宋体,四号,加粗;段前13磅,段后13磅,与下段同页,段中不分页,2级 主要说明本文档的作用,指出读者对象(通常为授权使用本系统的系统管理员、业务操作员等)。1.1.1 背景 宋体,小四号,加粗;段前13磅,段后13磅,与下段同页,段中不分页,3级 主要说明该手册所描述的软件系统的名称;本项目的任务提出者、开发者、用户等。 1.2 主要业务名词和术语定义
4、对本文档中所使用的专业或行业术语所指对象或含义进行解释性的说明,特别是对在本文档中为描述业务方便而自行定义的一些名词如“*类别”、“*状态”等进行说明,在后文论述中可直接加以引用。1.3 参考文献 * 列明制定本文档所参考的资料清单(包括项目的立项报告、合同或招投标文件;软件开发计划;用户需求说明书;软件需求规格说明书;系统设计说明书;手册中引用的其它资料、采用的软件工程标准或软件工程规范),说明其作者和出版日期。编号 资料名称 简介 作者 日期 出版单位 1.4 文档组织 说明本手册的组织形式,特别应说明第四章具体操作说明的组织形式。如:在每个具体业务模块的操作说明中,按照“业务办理条件”、
5、“业务功能说明”、“操作步骤”、“业务处理结果”、“注意事项”等条目加以说明。其中,“业务办理条件”主要说明使用此功能模块的业务先决条件和进入方式;“业务功能说明”主要说明本业务模块所实现的功能,包含对数据处理的概述;“操作步骤”主要说明界面内容的分类、具体操作步骤的顺序、输入限制、业务分支选择等信息;“业务处理结果”主要说明本业务模块办理完毕后系统的处理结果。“注意事项”主要说明其他需要操作员注意的部分。模板版本V2.5 第5页,共14页 2. 系统概述 2.1 系统简介 主要说明系统实现的主要功能;系统所采用的主要技术。 2.2 系统功能简介 说明系统功能的划分,列举划分的子系统,对子系统
6、功能做简短说明,说明子系统的功能划分,列明子系统所包含的下一级业务处理单元。 2.3 系统运行环境 2.3.1 软件环境 说明为运行本软件所需要的支持软件,如:, 操作系统的名称、版本号 , 程序语言的编译,汇编系统的名称和版本号 , 数据库管理系统的名称和版本号 , 中间件平台的名称和版本号 , 其他支持软件 2.3.2 硬件环境 列出软件系统运行时所需的硬件最小配置,如:, 计算机型号、主存容量 , 外存储器、媒体、记录格式、设备型号及数量 , 输入、输出设备 , 数据传输设备及数据转换设备的型号及数量 3. 系统基本操作说明 3.1 概述 3.2 系统登录 描述系统启动、登录的实际操作步
7、骤,并适当附上实际界面。 3.3 菜单介绍 描述各菜单及子菜单的结构。模板版本V2.5 第6页,共14页 操作手册 3.4 界面显示特性 说明界面的共性。如相同名称按钮的共同含义,常见的提示信息说明、如何切换页面等。 3.5 鼠标通用操作 介绍鼠标的操作,包括鼠标的拖放动作和指针状态的描述等 3.6 键盘通用操作 描述通过键盘操作系统的方法,包括正常输入和系统提供的快捷方式等 3.7 退出系统 描述如何退出系统的实际操作步骤 4. 系统操作说明 是操作手册的主体,应详细介绍软件的功能与实际操作步骤。对于不同的子系统,可以分不同的章节进行介绍。4.1 概述 * 若分不同的章节对子系统进行介绍,则
8、应首先说明如何启动该子系统。是否与前一章概述重复, 4.2 模块名称1 可以参考下面的内容,对模块进行具体的描述:, 业务办理条件:主要说明使用此功能模块的业务先决条件和进入方式;, 业务功能说明:主要说明本业务模块所实现的功能;, 操作步骤(启动,输入信息,点击按钮,结束):主要说明界面内容的分类、具体操作步骤的顺序、输入限制、业务分支选择等信息;, 业务处理结果:主要说明本业务模块办理完毕后系统的处理结果(如输出信息,在哪个模块可以查询到相关的处理结果等);, “注意事项”:主要说明其他需要操作员注意的部分。模板版本V2.5 第7页,共14页 操作手册 4.3 模块名称2 5. 操作说明 * 6. 附录 * 在操作手册中,有些知识和信息可以通过附录的形式提供
copyright@ 2008-2022 冰豆网网站版权所有
经营许可证编号:鄂ICP备2022015515号-1