4.文檔常見問題
(1)文檔編寫不夠規范。主要表現在軟件項目實施過程中，沒有對每一個階段的文檔進行整理，分層次管理，各類文檔資料缺少一個可以參照的樣本，更多的是在以前他人寫好的基礎上，對內容進行修改一下就算完成任務。
(2)文檔內容描寫不夠完善。在編寫各種文檔過程中，雖然大家都按事先規定的模式進行了編寫，但編寫的內容經常不夠完善，夾雜著一些舊的東西沒有及時更新。特別是一些參數表、用戶手冊等一些由數據中心、分行使用的文檔，由于一時的疏漏，造成軟件項目投產失敗、投產后造成系統宕機、出現賬務差錯、客戶按照你的操作說明不能得到正確的結果等現象的發生。
(3)對文檔評審不夠，使用效果不理想。按照軟件工程的要求，在軟件項目的開發過程中從設計到投產，要編寫一系列的文檔，編寫這些文檔是必須的，但經常會出現這樣的現象，在軟件開發企業，某職能部門負責人員自行制定了文檔模板后，就通知各部門進行使用，結果大家反映效果不好，分析原因是沒有在編寫時很好地依據企業自身的現狀，從實際出發征求大家的意見，對投入使用的文檔沒有組織相關人員進行評審。
(4)重視文檔的形式，實用性不強。在實際的軟件開發過程中，要求編制的文檔非常多，但編制人員沒有時間去關心它們的用途，也不知道哪些部門使用，更多的是在規定的時間內完成任務，以免影響考核成績，這樣一來一些不實用的、重復的文檔編制工作，占用了開發人員有效的設計開發時間，影響了項目的整體進度。因此，軟件文檔的制定要實用，減少繁文縟節的文字工作。
(5)文檔沒有統一入庫管理。隨著系統的不斷優化、升級，新需求的不斷產生，各種文檔越來越多，沒有建立一個文檔資料信息庫，統一存放軟件項目不同時期的各種文檔，零散存在的文檔，造成查詢、統計一個軟件項目完整的文檔信息時非常困難。
(6)對文檔的編制重視不夠。大家常常把文檔作為軟件產品的附件，對待文檔資料沒有像對待程序代碼一樣關注和投入，文檔中普遍存在錯別字、語句涵義表達不清楚，口語化濃厚，引用的圖表不夠準確，主題表達不夠清晰等現象。
(7)對文檔的測試不足。通常測試主要是針對軟件項目功能的測試，對該軟件項目的文檔測試則很少進行。通常用戶把文檔當成了軟件產品的一部分，在軟件產品安裝使用過程中，不正確的提示信息把客戶引入歧途，不但得不到預期的結果，還會產生錯誤，給用戶帶來麻煩。
5.文檔編制要求
(1)標準化：從需求分析開始到投產應用所有涉及的每一種文檔，都要給出一個可以執行的模板，所有完成的文檔從里到外都要非常工整，具有專業水準，符合ISO9000及CMM質量標準要求。
(2)易用性：編制的各種軟件文檔，要便于不同的崗位人員進行閱讀、理解、學習和使用。
(3)簡潔性：要求軟件項目中需要編寫的文檔內容突出主題，只反映要描述的問題，不包含其他不必要的東西，語言表達簡明扼要，一清二楚，如有可能，可以配以適當的圖表，以增強其清晰性。
(4)針對性：文檔要按不同的類型、面對不同的對象，實行差異化編制，根據實際需要進行編寫，也就是說文檔編寫目的要明確，因需而變。例如管理文檔主要面向管理人員，用戶文檔主要面向用戶，這兩類文檔不應像開發文檔(面向開發人員)那樣過多使用軟件的專用術語。
(5)一致性：文檔的行文應當十分確切，對于同一現象的描寫，不能出現多義性的描述，同一項目中幾個文檔描述的內容應當是一致的，相互之間沒有矛盾。
(6)完整性：任何一個文檔都應當是完整的、獨立的，沒有遺漏和丟失的內容。也就是說每一種文檔在設計時可以包含必要的圖形、模型、敘述、表、索引、附錄和參考文獻，列舉的這些內容都是完整的。同一軟件項目涉及的幾個文檔之間可能存在部分內容相同，這種重復是必要的，不要在文檔中出現“見XX文檔XX章節”的現象。
(7)靈活性：在實際操作中要針對軟件項目規模和復雜程度的不同，對現行的文檔進行修正，決定編制的文檔種類�？梢砸罁陨碥浖_發情況，制定一個對文檔編制的規定，用列表的形式列出在項目什么條件下，應該形成哪些文檔，這些文檔的詳細程度。
(8)可追溯性：在軟件項目的開發過程中，各個階段編制的文檔不是孤立的，而是與各個階段完成的工作有密切的關系，隨著項目開發工作的進展，具有一定的繼承關系，體現出了可追溯的特性，如軟件需求會在設計說明書、測試設計方案及用戶手冊中有所體現。
(9)設定優先級：在軟件項目眾多的文檔中，其中一些文檔必定是關鍵文檔，起到非常重要的作用。對于這類文檔要設定優先級別特別關注，不能有任何的錯誤存在，對于一些關鍵的地方要特別標記，特別說明。
6.文檔的審核
審核就是檢查編寫的項目文檔是否齊全有無遺漏，是否符合文檔的規范要求，內容描寫是否正確緊扣主題，列出的圖表信息是否準確，以確保文檔的質量。審核要花費一定的人力和時間，但效果是顯著的。通過對文檔進行全面的審核、充分的測試，有效地發現文檔中存在的問題，如遺漏的需求、多余的功能設計內容、不切實際的測試計劃、不可行的測試方案、不充分的測試案例和不合格的操作手冊等，提前發現問題、改正問題。這樣比客戶使用軟件時遇到麻煩或軟件項目推廣應用中出現問題時再向項目開發人員尋求支持更有效，且能提高客戶的滿意度，減少出錯返工的成本和時間。
7.使用工具管理文檔
對于一個大型的軟件項目系統，從形成概念開始，經過設計、開發、推廣使用和不斷增補修訂，直到最后被淘汰的整個項目生命周期中都要編寫大量的文檔。而文檔編寫的內容是在不斷變化的，有的是連續的，承前啟后的，有的是新增加的，也有的是廢除的，如何管理好這些文檔資料，為大家提供最新的信息，便于日常的調用查詢，便于信息的利用，是發揮文檔作用的重要一環，否則就是占用空間的垃圾。這就需要設計開發一個統一的軟件文檔管理工具，分門別類統一存放管理各種文檔資料，建立軟件文檔資料信息庫，供大家隨時查詢調用。
總之，文檔在軟件項目的開發過程中起到了關鍵的作用，從某種意義上來說，文檔是軟件項目開發規范的體現和指南，按照規范要求編制一整套文檔的過程，就是按照開發規范完成一個軟件項目開發的過程。高質量的文檔可以提高軟件項目的質量，有助于程序員編制程序，有助于管理人員監督和管理軟件的開發，有助于用戶更好地安裝和使用軟件系統，有助于維護人員進行有效的修改和擴充。所以，在軟件項目的開發過程中，要充分做好軟件文檔的編制和管理工作。
文章來源于領測軟件測試網 http://www.kjueaiud.com/