规范您可以真正参考的文档

Question

目前我正在使用Visual Source Safe（是的，是的！）来存储我的技术规范文档。

实际的文档是用MS Word编写的。

如果发现以字格式编写的规范是一个很大的负担，为了真正使用规范，不应该有任何使用障碍，更重要的是访问。

如果我无法快速扫描文档，超链接到其他相关文档或部分，那还有什么用呢？

以此为背景：

用什么软件来创建真正可访问的文档？即超链接到其他页面/部分等？甚至可以查询，以便我可以查看所有依赖于模块4.5.3

的文档

它基本上只是一个维基？还有什么吗？

Answer 1

Wiki非常适合创建和维护规范。然而，当你将它放在人们的办公桌上时，很难生成一个令人满意的“砰”一声的大型纸质文件。

我已经接受了Word。只需学会利用它为交叉引用，索引，表格，分页等所有自动化。

我认为规格有两个受众：决策者和开发者。 Word文档适用于决策者。当需要实施规范时，开发人员将在以后提出一些有用的东西。

Answer 2

我相信Word支持子文档的想法（链接到其他文档），但是我不确定它在没有VSS的情况下是如何工作的，更不用说VSS了。但这是需要考虑的事情。

然而，维基是你正在寻找的。

Answer 3

Java具有由javadoc生成的API文档，Python具有由epydoc等工具生成的API文档。

你在做什么语言？您是否为您的语言寻找过javadoc或epydoc等工具？

Answer 4

我们刚刚开始使用Confluence进行技术文档和说明：http://www.atlassian.com/software/confluence/

这是一个功能齐全的基于浏览器的wiki，只需工作开箱即用，但您可以根据自己的内容进行调整。它具有您对专业维基所期望的一切，包括安全性，富文本，超链接和附件;而且它非常直观，甚至我们的非技术人员（以'C'开头的3个字母的标题）也使用它。

如果您访问Atlassian的网站（请参阅上面的链接），您可以玩他们的在线演示......他们会吃自己的狗食以提供社区支持。