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 内容引用手册间相互引用，就是正文中被引用的内容在其他地方已经详细描述，该处不适合再次重复介绍。引用，应该尽量避免在手册中

23、使用；引用，必须保证引用的位置准确；对于内容很少（小于100字）但必须引用的情况建议直接在该处重新描述一遍；对于内容很多不利于重新描述的，可以采用引用。引用的规范参见下面三种情况。2.10.1 同手册同文档时的引用引用统一表达为：“请参见”。被引用的内容统一表达为：“标题序号（包括章、节）+标题文字”。利用Word软件功能，创建交叉引用，引用标题编号和标题文字。被引用的标题变化时，选中全文，更新域，会自动更新引用的链接。在正式定稿前，需要选中全文，更新域，刷新所有引用的语句，保证引用语句与被引用内容的标题序号、标题文字保持一致。在样书检查时，需要专门检查一遍引用语句刷新是否正常，是否与被引用内

24、容的标题序号、标题文字保持一致。【例如】这种情况下引用的具体要求请参见“2.10.1 同手册同文档时的引用”。& 说明：标题序号和标题文字之间的空格是两格。2.10.2 相同手册不同文档间的引用引用统一表达为：“请参见”。被引用的内容统一表达为：“部分名称（或模块名称）+标题序号（包括章、节）+标题文字”。需要手工写入这些内容，需要用引号。在样书检查时，需要专门检查一遍引用语句是否与被引用内容的标题序号、标题文字保持一致。【例如】磁盘划分的具体操作方法，请参见“第四部分 附录 A.2.1 划分磁盘空间”中的描述。& 说明：部分名称、标题序号、标题文字之间的的空格是两格。2.10.3 不同手册间

25、的引用引用统一表达为：“请参见”。被引用的内容统一表达为：书名号手册全称。手册全称中字符（含数字、字母）与字符、字符与文字之间加1个空格，文字与文字之间加2个空格。引用的内容需要手工写入，不添加引号，不具体到详细的模块、章节、标题。在样书检查时，需要专门检查一遍引用语句是否与被引用内容书名保持一致。【例如】在网管上的操作请参见OptiX iManager T2000 传送网子网级管理系统 操作手册。2.11 缩略语缩略语（Abbreviations），包含缩写和只取首字母的缩写词。正文中第一次出现的缩略语，必须进行解释。提供和不提供缩略语的手册，要求如下。l 需要提供缩略语表的资料：技术手册、

26、操作手册、维护手册、设备手册、用户手册、产品概述。l 不需提供缩略语表的资料：安装手册、命令手册、验收手册、出厂检验报告、成套资料使用指南、安全手册。缩略语表（Abbreviations）作为附录，放在手册的最后一部分。中文的正文缩略语解释格式：VPN（Virtual Private Network），括号中的解释不需要提供中文说明。缩略语表保持以下样式。Numerics3GThe Third Generation第三代（移动通信系统）3GPP23rd Generation Partnership Project 2第三代移动通信标准化伙伴项目二AAALATM Adaptation Layer

27、ATM适配层CCAMELCustomized Applications for Mobile network Enhanced Logic移动网络增强逻辑的客户化应用2.12 术语在技术、操作、维护手册中出现的重要技术术语（Term）要给予解释。可以在手册正文说明，也可以在术语表（Glossary）中说明。重要技术术语是指新技术术语、华为技术术语、不常见的技术术语。技术术语的解释原则立足于使用户快速和方便的理解产品特性，便于操作和维护设备。术语表放在缩略语表之前。术语表遵循以下样式，其中第一列中文术语按照拼音声母排序。& 说明：术语表模板以本规范为准。D动态VLAN用户Dynamic VLAN

28、 UserIP地址需要从DHCP Server上动态获得的VLAN用户。动感地带M-ZONE中国移动的业务品牌。G光纤收发器O/E Converter即通常所说的光电转换器或光Modem，实现100Base-TX的FE接口从电口到光口的转换，主要目的是实现电口5类线距离的拉远。L离线话单Logoff Call Detail Record在线用户下线时，由MA5200E/F向RADIUS服务器产生的该用户离线的最后一次话单，RADIUS服务器收到离线话单后认为该用户已经下线停止对该用户计费。2.13 数及数量2.13.1 基本规则数字在书面中的用法有两种：文字型和阿拉伯型。l 在极其正式的文件中

