你如何合作編寫規格？

Question

我正與一個地域分散的開發人員組成的小團隊（另外2人）一起工作，我正在尋找合作規範的好方法......我們認爲我們可能會使用Google文檔編寫規範因此我們都可以在中央位置修改它。

你做了什麼？你有什麼好主意？

Answer 1

如果你有一個內部網或VPN，我真的考慮安裝和使用小百科這些規格。

相比，谷歌文檔，你可以：

1. 好多版本和變更跟蹤（恕我直言）
2. 更容易爲小節開始新文檔
3. 實際的標記，而不是WYSIWYG（的事口味，我更喜歡LaTeX的Word）。
4. 可以附加其他多種文件類型
5. 很容易備份
6. 很容易創建一個離線版本
7. 你不必擔心其他地方存儲敏感材料。

缺點是它不是所見即所得，這對你來說可能是也可能不是問題。

當然，你可以選擇一個支持更好的編輯器，甚至可能是同步協作的Wiki實現。

Answer 2

這不是編程相關的，但我個人使用Google文檔編寫共享文檔，並發現它易於使用。

但是，如果Google服務器暫時關閉或無法連接到互聯網，我會建議啓用Google Gears。

Answer 3

技術的選擇是一個問題，谷歌文檔是一個很好的選擇恕我直言。但真正的挑戰是如何管理流程，例如分任務。

我的建議是首先確保平臺和所有相關技術儘可能地被確定。然後，撰寫一份完整的目錄。精心設計的TOC將使您能夠正確地分配任務，而不是對彼此的工作「分步」。從那時起，你們每個人都會「分享」你們分配的部分，並回顧彼此的工作。

實際上，每個目錄子部分都成爲一個工作原子單位，可由同時對該部分負責的個人分配和維護。

祝你好運！

Answer 4

Google Wave - 正是它的意思爲 - 合作

Answer 5

IMHO，文字處理器是一個程序員錯誤的工具。一個規範應該寫在純文本編輯器，並利用lightweight markup如reStructuredText的，AsciiDoc等

這種做法的好處是：

• 有極好的工具來管理純文本，是已經掌握在程序員手中（VCS，自動化構建系統，diff，補丁，編程編輯器，grep等）
• 標記語言允許表達意圖，而不是格式化。

記住，Wiki似乎是一個明顯的選擇。

個人我的首選工具鏈是：

• reStructuredText作爲標記語言。
• Trac爲維基
• 火狐+的it's all text extension
• 的Emacs + rst-mode

Answer 6

我認爲這取決於

1. 到寫大家都
2. 如果你很可能會在同一時間
3. 無論您打算公佈的規格寫的規格如何嚴重。

Google Docs很不錯，很容易入門。現在您可以一次全部導出文件夾，這也很棒。不過，對於要發佈到網絡上的內容，wiki或常規CMS是一種更好的演示工具。維基還將與您現有的網站進行整合。

如果您有一些小規格，主要由一個人編寫，然後使用您承載項目代碼或網站的任何工具。如果你不可能同時編輯，那麼wiki是好的。

我已經完成了維基事務，傳遞的文檔事情和Google文檔事情。

• 維基事情起點低，持續時間相當長。在一定的規模下，它確實會變得很痛苦。
• 通過文件的東西（寫，電子郵件，編輯，電子郵件等）只能在一個人開始一切時起作用。只要有小的編輯，就會很糟糕。
• 谷歌文檔的事情沒有問題，直到你有幾個文檔和幾個編輯器或想在線發佈。

心連心

Answer 7

對於寫作規範協作，你可以嘗試Gingko。

這是一個卡片樹編輯器，這意味着它是索引卡和大綱之間的混合體，具有實時協作和全面的Markdown支持（以及基本的LaTeX）。

我們仍然缺少一些功能（版本歷史記錄，評論等），但是對於某些樹型結構中的所有內容而言，這些好處超過了這些缺點。

使用它編寫規格非常棒，因爲您可以爲每個用戶故事創建一張卡片，並根據需要隨意鑽取（如果需要，可將其組織成不同類別）。

http://gingkoapp.com