软件股份公司用户手册编制规范模板.doc
《软件股份公司用户手册编制规范模板.doc》由会员分享,可在线阅读,更多相关《软件股份公司用户手册编制规范模板.doc(32页珍藏版)》请在咨信网上搜索。
1、用户手册编制规范沈阳东大阿尔派软件股份.2版权申明用户手册编制规范版权归沈阳东大阿尔派软件股份全部。未经沈阳东大阿尔派软件股份书面准许,不得将本规范任何部分以任何形式、采取任何手段(电子或机械,包含摄影复制或录制)、或为任何目标,进行复制或扩散。(c)Copyright 沈阳东大阿尔派软件股份。版权全部,翻制必究。 是沈阳东大阿尔派软件股份注册商标。Microsoft、word是Microsoft Corporation注册商标。Windows是Microsoft Corporation商标。前 言用户手册对于任何产品全部是不可缺乏组成部分。一个好产品没有一份完备用户手册,也不能算作一个完备产
2、品。对于软件产品来说更是如此,没有用户手册软件不能算产品,没有好用户手册,就不可能算好产品。也就是说,一个好软件产品除了含有和市场对路思想、良好用户界面、完备测试之外,还必需有一本适适用户使用用户手册。本规范手册不仅指明了软件用户手册内容,而且要求了沈阳东大阿尔派软件股份软件用户手册统一版面、格式。本规范手册就是按本要求编写,但因为本规范手册内容不足,极难以样本形式表现软件用户手册中可能出现多种情况,所以请大家认真阅读本规范手册内容。我们期望沈阳东大阿尔派软件股份相关人员,能够根据本规范手册编写自己软件用户手册,做好我们软件产品化工作。因为时间仓促,编者水平有限,期望大家能够提出宝贵意见,以逐
3、步完善本规范手册内容。阅读指南手册目标本手册关键对沈阳东大阿尔派软件股份软件产品用户手册所应包含内容及版面格式作一个初步统一要求。因为实际情况千变万化,本要求极难一次做到面面俱到,需要逐步完善。阅读对象本手册是为沈阳东大阿尔派软件股份全部软件开发人员和软件用户手册编写人员所编写。因为本手册中格式要求部分是依据 Microsoft Windows 下 Word 功效而编写,所以沈阳东大阿尔派软件股份软件用户手册应该使用 MicroSoft Word排版。手册组成本手册基础上由两部分组成:1. 第1章,“相关用户手册排版格式要求”,要求了用户手册标题及编号格式。2. 第2章,“用户手册内容”,要求
4、了用户手册所应包含内容较为具体清单。另外,本手册基础上是按“用户手册格式统一要求”编写一个样本。手册约定本手册遵照以下约定:1. 全部标题均使用黑体字。2. 假如标题后跟有“条件”字样,说明该标题下正文所要求内容是在一定条件下必需。【注意】意思是请读者注意那些需要注意事项。【警告】意思是请读者千万注意一些事项,不然将造成严重错误。目 录第1章 用户手册格式要求1-11.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-41.2.1 正文排版1-5
5、1.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基础知识介绍条件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-102.2.12 多种附录2-102.3
6、 用户手册风格2-11第1章 用户手册格式要求1.1 标题及编号通常情况下,用户手册用章、节来划分其内容,必需时还可引入小节、小小节概念。1.1.1 章标题设置每章编号用阿拉伯数字表示,采取“第1章”、“第2章”、形式表示章编号,章编号后面空一个半角格,然后是这一章标题。1. 章必需另起一页开始打印。2. 章编号和标题采取左对齐格式放在行左边,左缩进为0。3. 章编号和标题中汉字采取黑体小三号字,章编号和标题总长度不能超出一行。4. 章编号和标题行距取最小值、12磅,段前、段后分别取24磅。1.1.2 节标题设置节编号格式为“x.y”。其中,x为章号码,y为节号码,用阿拉伯数字表示。节编号后面
7、空一个半角格,然后是这一节标题。1. 标准上每一节另起一页开始打印,但对于每章第一节,假如章标题下无说明文字,能够将其和章标题放于一页之中。2. 节编号和标题采取左对齐格式放在行左边,左缩进为0。3. 节编号和标题中汉字采取黑体四号字,节编号和标题总长度不能超出一行。4. 节编号和标题行距取最小值、12磅,对于和章标题处于同页要将其段前、段后均取12磅,不然段前取24磅、段后取12磅。1.1.3 小节标题设置小节编号格式为“x.y.z”。其中x为章号码,y为节号码,z为小节号码,用阿拉伯数字表示。小节编号后面空一个半角格,然后是这一小节标题。1. 小节无须另起一页开始打印。2. 小节编号和标题
8、采取左对齐格式放在行左边,左缩进0.74CM。3. 小节编号和标题中汉字采取黑体小四号字,小节编号和标题总长度不能超出一行。4. 小节编号和标题行距取最小值、12磅,段前取12磅。【注意】1. 假如有必需,还能够在小节下面划分更小节,我们暂且称之为小小节。2. 对于小小节多种要求和小节一致,为保持版面清楚,小小节不再相对于小节向右缩进。3. 在用户手册中,系统提醒信息采取幼圆五号字,其它全部数字及字母采取Arial字体,字号和对应汉字相同。在本规范中提到字体如无特殊注明,均指汉字字体。4. 用户手册中,行距均取最小值、12磅。1.1.4 项目符号和编号设置在章、节、小节、小小节里面均能够含有项
9、目符号和编号。1. 编号1) 编号序列相对于和之对应标题向右缩进0.74CM。2) 编号格式是“n.”,其中n为阿拉伯数字。3) 对于有名编号序列名称采取五号黑体汉字,其后面内容采取五号宋体汉字;对于无名编号序列中内容字体同有名编号序列。4) 编号序列里还许可采取二级编号序列,其格式要求以下:“n)”,其中n为阿拉伯数字。5) 二级编号相对于和之对应一级编号向右缩进0.74CM。6) 其它要求和一级编号序列一致。7) 编号及二级编号行间距取最小值,12磅。一级编号第一项段前取12磅,其它各项及二级编号段前均取6磅。2. 项目符号1) 项目符号相对于和之对应标题或编号序列向右缩进0.74CM。2
10、) 项目符号格式是“”,其中“”字体为Wingdings,五号字。3) 对于有名项目符号序列,名称采取五号黑体汉字,其后面正文采取宋体五号字,对于无名项目符号序列中内容字体同有名编号序列。4) 假如项目符号序列处于编号序列下级,则各项各项段前均取6磅;不然首项段前取12磅,其它各项段前取6磅。【注意】项目符号和编号下叙述文字相对于和之对应项目符号或编号向右缩进0.74CM,首行缩进0.74CM,段前取6磅。汉字字体取宋体五号。1.1.5 其它编号设置1. 页编号:用户手册中正文按章进行编号,其格式为“章-页”。如,第2章第3页,编号为“2-3”。页编号放在页脚中,具体设置方法详见“页眉、页脚设
11、置”。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 正文排版正文排版包含字符排版、段落排版、图形排
12、版和版权申明、目录等排版,本节就这几方面格式要求加以具体叙述。1. 字符排版:1) 用户手册正文,系统提醒采取幼圆五号字体,其它采取宋体五号字。2) 对于界面中按钮名称,应把按钮名称用“”括起来,按钮名称用黑体五号字书写。对于下拉菜单选项名称,应用“”引发来,选项名称用宋体五号字书写。对于热点,应用“”引发来,热点名称用黑体五号字书写。3) 正文均采取常规字体、标准位置、标准间距。2. 段落排版:1) 正文段落首行相对于和之对应标题或编号序列向右缩进0.74CM。2) 行距采取最小值,12磅,除项目符号及编号和图形前面正文按前面所述特殊要求进行排版外,其它段前均取12磅。3) 采取两端对齐方法
13、。3. 图形排版:1) 屏幕截图时,应使所截图片尺寸为最大。2) 对于尺寸较大图片,可使图片高度和宽度按同百分比合适缩小。3) 必需时可合适缩小或将图片移到下一页,以确保图片和图号及图名在同页。4) 当正文中对图标进行说明时,应使图标同和之对应标题对齐。5) 为确保页面清楚,可合适调整图标右侧说明文字行间距和段前、段后。6) 在屏幕截图时,图片中输入数据不能包含本企业职员真实姓名。4. 版权申明、目录等排版:版权申明、序言、阅读指南、目录标题为段前取36磅,段后取24磅,采取黑体小三号字;内容排版和手册正文排版相同。1.2.2 版面设置1.2.2.1 版面设置对于版面设置作以下要求:1. 纸张
14、大小:用户手册用纸统一要求为16开。2. 页边距:上:30mm;下:20mm;内侧:21mm;外侧:16mm。另外采取“对称页边距”;对于版面设置页眉、页脚应选择“首页不一样”和“奇偶页不一样”。3. 对于新项目或新产品可依据具体情况对版面设置合适做部分修改。1.2.2.2 相关页眉、页脚设置1. 页眉设置:1) 版权申明、序言、阅读指南、目录均无篇眉。2) 章编号和名称所在页篇眉为一行有50%填充边框。3) 对于单号页,页眉内容是目前章标题名,要求打印在纸右上角。4) 对于双号页,页眉内容是用户手册名称,要求打印在纸左上角。5) 纸顶边和页眉距离是23mm。6) 页眉中汉字采取幼圆小五号字。
15、2. 页脚设置:1) 页脚内容是目前页页编号,如第2章第2页为2-2。2) 页编号字体采取Arial五号字。3) 纸底边和页脚距离是13mm。4) 版权申明、序言、阅读指南、目录页脚为,等,居中放置,不带边框。1.2.2.3 注意和警告在用户手册中,对于那些需要用户尤其注意事项,应该用“【注意】”作为标志给用户以尤其提醒。相关注意标志和注意事项格式有以下要求:1. 注意标志同和之对应标题对齐。2. 注意标志采取黑体小四号汉字。3. 注意标志段前取12磅。4. 假如注意事项只有一条,其内容应该紧跟在注意标志后面书写;不然,应该在注意标志下一行开始,采取编号序列形式分别给出。在用户手册中,对于那些
16、会给用户造成重大损失行为,应该用“【警告】”作为标志给用户以警告性提醒。【注意】相关警告标志和警告事项格式要求和相关注意标志和注意事项格式要求一致。第2章 用户手册内容本章关键讨论编写用户手册所要达成目标、软件用户手册所应包含内容、和在用户手册编写过程中所应保持风格。假如标有“条件”字样,说明该部分内容是在一定条件下所必需。2.1 用户手册目标某软件评测中心把软件产品评测测试分为两个阶段初评安装测试和复评测试。只有经过初评安装测试软件才能进入复评测试,初评安装测试内容包含:1. 根据软件用户手册中安装说明测试软件能否顺利安装成功。2. 对照软件用户手册测试软件功效是否和手册描述一致。3. 评价
17、产品包装及用户手册是否符合商品化要求。4. 经过以上三方面测试且无严重死机情况软件可进入复评测试。由此,我们能够看到软件用户手册是一个软件产品基础,没有合格软件用户手册就根本谈不上合格软件产品。其次,良好安装说明及软件功效和手册描述一致性是对软件用户手册两个基础要求。我们编写用户手册要达成两个目标:1. 让用户手册成为用户学习使用我们产品最好教材。用户经过阅读用户手册,应该对我们产品功效、操作有一定认识;根据用户手册上说明,经过实际操作,用户应该能够掌握我们产品操作过程。2. 让用户手册能够起到降低销售费用作用。用户手册不仅应该包含我们产品操作说明,而且还应该包含系统(软件和必需硬件)安装、数
18、据维护、犯错处理等。经过用户手册,就能够让用户掌握在使用我们软件过程中出现多种情况处理方法。为达成这两个目标,在通常情况下,用户手册应该包含以下多个方面内容:1. 封面2. 二封3. 版权4. 申明5. 序言6. 阅读指南7. 目录8. 基础知识介绍条件9. 系统安装(包含必需硬件安装)及开启10. 系统操作说明11. 系统及数据维护12. 例题条件13. 多种附录【注意】假如本系统软件是一个大系统,其系统安装、操作说明、系统及数据维护全部相当复杂,则能够把这三个部分分别编写为一本甚至几本用户手册,每本手册全部有自己封面、版权申明、序言、阅读指南、目录和对应基础知识介绍和附录。2.2 用户手册
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 股份公司 用户手册 编制 规范 模板
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,个别因单元格分列造成显示页码不一将协商解决,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【快乐****生活】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【快乐****生活】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。