29、使用文字来表示数字。如公告、社交请帖。产品手册避免使用。l 统计表中的数值，如正负整数，小数，百分比，分数，比例，必须使用阿拉伯数字。l 定型的词组、术语、带有修饰色彩的词语中使用文字格式。如三三制、五局三胜制、二十挂零、第三季度。l 对于需要强调的特别书面信息，格式不定，但要全文保持统一。如第1章。2.13.2 多位整数与小数l 数值巨大的精确数字，可以使用“亿、万”作单位。如，10亿231万3245人。l 使用阿拉伯型表示的数字不能发生断开移行。l 多位整数要从右到左分节，如 2 345 567 456。分节的空格为半角模式的空格。l 多位小数要从小数点后从左向右分节，如 4.234 3

30、45。“.”使用Arial。2.13.3 数字范围l 表示数值范围时，用“”连接。l 数字带有国际单位和表示量的数词时，两个数字都要加上数词和单位。正确的使用方法：132kg234kg，67%89%，50kV100kV，70kPa106kPa。错误的使用方法：132234kg，6789%，50100kV，70106kPa。2.13.4 数值的倍数数字的增加要使用“增加了”、“增加到”。“了”表增量，“到”表定量。如下：l 增加到过去的两倍即过去为一，现在为二；l 增加了两倍即过去为一，现在为三。数字的减少要使用“降低了”、“降低到”。“了”表增量，“到”表定量。如下：l 降低到百分之八十即定额

31、是一百，现在是八十；l 降低了百分之八十即原来是一百，现在是二十。不能用“降低N倍”或“减少N倍”的表示法，要用“降低百分之几”或“减少百分之几”。因为减少（或降低）一倍其涵义表示数值原来为一百，现在等于零。2.13.5 极限数值极限数值有两种方式：最小/大极限值，或基本数值与极限偏差值。注意数值的有效位数。有效位数的精确程度展示了产品的应有性能和质量。极限数值基本用语及涵义。表3 极限数值基本用语及涵义表基本用语符号其他用语涵义大于AA多于高于A值不符合标准要求（不含A值）小于AA少于低于A值不符合标准要求（不含A值）大于或等于AA不小于不少于不低于A值符合标准要求小于或等于AA不大于不多于

32、不高于A值符合标准要求l “不多于”“不少于”“多于”“少于”用于叙述时间、距离等指标。如，使用寿命不少于30年。l “不高于”“不低于”等用于叙述温度、高度等指标。如不低于80。l 从A到B表示法如，AXB，或 AB。l 习惯用语。如“A及以上”表示数值大于或等于A。“超过A”表示数值大于A。“至少A”表示数值大于或等于A。偏差值的数值和涵义。l 精确表示时，如510mm!4%，表示计算值R(mm)对于510mm的相对偏差值从(R510)/510)从4%到+4%符合标准要求。l 超出偏差范围的数值时，如510mm4%（不含4%），表示计算值R(mm)对于510mm的相对偏差值(R510)/5

33、10)从-4%到接近但不足+4%符合标准要求。2.13.6 时间使用阿拉伯数字的情况：l 公历世纪、年代、年、月、日使用阿拉伯数字。如，20世纪80年代，2003年7月30日。（一般，“1990年”在技术文档中不能简写成“90年”）；l 在表格、索引、年表中，年月日可以表示为“2003-07-30”。月和日为个位数时，要加“0”补充；l 时、分、秒。正式情况，采用如下格式：14时12分36秒。其他情况，按照GB-T 7408-94-5.3.1.1要求，使用扩展格式：14:12:16。“:”使用Arial。使用文字型数字的情况（产品手册避免使用）：l 农历年份。如，正月初五，丙寅年十月十五日；l

