结构化写作第4部分-使用DITA创建重用内容


2018-11-08 08:52:25

在我之前关于结构化写作的博客文章中 ,我谈到了用XML创作内容所需的工具。在接下来的几篇博客文章中,我将深入探讨使用DITA标准从作者的角度看结构化写作的更多细节。让我们首先看看如何处理内容重用的写作以及DITA架构如何适应。

创建重用内容


结构化写作第4部分 - 使用DITA创建重用内容 -  1

使用XML创作是一种以结构化,独立,无格式的方式创建内容的方法,以便您可以在多个位置重用内容。XML是一种像HTML一样的标记语言。您可以根据内容在其他地方使用的位置以及内容的类型(例如产品介绍段落或参考表),将该主题分解为有意义的内容块,而不是考虑撰写有关主题的章节。您甚至可以将其更细化,例如特定指令或产品名称。您还需要考虑该内容是否已存在,是否存在但需要修改或是否需要创建。您希望将内容分解为尽可能多的可重用部分,因为它有意义并以一般方式编写内容,使用您的书写标准(参见下面的DITA部分)和XML创作程序添加细节。然后,将所有XML文件添加到一起,创建主题并发布它们。您可能拥有许多较小的文件,而不是为您的文档创建一个文件。

右边的图形描绘了重用的概念。您有六个独立的主题。然后,您可以使用主题1,2和3来编译PDF和Web输出。您拉相同的主题1和3,然后添加6以创建不同的PDF和Web输出。您可以用一种有意义的方式编写一次,并在多个输出中重用内容。这是一种非常有效且经济有效的写作方式。

从一开始就对结构的思考


结构化写作第4部分 - 使用DITA创建重用内容 -  2

使用DITA以XML格式创作确实需要改变您对内容的看法。您需要花更多时间在前面思考结构,内容存在以及内容是否可以重用。有时它需要您在实际进入内容后更改结构。它不像从Microsoft Word这样的空白文档开始,您可以在其中开始输入。但是,您最终将结构应用于Word中的所有类型的内容 - 它只是与XML的不同工作顺序。此外,如果样式匹配,Word和已发布的XML内容的输出应该看起来相同。

结构化写作第4部分-使用DITA创建重用内容

使用DITA作为写作架构


DITA(达尔文信息类型化架构)是一种开放式架构,您可以应用它来构建您的内容。DITA是技术写作领域中最常用的标准。DITA标准定义了各种信息类型,最常见的是任务, 概念和 参考的主题 。许多技术信息都适合这三种信息类型,但是还有很多其他类型的元素,您还可以创建适合您内容的专业化。

的 最新标准DITA是1.3,它包括增强和用于不同的元件额外的支撑。DITA由OASIS DITA技术委员会管理, DITA XML.org在线社区是了解更多信息的好地方。XML创作程序内置了DITA结构以及验证工具,因此您始终可以尝试一些基本元素。

结论

使用DITA以XML格式创建内容是一种使您能够编写一次并在多个输出中重复使用内容的方法,这可以节省写入时间并降低翻译成本。在本系列的下一篇博客文章中,我将讨论使用DITA元素创建内容。