如何为IT工具提供文档?

我想提供一个在Windows上使用的IT工具。 事情是一个ISAPIfilter,我想描述安装,操作和configuration。

目前这是在一个相当完整的文本文件中完成的,但是我认为它不是很实用。 我想我应该很好地处理文档中的内容。 我想在如何部分input。 为Windows Web服务器pipe理员提供文档的最佳方式是什么?

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

编辑 :我一个文本文件,但它变得很长,它有限制的链接,交叉引用,索引和组织的设施。 LEt的看到,一个主要部分用等号标出,下划线用破折号等等等。所以我尝试这样格式化,但最后.txt文件只是没有规模。


更新 :我select了SHFB。 这里是输出HTML帮助 。 你怎么看? 可用?

这是我的意见:

  • ASCII文本是伟大的 – 我可以在任何地方阅读
  • HTML是第二好的 – 我也可以在任何地方阅读
  • PDF是可以接受的,但有点烦人,因为我可能需要在没有安装PDF阅读器的服务器上引用它
  • 由于愚蠢的HTML帮助控制(感谢HTML帮助控制错误/万用表!),CHM是一个痛苦,它不是一个非常友好的格式,从剪切/粘贴
  • DOCX只是简单的恼人的 – 我没有安装在我的服务器上的“办公室”,如果我需要参考文档那里,我相信不会加载它

我必须使用格式正确的ASCII文本文件。 他们可以从笔记本电脑,服务器,Windows,Unix,Linux等读取

我不应该依靠Web浏览器,Adobe Reader,Office或任何其他程序来阅读如何在我的服务器上安装东西。 它应该是简单而无痛的。

真相是…在一个捏…我甚至可以从我的手机阅读文本文件,如果我不得不。

我敢肯定,凡是在凌晨3点卡住在科罗拉多州科罗拉多州立大学的科罗拉多州立大学的科罗拉多州立大学的科罗拉多州立大学的科罗拉多州立大学, 😉

只是我2分钱…

你应该检查asciidoc 。 我用它做了一些简短的事情,输出相当尖锐(当然还有可定制的)。 纯文本是非常可读的devise,你可以有它输出docbook,HTML和PDF容易。 使用任何数量的其他转换器,您也可以将其转换为其他格式,例如CHM。

非常灵活的软件包虽然是以UNIX为中心的软件包,但我不知道Windows的支持是如何的。

reStructuredText很适合我。 这很容易学习和使用。

我知道你已经接受了一个答案,但我想我会推荐狮身人面像 。 您在reStructuredText中编写文档,但可以轻松生成可search的html(小javascript)。 /

这是纯文本的另一个投票。 如果文档要求或从中受益,某种types的HTML的插图可能是最好的select,因为浏览器比其他阅读器应用程序更可能是可用的。

请不要使用DOCX或任何其他专有格式,除非有压倒性的理由这样做(副手,我想不出一个)。 即使你想创build它作为一个Word文件保存为DOC,而不是DOCX,因为有更大范围的软件可以读取旧格式。