产品手册中文写作规范.doc

产品手册中文写作规范 DKBA华为技术有限公司内部技术规范DKBA1313200312产品手册中文写作规范 2004年03月15日发布 2004年03月15日实施华为技术有限公司Huawei Technologies Co Ltd版权所有 侵权必究All rights reserved修订声明本规范拟制与解释部门资料开发研究管理部本规范的相关系列规范或文件资料开发研究管理部签发的有关文件相关国际规范或文件一致性本规范符合下列国家标准国家标准 GB 03100-1993 国际单位制及其应用国家标准 GB 03101-1993 有关量单位和符号的一般原则国家标准 GBT 15834-1995 标点符号用法替代或作废的其它规范或文件无相关规范或文件的相互关系当在本规范发布之前由资料开发研究管理部签发的有关文件与本规范不一致时以本规范为准本规范版本升级更改主要内容第一版本无升级内容本规范主要起草专家资料开发研究管理部钱为民0220马明6669梁明琳25643本规范主要评审专家韩献光8725王永平9826毛咏梅15847杨健28082李顺华29118李天彬20058陶瑛15826宋联昌9528傅湘辉10592李少清0648彭新灿10264王艳英19966本规范历次修订情况规范号Doc No主要起草专家主要评审专家DKBA1313200312钱为民0220马明6669梁明琳25643韩献光8725王永平9826毛咏梅15847杨健28082李顺华29118李天彬20058陶瑛15826宋联昌9528傅湘辉10592李少清0648彭新灿10264王艳英19966目 录1 产品手册中文写作规范序言411 目的412 应用范围413 致谢42 样式和内容521 前言522 目录523 标题624 段落825 句子826 项目列表927 表格1028 图形1129 说明和注意11210 内容引用12com 同手册同文档时的引用12com 相同手册不同文档间的引用13com 不同手册间的引用13211 缩略语14212 术语15213 数及数量16com 基本规则16com 多位整数与小数16com 数字范围16com 数值的倍数16com 极限数值17com 时间18com 物理量18com 非物理量18com 代号代码和序号19214 举例19com 电话号码19com 人称19com 地名19com 数据举例20com IP地址20215 常用语213 中文标点符号2231 句号2232 逗号2233 顿号2334 分号2335 冒号2336 引号2437 括号2538 连接号2539 书名号26310 破折号26311 省略号27312 标点符号使用说明274 单位符号2841 单位词头2842 国际单位2843 常见计量单位的错误符号3144 手册常用符号325 界面控件名称3451 界面Graphic User Interface3452 菜单Menu3753 按钮Button4054 组合框 Combination Box 4355 其他组件 Others 466 附录资料开发研究管理部已签发规范摘要5161 技术术语及缩略语解释原则5162 商标使用管理规定5263 环境保护声明5364 资料总称规定5365 知识产权概念5466 手册命名和资料版本编码规则557 参考文献56表目录表1 标题序列编排表6表2 注意说明类标志使用说明表12表3 极限数值基本用语及涵义表17表4 连接号说明表26表5 常用词头表28表6 国际符号表28表7 常见计量单位错误符号表31表8 产品手册常见符号表32产品手册中文写作规范范 围Scope本规范规定了产品手册的中文写作风格本规范适用于产品手册开发参考文档信息开发参考产品线开发人员参与手册写作前的引导培训检视评审测评过程中争议问题的裁决也可供联机帮助等产品资料开发参考简 介Brief introduction本技术规范参考了语言规范和通信行业规范的相关内容结合产品手册的开发实践编制而成对写作过程中容易出现问题的写作要点进行了统一定义规定了产品手册的中文写作风格关键词Key words样式标点符号单位符号界面控件标题项目列表段落缩略语术语引用文件下列文件中的条款通过本规范的引用而成为本规范的条款凡是注日期的引用文件其随后所有的修改单不包括勘误的内容或修订版均不适用于本规范然而鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本凡是不注日期的引用文件其最新版本适用于本规范序号No文件编号Doc No文件名称 Doc Title12术语和定义TermDefinition缩略语Abbreviations 英文全名 Full spelling中文解释 Chinese explanation产品手册中文写作规范序言目的为了提高资料开发工程师写作技能提高整体写作职业化水平资料开发研究管理部制定了统一的产品手册中文写作规范应用范围资料开发工程师写作参考产品线开发人员参与手册写作前的引导培训检视评审测评过程中争议问题的裁决也可供联机帮助等产品资料开发参考致谢南京研究所资料开发部智能资料开发部样式和内容本章对以下构成产品手册的几大要素进行了定义并对写作过程中容易出现问题的写作要点进行了统一规定前言用户在第一次使用手册时前言向用户介绍了手册的结构帮助用户快速查找所需的信息在产品手册前言的写作中应注意模块或章节的内容摘要做到全面性和正确性说明阅读本章可以获得哪些知识可以帮助读者达到一个什么目标本书约定中要删除本书中未使用的格式说明行和注意说明类标志目录产品手册目录设计要求模块化手册应提供模块目录及总目录非模块化手册提供总目录总目录中必须包含所有章节以及附录的内容图表目录要求除了正文目录外还涉及到插图表格目录技术手册安装手册需要提供图表总目录其他手册根据作者需要进行规划凡规划插图表格目录的手册作者就手册图表目录的完整性清晰性全面性进行精心设计同时表说明图说明的描述风格需要一致以下情况不需要提供图表目录操作界面较多的手册不需要创建图目录规模较小的手册不需要提供图表目录标题样式要求标题1下面不能直接使用标题3标题要避免孤立编号正文不要有孤立三级四级五级标题标题序列编排表标题编排次序说 明一级1 XXXXXX对应排版模板标题1二级11 XXXXXX对应排版模板标题2三级com XXXXXX对应排版模板标题3四级com1 xxxxxx对应排版模板标题4五级 1 xxxxxx对应排版模板Item Step项目列表xxxxxx对应排版模板Item List标题的设计常用标题的写法有以下几种名词词组如概述规格参数主题词动词如母板插框槽位说明动词主题词如配置用户数据定语主题词如交换网板的安装交换网板的结构介词定语主题词如对空间规划的要求标题设计注意事项内容注意事项标题概括反映章节的中心内容标题尽量简洁扼要涵义确切表示操作任务时用动词主题词结构不要使用名词词组风格注意事项同一级标题建议用一种结构表达下级标题不重复上一级标题的内容高一级标题下不应只有一个次级标题同时避免孤立的章节和标题存在四级标题以上的标题之间应该有正文内容如一级标题和二级标题之间应有引言二级标题和三级标题之间应有正文内容14级标题中不带标点符号不对缩略语解释为了便于翻译四级和四级以下的标题编号不使用中文数字一二三四五等项目列表Item list是最小编号单位项目列表下面不可以嵌套子标题项目列表和标题5内容要求在手册写作中经常使用项目列表和标题5来表示操作步骤和并列关系的分句使用项目列表和标题5Item Step进行编排的内容其描述应该符合简单的术语和词汇短语简单句或单句描述类似的步骤采用类似的语言描述从方便用户记忆的角度出发建议一个操作任务限制在7个或更少的单步操作下最多不要超过9个步骤在某个步骤存在多个选项时建议使用表格进行描述例如在告警信息窗口中选择相应的操作按钮选择执行单击 按钮保存所有的上传告警信息单击 按钮仅保存当前告警信息段落段落是主题信息块的基本构成单元之一由多个句子构成段落写作要求如下一个段落只能有一个主题或一个中心句子段落的中心句子放在段首对全段内容进行概述后面陈述的句子作为说明展开论据陈述等为核心句服务连续的段落不能超过1页建议不要超过3个段落段落的句子语气要使用陈述和肯定语气避免使用感叹语气对于技术描述类主题应考虑先图表后句子的原则不要单一的使用段落来陈述主题句子句子是以句号结尾句号表示句子意思已完成句子要避免使用长句一个句子建议不超过100字正文3行句子要使用简单句和并列句避免使用复合句常见错误作为系统间切换的最基本要求GSM系统要能对UMTS系统的RNC ID进行识别而UMTS也要能对GSM小区号进行识别同时GSM和UMTS必须支持相互之间的服务质量参数的转换即2G channel type与3G QoS之间的转换以保证为用户提供可靠的服务质量同时还需终端的支持如双模手机点评以上句子由多个分句构成的复合句句与句之间使用了很多修饰用连词如而同时等增加了理解整体句群含义的难度建议修改系统间切换的基本要求GSM能识别UMTS的RNC IDUMTS能识别GSM的小区号GSM和UMTS支持服务质量参数2G channel type3G QoS的相互转换需要终端的支持如双模手机句子要避免歧义结构歧义是因为句子的构成形式与其意义之间产生了多种的对应关系使技术表达的准确性产生了多种不确定因素歧义常因为上下文的关系和技术背景而消失但如果没有上下文的技术背景引导加之部分词性的变化歧义就会发生这种情况常发生在标题表格文本项目列表文本中以下给出了几种技术写作中常见的歧义结构供参考名词1名词2名词3常存在的歧义结构名词1名词2名词3名词1名词2名词3这种结构在手册中经常出现注意规避同时注意词性的变化如配置管理界面动词形容词的名词常存在的歧义结构动词形容词的名词动词形容词的名词如检测故障的电路名词1的名词2和名词3常存在的歧义结构名词1的名词2和名词3名词1的名词2和名词3如系统的时钟和主控单元项目列表样式要求除了为保持全文对某个信息块表达风格一致性的情况以外单独一项内容不使用Item List样式内容要求在手册写作中经常使用项目列表来表示并列关系的分句使用项目列表进行编排的技术内容其描述应该符合简单的术语和词汇短语简单句或单句描述表格样式要求表格一行中的单元要求不跨页每个表格下都要空一行这一空行的样式为正文在遇换页的特殊情况下若表格后的空行为页面第一行空行需删除内容要求同一产品手册中相同类型表格的表头内容需要保持一致例如对参数进行说明的表不要出现参数说明参数解释参数含义参数意义等不同的表头内容尽量统一单元格内容要求表格中的内容应该尽量简练文字表述风格保持一致避免长篇大段的说明不出现空白的单元格建议无内容单元填写无或特定含义符号如-若使用特定含义符号需说明符号代表的意义单元格内容适当重复如果多个单元格中的内容相同建议将内容复制或者采用多个单元格合并的方式不要使用同上表说明内容要求表说明采用名词词组形式表说明简明扼要长度不能超过表的宽度同类表格的表说明在全文中风格保持统一图形图形设计的详细内容请参见图形设计规范绘制注意事项禁止图标或背景用渐变色组网图中所有的图标风格保持一致使用公司最新图库中的构件内容要求图形中中文字体采用宋体字母与数字采用Times New Roman字体图形中避免出现大段文字描述性语言建议放到图外用编号替代同一产品手册必须采用相同的标准图形中包含缩略语时需要在图说明中对缩略语进行解释图形层次结构为下级网络设备在左边或下方上级网络设备在右边或上方的结构图形的说明和图尽量统一在一页上如果分布在相邻的两页上应保证该两页是相对的而不是相背的即先偶数页后奇数页说明和注意样式要求产品手册在注意说明下面空一行空行的样式为正文样式注意说明中不能包含项目列表和标题5样式也不能使用数字作为项目编号如果特殊情况下需要在说明注意中罗列多个项目请选择模板中的Note Text list样式内容设计根据级别和分类使用不同的文字描述参见表2注意说明中不能包含表格和图形说明注意类的内容不能过长建议不要超过4行一页不超过两段说明注意说明类标志使用说明表图形文字使用原则危险若用户忽略危险标志可能会因误操作发生危害人身安全环境安全等严重后果警告若用户忽略警告标志可能会因误操作发生重大事故如损坏设备或人身伤害小心若用户忽略警告标志可能会因误操作发生严重事故如损坏设备或人身伤害注意若用户忽略注意标志可能会因误操作而带来一定的不良后果或者无法成功操作一般来说解决产生的问题不会太麻烦 说明提供给用户的说明和提示使用比较广泛 窍门作者提供给用户的一些容易忽视的小功能技巧这些小功能或技巧能够为用户带来便利 举例通过简短的例子对操作中的任务进行补充说明增进用户对任务的理解内容引用手册间相互引用就是正文中被引用的内容在其他地方已经详细描述该处不适合再次重复介绍引用应该尽量避免在手册中使用引用必须保证引用的位置准确对于内容很少小于100字但必须引用的情况建议直接在该处重新描述一遍对于内容很多不利于重新描述的可以采用引用引用的规范参见下面三种情况同手册同文档时的引用引用统一表达为请参见被引用的内容统一表达为标题序号包括章节标题文字利用Word软件功能创建交叉引用引用标题编号和标题文字被引用的标题变化时选中全文更新域会自动更新引用的链接在正式定稿前需要选中全文更新域刷新所有引用的语句保证引用语句与被引用内容的标题序号标题文字保持一致在样书检查时需要专门检查一遍引用语句刷新是否正常是否与被引用内容的标题序号标题文字保持一致例如这种情况下引用的具体要求请参见com 同手册同文档时的引用 说明相同手册不同文档间的引用引用统一表达为请参见被引用的内容统一表达为部分名称或模块名称标题序号包括章节标题文字需要手工写入这些内容需要用引号在样书检查时需要专门检查一遍引用语句是否与被引用内容的标题序号标题文字保持一致例如磁盘划分的具体操作方法请参见第四部分 附录 com 划分磁盘空间中的描述 说明不同手册间的引用引用统一表达为请参见被引用的内容统一表达为书名号手册全称手册全称中字符含数字字母与字符字符与文字之间加1个空格文字与文字之间加2个空格引用的内容需要手工写入不添加引号不具体到详细的模块章节标题在样书检查时需要专门检查一遍引用语句是否与被引用内容书名保持一致例如在网管上的操作请参见OptiX iManager T2000 传送网子网级管理系统 操作手册缩略语缩略语Abbreviations包含缩写和只取首字母的缩写词正文中第一次出现的缩略语必须进行解释提供和不提供缩略语的手册要求如下需要提供缩略语表的资料技术手册操作手册维护手册设备手册用户手册产品概述不需提供缩略语表的资料安装手册命令手册验收手册出厂检验报告成套资料使用指南安全手册缩略语表Abbreviations作为附录放在手册的最后一部分中文的正文缩略语解释格式VPNVirtual Private Network括号中的解释不需要提供中文说明缩略语表保持以下样式Numerics3GThe Third Generation第三代移动通信系统3GPP23rd Generation Partnership Project 2第三代移动通信标准化伙伴项目二AAALATM Adaptation LayerATM适配层CCAMELCustomized Applications for Mobile network Enhanced Logic移动网络增强逻辑的客户化应用术语在技术操作维护手册中出现的重要技术术语Term要给予解释可以在手册正文说明也可以在术语表Glossary中说明技术术语的解释原则立足于使用户快速和方便的理解产品特性便于操作和维护设备术语表放在缩略语表之前术语表遵循以下样式其中第一列中文术语按照拼音声母排序 说明D动态VLAN用户Dynamic VLAN UserIP地址需要从DHCP Server上动态获得的VLAN用户动感地带M-ZONE中国移动的业务品牌G光纤收发器OE Converter即通常所说的光电转换器或光Modem实现100Base-TX的FE接口从电口到光口的转换主要目的是实现电口5类线距离的拉远L离线话单Logoff Call Detail Record在线用户下线时由MA5200EF向RADIUS服务器产生的该用户离线的最后一次话单RADIUS服务器收到离线话单后认为该用户已经下线停止对该用户计费数及数量基本规则数字在书面中的用法有两种文字型和阿拉伯型在极其正式的文件中使用文字来表示数字如公告社交请帖产品手册避免使用统计表中的数值如正负整数小数百分比分数比例必须使用阿拉伯数字定型的词组术语带有修饰色彩的词语中使用文字格式如三三制五局三胜制二十挂零第三季度对于需要强调的特别书面信息格式不定但要全文保持统一如第1章多位整数与小数数值巨大的精确数字可以使用亿万作单位如10亿231万3245人使用阿拉伯型表示的数字不能发生断开移行多位整数要从右到左分节如 2 345 567 456分节的空格为半角模式的空格多位小数要从小数点后从左向右分节如 4234 345数字范围表示数值范围时用连接数字带有国际单位和表示量的数词时两个数字都要加上数词和单位正确的使用方法132kg234kg678950kV100kV70kPa106kPa错误的使用方法132234kg678950100kV70106kPa数值的倍数数字的增加要使用增加了增加到了表增量到表定量如下增加到过去的两倍即过去为一现在为二增加了两倍即过去为一现在为三数字的减少要使用降低了降低到了表增量到表定量如下降低到百分之八十即定额是一百现在是八十降低了百分之八十即原来是一百现在是二十不能用降低N倍或减少N倍的表示法要用降低百分之几或减少百分之几因为减少或降低一倍其涵义表示数值原来为一百现在等于零极限数值极限数值有两种方式最小大极限值或基本数值与极限偏差值注意数值的有效位数有效位数的精确程度展示了产品的应有性能和质量极限数值基本用语及涵义极限数值基本用语及涵义表基本用语符号其他用语涵义大于A A多于高于A值不符合标准要求不含A值小于A A少于低于A值不符合标准要求不含A值大于或等于A A不小于不少于不低于A值符合标准要求小于或等于A A不大于不多于不高于A值符合标准要求不多于不少于多于少于用于叙述时间距离等指标如使用寿命不少于30年不高于不低于等用于叙述温度高度等指标如不低于80从A到B表示法如A X B或 AB表示计算值R mm 对于510mm的相对偏差值从 R510 510 从4到4符合标准要求超出偏差范围的数值时如510mm4不含4表示计算值R mm 对于510mm的相对偏差值 R 510 从-4到接近但不足4符合标准要求时间使用阿拉伯数字的情况公历世纪年代年月日使用阿拉伯数字如20世纪80年代2003年7月30日一般1990年在技术文档中不能简写成90年在表格索引年表中年月日可以表示为2003-07-30月和日为个位数时要加0补充时分秒正式情况采用如下格式14时12分36秒其他情况按照GB-T 7408-94-com1要求使用扩展格式141216使用Arial使用文字型数字的情况产品手册避免使用农历年份如正月初五丙寅年十月十五日含有时间简称来表示时间节日的词组如九一三事件五四运动物理量物理量量值必须用阿拉伯数字并正确使用法定计量单位非物理量一般情况下使用阿拉伯数字如456万元1480人整数一到十没有统计意义的词组中使用文字型也可以用数值型但全文要保持一致如一个人三本书六条意见无线专业6个专职QA14人代号代码和序号文件编号证件号码其他序号用阿拉伯数字如HP-3000型维生素B12 举例电话号码手册举例中引入电话号码时格式如下没有区号时12345678国内区号家区号时86-755-12345678800电话8001234567电话号码范围1234500012348000123456787980固定电话号码举例时局号要用1开头即举例的号码用1开头区号可以按照实际情况举例手机号码的举例中格式如下联通用户时1XXXXXXXXXX移动用户时1XXXXXXXXXX人称在举例中引入的人名要保持全文一致人名引入不能采用全名或类似于全名的名称引入人的称谓时男王先生女林小姐如果存在不同角色角色间不能使用同姓称谓如王先生王小姐地名地名的引用不应该采用实际地名避免引起用户使用误解举例中尽量采用如A地A省A市区特殊情况需要特别指明地域的地方按产品需求写作数据举例举例经常引用的数据包含两种第一种是系统设置的参数第二种是号码编号等对于系统设置的参数在举例中应该尽量采用接近用户实际情况的数据举例中引入的系统设置参数不能引起用户其他数据的相互冲突或给设备造成影响特别情况下要突出说明引入的编号如SIM卡编号密码举例中采用顺序编号方式如充值卡密码3213 1234 5678 1234IP地址举例中经常要使用IP地址要求一般举例使用私网IP地址地址范围如下ClassAddress RangeAcom0com255Bcom0 com255Ccom0com255在特殊情况下如NAT网络地址转换协议VPN配置需要使用公网地址举例要求举例中公网地址统一规划并遵循简单清晰的原则例com4com1的公网地址IP地址举例需要注意以下事项举例时IP地址要求简单清晰例如不要使com234的复杂地址用com1的IP地址方便记忆一目了然表示具体组网和路由信息中IP地址必须和掩码同时出现组成完整的信息为了简洁图形和表格中可以使用如com124的方式其中斜杠后的24表示掩码长度正文中必须使com0格式表示掩码全文的表示方法必须唯一如IP地com1子网掩码com252以下IP地址为保留地址在举例中不能作为设备子网网络地址出现ClassAddress RangeStatusAcom0com0ReservedBcom0com0ReservedCcom0com0ReservedDcom0com255Multicast group AddressEcom0com254com255ReservedBroadcast常用语写作时要注意常用语的使用常用语指在一个手册体系或一本手册的写作中经常被使用的词句如一些个性化语气词操作动词技术术语常用语要保证全文一致如人称代词同一个动作的动词行文语态避免使用表示程度强调语气的词表示程度的词较多较好完全地基本地决定性的最后的仅仅事实上值得注意的表示转折的词当然然而表示量的词有些非常大量一些少许部分避免使用引起歧义的动词如把电源开关打开打开因为环境不同有接通电源开关和断开电源开关之意避免使用含义模糊的动词如用信号线连接两个机柜如果表示两个机柜通过信号线进行通信则连接这个词表示通信的概念模糊不明确不利于翻译中文标点符号句号句号的形式为句号常用于陈述句末尾的停顿在产品资料中常用于简单句和复合句的结尾表示句子意思已完整例如请输入您的卡号或全如意帐号并在号码后加拨号在正文描述下面紧接图或表时句子说明已完整以句号结束不要使用冒号常见错误用户进入管理界面如图3-2所示建议修改用户进入管理界面如图3-2所示逗号逗号的形式为逗号表示句子内部的一般性停顿一个较长的句子需要在适当的地方使用逗号加以停顿例如考虑实际应用情况18m型机柜一般都采用交流供电形式逗号虽然没有特殊专门的意义使用也最普遍但是不能滥用经常出现的错误是一逗到底整个段落除了段落结尾外全部停顿都使用逗号常见错误帐务计费中心主要负责话单处理和帐务处理帐务计费中心同计费网关之间有一个话单接口用于帐务计费中心取用户话单话单文件采用TXT的形式建议修改帐务计费中心主要负责话单处理和帐务处理帐务计费中心同计费网关之间有一个话单接口用于帐务计费中心取用户话单话单文件采用TXT的形式顿号顿号的形式为句子内部并列词语之间的停顿用顿号例如母板插框风扇框交流电源直流电源等在出厂前已安装完毕分号分号的形式为复句内部并列分句之间的停顿用分号分行列举的各项之间可以用分号分项说明时如分几大项大项下面又分几个小项小项之间用分号大项之间用句号如例二所示例一转换的范围包括图形元素转换为接收终端可处理的格式音频格式转换为接收终端可处理的格式文本编码格式转换为接收终端可处理的格式例二具体来讲分为如下几种情况XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 说明 list中的内容是一个段落这种情况下各分项句末使用句号冒号冒号的形式为在手册中常用在需要解释的词语后边表示引出解释和说明冒号在手册写作中常用来引出Item list和Item Step样式例如设备分为以下几个部分机柜单板外接设备引出的Item list样式的更多例子请参见34 分号建议不要连续使用冒号常见错误计费策略表示计费1表示不计费2建议修改计费策略1表示计费2表示不计费引号引号的形式为双引号和单引号引号里面还要用引号时外面一层用双引号里面一层用单引号产品手册的正文中若涉及特定参数名称字段名界面字段引用手册的节选等建议使用引号例一在参数表中规定了TMN接口与支持这些接口的物理构件的关系其中M表示必备O表示可选例二具体命令解释请参见Quidway S8016路由交换机 安装手册中com 安装步骤的内容例三请设置如下三个参数Card NumberPasswordDiscount Rate括号括号常用的形式是圆括号此外还有方括号 方头括号以及我们装帧中定义的尖括号 标准中称单书名号其中产品手册中常用的是圆括号方括号以及尖括号行文中注释性的文字用括注形式注释句子里某些词语的括注紧贴在被注释词语之后注释整个句子的括注放在句末标点之后例一系统提供VPNVirtual Private Network功能例二写技术说明类文档和文学创作不同不能摊开稿纸搞即兴其实文学创作也要有素养才能有即兴在产品手册中括号有许多特定用法方括号 表示窗口名菜单名等如弹出新建用户窗口文件新建文件夹多级菜单带尖括号 表示按钮名键名如单击 按钮 表示制表键连接号连接号的形式为占一个字的位置连接号还有另外四种形式即长横占两个字的位置半字线占半个字的位置短划线-占13个字的位置和浪纹占一个字的位置连接号说明表符号名称符号举例插入方式一字线常用于汉语名词之间压力温度曲线化学物理反应插入符号选择特殊符号中的长划线半字线常用于汉字和数字字母之间铀235惠普5000插入符号选择特殊符号中的短划线短划线-一些外来的词汇中常用短划线E-MailCD-ROMITU-T8-bitRJ-45插头STM-16电话号码中的连接符也统一用短划入符号选择特殊符号中的短划线或者在英文输入法中减号键输入浪纹用于表示数量的范围13中文输入法中通过键盘 shift 输入长横常用于地名之间北京天津插入符号选择特殊符号中的长划线连续输入两次书名号书名号的形式为双书名号书名篇名报纸名刊物名等用书名号标示英文手册名称不需要书名号标示例如TELLIN-SMAP业务管理接入点 用户手册书名号中的手名片名等全称不能使用简称常见错误具体操作请参见S8016 安装手册建议修改具体操作请参见Quidway S8016 路由交换机 安装手册破折号破折号的形式为占两个字的位置技术文献中破折号常用于表示注释和说明部分之前例如一种有机地结合了高速大容量光纤传输技术和智能网络技术的新体制光同步传送网应运而生 说明例如中文写作规范中要求句号常用于陈述句末尾的停顿在产品资料中常用于简单句和复合句的结尾表示句子意思已完整列举的省略用省略号标明例如在广州的花市上牡丹菊花杜鹃梅花水仙山茶春秋冬三季的鲜花都挤在一起了标点符号使用说明句号问号叹号逗号顿号分号和冒号不出现在一行之首引号括号书名号的前一半不出现在一行之末后一半不出现在一行之首破折号和省略号都占两个字的位置中间不能断开单位符号单位词头词头是指构成倍数单位十进制或者分数单位的符号例如G吉k千等常用词头表词头名称因数符号说明吉109G无兆106M无千103210k小写k国内资料不区分103和210统一为小写k适用于中文产品手册210K大写K例如KB在海外资料中可以根据最新IECInternational Electrotechnical Commission标准和其他厂商一致使用大写K适用于海外产品手册厘10-2c无毫10-3m无微10-6无纳诺10-9n无皮可10-12p无飞母托10-15f无国际单位国际符号表量的名称名称符号说明长度米m1国际海里1852m厘米cm无毫米mm无质量克g无吨t1t 103kg原子质量单位u1u 1660540 10-27kg时间天d无小时h无分min无秒s无电压伏特VV大写电流安培A无电阻欧姆常见正文中有15欧姆的写法建议修改为15电容法拉F无功率辐射能通量瓦特WW大写磁通量韦伯Wb无自感互感亨利H无磁极化强度特斯拉T无直流电导西门子S无电阻率欧姆米m无物质的量摩尔mol无能电子伏eV无温度摄氏度插入特殊符号菜单项选择单位符号页签华氏度热力学温度开尔文 K无压力压强帕斯卡Pa无体积立方米m3无面积平方米m2无速度米秒ms无加速度ms2常用于机械应力中的正弦振动等旋转速度转每分rmin无平面角度无角分无角秒无力牛顿N1N 1kg力矩牛顿米Nm无表面张力牛顿每米Nm无光通量流明lm无光照度勒克斯lx无放射性活度贝克勒尔Bq无发光强度坎德拉cd无频率赫兹HzH大写z小写错误写法HZhz能量热量焦耳J1J 1Nm电荷量库仑C1C 1As介电常数电容率法拉米Fm无级差分贝dBd小写B大写错误写法DBDbdb组合单位的书写注意事项组合单位的倍数单位一般只用一个词头词头置于组合单位中的第一个单位前例如力矩的单位kNm不宜写成Nkm摩尔热力学单位kJmol不宜写成Jmmol中文书写组合单位的名称时不加乘除或其他符号例如力矩的单位为Nm其名称为牛顿米而不是牛顿米牛顿-米不能在组合单位中同时使用中文符号和单位符号例如速度的单位不能写成km小时而应该是kmh词头不得孤立使用例如B信道速率64kbits 不能写为64k不得使用重叠的词头用单位符号代替汉字名称例如mm代替毫米常见计量单位的错误符号常见计量单位错误符号表量的名称单位名称错误或不恰当的符号正确的符号说明长度千米KMKMS千公尺km不符合国际规定和我国规定米 M公尺m不符合国际规定和我国规定厘米公分cm不符合国际规定和我国规定毫米mmMMmm不符合国际规定和我国规定微米Mmmm不符合国际规定和我国规定质量吨T公吨米制吨t不符合国际规定和我国规定千克公斤KGKGS KgKgm kilogkg不符合国际规定和我国规定克grgm公分g不符合国际规定和我国规定力重力牛顿nt牛顿N不符合国际规定和我国规定体积毫 升ccccmL不符合国际规定 升公升立升立L l 小写字母l为备用符号立方米立米立方cumm3不符合国际规定级差分贝dbdB贝来源于人名大写时间年yyra不符合国际规定小时hrh不符合国际规定和我国规定分min不符合国际规定和我国规定秒secs不符合国际规定和我国规定面积平方公里sqKmkm2不符合国际规定平方米平米m2不符合国际规定速度米每秒秒米ms不符合我国规定温度开尔文oK开氏度绝对度degK国际上有新规定摄氏度o度百分度oC不符合书写规则频率赫兹周周秒赫芝Hz不符合国际规定和我国规定电流安培aampA不符合国际规定电荷量库仑CoulC不符合国际规定电阻千欧姆Kk不符合国际规定电容微法拉MfmFF不符合国际规定发光强度坎德拉烛光新烛光支光支cd不符合国际规定和我国规定旋转速度转每分rpmrmin不符合国际规定手册常用符号产品手册常见符号表量的名称名称符号备注话务量爱尔兰Erl无存储单位比特bit无字节byteB1B 8bit速率数字信号比特秒bits错误写法bsKbits建议尽量不用bps一本手册中不要出现两种速率单位直径直径符号念fai的第四声缺省的单位为mm常用于安装手册中例如在选定的墙壁上钻8个16的孔高度高度符号U1U 4445mm例如机柜总高度为9335mm21U长度英寸in1in 254mm例如常说的19英寸机柜指该类机柜内安装的插箱面板宽度为19英寸运算符号1常用运算符号 插入符号菜单项在字体下拉列表框中进行选择Arial英文输入法中在键盘直接键入输入方法半角Ctrl数字键盘的键同时也表示正负数运算符号2特殊运算符号 插入符号菜单项在字体下拉列表框中进行选择Math B例如机柜尺寸长宽高为100mm 30mm 20mm知识产权附号已注册请设置相应的符号为上标已申请注册商标请设置相应的符号为上标版权所有产品手册中常见到紧跟在单位符号后的缩略语例如相对湿度RHRelative Humidity交流ACAlternating Current直流DCDirect Current这种放在单位之后的英文缩写起到补充说明的作用一般都是对于某个物理量的进一步详细的说明表达方法通常是数值单位符号空格补充说明缩略语例如220V AC48V DC20 RH界面控件名称 界面Graphic User Interface窗口Window以视窗形式表现出来的操作界面都可以叫窗口例如显示Huawei IPD Portal窗口对话框Dialog Box对话框是一种特殊的窗口它提供了一种标准框架可以提供一系列选项供用户响应一个对话框可以包含文本Text控件Control和图标Icon主要特点是允许用户和系统进行交互通过输入参数值或单击按钮等方式例如显示确认文件删除的对话框 说明窗口可以看作一个容器窗口里可以按照需要添加很多控件如进度条编辑框等对话框提供交互功能不具备容器功能其内置控件基本是固定的提示框Alert Box提示框和对话框的区别是对话框提供多个按钮供用户选择操作响应而提示框没有和用户的交互操作例如显示删除文件出错的提示框网页Web Page页签Tab Page例如选择常规页签菜单Menu菜单Menu例如在工具菜单中进行操作子菜单Sub Menu快捷菜单Shortcut Menu例如在图标上单击鼠标右健弹出快捷菜单菜单项Menu Item例如选择工具字数统计菜单项例如将图象不透明处理菜单项设置为选中状态接入键Access Key快捷键Shortcut Key按钮Button按钮Button的种类很多常见有窗口中的功能按钮例如下面会介绍的 按钮 按钮等按钮也常常出现在网页中例如单击 按钮标准按钮Standard Button缺省按钮Default Button缺省按钮和标准按钮的区别是按钮中多了一个虚线框用户直接敲键盘回车键即实现单击该按钮的功能折叠按钮Disclosure Button折叠按钮又名扩展按钮例如单击 折叠按钮例如单击 折叠按钮单选按钮Radio Button例如在不显示隐藏的文件和文件夹和显示所有文件和文件夹前的两个选项按钮中进行选择还原按钮Restore Button关闭按钮Close Button最小化按钮Minimize Button最大化按钮imize Button前进后退按钮ForwardBackward Button向上向下按钮UpDown Arrow向左向右按钮LeftRight Arrow注键盘的上下箭头用PageUpPageDown表示命令按钮 Command Button 开始一个动作的长方形按钮用省略号结尾的命令按钮标签表示将打开另一个对话框执行该动作前需要更多信息组合框 Combination Box 列表框List Box例如在格式列表框中进行选择下拉列表框Drop-Down List Box例如在字体下拉列表框中进行选择复合框Combo Box例如在每页中的行数组合框中进行选择类似的控件还有下拉组合框Drop-down Combo Box文本框Text Box例如在文件名文本框中输入文件名复选框Check Box例如选中上标P前的复选框打上钩后表示选中表示选择字体的效果为上标区域框Frame例如可以在Basic Parameter Of Card区域框中设置如下三个参数Card NumberPasswordDiscount Rate微调输入框Spin Box带上下箭头的文本框用户点击箭头可在一套固定的值中进行选择用户还可以在框中键入一个有效值其他组件 Others 图标Icon导航树Navigation Tree链接Link例一单击进入审计表单链接例二在Unix系统中V20链接指向的路径是exporthomeiscc2sms超链接Hyperlink在万维网中超链接是网页的常用组成部分用于提供到其他网页或者本网页其他部分的链接6HTML网页中提到的超文本链接链接指的就是超链接手册中超链接链接的称谓要统一链接栏Link Bar标题栏Title Bar菜单栏Menu Bar例如菜单栏包括文件编辑等菜单项搜索条Search Box搜索栏Explorer Bar地址栏Address Bar状态栏Status Bar工具栏Tool Bar例如在工具栏中单击按钮进行计费数据维护快速启动栏Quick Launch Bar任务栏Task Bar滚动条Scroll Bar例如拖动滚动条垂直滚动条Vertical Scroll Bar水平滚动条Horizontal Scroll Bar滑动杆Slider进度条Progress Indicator例如显示如图所示的进度指示框附录资料开发研究管理部已签发规范摘要 说明rnd-apps中查找技术术语及缩略语解释原则摘自华为研发资函200231号技术术语及缩略语规则术语表Glossary缩略语表Abbreviations包含缩写和只取首字母的缩写词正文中第一次出现的缩略语必须进行解释第一次出现是指在一本手册的正文中第一次出现缩略语应包含如传输手册出现的SDH无线手册出现的GSM智能手册出现的SCP固网手册出现的PSTN需要提供缩略语表的资料技术手册操作手册维护手册设备