連續用戶手冊生成

Question

是否已有解決方案存在於「連續文檔」中文檔標記語言併爲Jenkins/Hudson構建插件？

我不是在討論如何生成API描述，而是在討論帶有屏幕截圖的用戶手冊等。保持用戶手冊是最新的，這是一項單調乏味的工作，所以我認爲寫一個好主意用戶手冊中的某些標記（xml），然後在構建過程中將其轉換爲html和pdf。

這是相當直接的實現，但我想知道是否已經存在的解決方案或最佳實踐，例如，像Sphinx，但可能在Java中，因爲我不允許使用Python。

Answer 1

遺憾的是沒有很多的選擇，在一個純Java的世界：

• 對於簡單的說明書，你可以使用Markdown和Java實現類似f.ex. PegDown;這適用於簡單的HTML手冊，但PDF生成通常很困難。
• 如果你已經有獅身人面像的文檔，你可以使用reStructuredText的Java實現JRst（不作爲強大的獅身人面像）或JPython的運行獅身人面像...

• 的最好的解決方案在我看來是寫的文件在AsciiDoc。由於幾個星期，存在a Java-Wrapper（使用JRuby），其名稱爲AsciiDoctor。

  AsciiDoc語言功能非常強大，並且很容易從AsciiDoc生成DocBook。對於DocBook，存在很多（有時隱藏......）Java工具。