软件组织和维护项目文件，规范？

Question

我正在寻找用于组织和维护项目内部文档、规范、需求等的软件。目前，我们将所有文档作为大量MS文件存储在源代码管理存储库中，这为我们提供了版本控制，这很好。但是你不能搜索这些信息，在它们之间创建链接，分类，协作。

要求、偏好：

• 客户端零安装(基于WEB)。
• 文档版本控制。
• 文档注释。
• 文件链接。
• 全面搜索(所有文件)。
• MS Word (*.doc)导入\导出。
• 所见即所得文本编辑器。

到目前为止，我已经发现并尝试过这样的系统：

• MediaWiki
• XWiki
• 汇合点

Answer 1

像狮身人面像这样的怎么样？

您可以用reStructuredText (语法类似于Stack溢出使用的Markdown )将文档编写到纯文本文件(=易于版本控制)中，而Sphinx则吐出HTML页面。

据我所知，两个最著名的Sphinx用户是Python语言和TortoiseHG (参见Sphinx生成文档的链接)。

编辑：

我刚读到你说的是项目内部文档，而不是最终用户文档。

在我看来，类似狮身人面像的东西也是内部文档的最佳方式(前提是您可以让分析人员编写reStructuredText)，因为：

1. 您可以轻松地对文档进行版本控制(与二进制文件(如.doc或.pdf)相比，文本文件的差异占用的空间要小得多、少得多)。
2. 如果开发人员想要一个可读的.doc或.pdf文件，他可以从源代码中使用Sphinx创建它。

如果Sphinx太复杂，还有一种更简单的方法:您可以用Markdown编写文档，并使用潘多克创建(例如) .rtf、.doc或.pdf文件(它可以做得更多)。

我发现Pandoc比Sphinx更容易开始，但是Pandoc不能创建像Sphinx这样的好的菜单层次结构(就像我上面链接的文档中的那样)。

无论您使用哪种工具，如果您有内部web服务器和构建服务器，则可以设置它，以便生成服务器生成HTML输出，并在每次有人向文档推送文件时将其复制到web服务器上。因此，您的分析人员甚至不需要考虑最终的输出，他们只需要提交并推动他们的更改。

Answer 2

你可以尝试实现一个Wiki。Mediawiki拥有您正在讨论的所有缺少的功能(搜索函数、版本控制历史、链接、分类)。您必须确保确切地知道文档的哪个版本属于软件的哪个版本，但这可以通过在每个版本依赖的文章中包含版本引用或特定类别的约定来完成。

但是:你写你有“分析师”，他们不是开发人员(我承认，我不是那个星座的粉丝)。当您用一些面向文本的工具(如Wiki )替换MS Office工具时，这类人往往不高兴。由于MS不是免费软件，所以我想“免费软件”的要求并不是必须的。在这种情况下，Sharepoint服务器可能是更好的选择。不是免费的，但AFAIK拥有您所要求的所有功能，并且仍然可以使用Word、Excel等创建文档。

Answer 3

将规范和文档置于版本控制之下总是更好的做法，因为它会给您带来最大的杠杆，尽管学习曲线会有点陡峭。对于知识引擎，我建议如下

1. 特拉克 -易于使用的错误跟踪系统和知识引擎.用Python编写并可扩展，您将在几分钟内启动并运行。
2. MoinMoin -成熟的wiki引擎。同样，Python具有许多特性

两者都有最小的接口，支持大多数wiki结构，相当容易部署和维护，支持修订，有一个很好的WYSIWYG编辑器，您甚至可以保留您的文档和规范。除非您的项目非常庞大，否则您可以选择上述任何一个。