你用什么工具/格式来编写你的规格？

Question

我想知道你用什么样的工具来编写你的规范。我认为使用支持某种纯文本格式的工具非常重要，以便可以通过像SVN这样的源代码控制系统来控制规格。对于关于代码的规范，重要的是要有所有变化的历史记录。

目前我们以XML格式编写我们的规范。 TeX也可以替代，但对于从未使用过它的人来说很难。

因此，让我知道，什么样的工具，或者您使用的规范格式。

Answer 1

的DocBook与XXE编辑，在需要时转换为PDF文件使用XSLT被发送到客户端。

有史以来最好的变化，因此更容易编写，所以更容易融合，并且当它转换它看起来不那么godawfully作为非专业的MSWord。

加上结构化文档样式已经存在，不像你有得到合作打击血腥的词。

Answer 2

我来使用Docbook所有这些事情。这很容易，灵活，并且会生成html，TEX（因而PDF）等

Answer 3

我们使用的TeX（MIKTEX），它是完美的，因为：

• 感叹文本 - 编辑在VIM /记事本 - 只是到处使用预定义宏自己人做
• 的onclick一代PDF

唯一的问题是在得到图（来自的ArgoUML）

强大的格式化。

在另一个项目中，我看到使用Word模板 - 从上面执行的可怕东西。

我会考虑在Intranet上使用类似wiki/forum的内容。想象一下使用GoogleDocs - 有版本控制，它在线..但不适用于商业开发。

Answer 4

Microsoft Word。我知道它不符合你的要求，但是在我所做的每项工作中，我都使用了Microsoft Word的规范。您可以，也可以将Word文档放在源代码管理系统中 - 您唯一遗失的是能够在文档之间进行区分的能力。尽管我隐约记得在某处阅读可以使用的单词的差异工具。

Answer 5

在工作中我们的很多文件的Sharepoint或其他一些文件系统，真正减慢文档的“释放”去下。这意味着在各处都有文档的副本，让某人正确地发布某些内容是令人头疼的事情。由于这个原因，我通常会收到功率点或废纸的规格。所以我在工作中建立了一个wiki（媒体维基），我们现在保留所有项目规格。这使得他们可以被公司中的任何人查看，并且可以由我们的开发小组编辑。有时候开发人员会在他们经过或者其他任何东西时要求老板澄清，开发人员可以自己更新规范，我认为这是一个巨大的优势。此外，当人们使用历史记录更新新规格信息时，很容易看出最近的变化是什么 - 这意味着我可以看到之前发生的事情以及现在需要发生的事情，我认为这是一个巨大的优势。

我仍然保持这是潦草一些笔记本纸在我的墙上，提醒一个规范。

Answer 6

在工作中，我们使用维基，因为它们非常适合协作，但是Microsoft Word将起作用。

实际上，您可以使用Word本身来区分Word文档的两个不同版本 - 它使用“跟踪更改”功能来显示差异。 （如果你不相信我，请尝试使用TortoiseSVN来区分Word文档的两个版本。）

对于长文档，实际上我比较喜欢Word，因为它非常适合编辑长文档，业务人员更多舒适地使用Word文档。