定義
項目文檔管理,是指在一個系統(軟體)項目開發進程中將提交的文檔進行收集管理的過程。通常,文檔管理在項目開發中不是很受重視,當發現其重要性時,往往為時已晚。整個項目可能因此變得管理混亂,問題產生後無據可查。文檔管理對於一個項目的順利進行有著至關重要的作用,其關鍵性不容忽視。
項目文檔管理涉及範圍廣泛,其內容會根據項目的不同而有所變化。這裡將重點討論金融計算機軟體開發項目中的文檔管理。
首先要了解文檔管理的行業標準。目前ISO認證的企業通用管理規範為軟體系統開發提供了通用的管理規定和行業標準,它涉及文檔管理的整個生命周期。細分文檔的生命周期,一般包括:創建、審批、發布、修改、分發、簽收、追繳、歸檔、廢止與恢復這樣幾個環節。那么當企業需要按照ISO建立標準的文檔管理規範時,將從何入手昵?
對此,首先要將文檔分為普通紙質文檔和電子文檔兩類來討論。通常情況,在一個項目中都會確定專門或兼職的項目文檔管理員。對於紙質文檔,文檔管理員只需要關心如何將其較好地分類歸檔並保存,而之前的各個環節則要由整個項目組共同把握。
就目前業界項目的開發情況來看,電子文檔使用較紙質文檔更為方便、靈活、廣泛。對於電子文檔,我們大可不必頭疼如何管理其整個生命周期。
作用
作為管理完善的項目文檔,管理者完全可以依順它的軌跡看清整個項目進展的脈絡,同時通過對階段性文檔的把握使整個項目質量得到很好的掌控。制定一套完整有序的項目文檔管理規定十分必要,其作用有以下6個方面。 其一,它是項目管理者了解開發進度、存在的問題和預期目標的管理依據。
第二,大多數軟體開發項目會被劃分成若干個任務,並由不同的組去完成。文檔管理則是不同小組任務之間聯繫的重要憑證。
第三,可提供完整的文檔,保證了項目開發的質量。
第四,項目文檔是系統管理員、操作員、用戶、管理者和其他相關人員了解系統如何工作的培訓與參考資料; 第五,項目文檔將為系統維護人員提供維護支持;第六,項目文檔作為重要的歷史檔案將成為新項目的開發資源。
管理規定
從各行業以及每個項目的個性出發,需要管理者結合實際情況制訂出適合自身的文檔管理規定。(軟體文檔管理指南》和《計算機軟體產品開發檔案編制指南 (以下統稱《指南》)為我們提供了相關的指導。
首先要明確關於軟體項目文檔的具體分類。《指南 中提出文檔從重要性和質量要求方面可以分為非正式文檔和正式文檔;從項目周期角度可分為開發文檔、產品文檔、管理文檔;更細緻一點還可分為l4類文檔檔案,具體有:可行性研究報告、項目開發計畫、軟體需求說明書、數據要求說明書、概要設計說明書、詳細設計說明書、資料庫設計說明書、用戶手冊、操作手冊、模組開發卷宗、測試計畫、測試分析報告、開發進度月報、項目開發總結報告。這樣的分類細化了項目進度中各個階段所需管理的文檔。
其次需要將項目文檔進行歸類整理。下面對EDW項目組文檔情況與 軟體文檔管理指南 進行對比分析。通過對比可以看出,沒有規範管理的EDW項目組文檔存在以下4方面的問題。
問題1:項目組在開發初期針對業務部門和科技部門進行了需求及信息調研,可以覆蓋部分軟體需求和數據需求說明書的內容,但卻缺少業務部門對項目需求描述和變更的文檔記錄。這部分文檔需建立相應目錄予以保存。 問題2:對於設計說明,在系統比較複雜的情況下,設計階段應分解成概要設計和詳細設計兩個步驟。目前EDW項目組只對ETL模組提供了概要設計說明書,並沒有單獨的存放目錄,而是同其他設計文檔混亂地放在一起。對於比較複雜的套用開發項目,應將這兩種設計說明文檔分目錄管理。
問題3:在項目測試驗收中,項目組沒有要求將測試計畫文檔和測試結果報告進行規檔,而只重視了測試過程中的問題文檔,因此無法掌控測試進度與質量。
問題4:EDW項目組的工作分為模型設計、ETL、集市套用3個工作小組,對應的文檔管理需要圍繞這3個主題進行。其中模型設計和ETL都是數據倉庫項目實施的模組,而集市套用則包括了建立在數據倉庫基礎上的小項目開發。因此,文檔管理也應該針對這3個部分不同的性質制定管理規則。
通過表l中的對比分析,針對EDW文檔管理存在的問題,EDW項目組最終依據通用規則建立了正式的項目文檔管理規定。具體規定有以下5點。
(1)將文檔分為兩大部分提交管理:項目常規文檔和項目歸檔文檔。常規文檔的提交和使用根據項目組內部小組成員任務的不同進行許可權劃分;項目歸檔文檔由項目管理主管(或項目文檔管理員)將項目中的重要文檔從常規文檔中進行分類歸檔。
(2)常規文檔管理目錄分為項目日常管理文檔和項目流程管理文檔。
(3)日常管理文檔包括項目報告、會議紀要、項目管理模板、重大問題跟蹤、數據質量管理。項目報告又可分為個人周報、小組周報、項目周報、項目簡報,項目簡報。並都按照不同目錄進行分類管理。
(4)提交完整的項目開發、套用開發流程文檔。一般包括:項目計畫、業務需求說明書、數據需求說明書、模組、套用開發文檔、系統測試文檔、詳細設計文檔、系統測試文檔、用戶手冊、上線文檔、培訓資料、系統運行維護等。
(5)所有項目組成員均建立VSS軟體環境下的對套用戶,各自擁有對以上各類文檔的讀、寫、增加、刪除許可權。由各項目小組長保證提交已保存文檔的質量;由文檔管理員或項目經理整體把握項目文檔在各階段的提交情況。 項目文檔管理規範制定好之後,關鍵在於大家要“依規執行”,使雜亂無章的存放模式變得井井有條。
理念工具
領度企業執行與溝通平台做文檔管理功能時,決定不僅僅採用選單化模式提供上傳文檔的方式,而是在工作匯報時同步進行文檔管理,即無論因任何工作匯報中上傳的附屬檔案,都將按“項目——任務——事件”的位置編號方式自動歸檔在文檔庫中。位置編號的方式記錄了文檔的產生的完整過程:人、時間、事情,點擊文檔編號的時候不僅能夠下載到文檔,而且能查看到完整的文檔上下文關係,因此能夠保留這些知識及產生知識的過程。文檔分類管理不但可以按項目、用戶、群組進行分類,還可以加“標籤”整體管理這些文檔,形成企業知識庫。
1.豐富的文檔信息。
2.文檔分類管理。