34、 含有时间简称来表示时间、节日的词组。如“九一三”事件，五四运动。2.13.7 物理量物理量量值必须用阿拉伯数字，并正确使用法定计量单位。2.13.8 非物理量l 一般情况下，使用阿拉伯数字。如45.6万元，1480人。l 整数一到十，没有统计意义的词组中，使用文字型，也可以用数值型，但全文要保持一致。如，一个人，三本书，六条意见。无线专业6个，专职QA14人。2.13.9 代号、代码和序号文件编号，证件号码，其他序号，用阿拉伯数字。如HP-3000型，维生素B12 。2.14 举例2.14.1 电话号码手册举例中引入电话号码时，格式如下：l 没有区号时：12345678l 国内区号时：075

35、5-12345678l 国家区号时：+86-755-12345678l 800电话：8001234567l 电话号码范围：1234500012348000；12345678/79/80固定电话号码举例时，局号要用“1”开头（即举例的号码用1开头）。区号可以按照实际情况举例。手机号码的举例中，格式如下：l 联通用户时，13300001234l 移动用户时，139000012342.14.2 人称在举例中引入的人名要保持全文一致。人名引入，不能采用全名或类似于全名的名称。引入人的称谓时，男：王先生。女：林小姐。如果存在不同角色，角色间不能使用同姓称谓。如王先生，王小姐。2.14.3 地名地名的引用

36、不应该采用实际地名，避免引起用户使用误解。举例中尽量采用如A地，A省，A市/区。特殊情况，需要特别指明地域的地方，按产品需求写作。2.14.4 数据举例举例经常引用的数据包含两种：第一种是系统设置的参数，第二种是号码、编号等。l 对于系统设置的参数，在举例中应该尽量采用接近用户实际情况的数据。l 举例中引入的系统设置参数不能引起用户其他数据的相互冲突或给设备造成影响。特别情况下，要突出说明。l 引入的编号如SIM卡编号，密码举例中，采用顺序编号方式。如充值卡密码：3213 1234 5678 1234。2.14.5 IP地址举例中经常要使用IP地址，要求一般举例使用私网IP地址，地址范围如下。

37、ClassAddress RangeA10.0.0.010.255.255.255B172.16.0.0 172.31.255.255C192.168.0.0192.168.255.255在特殊情况下（如NAT网络地址转换协议、VPN配置）需要使用公网地址举例。要求举例中公网地址统一规划，并遵循简单、清晰的原则，例如采用1.2.3.4，11.11.11.1的公网地址。IP地址举例需要注意以下事项。l 举例时，IP地址要求简单、清晰，例如不要使用如10.112.208.234的复杂地址，用类似10.10.10.1的IP地址，方便记忆，一目了然。l 表示具体组网和路由信息中，IP地址必须和掩码同时

38、出现，组成完整的信息。为了简洁，图形和表格中可以使用如“1.1.1.1/24”的方式，其中斜杠后的“24”表示掩码长度。l 正文中必须使用255.255.255.0格式表示掩码，全文的表示方法必须唯一。如“IP地址为10.10.10.1，子网掩码为255.255.255.252”。以下IP地址为保留地址，在举例中不能作为设备、子网、网络地址出现。ClassAddress RangeStatusA0.0.0.0127.0.0.0ReservedB128.0.0.0191.255.0.0ReservedC192.0.0.0223.255.255.0ReservedD224.0.0.0239.255

39、255.255Multicast group AddressE240.0.0.0255.255.255.254255.255.255.255ReservedBroadcast2.15 常用语写作时要注意常用语的使用。常用语指在一个手册体系或一本手册的写作中，经常被使用的词句，如一些个性化语气词、操作动词、技术术语。常用语要保证全文一致。如人称代词，同一个动作的动词，行文语态。1. 避免使用表示程度、强调语气的词。l 表示程度的词：较多、较好、完全地、基本地、决定性的、最后的、仅仅、事实上、值得注意的。l 表示转折的词：当然、然而。l 表示量的词：有些、非常、大量、一些、少许、部分。2. 避免

