如何構建和交付Windows上IT工具的文檔？

Question

我應該如何爲Windows上的IT工具構建和交付文檔？還有一個額外的限制，我不想花錢幫助創作工具。

在這裏，我們討論算法和優化，API和性能。但是我的開發工作中的一個交付成果是文檔。建立它的最佳方式是什麼？我應該以什麼形式提供它？

如果我提供了一組.NET API，.CHM是一個合理的交付機制。使用SHFB構建幫助文件作爲構建的一部分非常簡單，如果它主要在Windows上使用，則.CHM非常易於使用。將.CHM轉換爲.HTM使得文檔更加廣泛。

但我想爲ISAPI過濾器提供文檔，而不是由開發人員本身使用，而是由Windows Web服務器管理員使用。我需要描述安裝，操作和配置。我認爲最終用戶可能經常擁有開發人員以及管理技能，但無論如何，爲了我的目的，這些文檔將涵蓋管理任務和操作事宜。

我知道SHFB允許我在.CHM中包含普通的HTML文件。如果我已經知道SHFB，並且如果我不想花錢在幫助創作工具上，這是最好的方法嗎？如果不是，什麼？

Answer 1

最後，我決定使用Sandcastle幫助文件生成器，免費工具http://shfb.codeplex.com。我已經使用sandcastle來爲不同的項目構建參考文檔，所以我對這個工具有了一些瞭解。它生成適用於Windows的CHM或.HxS文件。我從來沒有使用SHFB來「設計」一個幫助，但很容易理解如何做到這一點。結果非常好。

Answer 2

試試這個asciidoc。它不是LaTeX，但生成漂亮的PDF/CHM/HTML，你可以教非程序員爲你寫文檔，這是一個不錯的獎勵:)

Answer 3

爲什麼不把文檔寫在開放辦公室然後導出PDF？

乳膠是專業的方式，但它不能快速訪問。

Answer 4

​​是Eclipse的Latex插件。兩者都是免費的。 許多研究人員使用Latext來生成論文，甚至用於許多課本。這是一款免費工具，可以滿足您的需求。