你用什麼工具/格式來編寫你的規格？

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文檔。