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

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

实际文档是用MS word编写的

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

如果我不能快速扫描文档、超链接到其他从属文档或部分，那么这些又有什么用呢

以此为背景：

有什么软件可以创建真正可访问的文档？i、 e.指向其他页面/章节等的超链接？甚至可以查询，以便查看依赖于模块4.5.3的所有文档

---

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

我相信Word支持子文档（指向其他文档的链接）的想法，但是我不确定没有VSS它的效果如何，更不用说VSS了。但这是需要调查的

---

然而，wiki正是您所需要的。wiki非常适合创建和维护规范。然而，当你把一个大文件放在人们的桌子上时，很难产生一个令人满意的“砰砰”声

我已经听得通了。只要学会利用它在交叉引用、索引、表、分页等方面的所有自动化功能

---

我认为规范有两个受众：决策者和开发者。Word文档是供决策者使用的。开发人员稍后将在实现规范时提出一些有用的东西。

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

---

你用什么语言工作？你有没有为你的语言寻找像javadoc或epydoc这样的工具

我们刚刚开始将Confluence用于技术文档和注释：

这是一个功能齐全的基于浏览器的wiki，它只是开箱即用，尽管你可以根据自己的内心内容对其进行调整。它提供了专业维基的所有功能，包括安全性、富文本、超链接和附件；即使是我们的非技术人员（以“C”开头的三个字母的标题）也可以很直观地使用它

---

如果你访问Atlassian的网站（见上面的链接），你可以玩他们的在线演示。。。他们吃自己的狗粮来提供社区支持。

“当你把一份大的纸质文件放在人们的桌子上时，很难产生令人满意的“砰砰”声。”在许多地方，这实际上是一项多么令人沮丧的要求。实际上，没有人会读那些“砰”的文件。它们经常被用作政治足球。维基+1。对于thud文档，使用一个页面获取器、一个“内容”页面以及粘贴到grin word中的一些技巧可能会奏效。使用Linkify addin从源代码链接回wiki（）api文档和规范文档不是不同的东西吗？有些人可以互换使用这些术语。我们用狮身人面像制作我们的设计（我知道是什么）；我们的API和epydoc在一起。我真的不知道什么是“规格”。如果spec==design，那么我的答案就没用了。我不知道斯芬克斯？他们是这些家伙吗：我每次访问他们的页面都会超时。我对规格的理解是，这是在设计（或设计的初始阶段）过程之前。以一种冷静、易于使用的方式生成文档。Wiki很好，但如果可以的话，可以从Confluence运行。@sorin:为什么？如果伴随着解释，意见和建议会更有帮助。汇流适合我们（相当基本）的需求，甚至从不打嗝。你有问题吗？