C#Winform应用中最终用户文档的编辑器
-
30-09-2019 - |
题
我正在开发C#4.0中的Winform应用程序,并希望其他(非开发人员)同事贡献上下文敏感的最终用户帮助文件。首先,我认为我可以使用Microsoft的“ HTML帮助研讨会”,但似乎已经过时了(Vista和Windows 7不支持)。然后我看了Sandcastle,但是缺乏文档,我想知道它是否适合非技术用户编写最终用户文档。因此,我读到了Robohelp,但这对我来说很昂贵。我会迷失有关助手的所有信息。有人可以帮助提供一些最佳实践或信息,以了解我应该使用哪种工具以及我应该定位的输出格式(仍然是CHM或其他)。
解决方案
好问题。我喜欢您对最终用户文档做出贡献的非开发者的想法。
这个想法可能会激发您的应用程序的用户和测试人员,以轻松为文档做出贡献。
我想到的第一件事是使用某种Wiki引擎。您可以在Winform应用程序中构建一个简单的功能,该功能可以启动浏览器并将其引向Wiki。您可以使用称为构建URL的上下文;例如 http://dev-wiki.mycompany.com/LoginForm?action=edit
. 。在这里,Wiki页面的URL中使用了表单的名称(“登录”)。
另外,您可以简单地使用嵌入式 Web浏览器控件 Winforms可以访问Wiki。看起来像:
var url = GetWikiUrl(myForm);
browserControl.Navigate(url);
这很容易嵌入您的应用程序。
在受控的(办公室)环境中,这将非常容易设置。在您的生产环境中,这可能会更加困难,但仍然可行。它也可能利用一些最终用户的贡献。
不隶属于 StackOverflow