某软件公司用户手册编制规范(doc 43页)109513.docx

《某软件公司用户手册编制规范(doc 43页)109513.docx》由会员分享，可在线阅读，更多相关《某软件公司用户手册编制规范(doc 43页)109513.docx（35页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、第1章 关于标题及编号的规定用户手册编编制规范沈阳东大阿阿尔派软件件股份有限限公司2000.21-6第1章 用户手册格式的统一规定版权声明用户手册册编制规范范的版权权归沈阳东东大阿尔派派软件股份份有限公司司所有。未未经沈阳东东大阿尔派派软件股份份有限公司司的书面准准许，不得得将本规范范的任何部部分以任何何形式、采采用任何手手段(电子的或或机械的，包包括照相复复制或录制制)、或为任任何目的，进进行复制或或扩散。(c)Coopyriight 20000 沈阳东东大阿尔派派软件股份份有限公司司。版权所所有，翻制制必究。 是沈阳东东大阿尔派派软件股份份有限公司司的注册商商标。Microosoftt、w

2、ordd是Micrrosofft Coorporratioon的注册册商标。Windoows是Micrrosofft Coorporratioon的商标标。1-10 前 言用户手册对对于任何产产品都是不不可缺少的的组成部分分。一个好好的产品没没有一份完完备的用户户手册，也也不能算作作一个完备备的产品。对对于软件产产品来说更更是如此，没没有用户手手册的软件件不能算产产品，没有有好的用户户手册，就就不可能算算好产品。也也就是说，一一个好的软软件产品除除了具备与与市场对路路的思想、良良好的用户户界面、完完备的测试试之外，还还必须有一一本适合用用户使用的的用户手册册。本规范手册册不仅指明明了软件用用户

3、手册的的内容，而而且规定了了沈阳东大大阿尔派软软件股份有有限公司软软件用户手手册的统一一版面、格格式。本规规范手册就就是按本规规定编写的的，但由于于本规范手手册内容的的局限性，很很难以样本本的形式表表现软件用用户手册中中可能出现现的各种情情况，所以以请大家认认真阅读本本规范手册册的内容。我们希望沈沈阳东大阿阿尔派软件件股份有限限公司的相相关人员，能能够按照本本规范手册册编写自己己的软件用用户手册，做做好我们的的软件产品品化工作。由由于时间仓仓促，编者者水平有限限，希望大大家能够提提出宝贵意意见，以逐逐步完善本本规范手册册的内容。i 阅读指南手册目标标本手册主要要对沈阳东东大阿尔派派软件股份份有

4、限公司司软件产品品的用户手手册所应包包含的内容容及版面格格式作一个个初步的统统一规定。由由于实际情情况千变万万化，本规规定很难一一次做到面面面俱到，需需要逐渐完完善。阅读对象象本手册是为为沈阳东大大阿尔派软软件股份有有限公司的的所有软件件开发人员员和软件用用户手册编编写人员所所编写的。由由于本手册册中的格式式规定部分分是根据 Micrrosofft Wiindowws 下的的 Worrd 的功功能而编写写的，所以以沈阳东大大阿尔派软软件股份有有限公司的的软件用户户手册应该该使用 MMicrooSoft Wordd排版。手册构成成本手册基本本上由两部部分组成：第1章，“关于用户户手册排版版格式的

5、规规定”，规定了了用户手册册标题及编编号的格式式。第2章，“用户手册册的内容”，规定了了用户手册册所应包含含内容较为为详细的清清单。另外，本手手册基本上上是按“用户手册册格式的统统一规定”编写的一一个样本。手册约定定本手册遵循循以下约定定：所有标题均均使用黑体体字。如果标题后后跟有“条件”字样，说说明该标题题下正文所所要求的内内容是在一一定条件下下必须的。【注意】的的意思是请请读者注意意那些需要要注意的事事项。【警告】的的意思是请请读者千万万注意某些些事项，否否则将造成成严重错误误。i目 录第1章 用用户手册格格式规定1-11.1 标题及编编号1-11.1.1 章标题的的设置1-11.1.2

