軟件項目生命周期中的文檔管理[2]

      軟件項目生命周期中的文檔管理[2]   軟件項目管理

　　關鍵字：軟件項目 文檔管理 2

　　4.文檔常見問題

　　(1)文檔編寫不夠規范。主要表現在軟件項目實施過程中，沒有對每一個階段的文檔進行整理，分層次管理，各類文檔資料缺少一個可以參照的樣本，更多的是在以前他人寫好的基礎上，對內容進行修改一下就算完成任務。

　　(2)文檔內容描寫不夠完善。在編寫各種文檔過程中，雖然大家都按事先規定的模式進行了編寫，但編寫的內容經常不夠完善，夾雜著一些舊的東西沒有及時更新。特別是一些參數表、用戶手冊等一些由數據中心、分行使用的文檔，由于一時的疏漏，造成軟件項目投產失敗、投產后造成系統宕機、出現賬務差錯、客戶按照你的操作說明不能得到正確的結果等現象的發生。

　　(3)對文檔評審不夠，使用效果不理想。按照軟件工程的要求，在軟件項目的開發過程中從設計到投產，要編寫一系列的文檔，編寫這些文檔是必須的，但經常會出現這樣的現象，在軟件開發企業，某職能部門負責人員自行制定了文檔模板后，就通知各部門進行使用，結果大家反映效果不好，分析原因是沒有在編寫時很好地依據企業自身的現狀，從實際出發征求大家的意見，對投入使用的文檔沒有組織相關人員進行評審。

　　(4)重視文檔的形式，實用性不強。在實際的軟件開發過程中，要求編制的文檔非常多，但編制人員沒有時間去關心它們的用途，也不知道哪些部門使用，更多的是在規定的時間內完成任務，以免影響考核成績，這樣一來一些不實用的、重復的文檔編制工作，占用了開發人員有效的設計開發時間，影響了項目的整體進度。因此，軟件文檔的制定要實用，減少繁文縟節的文字工作。

　　(5)文檔沒有統一入庫管理。隨著系統的不斷優化、升級，新需求的不斷產生，各種文檔越來越多，沒有建立一個文檔資料信息庫，統一存放軟件項目不同時期的各種文檔，零散存在的文檔，造成查詢、統計一個軟件項目完整的文檔信息時非常困難。

　　(6)對文檔的編制重視不夠。大家常常把文檔作為軟件產品的附件，對待文檔資料沒有像對待程序代碼一樣關注和投入，文檔中普遍存在錯別字、語句涵義表達不清楚，口語化濃厚，引用的圖表不夠準確，主題表達不夠清晰等現象。

　　(7)對文檔的測試不足。通常測試主要是針對軟件項目功能的測試，對該軟件項目的文檔測試則很少進行。通常用戶把文檔當成了軟件產品的一部分，在軟件產品安裝使用過程中，不正確的提示信息把客戶引入歧途，不但得不到預期的結果，還會產生錯誤，給用戶帶來麻煩。

　　5.文檔編制要求

　　(1)標準化：從需求分析開始到投產應用所有涉及的每一種文檔，都要給出一個可以執行的模板，所有完成的文檔從里到外都要非常工整，具有專業水準，符合ISO9000及CMM質量標準要求。

　　(2)易用性：編制的各種軟件文檔，要便于不同的崗位人員進行閱讀、理解、學習和使用。

　　(3)簡潔性：要求軟件項目中需要編寫的文檔內容突出主題，只反映要描述的問題，不包含其他不必要的東西，語言表達簡明扼要，一清二楚，如有可能，可以配以適當的圖表，以增強其清晰性。

　　(4)針對性：文檔要按不同的類型、面對不同的對象，實行差異化編制，根據實際需要進行編寫，也就是說文檔編寫目的要明確，因需而變。例如管理文檔主要面向管理人員，用戶文檔主要面向用戶，這兩類文檔不應像開發文檔(面向開發人員)那樣過多使用軟件的專用術語。

原文轉自：http://www.anti-gravitydesign.com