文檔是軟件項目開發應用的一部分,存在于軟件項目的整個生命周期之中,沒有正式文檔的軟件項目開發,就不是規范標準的軟件項目。文檔Bug是軟件缺陷的一種表現形式,通?蛻舨⒉恢牢臋n是否存在Bug,如果按照帶有缺陷的文檔進行安裝操作,同樣會造成不良的后果,甚至帶來損失,在實際工作中因文檔質量不高,造成軟件投產后出現系統宕機、賬務扎賬錯誤等生產問題時有發生。因此,文檔的編制和管理在軟件項目開發中占有突出的地位和相當大的工作量,高質量、高效率地設計、編制、分發、管理和維護文檔,對于轉讓、變更、修正、擴充和使用文檔,對于提高軟件項目的質量和客戶滿意度有著重要的現實意義。
1.文檔的涵義
軟件項目中的文檔是用來記錄、描述、展示軟件項目開發過程中一系列信息的處理過程,通過書面或圖示的形式對軟件項目整體活動過程或結果進行描述、定義、規定、報告及認證。它描述和規定了軟件項目開發的每一個細節,使用軟件的操作命令及軟件產品投產以后,對產品使用過程中意見及產品缺陷、質量等方面的說明。
2.文檔的作用 本文轉自項目管理者聯盟
(1)提高了軟件項目開發過程的能見度。標準規范、齊全的文檔,詳細記錄了軟件項目開發過程中發生的事件,便于項目管理人員檢查、掌握軟件開發進度、開發質量以及各種資源的調配,是開發人員進行軟件開發的依據,也是項目成員協調工作的依據。
(2)提高了軟件項目的開發效率。項目成員用一定時間編制、整理軟件文檔,可以使開發人員對各個階段的工作都進行周密思考和理順、找出存在的問題,從而減少差錯,提高軟件項目質量。同時,通過對完成文檔的檢查,在項目開發早期發現軟件文檔的錯誤和不一致性,加以及時糾正,可以減少文檔Bug深入項目而導致的大問題的出現和為糾正這些錯誤而付出的更大的成本。
(3)便于軟件項目成員之間的交流與合作。文檔是一種無聲的語言,它記錄了軟件項目開發過程中有關軟件開發、運行、維護和培訓等方面的信息,這些信息有利于管理人員、開發人員、操作人員、用戶之間的交流和合作,便于軟件項目能在規定的時間、費用內完成開發和投產應用。
(4)方便客戶選購軟件產品。描述清楚、完備的文檔便于客戶了解軟件的功能、性能等各項指標,為客戶選購符合自己需要的軟件提供依據,是在客戶與軟件開發企業之間架起的一座橋梁。
(5)是做好軟件項目投產維護工作的保證。高質量的文檔可以幫助技術人員順利完成軟件的安裝,并及時排除軟件系統運行過程中出現的各種錯誤,可以幫助客戶知道在使用操作過程中出現的錯誤信息含義,及時處理出現的問題并順利完成工作。因此,高質量的文檔是軟件項目順利投產的保障。
(6)有利于操作人員正確操作,減少操作失誤。操作人員對產品的認識更多地是來自有關軟件產品的使用說明文檔,這些文檔可以提高操作人員正確、快速地為客戶辦理業務的質量,做好產品的宣傳,發揮產品性能,為客戶提供周到細致的服務。
(7)有利于客戶正確操作自助設備。描述簡單、正確、清晰的文檔,便于客戶盡快地掌握ATM、POS、網上銀行、手機銀行及自助終端等各種自助設備的操作,方便客戶,增強客戶對金融產品的認知,提高自助設備的使用率和效益。
3.文檔的分類
(1)開發文檔:這類文檔在軟件項目開發過程中,體現了軟件開發人員前一階段工作的成果,同時又是后一階段工作的依據。這類文檔包括可行性研究報告、軟件項目開發計劃、軟件需求規格說明、系統規格說明書、軟件功能說明書和數據字典等。
(2)管理文檔:這類文檔在軟件項目開發過程中,由軟件開發人員制定的需提交管理部門的一些工作計劃、工作方案和工作報告。通過閱讀這些文檔,管理人員能夠了解軟件項目開發活動安排、進度、資源使用等情況。這類文檔包括項目開發計劃、測試計劃、測試方案、開發進度報告和項目總結報告等。
(3)用戶文檔:這類文檔是軟件開發人員為使用該軟件的網點經辦人員準備的有關該軟件產品使用、操作的資料,主要是操作手冊及新功能介紹方面的文檔。
(4)投產文檔:這類文檔主要是軟件開發人員對數據中心、分行科技人員準備的有關投產說明、版本安裝、軟件測試等方面的資料。
(5)記錄文檔:與客戶交流往來的記錄、軟件項目開發過程中各種會議、跟蹤記錄、審查記錄、產品投產記錄和問題跟蹤解決記錄等。
(6)反饋文檔:這類文檔主要是軟件產品在推廣使用以后,客戶對產品使用過程中意見及產品缺陷、質量等方面的信息反饋。
文章來源于領測軟件測試網 http://www.kjueaiud.com/