documentation - 软件项目的文档

Question

我正在与一个从事大型软件项目的团队合作，我们有大量以 MS WORD 格式编写的文档，没有超链接索引，没有搜索能力。我们每天都在浪费时间试图找到确切的文件或参考资料。

我在想是否有办法甚至专业的工具可以将所有这些转换为 wiki 格式，并且可能通过一些手动（痛苦的）帮助组织成可以提高可访问性的东西。我使用 Google 桌面搜索让我的生活更轻松一些，但它不是最好的解决方案

我只是想知道你们中是否有人遇到过类似的问题以及这个问题的可能解决方案。

score 2 · Accepted Answer

Confluence wiki允许您导入 Word 文档。我被告知这是一个非常好的维基，有很多功能。

score 2 · Accepted Answer

开源：Trac Wiki

Trac Wiki系统是一种流行的开源选项。甚至在另一个 Stack Exchange 站点上也有一个关于将Word 文档转换为 Track Wiki 格式的主题。Trac 的一些大型或著名用户包括 Red Hat、Django、Handbrake 和 SourceForge。

正如 Alex Korban 所提到的，Confluence是另一个流行的选择。大规模使用它的一个很好的例子是软件公司 JBoss 的Application Server 7社区文档。

我将添加一个快速更新，我非常同意这个可发现的内容和协作问题，我已经在几个不同的项目中努力解决它。

请参阅PressGang CCMS项目，了解我们在 Red Hat 为解决此问题所做的构建工具。首席工程师制作了一个完整的视频，您可以在 Vimeo 上看到，如果您想尝试，我已经创建了一个公共 Amazon AMI。它没有被维护，但它都是开源的。查看存储库或参与社区分叉。

成为其中的一员是一次了不起的经历，并激励我推出了Corilla，这是一家开源技术写作初创公司，专门解决你提到的问题。这将同时提供商业/企业版本以及开源社区版本。目前正在运行一个测试版，我鼓励您参与其中- 您遇到的问题将非常有助于塑造正在构建的解决方案。

score 1 · Accepted Answer

不知道将 MS Word 转换为 Wiki 的工具，但如果您将文档保存为 ODF（OpenDocument 的 XML 格式），则应该可以在您自己的程序中导入文档，或使用 XSL 转换它们，然后输出它们以 Wiki 格式。

在此过程中，您可以尝试根据字符串匹配猜测一些链接。

对于一个曾经在文字处理器中编写文档（甚至不使用索引、目录和超链接等文字处理基本功能）的团队来说，困难的部分是说服他们使用另一个不是打字机的系统。