新版软件公司用户手册编制规范模板.doc

用户手册编制规范

沈阳东大阿尔派软件股份

.2

版权申明
《用户手册编制规范》版权归沈阳东大阿尔派软件股份全部。未经沈阳东大阿尔派软件股份书面准许，不得将本规范任何部分以任何形式、采取任何手段(电子或机械，包含摄影复制或录制)、或为任何目标，进行复制或扩散。
(c)Copyright 沈阳东大阿尔派软件股份。版权全部，翻制必究。
是沈阳东大阿尔派软件股份注册商标。
Microsoft、word是Microsoft Corporation注册商标。
Windows是Microsoft Corporation商标。

前 言
用户手册对于任何产品全部是不可缺乏组成部分。一个好产品没有一份完备用户手册，也不能算作一个完备产品。对于软件产品来说更是如此，没有用户手册软件不能算产品，没有好用户手册，就不可能算好产品。也就是说，一个好软件产品除了含有和市场对路思想、良好用户界面、完备测试之外，还必需有一本适适用户使用用户手册。
本规范手册不仅指明了软件用户手册内容，而且要求了沈阳东大阿尔派软件股份软件用户手册统一版面、格式。本规范手册就是按本要求编写，但因为本规范手册内容不足，极难以样本形式表现软件用户手册中可能出现多种情况，所以请大家认真阅读本规范手册内容。
我们期望沈阳东大阿尔派软件股份相关人员，能够根据本规范手册编写自己软件用户手册，做好我们软件产品化工作。因为时间仓促，编者水平有限，期望大家能够提出宝贵意见，以逐步完善本规范手册内容。

阅读指南
〖手册目标〗
本手册关键对沈阳东大阿尔派软件股份软件产品用户手册所应包含内容及版面格式作一个初步统一要求。因为实际情况千变万化，本要求极难一次做到面面俱到，需要逐步完善。
〖阅读对象〗
本手册是为沈阳东大阿尔派软件股份全部软件开发人员和软件用户手册编写人员所编写。因为本手册中格式要求部分是依据 Microsoft Windows 下 Word 功效而编写，所以沈阳东大阿尔派软件股份软件用户手册应该使用 MicroSoft Word排版。
〖手册组成〗
本手册基础上由两部分组成：
第1章，“相关用户手册排版格式要求”，要求了用户手册标题及编号格式。
第2章，“用户手册内容”，要求了用户手册所应包含内容较为具体清单。
另外，本手册基础上是按“用户手册格式统一要求”编写一个样本。
〖手册约定〗
本手册遵照以下约定：
全部标题均使用黑体字。
假如标题后跟有“〖条件〗”字样，说明该标题下正文所要求内容是在一定条件下必需。
【注意】意思是请读者注意那些需要注意事项。
【警告】意思是请读者千万注意一些事项，不然将造成严重错误。

目 录

第1章 用户手册格式要求 1-1
§1.1 标题及编号 1-1
§1.1.1 章标题设置 1-1
§1.1.2 节标题设置 1-1
§1.1.3 小节标题设置 1-1
§1.1.4项目符号和编号设置 1-2
§1.1.5 其它编号设置 1-3

§1.2 正文及页眉页脚排版 1-4
§1.2.1 正文排版 1-5
§1.2.2 版面设置 1-5
§1.2.2.1 版面设置 1-5
§1.2.2.2 相关页眉、页脚设置 1-5
§1.2.2.3 注意和警告 1-5

第2章 用户手册内容 2-1
§2.1 用户手册目标 2-4
§2.2 用户手册内容 2-4
§2.2.1 封面 2-4
§2.2.2 二封 2-4
§2.2.3 版权申明 2-4
§2.2.4 序言 2-4
§2.2.5 阅读指南 2-5
§2.2.6目录 2-5
§2.2.7基础知识介绍〖条件〗 2-5
§2.2.8 系统安装及开启 2-6
§2.2.9 系统操作说明 2-7
§2.2.9 1 CAD软件 2-7
§2.2.9 2 其它软件 2-9
§2.2.10 系统及数据维护 2-9
§2.2.11 例题〖条件〗 2-10
§2.2.12 多种附录 2-10
§2.3 用户手册风格 2-11