6、节标题的的设置1-11.1.3 小节标题题的设置1-11.1.4项目符符号和编号号的设置1-21.1.5 其它它编号的设设置1-31.2 正文及页页眉页脚的的排版1-41.2.1 正文排版版1-51.2.2 版面设置置1-51.2.2.1 版面设置置1-51.2.2.2 关于页眉眉、页脚的的设置1-51.2.2.3 注意与警警告1-5第2章 用用户手册的的内容2-12.1 用户手册册的目标2-42.2 用户手册册的内容2-42.2.1 封面面2-42.2.2 二封封2-42.2.3 版权权声明2-42.2.4 前言言2-42.2.5 阅读读指南2-52.2.6目录2-52.2.7基础知知识介绍

7、条件2-52.2.8 系统统安装及启启动2-62.2.9 系统统操作说明明2-72.2.9 1 CAD软软件2-72.2.9 2 其它软件件2-92.2.10 系系统及数据据维护2-92.2.11 例例题条件件2-1002.2.12 各各种附录2-1002.3 用户手册册的风格2-111第1章 用户手册格式的规定第1章 用用户手册格格式的规定定1.1 标题及编编号一般情况下下，用户手手册用章、节节来划分其其内容，必必要时还可可引入小节节、小小节节的概念。1.1.1 章标标题的设置置每章的编号号用阿拉伯伯数字表示示，采用“第1章”、“第2章”、的形式式表示章的的编号，章章的编号后后面空一个个半角

8、的格格，然后是是这一章的的标题。章必须另起起一页开始始打印。章的编号和和标题采用用左对齐的的格式放在在行的左边边，左缩进进为0。章的编号和和标题中汉汉字采用黑黑体小三号号字，章的的编号和标标题总长度度不能超过过一行。章的编号和和标题行距距取最小值值、12磅磅，段前、段段后分别取取24磅。1.1.2 节标标题的设置置节的编号格格式为“x.yy”。其中，xx为章的号号码，y为节的号号码，用阿阿拉伯数字字表示。节节的编号后后面空一个个半角的格格，然后是是这一节的的标题。原则上每一一节另起一一页开始打打印，但对对于每章的的第一节，如如果章标题题下无说明明文字，可可以将其与与章标题放放于一页之之中。节的

9、编号和和标题采用用左对齐的的格式放在在行的左边边，左缩进进为0。节的编号和和标题中汉汉字采用黑黑体四号字字，节的编编号和标题题总长度不不能超过一一行。节的编号和和标题行距距取最小值值、12磅磅，对于与与章标题处处于同页的的要将其段段前、段后后均取122磅，否则则段前取224磅、段段后取122磅。1.1.3 小节节标题的设设置小节的编号号格式为“x.yy.z”。其中x为章的号号码，y为节的号号码，z为小节号号码，用阿阿拉伯数字字表示。小小节的编号号后面空一一个半角的的格，然后后是这一小小节的标题题。小节不必另另起一页开开始打印。小节的编号号和标题采采用左对齐齐的格式放放在行的左左边，左缩缩进0.

10、774CM。小节的编号号和标题中中汉字采用用黑体小四四号字，小小节的编号号和标题总总长度不能能超过一行行。小节的编号号和标题行行距取最小小值、122磅，段前前取12磅磅。【注意】如果有必要要，还可以以在小节下下面划分更更小的节，我我们暂且称称之为小小小节。对于小小节节的各种规规定与小节节一致，为为保持版面面清晰，小小小节不再再相对于小小节向右缩缩进。在用户手册册中，系统统提示信息息采用幼圆圆五号字，其其余所有的的数字及字字母采用AAriall字体，字字号与相应应的汉字相相同。在本本规范中提提到的字体体如无特殊殊注明，均均指汉字字字体。用户手册中中，行距均均取最小值值、12磅磅。来自 .资料搜搜

11、索1.1.4 项目目符号和编编号的设置置在章、节、小小节、小小小节里面均均可以含有有项目符号号和编号。编号1. 编号序列相相对于与之之对应的标标题向右缩缩进0.774CM。2. 编号的格式式是“n.”，其中n为阿拉伯伯数字。3. 对于有名编编号序列名名称采用五五号黑体汉汉字，其后后面的内容容采用五号号宋体汉字字；对于无无名编号序序列中的内内容字体同同有名编号号序列。4. 编号序列里里还允许采采用二级编编号序列，其其格式规定定如下：“n)”，其中n为阿拉伯伯数字。5. 二级编号相相对于与之之对应的一一级编号向向右缩进00.74CCM。6. 其它规定和和一级编号号序列一致致。7. 编号及二级级编号

