跳转至

Alt text

Documentation Authoring, Managing and Publishing

选择一款优秀的文档创作和管理系统不仅仅可以保证文档风格规范的实施,更可以提高文档团队的工作效率,产出更为高品质的文档。

使用标记语言进行文档创作、管理和发布是非常通用的做法。标记语言创作的文档通常为纯文本文件,方便搜索、版本控制等方面的管理。并且,可以转换为不同的格式,例如在线阅读可以发布为HTML格式,打印、分享或者电子阅读可以发布PDF格式。

常用的几个文档创作标记语言有Docbook, AsciiDoc, reStructuredText, DITA和MarkDown。在AsciiDoc的官方网站有一个关于这几种标记语言的语法比较:https://asciidoc.org/#compare

DocBook

DocBook是一个国际标准,由结构信息标准化促进组织 OASIS维护。它的官方站点是http://www.docbook.org。DocBook是一个基于XML的标记语言,具有丰富、细腻的标签,几乎涵盖了创作一本“书籍”所需要的所有标签。

DocBook的标签丰富,而且几乎所有的标签都是采用了全单词拼写,非常容易理解。DocBook是一个优秀、完善的标记语言。

DocBook本身只是一个标准,自身不带任何书写或发布的工具。在将DocBook文件转换为HTML或者PDF文件时需要额外第三方软件。因为DocBook的标准性,在开源界有较为丰富的软件生态。如何使用DocBook创作文档,可以参考相关范例部分的"DocBook简要参考手册"。

另外,OpenSuse专门开发了一个针对DocBook的文档工具DAPS,也可以作为使用DocBook的一个参考。

AsciiDoc

AsciiDoc是一个轻量级的标记语言,目前由ECLIPSE维护。AsciiDoc有完善的维护团队、较为完整的工具链。它的官方站点是https://asciidoc.org/。 AsciiDoc的文档主要的转换工具是https://asciidoctor.org/。AsciiDoctor可以将AsciiDoc文件转换为HTML、PDF等文件。

reStructuredText

reStructuredText也属于一种轻量级的标记语言。Python的文档工具Sphinx-Doc使用的就是reStructuredText标记语言。使用Docutils或者Sphinx-Doc可以将reStructuredText文件转化为其他格式。

MarkDown

MarkDown是一种更为轻量级的标记语言,使用范围也非常广泛。由于标签少,所以如果想要创作较为大型的文档,就需要更多的扩展和相应的工具。两个不错的中文MarkDown网站 https://markdown.com.cn/https://www.markdown.cn/ ,可以作为MarkDown的参考。

MarkDown由于它的轻量级,所以它的应用范围似乎也更广,包括使用它来生成静态的网站页面、书写笔记等。docboon这个站点就是使用了MarkDown工具MKdocs来生成的。

DITA

Darwin Information Typing Architecture(DITA) 与DocBook类似,也是一个OASIS国际标准,而且同样也是基于XML体系结构。DITA由IBM贡献。 DITA也具有完善的创作和发布工具:https://www.dita-ot.org/