IT软件项目文档管理课件

IT軟體專案文檔管理

10.1軟體專案文檔管理概述

10.1.1專案文檔管理的概念10.1.2專案文檔的分類10.1.3過程文檔10.1.4產品文檔10.1.1專案文檔管理的概念

能作為開發組員之間交流溝通的媒介。能為軟體專案的維護工程師提供有關資訊系統的資料和知識庫。能為專案管理者提供專案計畫、預算、開發進度等各方面的資訊。能作為最終用戶或管理員的用戶手冊，使用戶知道如何使用、維護及管理系統。概念屬性：10.1.2專案文檔的分類過程文檔，是指那些記錄軟體專案開發和維護過程的文檔資料，專案的計畫、進度、過程品質、組織及專案標準等都是過程文檔。產品文檔，是那些描述正在開發的產品的資料。這類文檔又可以分為從軟體工程師開發和維護系統的角度描述產品的系統文檔，以及主要以客戶為對象描述產品的用戶文檔。文檔可分為以下兩大類，即過程文檔和產品文檔：10.1.3過程文檔軟體專案計畫、預測和進度安排文檔：這些文檔由專案經理負責產生，以便預測和控制軟體的開發過程。相關報告：這些文檔用來報告在軟體開發過程中，資源是如何分配和利用的。標準報告：這些文檔規定了軟體過程應該如何實現，這些可以是國際標準、國家標準、行業標準等。工作文檔：這些文檔是在專案開發中最主要的交流溝通工具，記錄了軟體專案開發中軟體工程師的想法等。備忘錄及電子資訊：主要記錄了每天專案經理和開發人員之間的詳細交流資訊。過程文檔可以分為如下幾類：

10.1.4產品文檔(1) 系統功能描述(2) 初級使用手冊(3) 系統參考手冊(4) 系統安裝文檔(5) 系統管理員手冊產品文檔可以分為用戶文檔和系統文檔：

用戶文檔包括：10.1.4產品文檔系統管理員嚮導系統評估員功能性描述描述提供的服務系統管理員安裝描述怎樣安裝系統新用戶初級使用手冊如何開始使用系統老用戶參考手冊所有系統功能的詳細描述系統管理員如何操作和維護系統圖10.1需要隨軟體系統發佈而產生的部分用戶文檔10.1.4產品文檔需求文檔及相關的基本原理說明。系統體系結構文檔。對系統的每一個程式，都有相應的程式體系結構文檔。每個子系統的規範和設計說明書。程式代碼列表。這些列表包括程式注釋、用來解釋代碼中複雜代碼段和採用的編碼方法等。描述每個程式怎樣驗證和驗證資訊與需求之間關係的驗證文檔。維護指導文檔，主要描述系統已知的問題、軟體支持、硬體支持等資訊，以便維護時使用。系統文檔包括：10.2專案文檔的品質10.2.1專案文檔結構10.2.2文檔標準10.2.3文檔書寫風格10.2.1專案文檔結構主要資訊：標題：專案：文檔ID：文檔類型：版本：日期：作者：是否被檢查：是/否是否被同意：N/A提交給CM：CM_ID：發佈：密級：關鍵字：圖10.2專案文檔封面的主要資訊10.2.2文檔標準過程標準：這種標準定義了高質量文檔應該遵守的過程。產品標準：這種標準操縱文檔本身。交互標準：通過電子郵件和文檔資料庫交換文檔變得越來越重要，交互標準使得所有的文檔都存在可比性。包括：10.2.2文檔標準階段2：修改階段1：編制編寫最初文檔評審文檔整理評審意見修改文檔校對文字最終文檔確認最終文檔設計文檔復審文檔列印文檔列印備份文檔階段3：發佈圖10.3文檔編制過程10.2.3文檔書寫風格運用主動的而不是被動的語氣。

運用正確的術語和語法結構。

句子不宜過長，儘量用短句。段落簡短。用詞簡潔，不要長篇累犢。簡明定義用到的專業術語。應用標題和子標題。盡可能地逐條列舉事實。不要單純地參考數字、圖、表來理解資訊，應當有一定的說明和注釋。編寫文檔時，也應該注意以下問題：10.3專案文檔準備

