如何在Windows上构build和交付IT工具的文档?

我应该如何为Windows上的IT工具构build和交付文档? 还有一个额外的限制,我不想花钱帮助创作工具。

在这里,我们讨论algorithm和优化,API和性能。 但是我的开发工作中的一个交付成果是文档。 什么是最好的方式来build立它,我应该以什么样的forms来实现它?

如果我提供了一组.NET API,.CHM是一个合理的交付机制。 使用SHFB构build帮助文件作为构build的一部分是非常容易的,如果它主要在Windows上使用,.CHM非常容易访问。 将.CHM转换为.HTM使得文档更加广泛。

但是我想提供一个ISAPIfilter的文档,而不是由开发者本身使用,而是由Windowsnetworking服务器pipe理员使用。 我需要描述安装,操作和configuration。 我认为最终用户可能经常拥有开发人员以及pipe理技能,但无论如何,就我个人而言,文档将涵盖pipe理任务和操作事宜。

我知道SHFB允许我在.CHM中包含常规的HTML文件。 如果我已经知道SHFB,如果我不想花钱在帮助创作工具上,这是最好的方法吗? 如果不是,什么?

Texlipse是Eclipse的Latex插件。 两者都是免费的。 Latext被许多研究人员用来生成他们的论文,甚至用于许多教科书。 这是一个免费的工具,可以满足您的需求。

试试这个asciidoc 。 它不是LaTeX,但生成很好的PDF / CHM / HTML,你可以教非程序员为你写文档,这是一个不错的奖励:)

为什么不把文档写在公开的办公室,然后用PDF格式导出呢?

乳胶是专业的方式,但它不能快速访问。

最后,我决定使用Sandcastle Help File Builder,它是http://shfb.codeplex.com上提供的免费工具。 我已经使用sandcastle来为不同的项目构建参考文档,所以我对这个工具有了一些了解。 它产生CHM或.HxS文件,适合在Windows上使用。 我以前从来没有用SHFB来“设计”一个帮助,但很容易理解如何做到这一点。 结果非常好。