如何在Windows上构建和提供IT工具的文档？

Question

我应该如何在Windows上构建和提供IT工具的文档？还有一个额外的限制，我不想花钱在帮助创作工具上。

在SO上，我们讨论算法和优化，API和性能。但我的开发工作的可交付成果之一就是文档。构建它的最佳方式是什么，我应该以什么形式提供它？

如果我提供一组.NET API，.CHM是一种合理的交付机制。使用SHFB构建帮助文件作为构建的一部分非常容易，如果它主要用于Windows，则.CHM非常容易访问。将.CHM转换为.HTM使得doc可以更广泛地访问。

但是我想为ISAPI过滤器提供doc，这些过滤器本身不会被开发人员使用，而是由Windows Web服务器管理员使用。我需要描述安装，操作和配置。我认为最终用户可能经常拥有开发人员和管理技能，但无论如何，出于我的目的，文档将涵盖管理任务和操作事项。

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

Answer 1

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

Answer 2

试试这个asciidoc。它不是LaTeX，而是产生很好的PDF / CHM / HTML，你可以教非程序员为你编写文档，这是一个很好的奖励：）

Answer 3

为什么不在开放式办公室中编写文档然后以pdf格式导出文档？

乳胶是专业的方式，但它不能快速获取。

Answer 4

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