遺留應用程序的用戶文檔的最佳實踐

Question

我在遺留應用程序（C++。Net）上工作，我們希望提取一些功能並將其重新命名爲單獨的產品。很明顯，這個'新'產品需要文檔，而且與這個功能相關的舊文檔是坦率的垃圾。

我正在尋找建議，人們認爲什麼是向這樣的應用程序添加文檔的最佳格式。要求包括：

• 文件應與應用
• 基於Web的文檔被打包是不是真的相關，但解決方案可以基於的本地基於Web的安裝
• 這將是巨大的，如果文件是輕鬆與應用程序集成
• 有很多範圍的FAQ，HOWTO等文檔以及標準的綜合用戶文檔
• 該應用程序也是可擴展的，因此支持基於代碼的示例等be gr吃。
• 應該由非開發人員

任何提示\提醒我們非常感激可更新。

這些文件應與應用

Answer 1

打包因爲你寫的非開發人員應該能夠更新它，我會去一些wiki解決方案與輸出文件的一些流行的格式的能力，這裏是wiki的列表：https://en.wikipedia.org/wiki/Comparison_of_wiki_software。你也可以考慮Markdown格式http://en.wikipedia.org/wiki/Markdown，我猜這是文檔最輕量級的解決方案。