我应该如何为Windows上的IT工具构建和交付文档?还有一个额外的限制,我不想把钱花在帮助创作工具上。
在这里,我们将讨论算法和优化、API和性能。但我的开发工作的其中一个可交付成果是文档。构建它的最好方法是什么,我应该以什么形式交付它?
如果我要交付一组.NET API,那么.CHM是一种合理的交付机制。在构建过程中使用SHFB来构建帮助文件是非常容易的,如果它主要在Windows上使用,那么.CHM是非常容易访问的。将.CHM转换为.HTM使得文档的可访问性更广。
但我想为ISAPI过滤器提供文档,它不是由开发人员本身使用的,而是由Windows web服务器管理员使用的。我需要描述安装、操作和配置。我认为最终用户可能通常具有开发人员和管理技能,但无论如何,对于我的目的,文档将涵盖管理任务和操作事项。
我知道SHFB允许我在.CHM中包含常规的HTML文件,如果我已经知道SHFB了,如果我不想花钱在帮助创作工具上,这是最好的选择吗?如果不是,那是什么?
发布于 2009-07-11 22:28:00
最后,我决定使用沙堡帮助文件生成器,这是http://shfb.codeplex.com上的免费工具。我已经使用sandcastle为不同的项目构建了参考文档,因此我对该工具有所了解。它产生CHM或.HxS文件,适合在Windows上使用。我以前从来没有用过SHFB来“设计”一个有帮助的软件,但是它很容易理解如何去做。结果非常好。
发布于 2009-07-09 16:28:26
Texlipse是一个用于Eclipse的Latex插件。两者都是免费的。Latext被许多研究人员用来生成论文,甚至被用于许多教科书。这是一个免费的工具,可以满足您的需求。
发布于 2009-07-09 15:16:34
试试这个asciidoc。它不是LaTeX,但生成了很好的PDF/CHM/HTML,您可以教非程序员为您编写文档,这是一个很好的奖励:)
https://stackoverflow.com/questions/1104533
复制相似问题