产品手册中文写作规范

《产品手册中文写作规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、产品手册中文写作规范DKBA华为技术有限公司内部技术规范DKBA1313－200312产品手册中文写作规范2004年03月15日发布2004年03月15日实施华为技术有限公司HuaweiTechnologiesCoLtd版权所有侵权必究Allrightsreserved修订声明本规范拟制与解释部门资料开发研究管理部本规范的相关系列规范或文件资料开发研究管理部签发的有关文件相关国际规范或文件一致性本规范符合下列国家标准国家标准GB03100-1993国际单位制及其应用国家标准GB03101-1993有关量

2、单位和符号的一般原则国家标准GBT15834-1995标点符号用法替代或作废的其它规范或文件无相关规范或文件的相互关系当在本规范发布之前由资料开发研究管理部签发的有关文件与本规范不一致时以本规范为准本规范版本升级更改主要内容第一版本无升级内容本规范主要起草专家资料开发研究管理部钱为民0220马明6669梁明琳25643本规范主要评审专家韩献光8725王永平9826毛咏梅15847杨健28082李顺华29118李天彬20058陶瑛15826宋联昌9528傅湘辉10592李少清0648彭新灿10264王艳英

3、19966本规范历次修订情况规范号DocNo主要起草专家主要评审专家DKBA1313－200312钱为民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说明和注意112

4、10内容引用12com同手册同文档时的引用12com相同手册不同文档间的引用13com不同手册间的引用13211缩略语14212术语15213数及数量16com基本规则16com多位整数与小数16com数字范围16com数值的倍数16com极限数值17com时间18com物理量18com非物理量18com代号代码和序号19214举例19com电话号码19com人称19com地名19com数据举例20comIP地址20215常用语213中文标点符号2231句号2232逗号2233顿号2334分号2335冒

5、号2336引号2437括号2538连接号2539书名号26310破折号26311省略号27312标点符号使用说明274单位符号2841单位词头2842国际单位2843常见计量单位的错误符号3144手册常用符号325界面控件名称3451界面GraphicUserInterface3452菜单Menu3753按钮Button4054组合框CombinationBox4355其他组件Others466附录资料开发研究管理部已签发规范摘要5161技术术语及缩略语解释原则5162商标使用管理规定5263环境保护声

6、明5364资料总称规定5365知识产权概念5466手册命名和资料版本编码规则557参考文献56表目录表1标题序列编排表6表2注意说明类标志使用说明表12表3极限数值基本用语及涵义表17表4连接号说明表26表5常用词头表28表6国际符号表28表7常见计量单位错误符号表31表8产品手册常见符号表32产品手册中文写作规范范围Scope本规范规定了产品手册的中文写作风格本规范适用于产品手册开发参考文档信息开发参考产品线开发人员参与手册写作前的引导培训检视评审测评过程中争议问题的裁决也可供联机帮助等产品资料开发参

7、考简介Briefintroduction本技术规范参考了语言规范和通信行业规范的相关内容结合产品手册的开发实践编制而成对写作过程中容易出现问题的写作要点进行了统一定义规定了产品手册的中文写作风格关键词Keywords样式标点符号单位符号界面控件标题项目列表段落缩略语术语引用文件下列文件中的条款通过本规范的引用而成为本规范的条款凡是注日期的引用文件其随后所有的修改单不包括勘误的内容或修订版均不适用于本规范然而鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本凡是不注日期的引用文件其最新版本适用于

8、本规范序号No文件编号DocNo文件名称DocTitle12术语和定义TermDefinition缩略语Abbreviations英文全名Fullspelling中文解释Chineseexplanation产品手册中文写作规范序言目的为了提高资料开发工程师写作技能提高整体写作职业化水平资料开发研究管理部制定了统一的《产品手册中文写作规范》应用范围资料开发工程师写作参考产品线开发人员参与手册写作前的引导培训检视评审测评过程中争议问题的裁决也可