內部產品文檔

Question

我們有一個已經發展了多年的系統（ASP.NET Web Forms，MySQL），我們正在尋找關於如何記錄以及如何記錄它的指導，以便我們有一個我們可以去了解系統應該如何表現的一個地方。

本文檔將允許開發人員和測試人員識別在我們進行更改時可能會受到的影響。

我們正在構建全面的單元測試，但這項工作仍在進行中，我不認爲單元測試將會是一個很好的，可讀的系統功能描述。

人們如何記錄系統的功能和行爲？你用什麼工具？誰負責文檔？你是否按屏幕組織它？按情景？

Answer 1

我覺得Doxygen對文檔很有用。 （如果這是你使用的語言，它支持C＃）。至於誰負責，我認爲正確的答案是所有的開發人員都應該負責。 Doxygen（和許多其他文檔工具）可以選擇爲沒有記錄的代碼生成警告。

任何開發人員在提交代碼之前都應該檢查是否可以生成一整套文檔。即使是一個相當大的項目，這也只需要幾分鐘的時間來檢查和解決。這比其他人稍後回去並試圖弄清楚發生了什麼要容易得多。

Answer 2

我意識到這是一個老問題，但MindTouch已經花了幾年的時間來開發一個解決方案（MindTouch TCS），它非常適合您描述的內容。 http://www.mindtouch.com/products/mindtouch_tcs

它使產品文檔的協作變得簡單。您可以拖放文件來創建頁面，嵌入視頻，從頁面發送消息，回滾編輯，解決版本衝突等。