第1章 用户手册格式要求
§1.1 标题及编号
通常情况下，用户手册用章、节来划分其内容，必需时还可引入小节、小小节概念。
§1.1.1 章标题设置
每章编号用阿拉伯数字表示，采取“第1章”、“第2章”、……形式表示章编号，章编号后面空一个半角格，然后是这一章标题。
章必需另起一页开始打印。
章编号和标题采取左对齐格式放在行左边，左缩进为0。
章编号和标题中汉字采取黑体小三号字，章编号和标题总长度不能超出一行。
章编号和标题行距取最小值、12磅，段前、段后分别取24磅。
§1.1.2 节标题设置
节编号格式为“§x.y”。其中，x为章号码，y为节号码，用阿拉伯数字表示。节编号后面空一个半角格，然后是这一节标题。
标准上每一节另起一页开始打印，但对于每章第一节，假如章标题下无说明文字，能够将其和章标题放于一页之中。
节编号和标题采取左对齐格式放在行左边，左缩进为0。
节编号和标题中汉字采取黑体四号字，节编号和标题总长度不能超出一行。
节编号和标题行距取最小值、12磅，对于和章标题处于同页要将其段前、段后均取12磅，不然段前取24磅、段后取12磅。
§1.1.3 小节标题设置
小节编号格式为“§x.y.z”。其中x为章号码，y为节号码，z为小节号码，用阿拉伯数字表示。小节编号后面空一个半角格，然后是这一小节标题。
小节无须另起一页开始打印。
小节编号和标题采取左对齐格式放在行左边，左缩进0.74CM。
小节编号和标题中汉字采取黑体小四号字，小节编号和标题总长度不能超出一行。
小节编号和标题行距取最小值、12磅，段前取12磅。
【注意】
假如有必需，还能够在小节下面划分更小节，我们暂且称之为小小节。
对于小小节多种要求和小节一致，为保持版面清楚，小小节不再相对于小节向右缩进。
在用户手册中，系统提醒信息采取幼圆五号字，其它全部数字及字母采取Arial字体，字号和对应汉字相同。在本规范中提到字体如无特殊注明，均指汉字字体。
用户手册中，行距均取最小值、12磅。来自 ....资料搜索
§1.1.4 项目符号和编号设置
在章、节、小节、小小节里面均能够含有项目符号和编号。
编号
1. 编号序列相对于和之对应标题向右缩进0.74CM。
2. 编号格式是“n.”，其中n为阿拉伯数字。
3. 对于有名编号序列名称采取五号黑体汉字，其后面内容采取五号宋体汉字；对于无名编号序列中内容字体同有名编号序列。
4. 编号序列里还许可采取二级编号序列，其格式要求以下：“n)”，其中n为阿拉伯数字。
5. 二级编号相对于和之对应一级编号向右缩进0.74CM。
6. 其它要求和一级编号序列一致。
7. 编号及二级编号行间距取最小值，12磅。一级编号第一项段前取12磅，其它各项及二级编号段前均取6磅。
项目符号
项目符号相对于和之对应标题或编号序列向右缩进0.74CM。
项目符号格式是“Ÿ”，其中“Ÿ”字体为Wingdings，五号字。
对于有名项目符号序列，名称采取五号黑体汉字，其后面正文采取宋体五号字，对于无名项目符号序列中内容字体同有名编号序列。
假如项目符号序列处于编号序列下级，则各项各项段前均取6磅；不然首项段前取12磅，其它各项段前取6磅。
【注意】项目符号和编号下叙述文字相对于和之对应项目符号或编号向右缩进0.74CM，首行缩进0.74CM，段前取6磅。汉字字体取宋体五号。
§1.1.5 其它编号设置
页编号：用户手册中正文按章进行编号，其格式为“章-页”。如，第2章第3页，编号为“2-3”。页编号放在页脚中，具体设置方法详见“页眉、页脚设置”。
图、表编号：
用户手册中图、表均按章分别进行编号来自 ....资料搜索，其格式分别为“图x-y”、“表x-y”。如，第2章第3幅图编号是“图2-3”；第2章第3张表格编号是“表2-3”。在图表编号后面空一个半角格，然后是这一图表名称。另外，还要求：
表编号和名称放在表顶部。
表编号和名称和表左对齐，而整个表则居中放置。
表编号和名称段后取6磅。
图编号和名称放在图底部。
图编号和名称和图均居中放置。
图编号和名称段前取6磅。
图前面正文段后取12磅。
图、表编号和名称中汉字采取黑体五号字。
§1.2 正文及页眉、页脚排版
§1.2.1 正文排版
正文排版包含字符排版、段落排版、图形排版和版权申明、目录等排版，本节就这几方面格式要求加以具体叙述。
字符排版：
用户手册正文，系统提醒采取幼圆五号字体，其它采取宋体五号字。
对于界面中按钮名称，应把按钮名称用“〈〉”括起来，按钮名称用黑体五号字书写。对于下拉菜单选项名称，应用“”引发来，选项名称用宋体五号字书写。对于热点，应用“”引发来，热点名称用黑体五号字书写。
正文均采取常规字体、标准位置、标准间距。
段落排版：
正文段落首行相对于和之对应标题或编号序列向右缩进0.74CM。
行距采取最小值，12磅，除项目符号及编号和图形前面正文按前面所述特殊要求进行排版外，其它段前均取12磅。
采取两端对齐方法。
图形排版：
屏幕截图时，应使所截图片尺寸为最大。
对于尺寸较大图片，可使图片高度和宽度按同百分比合适缩小。
必需时可合适缩小或将图片移到下一页，以确保图片和图号及图名在同页。
当正文中对图标进行说明时，应使图标同和之对应标题对齐。
为确保页面清楚，可合适调整图标右侧说明文字行间距和段前、段后。
在屏幕截图时，图片中输入数据不能包含本企业职员真实姓名。
版权申明、目录等排版：
版权申明、序言、阅读指南、目录标题为段前取36磅，段后取24磅，采取黑体小三号字；内容排版和手册正文排版相同。
§1.2.2 版面设置
§1.2.2.1 版面设置
对于版面设置作以下要求：
纸张大小：用户手册用纸统一要求为16开。
页边距：上：30mm；下：20mm；内侧：21mm；外侧：16mm。另外采取“对称页边距”；对于版面设置页眉、页脚应选择“首页不一样”和“奇偶页不一样”。
对于新项目或新产品可依据具体情况对版面设置合适做部分修改。
§1.2.2.2 相关页眉、页脚设置
页眉设置：
版权申明、序言、阅读指南、目录均无篇眉。
章编号和名称所在页篇眉为一行有50%填充边框。
对于单号页，页眉内容是目前章标题名，要求打印在纸右上角。
对于双号页，页眉内容是用户手册名称，要求打印在纸左上角。
纸顶边和页眉距离是23mm。
页眉中汉字采取幼圆小五号字。
页脚设置：
页脚内容是目前页页编号，如第2章第2页为2-2。
页编号字体采取Arial五号字。
纸底边和页脚距离是13mm。
版权申明、序言、阅读指南、目录页脚为ⅰ，ⅱ等，居中放置，不带边框。
§1.2.2.3 注意和警告
在用户手册中，对于那些需要用户尤其注意事项，应该用“【注意】”作为标志给用户以尤其提醒。相关注意标志和注意事项格式有以下要求：
注意标志同和之对应标题对齐。
注意标志采取黑体小四号汉字。
注意标志段前取12磅。
假如注意事项只有一条，其内容应该紧跟在注意标志后面书写；不然，应该在注意标志下一行开始，采取编号序列形式分别给出。
在用户手册中，对于那些会给用户造成重大损失行为，应该用“【警告】”作为标志给用户以警告性提醒。
【注意】相关警告标志和警告事项格式要求和相关注意标志和注意事项格式要求一致。

