在早期,技术文档写作方式更其他文档没什么区别,都是线性的写作方式,一般一个产品对应一本文档,随着科技行业的日益发展,技术文档写作需求越来越多,一个产品往往有多个系列,像同一款汽车,有高中低三种配置,他们大部分是相同,只有少部分不同,如果按照线性的写作方式,要写三回,当然有人会说肯定没这么傻,写三回,肯定 and paste,这种方式同样带来问题,就是如果修改会至少要改三个地方,常常容易出错。
针对这种问题,模块化的写作方式应运而生,DITA就是其中的佼佼者。DITA(Darwin Information Typing Architecture)是一种基于XML语言和信息分类的资料开发方法。利用DITA的资料开发方法,可以很好的解决同源和重用问题。
DITA最早有IBM提出,现今已经标准化,具体可以参见 https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita
目前市场上用的最多的DITA写作工具就是 Arbortext 了,基于XML语言,写作与样式分离。
使用DITA的方法开发文档的流程一般式这样:
从上图我们可以很直观的看出Topic可以被不同的Map引用,从而做到同源和重用,而Topic不决定发布件的格式,能够做到内容与样式分离。
InfoMapping是一个用于 分析、组织和表达 信息的 原则、技术和标准的集合 。 DITA是一种基于XML的文档开发方法。 个人理解DITA是资料工程方法,是术,InfoMapping是信息理论,是道。两者结合起来,就是技术文档写作的理论基石。