如何交付IT工具文件?

如何交付IT工具文件?

我想提供一個在 Windows 上使用的 IT 工具。這個東西是一個 ISAPI Filter,我想描述安裝、操作和設定。

目前這是在文字檔案中完成的,該文件相當完整,但我認為它不是很有用。我想我能很好地處理什麼應該在文檔中。我想要輸入如何部分。為 Windows Web 伺服器管理員提供文件的最佳方式是什麼?

.CHM? .PDF? .DOCX? .HTM?

編輯: 我一個文字文件,但它變得非常長,而且它的連結、交叉引用、索引和組織功能有限。讓我們看看,主要部分用等號加下劃線,小節用破折號加下劃線...等等。


更新:我選擇了SHFB。這是輸出 HTML 幫助。你怎麼認為?可以用嗎?

答案1

這是我的看法:

  • ASCII 文字很棒 - 我可以在任何地方閱讀它
  • HTML 是第二好的 - 我也可以在大多數地方閱讀它
  • PDF 是可以接受的,但有點煩人,因為我可能需要在未安裝 PDF 閱讀器的伺服器上引用它
  • CHM 是一種痛苦,因為愚蠢的 HTML 幫助控制項(感謝 HTML 幫助控制項錯誤/漏洞!),而且它不是一種非常友好的剪切/貼上格式
  • DOCX 實在是太煩人了 - 我的伺服器上沒有安裝“Office”,如果我需要參考那裡的文檔,我肯定不會加載它

答案2

我必須使用格式正確的 ASCII 文字檔。它們可以從筆記型電腦、伺服器、windows、unix、linux 等讀取。

我不必依賴網頁瀏覽器、adobe reader、office 或任何其他程式來閱讀如何在我的伺服器上安裝某些內容。它應該是簡單且無痛。

事實是……在緊要關頭……如果需要的話,我甚至可以從手機上讀取文字檔案。

我確信任何在凌晨 3 點在不太理想的情況下被困在託管設施中的人(即從酒吧傳呼、沒有筆記型電腦等)都會同意。 ;-)

只是我的2分錢...

答案3

你應該檢查一下阿斯西多克。我用它做了一些簡短的東西,並且輸出非常清晰(當然,並且可以自訂)。純文字的設計非常具有可讀性,您可以讓它輕鬆輸出文件、HTML 和 PDF。使用任意數量的其他轉換器,您也可以將其轉換為其他格式,例如 CHM。

非常通用的軟體包,但作為一個以 UNIX 為中心的軟體包,我不知道 Windows 支援如何。

答案4

我知道您已經接受了答案,但我想我會推薦獅身人面像。您可以在 reStructuredText 中編寫文檔,但可以輕鬆產生可搜尋的 html(微小的 javascript)。 /

相關內容