軟件項(xiàng)目生命周期中的文檔管理

申請免費(fèi)試用、咨詢電話：400-8352-114

文檔是軟件項(xiàng)目開發(fā)應(yīng)用的一部分，存在于軟件項(xiàng)目的整個(gè)生命周期之中，沒有正式文檔的軟件項(xiàng)目開發(fā)，就不是規(guī)范標(biāo)準(zhǔn)的軟件項(xiàng)目。文檔Bug是軟件缺陷的一種表現(xiàn)形式，通?？蛻舨⒉恢牢臋n是否存在Bug，如果按照帶有缺陷的文檔進(jìn)行安裝操作，同樣會(huì)造成不良的后果，甚至帶來損失，在實(shí)際工作中因文檔質(zhì)量不高，造成軟件投產(chǎn)后出現(xiàn)系統(tǒng)宕機(jī)、賬務(wù)扎賬錯(cuò)誤等生產(chǎn)問題時(shí)有發(fā)生。因此，文檔的編制和管理在軟件項(xiàng)目開發(fā)中占有突出的地位和相當(dāng)大的工作量，高質(zhì)量、高效率地設(shè)計(jì)、編制、分發(fā)、管理和維護(hù)文檔，對于轉(zhuǎn)讓、變更、修正、擴(kuò)充和使用文檔，對于提高軟件項(xiàng)目的質(zhì)量和客戶滿意度有著重要的現(xiàn)實(shí)意義。
　　1.文檔的涵義
　　軟件項(xiàng)目中的文檔是用來記錄、描述、展示軟件項(xiàng)目開發(fā)過程中一系列信息的處理過程，通過書面或圖示的形式對軟件項(xiàng)目整體活動(dòng)過程或結(jié)果進(jìn)行描述、定義、規(guī)定、報(bào)告及認(rèn)證。它描述和規(guī)定了軟件項(xiàng)目開發(fā)的每一個(gè)細(xì)節(jié)，使用軟件的操作命令及軟件產(chǎn)品投產(chǎn)以后，對產(chǎn)品使用過程中意見及產(chǎn)品缺陷、質(zhì)量等方面的說明。
　　2.文檔的作用
　?。?）提高了軟件項(xiàng)目開發(fā)過程的能見度。標(biāo)準(zhǔn)規(guī)范、齊全的文檔，詳細(xì)記錄了軟件項(xiàng)目開發(fā)過程中發(fā)生的事件，便于項(xiàng)目管理人員檢查、掌握軟件開發(fā)進(jìn)度、開發(fā)質(zhì)量以及各種資源的調(diào)配，是開發(fā)人員進(jìn)行軟件開發(fā)的依據(jù)，也是項(xiàng)目成員協(xié)調(diào)工作的依據(jù)。
　?。?）提高了軟件項(xiàng)目的開發(fā)效率。項(xiàng)目成員用一定時(shí)間編制、整理軟件文檔，可以使開發(fā)人員對各個(gè)階段的工作都進(jìn)行周密思考和理順、找出存在的問題，從而減少差錯(cuò)，提高軟件項(xiàng)目質(zhì)量。同時(shí)，通過對完成文檔的檢查，在項(xiàng)目開發(fā)早期發(fā)現(xiàn)軟件文檔的錯(cuò)誤和不一致性，加以及時(shí)糾正，可以減少文檔Bug深入項(xiàng)目而導(dǎo)致的大問題的出現(xiàn)和為糾正這些錯(cuò)誤而付出的更大的成本。
　?。?）便于軟件項(xiàng)目成員之間的交流與合作。文檔是一種無聲的語言，它記錄了軟件項(xiàng)目開發(fā)過程中有關(guān)軟件開發(fā)、運(yùn)行、維護(hù)和培訓(xùn)等方面的信息，這些信息有利于管理人員、開發(fā)人員、操作人員、用戶之間的交流和合作，便于軟件項(xiàng)目能在規(guī)定的時(shí)間、費(fèi)用內(nèi)完成開發(fā)和投產(chǎn)應(yīng)用。
　?。?）方便客戶選購軟件產(chǎn)品。描述清楚、完備的文檔便于客戶了解軟件的功能、性能等各項(xiàng)指標(biāo)，為客戶選購符合自己需要的軟件提供依據(jù)，是在客戶與軟件開發(fā)企業(yè)之間架起的一座橋梁。
　?。?）是做好軟件項(xiàng)目投產(chǎn)維護(hù)工作的保證。高質(zhì)量的文檔可以幫助技術(shù)人員順利完成軟件的安裝，并及時(shí)排除軟件系統(tǒng)運(yùn)行過程中出現(xiàn)的各種錯(cuò)誤，可以幫助客戶知道在使用操作過程中出現(xiàn)的錯(cuò)誤信息含義，及時(shí)處理出現(xiàn)的問題并順利完成工作。因此，高質(zhì)量的文檔是軟件項(xiàng)目順利投產(chǎn)的保障。
　　（6）有利于操作人員正確操作，減少操作失誤。操作人員對產(chǎn)品的認(rèn)識(shí)更多地是來自有關(guān)軟件產(chǎn)品的使用說明文檔，這些文檔可以提高操作人員正確、快速地為客戶辦理業(yè)務(wù)的質(zhì)量，做好產(chǎn)品的宣傳，發(fā)揮產(chǎn)品性能，為客戶提供周到細(xì)致的服務(wù)。
　　（7）有利于客戶正確操作自助設(shè)備。描述簡單、正確、清晰的文檔，便于客戶盡快地掌握ATM、POS、網(wǎng)上銀行、手機(jī)銀行及自助終端等各種自助設(shè)備的操作，方便客戶，增強(qiáng)客戶對金融產(chǎn)品的認(rèn)知，提高自助設(shè)備的使用率和效益。
　　3.文檔的分類
　?。?）開發(fā)文檔：這類文檔在軟件項(xiàng)目開發(fā)過程中，體現(xiàn)了軟件開發(fā)人員前一階段工作的成果，同時(shí)又是后一階段工作的依據(jù)。這類文檔包括可行性研究報(bào)告、軟件項(xiàng)目開發(fā)計(jì)劃、軟件需求規(guī)格說明、系統(tǒng)規(guī)格說明書、軟件功能說明書和數(shù)據(jù)字典等。
　　（2）管理文檔：這類文檔在軟件項(xiàng)目開發(fā)過程中，由軟件開發(fā)人員制定的需提交管理部門的一些工作計(jì)劃、工作方案和工作報(bào)告。通過閱讀這些文檔，管理人員能夠了解軟件項(xiàng)目開發(fā)活動(dòng)安排、進(jìn)度、資源使用等情況。這類文檔包括項(xiàng)目開發(fā)計(jì)劃、測試計(jì)劃、測試方案、開發(fā)進(jìn)度報(bào)告和項(xiàng)目總結(jié)報(bào)告等。
　?。?）用戶文檔：這類文檔是軟件開發(fā)人員為使用該軟件的網(wǎng)點(diǎn)經(jīng)辦人員準(zhǔn)備的有關(guān)該軟件產(chǎn)品使用、操作的資料，主要是操作手冊及新功能介紹方面的文檔。
　　（4）投產(chǎn)文檔：這類文檔主要是軟件開發(fā)人員對數(shù)據(jù)中心、分行科技人員準(zhǔn)備的有關(guān)投產(chǎn)說明、版本安裝、軟件測試等方面的資料。
　?。?）記錄文檔：與客戶交流往來的記錄、軟件項(xiàng)目開發(fā)過程中各種會(huì)議、跟蹤記錄、審查記錄、產(chǎn)品投產(chǎn)記錄和問題跟蹤解決記錄等。
　?。?）反饋文檔：這類文檔主要是軟件產(chǎn)品在推廣使用以后，客戶對產(chǎn)品使用過程中意見及產(chǎn)品缺陷、質(zhì)量等方面的信息反饋。
　　4.文檔常見問題
　?。?）文檔編寫不夠規(guī)范。主要表現(xiàn)在軟件項(xiàng)目實(shí)施過程中，沒有對每一個(gè)階段的文檔進(jìn)行整理，分層次管理，各類文檔資料缺少一個(gè)可以參照的樣本，更多的是在以前他人寫好的基礎(chǔ)上，對內(nèi)容進(jìn)行修改一下就算完成任務(wù)。
　　（2）文檔內(nèi)容描寫不夠完善。在編寫各種文檔過程中，雖然大家都按事先規(guī)定的模式進(jìn)行了編寫，但編寫的內(nèi)容經(jīng)常不夠完善，夾雜著一些舊的東西沒有及時(shí)更新。特別是一些參數(shù)表、用戶手冊等一些由數(shù)據(jù)中心、分行使用的文檔，由于一時(shí)的疏漏，造成軟件項(xiàng)目投產(chǎn)失敗、投產(chǎn)后造成系統(tǒng)宕機(jī)、出現(xiàn)賬務(wù)差錯(cuò)、客戶按照你的操作說明不能得到正確的結(jié)果等現(xiàn)象的發(fā)生。
　?。?）對文檔評審不夠，使用效果不理想。按照軟件工程的要求，在軟件項(xiàng)目的開發(fā)過程中從設(shè)計(jì)到投產(chǎn)，要編寫一系列的文檔，編寫這些文檔是必須的，但經(jīng)常會(huì)出現(xiàn)這樣的現(xiàn)象，在軟件開發(fā)企業(yè)，某職能部門負(fù)責(zé)人員自行制定了文檔模板后，就通知各部門進(jìn)行使用，結(jié)果大家反映效果不好，分析原因是沒有在編寫時(shí)很好地依據(jù)企業(yè)自身的現(xiàn)狀，從實(shí)際出發(fā)征求大家的意見，對投入使用的文檔沒有組織相關(guān)人員進(jìn)行評審。