3.軟件開發(fā)文檔管理規(guī)范

軟件項(xiàng)目管理培訓(xùn)講座,系列之三文檔管理規(guī)范,內(nèi)容提要,文檔的分類和等級 文檔管理的原則和方法 文檔示例與討論,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,2,為什么需要文檔管理？,項(xiàng)目管理的依據(jù) 了解進(jìn)度、分析問題，提供項(xiàng)目可預(yù)見性 工作交流的憑證 口說無憑，立字為據(jù) 軟件測試的基礎(chǔ) 沒有文檔，測試人員無法展開工作 培訓(xùn)用戶的參考 幫助外界人員了解項(xiàng)目內(nèi)幕 技術(shù)支持的幫手 幫助技術(shù)支持人員熟悉系統(tǒng)、分析錯(cuò)誤、解決問題 記錄歷史的必須 軟件最大的價(jià)值在于可復(fù)用性,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,3,為什么需要文檔管理？,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,4,按規(guī)范要求生成一整套文檔的過程，就是按照軟件開發(fā)規(guī)范完成一個(gè)軟件開發(fā)的過程。,編寫文檔的基本思路,明確文檔范圍，避免空泛浮躁 大而全的文檔是沒有用的 定位讀者角度，防止對牛彈琴 以讀者能夠理解作為編寫文檔的標(biāo)準(zhǔn) 規(guī)范名詞稱謂，保持前后一致 統(tǒng)一的名詞和稱謂，會降低文檔的歧義性 注重版本控制，切忌顧此失彼 不同階段的文檔記錄了項(xiàng)目開發(fā)的完整過程 應(yīng)用圖文表格，保證內(nèi)容清晰 簡潔的圖形和表格勝過前言萬語,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,5,文檔的分類（1）,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,6,文檔的分類（2）,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,7,文檔的分類（3）,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,8,開發(fā)文檔,可行性研究報(bào)告,項(xiàng)目開發(fā)計(jì)劃,模塊開發(fā)卷宗,測試分析報(bào)告,需求規(guī)格說明書,功能規(guī)格說明書,概要設(shè)計(jì)說明書,詳細(xì)設(shè)計(jì)說明書,數(shù)據(jù)庫設(shè)計(jì)說明書,測試計(jì)劃,文檔的分類（4）,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,9,產(chǎn)品文檔,用戶指南,操作手冊,用戶指南,產(chǎn)品手冊,文檔的分類（5）,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,10,管理文檔,開發(fā)進(jìn)度月報(bào),項(xiàng)目開發(fā)總結(jié),職責(zé)定義,進(jìn)度變更記錄,文檔的等級（1）,確定文檔質(zhì)量等級 根據(jù)項(xiàng)目資源、項(xiàng)目大小和風(fēng)險(xiǎn)確定每個(gè)文檔的格式及詳細(xì)程度 文檔格式和文檔內(nèi)容同樣重要 必須保證文檔的質(zhì)量，文檔管理才有意義,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,11,文檔的等級（2）,文檔按照質(zhì)量可劃分為四個(gè)等級： 最低限度文檔（1級文檔） 適合開發(fā)工作量低于一個(gè)人月的開發(fā)者自用程序 包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介 內(nèi)部文檔（2級文檔） 適合于沒有與其他用戶共享資源的專用程序 1級文檔內(nèi)容，加上足夠的注釋和說明,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,12,文檔的等級（3）,文檔按照質(zhì)量可劃分為四個(gè)等級： 工作文檔（3級文檔） 適合于由同一單位內(nèi)若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序 正式文檔（4級文檔） 適合那些要正式發(fā)行供普遍使用的軟件產(chǎn)品 關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì)（如工資計(jì)算）的程序需要4級文檔,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,13,內(nèi)容提要,文檔的分類和等級 文檔管理的原則和方法 文檔示例與討論,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,14,文檔管理的基本原則,完整性原則 項(xiàng)目文檔集應(yīng)覆蓋軟件開發(fā)的完整流程 簡潔性原則 編寫文檔不應(yīng)浪費(fèi)過多的時(shí)間和經(jīng)歷 有效性原則 文檔必須能夠起到輔助決策、指導(dǎo)參考的作用 延續(xù)性原則 文檔的變化必須有合理依據(jù)，保持連續(xù)發(fā)展,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,15,文檔管理的內(nèi)容,建立文檔規(guī)范，培養(yǎng)良好習(xí)慣 制定編寫計(jì)劃，明確編寫責(zé)任 檢查文檔質(zhì)量，提高利用效率 控制文檔范圍，保護(hù)知識產(chǎn)權(quán) 實(shí)施版本控制，有效記錄歷史,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,16,文檔管理方法：如何命名？,命名規(guī)范的重要性 統(tǒng)一的對外形象（舉例） 有效的文檔分類（舉例） 快速的文檔查找（舉例） 命名規(guī)則的制定 并無統(tǒng)一規(guī)則，依據(jù)項(xiàng)目環(huán)境自定義 技巧1：確定統(tǒng)一的空白封面和項(xiàng)目名稱 技巧2：同類型多個(gè)文檔的命名方法 技巧3：文檔存儲和管理的方法,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,17,文檔管理方法：如何保證內(nèi)容完整？,內(nèi)容殘缺的體現(xiàn) 缺少項(xiàng)目背景和內(nèi)容目錄（舉例） 缺少表格和示意圖（舉例） 缺少對思想的闡述和問題的分析（舉例） 保證內(nèi)容完整的方法 技巧1：提供統(tǒng)一的項(xiàng)目背景資料 技巧2：培養(yǎng)一致的文檔編寫習(xí)慣 技巧3：明確要求表格和圖形的使用方式,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,18,文檔管理方法：如何寫好需求分析,做好需求分析的前提條件 客戶應(yīng)用環(huán)境的了解 市場主流與技術(shù)主流的了解 客戶現(xiàn)有需求的總結(jié)和潛在需求的挖掘 完成需求分析的過程 第一步：項(xiàng)目建議書（Proposal） 第二步：市場與技術(shù)調(diào)研報(bào)告（M&T Report) 第三步：需求變更風(fēng)險(xiǎn)分析 第四步：需求分析初稿,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,19,文檔管理方法：如何寫好概要設(shè)計(jì),做好概要設(shè)計(jì)的前提條件 客戶需求細(xì)節(jié)的了解 技術(shù)重點(diǎn)和難點(diǎn)的分析 系統(tǒng)結(jié)構(gòu)的設(shè)計(jì)與劃分 完成概要設(shè)計(jì)的過程 第一步：功能描述（Function Description） 第二步：功能定義（Function Specification） 第三步：重點(diǎn)難點(diǎn)問題解決思路 第四步：概要設(shè)計(jì)草案,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,20,文檔管理方法：如何寫好詳細(xì)設(shè)計(jì),詳細(xì)設(shè)計(jì)的底線是什么？ 主要處理流程的詳細(xì)說明 對外接口的詳細(xì)說明 主要邏輯結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)的詳細(xì)說明 完成詳細(xì)設(shè)計(jì)的過程 第一步：流程定義（Control Flow） 第二步：數(shù)據(jù)結(jié)構(gòu)定義（Data Flow) 第三步：接口定義（API Specification） 第四步：詳細(xì)設(shè)計(jì)草案,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,21,文檔管理方法：如何寫好里程碑報(bào)告,里程碑報(bào)告的內(nèi)容 預(yù)期目標(biāo)的解釋和說明 已完成工作的說明 進(jìn)度情況、測試結(jié)果的分析和說明 下一步工作的重點(diǎn)和難點(diǎn) 完成里程碑報(bào)告的過程 第一步：分析前一個(gè)里程碑報(bào)告的內(nèi)容 第二步：說明當(dāng)前里程碑的主要進(jìn)展 第三步：總結(jié)存在的問題、困難和障礙 第四步：列出下一個(gè)里程碑的主要工作計(jì)劃,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,22,文檔管理方法：確定最小文檔集,如何確定最小文檔集 重要認(rèn)識：最小文檔集不是指最簡單文檔集 最重要、最必須的文檔組成最小文檔集 如何實(shí)現(xiàn)最小文檔集 人員分工：多人協(xié)作完成一份文檔 文檔格式：提供統(tǒng)一易用的模板 內(nèi)容組織：合并細(xì)節(jié)結(jié)構(gòu)，保持總體完整,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,23,反思：為什么中國人不善于寫文檔？,文化背景的原因 官修史與私修史：從孔子談起 封建專制與思想禁錮：焚書坑儒和文字獄 現(xiàn)代教育的原因 缺乏方法教育和人格教育 缺乏法律意識和嚴(yán)謹(jǐn)態(tài)度 官本位、錢本位的價(jià)值觀,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,24,內(nèi)容提要,文檔的分類和等級 文檔管理的原則和方法 文檔示例與討論,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,25,文檔編寫技巧,文檔排版方法 問題：你會用MS Word嗎？ 圖表制作方法 問題：你會用MS Visio和MS Excel嗎？ 文檔分類結(jié)構(gòu) 問題：如何設(shè)計(jì)良好的文件夾結(jié)構(gòu)？ 文檔命名方式 問題：如何對自己的項(xiàng)目進(jìn)行文檔命名？,2019年10月2日,軟件項(xiàng)目管理培訓(xùn)之三文檔規(guī)范,26,文檔示例與討論,需求分析文檔示例 研發(fā)類項(xiàng)目概要設(shè)計(jì)與詳細(xì)設(shè)計(jì)示例 應(yīng)用類項(xiàng)目概要設(shè)計(jì)與詳細(xì)設(shè)計(jì)示例 數(shù)據(jù)庫與數(shù)據(jù)倉庫類設(shè)計(jì)文檔示例 測試計(jì)劃與測試案例類文檔示例 工作日志、周工作報(bào)告、里程碑報(bào)告文檔示例,2019年10月2日,