6

我想知道您使用哪种工具来编写规范。我认为使用支持某种纯文本格式的工具是必不可少的，这样人们就可以使用像 SVN 这样的源代码控制系统来控制规范。对于规范和代码一样，拥有所有更改的历史记录很重要。

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

所以让我知道，你使用什么样的工具或格式来制定规范。

4

6 回答 6

4

DocBook 使用 XXE 编辑，在需要发送给客户时使用 xslt 翻译成 pdf。

有史以来最好的改变，更容易编写，更容易合并，而且当它被转换时，它看起来不像 MSWord 那样不专业。

再加上结构化的文档样式已经存在，不像你必须与之斗争才能开始工作的血腥词。

于 2008-09-19T07:19:51.233 回答
1

我们使用了 TeX (MikTeX)，它非常完美，因为：

  • 纯文本 - 在 Vim/记事本中编辑 - 无处不在
  • 我们中的一个人使用预定义的宏进行了强大的格式化
  • onclick 生成为 PDF

唯一的问题是获取图表（来自 ArgoUML）。

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

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

于 2008-09-19T07:13:37.443 回答
1

在工作中，我们的许多文档都在 Sharepoint 或其他一些真正减慢文档“发布”速度的文档系统下。这意味着到处都有文件的副本，让某人正确发布某些东西是一件令人头疼的事情。因此，我通常会收到电源点或废纸上的规格。所以我在工作中建立了一个 wiki (Media Wiki)，我们现在将所有项目规范保存在其中。这使公司中的任何人都可以查看它们，并且可以由我们的开发团队进行编辑。有时开发人员会在他们经过或其他任何事情时要求老板澄清，并且开发人员可以自己更新规范，我认为这是一个巨大的优势。还，

我仍然保留在我墙上的一些笔记本纸上潦草的规格作为提醒。

于 2008-09-22T04:36:39.017 回答
0

我已经开始使用Docbook来处理所有这些事情。它简单、灵活，可以生成 html、tex（以及 pdf）等。

于 2008-09-19T07:10:52.363 回答
0

微软Word。我知道它不符合您的要求，但在我从事的每项工作中，我都使用 Microsoft Word 作为规范。您可以，而且我已经将 Word 文档放在源代码控制系统中 - 您唯一失去的就是区分文档的能力。尽管我隐约记得在某处读到过可以使用单词的差异工具。

于 2008-09-19T07:13:44.570 回答
0

在工作中，我们使用 wiki，因为它们非常适合协作，但 Microsoft Word 也可以。

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

对于长文档，我实际上更喜欢 Word 而不是 wiki，因为它非常适合编辑长文档，而且商务人士更喜欢使用 Word 文档。

于 2008-10-16T04:01:02.520 回答