《某软件公司用户手册编制规范46478.docx》由会员分享，可在线阅读，更多相关《某软件公司用户手册编制规范46478.docx（44页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、第1章 关于标题及编号的规定Evaluation Warning: The document was created with Spire.Doc for .NET.用户手册编编制规范范沈阳东大阿阿尔派软软件股份份有限公公司2000.21-6第1章 用户手册格式的统一规定版权声明用户手册册编制规规范的的版权归归沈阳东东大阿尔尔派软件件股份有有限公司司所有。未未经沈阳阳东大阿阿尔派软软件股份份有限公公司的书书面准许许，不得得将本规规范的任任何部分分以任何何形式、采采用任何何手段(电子的的或机械械的，包包括照相相复制或或录制)、或为为任何目目的，进进行复制制或扩散散。(c)Coopyrrighht
2、 220000 沈阳阳东大阿阿尔派软软件股份份有限公公司。版版权所有有，翻制制必究。 是沈阳东东大阿尔尔派软件件股份有有限公司司的注册册商标。Microosofft、worrd是Miccrossoftt Coorpoorattionn的注册册商标。Windoows是是Miccrossoftt Coorpoorattionn的商标标。1-10 前 言用户手册对对于任何何产品都都是不可可缺少的的组成部部分。一一个好的的产品没没有一份份完备的的用户手手册，也也不能算算作一个个完备的的产品。对对于软件件产品来来说更是是如此，没没有用户户手册的的软件不不能算产产品，没没有好的的用户手手册，就就不可能能算
3、好产产品。也也就是说说，一个个好的软软件产品品除了具具备与市市场对路路的思想想、良好好的用户户界面、完完备的测测试之外外，还必必须有一一本适合合用户使使用的用用户手册册。本规范手册册不仅指指明了软软件用户户手册的的内容，而而且规定定了沈阳阳东大阿阿尔派软软件股份份有限公公司软件件用户手手册的统统一版面面、格式式。本规规范手册册就是按按本规定定编写的的，但由由于本规规范手册册内容的的局限性性，很难难以样本本的形式式表现软软件用户户手册中中可能出出现的各各种情况况，所以以请大家家认真阅阅读本规规范手册册的内容容。我们希望沈沈阳东大大阿尔派派软件股股份有限限公司的的相关人人员，能能够按照照本规范范手
4、册编编写自己己的软件件用户手手册，做做好我们们的软件件产品化化工作。由由于时间间仓促，编编者水平平有限，希希望大家家能够提提出宝贵贵意见，以以逐步完完善本规规范手册册的内容容。i 阅读指南手册目标标本手册主要要对沈阳阳东大阿阿尔派软软件股份份有限公公司软件件产品的的用户手手册所应应包含的的内容及及版面格格式作一一个初步步的统一一规定。由由于实际际情况千千变万化化，本规规定很难难一次做做到面面面俱到，需需要逐渐渐完善。阅读对象象本手册是为为沈阳东东大阿尔尔派软件件股份有有限公司司的所有有软件开开发人员员和软件件用户手手册编写写人员所所编写的的。由于于本手册册中的格格式规定定部分是是根据 Micc
5、rossoftt Wiindoows 下的 WWordd 的功功能而编编写的，所所以沈阳阳东大阿阿尔派软软件股份份有限公公司的软软件用户户手册应应该使用用 MiicrooSoftt Woord排排版。手册构成成本手册基本本上由两两部分组组成：第1章，“关于用用户手册册排版格格式的规规定”，规定定了用户户手册标标题及编编号的格格式。第2章，“用户手手册的内内容”，规定定了用户户手册所所应包含含内容较较为详细细的清单单。另外，本手手册基本本上是按按“用户手手册格式式的统一一规定”编写的的一个样样本。手册约定定本手册遵循循以下约约定：所有标题均均使用黑黑体字。如果标题后后跟有“条件件”字样，说说明该
6、标标题下正正文所要要求的内内容是在在一定条条件下必必须的。【注意】的的意思是是请读者者注意那那些需要要注意的的事项。【警告】的的意思是是请读者者千万注注意某些些事项，否否则将造造成严重重错误。i目 录第1章 用用户手册册格式规规定1-111.1 标题及及编号1-11.1.1 章标题题的设置置1-11.1.2 节标题题的设置置1-11.1.3 小节标标题的设设置1-11.1.4项目目符号和和编号的的设置1-21.1.5 其其它编号号的设置置1-31.2 正文及及页眉页页脚的排排版1-441.2.1 正文排排版1-551.2.2 版面设设置1-551.2.2.11 版面面设置1-551.2.2.2
7、2 关于于页眉、页页脚的设设置1-551.2.2.33 注意意与警告告1-55第2章 用用户手册册的内容容2-112.1 用户手手册的目目标2-442.2 用户手手册的内内容2-442.2.1 封封面2-442.2.2 二二封2-442.2.3 版版权声明明2-442.2.4 前前言2-442.2.5 阅阅读指南南2-552.2.6目录录2-552.2.7基础础知识介介绍条条件2-552.2.8 系系统安装装及启动动2-662.2.9 系系统操作作说明2-772.2.9 11 CAAD软件件2-772.2.9 22 其它它软件2-992.2.10 系统及及数据维维护2-992.2.11 例题条
8、件2-1102.2.12 各种附附录2-1102.3 用户手手册的风风格2-111第1章 用户手册格式的规定第1章 用用户手册册格式的的规定1.1 标题及及编号一般情况下下，用户户手册用用章、节节来划分分其内容容，必要要时还可可引入小小节、小小小节的的概念。1.1.1 章章标题的的设置每章的编号号用阿拉拉伯数字字表示，采采用“第1章”、“第2章章”、的形形式表示示章的编编号，章章的编号号后面空空一个半半角的格格，然后后是这一一章的标标题。章必须另起起一页开开始打印印。章的编号和和标题采采用左对对齐的格格式放在在行的左左边，左左缩进为为0。章的编号和和标题中中汉字采采用黑体体小三号号字，章章的编
9、号号和标题题总长度度不能超超过一行行。章的编号和和标题行行距取最最小值、112磅，段段前、段段后分别别取244磅。1.1.2 节节标题的的设置节的编号格格式为“x.y”。其中中，x为章的的号码，y为节的号码，用阿拉伯数字表示。节的编号后面空一个半角的格，然后是这一节的标题。原则上每一一节另起起一页开开始打印印，但对对于每章章的第一一节，如如果章标标题下无无说明文文字，可可以将其其与章标标题放于于一页之之中。节的编号和和标题采采用左对对齐的格格式放在在行的左左边，左左缩进为为0。节的编号和和标题中中汉字采采用黑体体四号字字，节的的编号和和标题总总长度不不能超过过一行。节的编号和和标题行行距取最最
10、小值、112磅，对对于与章章标题处处于同页页的要将将其段前前、段后后均取112磅，否否则段前前取244磅、段段后取112磅。1.1.3 小小节标题题的设置置小节的编号号格式为为“x.y.zz”。其中中x为章的的号码，y为节的号码，z为小节号码，用阿拉伯数字表示。小节的编号后面空一个半角的格，然后是这一小节的标题。小节不必另另起一页页开始打打印。小节的编号号和标题题采用左左对齐的的格式放放在行的的左边，左左缩进00.744CM。小节的编号号和标题题中汉字字采用黑黑体小四四号字，小小节的编编号和标标题总长长度不能能超过一一行。小节的编号号和标题题行距取取最小值值、122磅，段段前取112磅。【注意
11、】如果有必要要，还可可以在小小节下面面划分更更小的节节，我们们暂且称称之为小小小节。对于小小节节的各种种规定与与小节一一致，为为保持版版面清晰晰，小小小节不再再相对于于小节向向右缩进进。在用户手册册中，系系统提示示信息采采用幼圆圆五号字字，其余余所有的的数字及及字母采采用Arriall字体，字字号与相相应的汉汉字相同同。在本本规范中中提到的的字体如如无特殊殊注明，均均指汉字字字体。用户手册中中，行距距均取最最小值、112磅。来自 .资料搜索1.1.4 项项目符号号和编号号的设置置在章、节、小小节、小小小节里里面均可可以含有有项目符符号和编编号。编号1. 编号序列相相对于与与之对应应的标题题向右
12、缩缩进0.74CCM。2. 编号的格式式是“n.”，其中中n为阿拉拉伯数字字。3. 对于有名编编号序列列名称采采用五号号黑体汉汉字，其其后面的的内容采采用五号号宋体汉汉字；对对于无名名编号序序列中的的内容字字体同有有名编号号序列。4. 编号序列里里还允许许采用二二级编号号序列，其其格式规规定如下下：“n)”，其中中n为阿拉拉伯数字字。5. 二级编号相相对于与与之对应应的一级级编号向向右缩进进0.774CMM。6. 其它规定和和一级编编号序列列一致。7. 编号及二级级编号的的行间距距取最小小值，112磅。一一级编号号的第一一项段前前取122磅，其其余各项项及二级级编号段段前均取取6磅。项目符号项
13、目符号相相对于与与之对应应的标题题或编号号序列向向右缩进进0.774CMM。项目符号的的格式是是“”，其中中“”字体为为Winngdiingss，五号号字。对于有名项项目符号号序列，名名称采用用五号黑黑体汉字字，其后后面的正正文采用用宋体五五号字，对对于无名名项目符符号序列列中的内内容字体体同有名名编号序序列。如果项目符符号序列列处于编编号序列列的下级级，则各各项各项项段前均均取6磅磅；否则则首项段段前取112磅，其其余各项项段前取取6磅。【注意】项项目符号号和编号号下的叙叙述文字字相对于于与之对对应的项项目符号号或编号号向右缩缩进0.74CCM，首首行缩进进0.774CMM，段前前取6磅磅。
14、汉字字字体取取宋体五五号。1.1.5 其其它编号号的设置置页编号：用用户手册册中的正正文按章章进行编编号，其其格式为为“章-页”。如，第第2章的的第3页页，编号号为“2-33”。页编编号放在在页脚中中，具体体设置方方法详见见“页眉、页页脚设置置”。图、表编号号：用户手册中中的图、表表均按章章分别进进行编号号来自 .资料料搜索，其其格式分分别为“图x-yy”、“表x-yy”。如，第第2章的的第3幅幅图的编编号是“图2-3”；第22章的第第3张表表格的编编号是“表2-3”。在图图表编号号的后面面空一个个半角的的格，然然后是这这一图表表的名称称。另外外，还规规定：表的编号与与名称放放在表的的顶部。表
15、的编号与与名称和和表左对对齐，而而整个表表则居中中放置。表的编号与与名称段段后取66磅。图的编号与与名称放放在图的的底部。图的编号与与名称和和图均居居中放置置。图的编号与与名称段段前取66磅。图前面的正正文段后后取122磅。图、表的编编号与名名称中汉汉字采用用黑体五五号字。1.2 正文及及页眉、页页脚的排排版1.2.1 正正文排版版正文排版包包括字符符排版、段段落排版版、图形形排版和和版权声声明、目目录等的的排版，本本节就这这几方面面的格式式要求加加以详细细阐述。字符排版：用户手册的的正文，系系统提示示采用幼幼圆五号号字体，其其余采用用宋体五五号字。对于界面中中的按钮钮名称，应应把按钮钮名称用
16、用“”括起来来，按钮钮名称用用黑体五五号字书书写。对对于下拉拉菜单选选项的名名称，应应用“”引起起来，选选项名称称用宋体体五号字字书写。对对于热点点，应用用“”引起起来，热热点名称称用黑体体五号字字书写。正文均采用用常规字字体、标标准位置置、标准准间距。段落排版：正文段落的的首行相相对于与与之对应应的标题题或编号号序列向向右缩进进0.774CMM。行距采用最最小值，112磅，除除项目符符号及编编号以及及图形前前面正文文按前面面所述的的特殊要要求进行行排版外外，其余余段前均均取122磅。采取两端对对齐方式式。图形的排版版：屏幕截图时时，应使使所截图图片的尺尺寸为最最大。对于尺寸较较大的图图片，可
17、可使图片片的高度度和宽度度按同比比例适当当缩小。必要时可适适当缩小小或将图图片移到到下一页页，以保保证图片片与图号号及图名名在同页页。当正文中对对图标进进行说明明时，应应使图标标同与之之对应的的标题对对齐。为保证页面面清晰，可可适当调调整图标标右侧说说明文字字的行间间距以及及段前、段段后。在屏幕截图图时，图图片中输输入的数数据不能能包含本本公司员员工的真真实姓名名。版权声明、目目录等的的排版：版权声明、前前言、阅阅读指南南、目录录的标题题为段前前取366磅，段段后取224磅，采采用黑体体小三号号字；内内容排版版与手册册正文排排版相同同。1.2.2 版版面设置置1.2.2.1 版版面设置置对于版
18、面设设置作如如下规定定：纸张大小：用户手手册用纸纸统一规规定为116开。页边距：上上：300mm；下下：200mm；内内侧：221mmm；外侧侧：166mm。另另外采用用“对称页页边距”；对于于版面设设置页眉眉、页脚脚应选用用“首页不不同”和“奇偶页页不同”。对于新项目目或新产产品可根根据具体体情况对对版面设设置适当当做一些些修改。1.2.2.2 关关于页眉眉、页脚脚的设置置页眉的设置置：版权声明、前前言、阅阅读指南南、目录录均无篇篇眉。章编号和名名称所在在页的篇篇眉为一一行有550%填填充的边边框。对于单号页页，页眉眉的内容容是当前前章的标标题名，要要求打印印在纸的的右上角角。对于双号页页，
19、页眉眉的内容容是用户户手册的的名称，要要求打印印在纸的的左上角角。纸的顶边与与页眉的的距离是是23mmm。页眉中汉字字采用幼幼圆小五五号字。页脚的设置置：页脚的内容容是当前前页的页页编号，如如第2章章第2页页为2-2。页编号的字字体采用用Ariial五五号字。纸的底边与与页脚的的距离是是13mmm。版权声明、前前言、阅阅读指南南、目录录的页脚脚为，等，居居中放置置，不带带边框。1.2.2.3 注注意与警警告在用户手册册中，对对于那些些需要用用户特别别注意的的事项，应应该用“【注意意】”作为标标志给用用户以特特别的提提示。关关于注意意标志和和注意事事项的格格式有如如下规定定：注意标志同同与之对对
20、应的标标题对齐齐。注意标志采采用黑体体小四号号汉字。注意标志段段前取112磅。如果注意事事项只有有一条，其其内容应应该紧跟跟在注意意标志的的后面书书写；否否则，应应该在注注意标志志的下一一行开始始，采用用编号序序列的形形式分别别给出。在用户手册册中，对对于那些些会给用用户造成成重大损损失的行行为，应应该用“【警告告】”作为标标志给用用户以警警告性的的提示。【注意】关关于警告告标志和和警告事事项的格格式规定定与关于于注意标标志和注注意事项项的格式式规定一一致。1-11 第2章 用用户手册册的内容容本章主要讨讨论编写写用户手手册所要要达到的的目标、软软件用户户手册所所应包含含的内容容、以及及在用户
21、户手册编编写过程程中所应应保持的的风格。如果标有“条件件”字样，说说明该部部分内容容是在一一定条件件下所必必须的。2.1 用户手手册的目目标某软件评测测中心把把软件产产品评测测测试分分为两个个阶段初评评安装测测试和复复评测试试。只有有通过初初评安装装测试的的软件才才能进入入复评测测试，初初评安装装测试的的内容包包括：按照软件用用户手册册中的安安装说明明测试软软件能否否顺利安安装成功功。对照软件用用户手册册测试软软件功能能是否与与手册描描述一致致。评价产品包包装及用用户手册册是否符符合商品品化要求求。通过以上三三方面测测试且无无严重死死机情况况的软件件可进入入复评测测试。由此，我们们可以看看到软
22、件件用户手手册是一一个软件件产品的的基础，没没有合格格的软件件用户手手册就根根本谈不不上合格格的软件件产品。另另一方面面，良好好的安装装说明及及软件功功能与手手册描述述的一致致性是对对软件用用户手册册的两个个基本要要求。我们编写的的用户手手册要达达到两个个目的：让用户手册册成为用用户学习习使用我我们产品品的最好好教材。用用户通过过阅读用用户手册册，应该该对我们们产品的的功能、操操作有一一定的认认识；按按照用户户手册上上的说明明，通过过实际操操作，用用户应该该能够掌掌握我们们产品的的操作过过程。让用户手册册能够起起到降低低销售费费用的作作用。用用户手册册不仅应应该包括括我们的的产品操操作说明明，
23、而且且还应该该包括系系统（软软件和必必要的硬硬件）安安装、数数据维护护、出错错处理等等。通过过用户手手册，就就可以让让用户掌掌握在使使用我们们软件的的过程中中出现各各种情况况的处理理方法。为达到这两两个目标标，在一一般情况况下，用用户手册册应该包包含如下下几个方方面的内内容：封面二封版权声明前言阅读指南目录基础知识介介绍条条件系统安装(包括必必要的硬硬件安装装)及启动动系统操作说说明系统及数据据维护例题条件件各种附录【注意】如如果本系系统软件件是一个个大系统统，其系系统安装装、操作作说明、系系统及数数据维护护都相当当复杂，则则可以把把这三个个部分分分别编写写为一本本甚至几几本用户户手册，每每本
24、手册册都有自自己的封封面、版版权声明明、前言言、阅读读指南、目目录以及及相应的的基础知知识介绍绍和附录录。2.2 用户手手册的内内容2.2.1 封封面封面内容应应包括公公司的IICONN、软件件名称及及版本号号、公司司名称及及手册印印刷时间间。2.2.2 二封二封正面为为软件名名称及版版本号、公公司名称称、手册册印刷时时间、公公司地址址及服务务电话等等。以EEDD44.0手手册为例例，其形形式如下下：EDD/AAutooCADD R114 VV4.00用户手手册 沈阳东大大阿尔派派软件股股份有限限公司地址：沈阳阳市和平平区三好好街844-2号号电话：(0024)2388417748 (0024
25、)2377830000传真：(0024)2388908817 (0024)2377822266客户服务热热线：8800-8900-80000Emaill：Seerviiceneuu-allpinne.2.2.3 版权声声明版权声明是是保护我我们所开开发软件件的产权权、不使使我们公公司利益益受到损损害的一一种方式式。在版版权声明明中应该该包括以以下内容容：对我们所提提供的软软件及用用户手册册的保护护声明。对我们的软软件及商商标 所有权权的声明明。对我们的用用户手册册中所提提到的各各种商标标的版权权声明条件。我们不对用用户因为为使用我我们的软软件所造造成的损损失负责责的声明明。具体请参考考本规范范
26、的版权权声明。2.2.4 前前言对于前言所所应包含含的内容容经常根根据用户户手册编编写人员员的习惯惯不同而而不同，有有时仅仅仅包含了了系统的的开发背背景和目目的，有有时还包包含了系系统简介介，有时时甚至还还包含了了用户手手册的阅阅读指南南。为了统一起起见，在在这里我我们规定定前言主主要包括括以下内内容：系统的开发发背景和和目的。系统所能应应用的领领域和使使用对象象。系统的功能能及特性性简介。如果本手册册不是该该系统的的第一个个版本，还还应该简简介较上上一版本本的改进进部分。2.2.5 阅阅读指南南阅读指南是是每本(套)用户手手册必不不可少的的组成部部分，用用户通过过它可以以了解到到用户手手册的
27、基基本内容容；了解解到应该该如何、从从哪儿开开始阅读读该用户户手册。用用户手册册的阅读读指南应应该包含含如下几几部分：手册目标：通过阅阅读该用用户手册册，用户户应该或或能够达达到什么么目标。阅读对象：指明什什么人员员应该阅阅读该手手册，或或什么人人员应该该阅读本本手册的的哪些部部分；阅阅读对象象在阅读读本手册册之前应应该掌握握哪些知知识，必必要时应应给出资资料清单单，以便便用户查查阅。手册构成：如果本本系统的的用户手手册(包括管管理员手手册、参参考手册册)由几本本组成，首首先应该该分别简简要介绍绍这些手手册的情情况。最最根本的的是应该该介绍本本手册在在哪一章章或哪几几章讲解解了什么么内容，对对
28、于较大大系统，如如Uniiverrsall Offficce 33.5，分分别介绍绍每一章章内容比比较繁琐琐，则可可概括性性地介绍绍。手册约定：这一部部分应该该包括字字体的约约定、特特殊符号号的约定定以及【注注意】、【警警告】、【说说明】等等的含义义。必要要时，应应该给出出某些基基本术语语的定义义。也可可以把基基本术语语、概念念的定义义作为基基础知识识来介绍绍。具体请参考考本规范范的阅读读指南。2.2.6 目录目录的编写写要尽量量详尽。如如果用户户手册的的内容用用到小节节，则目目录就应应该编写写到小节节；如果果用户手手册的内内容用到到小小节节，则目目录就应应该编写写到小小小节。编编写用户户手册
29、目目录的目目的就是是为了让让用户能能够根据据它很快快地找到到想要的的内容。有关格式请请参考本本规范目目录的编编写。2.2.7 基基础知识识介绍条件这一部分内内容是在在一定条条件下必必需的，用用户手册册编写人人员应该该根据实实际情况况确定是是否需要要这一部部分。如如果包括括基础知知识介绍绍，应将将其放在在第1章章。在一般情况况下，使使用我们们的软件件系统需需要一定定的基础础知识。这这些知识识可以从从有关书书籍上得得到，但但是用户户从这些些资料得得到这些些知识需需要花费费相当的的时间。在在某些情情况下，我我们只需需要用户户掌握用用户手册册中使用用的那些些概念，那那么我们们就有必必要编写写一章“基础
30、知知识介绍绍”来进行行专门介介绍。比如说，在在工厂管管道设计计系统用用户手册册中，经经常用到到按下鼠鼠标“数据键键”、“捕捉键键”、“复位键键”的概念念，用户户虽然可可以从Microstation的用户手册中得到这些概念，但是比较不方便。由于我们编写用户手册的主要目标就是方便用户，所以有必要在用户手册的一开始就介绍这些概念。2.2.8 系系统安装装及启动动如果手册中中包括基基础知识识介绍，应应把系统统安装及及启动作作为第22章，否否则，将将其作为为第1章章首先向向读者予予以介绍绍。系统安装及及启动部部分应该该包括如如下内容容：系统的运行行环境硬件环境要要求说明明：系统统运行时时所需硬硬件环境境
31、描述。包包括机型型、内存存大小、硬硬盘空间间等。如如果必要要，还应应包括输输入/输出设设备、通通讯环境境等。软件环境要要求说明明：系统统运行时时所需软软件支持持环境的的描述。包包括所需需任何其其它软件件的名称称及版本本号等。其它环境要要求说明明条件件：应应该说明明要求的的任何其其它环境境。系统的安装装对于不同的的系统其其安装应应有所区区别，一一般来说说，应给给出最终终用户能能够据此此把软件件安装到到其操作作系统并并配置完完成，且且能成功功运行的的任何信信息和操操作。系系统的安安装包括括软件的的安装过过程及系系统环境境的配置置条件件，必必要时还还应给出出硬件的的安装条件。硬件安装条件：如果果必要
32、，应应该详细细说明系系统所需需硬件环环境的安安装过程程，其中中包括软软件加密密锁的安安装。软件安装：应该用图示示方法详详细介绍绍软件的的安装过过程。对对于来自自 .资料料搜索网网络版软软件，应应对服务务器端及及客户端端的安装装分别予予以介绍绍（可参参考文档档管理系系统SEEAS220000-AMMS 55.0）。如如果二者者安装过过程相似似，可以以详细介介绍一种种，另一一种参考考前一种种即可。如如果软件件由多个个模块构构成，且且其中部部分模块块需单独独安装，如如Uniiverrsall Offficce 33.5，则则应分别别给出安安装步骤骤。所有产品的的安装包包括以下下界面：安装快快闪界面面
33、条件件、安安装初始始窗口（欢欢迎）、版版权声明明界面、选选择安装装路径界界面、选选择程序序文件夹夹（程序序组）界界面条条件、安安装进程程界面条件及安装装完成界界面。系统配置条件：应给给出系统统配置的的详细过过程，以以便用户户能够顺顺利操作作系统。对对于网络络版软件件，应分分别讲述述服务器器和客户户端的配配置过程程。系统的启动动：应给给出系统统启动的的方法。如如果系统统由多个个模块组组成，则则不必单单列出一一节讲述述系统的的启动方方法，只只须在介介绍各个个模块的的操作时时给出模模块的启启动方法法即可。对于系统的的安装及及启动的的结构总总结如下下，供编编写用户户手册时时参考：|-系系统的运运行环境
34、境 |-硬硬件环境境| |-软件件环境|系统的安装装及启动动 | |-硬件安安装|-系系统的安安装 |-软件件安装| |-系统的的配置|-系系统的启启动2.2.9 系系统操作作说明系统操作说说明是所所有用户户手册的的主体，它它所包含含的内容容相当广广泛。主主要包括括：输入入的命令令和数据据、软件件的功能能、输出出结果、出出错信息息及其矫矫正和恢恢复方法法。对于不同的的软件，其其操作说说明也应应有所不不同，下下面就几几种情况况分别予予以介绍绍。2.2.9.11 CAAD软件件CAD软件件的操作作说明应应包括文文件管理理、图纸纸尺寸设设置、图图形绘制制、图形形编辑、尺尺寸标注注、图层层管理、图图库
35、调用用条件件、图图库维护护条件件及附附录条条件等等内容。在用户手册册中应按按操作顺顺序或界界面中菜菜单顺序序分别对对上述内内容中的的每一项项操作予予以介绍绍。要求求详细给给出操作作过程及及命令格格式与功功能，具具体规定定如下：各种操作、命命令和语语言：软软件系统统的使用用过程都都是使用用软件系系统提供供的各种种操作、命命令和语语言的过过程。所所以，我我们必须须做到：操作和命令令：在用用户手册册中详细细给出各各种操作作的过程程和功能能、命令令的格式式和功能能；应当当描述在在使用上上的各种种限制，如如，操作作状态、操操作条件件、操作作序列等等。另外外，必要要时可以以通过适适当地举举例讲述述各种操操
36、作和命命令的使使用方法法，以帮帮助用户户理解。输出信息：应该详详细列出出与操作作、命令令相关的的各种输输出信息息。如果果输出信信息的意意思本身身不是很很明显，应应当给予予解释。另另外还应应当说明明对于这这些信息息所采取取的操作作。程序设计语语言条条件：如果我我们的软软件系统统提供了了某种语语言，对对其语言言规则应应当给予予说明。各种数据：在软件件的使用用过程中中，用户户必须与与各种数数据和信信息打交交道。为为了让用用户能够操作作我们的的软件，我我们必须须为用户户提供各各种结构构以及每每个数据据元素的的含义有些数据适适合在系系统操作作说明中中给出，有有些适合合在后面面的附录录中给出出，甚至至有些
37、除除了在操操作说明明的同时时给出外外，还要要在附录录中给予予归纳，这这些都由由用户手手册编写写人员根根据实际际情况来来决定。这这些数据据包括：1) 输入入数据条件：应该该给出数数据的内内容、逻逻辑结构构、格式式以及每每一个数数据元素素的意思思。如果果输入数数据依赖赖于某特特定数据据介质，则则应当给给予说明明。2) 输出出数据：应当给给出软件件以何种种形式输输出的数数据的内内容和格格式，并并要求以以例样的的形式给给予说明明。3) 中间间数据条件：如果果我们告告诉用户户在软件件的运行行过程中中所产生生的中间间数据的的内容和和格式，有有助于用用户理解解软件的的使用，则则应当给给予说明明4) 数据据限
38、制条件：如果果对数据据有限制制，如数数据的大大小限制制，则应应当给予予说明。5) 数据据文件条件：如果果要告诉诉用户我我们的软软件所使使用的某某些数据据文件的的结构有有助于用用户理解解我们软软件的使使用，则则应给予予说明，但但应该注注意技术术保密。如如果对数数据文件件有所限限制，例例如每个个文件的的最大记记录数、每每个磁盘盘的最大大文件数数等，应应当给予予说明。处理过程条件：如果果我们简简要地给给用户描描述我们们软件对对用户的的操作、输输入的命命令和输输入数据据的处理理过程，有有助于用用户了解解我们软软件的使使用，则则应给予予说明。截图内容：目前，多多数软件件已不再再采用命命令行输输入方式式，
39、而是是采用对对话框输输入方式式。在此此情况下下，应该该以图示示方式对对软件的的操作过过程予以以介绍。采采用图示示方式讲讲述软件件操作过过程应注注意以下下几点：所截图形的的输入、输输出信息息中不应应包含本本公司人人员的真真实姓名名，且各各种输入入、输出出信息以以不泄漏漏公司机机密为原原则。截图是为使使叙述更更加明确确、简洁洁，所以以应尽量量避免不不必要的的截图。一一般来说说，在用用户手册册中应该该包括系系统的主主界面、各各种操作作的初始始界面（点点取命令令后弹出出的第一一个界面面，一般般需要输输入信息息）、操操作中间间过程界界面、操操作结果果界面以以及其它它一些必必要的界界面。没没有必要要为下拉
40、拉菜单、快快捷菜单单等内容容截图，因因为这些些操作都都比较简简单，只只要用语语言叙述述用户即即可明确确其操作作方法。另另外，在在同一本本手册中中，应避避免重复复截图，对对于不同同输入或或输出信信息的同同一界面面在手册册中不应应重复（例例题除外外）。出错处理：应当给给出各种种出错情情况以及及相应的的处理措措施。现对系统操操作说明明的步骤骤总结如如下，供供编写用用户手册册时参考考：进入相关界界面。调用命令（选选择菜单单、键入入命令或或点击工工具按钮钮）。弹出相应的的操作初初始界面面（或提提示行）。对输入信息息给予说说明。继续操作（点点击按钮钮或选择择参数及及键入按按键等）。结果界面（或或结果提提示
41、行）。对输出信息息给予说说明。【警告】在在编写软软件用户户手册的的系统操操作说明明时，我我们在决决定是否否提供某某种数据据的格式式时，应应以不泄泄漏公司司的技术术而且有有利于用用户使用用为准则则。2.2.9.22 其它软软件对于一些比比较复杂杂的软件件，一般般包括多多个模块块。对于于此类系系统，要要求按照照操作顺顺序对各各个模块块分别介介绍。一一般按模模块分成成若干章章，在各各章中对对相关模模块的操操作予以以介绍。对对于此类类软件的的操作步步骤总结结如下：启动某一模模块，进进入该模模块的主主界面。执行某一功功能（选选择菜单单或工具具按钮）。弹出相关界界面。对输入信息息予以说说明。继续操作（点点
42、击按钮钮）。结果界面。对输出信息息予以说说明。有些软件的的操作可可能需要要一定的的技术和和经验才才能获得得满意的的结果，那那么应该该在用户户手册上上尽量给给出这些些技术和和经验的的描述，或或告诉用用户如何何才能获获得这些些技术和和经验。例例如，在在操作SSEASS系统作作图纸净净化处理理时，如如何选择择适当的的阀值就就需要一一定的技技术和经经验。一些比较简简单的系系统，如如NettEyee、OppenVVideeo等其其系统操操作比较较简单，操操作说明明内容比比较少。对对于此类类软件，手手册中可可以将操操作说明明归纳为为一章，再再按操作作顺序予予以介绍绍。另外，对于于各种操操作、命命令、语语言
43、、数数据及截截图内容容的规定定同CAAD软件件。2.2.10 系统及及数据维维护应该给出用用户数据据的备份份、恢复复、删除除、整理理的详细细过程。如如果必要要，应该该给出系系统数据据、系统统磁盘空空间维护护的详细细过程。2.2.11 例题条条件有些软件系系统可以以通过一一个较为为完整的的例题演演示系统统部分功功能的使使用方法法，在这这个例题题中，用用户应该该详细地地描述每每一步的的操作过过程，用用户可以以通过这这个例题题对系统统的操作作有一个个初步的的了解。2.2.12 各种附附录在用户手册册中，有有些知识识和信息息可以通通过附录录的形式式提供给给用户，以以便于用用户查阅阅，这些些内容是是：1
44、. 错误误提示信信息：通通常可以以以表的的形式按按照一定定的顺序序，例如如按出错错提示信信息编号号顺序、或或按出错错提示信信息的字字母顺序序，给出出出错提提示信息息的编号号、提示示信息、相相应的解解释、出出错原因因和解决决办法2. 命令令速查表表条件件：通通常可以以以表的的形式按按照一定定的顺序序给出各各种命令令的概要要(包括命命令名称称、各种种参数、及及相应的的功能介介绍)，以帮帮助有一一定经验验的用户户进行快快速查找找所需信信息3. 数据据文件格格式条条件：可以通通过附录录介绍用用户必须须了解或或可以了了解的各各种输入入数据文文件、输输出结果果文件、中中间数据据文件的的格式、限限制范围围、
45、适当当的解释释等4. 其它它信息 条件件：任任何其它它有利于于用户使使用我们们的软件件、方便便用户的的信息都都可以以以附录的的形式提提供给用用户【注意】虽虽然附录录所提供供的信息息可能均均可以在在系统操操作说明明中查到到，但提提供附录录的目的的就是为为了方便便用户使使用，这这种重复复还是必必要的。2.3 用户手手册的风风格用户手册应应具有自自己的风风格。有有的人喜喜欢用比比较深奥奥的概念念和语言言来说明明问题，有有的人喜喜欢用比比较长的的句子来来表达思思想，在在编制用用户手册册的过程程中这些些都是不不可取的的。用户户手册应应该具备备如下特特点：用户手册的的句子尽尽量简洁洁：如果用用一个句句子表达达起来比比较复杂杂，定语语多，则则可以分分成两个个甚至几几个句子子来说明明，这样样用户在在阅读用用户手册册时会轻轻松些。每节、段的的内容明明确：每每节的内内容必须须明确，这这样用户户可以通通过目录录很方便便地查到到自己所所需要的的内容；注意段段的划分分，每段段不要太太长，突突出重点点，否则则用户不不容易获获得其中中的精华华。用户手册的的用词要要前后一一致：在在用户手手册中使使用的概概念、术术语的用用词要前前后一致致，否则则用户将将不容易易读懂此此手册。用户不一定定是计算算机专家家：用户户手册编编写人员员应该牢牢牢记住住这一点点，我们们的大多多数用户户都不是是学计算算机的，手