12、的行行间距取最最小值，112磅。一一级编号的的第一项段段前取122磅，其余余各项及二二级编号段段前均取66磅。项目符号项目符号相相对于与之之对应的标标题或编号号序列向右右缩进0.74CMM。项目符号的的格式是“”，其中“”字体为Wiingdiings，五五号字。对于有名项项目符号序序列，名称称采用五号号黑体汉字字，其后面面的正文采采用宋体五五号字，对对于无名项项目符号序序列中的内内容字体同同有名编号号序列。如果项目符符号序列处处于编号序序列的下级级，则各项项各项段前前均取6磅磅；否则首首项段前取取12磅，其其余各项段段前取6磅磅。【注意】项项目符号和和编号下的的叙述文字字相对于与与之对应的的项

13、目符号号或编号向向右缩进00.74CCM，首行行缩进0.74CMM，段前取取6磅。汉汉字字体取取宋体五号号。1.1.5 其它它编号的设设置页编号：用用户手册中中的正文按按章进行编编号，其格格式为“章-页”。如，第第2章的第第3页，编编号为“2-3”。页编号号放在页脚脚中，具体体设置方法法详见“页眉、页页脚设置”。图、表编号号：用户手册中中的图、表表均按章分分别进行编编号来自 .资料搜搜索，其格格式分别为为“图x-y”、“表x-y”。如，第第2章的第第3幅图的的编号是“图2-33”；第2章章的第3张张表格的编编号是“表2-33”。在图表表编号的后后面空一个个半角的格格，然后是是这一图表表的名称。

14、另另外，还规规定：表的编号与与名称放在在表的顶部部。表的编号与与名称和表表左对齐，而而整个表则则居中放置置。表的编号与与名称段后后取6磅。图的编号与与名称放在在图的底部部。图的编号与与名称和图图均居中放放置。图的编号与与名称段前前取6磅。图前面的正正文段后取取12磅。图、表的编编号与名称称中汉字采采用黑体五五号字。1.2 正文及页页眉、页脚脚的排版1.2.1 正文文排版正文排版包包括字符排排版、段落落排版、图图形排版和和版权声明明、目录等等的排版，本本节就这几几方面的格格式要求加加以详细阐阐述。字符排版：用户手册的的正文，系系统提示采采用幼圆五五号字体，其其余采用宋宋体五号字字。对于界面中中的

15、按钮名名称，应把把按钮名称称用“”括起来，按按钮名称用用黑体五号号字书写。对对于下拉菜菜单选项的的名称，应应用“”引起来来，选项名名称用宋体体五号字书书写。对于于热点，应应用“”引起来来，热点名名称用黑体体五号字书书写。正文均采用用常规字体体、标准位位置、标准准间距。段落排版：正文段落的的首行相对对于与之对对应的标题题或编号序序列向右缩缩进0.774CM。行距采用最最小值，112磅，除除项目符号号及编号以以及图形前前面正文按按前面所述述的特殊要要求进行排排版外，其其余段前均均取12磅磅。采取两端对对齐方式。图形的排版版：屏幕截图时时，应使所所截图片的的尺寸为最最大。对于尺寸较较大的图片片，可使

16、图图片的高度度和宽度按按同比例适适当缩小。必要时可适适当缩小或或将图片移移到下一页页，以保证证图片与图图号及图名名在同页。当正文中对对图标进行行说明时，应应使图标同同与之对应应的标题对对齐。为保证页面面清晰，可可适当调整整图标右侧侧说明文字字的行间距距以及段前前、段后。在屏幕截图图时，图片片中输入的的数据不能能包含本公公司员工的的真实姓名名。版权声明、目目录等的排排版：版权声明、前前言、阅读读指南、目目录的标题题为段前取取36磅，段段后取244磅，采用用黑体小三三号字；内内容排版与与手册正文文排版相同同。1.2.2 版面面设置1.2.2.1 版面面设置对于版面设设置作如下下规定：纸张大小：用户

