DITA Reuse的设计和管理

发布时间 2023-09-12 08:55:04作者: 蹇爱黄

1.Topic划分

以Topic为主要重用对象,就需要将整本手册切分为若干个Topic。第一次拆分时往往会沿用以前的章节划分,把一个小节,自然转换成一个Topic。

把所有章节填入表格,进行初次审阅:

  • 该小节是否完整回答了一个问题?是否包含了该问题以外的内容?

  • 该小节是否可以归为一个信息分类,如Concept、Task或Reference?

2.判断是否Topic是否覆盖所有内容

根据Topic的独立完整性要求,对小节的标题和类型进行调整,可以得到第一版的Topic列表。请回答一个问题:这个列表包含了全部的Topic吗?回答是:不知道。
可从两个方面:

  • 以上Topic是否覆盖了全部的用户场景?

  • 以上Topic是否包含了全部的产品特性?
    此方法为"信息双向分类"法,一个方向是信息应用的场景,表示为信息类型如:原理描述、接口说明、安装步骤、调试步骤等;
    另一个方向就是产品特性,表示为产品特性树或产品结构树。

3.变更管理

把文件夹复制一份,"重用"了全部的topic,但违背了内容重用的目的:信息同源。
另一方面,技术内容的全生命周期维护需求也越来越高了。换句话说,一本手册交付给用户以后,如果该用户的设备出现了维护或升级,是否还能够同步更新该用户的手册?很显然,互联网时代的用户对此有着越来越高的预期。

因此,内容交付的变更管理,应该从内容设计之初就进行规划。

  • 每种粒度的内容都要建立唯一的编码机制。不管是手册,还是topic、被管理重用的段落、术语、都要有唯一的ID,以便于版本识别。

  • 不同语言之间,要建立同一模板的关联关系。这样一个Topic翻译之后不需要整个重复翻译,变更时只需要再次翻译有更改的Topic。

  • 要建立发布分基线管理。每一本交付的手册,要记录当时的发布结果,不只是发布的PDF或网页,是当时的版本。

  • 建立变更追溯关系。每次考虑变更同步时,不仅要考虑Topic本身,还要兼顾改Topic关联的其他内容,如图、引用的段落或短语、指向其他的Topic,和引用了该Topic的其他内容。

内容重用设计是基于用户场景分析,围绕产品结构或功能树,综合考虑配置和变更管理的一项工作。要提高设计的合理性,就必须不断验证,根据验证的结果不断调整。