“注重实际,摒弃教条主义”── DITA和 CCMS 最佳实践示例

DITA(达尔文信息分类架构)是一种基于 XML 且独立于制造商的常用信息架构,尤其适合用于以主题为导向的文档编写。很多创作工具对基于 DITA 的信息创建都提供了广泛的支持。此外,DITA Open Toolkit(DITA-OT)还提供有将 DITA 内容发布成各种输出格式的架构。

“组件内容管理”(CCMS)遵循的是类似的目标:在将文档模块化处理成可重复使用的模块之后,可以达到节约成本的效果。因为各主题可以重复使用,包括在不同的语境下重复使用,并且翻译成本也降低了。过去,常用的 CCMS 解决方案与 DITA 的发展在很大程度上是彼此独立的。DITA 架构着眼于基于文件的文档和主题存储。它的焦点在于文档。它通过文件名和 ID 实现与 HTML 类似的引用技术。用 DITA 可以快速地在文件系统中启动带有相应支持功能的编辑器。

同时,成熟的 CCMS 产品也具有了管理非常大量文档和模块的技术,这些文档和模块的数据量可达太字节(Terabyte)。它们能通过导航和搜索实现对话题的迅速访问,并且能将模块之间的关系保持恒定,无论这些模块的保存路径如何。

在 CCMS 项目中采用 DITA 会产生矛盾。一方面,使用 DITA 将可利用兴盛发展的开放式标准的优点,但同时该标准的特点却经常与 CCMS 系统提供商的解决方案重合。因此,让 DITA 与内容管理系统共生是比较有意义的:DITA 的方案如何成功与 CCMS 的方案关联起来,以实现具体的项目?

下面我们将根据经验,说明三个典型的场景。

场景 1:用有限的 DITA 调整创建技术文档

项目对象是,创建一个用于制作维修说明书的系统。客户希望在 CCMS 的基础上采用 DITA。通过对 DITA 的特性进行选择限制并且使用 CCMS 的基本功能,实现了二者的共存,尤其是对写作者来说,这样处理后的系统比较容易使用:

  • 对 DTD 进行与 DITA 适应的专业化处理
  • CCMS 的链接管理,包括规则控制的链接
  • 不用 Open Toolkit 进行快速的 HTML 和 PDF 发布 216 tekom 年会 2015 智能信息³
  • 副主题层面上无 DITA“conref”机制的可重复使用的模块(警告和错误说明)
  • 通过 CCMS 进行内容处理

可将这种方法称为“CMS 第一方法”。在可能且合理的情况下,优先使用 CCMS 的现有特征。只使用真正所需的 DITA 方案。

场景 2:知识管理:无文档发布

一家世界性的企业采用一个旧的系统来运行其知识管理解决方案,文档都未经结构化处理地以该企业特有的格式保存在该系统中。

这些文档既会发布到企业内网中,也会发布到自家的客户门户网站,发布成不同的产品。该企业想替换这个旧系统,一方面是为了强制推行统一的结构和格式,另一方面是为了在发布方面具有更大的自由度:

  • 将文档映射成主题(低专业化程度)
  • 不使用映射(Map)
  • 对主题进行处理、发布并彼此链接
  • 通过 DITA 结构(xref、image、link)进行链接,通过 CCMS 进行管理
  • 通过 CCMS 元数据中的分类法进行分类
  • 无 DITA-OT 的发布轨道,但有用于调出新文章的网页服务,此外还有 RSS

场景 2 显示,即使是在主题层面上使用 DITA 也可以是富有成效的。发布渠道由 CCMS 中的元数据和分类法进行控制。即使没有映射(Map),整个数据库内的链接也会被消除。

场景 3:用完全的 DITA 支持功能创建技术文档

一家国际运营的机械制造商希望用 DITA 创建技术文档并用多种语言发布。在执行 CCMS 之前,已利用 DITA-1.2 特征开发出内容战略了。引入 CCMS 是为了不用切割使用 DITA 的特征。

  • 广泛地使用 DITA-1.2 特征,其中包括 conref、keyref、conkeyref、subject schemes、 ditaval
  • 通过带有第三方提供商插件的 DITA-OT 2.0 进行发布
  • 规定:集成 oXygen XML Author,因其具有良好的 DITA 支持性

在这个“DITA 第一”方法中,方案完全是建立在 DITA 的特征库上的。然后,CCMS 就作为这样开发出来的方案的执行基础。通过配置,以低成本准备好 CCMS,用于所需的 DITA 要求。将 DITA-OT 集成到 CCMS 后,就可以使用第三方提供商的插件进行发布。链接管理由 CCMS 的链接系统提供支持。在进行 DITA 处理之前具备与 DITA 匹配的链接属性(“href”)。

总结

预设的场景证明,CCMS 与 DITA 是能很好地协调的。在这方面并非只有一种最佳的实施方法。更多地是必须让项目利益处于核心地位,才能根据要求低成本地满足具体的要求。使用内容管理系统,基于文件的 DITA 方案多了如果没有这些系统就无法提供的管理和控制功能。

将 DITA 与 CCMS 进行组合之后,可以在很大程度上像使用滑动控制器那样,设置哪些方案要用 DITA 或者 CCMS 固有的工具来实现。在此应重视对写作者来说的可用性。