17、手册册用纸统一一规定为116开。页边距：上上：30mmm；下：20mmm；内侧：21mmm；外侧：16mmm。另外采采用“对称页边边距”；对于版版面设置页页眉、页脚脚应选用“首页不同同”和“奇偶页不不同”。对于新项目目或新产品品可根据具具体情况对对版面设置置适当做一一些修改。1.2.2.2 关于于页眉、页页脚的设置置页眉的设置置：版权声明、前前言、阅读读指南、目目录均无篇篇眉。章编号和名名称所在页页的篇眉为为一行有550%填充充的边框。对于单号页页，页眉的的内容是当当前章的标标题名，要要求打印在在纸的右上上角。对于双号页页，页眉的的内容是用用户手册的的名称，要要求打印在在纸的左上上角。纸的顶边

18、与与页眉的距距离是233mm。页眉中汉字字采用幼圆圆小五号字字。页脚的设置置：页脚的内容容是当前页页的页编号号，如第22章第2页页为2-22。页编号的字字体采用AAriall五号字。纸的底边与与页脚的距距离是133mm。版权声明、前前言、阅读读指南、目目录的页脚脚为，等，居中中放置，不不带边框。1.2.2.3 注意意与警告在用户手册册中，对于于那些需要要用户特别别注意的事事项，应该该用“【注意】”作为标志志给用户以以特别的提提示。关于于注意标志志和注意事事项的格式式有如下规规定：注意标志同同与之对应应的标题对对齐。注意标志采采用黑体小小四号汉字字。注意标志段段前取122磅。如果注意事事项只有一

19、一条，其内内容应该紧紧跟在注意意标志的后后面书写；否则，应应该在注意意标志的下下一行开始始，采用编编号序列的的形式分别别给出。在用户手册册中，对于于那些会给给用户造成成重大损失失的行为，应应该用“【警告】”作为标志志给用户以以警告性的的提示。【注意】关关于警告标标志和警告告事项的格格式规定与与关于注意意标志和注注意事项的的格式规定定一致。1-9 第2章 用用户手册的的内容本章主要讨讨论编写用用户手册所所要达到的的目标、软软件用户手手册所应包包含的内容容、以及在在用户手册册编写过程程中所应保保持的风格格。如果标有“条件”字样，说说明该部分分内容是在在一定条件件下所必须须的。2.1 用户手册册的目

20、标某软件评测测中心把软软件产品评评测测试分分为两个阶阶段初评安安装测试和和复评测试试。只有通通过初评安安装测试的的软件才能能进入复评评测试，初初评安装测测试的内容容包括：按照软件用用户手册中中的安装说说明测试软软件能否顺顺利安装成成功。对照软件用用户手册测测试软件功功能是否与与手册描述述一致。评价产品包包装及用户户手册是否否符合商品品化要求。通过以上三三方面测试试且无严重重死机情况况的软件可可进入复评评测试。由此，我们们可以看到到软件用户户手册是一一个软件产产品的基础础，没有合合格的软件件用户手册册就根本谈谈不上合格格的软件产产品。另一一方面，良良好的安装装说明及软软件功能与与手册描述述的一致

21、性性是对软件件用户手册册的两个基基本要求。我们编写的的用户手册册要达到两两个目的：让用户手册册成为用户户学习使用用我们产品品的最好教教材。用户户通过阅读读用户手册册，应该对对我们产品品的功能、操操作有一定定的认识；按照用户户手册上的的说明，通通过实际操操作，用户户应该能够够掌握我们们产品的操操作过程。让用户手册册能够起到到降低销售售费用的作作用。用户户手册不仅仅应该包括括我们的产产品操作说说明，而且且还应该包包括系统（软软件和必要要的硬件）安安装、数据据维护、出出错处理等等。通过用用户手册，就就可以让用用户掌握在在使用我们们软件的过过程中出现现各种情况况的处理方方法。为达到这两两个目标，在在一

22、般情况况下，用户户手册应该该包含如下下几个方面面的内容：封面二封版权声明前言阅读指南目录基础知识介介绍条件件系统安装(包括必要要的硬件安安装)及启动系统操作说说明系统及数据据维护例题条件件各种附录【注意】如如果本系统统软件是一一个大系统统，其系统统安装、操操作说明、系系统及数据据维护都相相当复杂，则则可以把这这三个部分分分别编写写为一本甚甚至几本用用户手册，每每本手册都都有自己的的封面、版版权声明、前前言、阅读读指南、目目录以及相相应的基础础知识介绍绍和附录。2.2 用户手册册的内容2.2.1 封面面封面内容应应包括公司司的ICOON、软件件名称及版版本号、公公司名称及及手册印刷刷时间。2.2