文檔製作：文字處理器、文本格式器、表格和公式編輯器、繪圖工具包等。文檔修改：拼寫檢查器和風格檢查器。文檔產品發佈：桌面發佈包、技術工作包等。文檔的準備分3個階段：10.3專案文檔準備文檔管理系統：文檔索引文檔管理系統配置管理系統文檔參考用戶請求圖10.4文檔管理文檔資料庫10.4主要專案文檔

10.4.1專案開發立項報告10.4.2可行性研究報告10.4.3專案開發計畫報告10.4.4專案分析報告10.4.5專案設計報告10.4.6程式設計報告10.4.7專案測試報告10.4.8專案使用與維護手冊10.4.9專案評價報告10.4.10專案開發總結報告

10.4.1專案開發立項報告(1)概述：概述現行系統的組織結構、功能、業務流程以及存在的主要問題。(2)新系統的目標：開發新系統的意義和新系統實現後的功能、技術指標、安全和保密性、新系統運行環境等。(3)經費預測和經費來源。(4)專案進度和完成期限。(5)驗收標準和方法。(6)移交的文檔資料。(7)開始可行性研究的組織隊伍、機構與預算。(8)其他需要說明的有關問題。包括以下內容

:10.4.2可行性研究報告(1)系統概述。(2)新系統的目標、要求和約束。(3)可行性研究的基本準則。(4)現行系統描述及現行系統存在的主要問題。(5)新系統對現行系統的影響。(6)投資與效益分析。(7)其他可選方案及國內外同類方案的比較。(8)有關建議。包括以下內容

:10.4.3專案開發計畫報告(1)概述：主要包括系統開發的主要目標、基本方針、參加人員、工作階段和內容等。(2)開發計畫：系統開發各個工作階段或者子項目的劃分、任務、分工、負責人、計畫時間(開始及結束時間)、人力資源需求、資金及設備消耗、實際執行情況等。可以用工作進度表、甘特圖、網路圖及關鍵路徑法等工具輔助管理。(3)驗收標準：每項工作完成後驗收的標準，包括時間、資金、品質等。(4)協調方法：專案開發中各個單位、階段之間的銜接、協調方法、負責人、許可權等。包括以下內容

:10.4.4專案分析報告(1)概述。(2)系統需求。(3)新系統的目標與新鮮系統的功能。(4)新系統的邏輯模型。(5)新系統的運行環境。(6)新系統的驗收標準與培訓計畫。包括以下內容

:10.4.5專案設計報告(1)系統概述。(2)系統總體結構。(3)電腦系統配置方案。(4)代碼設計。(5)檔/資料庫設計。(6)輸入輸出設計。(7)電腦處理過程設計。(8)介面及通信環境設計。(9)安全保密設計。(10)數據準備。(11)系統測試計畫。(12)培訓計畫。包括以下內容

:10.4.6程式設計報告

(1)概述。(2)程式結構圖。(3)程式控制圖。(4)演算法。(5)程式流程圖。(6)根源程式。(7)程式注釋及說明。包括以下內容

:10.4.7專案測試報告(1)概述：說明專案測試的目的。(2)測試環境：有關軟、硬體、通信、資料庫、人員等情況。(3)測試內容：系統、子系統、模組的名稱、性能技術指標等。(4)測試方案：測試的方法、測試數據、測試步驟、測試中故障的解決方案等。(5)測試結果：測試的實際情況。(6)結論：專案功能評價、性能技術指標評價、結論。包括以下內容

:10.4.8專案使用與維護手冊(1)概述：主要包括系統功能、系統運行環境(軟硬體環境)、系統安裝等內容。(2)使用說明：系統操作使用說明較為詳細地說明了操作的目的、過程、方式、輸入輸出的數據等。最好將系統操作的介面圖放入說明書中，便於使用者學習與操作。(3)問題解釋：解釋了系統使用中可能出現的問題及解決辦法，如非常規操作命令、系統恢復過程及意外情況、與開發單位的聯繫方式等。包括以下內容

:10.4.9專案評價報告(1)概述。(2)系統構成。(3)系統達到設計目標的情況。(4)系統的可靠性、安全性、保密性、可維護性等狀況。(5)系統的經濟效益與社會效益的評價。(6)總結性評價。包括以下內容

:10.4.10專案開發總結報告(1)概述：包括專案的提供者、開發者、用戶；專案開發的主要依據；專案開發的目的；專案開發的可行性分析等。