什么是编写与版本控制集成的用户手册(帮助文件)的好工具

时间:2020-03-06 14:54:48  来源:igfitidea点击:

编写用户手册的人不一定是程序员,他们需要可视化编辑器。一个主要问题是创作工具的内部格式。它应该是可读的text / html,因此可以轻松比较签入版本控制的各个页面的版本。

解决方案

DocBook

替代文字http://www.docbook.org/graphics/banner.png

我们正在使用APT。它与CI(标准构建工件)很好地集成在一起,并且比Word文档更生动。如果需要,也可以生成PDF和其他格式。

Microsoft HTML帮助研讨会可用于创建高质量的专业CHM帮助文件。我们只需要一堆HTML文件。该工具将所有这些文件"编译"并捆绑到单个帮助文件中。
可以使用Microsoft Word / Frontpage甚至Dreamweaver生成HTML文件。我们可能需要考虑对这些HTML文件进行源代码控制。

我创建了一个名为Mandown的文档系统(Markdown / Html / Javascript /基于文件的相对链接的文档,以实现可移植性),该系统很容易受到版本控制。我们必须单独弄清楚的可视化编辑器部分,有时我会使用HTML-Kit,该工具至少具有预览功能。

请参阅什么是存储软件文档的最佳方法?

这是另一个签出的工具:Xilize

乳胶。 Lyx提供用于编写​​乳胶文件的WYSIWYM。

如果我们使用的是Visual Studio,请查看SandCastle http://www.codeplex.com/Sandcastle。

还有两个工具可以构建沙堡文件,尝试在codeplex上搜索" sandcastle"。其中之一是SandCastle帮助文件生成器(http://www.codeplex.com/SHFB),但我从未使用过它,所以我不知道非技术用户对此是否满意。

还有其他专业产品允许编写帮助文件,并且它们还支持"上下文ID",这使上下文相关的帮助成为可能。 Doc To Help和RoboHelp是此类产品。

在我以前的工作中,他们使用了由madcap软件开发的工具flare。

看起来真的很好。

我们可以使用Subversion和MGTEK帮助生产者。帮助生产者从Word文档制作帮助文件。 TortoiseSVN带有脚本,用于在Word本身中比较Word文档的不同修订版本(Word具有版本比较工具)。

用户将需要一个类似于他们正在编辑的可视化差异工具。如果它们只是一点技术,则DocBook或者Latex将无法正常工作(我尝试给用户和用户同时使用,甚至尝试将Epic Editor作为DocBook编辑器使用,这虽然非常昂贵,但毕竟效果不佳)。坚持他们所知道的(单词)将防止我们头疼。

我也很不愿意一开始就走这条路,因为我想要一个在技术上更"完美"的解决方案,但是随着时间的推移,我意识到拥有快乐和高效的用户更为重要。只是说我知道我们来自哪里,但是尝试使用Word路由,比起所有现有的"纯"基于文本的解决方案,它在实践中的工作要好得多。普通用户不喜欢基于标记的编辑。

Mapcap Flare是周围最好的商业工具。由Robodoc的前开发人员撰写