2

我应该如何在 Windows 上为 IT 工具构建和交付文档？还有一个限制是我不想花钱购买帮助创作工具。

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

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

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

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

4

4 回答 4

1

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

于 2009-07-09T16:28:26.470 回答
0

试试这个asciidoc。它不是 LaTeX，但可以生成漂亮的 PDF/CHM/HTML，您可以教非程序员为您编写文档，这是一个不错的奖励 :)

于 2009-07-09T15:16:34.290 回答
0

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

乳胶是专业的方式，但不是很快就可以使用。

于 2009-07-09T15:22:38.177 回答
0

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

于 2009-07-11T22:28:00.000 回答