为 MVC 应用程序创建帮助和手册

Question

我有一个小型应用程序，需要有专业的帮助/手册部分。帮助包括：

• 操作方法
• 常问问题
• 参考

我想知道是否有一个免费（易于学习）的工具可以帮助我生成 HTML 格式的这些文档？有什么建议么？

谢谢您的帮助

Answer 1

对于我们现在正在设计的新 MVC 应用程序，我们计划使用 wiki 形式的外部帮助站点。有像 mediawiki 和其他这样的 wiki 引擎，其想法是提供上下文相关的帮助（从不同的应用程序页面打开不同的帮助页面），并允许用户随后添加公式和示例等内容。

很酷的事情是，wiki 跟踪更改并为我们免费进行版本控制，因此帮助可以与我们的应用程序源代码完全解耦，并且用户可以查看谁添加了他们想要的内容。

在我们的例子中，它只是一个内联网应用程序，所以实际上我们的内部网络没有安全问题。