你使用什么工具/格式来编写你的规范?[关闭]

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

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

此外,结构化文档样式已经存在,不像你必须与之斗争才能工作的血腥单词。

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

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

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

在另一个项目中,我看到了使用Word模板——从上面指导的糟糕的东西。

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

在工作中,我们的许多文档都在Sharepoint或其他文档系统下,这确实会减缓文档的“发布”速度。这意味着到处都是文件的副本,让某人正确发布某些内容是一件令人头疼的事情。因此,我通常会收到电源插座或废纸上的规格。因此,我在工作中建立了一个维基(媒体维基),我们现在将所有项目规范都保存在其中。这使得公司中的任何人都可以查看这些规范,我们的开发团队也可以对其进行编辑。有时,开发人员会在老板经过时或其他时候要求老板澄清,开发人员可以自己更新规范,我认为这是一个巨大的优势。此外,当人们使用历史记录用新信息更新规范时,很容易看到最近的变化是什么——这意味着我可以看到以前发生了什么,现在需要发生什么,我认为这是一个巨大的优势。

我仍然保留着一份写在墙上笔记本纸上的规格,作为提醒。

我是来用的 Docbook 对于所有这些事情。它简单、灵活,可以生成html、tex(以及pdf)等。

微软Word。我知道它不符合你的要求,但在我做的每一份工作中,我都使用了微软Word作为规范。你可以,我也有,把Word文档放在源代码管理系统中——你唯一失去的就是在文档之间进行区分的能力。虽然我依稀记得在某个地方读到过,有不同的单词工具可以使用。

在工作中,我们使用维基,因为它们非常适合协作,但微软Word也可以。

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

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