How to make a high quality document ?

• 对于上百页、千页甚至万页的文档该如何编辑、排版、管理和发布？
• 用什么样的样式展示不同的文档元素？如列表、脚注、数学公式或程序代码等。
• 如何保证这些文档元素在对外发布的文档中具有完全一致的显示效果？
• 如何完成多人协作书写，又同时保证样式的完全一致？
• ... ...

创作和发行高品质的文档，除了保证内容的优质之外，以上的问题值得探讨。

高品质的文档不仅仅是良好的精神风貌和企业文化的体现，更是专业能力和业务素养的彰显。

采用合适的文档风格规范和文档创作发行工具，是持续产出风格统一、高品质文档的保障。

文档风格规范

文档风格规范是创作文档的一些要求，主要包括文档采用的排版样式、用语规范、文档元素种类等。保证文档风格的统一，能够保证文档对外的输出保持一致的形象。同时，可以提高文档的可读性和传播性，给读者带来舒适地阅读体验。所以有一份属于自己的文档风格规范（Documentation Style Guide）是非常必要的。

文档标记语言及工具

合适的文档标记语言及相关的工具集不仅可以保障文档风格规范的实施，而且可以提高文档创作、管理和发行方面的效率和质量。

从团队角度来看，有了合适的工具集，创作人员能够从繁琐的排版、样式调整的工作中解放出来，把精力集中在文档内容的创作上。真正实现内容和样式的分离。

一套完备的文档创作套件包括：标记语言、工具集、样式表。为了方便管理，也会增加版本管理和权限管理工具。

• 标记语言用来完成文档的写作。将文档用标记把文字组织在一起。
• 工具集根据相应的样式表将创作好的源文件转换为不同格式的文件，例如在线阅读的HTML文件和用于打印的PDF文件。
• 样式表是根据文档风格规范制定的样式。它不仅仅要保证发布的文档风格统一，从美学角度看，一份合格的样式表还要让文档看上去赏心悦目。

相关范例

在相关范例部分，我们提供了一些使用DocBook标记语言创作的一些文档，并将其发布为HTML和PDF格式。其中，在“DocBook简要参考⼿册”中，介绍了如何使用DocBook标记语言及相关工具进行文档创作。