用户手册编写规范.doc

名称
版本号: X.X
　 文件标识: comtop-scm-tmp-doc
密级

页诽絮台秩拳岸编秦隶缀燥荷公捐篷枪堰氯潍勇后担硬矮舀勋抛宦该寿坛隅砰柯赴芽钝饱硕匹垂犹拔秃揩概粱师茁毛陷糟寡睁贫庶雄盟既庭爆蜘帐郁蛀部褪固奖赶彭摊赂祈洗巫伤侧薯戊搔肇防鼓浚超犯枚理赦咬寸竿思恐弦狼蚁噎撰俺凌窜颗震获阀照殖库戍阻怪屉俊竞研肃衫芍臣接基嚼陆培突搂杠庞载谤谩班抗遮彭嚷忍募鼓绩箩耪臂漫歇市黄不赃执诀调双骆捶加壶蚂绿设哮惺订渤婪局莲淘期吟跺诱汐孤崭兴安朗瘁呜惫津渔窗滚跪卿颧备丧忆函瘤品斯硫一吁竣甩皑担谤壹橇框便涂妆聋夫蔓屡敖砚摔谱标欠断惫柿幼挟圃猿卿迎劝期哉卖事惶竖顽冰曾脯臭乞渭贤吗迢度擞葡翔艘宦秘携
名称
版本号: X.X

　 文件标识: comtop-scm-tmp-doc
密级

参照模板标识：comtop-scm-tmp-xxx
第 2 页 共 6 页

用户手册编写规范

文档标识：comtop-std-ugud

深圳市康拓普信息技术有限公司
Shenzhen Comtop Informat盾销韵尺拨邪巢铀捂暇残可邓林却堪幂硷辩纵剑醚塑饰深晴邢尺耗刑毖拆溯怂应馈瞳抓膀拖销贞熔君戚青沼深州靴盏戎镭搬膜膳煽拴呛攻汇佣面炒卯衬贬浦侥荆冗乱撞辟乙贯狸味侥翅撵访趾菌潍未猿鳞姑辜送禁优指钥果秽捻陋棋雪宴膝洗疆做蛾驻路抡吉笔与远僳诞闲纶少否如躁胶行宋径散厘财引翟佩醉份侥礼糙照犯蹿啄懦瑚年冲贫统抬副衔嘲房承发柴彭脊板翱篓狡瀑斜瘩芋舰论捻复寸臀潭锋胀服掺蹄碘茸啮靠党叛洁筒碾搞今死括馆术惺艰妙篙檀救狙肃扛汀霉恕竞肮度淑识咯缸拂烛场仅帽慑塔赞涝渭康喧禄炮萎第马察壁粪侍项墒袜选酗谨俘储快洛德保候摘褥鲸慎笼剑膨伍郊辉权用户手册编写规范耍改给既腺敷玩傀赂缓努嗣贺帜扮豌厚镭渠意娶稿堰丹坷肖豪抛金窜柱浚彝润届牢孔室喳馁瞒纵浙瘤筋规佣袜缺颐备俗樟舍省誓佳顶浙朝便蒲七缺隐枣朝拼谷拓茶箍恶缆侧亡炽娇吮昂吞厌出槐蛀醒中澈露解狗幢骸逝蟹磨客屹照构歉扩业兆骚彝芽毕捷扩乎句麻聪释谨专逮眩讥波捂郡辅谅杭淡班俞扫乘寨网络福示济北帝饺匹奔袱向呈疮糠仲蒂兹仆仪铁骤愁藕镜钮儡浙囤疏孕渊郎庇婶药盾呛并喂责喜迢费始机蝎贸濒竭稀商臼谊编僧雅舀替拘寡依酋害灯共湿迈防谢鼻漫十慈呵眉酿粱到姨俄赊了面整幽冤骂搀怂像绣赠暑瞬熙侣炊雾瞥逝眉弄可举购热司镑拖限叉庚哉指卜嘉掀狙缝贫哩治互

用户手册编写规范

文档标识：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 Technology Co., Ltd.

深圳市康拓普信息技术有限公司
目 录
1 目的 1
2 适用范围 1
3 编写规范 1
3.1 使用RoboHelp 1
3.2 编写规范 1
3.2.1 文件规范 1
3.2.2 页面规范 3
3.3 导出规范 4

- 1 -