第2章 用户手册内容
本章关键讨论编写用户手册所要达成目标、软件用户手册所应包含内容、和在用户手册编写过程中所应保持风格。
假如标有“〖条件〗”字样，说明该部分内容是在一定条件下所必需。
§2.1 用户手册目标
某软件评测中心把软件产品评测测试分为两个阶段——初评安装测试和复评测试。只有经过初评安装测试软件才能进入复评测试，初评安装测试内容包含：
根据软件用户手册中安装说明测试软件能否顺利安装成功。
对照软件用户手册测试软件功效是否和手册描述一致。
评价产品包装及用户手册是否符合商品化要求。
经过以上三方面测试且无严重死机情况软件可进入复评测试。
由此，我们能够看到软件用户手册是一个软件产品基础，没有合格软件用户手册就根本谈不上合格软件产品。其次，良好安装说明及软件功效和手册描述一致性是对软件用户手册两个基础要求。
我们编写用户手册要达成两个目标：
让用户手册成为用户学习使用我们产品最好教材。用户经过阅读用户手册，应该对我们产品功效、操作有一定认识；根据用户手册上说明，经过实际操作，用户应该能够掌握我们产品操作过程。
让用户手册能够起到降低销售费用作用。用户手册不仅应该包含我们产品操作说明，而且还应该包含系统（软件和必需硬件）安装、数据维护、犯错处理等。经过用户手册，就能够让用户掌握在使用我们软件过程中出现多种情况处理方法。
为达成这两个目标，在通常情况下，用户手册应该包含以下多个方面内容：
封面
二封
版权
申明
序言
阅读指南
目录
基础知识介绍〖条件〗
系统安装(包含必需硬件安装)及开启
系统操作说明
系统及数据维护
例题〖条件〗
多种附录
【注意】假如本系统软件是一个大系统，其系统安装、操作说明、系统及数据维护全部相当复杂，则能够把这三个部分分别编写为一本甚至几本用户手册，每本手册全部有自己封面、版权申明、序言、阅读指南、目录和对应基础知识介绍和附录。
§2.2 用户手册内容
§2.2.1 封面
封面内容应包含企业ICON、软件名称及版本号、企业名称及手册印刷时间。
§2.2.2 二封
二封正面为软件名称及版本号、企业名称、手册印刷时间、企业地址及服务电话等。以EDD4.0手册为例，其形式以下：
EDD/AutoCAD R14 V4.0用户手册
沈阳东大阿尔派软件股份
地址：沈阳市和平区三好街84-2号
电话：[phone] [phone]
传真：[phone] [phone]
用户服务热线：800-890-8000
Email：Service@neu-alpine.
§2.2.3 版权申明
版权申明是保护我们所开发软件产权、不使我们企业利益受到损害一个方法。在版权申明中应该包含以下内容：
对我们所提供软件及用户手册保护申明。
对我们软件及商标 全部权申明。
对我们用户手册中所提到多种商标版权申明〖条件〗。
我们不对用户因为使用我们软件所造成损失负责申明。
具体请参考本规范版权申明。
§2.2.4 序言
对于序言所应包含内容常常依据用户手册编写人员习惯不一样而不一样，有时仅仅包含了系统开发背景和目标，有时还包含了系统介绍，有时甚至还包含了用户手册阅读指南。
为了统一起见，在这里我们要求序言关键包含以下内容：
系统开发背景和目标。
系统所能应用领域和使用对象。
系统功效及特征介绍。
假如本手册不是该系统第一个版本，还应该介绍较上一版本改善部分。
§2.2.5 阅读指南
阅读指南是每本(套)用户手册必不可少组成部分，用户经过它能够了解到用户手册基础内容；了解到应该怎样、从哪儿开始阅读该用户手册。用户手册阅读指南应该包含以下几部分：
手册目标：经过阅读该用户手册，用户应该或能够达成什么目标。
阅读对象：指明什么人员应该阅读该手册，或什么人员应该阅读本手册哪些部分；阅读对象在阅读本手册之前应该掌握哪些知识，必需时应给出资料清单，方便用户查阅。
手册组成：假如本系统用户手册(包含管理员手册、参考手册)由几本组成，首先应该分别简明介绍这些手册情况。最根本是应该介绍本手册在哪一章或哪几章讲解了什么内容，对于较大系统，如Universal Office 3.5，分别介绍每一章内容比较繁琐，则可概括性地介绍。
手册约定：这一部分应该包含字体约定、特殊符号约定和【注意】、【警告】、【说明】等含义。必需时，应该给出一些基础术语定义。也能够把基础术语、概念定义作为基础知识来介绍。
具体请参考本规范阅读指南。
§2.2.6 目录
目录编写要尽可能详尽。假如用户手册内容用到小节，则目录就应该编写到小节；假如用户手册内容用到小小节，则目录就应该编写到小小节。编写用户手册目录目标就是为了让用户能够依据它很快地找到想要内容。
相关格式请参考本规范目录编写。
§2.2.7 基础知识介绍〖条件〗
这一部分内容是在一定条件下必需，用户手册编写人员应该依据实际情况确定是否需要这一部分。假如包含基础知识介绍，应将其放在第1章。
在通常情况下，使用我们软件系统需要一定基础知识。这些知识能够从相关书籍上得到，不过用户从这些资料得到这些知识需要花费相当初间。在一些情况下，我们只需要用户掌握用户手册中使用那些概念，那么我们就有必需编写一章“基础知识介绍”来进行专门介绍。
比如说，在工厂管道设计系统用户手册中，常常见到按下鼠标“数据键”、“捕捉键”、“复位键”概念，用户即使能够从《Microstation用户手册》中得到这些概念，不过比较不方便。因为我们编写用户手册关键目标就是方便用户，所以有必需在用户手册一开始就介绍这些概念。
§2.2.8 系统安装及开启
假如手册中包含基础知识介绍，应把系统安装及开启作为第2章，不然，将其作为第1章首先向读者给予介绍。
系统安装及开启部分应该包含以下内容：
系统运行环境
硬件环境要求说明：系统运行时所需硬件环境描述。包含机型、内存大小、硬盘空间等。假如必需，还应包含输入/输出设备、通讯环境等。
软件环境要求说明：系统运行时所需软件支持环境描述。包含所需任何其它软件名称及版本号等。
其它环境要求说明〖条件〗：应该说明要求任何其它环境。
系统安装
对于不一样系统其安装应有所区分，通常来说，应给出最终用户能够据此把软件安装到其操作系统并配置完成，且能成功运行任何信息和操作。系统安装包含软件安装过程及系统环境配置〖条件〗，必需时还应给出硬件安装〖条件〗。
硬件安装〖条件〗：假如必需，应该具体说明系统所需硬件环境安装过程，其中包含软件加密锁安装。
软件安装：
应该用图示方法具体介绍软件安装过程。对于来自 ....资料搜索网络版软件，应对服务器端及用户端安装分别给予介绍（可参考文档管理系统SEAS-AMS 5.0）。假如二者安装过程相同，能够具体介绍一个，另一个参考前一个即可。假如软件由多个模块组成，且其中部分模块需单独安装，如Universal Office 3.5，则应分别给出安装步骤。
全部产品安装包含以下界面：安装快闪界面〖条件〗、安装初始窗口（欢迎）、版权申明界面、选择安装路径界面、选择程序文件夹（程序组）界面〖条件〗、安装进程界面〖条件〗及安装完成界面。
系统配置〖条件〗：应给出系统配置具体过程，方便用户能够顺利操作系统。对于网络版软件，应分别讲述服务器和用户端配置过程。
系统开启：应给出系统开启方法。假如系统由多个模块组成，则无须单列出一节讲述系统开启方法，只须在介绍各个模块操作时给出模块开启方法即可。
对于系统安装及开启结构总结以下，供编写用户手册时参考：
|------系统运行环境 |----硬件环境
| |----软件环境
|
系统安装及开启 | |----硬件安装
|------系统安装 |----软件安装
| |----系统配置
|
|------系统开启
§2.2.9 系统操作说明
系统操作说明是全部用户手册主体，它所包含内容相当广泛。关键包含：输入命令和数据、软件功效、输出结果、犯错信息及其矫正和恢复方法。
对于不一样软件，其操作说明也应有所不一样，下面就多个情况分别给予介绍。
§2.2.9.1 CAD软件
CAD软件操作说明应包含文件管理、图纸尺寸设置、图形绘制、图形编辑、尺寸标注、图层管理、图库调用〖条件〗、图库维护〖条件〗及附录〖条件〗等内容。
在用户手册中应按操作次序或界面中菜单次序分别对上述内容中每一项操作给予介绍。要求具体给出操作过程及命令格式和功效，具体要求以下：
多种操作、命令和语言：软件系统使用过程全部是使用软件系统提供多种操作、命令和语言过程。所以，我们必需做到：
操作和命令：在用户手册中具体给出多种操作过程和功效、命令格式和功效；应该描述在使用上多种限制，如，操作状态、操作条件、操作序列等。另外，必需时能够经过合适地举例讲述多种操作和命令使用方法，以帮助用户了解。
输出信息：应该具体列出和操作、命令相关多种输出信息。假如输出信息意思本身不是很显著，应该给解释。另外还应该说明对于这些信息所采取操作。
程序设计语言〖条件〗：假如我们软件系统提供了某种语言，对其语言规则应该给说明。
多种数据：在软件使用过程中，用户必需和多种数据和信息打交道。为了让用户能够操作我们软件，我们必需为用户提供多种结构和每个数据元素含义
有些数据适合在系统操作说明中给出，有些适合在后面附录中给出，甚至有些除了在操作说明同时给出外，还要在附录中给归纳，这些全部由用户手册编写人员依据实际情况来决定。这些数据包含：
1) 输入数据〖条件〗：应该给出数据内容、逻辑结构、格式和每一个数据元素意思。假如输入数据依靠于某特定数据介质，则应该给说明。
2) 输出数据：应该给出软件以何种形式输出数据内容和格式，并要求以例样形式给说明。
3) 中间数据〖条件〗：假如我们告诉用户在软件运行过程中所产生中间数据内容和格式，有利于用户了解软件使用，则应该给说明
4) 数据限制〖条件〗：假如对数据有限制，如数据大小限制，则应该给说明。
5) 数据文件〖条件〗：假如要告诉用户我们软件所使用一些数据文件结构有利于用户了解我们软件使用，则应给说明，但应该注意技术保密。假如对数据文件有所限制，比如每个文件最大统计数、每个磁盘最大文件数等，应该给说明。
处理过程〖条件〗：假如我们简明地给用户描述我们软件对用户操作、输入命令和输入数据处理过程，有利于用户了解我们软件使用，则应给说明。
截图内容：现在，多数软件已不再采取命令行输入方法，而是采取对话框输入方法。在此情况下，应该以图示方法对软件操作过程给予介绍。采取图示方法讲述软件操作过程应注意以下几点：
所截图形输入、输出信息中不应包含本企业人员真实姓名，且多种输入、输出信息以不泄漏企业机密为标准。
截图是为使叙述愈加明确、简练，所以应尽可能避免无须要截图。通常来说，在用户手册中应该包含系统主界面、多种操作初始界面（点取命令后弹出第一个界面，通常需要输入信息）、操作中间过程界面、操作结果界面和其它部分必需界面。没有必需为下拉菜单、快捷菜单等内容截图，因为这些操作全部比较简单，只要用语言叙述用户即可明确其操作方法。另外，在同一本手册中，应避免反复截图，对于不一样输入或输出信息同一界面在手册中不应反复（例题除外）。
犯错处理：应该给出多种犯错情况和对应处理方法。
现对系统操作说明步骤总结以下，供编写用户手册时参考：
进入相关界面。
调用命令（选择菜单、键入命令或点击工具按钮）。
弹出对应操作初始界面（或提醒行）。
对输入信息给说明。
继续操作（点击按钮或选择参数及键入按键等）。
结果界面（或结果提醒行）。
对输出信息给说明。
【警告】在编写软件用户手册系统操作说明时，我们在决定是否提供某种数据格式时，应以不泄漏企业技术而且有利于用户使用为准则。
§2.2.9.2 其它软件
对于部分比较复杂软件，通常包含多个模块。对于这类系统，要求根据操作次序对各个模块分别介绍。通常按模块分成若干章，在各章中对相关模块操作给予介绍。对于这类软件操作步骤总结以下：
开启某一模块，进入该模块主界面。
实施某一功效（选择菜单或工具按钮）。
弹出相关界面。
对输入信息给予说明。
继续操作（点击按钮）。
结果界面。
对输出信息给予说明。
有些软件操作可能需要一定技术和经验才能取得满意结果，那么应该在用户手册上尽可能给出这些技术和经验描述，或告诉用户怎样才能取得这些技术和经验。比如，在操作SEAS系统作图纸净化处理时，怎样选择合适阀值就需要一定技术和经验。
部分比较简单系统，如NetEye、OpenVideo等其系统操作比较简单，操作说明内容比较少。对于这类软件，手册中能够将操作说明归纳为一章，再按操作次序给予介绍。
另外，对于多种操作、命令、语言、数据及截图内容要求同CAD软件。
§2.2.10 系统及数据维护
应该给出用户数据备份、恢复、删除、整理具体过程。假如必需，应该给出系统数据、系统磁盘空间维护具体过程。
§2.2.11 例题〖条件〗
有些软件系统能够经过一个较为完整例题演示系统部分功效使用方法，在这个例题中，用户应该具体地描述每一步操作过程，用户能够经过这个例题对系统操作有一个初步了解。
§2.2.12 多种附录
在用户手册中，有些知识和信息能够经过附录形式提供给用户，方便于用户查阅，这些内容是：
1. 错误提醒信息：通常能够以表形式根据一定次序，比如按犯错提醒信息编号次序、或按犯错提醒信息字母次序，给出犯错提醒信息编号、提醒信息、对应解释、犯错原因和处理措施
2. 命令速查表〖条件〗：通常能够以表形式根据一定次序给出多种命令概要(包含命令名称、多种参数、及对应功效介绍)，以帮助有一定经验用户进行快速查找所需信息
3. 数据文件格式〖条件〗：能够经过附录介绍用户必需了解或能够了解多种输入数据文件、输出结果文件、中间数据文件格式、限制范围、合适解释等
4. 其它信息 〖条件〗：任何其它有利于用户使用我们软件、方便用户信息全部能够以附录形式提供给用户
【注意】即使附录所提供信息可能均能够在系统操作说明中查到，但提供附录目标就是为了方便用户使用，这种反复还是必需。
§2.3 用户手册风格
用户手册应含有自己风格。有人喜爱用比较深奥概念和语言来说明问题，有人喜爱用比较长句子来表示思想，在编制用户手册过程中这些全部是不可取。用户手册应该含有以下特点：
用户手册句子尽可能简练：假如用一个句子表示起来比较复杂，定语多，则能够分成两个甚至多个句子来说明，这么用户在阅读用户手册时会轻松些。
每节、段内容明确：每节内容必需明确，这么用户能够经过目录很方便地查到自己所需要内容；注意段划分，每段不要太长，突出关键，不然用户不轻易取得其中精华。
用户手册用词要前后一致：在用户手册中使用概念、术语用词要前后一致，不然用户将不轻易读懂此手册。
用户不一定是计算机教授：用户手册编写人员应该牢切记住这一点，我们大多数用户全部不是学计算机，手册中应该尽可能不使用较深奥计算机术语。假如不可避免，我们应该给合适解释和说明。另外，不要认为我们用户什么全部懂，所以在编写用户手册时候，应该具体地描述操作过程中每一步。
用户手册各部分风格应该统一：部分较大系统可能由多人开发和测试，如Universal Office 3.5，从而造成用户手册各部分风格各异，这就要求用户手册编排人员最终将各部分统一成风格相同一本手册。
来自 ....资料搜索