我想提供一个在 Windows 上使用的 IT 工具。这个东西是一个 ISAPI 过滤器,我想描述安装、操作和配置。
目前这是在一个文本文件中完成的,它相当完整,但我认为它不是很有用。我想我对文档中应该包含的内容有很好的处理。我想输入“如何”部分。为 Windows Web 服务器管理员提供文档的最佳方式是什么?
.CHM?.PDF?.DOCX?.HTM ?
编辑:我有一个文本文件,但它变得很长,而且它的链接、交叉引用、索引和组织功能有限。让我们看看,一个主要部分用等号加下划线,一个小部分用破折号加下划线......等等。所以我尝试用这种方式格式化它,但最后 .txt 文件只是没有缩放。
更新:我选择了 SHFB。这是输出 HTML 帮助。你怎么看?可用吗?
这是我的看法:
我必须使用格式正确的 ASCII 文本文件。它们可以从笔记本电脑、服务器、windows、unix、linux等中读取。
我不应该依赖网络浏览器、adobe 阅读器、office 或任何其他程序来阅读如何在我的服务器上安装某些东西。它应该简单而无痛。
事实是......在紧要关头......如果必须的话,我什至可以从手机中读取文本文件。
我敢肯定,在不太理想的情况下(即从酒吧传呼、没有笔记本电脑等)凌晨 3 点被困在 colo 设施的任何人都会同意。;-)
只是我的2美分...
您应该查看asciidoc。我用它做了一些简短的事情,并且输出非常清晰(当然可以自定义)。纯文本在设计上非常易读,您可以轻松地输出文档、HTML 和 PDF。使用任意数量的其他转换器,您也可以将其转换为其他格式,例如 CHM。
非常通用的包,不过,作为一个以 UNIX 为中心的包,我不知道 Windows 支持如何。
reStructuredText很适合我。它易于学习和使用。
我知道您已经接受了答案,但我想我会推荐sphinx。您在 reStructuredText 中编写文档,但可以轻松生成可搜索的 html(小型 javascript)。/
这是对纯文本的另一票。如果文档需要或受益于某种 HTML 插图,则可能是最佳选择,因为浏览器比其他阅读器应用程序更可能可用。
请不要使用 DOCX 或任何其他专有格式,除非有压倒性的理由这样做(而且我暂时想不出一个)。即使您想将其创建为 Word 文件,也将其保存为 DOC,而不是 DOCX,因为有更多的软件可以读取旧格式。