技术文档编辑之当下论域与本土革新研究.doc

1、技术文档编辑之当下论域与本土革新研究摘 要 尝试引入欧美国家规范化的 Technical Editor/Writer概念，并以中文“技术文档编辑”与之对应，通过对其工作对象、工作方法、服务范围等方面的分析和研究，使之在中文语境下拥有明确的、科学的概念，同时也阐明技术文档编辑的介入领域及其发展的必要性与重要性。 关键词 技术文档编辑 技术文档 本土化 内容管理 受控语言 中图分类号 G238 文献标识码 A 文章编号 1009-5853 （2014） 02-0082-04 “编辑”当然不难理解，但是在它前面加上“技术”这一定语，则骤然变得陌生而神秘了，甚至让人觉得有些故弄玄虚。在出版业相关刊物上

2、，不乏有关“技术编辑”的文章，探讨其在出版流程中所扮演的角色及应当承担的任务；如果在互联网上搜索一下，也不难发现众多“技术编辑”的招聘信息。 但遗憾的是，从这些文章或招聘启事来看，我们并不明白“技术编辑”究竟是什么，因为它被定义得太过宽泛。在图书出版行业内，存在两种看法：一是被认为运用各种制版软件（包括图形图像处理和排版）的技术人员；二是指科技图书的编辑。广播电视行业的音频、视频编辑被称为技术编辑，但一般还是使用更为精确的称谓。网络媒体中将网站或者网页制作人员视为技术编辑。西方国家的 Technical Editor/Writer，多出现在外资企业招聘启事上。国内尽管也使用“技术编辑”这一词汇

3、，但其概念、工作对象、受众等，却并没有明确的规范。对技术编辑的理解，似乎是一件见仁见智的事情，没有一个普遍的约定。也有不少作者在文章中谈及技术编辑，但并未给予其精确定义。 西方国家所使用的 Technical Editor/Writer，直译过来就是“技术编辑”或者“技术作者” ，早已经规范化。为了与国内现有的“技术编辑”相区别，避免概念与称谓上的混淆，笔者以为不妨称其为“技术文档编辑” 。本文所谓的“技术文档编辑”是指从事编辑活动的人，而非编辑活动本身。 笔者将不揣浅陋，对 Technical Editor/Writer作一些简单介绍，作为其本土化（Localization）尝试。如非必要，

4、下文将不使用其英文名称，而代之以“技术文档编辑” 。 1 概 述 首先要明确的是，技术文档编辑的工作对象是“技术文档（technical document） ”。所谓技术文档，是指描述某种技术成果的文档，诸如操作手册、装配说明书、培训材料、帮助文档或者白皮书等。这些文本无一例外地要求严格统一的语言风格和格式规范，其传达的信息原则上通过符号和编号系统呈现出清晰的结构形式和组织分类。 技术文档编辑的工作就是策划、制作、维护、更新技术文档。实际上，技术文档编辑即使在西方国家，也并不是一个为人所熟知的职业，因为企业常常将技术文档视为产品的一部分、提升效率或者是用来帮助与客户交流的工具，由于缺乏对技术文

5、档的了解，其编辑人员往往并不具备相应的工作能力和资格，编制的文档未必能够达到技术文档的标准。从另一个角度来说，尽管“技术文档编辑”这个词汇出现的时间并不长，但其行为在事实上早已存在，只不过本该由技术文档编辑完成的工作却通常由文案或工艺人员来实现。 2 职业描述 技术文档编辑通常并非为某问题的专家1，但能够使用专业技能来搜集、掌握和分析必要的信息，并以较为通俗的语言清楚地描述该问题，使之易于为受众理解并接受。从这个角度而言，将其视为制造者和接受者之间的中间人，应该是比较恰当的。 与早些时候有所不同，现在技术文档编辑的主要工作并不局限于编制技术文档，而更着重信息的统一管理。它需要按照企业有关计划，

6、针对不同受众做好相应的文档储备，比如沟通企业内部各部门或沟通产品的生产者和使用者。 技术文档编辑的活动应该包括以下部分： （1）编制技术文档的计划书 （2）对产品、受众的分析 （3）搜集并分类信息 （4）筛选并组织所占有的材料 （5）选择适当的载体（印刷、在线、光盘，等等） （6）对文档进行整体构思 （7）制作原稿 （8）内部试行并测试 （9）校对审核 （10）准备、开始和监控技术文档的制作 （11）更新与再加工 （12）技术文档的存档和管理 基本上来说，技术文档编辑与出版业内的编辑不同，并不属于文化产业，而是服务性行业。不过，在跨媒体出版（cross media publishing）和单源