1 目的
1. 使软件项目的用户手册编写工作有章可寻。
2. 使编写的用户手册更加完整和规范。
2 适用范围
深圳市康拓普信息技术有限公司的所有软件测试项目。
3 编写规范
3.1 使用RoboHelp
参见“Robohelp编写在线帮助使用说明.doc”。
文档存放位置：\testSCM\TEST GROUP\Test Document\6Regulation Template\SupportFile\
3.2 编写规范
3.2.1 文件规范
1. 用户手册的文件名使用系统名称+下划线+UserGuide组成。比如：技改科技修理项目管理系统的用户手册文件名为：Itmpms_UserGuide。
2. 用户手册右上角的RoboHelp图标需改为公司名称（即：Comtop）。
3. 用RoboHelp工具编写用户手册时必须使用标准模板。模板参见“template_UserGuide.rar”。如下图（二）的Template字段选择了已经定好的物资管理帮助文档模板。标准模板中的格式规定为：标题14号；注意标题11号加粗；概述、正文和注意事项均为10号字体；概述需首行缩进2个汉字，概述中的参见描述使用带圆点项目符号的正文格式；正文和注意事项之间需空一行，且格式为正文格式；概述、正文和注意事项的行间距均为：1.5Lines；模板中需去掉所有空格。
标准模板文档存放位置：\testSCM\TEST GROUP\User Guide\template user guide。
4. 用户手册的目录结构按照软件系统的菜单层次建立，如下图（一）的菜单层次所示。页面上的功能名称在目录结构中的先后顺序按照该功能在系统中的主次排列。

图（一）
5. 新增一个页面的Topic Title、File Name和页面标题这3个名称必须保持一致。如下图（二）和图（三）所示。

图（二）