23、.2 二封二封正面为为软件名称称及版本号号、公司名名称、手册册印刷时间间、公司地地址及服务务电话等。以以EDD44.0手册册为例，其其形式如下下：EDD/AAutoCCAD RR14 VV4.0用用户手册 沈阳东大大阿尔派软软件股份有有限公司地址：沈阳阳市和平区区三好街884-2号号电话：(0024)2238411748 (0244)2377830000传真：(0024)2238900817 (0244)2377822666客户服务热热线：8000-8990-80000Emaill：Serrviceeneuu-alppine.2.2.3 版权声明明版权声明是是保护我们们所开发软软件的产权权、不

24、使我我们公司利利益受到损损害的一种种方式。在在版权声明明中应该包包括以下内内容：对我们所提提供的软件件及用户手手册的保护护声明。对我们的软软件及商标标 所有权的的声明。对我们的用用户手册中中所提到的的各种商标标的版权声声明条件件。我们不对用用户因为使使用我们的的软件所造造成的损失失负责的声声明。具体请参考考本规范的的版权声明明。2.2.4 前言言对于前言所所应包含的的内容经常常根据用户户手册编写写人员的习习惯不同而而不同，有有时仅仅包包含了系统统的开发背背景和目的的，有时还还包含了系系统简介，有有时甚至还还包含了用用户手册的的阅读指南南。为了统一起起见，在这这里我们规规定前言主主要包括以以下内

25、容：系统的开发发背景和目目的。系统所能应应用的领域域和使用对对象。系统的功能能及特性简简介。如果本手册册不是该系系统的第一一个版本，还还应该简介介较上一版版本的改进进部分。2.2.5 阅读读指南阅读指南是是每本(套)用户手册册必不可少少的组成部部分，用户户通过它可可以了解到到用户手册册的基本内内容；了解解到应该如如何、从哪哪儿开始阅阅读该用户户手册。用用户手册的的阅读指南南应该包含含如下几部部分：手册目标：通过阅读读该用户手手册，用户户应该或能能够达到什什么目标。阅读对象：指明什么么人员应该该阅读该手手册，或什什么人员应应该阅读本本手册的哪哪些部分；阅读对象象在阅读本本手册之前前应该掌握握哪些

26、知识识，必要时时应给出资资料清单，以以便用户查查阅。手册构成：如果本系系统的用户户手册(包括管理理员手册、参参考手册)由几本组组成，首先先应该分别别简要介绍绍这些手册册的情况。最最根本的是是应该介绍绍本手册在在哪一章或或哪几章讲讲解了什么么内容，对对于较大系系统，如UUniveersall Offfice 3.5，分分别介绍每每一章内容容比较繁琐琐，则可概概括性地介介绍。手册约定：这一部分分应该包括括字体的约约定、特殊殊符号的约约定以及【注注意】、【警警告】、【说说明】等的的含义。必必要时，应应该给出某某些基本术术语的定义义。也可以以把基本术术语、概念念的定义作作为基础知知识来介绍绍。具体请参

27、考考本规范的的阅读指南南。2.2.6 目录目录的编写写要尽量详详尽。如果果用户手册册的内容用用到小节，则则目录就应应该编写到到小节；如如果用户手手册的内容容用到小小小节，则目目录就应该该编写到小小小节。编编写用户手手册目录的的目的就是是为了让用用户能够根根据它很快快地找到想想要的内容容。有关格式请请参考本规规范目录的的编写。2.2.7 基础础知识介绍绍条件这一部分内内容是在一一定条件下下必需的，用用户手册编编写人员应应该根据实实际情况确确定是否需需要这一部部分。如果果包括基础础知识介绍绍，应将其其放在第11章。在一般情况况下，使用用我们的软软件系统需需要一定的的基础知识识。这些知知识可以从从有

28、关书籍籍上得到，但但是用户从从这些资料料得到这些些知识需要要花费相当当的时间。在在某些情况况下，我们们只需要用用户掌握用用户手册中中使用的那那些概念，那那么我们就就有必要编编写一章“基础知识识介绍”来进行专专门介绍。比如说，在在工厂管道道设计系统统用户手册册中，经常常用到按下下鼠标“数据键”、“捕捉键”、“复位键”的概念，用用户虽然可可以从MMicroostattion的的用户手册册中得到到这些概念念，但是比比较不方便便。由于我我们编写用用户手册的的主要目标标就是方便便用户，所所以有必要要在用户手手册的一开开始就介绍绍这些概念念。2.2.8 系统统安装及启启动如果手册中中包括基础础知识介绍绍，