7、出版（single source publishing）方面，技术文档编辑和出版业内编辑的工作产生了交叉，因为两者都需要采用内容管理（content management）的工作方法对信息进行处理。 3 工作方法 为编制一份技术文档，需要了解受众、目标和产品，这些是技术文档编辑应有的素质。除此之外，还需要掌握某些技能和工作方法。这里有一个例子。 国内某汽车公司的发动机为国外进口，但发动机零部件需在国内组装。为了保证装配各环节精确无误，除了相关人员指导外，还需要一份详细的装配说明书。该说明书需要实现以下要求：文本格式说明书图文并茂，由中英文编写，同时提供网络版、电子光盘版和纸质印刷版；装配动画附

8、中英文注释和电子光盘版；“在线帮助”要求在企业网站上给予反馈和联络的空间，并提供以上说明书及动画下载，中英文界面。 这些要求可以理解为一份简单的技术文档，下文将略述如何实现它，并借此介绍技术文档的编辑工作方法。 3.1 编制工具 简单的技术文档排版一般可以通过办公软件来完成，但对要求更高的技术文档而言，桌面排版软件（DTP Program）才是更好的选择，因为这些软件为文档的编制和排版、功能上的自动化以及与其他文档的对接提供了更多可能性。 必要时技术文档编辑还需使用计算机辅助设计程序（CAD Program） 、软件开发工具或者图形图像软件来加工技术文档或者为其作前期准备工作。这样的技术文档通

9、常是动态的，能与受众之间产生交互。 就前文所述例子而言，要采用排版软件编制装配说明书自然不难理解。而动画制作则需要通过计算机辅助设计程序模拟并制作发动机所有零部件的动画，细微到每一颗螺丝钉，再由 3D视频工具（比如 3D Toolkit）将其装配过程制作成视频，最后利用动画编辑软件（比如Adobe Acrobat 3D或者 Macromedia Flash）配合命令代码2制作出可操作的装配动画。最后，编写网页（Web-Programming）将文档和动画上传，通过电子邮件或其他在线交流工具实现双方交流。 3.2 信息处理 内容管理已经成为目前技术文档编辑最普遍的信息处理方法，用以使文档叙述结构

10、化、搭建模块化，并提高各组成单元重复使用的可能性。所谓内容管理，指用以支持和促进数字化信息生命周期的一系列行为、过程和帮助手段。这里的数字化信息，包括文本、图像、音频、视频等，通常被视为“内容” ，既可以作为文件单独加工，亦可作为统一的文件系统如网页（超文本）来呈现，或者是存在于结构化的数据库之中。 具体到操作上，就是 XML和 CMS3常常介入编辑活动。XML 不是用来表现或展示数据，而是用来说明数据是什么，以及携带数据信息。在XML文件里清楚地展现了将要发布的说明书的结构、模块以及所包含的数据，除文字外还有图片和视频，且这些数据并非混杂在一起，而是有层级的。 当然，技术文档最终要以恰当的形

11、式表现出来，这与选择的载体有关。可以为 XML文件编写不同的 XSL文件来设计表达形式。编写 XSL，事实上就是对 XML中各单元的样式进行设计，比如在纸质媒体上不可能出现视频，则在编写用于印刷的 XSL时忽略该单元即可。并且，如果需要对内容进行更改，那么并不需要逐一修正已经发布的各种形式的文档，而只需要修改 XML元数据即可，这样既避免因疏忽发生错漏，也保证了发布的各个版本之间的一致性4。 3.3 写作文档的受控语言 如前文所述，技术文档要求严格统一的语言风格和格式规范，如此文档中的各模块可以交由不同的技术编辑共同完成；或者产品升级更新后，原有文档中相对稳定的段落可以继续使用。换句话说，一篇

12、完整的技术文档可以由不同人员在不同时期来完成，这样既降低了编制成本，又方便了横向和纵向的技术交流。如果在行业内实现技术文档编制的标准化，对该行业而言未尝不是一个有力的技术支持。同时，行文严谨则文档呈现出正式庄重的语体色彩，产品更容易获得受众的认可和信赖，帮助建立良好可靠的企业形象；而通过符号和编号系统，文档结构更清晰、条理化、模块化，这大大提高了文档的易用性。 编制这种语言风格和格式规范严格统一的技术文档，需要通过受控语言来实现，它可以减少文本的歧义、多义和复杂性。所谓受控语言，应该说仍然属于自然语言范畴，它的特征一是使用特定的词汇表从而降低文档中出现的词汇数量；二是选择某些特定的语法从而固定

