目前的問題包括:
1. 更新不及時;
2. 可讀性差;
3. 面對不同使用者,不同類型文檔的重復性大;
4. 更新工作不能與開發工作進行良好互動。
5. 文檔太多造成了用戶使用文檔上的混亂
以致延伸的問題:
1. 提倡極限編程 - 拋棄文檔的一種團隊開發方式;
a) 問題是:開發團隊需要進行一定的培訓,而且需要客戶配合,不是所有開發團隊都有條件、有能力實行。
2. CMMS開發管理模式 – 硬性規范編寫文檔的和使用文檔的各個方面的標準。
a) 問題是;管理成本很高,導致開發成本高昂
b) 需要項目經理強力管理和推行,否則會出現浪費人力而又沒有收獲的情況
3. 統籌編制基本要求文檔,然后實行單點(功能點)、單人開發;
a) 問題是:對程序內部結構控制不嚴,容易出現協同與質量問題
我的理解:
1. 項目團隊開發需要必要的文檔,這是毫無疑問的,而且有效的文檔越豐富,對項目開發和團隊溝通越有效;
2. 團隊使用文檔、編制文檔是有成本的,文檔越多成文越高,而且增加速度高于文檔數量的線形提升。
3. 項目團隊如果沒有必要的文檔,也是有成本的,而且項目大小、項目開發時間與文檔數量應該成正比,如果缺乏必要的文檔,其溝通成本遠遠要大于補充完成這些文檔所需要的成本。
4. 觀點:項目開發不能沒有開發文檔,同時要降低開發文檔的使用和管理成本。
實現良好的文檔管理的核心要點
1. 減少、取消不必要的開發文檔的編制和使用;
2. 提高開發文檔在團隊中的使用效率;
具體做法:
1.把開發文檔的粒度減少,就是把原來一篇開發文檔,按照模塊或其他要求進行分解,成為多個文檔。
a) 比如說,一個客戶資料管理模塊一般在整個ERP系統中是其中一塊,我們就可以把這個模塊單獨成為一篇文檔,整個ERP系統的完整文檔,就是由這些一個個模塊整合起來。
b) 而就是對于這個“客戶資料管理模塊”,我們也可以繼續分解為:
i. 功能描述部分;
ii. 數據庫設計部分
iii. 內部對象設計部分
iv. 界面描述部分
v. 等等。。。
2.確定開發文檔對應的使用者,編制有針對性的文檔內容,同時這些文章,從分解后的開發文檔中獲取。
a) 比如說上面例子:面向客戶的,只需要提供功能描述和界面描述部分;
b) 面向開發人員,就要包括所有內容;
c) 面向數據庫開發人員的,只需要數據庫設計,內部對象設計,功能要求等部分。
3.那么剩下來的就是如何對這些松散的文檔進行有效管理的問題。對于這個問題,其實可以通過編寫簡單的文檔管理程序進行管理。
這樣做到的話,我們在每個階段都有針對性地文檔來指導開發人員的工作,同時,開發人員又不會被過多文檔淹沒。而且,還可以通過一些管理策略,讓開發人員可以根據開發情況修改部分文檔。
4.然后要關注的一個問題就是這些文檔的版本管理,對于這個問題,可以采用現行版本管理工具來管理或者采用開發行政指引的方式來解決。
通過以上做法,可以緩和開發團隊與開發文檔的對立關系,讓開發文檔真正為團隊工作服務;同時也切實降低了管理成本和開發風險。
延伸閱讀
文章來源于領測軟件測試網 http://www.kjueaiud.com/