29、应把系系统安装及及启动作为为第2章，否否则，将其其作为第11章首先向向读者予以以介绍。系统安装及及启动部分分应该包括括如下内容容：系统的运行行环境硬件环境要要求说明：系统运行行时所需硬硬件环境描描述。包括括机型、内内存大小、硬硬盘空间等等。如果必必要，还应应包括输入入/输出设备备、通讯环环境等。软件环境要要求说明：系统运行行时所需软软件支持环环境的描述述。包括所所需任何其其它软件的的名称及版版本号等。其它环境要要求说明条件：应该说明明要求的任任何其它环环境。系统的安装装对于不同的的系统其安安装应有所所区别，一一般来说，应应给出最终终用户能够够据此把软软件安装到到其操作系系统并配置置完成，且且能

30、成功运运行的任何何信息和操操作。系统统的安装包包括软件的的安装过程程及系统环环境的配置置条件，必要时时还应给出出硬件的安安装条件件。硬件安装条件：如果必要要，应该详详细说明系系统所需硬硬件环境的的安装过程程，其中包包括软件加加密锁的安安装。软件安装：应该用图示示方法详细细介绍软件件的安装过过程。对于于来自 .资料搜搜索网络版版软件，应应对服务器器端及客户户端的安装装分别予以以介绍（可可参考文档档管理系统统SEASS20000-AMSS 5.00）。如果果二者安装装过程相似似，可以详详细介绍一一种，另一一种参考前前一种即可可。如果软软件由多个个模块构成成，且其中中部分模块块需单独安安装，如UUn

31、iveersall Offfice 3.5，则则应分别给给出安装步步骤。所有产品的的安装包括括以下界面面：安装快快闪界面条件、安安装初始窗窗口（欢迎迎）、版权权声明界面面、选择安安装路径界界面、选择择程序文件件夹（程序序组）界面面条件、安装进进程界面条件及及安装完成成界面。系统配置条件：应给出系系统配置的的详细过程程，以便用用户能够顺顺利操作系系统。对于于网络版软软件，应分分别讲述服服务器和客客户端的配配置过程。系统的启动动：应给出出系统启动动的方法。如如果系统由由多个模块块组成，则则不必单列列出一节讲讲述系统的的启动方法法，只须在在介绍各个个模块的操操作时给出出模块的启启动方法即即可。对于系

32、统的的安装及启启动的结构构总结如下下，供编写写用户手册册时参考：|-系统统的运行环环境 |-硬件环环境| |-软软件环境|系统的安装装及启动 | |-硬硬件安装|-系统统的安装 |-软软件安装| |-系系统的配置置|-系统统的启动2.2.9 系统统操作说明明系统操作说说明是所有有用户手册册的主体，它它所包含的的内容相当当广泛。主主要包括：输入的命命令和数据据、软件的的功能、输输出结果、出出错信息及及其矫正和和恢复方法法。对于不同的的软件，其其操作说明明也应有所所不同，下下面就几种种情况分别别予以介绍绍。2.2.9.1 CAD软软件CAD软件件的操作说说明应包括括文件管理理、图纸尺尺寸设置、图图

33、形绘制、图图形编辑、尺尺寸标注、图图层管理、图图库调用条件、图图库维护条件及及附录条条件等内内容。在用户手册册中应按操操作顺序或或界面中菜菜单顺序分分别对上述述内容中的的每一项操操作予以介介绍。要求求详细给出出操作过程程及命令格格式与功能能，具体规规定如下：各种操作、命命令和语言言：软件系系统的使用用过程都是是使用软件件系统提供供的各种操操作、命令令和语言的的过程。所所以，我们们必须做到到：操作和命令令：在用户户手册中详详细给出各各种操作的的过程和功功能、命令令的格式和和功能；应应当描述在在使用上的的各种限制制，如，操操作状态、操操作条件、操操作序列等等。另外，必必要时可以以通过适当当地举例讲

