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

https://stackoverflow.com/questions/2977398

24-10-2019
|

题

为最终用户创建跨平台帮助文件的一些好的创作工具是什么？（如果有任何区别，我们的应用程序正在使用QT框架。）

注意：我对内部API文档不感兴趣 - 我们正在使用 doxygen 为了那个原因。

理想情况下，解决方案将：

允许我们在一个位置管理所有帮助内容（文本，目录，图像等）。
输出到本机帮助格式。（Windows的CHM或至少可以直接进入HTML帮助API；不确定其他平台的“标准”帮助格式是什么。）
体面的Wysiwyg支持：处理常见的文本条目，图像，交叉引用等。但是，我们可以在需要时编辑HTML。
基于文本的文件形式用于帮助项目（XML等），以便可以在颠覆中版本进行版本。
任何有助于使其与实际代码库同步的钩子都将很棒。（也许某种程度上有一个帮助主题与代码文件相关联，可以检查颠覆以查看是否已进行了任何更改，并将主题标记为“可能过时的日期” ...我在做梦吗？）
帮助内容可以进行本地化。
不反对商业产品，但免费选择会很好。

我将继续进行Wiki，然后以一些示例开始。如果您对他们有经验，请投票或向下投票，并发表一些评论。还添加其他工具。

解决方案

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

比HTML优于Wysiwyg：重组文本
输出到QTHELP（除其他外），因此很容易在我们的应用程序中分发（和集成）。
尚不确定本地化，但是我们会在需要时越过那座桥。
很容易设置，并且“只能工作”；看起来很专业。

其他提示

我已经使用了Robohelp多年了。

很好，但是核心技术现在很旧。同样，他们锁定单词版本的方式是PITA（迫使我避免MS Office升级几次）。

我们正在移动Madcap Flare http://www.madcapsoftware.com/products/flare/robohelp.aspx

我认为 Docbook 解决您的所有要求，除了可能的同步挂钩，我会进一步考虑。它本质上是设计用于创建文档的XML子集，并且是免费的和开源的。它只是一种格式加上一组XSL输出，可以将DOCBOOK转换为更有用的格式（HTML，因此可以通过XML-FO或TEX转换为CHM，Javahelp，PDF）。

这意味着您仍然需要选择一个XML创作工具来实际编辑它，因此Wysiwyg之类的内容将取决于XML创作软件的功能。我们使用Syntext Serna，因为它对Wysiwyg有很好的支持和XML #includes的内联编辑（似乎没有其他人支持后者）。您可能会发现其他XML创作工具更好地满足您的需求 - Serna是一种相当昂贵的商业产品。

DocBook通过分析提供了很大的灵活性，这使您可以根据其属性包含/排除XML元素。示例用例是OS = Windows的帮助输出略有不同，而不是OS = Linux。还通过分析和其他机制来支持本地化。

相当好文档简介可以被找寻到这里.

我们使用DocBook进行帮助格式，并将其编译到仅包含与特定产品相关功能的帮助的CHM文件（IE Enterprise Edition具有不在标准或演示版本中的功能）。相关步骤是：