新知一下
海量新知
6 0 8 4 0 9 8

您的结构化写作工具排版功能强吗——如何避开结构化的坑

技术传播李琳 | 技术传播领域业务顾问和技术专家 2021/11/25 15:38

在公众号早期的文章里,有一篇专门讨论DITA实施方法论,叫《 他们做过以后都说DITA没价值,为什么 》。该文分享和转载都不少,可见大家都担心,DITA有可能起不到应有的效果,反而掉进“坑”里。

但这篇文章并没有讨论,为什么要采用DITA。很多时候,“上进心”就是答案——我想写好文档,我想引入先进的方法和工具。

时间过去这么久,DITA或结构化,不仅没过时,还越来越时髦了。现在不只是技术文档领域要凸显结构化的必要性,连营销资料、研发文档等等领域都在积极推进结构化。有时对方会在第一次见面时坚定的说,我们一定要实现结构化。

但我还要问:为什么要结构化?

大概率我会得到这样的回答:

  1.  我们需要更专业的方法和工具(适用于专职文档团队);

  2.  我们有在线协同的需求(适用于无专职文档人员,但有大量技术文档需要管理的团队);

  3.  我们听说友商都是这么干的;

  4.  我听专家是这么说的,不结构化怎么智能化呢?

以上固然都是好的出发点,但对选择有针对性的解决方案来说,对问题分析得还不够深入。

反过来说,结构化能解决什么问题呢?

01

什么是结构化写作

Structured writing is an approach to writing that focuses on the structure of content and it includes evaluating and defining types of content, applying and creating rules around the structure, validating the rules and defining styles to apply to the content so you can publish it.

结构化写作关注的是“内容的结构”,包括内容分类,制定和应用内容结构规则。

那什么是结构呢?对一篇文档而言,目录大纲算不算文档结构?当然算,但内容结构要比文档结构更详细。也就是说,结构化细化到内部结构,包括字词句的定义。

举个DITA Topic的例子:

新知达人, 您的结构化写作工具排版功能强吗——如何避开结构化的坑

Task的结构定义了如何描写任务:先写标题,然后是前提条件、背景信息、步骤,最后是结果、举例等。

在步骤中,又定义了先写动作,再写补充信息,可以添加步骤的可选项。

每个Task都有丰富且一致的结构,有两个好处:

  1. 结构更明确。类似模板的作用,又比word模板的约束性更高;

  2. 对结构的描述更具体,有利于计算机识别,比如可以自动累加步骤、去掉重复的步骤、计算步骤的复杂程度等等。

02

结构化解决什么问题

  1. 规范性问题。当内容结构做出清晰具体的定义时,每个写作的人都必须遵从这个结构,使得整个组织的写作规范得到落实;

  2. 提高效率和质量。通过内容的同源管理,可以有效减少重复拷贝粘贴带来的工作量和版本错误。

  3. 减少排版时间。写作的目的是输出有价值的信息,而不是排版。结构化不再关注排版,由程序专门处理。

  4. 人机对话问题。结构化为智能化打下了基础,提供了计算机系统自动应用的技术基础,比如问答机器人、IoT自动诊断等等。以往这些内容都需要二次处理,有了结构化,软件可以自动分析内容。

03

结构化的难点和问题

说到底,结构化是不是最佳方式?特别是DITA,是否最佳选择?

先说一个结构化带来的“问题”,就是所见不是所得。

What you see is not what you get; what you see is only one of the options.

这是坏事吗?当然不是,结构化使得写作者更聚焦内容,不需要排版,是更高效的方式。程序可以自动把内容发布成PDF、网页、多媒体等等格式。

但如果你写作的目的就是为了出一本排版美妙的书,且排版的样式丰富多变,那脱离了所见即所得,会引起不适应。

再有就是有人喜欢连贯叙事。而DITA的模块化要点,是使得内容模块独立完整,看一页就能解决一个问题,并不需要“接下来”、“上一章介绍了”这样的文字。

但如果你觉得写的不连贯了,读者会不习惯,在DITA演进的过程中也有妥协,可以写一些“承上启下” 内容,专用于写“一本书”。

以上两点,比起对内容结构设计,都还是小问题。最主要的问题是,你打算采用结构化了,但你对内容结构有充分分析吗?失去对结构的分析和设计,结构化容易流于形式。看起来结构化了,但没有感受到结构化的作用,那可能需要重新审视结构设计和内容分类。

04

总结

  1.  结构化是大势所趋,但不是万金油;

  2.  结构化写作工具,着重于内容结构的管理,不是排版工具;

  3.  结构化的基础,是对结构本身进行分析和定义,这就是所谓信息架构师的工作职责。

更多“写作”相关内容

更多“写作”相关内容

新知精选

更多新知精选