C＃WinForm应用程序中的最终用户文档编辑器

我正在C＃4.0中开发WinForm应用程序，并希望其他（非开发人员）同事贡献编写上下文敏感的最终用户帮助文件。首先，我认为我可以使用Microsoft的“HTML帮助研讨会”，但似乎已经过时（不支持Vista和Windows 7）。然后我看了Sandcastle，但是缺少文档，我不知道它是否适合非技术用户编写最终用户文档。因此，我阅读了RoboHelp，但它对我来说代价昂贵。我迷失在所有关于帮助文件的信息中。有人可以帮助提供一些最佳实践或有关使用什么工具以及我应该针对哪种输出格式（仍然是CHM或其他）的信息。C＃WinForm应用程序中的最终用户文档编辑器

来源

2010-10-15 Martin

伟大的问题。我喜欢您的非开发人员对最终用户文档的贡献。

这个想法可能会激励用户和应用程序的测试人员轻松地为文档做出贡献。

我首先想到的是使用某种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);

这将是很容易嵌入到您的应用程序。

在受控（办公）环境中，这将非常容易设置。在你的生产环境中，它可能有点困难，但仍然可行。它也可能会影响一些最终用户的贡献。

来源

2010-10-15 07:59:32 Marijn

SandCastle主要用于技术（源代码）文档，我相信我发现Html工作室很难合作。 – Marijn 2010-10-15 08:08:17

对于编写文档，我使用sphinx。它可以让你在纯文本文件，并有各种输出格式（CHM，HTML，PDF等）。

其中一些（chm，html）可以用作上下文相关的帮助源。

但是很简单，sphinx用户界面（文本编辑器和make文件）可能不适合非技术用户。

来源

2010-10-15 08:18:37 Marijn

我建议使用Help+Manual创建CHM文档。它与MS Word类似，任何PC用户都可以在短期教育之后开始贡献文档开发。但是这个工具不是免费的:(

来源

2012-02-23 21:56:55

C＃WinForm应用程序中的最终用户文档编辑器

回答

相关问题