協作編碼和文檔

Question

在一項新的研究工作中，我將成爲清理相當廣泛Java代碼庫（7年以上開發）的長期努力的一部分。它目前駐留在SVN上，但我正在考慮Mercurial。

也許有兩種類型的人在項目上合作。類型1：將開發大量代碼和編寫文檔的人員。類型2：代碼使用者，對文檔和可用性有很好的建議。

我想象的工作流程如下所示：

1. 開發人員審查的代碼段和（重新）寫文檔（代碼的Javadoc/Doxygen的風格）
2. 開發者提交的代碼
3. 版本服務器更新HTML文檔
4. 類型2的用戶可以查看文檔並在文檔頁面本身發表評論（wiki風格？）。合作者可以在這裏討論。
5. 開發商看評論，然後轉到步驟1.

我要找約約工具所提出的工作流程和想法，這將有助於實現它的任何建議。謝謝！

Answer 1

我強烈建議一個提交郵件列表：通過使改變大家很容易看到，因爲它們發生的事情，我們的代碼審查是顯著更好：錯誤是較早抓住，提出了修訂建議，而代碼仍然是在開發人員的頭腦清新，每個人都更加意識到團隊中其他人正在做什麼。

Answer 2

我建議你直接讓第2類（客戶？）人團隊的一部分，這樣他們可以立即幫助開發人員，而不必寫文檔。

這應該更快，因爲它增加了溝通並極大地縮短了反饋循環。