我正在用 c# 4.0 开发一个 WinForm 应用程序，并希望其他（非开发人员）同事为编写上下文敏感的最终用户帮助文件做出贡献。首先，我认为我可以使用 Microsoft 的“HTML Help Workshop”，但它似乎已经过时（不支持 Vista 和 Windows 7）。然后我看了Sandcastle，但是缺少文档，我想知道它是否适合非技术用户编写最终用户文档。因此，我阅读了有关 RoboHelp 的信息，但这对我来说太贵了。我迷失在有关帮助文件的所有可用信息中。有人可以帮助提供一些关于使用哪些工具以及我应该针对什么输出格式（仍然是 chm 或其他）的最佳实践或信息。
问问题
868 次
3 回答
1
好问题。我喜欢您关于非开发人员为最终用户文档做出贡献的想法。
这个想法可能会激励您的应用程序的用户和测试人员轻松地为文档做出贡献。
我首先想到的是使用某种 wiki 引擎。您可以在您的 WinForm 应用程序中构建一个简单的函数，该函数会启动浏览器并指向 wiki。您可以使用调用它的上下文来构建一个 url；例如http://dev-wiki.mycompany.com/LoginForm?action=edit。此处表单的名称（“LoginForm”）用于 wiki 页面的 url。
或者，您可以简单地使用 WinForms 的嵌入式Web 浏览器控件来访问 wiki。这看起来像：
var url = GetWikiUrl(myForm);
browserControl.Navigate(url);
这很容易嵌入到您的应用程序中。
在受控（办公室）环境中，这将非常容易设置。在您的生产环境中，这可能会有点困难，但仍然可行。它也可能会利用一些最终用户的贡献。
于 2010-10-15T07:59:32.790 回答
0
对于编写文档，我使用sphinx。它可以让您以纯文本形式记录并具有各种输出格式（chm、html、pdf 等）。
其中一些（chm、html）可以用作上下文相关的帮助资源。
不管多么简单，sphinx 用户界面（文本编辑器和生成文件）可能不适合非技术用户。
于 2010-10-15T08:18:37.927 回答
0
我建议使用Help+Manual来创建 CHM 文档。它类似于 MS Word，任何 PC 用户都可以在短期教育后开始贡献文档开发。但是这个工具不是免费的:(
于 2012-02-23T21:56:55.563 回答