我们使用什么工具/格式编写规范?

时间:2020-03-06 14:24:58  来源:igfitidea点击:

我想知道我们使用哪种工具编写规范。我认为使用支持某种纯文本格式的工具非常重要,这样一个人就可以使用诸如SVN之类的源代码控制系统来控制规范。对于规范以及代码,拥有所有更改的历史很重要。

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

因此,请告诉我,我们使用哪种工具或者格式进行规范。

解决方案

我已经开始将Docbook用于所有此类用途。它简单,灵活,并且会生成html,tex(从而生成pdf)等。

我们使用了TeX(MikTeX),它之所以完美,是因为:

  • 纯文本-在Vim /记事本中编辑-随处可见
  • 使用预定义宏进行强大的格式化,我们中的一位
  • onclick生成为PDF

唯一的问题是从ArgoUML中获取图表。

在另一个项目中,我看到使用Word模板从上面直接进行操作。

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

Microsoft Word。我知道它不符合要求,但是在我做的每一项工作中,我都使用Microsoft Word作为规范。我们可以(而且我已经)将Word文档放入源代码管理系统中,唯一失去的就是能够在文档之间进行区分。尽管我确实隐约记得在某处阅读过,但有一些单词差异工具可以使用。

用XXE编辑的DocBook,在需要发送给客户时用xslt转换为pdf。

有史以来最好的更改,更容易编写,更容易合并,而且在转换后,它看起来并不像MSWord那样令人讨厌。

加上结构化的文档样式已经存在,这与流血的单词不同,我们必须为之努力才能开始工作。

在工作中,我们的许多文档都位于Sharepoint或者某些其他文档系统下,这实际上减慢了文档的"发布"速度。这意味着到处都有文档的副本,要有人适当地释放某些东西是一件令人头疼的事情。因此,我通常会收到有关Power Point或者便条纸的规格。因此,我在工作中建立了一个Wiki(媒体Wiki),现在我们保留所有项目规范。这使公司中的任何人都可以查看它们,而我们的开发小组则可以对其进行编辑。有时,开发人员会在经过时或者其他情况下要求老板进行澄清,而开发人员可以自行更新规范,我认为这是一个巨大的优势。另外,当人们使用历史记录以新信息更新规格时,很容易看到最新变化意味着我可以看到以前发生了什么以及现在需要发生什么,这是我的巨大优势。

我仍然在墙上贴一些笔记本纸,以备不时之需。

在工作中,我们使用Wiki,因为它们非常适合协作,但是Microsoft Word可以工作。

我们实际上可以使用Word本身来区分Word文档的两个不同版本,它使用"修订记录"功能来显示差异。 (如果我们不相信我,请尝试使用TortoiseSVN区分两个版本的Word文档。)

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