350华为公司的产品手册中文写作规范.doc
《350华为公司的产品手册中文写作规范.doc》由会员分享,可在线阅读,更多相关《350华为公司的产品手册中文写作规范.doc(59页珍藏版)》请在三一文库上搜索。
1、文档密级:内部公开DKBA13132003.12DKBA华为技术有限公司内部技术规范DKBA13132003.12产品手册中文写作规范 2004年03月15日发布 2004年03月15日实施华为技术有限公司Huawei Technologies Co., Ltd.版权所有 侵权必究All rights reserved修订声明本规范拟制与解释部门:资料开发研究管理部本规范的相关系列规范或文件:资料开发研究管理部签发的有关文件相关国际规范或文件一致性:本规范符合下列国家标准国家标准 GB 03100-1993 国际单位制及其应用国家标准 GB 03101-1993 有关量、单位和符号的一般原则国
2、家标准 GB/T 15834-1995 标点符号用法替代或作废的其它规范或文件:无相关规范或文件的相互关系:当在本规范发布之前由资料开发研究管理部签发的有关文件与本规范不一致时,以本规范为准。本规范版本升级更改主要内容:第一版本无升级内容本规范主要起草专家:资料开发研究管理部:钱为民(0220)、马明(6669)、梁明琳(25643)本规范主要评审专家:韩献光(8725)、王永平(9826)、毛咏梅(15847)、杨健(28082)、李顺华(29118)、李天彬(20058)、陶瑛(15826)、宋联昌(9528)、傅湘辉(10592)、李少清(0648)、彭新灿(10264)、王艳英(199
3、66)本规范历次修订情况:规范号Doc No.主要起草专家主要评审专家DKBA13132003.12钱为民(0220)、马明(6669)、梁明琳(25643)韩献光(8725)、王永平(9826)、毛咏梅(15847)、杨健(28082)、李顺华(29118)、李天彬(20058)、陶瑛(15826)、宋联昌(9528)、傅湘辉(10592)、李少清(0648)、彭新灿(10264)、王艳英(19966)目 录1 产品手册中文写作规范序言41.1 目的41.2 应用范围41.3 致谢42 样式和内容52.1 前言52.2 目录52.3 标题62.4 段落82.5 句子82.6 项目列表92.7
4、 表格102.8 图形112.9 说明和注意112.10 内容引用122.10.1 同手册同文档时的引用122.10.2 相同手册不同文档间的引用132.10.3 不同手册间的引用132.11 缩略语142.12 术语152.13 数及数量162.13.1 基本规则162.13.2 多位整数与小数162.13.3 数字范围162.13.4 数值的倍数162.13.5 极限数值172.13.6 时间182.13.7 物理量182.13.8 非物理量182.13.9 代号、代码和序号192.14 举例192.14.1 电话号码192.14.2 人称192.14.3 地名192.14.4 数据举例2
5、02.14.5 IP地址202.15 常用语213 中文标点符号223.1 句号223.2 逗号223.3 顿号233.4 分号233.5 冒号233.6 引号243.7 括号253.8 连接号253.9 书名号263.10 破折号263.11 省略号273.12 标点符号使用说明274 单位符号284.1 单位词头284.2 国际单位284.3 常见计量单位的错误符号314.4 手册常用符号325 界面、控件名称345.1 界面(Graphic User Interface)345.2 菜单(Menu)375.3 按钮(Button)405.4 组合框(Combination Box)435
6、5 其他组件(Others)466 附录:资料开发研究管理部已签发规范摘要516.1 技术术语及缩略语解释原则516.2 商标使用管理规定526.3 环境保护声明536.4 资料总称规定536.5 知识产权概念546.6 手册命名和资料版本编码规则557 参考文献56DKBA13132003.12华为机密,未经许可不得扩散 第56页,共59页Page 56 , Total59表目录表1 标题序列编排表6表2 注意、说明类标志使用说明表12表3 极限数值基本用语及涵义表17表4 连接号说明表26表5 常用词头表28表6 国际符号表28表7 常见计量单位错误符号表31表8 产品手册常见符号表32
7、产品手册中文写作规范范 围Scope:本规范规定了产品手册的中文写作风格。本规范适用于产品手册开发参考、文档信息开发参考、产品线开发人员参与手册写作前的引导培训;检视、评审、测评过程中争议问题的裁决。也可供联机帮助等产品资料开发参考。简 介Brief introduction:本技术规范参考了语言规范和通信行业规范的相关内容,结合产品手册的开发实践编制而成,对写作过程中容易出现问题的写作要点进行了统一定义,规定了产品手册的中文写作风格。关键词Key words:样式、标点符号、单位符号、界面控件、标题、项目列表、段落、缩略语、术语引用文件:下列文件中的条款通过本规范的引用而成为本规范的条款。凡
8、是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。序号No.文件编号Doc No.文件名称 Doc Title12术语和定义Term&Definition:缩略语Abbreviations 英文全名 Full spelling中文解释 Chinese explanation1 产品手册中文写作规范序言1.1 目的为了提高资料开发工程师写作技能,提高整体写作职业化水平,资料开发研究管理部制定了统一的产品手册中文写作规范。1.2 应用范围l 资料开发
9、工程师写作参考;l 产品线开发人员参与手册写作前的引导培训;l 检视、评审、测评过程中争议问题的裁决;l 也可供联机帮助等产品资料开发参考。1.3 致谢南京研究所资料开发部智能资料开发部2 样式和内容本章对以下构成产品手册的几大要素进行了定义,并对写作过程中容易出现问题的写作要点进行了统一规定。2.1 前言用户在第一次使用手册时,前言向用户介绍了手册的结构,帮助用户快速查找所需的信息。在产品手册前言的写作中应注意:l 模块或章节的内容摘要做到全面性和正确性;l 说明阅读本章可以获得哪些知识,可以帮助读者达到一个什么目标;l “本书约定”中要删除本书中未使用的格式说明行和注意、说明类标志。2.2
10、 目录1. 产品手册目录设计要求l 模块化手册应提供模块目录及总目录。l 非模块化手册提供总目录。l 总目录中必须包含所有章节以及附录的内容。2. 图表目录要求除了正文目录外,还涉及到插图、表格目录。技术手册、安装手册需要提供图、表总目录,其他手册根据作者需要进行规划。凡规划插图、表格目录的手册,作者就手册图、表目录的完整性、清晰性、全面性进行精心设计,同时表说明(Table Description)、图说明(Figure Description)的描述风格需要一致。以下情况不需要提供图表目录:l 操作界面较多的手册不需要创建图目录;l 规模较小的手册(少于100页)不需要提供图、表目录。3.
11、 上网和光盘制作对目录的要求在制作光盘和手册上网时使用了HTML文件,所以在每个文件或每个章节前应保留目录(不保留图、表目录),用于制作超级链接。但这个目录是不印刷的。请作者了解并在印刷说明中明确说明。2.3 标题1. 样式要求标题1下面不能直接使用标题3。标题要避免孤立编号,正文不要有孤立三级、四级、五级标题。表1 标题序列编排表标题编排次序说 明一级第1章 XXXXXX对应排版模板标题1二级1.1 XXXXXX对应排版模板标题2三级1.1.1 XXXXXX对应排版模板标题3四级1. xxxxxx对应排版模板标题4五级(1) xxxxxx对应排版模板Item Step项目列表l xxxxxx
12、对应排版模板Item List2. 标题的设计常用标题的写法有以下几种。l 名词词组,如“概述”、“规格参数”。l 主题词动词,如“母板插框槽位说明”。l 动词主题词,如“配置用户数据”。l 定语主题词,如“交换网板的安装”,“交换网板的结构”。l 介词定语主题词,如“对空间规划的要求”。3. 标题设计注意事项内容注意事项:l 标题概括反映章节的中心内容;l 标题尽量简洁扼要,涵义确切;l 表示操作任务时用“动词主题词”结构,不要使用名词词组。风格注意事项:l 同一级标题建议用一种结构表达;l 下级标题不重复上一级标题的内容;l 高一级标题下不应只有一个次级标题,同时避免孤立的章节和标题存在;
13、l 四级标题以上的标题之间应该有正文内容;如一级标题和二级标题之间应有引言,二级标题和三级标题之间应有正文内容。l 14级标题中不带标点符号,不对缩略语解释;l 为了便于翻译,四级和四级以下的标题编号不使用中文数字一、二、三、四、五等;l 项目列表(Item list)是最小编号单位。项目列表下面不可以嵌套子标题。4. 项目列表和标题5内容要求在手册写作中,经常使用项目列表和标题5来表示操作步骤和并列关系的分句。使用项目列表和标题5(Item Step)进行编排的内容,其描述应该符合:l 简单的术语和词汇;l 短语,简单句或单句描述;l 类似的步骤采用类似的语言描述。从方便用户记忆的角度出发,
14、建议一个操作任务限制在7个或更少的单步操作下,最多不要超过9个步骤。在某个步骤存在多个选项时,建议使用表格进行描述。【例如】在告警信息窗口中选择相应的操作按钮。选择执行单击按钮保存所有的上传告警信息。单击按钮仅保存当前告警信息。2.4 段落段落是主题信息块的基本构成单元之一,由多个句子构成。段落写作要求如下。l 一个段落只能有一个主题,或一个中心句子。l 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子作为说明、展开、论据陈述等为核心句服务。l 一个段落的长度不能超过7行,最佳段落长度小于等于4行。l 连续的段落不能超过1页,建议不要超过3个段落。l 段落的句子语气要使用陈述和肯定语
15、气,避免使用感叹语气。l 对于技术描述类主题,应考虑先图表,后句子的原则,不要单一的使用段落来陈述主题。2.5 句子句子是以句号结尾,句号表示句子意思已完成。l 句子要避免使用长句。一个句子建议不超过100字(正文3行)。l 句子要使用简单句和并列句,避免使用复合句。【常见错误】作为系统间切换的最基本要求,GSM系统要能对UMTS系统的RNC ID进行识别,而UMTS也要能对GSM小区号进行识别,同时GSM和UMTS必须支持相互之间的服务质量参数的转换(即,2G channel type与3G QoS之间的转换),以保证为用户提供可靠的服务质量,同时还需终端的支持,如双模手机。【点评】以上句子
16、由多个分句构成的复合句。句与句之间使用了很多修饰用连词,如“而”、“同时”等。增加了理解整体句群含义的难度。【建议修改】系统间切换的基本要求: GSM能识别UMTS的RNC ID; UMTS能识别GSM的小区号; GSM和UMTS支持服务质量参数(2G channel type、3G QoS)的相互转换; 需要终端的支持,如双模手机。句子要避免歧义结构。歧义是因为句子的构成形式与其意义之间产生了多种的对应关系,使技术表达的准确性产生了多种不确定因素。歧义常因为上下文的关系和技术背景而消失,但如果没有上下文的技术背景引导,加之部分词性的变化,歧义就会发生,这种情况常发生在标题、表格文本、项目列
17、表文本中。以下给出了几种技术写作中常见的歧义结构供参考。l 名词1名词2名词3常存在的歧义结构:(名词1名词2)名词3;名词1(名词2名词3)。这种结构在手册中经常出现,注意规避,同时注意词性的变化。如“配置管理界面”。l 动词形容词的名词常存在的歧义结构:(动词形容词的)名词;动词(形容词的名词)。如“检测故障的电路”。l 名词1的名词2和名词3常存在的歧义结构:(名词1的名词2)和名词3;名词1的(名词2和名词3)。如“系统的时钟和主控单元”。2.6 项目列表1. 样式要求除了为保持全文对某个信息块表达风格一致性的情况以外,单独一项内容不使用Item List样式。2. 内容要求在手册写作
18、中,经常使用项目列表来表示并列关系的分句。使用项目列表进行编排的技术内容,其描述应该符合:l 简单的术语和词汇;l 短语、简单句或单句描述。2.7 表格1. 样式要求l 表格一行中的单元要求不跨页。l 对于多行合并单元格的情况,应将段落属性设置成不跨页。l 每个表格下都要空一行,这一空行的样式为正文。在遇换页的特殊情况下,若表格后的空行为页面第一行,空行需删除。2. 内容要求同一产品手册中相同类型表格的表头内容需要保持一致。【例如】对参数进行说明的表,不要出现“参数说明”、“参数解释”、“参数含义”、“参数意义”等不同的表头内容,尽量统一。3. 单元格内容要求l 表格中的内容应该尽量简练,文字
19、表述风格保持一致。避免长篇大段的说明,建议单元格中的内容所占行数不要超过6行。l 不出现空白的单元格。建议无内容单元填写“无”或特定含义符号(如“-”)。若使用特定含义符号,需说明符号代表的意义。l 单元格内容适当重复。如果多个单元格中的内容相同,建议将内容复制或者采用多个单元格合并的方式,不要使用“同上”。4. 表说明内容要求l 表说明采用名词词组形式。l 表说明简明扼要,长度不能超过表的宽度。l 同类表格的表说明在全文中风格保持统一。2.8 图形图形设计的详细内容,请参见图形设计规范。1. 绘制注意事项l 禁止直接引用背景透明的位图图标。l 禁止图标或背景用渐变色。l 禁止使用占用磁盘空间
20、太大的图形格式。l 界面图禁止使用JPG格式,建议用GIF或PNG格式。l 组网图中所有的图标风格保持一致,使用公司最新图库中的构件。2. 内容要求l 图形中中文字体采用“宋体”,字母与数字采用“Arial”字体。l 图形中避免出现大段文字,描述性语言建议放到图外,用编号替代。同一产品手册必须采用相同的标准。l 图形中包含缩略语时,需要在图说明中对缩略语进行解释。l 所要描述的网元或网络设备,应在图形的中心位置或在图形中给予突出表示。l 图形层次结构为下级网络设备在左边或下方,上级网络设备在右边或上方的结构。l 图形的说明和图尽量统一在一页上。如果分布在相邻的两页上,应保证该两页是相对的,而不
21、是相背的(即先偶数页,后奇数页)。2.9 说明和注意1. 样式要求l 中文的产品手册在注意、说明下面空一行。空行的样式为正文样式。l 注意、说明中不能包含项目列表和标题5样式,也不能使用数字作为项目编号。l 如果特殊情况下需要在说明、注意中罗列多个项目,请选择模板中的“Note Text list”样式。2. 内容设计l 根据级别和分类使用不同的文字描述,参见表2。l 注意、说明中不能包含表格和图形。l 说明、注意类的内容不能过长,建议不要超过4行。l 一页不超过两段“说明”。表2 注意、说明类标志使用说明表图形文字使用原则危险若用户忽略危险标志,可能会因误操作发生危害人身安全、环境安全等严重
22、后果。警告若用户忽略警告标志,可能会因误操作发生重大事故(如损坏设备)或人身伤害。小心若用户忽略警告标志,可能会因误操作发生严重事故(如损坏设备)或人身伤害。注意若用户忽略注意标志,可能会因误操作而带来一定的不良后果或者无法成功操作。一般来说,解决产生的问题不会太麻烦。&说明提供给用户的说明和提示,使用比较广泛。&窍门作者提供给用户的一些容易忽视的小功能、技巧,这些小功能或技巧能够为用户带来便利。&举例通过简短的例子对操作中的任务进行补充说明,增进用户对任务的理解。2.10 内容引用手册间相互引用,就是正文中被引用的内容在其他地方已经详细描述,该处不适合再次重复介绍。引用,应该尽量避免在手册中
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 350 华为 公司 产品 手册 中文 写作 规范
