当前位置:文档之家› 用户手册编写规范

用户手册编写规范

用户手册编写规范
文件编号:YF-09
版本号:V1.0
受控状态:受控
发放编号:
编制人:编制日期:审核人:审核日期:批准人:批准日期:
变更记录
注:对该文件内容增加、删除或修改均需填写此变更记录,详细记载变更信息,以保证其可追溯性。

写手册时将此变更记录删除。

手册格式
∙手册第二页插入目录
∙标题及字号
标题一黑体二号字
标题二黑体三号
标题三黑体小四
正文宋体五号
小标题宋体五号粗体
∙每章标题下加段下划线,可以复制粘贴过去
∙文中所有需要重点提醒的地方,使用备注方式,即文中的注意部分,使用文中现有的格式“注意”
∙每章标题(即标题一)前,插入分节符
∙文字行距为1.5倍
∙插入的图片加黑色边框,居中显示,大小不能超过页面边界
∙尽量使图片中文字显示清楚,必要时可以撑满页面宽度
∙页眉中插入域“styleref”,标题1,页脚插入“北京清华北方思路信息技术有限公司”
和页码,右对齐
手册封面
*******系统
1.0 版
使用手册
北京清华北方思路信息技术有限公司
2004年11月23日
系统概述
概述本文档所适用的软件和系统的用途。

系统目标
概述本文档的用途和内容。

系统特点
概述本系统突出特点。

运行环境
明确用户安装运行该软件必须的软、硬件环境以及其它相关资源。

必要时还应包括:
①必须列出的计算机设备,包括所需处理能力、内外存储器,以及其它存储设备和外部设备;
②必需的支撑软件,如操作系统、数据库、数据文件和其它支持软件;
③通讯设备;
④其它工具、设备和资源。

安装过程
对初次使用该软件的用户,提供足够详细的资料以便用户在学习软件的详细功能之前能够放心地使用该软件。

描述用户必须履行的一些程序如用户如何安装软件、配置软件、删除和覆盖原来的文件或数据、输入软件操作所需的参数。

卸载程序
描述卸载程序的方法及过程。

第三章***功能
从第二章开始详细介绍系统的各个功能,每个功能可以独自成为一个章节。

每个功能的介绍按下面的规范进行。

操作过程
叙述实现系统功能的详细操作过程。

必要时包括初始化数据、用户输入、用户输出、系统推出等详细信息。

初始化
叙述为执行软件用户所需执行的初始化过程以及初始化的可选项。

用户输入
叙述用户对软件的输入。

系统输出
叙述软件预期的输出,包括错误信息。

退出
叙述如何终止操作,并退出相应操作。

第四章出错信息
出错信息
标识软件的所有出错信息、每个出错信息含义和出现错误信息时应采用的动作。

第五章术语表及附录
术语表
叙述与使用本软件相关的,并为本软件所特有的术语。

附录
使用本软件所需要的一些必备的信息。

相关主题