结构化写作的好处：省去排版工作并让文档风格一致

结构化写作的好处：省去排版工作并让文档风格一致

引用

CSDN

1.

https://blog.csdn.net/xmlidea/article/details/140788185

结构化写作是一种标准化的文档编写方法，它通过预定义的规则和软件支持，帮助文档工程师省去繁琐的排版工作，同时确保团队输出的文档风格一致。本文将详细介绍结构化写作的核心思想及其带来的好处。

用Word写文档常见的排版问题

在使用Word等工具编写文档时，我们常常会遇到各种排版问题，这些问题不仅耗费时间，还可能导致文档风格不一致。常见的问题包括：

1. 使用空格定位
2. 手动设置复杂格式
3. 手动输入标题编号
4. 图片显示不全
5. 字幕和数字间距过大
6. 英文、数字与中文之间的空隙
7. 关闭超级链接
8. 自动编号功能
9. ...

常用的解决办法

遇到这些排版问题，我们通常会采取以下几种解决办法：

1. 上网搜索，看看有没有人碰到这些问题并分享了解决的办法
2. 阅读Word排版相关书籍，在上边寻求答案

然而，这些方法可能会带来新的问题：

1. 文档工程师需要花费大量的时间学习排版和进行文档排版
2. 不同的人对同一个问题解决方法不一样，造成文档风格不一致

结构化写作的思路

结构化写作是编写技术文档的一种标准化方法，其中内容由预定义的规则控制。有相关的国际标准，比如：DITA。文档工程师不关心样式或格式，而是根据内容的语义表示来标记内容。

用大白话讲，它有这几个意思：

首先，预先定义了文档遵循的规则，并且使用软件来保证每个人写的内容都符合这个规则

比如：写一封信就按照信的规则有称谓、信件内容、落款组成。
再比如：写一本书则由书名、作者、序言、章节、附录组成。

传统是使用文档模板来辅助人们按照一定的规则写作，不过它不是强制的，也无法检查内容是否符合某个规则。结构化写作中，软件按照规则来检查写好的文档。如果不符合规则，它就会提示哪里违反了规则，违反了什么规则。

其次，写作的时候只需要关心内容，不需要关心格式

MS Word的思想是所见即所得(WYSIWYG)，这也是它被广泛接受的原因。同时它存在的问题就如本文第二部分所述，就是有很多排版工作并且造成文档风格不一致。

结构化写作的思想和Word不同，结构化写作中内容和样式（或者叫做视觉效果）是分开的。写作时不用关心输出是怎样的，也不用进行排版，只专心于内容创作本身。

最后，文档的格式由样式模板确定，将内容与样式模板合成就能得到最终的输出物

下边是一些样式的例子：

• 输出页面多大
• 页眉多高，左边显示公司logo还是右边显示公司logo
• 页脚多高，页码是居中还是靠右
• 一级标题是几号字、左对齐还是居中、上边距下边距是多少
• 图的标题是在图上方还是下方；是“图 3 - XXXX”这种风格还是“图 2-3 XXXX”这种风格？

在结构化写作中，样式被放到样式文件中进行定义。所有人都使用同样的样式文件，这样能得到风格一致的输出物（PDF）。样式文件是针对各种情形提供统一的格式化方案，而不是针对每一个文件的每一处进行特殊处理，这就能保证输出统一风格的文档。

样式文件可以让有计算机软件背景的同事编写或者找专业的结构化文档工具和服务供应商来编写。

所以，结构化写作能够为文档工程师省去文档排版工作，同时保证团队输出的文档风格一致。