大家好!今天想和大家分享一個技術文檔格式轉換的小故事。
有個朋友在軟件行業從事文檔工作,她們的手冊是用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格式的需求,可以試試上邊的方法。