结构化写作第1部分-什么是结构化写作?


2019-05-04 08:46:13

结构化写作第1部分-什么是结构化写作?

翻译公司

结构化写作是一种创建适合更大内容策略的内容的方法。它有许多不同的组件,可以以多种不同的方式应用,也提供许多好处和挑战。由于这是一个广泛的主题,我将在一系列博客文章中分享我对结构化写作的看法,从结构化写作的高级方法开始,到结束使用DITA标准在XML中创作的概念。
结构化写作第1_1部分
结构化写作是一种专注于内容结构的写作方法,它包括评估和定义内容类型,围绕结构应用和创建规则,验证规则以及定义应用于内容的样式,以便您可以发布它。您可以将结构化书写应用于所有类型的内容,从将Microsoft Word中的简单字母写入Adobe FrameMaker中的400页技术说明手册,再到MadCap Flare中的产品在线帮助系统。您还可以将各种规则从标题级别的数量强加到列表中的选项数量。可能性是无止境。
在这一系列博客文章中,我将重点介绍使用结构化编写程序并遵循DITA标准在XML中编写的技术内容的结构化编写。我将在此处提供高级解释,并在随后的博客文章中提供详细信息。
评估和定义内容类型
结构化写作首先要仔细查看您生成的内容类型,以便定义和放置它们周围的结构。例如,如果您创建快速入门指南(QSG),则需要一些说明,可能还有客户服务电话号码等。如果您查看QSG集,很可能您会发现信息非常相似且可以标准化,至少在一定程度上。我建议您先进行内容审核。然后,您可以开始定义您拥有的内容类型,并考虑一般结构。最终,您希望创建可重用的,基于主题的内容块并将结构应用于其中。这是一套关于如何验证包内容的简单说明,在几个QSG中使用:
如何验证包装内容
打开包装盒。
找到装箱单。
将内容与装箱单进行比较。
结构化写作第1_3部分
围绕结构应用和创建规则
一旦你剔除了你的内容,你需要围绕它建立一些规则。基于结构的创作程序附带规则,或者您可以创建自己的规则。正如我之前提到的,您可以创建各种规则。例如,每个QSG都需要有一个介绍,两组任务和一个客户服务主题。您还可以创建更精细的规则,例如每个列表都需要包含三个项目。
以下是上一个示例的一些规则:
用标题介绍该主题。
编号说明。
验证规则
定义规则后,必须验证它们。在结构化编写程序中,很容易判断您编写的内容是否无效,因为该程序会给您一个错误。例如,这会给我一个错误:
(没有标题)
打开包装盒。
找到装箱单。
将内容与装箱单进行比较。
定义要应用于要发布的内容的样式
为了发布您的内容,您需要一个样式表来定义样式,因为格式与内容是分开的。你可以使用程序附带的那个,但你可能想调整它以使用你公司的样式,如字体,颜色和间距。在我们的示例中,我可以更改样式表以使输出看起来像这样:
如何验证包装内容
打开包装盒。
找到装箱单。
将内容与装箱单进行比较。
结论
结构化写作包含许多不同的组件,我在这里高级解释。在未来的博客文章中,我将开始深入研究这些组件。在下一篇博客文章中,我将讨论您可能希望应用结构化写作的哪些方面以及一些好处。