34、讲述各种操操作和命令令的使用方方法，以帮帮助用户理理解。输出信息：应该详细细列出与操操作、命令令相关的各各种输出信信息。如果果输出信息息的意思本本身不是很很明显，应应当给予解解释。另外外还应当说说明对于这这些信息所所采取的操操作。程序设计语语言条件件：如果果我们的软软件系统提提供了某种种语言，对对其语言规规则应当给给予说明。各种数据：在软件的的使用过程程中，用户户必须与各各种数据和和信息打交交道。为了了让用户能能够操作我我们的软件件，我们必必须为用户户提供各种种结构以及及每个数据据元素的含含义有些数据适适合在系统统操作说明明中给出，有有些适合在在后面的附附录中给出出，甚至有有些除了在在操作说明

35、明的同时给给出外，还还要在附录录中给予归归纳，这些些都由用户户手册编写写人员根据据实际情况况来决定。这这些数据包包括：1) 输入入数据条条件：应应该给出数数据的内容容、逻辑结结构、格式式以及每一一个数据元元素的意思思。如果输输入数据依依赖于某特特定数据介介质，则应应当给予说说明。2) 输出出数据：应应当给出软软件以何种种形式输出出的数据的的内容和格格式，并要要求以例样样的形式给给予说明。3) 中间间数据条条件：如如果我们告告诉用户在在软件的运运行过程中中所产生的的中间数据据的内容和和格式，有有助于用户户理解软件件的使用，则则应当给予予说明4) 数据据限制条条件：如如果对数据据有限制，如如数据的

36、大大小限制，则则应当给予予说明。5) 数据据文件条条件：如如果要告诉诉用户我们们的软件所所使用的某某些数据文文件的结构构有助于用用户理解我我们软件的的使用，则则应给予说说明，但应应该注意技技术保密。如如果对数据据文件有所所限制，例例如每个文文件的最大大记录数、每每个磁盘的的最大文件件数等，应应当给予说说明。处理过程条件：如果我们们简要地给给用户描述述我们软件件对用户的的操作、输输入的命令令和输入数数据的处理理过程，有有助于用户户了解我们们软件的使使用，则应应给予说明明。截图内容：目前，多多数软件已已不再采用用命令行输输入方式，而而是采用对对话框输入入方式。在在此情况下下，应该以以图示方式式对软

37、件的的操作过程程予以介绍绍。采用图图示方式讲讲述软件操操作过程应应注意以下下几点：所截图形的的输入、输输出信息中中不应包含含本公司人人员的真实实姓名，且且各种输入入、输出信信息以不泄泄漏公司机机密为原则则。截图是为使使叙述更加加明确、简简洁，所以以应尽量避避免不必要要的截图。一一般来说，在在用户手册册中应该包包括系统的的主界面、各各种操作的的初始界面面（点取命命令后弹出出的第一个个界面，一一般需要输输入信息）、操操作中间过过程界面、操操作结果界界面以及其其它一些必必要的界面面。没有必必要为下拉拉菜单、快快捷菜单等等内容截图图，因为这这些操作都都比较简单单，只要用用语言叙述述用户即可可明确其操操

38、作方法。另另外，在同同一本手册册中，应避避免重复截截图，对于于不同输入入或输出信信息的同一一界面在手手册中不应应重复（例例题除外）。出错处理：应当给出出各种出错错情况以及及相应的处处理措施。现对系统操操作说明的的步骤总结结如下，供供编写用户户手册时参参考：进入相关界界面。调用命令（选选择菜单、键键入命令或或点击工具具按钮）。弹出相应的的操作初始始界面（或或提示行）。对输入信息息给予说明明。继续操作（点点击按钮或或选择参数数及键入按按键等）。结果界面（或或结果提示示行）。对输出信息息给予说明明。【警告】在在编写软件件用户手册册的系统操操作说明时时，我们在在决定是否否提供某种种数据的格格式时，应应

39、以不泄漏漏公司的技技术而且有有利于用户户使用为准准则。2.2.9.2 其它软件件对于一些比比较复杂的的软件，一一般包括多多个模块。对对于此类系系统，要求求按照操作作顺序对各各个模块分分别介绍。一一般按模块块分成若干干章，在各各章中对相相关模块的的操作予以以介绍。对对于此类软软件的操作作步骤总结结如下：启动某一模模块，进入入该模块的的主界面。执行某一功功能（选择择菜单或工工具按钮）。弹出相关界界面。对输入信息息予以说明明。继续操作（点点击按钮）。结果界面。对输出信息息予以说明明。有些软件的的操作可能能需要一定定的技术和和经验才能能获得满意意的结果，那那么应该在在用户手册册上尽量给给出这些技技术和

