5. 同源开发的优势

事实上,前文已经部分阐明了同源开发的优势。这一章我们将详细地罗列这套方法论比较过去传统的线性文档开发有怎样的优势。

5.1. 更好的一致性

对于技术文档写作来说,一致性对于向软件和设备的用户有效传递指令至关重要。撰写独特的散文来描述重复性的任务是没有什么好处的。重要的是要保持一致的、可预测的风格,以及术语的一致使用。单一来源的编写有助于通过关注内容的重复使用来实现这一点。就像投影仪的例子一样,为什么要写两个不同版本的“打开您的投影仪”,而这些版本之间的区别可能就是型号名称和与该主题完全无关的灯泡亮度。写一次然后插入一个型号名称的变量显然是更合理的选择。根据发布的文档的版本,您的编写工具可以自动替换正确的型号名称。

5.2. 减少重复

重复已经写好的内容不仅会占用编辑环境的空间,而且如果一份拷贝在一个位置被修改,而另一个位置中没有,会带来发布不一致信息的风险。使用同源开发,给定的文本内容可以在一个位置进行管理,然后由创作工具自动将其依据不同文档中的使用情况自动修改,从而为作者节省大量的精力。   特别地,技术翻译项目的一个重要问题是避免对同一内容进行两次翻译。高质量的翻译公司已经有办法有效地处理重复的文本(通过翻译记忆和首选术语列表),但处理每一个重复的内容仍然需要成本。使用同源开发的作者可以避免这种情况,因为每个文本内容都是独一无二的。

5.3. 灵活的输出选项

单一来源的创作工具使作者能够以各种格式发布。例如,MadCap Flare允许自动发布到以下格式:

  • HTML5 Webhelp(PC和移动)

  • Eclipse帮助

  • 网站帮助

  • WebHelp Plus

  • PDF

  • XPS

  • Adobe Framemaker

  • MS Word

这真的只需要通过点击按钮即可轻松完成。这就是为什么同源开发软件也被称为多渠道发布软件的原因。例如,想象一个软件产品的帮助文档系统。作者可以自动创建一个可以在用户的电脑和移动设备上运行的版本,以及一个可以打印的PDF版本–所有这些都使用同一套源文件。作者不需要对他撰写的内容的提供多个副本来生成这些不同的格式。   同时,技术翻译机构或者人工智能可以使用相同源文件以更低的成本生成专业翻译版本。

5.4. 集中控制多个关键数据

通过在单一源环境中控制内容,可以保证全球标准的统一。如果所有技术文档写作都基于使用相同结构的同一套原始文件,作者就可以更有信心地将其发布为多种语言和多种格式版本,因为作者很清楚会得到什么样的结果。控制内容包括控制目标信息以及文件的外观。在10年或15年前,要做到这一点是很困难是很耗时的。现如今尽管仍然需要一定的工作量,但是整体的写作效率已经得到了大大提高。

5.5. 减少桌面出版费用

当使用同源开发时,创建的源项目将包含您对页面布局、标志位置、字体和各自风格的所有设计选择。大多数同源开发工具都利用了CSS(层叠样式表)技术的使用。CSS使整个文档环境的样式标准化,CSS甚至可以国际化,以便为特定的语言使用正确的字体(这对于逻辑语言,如中文和日文,是至关重要的)。通过集中控制设计策略,可以自动生成原始文档的外文翻译,而只需要很少的人力资源。传统的文档格式(MS Word、Framemaker、InDesign等)翻译通常需要劳动密集型的页面排版,其成本可能高达翻译文档成本的30%。当使用单一源码编辑时,这一成本将降至翻译成本的10%以下。

5.6. 一些小小的批评

同源开发也不是万灵药,有一些专家也对这种方法论持一定的批判态度。特别是在技术翻译领域,虽然同源开发已经在技术翻译中大量使用,但在索引方面存在错误的风险。两个词在英语中可能是同义词,但在另一种语言中可能不是同义词。在同源开发的文档中,索引将被自动翻译,这两个词将被渲染为同义词。这是因为它们在源语言中是同义词,而在目标语言中不是。这种错误可能对用户造成误解,应当在后期的文档测试环节进行单独的校准。

5.7. 实施同源开发的工具

一些最流行的同源开发工具包括MadCap Software的Flare、Adobe RoboHelp、Adobe Framemaker或Oxygen XML Editor。一旦开始构建项目,同源开发可以提高公司的出版能力,同时降低所有多渠道发布、翻译和通信的成本。

下一章将主要讲述如何进行同源开发。