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

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