用户手册编制规范.docx
《用户手册编制规范.docx》由会员分享，可在线阅读，更多相关《用户手册编制规范.docx（20页珍藏版）》请在冰豆网上搜索。
用户手册编制规范
用户手册编制规范
沈阳软件股份有限公司
2000.2
版权声明
《用户手册编制规范》的版权归沈阳软件股份有限公司所有。
未经沈阳软件股份有限公司的书面准许，不得将本规范的任何部分以任何形式、采用任何手段（电子的或机械的，包括照相复制或录制）、或为任何目的，进行复制或扩散。
（c）Copyright2000沈阳软件股份有限公司。
版权所有，翻制必究。
是沈阳软件股份有限公司的注册商标。
Microsoft、word是MicrosoftCorporation的注册商标。
Windows是MicrosoftCorporation的商标。
前言
用户手册对于任何产品都是不可缺少的组成部分。
一个好的产品没有一份完备的用户手册，也不能算作一个完备的产品。
对于软件产品来说更是如此，没有用户手册的软件不能算产品，没有好的用户手册，就不可能算好产品。
也就是说，一个好的软件产品除了具备与市场对路的思想、良好的用户界面、完备的测试之外，还必须有一本适合用户使用的用户手册。
本规范手册不仅指明了软件用户手册的内容，而且规定了沈阳软件股份有限公司软件用户手册的统一版面、格式。
本规范手册就是按本规定编写的，但由于本规范手册内容的局限性，很难以样本的形式表现软件用户手册中可能出现的各种情况，所以请大家认真阅读本规范手册的内容。
我们希望沈阳软件股份有限公司的相关人员，能够按照本规范手册编写自己的软件用户手册，做好我们的软件产品化工作。
由于时间仓促，编者水平有限，希望大家能够提出宝贵意见，以逐步完善本规范手册的内容。
阅读指南
〖手册目标〗
本手册主要对沈阳软件股份有限公司软件产品的用户手册所应包含的内容及版面格式作一个初步的统一规定。
由于实际情况千变万化，本规定很难一次做到面面俱到，需要逐渐完善。
〖阅读对象〗
本手册是为沈阳软件股份有限公司的所有软件开发人员和软件用户手册编写人员所编写的。
由于本手册中的格式规定部分是根据MicrosoftWindows下的Word的功能而编写的，所以沈阳软件股份有限公司的软件用户手册应该使用MicroSoftWord排版。
〖手册构成〗
本手册基本上由两部分组成：
1.第1章，“关于用户手册排版格式的规定”，规定了用户手册标题及编号的格式。
2.第2章，“用户手册的内容”，规定了用户手册所应包含内容较为详细的清单。
另外，本手册基本上是按“用户手册格式的统一规定”编写的一个样本。
〖手册约定〗
本手册遵循以下约定：
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.91CAD软件2-7
§2.2.92其它软件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章”、……的形式表示章的编号，章的编号后面空一个半角的格，然后是这一章的标题。
1.章必须另起一页开始打印。
2.章的编号和标题采用左对齐的格式放在行的左边，左缩进为0。
3.章的编号和标题中汉字采用黑体小三号字，章的编号和标题总长度不能超过一行。
4.章的编号和标题行距取最小值、12磅，段前、段后分别取24磅。
§1.1.2节标题的设置
节的编号格式为“§x.y”。
其中，x为章的号码，y为节的号码，用阿拉伯数字表示。
节的编号后面空一个半角的格，然后是这一节的标题。
1.原则上每一节另起一页开始打印，但对于每章的第一节，如果章标题下无说明文字，可以将其与章标题放于一页之中。
2.节的编号和标题采用左对齐的格式放在行的左边，左缩进为0。
3.节的编号和标题中汉字采用黑体四号字，节的编号和标题总长度不能超过一行。
4.节的编号和标题行距取最小值、12磅，对于与章标题处于同页的要将其段前、段后均取12磅，否则段前取24磅、段后取12磅。
§1.1.3小节标题的设置
小节的编号格式为“§x.y.z”。
其中x为章的号码，y为节的号码，z为小节号码，用阿拉伯数字表示。
小节的编号后面空一个半角的格，然后是这一小节的标题。
1.小节不必另起一页开始打印。
2.小节的编号和标题采用左对齐的格式放在行的左边，左缩进0.74CM。
3.小节的编号和标题中汉字采用黑体小四号字，小节的编号和标题总长度不能超过一行。
4.小节的编号和标题行距取最小值、12磅，段前取12磅。
【注意】
1.如果有必要，还可以在小节下面划分更小的节，我们暂且称之为小小节。
2.对于小小节的各种规定与小节一致，为保持版面清晰，小小节不再相对于小节向右缩进。
3.在用户手册中，系统提示信息采用幼圆五号字，其余所有的数字及字母采用Arial字体，字号与相应的汉字相同。
在本规范中提到的字体如无特殊注明，均指汉字字体。
4.用户手册中，行距均取最小值、12磅。
§1.1.4项目符号和编号的设置
在章、节、小节、小小节里面均可以含有项目符号和编号。
1.编号
1）编号序列相对于与之对应的标题向右缩进0.74CM。
2）编号的格式是“n.”，其中n为阿拉伯数字。
3）对于有名编号序列名称采用五号黑体汉字，其后面的内容采用五号宋体汉字；对于无名编号序列中的内容字体同有名编号序列。
4）编号序列里还允许采用二级编号序列，其格式规定如下：
“n）”，其中n为阿拉伯数字。
5）二级编号相对于与之对应的一级编号向右缩进0.74CM。
6）其它规定和一级编号序列一致。
7）编号及二级编号的行间距取最小值，12磅。
一级编号的第一项段前取12磅，其余各项及二级编号段前均取6磅。
2.项目符号
1）项目符号相对于与之对应的标题或编号序列向右缩进0.74CM。
2）项目符号的格式是“”，其中“”字体为Wingdings，五号字。
3）对于有名项目符号序列，名称采用五号黑体汉字，其后面的正文采用宋体五号字，对于无名项目符号序列中的内容字体同有名编号序列。
4）如果项目符号序列处于编号序列的下级，则各项各项段前均取6磅；否则首项段前取12磅，其余各项段前取6磅。
【注意】项目符号和编号下的叙述文字相对于与之对应的项目符号或编号向右缩进0.74CM，首行缩进0.74CM，段前取6磅。
汉字字体取宋体五号。
§1.1.5其它编号的设置
1.页编号：
用户手册中的正文按章进行编号，其格式为“章-页”。
如，第2章的第3页，编号为“2-3”。
页编号放在页脚中，具体设置方法详见“页眉、页脚设置”。
2.图、表编号：
用户手册中的图、表均按章分别进行编号，其格式分别为“图x-y”、“表x-y”。
如，第2章的第3幅图的编号是“图2-3”；第2章的第3张表格的编号是“表2-3”。
在图表编号的后面空一个半角的格，然后是这一图表的名称。
另外，还规定：
1）表的编号与名称放在表的顶部。
2）表的编号与名称和表左对齐，而整个表则居中放置。
3）表的编号与名称段后取6磅。
4）图的编号与名称放在图的底部。
5）图的编号与名称和图均居中放置。
6）图的编号与名称段前取6磅。
7）图前面的正文段后取12磅。
8）图、表的编号与名称中汉字采用黑体五号字。
§1.2正文及页眉、页脚的排版
§1.2.1正文排版
正文排版包括字符排版、段落排版、图形排版和版权声明、目录等的排版，本节就这几方面的格式要求加以详细阐述。
1.字符排版：
1）用户手册的正文，系统提示采用幼圆五号字体，其余采用宋体五号字。
2）对于界面中的按钮名称，应把按钮名称用“〈〉”括起来，按钮名称用黑体五号字书写。
对于下拉菜单选项的名称，应用“”引起来，选项名称用宋体五号字书写。
对于热点，应用“”引起来，热点名称用黑体五号字书写。
3）正文均采用常规字体、标准位置、标准间距。
2.段落排版：
1）正文段落的首行相对于与之对应的标题或编号序列向右缩进0.74CM。
2）行距采用最小值，12磅，除项目符号及编号以及图形前面正文按前面所述的特殊要求进行排版外，其余段前均取12磅。
3）采取两端对齐方式。
3.图形的排版：
1）屏幕截图时，应使所截图片的尺寸为最大。
2）对于尺寸较大的图片，可使图片的高度和宽度按同比例适当缩小。
3）必要时可适当缩小或将图片移到下一页，以保证图片与图号及图名在同页。
4）当正文中对图标进行说明时，应使图标同与之对应的标题对齐。
5）为保证页面清晰，可适当调整图标右侧说明文字的行间距以及段前、段后。
6）在屏幕截图时，图片中输入的数据不能包含本公司员工的真实姓名。
4.版权声明、目录等的排版：
版权声明、前言、阅读指南、目录的标题为段前取36磅，段后取24磅，采用黑体小三号字；内容排版与手册正文排版相同。
§1.2.2版面设置
§1.2.2.1版面设置
对于版面设置作如下规定：
1.纸张大小：
用户手册用纸统一规定为16开。
2.页边距：
上：
30mm；下：
20mm；内侧：
21mm；外侧：
16mm。
另外采用“对称页边距”；对于版面设置页眉、页脚应选用“首页不同”和“奇偶页不同”。
3.对于新项目或新产品可根据具体情况对版面设置适当做一些修改。
§1.2.2.2关于页眉、页脚的设置
1.页眉的设置：
1）版权声明、前言、阅读指南、目录均无篇眉。
2）章编号和名称所在页的篇眉为一行有50%填充的边框。
3）对于单号页，页眉的内容是当前章的标题名，要求打印在纸的右上角。
4）对于双号页，页眉的内容是用户手册的名称，要求打印在纸的左上角。
5）纸的顶边与页眉的距离是23mm。
6）页眉中汉字采用幼圆小五号字。
2.页脚的设置：
1）页脚的内容是当前页的页编号，如第2章第2页为2-2。
2）页编号的字体采用Arial五号字。
3）纸的底边与页脚的距离是13mm。
4）版权声明、前言、阅读指南、目录的页脚为ⅰ，ⅱ等，居中放置，不带边框。
§1.2.2.3注意与警告
在用户手册中，对于那些需要用户特别注意的事项，应该用“【注意】”作为标志给用户以特别的提示。
关于注意标志和注意事项的格式有如下规定：
1.注意标志同与之对应的标题对齐。
2.注意标志采用黑体小四号汉字。
3.注意标志段前取12磅。
4.如果注意事项只有一条，其内容应该紧跟在注意标志的后面书写；否则，应该在注意标志的下一行开始，采用编号序列的形式分别给出。
在用户手册中，对于那些会给用户造成重大损失的行为，应该用“【警告】”作为标志给用户以警告性的提示。
【注意】关于警告标志和警告事项的格式规定与关于注意标志和注意事项的格式规定一致。
第2章用户手册的内容
本章主要讨论编写用户手册所要达到的目标、软件用户手册所应包含的内容、以及在用户手册编写过程中所应保持的风格。
如果标有“〖条件〗”字样，说明该部分内容是在一定条件下所必须的。
§2.1用户手册的目标
某软件评测中心把软件产品评测测试分为两个阶段——初评安装测试和复评测试。
只有通过初评安装测试的软件才能进入复评测试，初评安装测试的内容包括：
1.按照软件用户手册中的安装说明测试软件能否顺利安装成功。
2.对照软件用户手册测试软件功能是否与手册描述一致。
3.评价产品包装及用户手册是否符合商品化要求。
4.通过以上三方面测试且无严重死机情况的软件可进入复评测试。
由此，我们可以看到软件用户手册是一个软件产品的基础，没有合格的软件用户手册就根本谈不上合格的软件产品。
另一方面，良好的安装说明及软件功能与手册描述的一致性是对软件用户手册的两个基本要求。
我们编写的用户手册要达到两个目的：
1.让用户手册成为用户学习使用我们产品的最好教材。
用户通过阅读用户手册，应该对我们产品的功能、操作有一定的认识；按照用户手册上的说明，通过实际操作，用户应该能够掌握我们产品的操作过程。
2.让用户手册能够起到降低销售费用的作用。
用户手册不仅应该包括我们的产品操作说明，而且还应该包括系统（软件和必要的硬件）安装、数据维护、出错处理等。
通过用户手册，就可以让用户掌握在使用我们软件的过程中出现各种情况的处理方法。
为达到这两个目标，在一般情况下，用户手册应该包含如下几个方面的内容：
1.封面
2.二封
3.版权
4.声明
5.前言
6.阅读指南
7.目录
8.基础知识介绍〖条件〗
9.系统安装（包括必要的硬件安装）及启动
10.系统操作说明
11.系统及数据维护
12.例题〖条件〗
13.各种附录
【注意】如果本系统软件是一个大系统，其系统安装、操作说明、系统及数据维护都相当复杂，则可以把这三个部分分别编写为一本甚至几本用户手册，每本手册都有自己的封面、版权声明、前言、阅读指南、目录以及相应的基础知识介绍和附录。
§2.2用户手册的内容
§2.2.1封面
封面内容应包括公司的ICON、软件名称及版本号、公司名称及手册印刷时间。
§2.2.2二封
二封正面为软件名称及版本号、公司名称、手册印刷时间、公司地址及服务电话等。
以EDD4.0手册为例，其形式如下：
EDD/AutoCADR14V4.0用户手册
沈阳软件股份有限公司
地址：
沈阳市和平区三好街84-2号
电话：
（024）23841748（024）23783000
传真：
（024）23890817（024）23782266
客户服务热线：
800-890-8000
Email：
Service@neu-
§2.2.3版权声明
版权声明是保护我们所开发软件的产权、不使我们公司利益受到损害的一种方式。
在版权声明中应该包括以下内容：
1.对我们所提供的软件及用户手册的保护声明。
2.对我们的软件及商标
所有权的声明。
3.对我们的用户手册中所提到的各种商标的版权声明〖条件〗。
4.我们不对用户因为使用我们的软件所造成的损失负责的声明。
具体请参考本规范的版权声明。
§2.2.4前言
对于前言所应包含的内容经常根据用户手册编写人员的习惯不同而不同，有时仅仅包含了系统的开发背景和目的，有时还包含了系统简介，有时甚至还包含了用户手册的阅读指南。
为了统一起见，在这里我们规定前言主要包括以下内容：
1.系统的开发背景和目的。
2.系统所能应用的领域和使用对象。
3.系统的功能及特性简介。
4.如果本手册不是该系统的第一个版本，还应该简介较上一版本的改进部分。
§2.2.5阅读指南
阅读指南是每本（套）用户手册必不可少的组成部分，用户通过它可以了解到用户手册的基本内容；了解到应该如何、从哪儿开始阅读该用户手册。
用户手册的阅读指南应该包含如下几部分：
1.手册目标：
通过阅读该用户手册，用户应该或能够达到什么目标。
2.阅读对象：
指明什么人员应该阅读该手册，或什么人员应该阅读本手册的哪些部分；阅读对象在阅读本手册之前应该掌握哪些知识，必要时应给出资料清单，以便用户查阅。
3.手册构成：
如果本系统的用户手册（包括管理员手册、参考手册）由几本组成，首先应该分别简要介绍这些手册的情况。
最根本的是应该介绍本手册在哪一章或哪几章讲解了什么内容，对于较大系统，如UniversalOffice3.5，分别介绍每一章内容比较繁琐，则可概括性地介绍。
4.手册约定：
这一部分应该包括字体的约定、特殊符号的约定以及【注意】、【警告】、【说明】等的含义。
必要时，应该给出某些基本术语的定义。
也可以把基本术语、概念的定义作为基础知识来介绍。
具体请参考本规范的阅读指南。
§2.2.6目录
目录的编写要尽量详尽。
如果用户手册的内容用到小节，则目录就应该编写到小节；如果用户手册的内容用到小小节，则目录就应该编写到小小节。
编写用户手册目录的目的就是为了让用户能够根据它很快地找到想要的内容。
有关格式请参考本规范目录的编写。
§2.2.7基础知识介绍〖条件〗
这一部分内容是在一定条件下必需的，用户手册编写人员应该根据实际情况确定是否需要这一部分。
如果包括基础知识介绍，应将其放在第1章。
在一般情况下，使用我们的软件系统需要一定的基础知识。
这些知识可以从有关书籍上得到，但是用户从这些资料得到这些知识需要花费相当的时间。
在某些情况下，我们只需要用户掌握用户手册中使用的那些概念，那么我们就有必要编写一章“基础知识介绍”来进行专门介绍。
比如说，在工厂管道设计系统用户手册中，经常用到按下鼠标“数据键”、“捕捉键”、“复位键”的概念，用户虽然可以从《Microstation的用户手册》中得到这些概念，但是比较不方便。
由于我们编写用户手册的主要目标就是方便用户，所以有必要在用户手册的一开始就介绍这些概念。
§2.2.8系统安装及启动
如果手册中包括基础知识介绍，应把系统安装及启动作为第2章，否则，将其作为第1章首先向读者予以介绍。
系统安装及启动部分应该包括如下内容：
1.系统的运行环境
•硬件环境要求说明：
系统运行时所需硬件环境描述。
包括机型、内存大小、硬盘空间等。
如果必要，还应包括输入/输出设备、通讯环境等。
•软件环境要求说明：
系统运行时所需软件支持环境的描述。
包括所需任何其它软件的名称及版本号等。
•其它环境要求说明〖条件〗：
应该说明要求的任何其它环境。
2.系统的安装
对于不同的系统其安装应有所区别，一般来说，应给出最终用户能够据此把软件安装到其操作系统并配置完成，且能成功运行的任何信息和操作。
系统的安装包括软件的安装过程及系统环境的配置〖条件〗，必要时还应给出硬件的安装〖条件〗。
•硬件安装〖条件〗：
如果必要，应该详细说明系统所需硬件环境的安装过程，其中包括软件加密锁的安装。
•软件安装：
应该用图示方法详细介绍软件的安装过程。
对于网络版软件，应对服务器端及客户端的安装分别予以介绍（可参考文档管理系统SEAS2000-AMS5.0）。
如果二者安装过程相似，可以详细介绍一种，另一种参考前一种即可。
如果软件由多个模块构成，且其中部分模块需单独安装，如UniversalOffice3.5，则应分别给出安装步骤。
所有产品的安装包括以下界面：
安装快闪界面〖条件〗、安装初始窗口（欢迎）、版权声明界面、选择安装路径界面、选择程序文件夹（程序组）界面〖条件〗、安装进程界面〖条件〗及安装完成界面。
•系统配置〖条件〗：
应给出系统配置的详细过程，以便用户能够顺利操作系统。
对于网络版软件，应分别讲述服务器和客户端的配置过程。
3.系统的启动：
应给出系统启动的方法。
如果系统由多个模块组成，则不必单列出一节讲述系统的启动方法，只须在介绍各个模块的操作时给出模块的启动方法即可。
对于系统的安装及启动的结构总结如下，供编写用户手册时参考：
|------系统的运行环境|----硬件环境
||----软件环境
|
系统的安装及启动||----硬件安装
|------系统的安装|----软件安装
||----系统的配置
|
|------系统的启动
§2.2.9系统操作说明
系统操作说明是所有用户手册的主体，它所包含的内容相当广泛。
主要包括：
输入的命令和数据、软件的功能、输出结果、出错信息及其矫正和恢复方法。
对于不同的软件，其操作说明也应有所不同，下面就几种情况分别予以介绍。
§2.2.9.1CAD软件
CAD软件的操作说明应包括文件管理、图纸尺寸设置、图形绘制、图形编辑、尺寸标注、图层管理、图库调用〖条件〗、图库维护〖条件〗及附录〖条件〗等内容。
在用户手册中应按操作顺序或界面中菜单顺序分别对上述内容中的每一项操作予以介绍。
要求详细给出操作过程及命令格式与功能，具体规定如下：
1.各种操作、命令和语言：
软件系统的使用过程都是使用软件系统提供的各种操作、命令和语言的过程。
所以，我们必须做到：
1）操作和命令：
在用户手册中详细给出各种操作的过程和功能、命令的格式和功能；应当描述在使用上的各种限制，如，操作状态、操作条件、操作序列等。
另外，必要时可以通过适当地举例讲述各种操作和命令的使用方法，以帮助用户理解。
2）输出信息：
应该详细列出与操作、命令相关的各种输出信息。
如果输出信息的意思本身不是很明显，应当给予解释。
另外还应当说明对于这些信息所采取的操作。
3）程序设计语言〖条件〗：
如果我们的软件系统提供了某种语言，对其语言规则应当给予说明。
2.各种数据：
在软件的使用过程中，用户必须与各种数据和信息打交道。
为了让用户能够操作我们的软件，我们必须为用户提供各种结构以及每个数据元素的含义
有些数据适合在系统操作说明中给出，有些适合在后面的附录中给出，甚至有些除了在操作说明的同时给出外，还要在附录中给予归纳，这些都由用户手册编写人员根据实际情况来决定。
这些数据包括：
1）输入数据〖条件〗：
应该给出数据的内容、逻辑结构、格式以及每一个数据元素的意思。
如果输入数据依赖于某特定数据介质，则应当给予说明。
2）输出数据：
应当给出软件以何种形式输出的数据的内容和格式，并要求以例样的形式给予说明。
3）中间数据〖条件〗：
如果我们告诉用户在软件的运行过程中所产生的中间数据的内容和格式，有助于用户理解软件的使用，则应当给予说明
4）数据限制〖条件〗：
如果对数据有限制，如数据的大小限制，则应当给予说明。
5）数据文件〖条件〗：
如果要告诉用户我们的软件所使用的某些数据文件的结构有助于用户理解我们软件的使用，则应给予说明，但应该注意技术保密。
如果对数据文件有所限制，例如每个文件的最大记录数、每个磁盘的最大文件数等，应当给予说明。
3.处理过程〖条件〗：
如果我们简要地给用户描述我们软件对用户的操作、输入的命令和输入数据的处理过程，有助于用户了解我们软件的使用，则应给予说明。
4.截图内容：
目前，多数软件已不再采用命令行输入方式，而是采用对话框输入方式。
在此情况下，应该以图示方式对软件的操作过程予以介绍。
采用图示方式讲述软件操作过程应注意以下几点：
•所截图形的输入、输出信息中不应包含本公司人员的真实姓名，且各种输入、输出信息以不泄漏公司机密为原则。
•截图是为使叙述更加明确、简洁，所以应尽量避免不必要的截图。
一般来说，在用户手册中应该包括系统的主界面、各种操作的初始界面（点取
升级会员 