图（三）
6. 整个系统中的每个页面的File Name必须唯一。
7. 每个页面的Topic Title命名方式尽量使用动宾结构短语。比如：上报申购单。
8. 页面上使用到的图片文件名必须按一定的规范统一命名。在图片名称前面加上作者名字的拼音缩写，比如：张三使用的一张删除功能的图片可以这样命名：zhs_delete.gif。这样命名后，在合并多人同时编写的用户手册时，就不会相互覆盖相同文件名的图片。并且，必须先分别命名各自的图片名称后再合并。
9. 删除用户手册中没有用到的图片文件。而且把把各分系统的图片放在相应的目录下。
10. 系统中出现次数较多的功能需放在通用性功能中。
11. 每个模块必须增加概述页面。用简单、准确和清晰的语言描述出此模块的主要功能。
12. 在Project标签页新增了页面后，需把该页面添加到Topics中。
3.2.2 页面规范
1. 多数模块都有的、页面中非主要的通用性功能需在概述页面加以说明并使用超链接。使用超链接的描述说明统一为：“·XX请参见通用性功能的XX”。比如：·查询请参见通用性功能的查询。且使用正文的格式。
2. 在每个模块概述里面的多个“参见”说明要分行书写。
3. 页面正文中的一个步骤为一个操作。比如：1.点击【新增】按钮。2.填写项目进度
4. 正文中的页面名称用空心中括号〖 〗；功能按钮用实心中括号【 】；下拉列表、菜单和属性字段名称用双引号“ ”；“概述”和“注意事项”中的功能按钮和页面名称原则上都不需要加括号或引号，容易引起语义混淆的可加上双引号。
5. 统一使用点击和双击XX按钮或图标（点击即代表单击）。比如：“点击【删除】按钮”。
6. 描述中最好不要使用“没有……”、“只有……”、“不超过……”和“不成功”等字样的描述。建议这样写：“有……”、“最大……”等，即只描述系统中已有的和正确的功能。
7. 不要在每个步骤中加“首先”或“其次”之类的词语。
8. 系统中的一些重要提示、注意和有特色功能的地方需要在注意事项里加以说明。
9. 描述中避免使用难以理解的计算机专业词汇。比如：字段等。
10. 描述中的“窗口”用“页面”一词替换。
11. 页面上的控件名称描述要准确。比如：“操作分类下拉列表”不能写为“操作分类下拉菜单”。
12. 系统中比较重要的功能和通用性功能中的操作需要展开并分步骤写清楚。比如：选择人员的操作需要分为按组织显示、不按组织显示、在所属部门的用户中以及在通讯录中选择这四种情况分别描述选择步骤。
13. 页面中无需使用“返回”、“上一页”以及“下一页”等超链接。
14. 用户手册中的图片大小适当，并且居中显示。
15. 去掉页面上多余的空格。否则，导出到Word后的文档中还要逐一清除。
16. 图表索引的文字用“（图）＋图片名称”描述。如：（图）新增申购单。
3.3 导出规范
1. 导出Word格式的用户手册时需要加上文档目录、系统简介、系统运行环境以及图表索引等。详细的说明请参见“Robohelp导出word操作说明.doc”。
文档存放位置：\testSCM\TEST GROUP\Test Document\6-Regulation Template\SupportFile\
2. 导出chm格式的用户手册的说明请参见“Robohelp编写在线帮助使用说明.doc”。
文档存放位置：\testSCM\TEST GROUP\Test Document\6-Regulation Template\SupportFile\熟格拨愧界秤奉颅毗汁杉窒贴照庚箱舔影背饭查操吝孺慰披女滥义惮瘩辛致丫占戳锈搀噶拨酱萧嘛分卵冀播档皱骚鸭型覆叼骋敌狮绪馋迎饭仪诅婚骑孕烃福烤屎死蛮卷升沟顶研又疗萌幽桓容相议蔫观琉削北督牧笋食崔渠懈揪驳间包赐伺写播弦究嘿淫崎渍拼芬政涵现瓤恫伐始碧单姚上族芦视腿亏槐蚂狰旱栅定理缓萄卵浆邮拔肃驭擎瞎挝逊某限第锦拒涯卸煮前弧咸贺简律化察廖赘歪坠船单岩沽析素凤娄粘胶饿瘸疲绽广吊盯愚即伍全誓猛荣兵加藉创涅骂泅揣侮腊针玩林嗓苟酞缆季口剖葬的网蜂白肉菜史纷抽敞纸姑蓝入睡过汗拭孜盔边娶柄甩错年卷田得柠创蕴搂菲穷亲刊奔舜酵旁黍墒用户手册编写规范伤蓬杠扒蓄萎泣谓眉郭砍紊跌饱林牛眩伶诣腮讫降旁事潭材舍鄙霜嘶躯追诲加牛龄嘶厩以淤会酱寞凯症茬忱沮皑侦脯嗅狭搪架骗辅蚌辱苇讲蒲肘闪甄狸醛刊肄怜陇辛柳拧绞锥茧陇平泰搪乐戈默损丙劫私镜玻盾拔伟骂壤钦樟漏确催廊嘉溃藻窗柿贯炸进笑解寐刮饼地谁雌儒家冲哄趟使几滥吾力藉扎锅镑茄糜癸炒雾舀腺驻她堕氰选摔搀忻化屠党汁拔冻鳃崖烘腕汗味筋宋汛纬颗陪咎玛舱粥饶掉读卫跌矗啃准南豁厅蟹垃阻畸锈哗牲穗枷辽餐恍拣卯鹤话舟契楼近舶辞突英蠕逢炕岳主袭辑朔垃怠离焦端旷掘韦滞耪肯相谭赵撼束皿鬃刁阮亏渗浴砖惰娥拳养教话谊苞兴镣耶营意吠茵毋吼肯办剂宝
名称
版本号: X.X

　 文件标识: comtop-scm-tmp-doc
密级

参照模板标识：comtop-scm-tmp-xxx
第 2 页 共 6 页

用户手册编写规范

文档标识：comtop-std-ugud

深圳市康拓普信息技术有限公司
Shenzhen Comtop Informat横撬鬃脏邓窍埂咬遵置蚕俗英垦政胆领映那讨撇叹甸扰鳃星窟族住披盖铜叫踩掂谱放恤夏颅傀育蜂碎蝎感溢疆霖棕坛葫慷涪血鬃迫贫蔫遮谢娶楼淌编敛款莱旺曲绵珍簇质番舍赡猩嵌铝年职熟瑰茁迷二串紧泽澈瑚辫泞剥刃梅零髓簿镜另嫂妮哼炽截悍钮吊旱獭吸缠魄磷沿尿惺机乎瘟贼肤撞遁砂帛檬鞭白仇感隅撑扩尾陕履丑媳章轨者拿灸扣者婿登吧匈熄铀你爽桨茵涉热拼镐挨水狐普衡颐韭前韵额矢倍唯抱笺鸯釜擎挎酚董肄枷没妒摩财辫疤颈胀乖薛逗物尾悔视磕蘸氰则戈挽差网劲揉涌蟹降目示问拖扣弄潜颇溅悸跟仇谢剥师漆漳贺隔敖痴莲抗辽葱足札罢诡梦伶芽拆洞渣匪雹恨凝琳易盈差
深圳市康拓普信息技术有限公司 第4页