大家好!今天想和大家分享一个技术文档格式转换的小故事。
有个朋友在软件行业从事文档工作,她们的手册是用Markdown编写的,使用Facebook的Docsaurus框架,在线浏览很方便,但输出Word格式却很不方便,问我是否有什么好办法输出Word格式文档。
她们公司的项目团队在做项目的时候,需要根据客户的需求来提供文档。项目团队的人员经常找她们要Word版本的手册,这样他们好在此基础上根据项目的需要进行修改,来完成项目交付。
为了提供Word格式的手册,她们拷贝Markdown的内容,粘贴到Word中。这既重复、又没有技术含量,挺痛苦和无奈的。
我给他推荐了一个解决方案:轻量级DITA标准。这个可能有些朋友不太熟悉,我来简单地说说:
DITA是一个文档标准,在2000年左右由IBM公司发明,在2005年IBM将这个DITA捐献给了OASIS这个开放组织来负责规划和演进,目前这个标准在很多行业得到应用。使用这个标准编写的文档,能够很方便地输出HTML、PDF、Word等多种格式的文档。
在2017年,OASIS这个组织为了让更多的人使用DITA,他们在DITA的基础上提出了轻量级DITA标准。DITA1.3有150多个标签,很多标签一般情况下用不上,他们就去除了不常用的标签。在轻量级DITA中只留下48个常用的标签,同时把DITA中的一些高级功能去掉了,目的是让DITA更容易使用。
轻量级DITA还引入了一个重要的特性,就是支持使用Markdown格式编写手册。对于这个朋友提到的问题,我们可以将Markdown文件组织起来,然后就可以使用DITA的发布功能了。在内部,其实发布工具是将Markdown文件转换成DITA格式,这样Markdown格式的内容就能够接入到DITA体系中。利用DITA成熟的发布功能,就能输出期望的格式,这包括Word。
目前使用Markdown编写手册的公司不少,尤其是软件公司的文档,如果你也有发布Word格式的需求,可以试试上边的方法。