结构化写作第2部分-在何处应用它及其重要性


2019-05-04 08:43:36

结构化写作第2部分-在何处应用它及其重要性

写作翻译

在我的结构化写作系列的第一部分中,我在高层次上解释了结构化写作的概念。结构化写作是一种专注于内容结构的写作方法。通过对内容应用规则,您可以强制使用结构来提高一致性。
在这篇博客文章中,我将讨论结构化写作在商业中的应用和描述它的好处。
何处应用以及为何重要_1
在哪里申请结构化写作
如果您生成大量具有许多相似性的内容,则可以使用结构化写作。例如,您可能有几个说明手册,其中有许多相同的操作或故障排除产品的过程。即使某些产品之间存在差异,结构化写作也可以处理。如果您生成了大量内容,则可能有多个作者在处理内容,并且他们可能不在同一办公室或国家/地区。如果没有一些写作结构,你最终可能会有很多变化,这可能导致写作,审查和翻译成本增加。
也许您经常创建类似类型的信息,例如小册子的产品描述,这是结构化写作的另一个好方案。您可以定义如何布置这些类型的内容,例如首先介绍产品,然后介绍一系列具有产品优势的项目符号。您还将定义内容的样式,如字体类型和颜色。通过以模板的形式预定义结构和样式,您的作者不需要考虑写作的这两大部分 - 他们可以只关注内容本身。
发布是内容开发的另一个方面。很可能你不再只为一个输出编写内容了。例如,您编写了一份产品修订说明,该说明已发布在您的网站上。然后将其纳入客户培训,并在博客文章,电子邮件营销活动和Facebook页面中进行宣传。Adobe FrameMaker 2015允许您发布多个输出,如PDF,HTML5,WebHelp等,使技术作者更容易重用内容。结构化内容在您编写一次并重复使用多次时提供一致性。
我们来看一个例子
假设您有三种产品变体:低层(产品A),中层(产品B)和高端(产品C)。这些产品适用于不同的受众,低端产品功能最少,高端产品功能最强。尽管存在差异,但它们共有的功能都以相同的方式工作。
使用我之前博客文章中的示例,假设所有产品都有关于如何验证包内容的说明。拥有相同的指令是有意义的,但如果您在具有多个编写器的非结构化环境中工作,您最终可能会有三个不同的相同内容变体,如下所示:
产品A.
产品B.
产品C.
如何验证包装内容
在开始之前验证包内容。
打开包装盒。
找到装箱单。
将内容与装箱单进行比较。
在开始之前验证包内容。
打开包装盒。
找到装箱单。
将内容与装箱单进行比较。
如何验证包装内容
打开包装盒,找到装箱单。确保内容匹配。
你可以看到虽然三条指令相似,但它们并不相同:
产品A包括标题后的介绍性句子。
产品B缺少标题。
产品C的说明采用段落形式,而不是编号步骤。
通过结构化写作,您可以创建规则来定义主题的各个部分,例如:
每条指令都需要一个标题。
步骤必须采用编号格式。
何处应用以及为何如此重要_2
优点
通过制定一些结构和指南,您可以确保这些说明完全相同。差异可能看起来很小,但在许多地方以三种不同方式制作内容的费用加起来。结构化内容的好处包括:
降低写作成本 - 一次写入内容。
降低审核人员成本 - 一次审核内容。
降低翻译成本 - 尽管措辞相似,但它有所不同,您将被收取相应的费用。如果您翻译成多种语言,则会增加成本。
由于内容一致,因此客户体验更加完善。
开始内容审核
从内容审核开始,看看切换到结构化创作方法是否有意义。我的同事在内容审核第2部分:技术内容审核中解释了如何执行此操作。
结论
如果您有许多类似的内容可以重复使用,或者您经常创建类似类型的信息,那么您可能需要考虑结构化写作,因为它有一些有价值的好处。我的下一篇博客文章将介绍结构化写作的必要工具。