我正在使用c#4.0开发一个WinForm应用程序,并希望其他(非开发人员)同事能够编写一个上下文敏感的最终用户帮助文件。首先我想我可以使用微软的“HTML Help Workshop”,但它似乎已经过时了(不支持Vista和Windows 7)。 然后我看了Sandcastle,但文档缺乏,我想知道它是否适合非技术用户编写最终用户文档。 所以我读到了RoboHelp,但这对我来说是昂贵的。 我迷失在有关帮助文件的所有信息中。有人可以帮助提供一些最佳实践或信息,说明我应该使用什么工具以及我应该采用哪种输出格式(仍然是chm或其他)。
答案 0 :(得分:1)
好问题。我喜欢你的非开发人员对最终用户文档做出贡献的想法。
这个想法可能会激励您的应用程序的用户和测试人员轻松地为文档做出贡献。
我想到的第一件事是使用某种wiki引擎。您可以在WinForm应用程序中构建一个简单的函数,该函数会启动浏览器并指向wiki。您可以使用调用它的上下文来构建URL;例如http://dev-wiki.mycompany.com/LoginForm?action=edit
。这里表单的名称(“LoginForm”)用在维基页面的URL中。
或者,您可以简单地使用嵌入式web browser control for WinForms来访问Wiki。这看起来像是:
var url = GetWikiUrl(myForm);
browserControl.Navigate(url);
这很容易嵌入到您的应用程序中。
在受控(办公室)环境中,这很容易设置。在您的生产环境中,它可能会有点困难,但仍然可行。它也可能会利用一些最终用户的贡献。
答案 1 :(得分:0)
对于编写文档,我使用sphinx。 它允许您以纯文本文档并具有各种输出格式(chm,html,pdf等)。
其中一些(chm,html)可以用作上下文相关的帮助源。
但是很简单,sphinx用户界面(文本编辑器和make文件)可能不适合非技术用户。
答案 2 :(得分:0)
我建议使用Help+Manual来创建CHM文档。它与MS Word类似,任何PC用户都可以在短期教育后开始提供文档开发。 但是这个工具是免费的:(