跨平台的最终用户帮助创作工具

Dav*_*eer 8 chm qt cross-platform help-authoring

有哪些好的创作工具可以为最终用户创建跨平台的帮助文件?(我们的应用程序使用Qt框架,如果这有任何区别.)

注意:我对内部API文档不感兴趣 - 我们正在使用doxygen.

理想情况下,解决方案是:

  • 允许我们在一个位置管理所有帮助内容(文本,目录,图像等).
  • 输出到本机帮助格式.(适用于Windows的CHM - 或者至少我们可以直接提供给HTML帮助API;不确定其他平台的"标准"帮助格式是什么.)
  • 体面的WYSIWYG支持:轻松处理常见的文本输入,图像,交叉引用等,但我们可以在需要时编辑HTML.
  • 帮助项目(XML等)的基于文本的文件格式,以便可以在Subversion中进行版本控制.
  • 任何有助于使其与实际代码库保持同步的钩子都会很棒.(也许某种程度上帮助主题与代码文件相关联,并且可以检查Subversion以查看是否进行了任何更改并将主题标记为"可能已过时"......我在做什么?
  • 帮助内容可以本地化.
  • 不反对商业产品,但免费选择会很好.

我将继续并将其作为维基,并从几个例子开始.如果你有经验,可以投票或者投票,并留下一些评论.还添加其他工具.

Dav*_*eer 4

我刚刚发现了狮身人面像;我想我恋爱了。

  • 比 HTML 上的 WYSIWYG 更好:reStructuredText
  • 输出到 QtHelp(除其他外),因此可以轻松地在我们的应用程序中分发(和集成)。
  • 还不确定本地化,但我们会在需要时跨过那座桥。
  • 易于设置且“正常工作”;看起来很专业。