40、使用引起歧义的动词如“把电源开关打开”，“打开”因为环境不同有接通电源开关和断开电源开关之意。3. 避免使用含义模糊的动词。如“用信号线连接两个机柜”，如果表示两个机柜通过信号线进行通信，则“连接”这个词表示“通信”的概念模糊不明确，不利于翻译。3 中文标点符号3.1 句号句号的形式为“。”。句号常用于陈述句末尾的停顿。在产品资料中常用于简单句和复合句的结尾，表示句子意思已完整。【例如】请输入您的卡号或全如意帐号，并在号码后加拨“#”号。在正文描述下面紧接图或表时，句子说明已完整，以句号结束，不要使用冒号。【常见错误】“用户进入管理界面，如图3-2所示：”【建议修改】“用户进入管理界面，如图3

41、2所示。”3.2 逗号逗号的形式为“，”。逗号表示句子内部的一般性停顿。一个较长的句子，需要在适当的地方使用逗号加以停顿。【例如】考虑实际应用情况，1.8m型机柜一般都采用交流供电形式。逗号虽然没有特殊、专门的意义，使用也最普遍，但是不能滥用。经常出现的错误是“一逗到底”，整个段落除了段落结尾外，全部停顿都使用逗号。【常见错误】帐务计费中心主要负责话单处理和帐务处理，帐务计费中心同计费网关之间有一个话单接口，用于帐务计费中心取用户话单，话单文件采用*.TXT的形式。【建议修改】帐务计费中心主要负责话单处理和帐务处理。帐务计费中心同计费网关之间有一个话单接口，用于帐务计费中心取用户话单。话单文

42、件采用*.TXT的形式。3.3 顿号顿号的形式为“、”。句子内部并列词语之间的停顿，用顿号。【例如】母板插框、风扇框、交流电源、直流电源等在出厂前已安装完毕。3.4 分号分号的形式为“；”。复句内部并列分句之间的停顿，用分号。分行列举的各项之间，可以用分号。分项说明时，如分几大项，大项下面又分几个小项；小项之间用分号，大项之间用句号，如例二所示。【例一】转换的范围包括：l 图形元素转换为接收终端可处理的格式；l 音频格式转换为接收终端可处理的格式；l 文本编码格式转换为接收终端可处理的格式。【例二】具体来讲，分为如下几种情况：(1) XXXXXXXXXXXXXX。l XXXXXX；l XXXX

43、XXXX；l XXXXXXXX。(2) XXXXXXXXX。(3) XXXXXXXXXXXXXXX。& 说明：有时文中Item list中的内容是一个段落，这种情况下，各分项句末使用句号。3.5 冒号冒号的形式为“：”。在手册中常用在需要解释的词语后边，表示引出解释和说明。冒号在手册写作中常用来引出Item list和Item Step样式。【例如】设备分为以下几个部分：l 机柜l 单板l 外接设备l 引出的Item list样式的更多例子请参见“3.4 分号”。建议不要连续使用冒号。【常见错误】计费策略：表示计费：1，表示不计费：2。【建议修改】计费策略：1表示计费，2表示不计费。3.6 引

44、号引号的形式为双引号“”和单引号。引号里面还要用引号时，外面一层用双引号，里面一层用单引号。产品手册的正文中若涉及特定参数名称、字段名、界面字段、引用手册的节选等，建议使用引号。【例一】在参数表中规定了TMN接口与支持这些接口的物理构件的关系，其中“M”表示必备，“O”表示可选。【例二】具体命令解释请参见Quidway S8016路由交换机 安装手册中“1.2.1 安装步骤”的内容。【例三】请设置如下三个参数：“Card Number”、“Password”、“Discount Rate”。3.7 括号括号常用的形式是圆括号“（）”。此外还有方括号“ ”、方头括号“【】”以及我们装帧中定义的尖括号“”（标准中称单书名号）。其中产品手册中常用的是圆括号、方括号以及尖括号。行文中注释性的文字，用括注形式。注释句子里某些词语的，括注紧贴在被注释词语之后；注释整个句子的，括注放在句末标点之后。