40、经验验的描述，或或告诉用户户如何才能能获得这些些技术和经经验。例如如，在操作作SEASS系统作图图纸净化处处理时，如如何选择适适当的阀值值就需要一一定的技术术和经验。一些比较简简单的系统统，如NeetEyee、OpeenViddeo等其其系统操作作比较简单单，操作说说明内容比比较少。对对于此类软软件，手册册中可以将将操作说明明归纳为一一章，再按按操作顺序序予以介绍绍。另外，对于于各种操作作、命令、语语言、数据据及截图内内容的规定定同CADD软件。2.2.10 系系统及数据据维护应该给出用用户数据的的备份、恢恢复、删除除、整理的的详细过程程。如果必必要，应该该给出系统统数据、系系统磁盘空空间维护

41、的的详细过程程。2.2.11 例题条件件有些软件系系统可以通通过一个较较为完整的的例题演示示系统部分分功能的使使用方法，在在这个例题题中，用户户应该详细细地描述每每一步的操操作过程，用用户可以通通过这个例例题对系统统的操作有有一个初步步的了解。2.2.12 各各种附录在用户手册册中，有些些知识和信信息可以通通过附录的的形式提供供给用户，以以便于用户户查阅，这这些内容是是：1. 错误误提示信息息：通常可可以以表的的形式按照照一定的顺顺序，例如如按出错提提示信息编编号顺序、或或按出错提提示信息的的字母顺序序，给出出出错提示信信息的编号号、提示信信息、相应应的解释、出出错原因和和解决办法法2. 命令

42、令速查表条件：通常可以以以表的形形式按照一一定的顺序序给出各种种命令的概概要(包括命令令名称、各各种参数、及及相应的功功能介绍)，以帮助助有一定经经验的用户户进行快速速查找所需需信息3. 数据据文件格式式条件：可以通通过附录介介绍用户必必须了解或或可以了解解的各种输输入数据文文件、输出出结果文件件、中间数数据文件的的格式、限限制范围、适适当的解释释等4. 其它它信息 条件：任何其其它有利于于用户使用用我们的软软件、方便便用户的信信息都可以以以附录的的形式提供供给用户【注意】虽虽然附录所所提供的信信息可能均均可以在系系统操作说说明中查到到，但提供供附录的目目的就是为为了方便用用户使用，这这种重复

43、还还是必要的的。2.3 用户手册册的风格用户手册应应具有自己己的风格。有有的人喜欢欢用比较深深奥的概念念和语言来来说明问题题，有的人人喜欢用比比较长的句句子来表达达思想，在在编制用户户手册的过过程中这些些都是不可可取的。用用户手册应应该具备如如下特点：用户手册的的句子尽量量简洁：如果用一一个句子表表达起来比比较复杂，定定语多，则则可以分成成两个甚至至几个句子子来说明，这这样用户在在阅读用户户手册时会会轻松些。每节、段的的内容明确确：每节的的内容必须须明确，这这样用户可可以通过目目录很方便便地查到自自己所需要要的内容；注意段的的划分，每每段不要太太长，突出出重点，否否则用户不不容易获得得其中的精

44、精华。用户手册的的用词要前前后一致：在用户手手册中使用用的概念、术术语的用词词要前后一一致，否则则用户将不不容易读懂懂此手册。用户不一定定是计算机机专家：用用户手册编编写人员应应该牢牢记记住这一点点，我们的的大多数用用户都不是是学计算机机的，手册册中应该尽尽量不使用用较深奥的的计算机术术语。如果果不可避免免，我们应应该给予适适当的解释释和说明。另另外，不要要以为我们们的用户什什么都懂，所所以在编写写用户手册册的时候，应应该详细地地描述操作作过程中的的每一步。用户手册各各部分风格格应该统一一：一些较较大的系统统可能由多多人开发和和测试，如如Univversaal Offficee 3.55，从而造造成用户手手册各部分分风格各异异，这就要要求用户手手册编排人人员最终将将各部分统统一成风格格相同的一一本手册。来自 .资料搜搜索2-15