13、文档语句的语法形式。 使用受控语言通常出于两方面考虑：一是使文档简单易懂，尤其是对非母语的阅读者来说，二是便于翻译，特别是能为机器翻译（machine translation，MT）提供支持。 每种自然语言都有其语法规则，因此很难有放之四海而皆准的方法来规定受控语言的编写。尽管如此，德国学者乌韦（Uwe Muegge）还是开发了所谓 CLOUT规则5，指出应该如何编写受控语言，以便有效地降低大多数语言文本的多义性。 事实上，这些规则更适用于印欧语系，个别规则显然对汉语没有意义，比如有关冠词的规定，但观察这些规则能够很好地帮助我们理解受控语言，现简单列举如下。 规则 1：一个语句不应超过 25个

14、词语。 规则 2：一个语句应该只表述一个意思。 规则 3：表述相同的内容应该使用相同的语句。 规则 4：语句中的语法应该完整。 规则 5：语句应该使用简单的语法结构。 规则 6：语句应该采用主动语态。 规则 7：语句中需要重复名词应该直接重复，而不要使用代名词。 规则 8：语句中应该使用冠词来标记名词。 规则 9：语句中词语应该出自通用字典。 规则 10：语句中词语的书写应该规范6。 3.4 机器翻译（machine translation） 对于技术文档编辑而言，机器翻译是指三方面的工作内容：一是面向翻译的文档编写（translation-oriented authoring） ，编写技术文

15、档时应该遵循上述 10条规则，以便文档易于被自动翻译系统所识别；二是对机器翻译而来的文章进行再加工，就目前的自动翻译系统而言，人工干预还是一个必不可少的环节，自动翻译的文档一般来说还难以直接使用；三是使用自动翻译存储系统（translation memory system，TMS） 。应该说，使用自动翻译储存系统才是这一工作环节的核心。 当工作人员掌握了受控语言或者具有相当的外语能力，即可以完成面向翻译的文档编写和对机器翻译文章的再加工。但是，术语库的制作和管理、团队形式的联机协作和自动翻译系统的操作等，都有非常强的专业性，这就要求技术文档编辑必须有相关专业化、系统化的教育背景。前述例子中，说

16、明书要求用中英文编写，因此在编写环节就应该面向翻译，以加强机器翻译的可读性。已有很多企业采用机器翻译为客户提供产品和技术支持，比如说微软公司。 4 介入领域及发展前景 尽管目前技术文档编辑在中国几乎还没有起步，但美国早在二次大战时就已经有了技术写作（technical writing）这一专业。而汉诺威高等专业学院（Hochschule Hannover）也于 1990年在德国最早开设了这一专业。现在，欧美国家许多研究所、高等专科学院以及大学都提供相关的高等教育和继续教育，同时有专门的技术交流协会7规定了技术文档编辑明确的定义和工作方法，并组织研讨和交流，对其进行规范和引导。 在这个日益技术化

17、的世界，技术文档编辑的意义也日益重要，在应用工业领域如医药、机械制造、电子和软件开发等，这一工作已经是必不可少。而某些职业则与技术文档编辑出现了交叉，诸如公关、专业翻译、出版社技术编辑、报社专业记者等。 西方发达国家的几乎所有企业都有内部技术服务部门负责技术文档的编制工作，或者委托技术文档编制公司提供相应服务。相信随着中国企业的现代化与国际化水平越来越高，技术文档编辑这一工作也将在中国越来越受到重视。 注 释 1对企业而言可以是某产品，对政府部门而言可以为某项政策，等等。为便于叙述，下文提到技术文档编辑时均假定其为服务于企业。 2Adobe Acrobat 3D使用脚本语言（Script） ，

18、Macromedia 使用动作代码（Action Code） ，这些其实就是一些简单的编程语言，或者说最基本的软件开发工具，在 MS Office中所使用的宏（Macro）也与之相类似。 3内容管理系统（Content Management System，CMS） ，是指支持内容管理的一种或一套软件系统工具。国内的内容管理系统通常指网站的发布和管理系统，这个定义较为狭义，与本文所指并非同一。 4跨媒体出版和单源出版的操作流程也大致如此。 5CLOUT（Controlled Language Optimized for Uniform Translation） ，即一致性翻译的受控语言优化。 610 条规则为笔者所译，原文为德语。 7美国有 Society for Technical Communication （STC） ，德国有Gesellschaft fuer Technische Kommunikation （tekom） ，英国有Institute of Scientific and Technical Communicators （ISTC）等。