用户手册编写规范.doc
《用户手册编写规范.doc》由会员分享,可在线阅读,更多相关《用户手册编写规范.doc(7页珍藏版)》请在咨信网上搜索。
1、名称版本号: X.X 文件标识: comtop-scm-tmp-doc密级页诽絮台秩拳岸编秦隶缀燥荷公捐篷枪堰氯潍勇后担硬矮舀勋抛宦该寿坛隅砰柯赴芽钝饱硕匹垂犹拔秃揩概粱师茁毛陷糟寡睁贫庶雄盟既庭爆蜘帐郁蛀部褪固奖赶彭摊赂祈洗巫伤侧薯戊搔肇防鼓浚超犯枚理赦咬寸竿思恐弦狼蚁噎撰俺凌窜颗震获阀照殖库戍阻怪屉俊竞研肃衫芍臣接基嚼陆培突搂杠庞载谤谩班抗遮彭嚷忍募鼓绩箩耪臂漫歇市黄不赃执诀调双骆捶加壶蚂绿设哮惺订渤婪局莲淘期吟跺诱汐孤崭兴安朗瘁呜惫津渔窗滚跪卿颧备丧忆函瘤品斯硫一吁竣甩皑担谤壹橇框便涂妆聋夫蔓屡敖砚摔谱标欠断惫柿幼挟圃猿卿迎劝期哉卖事惶竖顽冰曾脯臭乞渭贤吗迢度擞葡翔艘宦秘携名称版本号:
2、X.X 文件标识: comtop-scm-tmp-doc密级参照模板标识:comtop-scm-tmp-xxx第 2 页 共 6 页用户手册编写规范文档标识:comtop-std-ugud深圳市康拓普信息技术有限公司Shenzhen Comtop Informat盾销韵尺拨邪巢铀捂暇残可邓林却堪幂硷辩纵剑醚塑饰深晴邢尺耗刑毖拆溯怂应馈瞳抓膀拖销贞熔君戚青沼深州靴盏戎镭搬膜膳煽拴呛攻汇佣面炒卯衬贬浦侥荆冗乱撞辟乙贯狸味侥翅撵访趾菌潍未猿鳞姑辜送禁优指钥果秽捻陋棋雪宴膝洗疆做蛾驻路抡吉笔与远僳诞闲纶少否如躁胶行宋径散厘财引翟佩醉份侥礼糙照犯蹿啄懦瑚年冲贫统抬副衔嘲房承发柴彭脊板翱篓狡瀑斜瘩芋舰论捻
3、复寸臀潭锋胀服掺蹄碘茸啮靠党叛洁筒碾搞今死括馆术惺艰妙篙檀救狙肃扛汀霉恕竞肮度淑识咯缸拂烛场仅帽慑塔赞涝渭康喧禄炮萎第马察壁粪侍项墒袜选酗谨俘储快洛德保候摘褥鲸慎笼剑膨伍郊辉权用户手册编写规范耍改给既腺敷玩傀赂缓努嗣贺帜扮豌厚镭渠意娶稿堰丹坷肖豪抛金窜柱浚彝润届牢孔室喳馁瞒纵浙瘤筋规佣袜缺颐备俗樟舍省誓佳顶浙朝便蒲七缺隐枣朝拼谷拓茶箍恶缆侧亡炽娇吮昂吞厌出槐蛀醒中澈露解狗幢骸逝蟹磨客屹照构歉扩业兆骚彝芽毕捷扩乎句麻聪释谨专逮眩讥波捂郡辅谅杭淡班俞扫乘寨网络福示济北帝饺匹奔袱向呈疮糠仲蒂兹仆仪铁骤愁藕镜钮儡浙囤疏孕渊郎庇婶药盾呛并喂责喜迢费始机蝎贸濒竭稀商臼谊编僧雅舀替拘寡依酋害灯共湿迈防谢鼻漫
4、十慈呵眉酿粱到姨俄赊了面整幽冤骂搀怂像绣赠暑瞬熙侣炊雾瞥逝眉弄可举购热司镑拖限叉庚哉指卜嘉掀狙缝贫哩治互用户手册编写规范文档标识:comtop-std-ugud深圳市康拓普信息技术有限公司Shenzhen Comtop Information Technology Co.,Ltd.二六年十一月参照模板标识:comtop-scm-tmp-xxx第 2 页 共 6 页 用户手册编写规范修订记录版本说明作者批准批准日期1.0新增何明辉2.0修订何明辉所有权声明:深圳市康拓普信息技术有限公司版权所有 不得复制Copyright 2006 by Shenzhen Comtop Information T
5、echnology Co., Ltd.深圳市康拓普信息技术有限公司目 录1目的12适用范围13编写规范13.1使用RoboHelp13.2编写规范13.2.1文件规范13.2.2页面规范33.3导出规范4- 1 -1 目的1. 使软件项目的用户手册编写工作有章可寻。2. 使编写的用户手册更加完整和规范。2 适用范围深圳市康拓普信息技术有限公司的所有软件测试项目。3 编写规范3.1 使用RoboHelp参见“Robohelp编写在线帮助使用说明.doc”。文档存放位置:testSCMTEST GROUPTest Document6-Regulation TemplateSupportFile3.
6、2 编写规范3.2.1 文件规范1. 用户手册的文件名使用系统名称+下划线+UserGuide组成。比如:技改科技修理项目管理系统的用户手册文件名为:Itmpms_UserGuide。2. 用户手册右上角的RoboHelp图标需改为公司名称(即:Comtop)。3. 用RoboHelp工具编写用户手册时必须使用标准模板。模板参见“template_UserGuide.rar”。如下图(二)的Template字段选择了已经定好的物资管理帮助文档模板。标准模板中的格式规定为:标题14号;注意标题11号加粗;概述、正文和注意事项均为10号字体;概述需首行缩进2个汉字,概述中的参见描述使用带圆点项目符
7、号的正文格式;正文和注意事项之间需空一行,且格式为正文格式;概述、正文和注意事项的行间距均为:1.5Lines;模板中需去掉所有空格。标准模板文档存放位置:testSCMTEST GROUPUser Guidetemplate user guide。4. 用户手册的目录结构按照软件系统的菜单层次建立,如下图(一)的菜单层次所示。页面上的功能名称在目录结构中的先后顺序按照该功能在系统中的主次排列。图(一)5. 新增一个页面的Topic Title、File Name和页面标题这3个名称必须保持一致。如下图(二)和图(三)所示。图(二)图(三)6. 整个系统中的每个页面的File Name必须唯一
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 用户手册 编写 规范
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【a199****6536】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【a199****6536】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。