1

我一直負責構建文檔系統/平臺。需要建議 - 開發靈活的文檔系統,重點關注本地化

這裏的主要要求的簡短列表:

  • 輕鬆本地化:這將需要支持十幾語言出了大門。 (非技術人員添加/更新翻譯的能力將是一個很大的優勢,儘管不是100%的要求)

  • 輸出格式的靈活性:在最低限度,我需要輸出文檔(作爲整個或選定的塊)作爲PDF和HTML。 Windows幫助文件等原生格式的獎勵點數。

  • 通過直觀的用戶界面(理想情況下,網絡)進行管理和部署。

我想知道如果你們大家知道有支持這種類型的東西的任何系統已經?我並不反對從頭開始寫這篇文章,但如果我能幫到的話,我寧願不要重新發明。

我到目前爲止遇到的兩個主要候選人是DocBookreST。前者似乎贏得了吮吸的聲譽。我對這兩者都不熟悉,但我被告知,reST會讓我成爲那裏的一大部分。

其他建議?我從零開始構建它會更好嗎?

回答

2

如果您需要創建傳統技術文檔,我可以推薦DocBook:書籍,分爲章節,分爲章節等。我認爲有三個主要考慮因素:標記本身,編輯工具鏈和發佈工具鏈。

標記。 DocBook XML標記非常全面,包含對幾乎所有可以想象到的方面的支持,這些方面可能包含在技術性文章中,然後包含在一些文章中。這包括交叉引用,腳註等書籍的基本內容,以及專門用於軟件文檔的標記,如程序列表,參考條目等。Norman Walsh和Leonard Muellner對標記的基本參考是DocBook: The Definitive Guide

可以使用lang屬性明確標記內容的語言,以便源文檔可以包含多種語言的內容,並且可以在處理階段提取所需的語言版本。

創作工具。由於DocBook詞彙量龐大,某種「模式感知」編輯器幾乎是一項需求。一個好的編輯器會幫助你選擇標記元素,並確保你產生有效的標記。一個體面的XML編輯器會這樣做,但取決於您的文檔編寫者的技術水平,您可能還想考慮一些更加用戶友好的內容。有一些WYSIWYG風格的編輯器可用。 (我用過XMLMind XML Editor,對此我很滿意。)

發佈工具。 DocBook XML標記生成輸出的事實上的標準方式是DocBook XSL樣式表分佈。它支持多種輸出格式,包括HTML,XSL-FO(用於PDF輸出),HTML幫助,甚至是手冊頁。由樣式表生成的輸出可以由許多參數控制,當您想調整輸出時首先要查詢的是reference documentation隨樣式表一起分發。

但是,如果您希望對生成的輸出進行更多的控制,則需要自定義XSLT樣式表以供特定用途。這看起來有點令人生畏,特別是如果您以前沒有XSLT的經驗。不過,這裏有一本關於這個主題的優秀免費書籍:Bob Stayton的DocBook XSL: The Complete Guide

爲了將XSL-FO轉換爲PDF,您還需要一個XSL-FO處理器。有免費的開源Apahce FOP,然後有多種商業選擇。

很可能,您的發佈過程可能最終會看起來像文檔的構建系統。您將擁有一個自動化系統(可能由像Make或Ant這樣的構建工具驅動),它將以XML形式提供文檔源,並將其轉換爲所需語言的所需輸出格式。


總之,如果您正在尋求生成線性書類的詳細技術文檔,DocBook是一個不錯的選擇。主要的缺點是標記的複雜性,可以爲作者提供相當大的學習曲線,並且可能需要特殊的創作工具。此外,自定義DocBook XSL樣式表的輸出可能會相當複雜。

如果您希望生產更少的「書樣」和更多「類似在線」的文檔 - 文檔主題相互關聯 - 您可能想看看DITA作爲另一種基於XML的替代方案。我沒有使用它,但它也帶有一個用於從XML標記生成各種輸出格式的工具鏈。

2

DocBook和ReStructuredText絕對是兩個最大的競爭對手,但Asciidoc是另一種類似的標記語言,不管標記如何,它都是可讀的。我個人更熟悉ReStructuredText(因此也是更大的支持者),但Asciidoc只是另一種選擇。鑑於目前爲止所描述的內容,聽起來像MoinMoin將會是一個很好的選擇,因爲它has a ReStructuredText parserit can export pages to PDF。您應該能夠提取源代碼並根據需要通過任何其他獨立工具運行它(但您可能需要預處理它們以去除任何MoinMoin特定的標記)。

如果MoinMoin不完全符合您的需求,Google還會提供其他一些results for ReStructuredText wiki