關於軟件工程血的教訓之文檔管理

       文檔管理混亂是上個項目最爲致命和混亂的,我個人認爲,如果一個項目小組進行開發一個系統的時候沒有文檔的開發個人認爲是可怕的,而在系統的開發中沒有對文檔進行有效管理是恐怖的,我們要做的是一個產品,而不是自娛自樂的一個試驗品,作爲產品,必須要標準,無論是客戶給我們的標準還是開發小組給自己的標準,關於標準將在後面做詳細討論。而有標準就必要有相關的文檔,關於文檔的好處大家都清除,無論在軟件開發部署以及維護的任何階段它都扮演着很重要的角色,關於文檔我覺得它不是形式一個開發小組的負責人對文檔的態度就覺得樂這個系統的成敗(說的誇張些)。

除了認真做各個階段的相關文檔外,還要對文檔進行有效管理,下面將說一下這幾年來對文檔管理的一些開發,僅僅是拋磚引玉,歡迎大家補充和牌磚。
   1 文檔必須需要版本。

像軟件一樣,如果不對文檔進行版本管理和控制,文檔的修改將造成文檔的混亂,尤其是比較大的項目,一定對文檔的管理進行版本控制,不然每次文檔修改,想找到什麼時候做樂什麼修改,爲什麼做這次的修改都搞不清楚,後面的程序員的工作就很難開展。


2文檔需要專人負責。

如果一個小組的人手足夠多的話,希望能有一個人來專門負責對文檔管理,如果開發小組的人手緊張需小組某一個人簡直負責,不能每個人都隨意的對所有的文檔都拿來拿去。


3文檔的修改要有嚴格的章程控制。

文檔一旦形成,不能隨意修改,當然形成正式版本的文檔之前一定要認真討論確定文檔,一旦文檔確定後,不能隨意修改,尤其是前期文檔,如需求分析,需求分析一變後面的設計文檔都要變,這樣變來變去會影響到系統的整體進度與軟件的質量。每次修改都要做好記錄爲什麼要做這個修改,修改樂哪些部分 會影響到哪些文檔一定要註明還要包括文檔修改的發起人和批准人。


4 文檔的份數。

個人認爲一個十人以內的開發小組每個版本的文檔只需要一份,尤其是開發階段流傳在程序員手中的文檔儘量只有一份,大家以互相傳閱的方式進行查閱文檔,並不是每個人一份文檔會給項目的進度帶來有利的影響,上一個項目中每次文檔修改後,都給每個人打印一份近千頁的文檔,一是造成了巨大的浪費,二是由於沒有對版本控制好,每個人手裏的文檔不止一份,開始的時候大家還比較清楚到最後,大家都快搞不清應該以哪一份文檔爲準了。

今天就先寫到這裏了,希望大家看後補充 謝謝

發佈了14 篇原創文章 · 獲贊 2 · 訪問量 7萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章