應用程序文檔

Question

我一直在開發應用程序並使用PDF或MS Word編寫文檔（用戶手冊）。當我們在目標機器上安裝這些應用程序時，我們面臨的問題就像Acrobat reader無法打開用戶手冊（PDF）。最後（大多數情況下），我寫在文本文件中。

我在考慮將用戶手冊作爲應用程序本身或我的主應用程序將調用的其他應用程序的一部分。主題顯示在Winform上，並從XML文檔中讀取。

這是一個正確的方式來記錄和呈現。接下來，如果這很好，我們是否有庫/開源或任何東西。

請發表您的評論。

謝謝 戒

Answer 1

我會建議使用不同的格式，如CHM文件或HTML文件。 CHM文件被設計成幫助文件，並在Windows機器上運行。如果你真的想全面支持，HTML是一個好方法。

由於CHM文件是經過壓縮和索引的HTML文件，如果您有任何需要移出平臺的問題，只需將其輸出到純HTML文件即可。

這裏是對應用程序的鏈接創建CHM文件：

http://www.microsoft.com/downloads/en/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&DisplayLang=en&displaylang=en

Answer 2

由於您使用的是Windows，你可以使用Windows HTML幫助和你的文檔將可隨時到達你的目標機器：

• Microsoft HTML Help 1.4 SDK

本文介紹如何創建一個幫助項目，編譯它，將它連接到您的程序並分發它。

Answer 3

我的想法，包括用戶手冊 作爲應用程序本身

的一部分，在這種情況下CHM格式是更優選的，因爲它允許建立來回你的應用程序上下文敏感的幫助。使用HtmlHelp API調用，您可以從應用程序中直接調用特定的幫助主題或搜索關鍵字。