讀古今文學網 > 程序員必讀之軟件架構 > 產品與項目文檔 >

產品與項目文檔

最後一點,我這裡指的文檔風格是跟所構建的產品有關,而不是創建/改變這個產品的項目 。和我一起工作過的一些組織有將近二十年的軟件系統,儘管它們有不同數量的項目級 文檔,其中卻往往沒有一個能講述產品如何工作、如何演化。通常這些組織有只有一個產品(軟件系統),每一次主要的變化都作為一個單獨項目來管理,結果過去20年中產品發生了巨大的變化,為瞭解軟件當前的狀態,要消化相當數量的項目文檔。在這樣的環境中,新員工往往只能讀讀代碼,跟蹤不同項目組產出的文檔來填補空白,這至少是浪費時間!

我建議軟件團隊為他們構建的每一款軟件系統都創建一份軟件指南。這並不意味著團隊不應該創建項目級別的文檔,但應該有一個地方可以讓人找到關於產品如何工作、如何隨著時間演化的信息。一旦有了這樣的軟件指南,改變一個系統的每一個項目/變化流/時間段就是一個小的增量。每款產品一份軟件指南,使得瞭解軟件當前的狀態變得簡單得多,也為將來的探索提供了非常好的起點。