什么是一个很好的工具，用于编写用户手册(帮助的文件)，其整合的版本控制[封闭]

https://stackoverflow.com/questions/152241

02-07-2019
|

题

人们写的用户手册不一定程序员，他们需要一些编辑器。一个主要问题是内部的格式编写的工具；它应该是可读的文本/html，因此很容易进行比较版本的个人网页查到版本控制。

解决方案

还有其他专业产品允许帮助文件编写，并且他们支持“上下文ID”。这使得上下文敏感帮助成为可能提供帮助的文档和 RoboHelp 就是这些类型的产品。

其他提示

的DocBook

_{（来源： docbook.org ）}

Microsoft HTML Help Workshop可用于创建高质量的专业CHM帮助文件。您只需要一堆HTML文件。该工具“编译”所有这些和捆绑到一个帮助文件中。可以使用Microsoft Word / Frontpage甚至Dreamweaver生成HTML文件。您可能需要考虑控制这些HTML文件的源。

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

在我以前的工作中，他们使用了一个名为 flare 的疯狂软件工具。

它似乎工作得很好。

一个很好的组合审议是颠复、DocBook和税吏.

版本控制= 颠复
内容创作= DocBook
出版= 税吏
可选择的"所见即所得"= Serna

目前，这是一个工具链中使用世界上最大的提供者的开放源解决方案，并将名字背后的世界上许多使用基于Linux的操作系统的企业市场。大多数(靠近所有的)的红帽子的官方文件是建立在这样一种方式。同样的问。

主要的"专业"这里是这些都是免费提供的工具，具有强烈的重叠，在市场的技术的作家。所有这些都将能够(但不可能想要)编写在XML和捡DocBook是像捡HTML在90年代。颠复是一个非常常见的版本控制的工具，这样DocBook是比较容易实施和使用。税吏是一个伟大的出版工具，可以采取的DocBook XML，并将其发布到PDF,HTML,HTML单，等等。很明显你的作家可以使用所见即所得像Serna，但是，我使用的片段在Geany(Fedora)或突(OS X)个人。

主要的"con"是的看法的技术性问题。你的作家可能希望所见即所得(以及可以拥有这一)，并且根据你的文件的需求，这可能是你最终使用。因为你会知道，有一个市场那里为"技术的作家"专门从事固定Microsoft Word格(和标记)，这样的参数对于分离的"创作"，从"发布"是基于经验证，但不同的使用情况的组织需要的文件被举起到相同标准的工程/方案/源生产。

一些极端的建议，你将得到来自个人和公司已经暴露的价值XML文件，尤其是那些在该领域的蒂塔，那里的某些跨国有声誉的收购的影响的格式和可用性的产品的知识。也有论点锁定你的文件变成一个"粘"或关闭的格式并不能帮助未来的维护要求。这是开放源的选择获得支持在企业水平。另外，显然，它是免费的。

您可以使用Subversion和MGTEK Help Producer。帮助生产者从Word文档中生成帮助文件。 TortoiseSVN附带了用于比较Word文档的不同修订版本的脚本（Word有一个版本比较工具）。

您的用户将需要一个类似于他们正在编辑的视觉差异工具。如果他们只是稍微不技术，DocBook或Latex将无法工作（我试过给我的用户两者，我甚至尝试过Epic Editor作为DocBook编辑器，这个编辑器非常昂贵，但毕竟效果不好。坚持他们所知道的事情（Word）会让你头疼。

我一开始也不愿意走这条路，因为我想要一个更“技术上完美”的解决方案，但随着时间的推移，我意识到拥有快乐和高效的用户更为重要。只是说我知道你来自哪里，但尝试Word路线 - 它在实践中比在那里的所有'纯'基于文本的解决方案更好。普通用户不喜欢基于标记的编辑。

如果您使用的是Visual Studio，请查看SandCastle - http://www.codeplex.com /沙堡。

还有一些工具可以帮助您构建沙堡文件，尝试搜索“沙堡”文件。在codeplex上。其中一个是SandCastle帮助文件生成器（ http://www.codeplex.com/SHFB ），但我从来没有使用它，所以我不知道非技术用户是否会对此感到满意。

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

我创建了一个名为 Mandown 的文档系统（ Markdown / Html / Javascript / file-based可以轻松进行版本控制的相对链接文件（可移植性）。你必须单独弄清楚的可视化编辑器部分 - 我有时会使用 HTML-Kit 至少有一个预览功能。

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

这是另一个检查工具： Xilize

我们正在使用 APT 。它与CI（标准构建工件）很好地集成，并且比例如word文档更活跃。也可以在需要时生成PDF和其他格式。

许可以下： CC-BY-SA 和归因

不隶属于 StackOverflow