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

1、編輯課件軟件項目管理培訓(xùn)講座軟件項目管理培訓(xùn)講座系列之三系列之三文檔管理規(guī)范文檔管理規(guī)范3/11/2022編輯課件2內(nèi)容提要內(nèi)容提要文檔的分類和等級文檔的分類和等級文檔管理的原則和方法文檔管理的原則和方法文檔示例與討論文檔示例與討論3/11/2022編輯課件3為什么需要文檔管理？為什么需要文檔管理？項目管理的依據(jù)項目管理的依據(jù)了解進度、分析問題，提供項目可預(yù)見性了解進度、分析問題，提供項目可預(yù)見性工作交流的憑證工作交流的憑證口說無憑，立字為據(jù)口說無憑，立字為據(jù)軟件測試的基礎(chǔ)軟件測試的基礎(chǔ)沒有文檔，測試人員無法展開工作沒有文檔，測試人員無法展開工作培訓(xùn)用戶的參考培訓(xùn)用戶的參考幫助外界人員了解項目

2、內(nèi)幕幫助外界人員了解項目內(nèi)幕技術(shù)支持的幫手技術(shù)支持的幫手幫助技術(shù)支持人員熟悉系統(tǒng)、分析錯誤、解決問題幫助技術(shù)支持人員熟悉系統(tǒng)、分析錯誤、解決問題記錄歷史的必須記錄歷史的必須軟件最大的價值在于可復(fù)用性軟件最大的價值在于可復(fù)用性3/11/2022編輯課件4為什么需要文檔管理？為什么需要文檔管理？3/11/2022編輯課件5編寫文檔的基本思路編寫文檔的基本思路明確文檔范圍，避免空泛浮躁明確文檔范圍，避免空泛浮躁大而全的文檔是沒有用的大而全的文檔是沒有用的定位讀者角度，防止對牛彈琴定位讀者角度，防止對牛彈琴以讀者能夠理解作為編寫文檔的標準以讀者能夠理解作為編寫文檔的標準規(guī)范名詞稱謂，保持前后一致規(guī)范名

3、詞稱謂，保持前后一致統(tǒng)一的名詞和稱謂，會降低文檔的歧義性統(tǒng)一的名詞和稱謂，會降低文檔的歧義性注重版本控制，切忌顧此失彼注重版本控制，切忌顧此失彼不同階段的文檔記錄了項目開發(fā)的完整過程不同階段的文檔記錄了項目開發(fā)的完整過程應(yīng)用圖文表格，保證內(nèi)容清晰應(yīng)用圖文表格，保證內(nèi)容清晰簡潔的圖形和表格勝過前言萬語簡潔的圖形和表格勝過前言萬語3/11/2022編輯課件6文檔的分類（文檔的分類（1 1）類型類型讀者讀者時間時間可行性研究報告可行性研究報告管理管理/ /研發(fā)人員研發(fā)人員可行性研究與計劃階段可行性研究與計劃階段項目開發(fā)計劃項目開發(fā)計劃管理管理/ /研發(fā)人員研發(fā)人員可行性研究、需求分析階段可行性研究、

4、需求分析階段設(shè)設(shè)需求規(guī)格說明書需求規(guī)格說明書研發(fā)人員研發(fā)人員需求分析階段需求分析階段計計功能規(guī)格說明書功能規(guī)格說明書研發(fā)人員研發(fā)人員需求分析階段需求分析階段開開概要設(shè)計說明書概要設(shè)計說明書研發(fā)研發(fā)/ /維護人員維護人員設(shè)計階段設(shè)計階段發(fā)發(fā)詳細設(shè)計說明書詳細設(shè)計說明書研發(fā)研發(fā)/ /維護人員維護人員設(shè)計階段設(shè)計階段類類數(shù)據(jù)庫設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書研發(fā)研發(fā)/ /維護人員維護人員設(shè)計階段設(shè)計階段模塊開發(fā)卷宗模塊開發(fā)卷宗管理管理/ /研發(fā)研發(fā)/ /維護人員維護人員實現(xiàn)、測試階段實現(xiàn)、測試階段測試計劃測試計劃研發(fā)人員研發(fā)人員需求分析、設(shè)計階段需求分析、設(shè)計階段測試分析報告測試分析報告研發(fā)研發(fā)/ /維護

5、人員維護人員測試階段測試階段管管開發(fā)進度月報開發(fā)進度月報管理人員管理人員貫穿整個開發(fā)過程貫穿整個開發(fā)過程理理項目開發(fā)總結(jié)項目開發(fā)總結(jié)管理人員管理人員測試階段測試階段類類職責(zé)定義職責(zé)定義管理人員管理人員可行性研究與計劃階段可行性研究與計劃階段進度變更記錄進度變更記錄管理人員管理人員隨時隨時產(chǎn)產(chǎn)用戶指南用戶指南用戶用戶需求分析、設(shè)計、實現(xiàn)階段需求分析、設(shè)計、實現(xiàn)階段品品操作手冊操作手冊用戶用戶設(shè)計、實現(xiàn)階段設(shè)計、實現(xiàn)階段類類信息廣告信息廣告用戶用戶測試階段測試階段3/11/2022編輯課件7文檔的分類（文檔的分類（2 2）文件文件 階段階段可行性研究可行性研究與計劃階段與計劃階段需求分需求分析階段

6、析階段設(shè)計設(shè)計階段階段實現(xiàn)實現(xiàn)階段階段測試測試階段階段運行與運行與維護階段維護階段數(shù)據(jù)需求說明書數(shù)據(jù)需求說明書項目開發(fā)計劃項目開發(fā)計劃軟件需求說明書軟件需求說明書數(shù)據(jù)需求說明書數(shù)據(jù)需求說明書測試計劃測試計劃概要設(shè)計說明書概要設(shè)計說明書詳細設(shè)計說明書詳細設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書模塊開發(fā)卷宗模塊開發(fā)卷宗用戶手冊用戶手冊操作手冊操作手冊測試分析報告測試分析報告開發(fā)進度月報開發(fā)進度月報項目開發(fā)總結(jié)項目開發(fā)總結(jié)3/11/2022編輯課件8文檔的分類（文檔的分類（3 3）開發(fā)文檔開發(fā)文檔可行性研究報告可行性研究報告項目開發(fā)計劃項目開發(fā)計劃模塊開發(fā)卷宗模塊開發(fā)卷宗測試分析報告測試分析報告需

7、求規(guī)格說明書需求規(guī)格說明書功能規(guī)格說明書功能規(guī)格說明書概要設(shè)計說明書概要設(shè)計說明書詳細設(shè)計說明書詳細設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書測試計劃測試計劃3/11/2022編輯課件9文檔的分類（文檔的分類（4 4）產(chǎn)品文檔產(chǎn)品文檔用戶指南用戶指南操作手冊操作手冊用戶指南用戶指南產(chǎn)品手冊產(chǎn)品手冊3/11/2022編輯課件10文檔的分類（文檔的分類（5 5）管理文檔管理文檔開發(fā)進度月報開發(fā)進度月報項目開發(fā)總結(jié)項目開發(fā)總結(jié)職責(zé)定義職責(zé)定義進度變更記錄進度變更記錄3/11/2022編輯課件11文檔的等級（文檔的等級（1 1）確定文檔質(zhì)量等級確定文檔質(zhì)量等級根據(jù)項目資源、項目大小和風(fēng)險確定每個文檔根

8、據(jù)項目資源、項目大小和風(fēng)險確定每個文檔的格式及詳細程度的格式及詳細程度文檔格式和文檔內(nèi)容同樣重要文檔格式和文檔內(nèi)容同樣重要必須保證文檔的質(zhì)量，文檔管理才有意義必須保證文檔的質(zhì)量，文檔管理才有意義 3/11/2022編輯課件12文檔的等級（文檔的等級（2 2）文檔按照質(zhì)量可劃分為四個等級：文檔按照質(zhì)量可劃分為四個等級：最低限度文檔（最低限度文檔（1 1級文檔）級文檔）適合開發(fā)工作量低于一個人月的開發(fā)者自用程序適合開發(fā)工作量低于一個人月的開發(fā)者自用程序包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介包含程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介內(nèi)部文檔（內(nèi)部文檔（2 2級文檔）級文檔）適合于沒有與其他用戶共

9、享資源的專用程序適合于沒有與其他用戶共享資源的專用程序1 1級文檔內(nèi)容，加上足夠的注釋和說明級文檔內(nèi)容，加上足夠的注釋和說明3/11/2022編輯課件13文檔的等級（文檔的等級（3 3）文檔按照質(zhì)量可劃分為四個等級：文檔按照質(zhì)量可劃分為四個等級：工作文檔（工作文檔（3 3級文檔）級文檔）適合于由同一單位內(nèi)若干人聯(lián)合開發(fā)的程序，或適合于由同一單位內(nèi)若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序可被其他單位使用的程序正式文檔（正式文檔（4 4級文檔）級文檔）適合那些要正式發(fā)行供普遍使用的軟件產(chǎn)品適合那些要正式發(fā)行供普遍使用的軟件產(chǎn)品關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì)（如工資計關(guān)鍵性程序或具有重復(fù)管理

10、應(yīng)用性質(zhì)（如工資計算）的程序需要算）的程序需要4 4級文檔級文檔3/11/2022編輯課件14內(nèi)容提要內(nèi)容提要文檔的分類和等級文檔的分類和等級文檔管理的原則和方法文檔管理的原則和方法文檔示例與討論文檔示例與討論3/11/2022編輯課件15文檔管理的基本原則文檔管理的基本原則完整性原則完整性原則項目文檔集應(yīng)覆蓋軟件開發(fā)的完整流程項目文檔集應(yīng)覆蓋軟件開發(fā)的完整流程簡潔性原則簡潔性原則編寫文檔不應(yīng)浪費過多的時間和經(jīng)歷編寫文檔不應(yīng)浪費過多的時間和經(jīng)歷有效性原則有效性原則文檔必須能夠起到輔助決策、指導(dǎo)參考的作用文檔必須能夠起到輔助決策、指導(dǎo)參考的作用延續(xù)性原則延續(xù)性原則文檔的變化必須有合理依據(jù)，保持連

11、續(xù)發(fā)展文檔的變化必須有合理依據(jù)，保持連續(xù)發(fā)展3/11/2022編輯課件16文檔管理的內(nèi)容文檔管理的內(nèi)容建立文檔規(guī)范，培養(yǎng)良好習(xí)慣建立文檔規(guī)范，培養(yǎng)良好習(xí)慣制定編寫計劃，明確編寫責(zé)任制定編寫計劃，明確編寫責(zé)任檢查文檔質(zhì)量，提高利用效率檢查文檔質(zhì)量，提高利用效率控制文檔范圍，保護知識產(chǎn)權(quán)控制文檔范圍，保護知識產(chǎn)權(quán)實施版本控制，有效記錄歷史實施版本控制，有效記錄歷史3/11/2022編輯課件17文檔管理方法：如何命名？文檔管理方法：如何命名？命名規(guī)范的重要性命名規(guī)范的重要性統(tǒng)一的對外形象（舉例）統(tǒng)一的對外形象（舉例）有效的文檔分類（舉例）有效的文檔分類（舉例）快速的文檔查找（舉例）快速的文檔查找（舉

12、例）命名規(guī)則的制定命名規(guī)則的制定并無統(tǒng)一規(guī)則，依據(jù)項目環(huán)境自定義并無統(tǒng)一規(guī)則，依據(jù)項目環(huán)境自定義技巧技巧1 1：確定統(tǒng)一的空白封面和項目名稱：確定統(tǒng)一的空白封面和項目名稱技巧技巧2 2：同類型多個文檔的命名方法：同類型多個文檔的命名方法技巧技巧3 3：文檔存儲和管理的方法：文檔存儲和管理的方法3/11/2022編輯課件18文檔管理方法：如何保證內(nèi)容完整？文檔管理方法：如何保證內(nèi)容完整？內(nèi)容殘缺的體現(xiàn)內(nèi)容殘缺的體現(xiàn)缺少項目背景和內(nèi)容目錄（舉例）缺少項目背景和內(nèi)容目錄（舉例）缺少表格和示意圖（舉例）缺少表格和示意圖（舉例）缺少對思想的闡述和問題的分析（舉例）缺少對思想的闡述和問題的分析（舉例）保證

13、內(nèi)容完整的方法保證內(nèi)容完整的方法技巧技巧1 1：提供統(tǒng)一的項目背景資料：提供統(tǒng)一的項目背景資料技巧技巧2 2：培養(yǎng)一致的文檔編寫習(xí)慣：培養(yǎng)一致的文檔編寫習(xí)慣技巧技巧3 3：明確要求表格和圖形的使用方式：明確要求表格和圖形的使用方式3/11/2022編輯課件19文檔管理方法：如何寫好需求分析文檔管理方法：如何寫好需求分析做好需求分析的前提條件做好需求分析的前提條件客戶應(yīng)用環(huán)境的了解客戶應(yīng)用環(huán)境的了解市場主流與技術(shù)主流的了解市場主流與技術(shù)主流的了解客戶現(xiàn)有需求的總結(jié)和潛在需求的挖掘客戶現(xiàn)有需求的總結(jié)和潛在需求的挖掘完成需求分析的過程完成需求分析的過程第一步：項目建議書（第一步：項目建議書（Prop

14、osalProposal） 第二步：市場與技術(shù)調(diào)研報告（第二步：市場與技術(shù)調(diào)研報告（M&T Report)M&T Report)第三步：需求變更風(fēng)險分析第三步：需求變更風(fēng)險分析第四步：需求分析初稿第四步：需求分析初稿3/11/2022編輯課件20文檔管理方法：如何寫好概要設(shè)計文檔管理方法：如何寫好概要設(shè)計做好概要設(shè)計的前提條件做好概要設(shè)計的前提條件客戶需求細節(jié)的了解客戶需求細節(jié)的了解技術(shù)重點和難點的分析技術(shù)重點和難點的分析系統(tǒng)結(jié)構(gòu)的設(shè)計與劃分系統(tǒng)結(jié)構(gòu)的設(shè)計與劃分完成概要設(shè)計的過程完成概要設(shè)計的過程第一步：功能描述（第一步：功能描述（Function DescriptionFun

15、ction Description）第二步：功能定義（第二步：功能定義（Function SpecificationFunction Specification）第三步：重點難點問題解決思路第三步：重點難點問題解決思路第四步：概要設(shè)計草案第四步：概要設(shè)計草案3/11/2022編輯課件21文檔管理方法：如何寫好詳細設(shè)計文檔管理方法：如何寫好詳細設(shè)計詳細設(shè)計的底線是什么？詳細設(shè)計的底線是什么？主要處理流程的詳細說明主要處理流程的詳細說明對外接口的詳細說明對外接口的詳細說明主要邏輯結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)的詳細說明主要邏輯結(jié)構(gòu)和數(shù)據(jù)結(jié)構(gòu)的詳細說明完成詳細設(shè)計的過程完成詳細設(shè)計的過程第一步：流程定義（第一步：流

16、程定義（Control FlowControl Flow）第二步：數(shù)據(jù)結(jié)構(gòu)定義（第二步：數(shù)據(jù)結(jié)構(gòu)定義（Data Flow)Data Flow)第三步：接口定義（第三步：接口定義（API SpecificationAPI Specification）第四步：詳細設(shè)計草案第四步：詳細設(shè)計草案3/11/2022編輯課件22文檔管理方法：如何寫好里程碑報告文檔管理方法：如何寫好里程碑報告里程碑報告的內(nèi)容里程碑報告的內(nèi)容預(yù)期目標的解釋和說明預(yù)期目標的解釋和說明已完成工作的說明已完成工作的說明進度情況、測試結(jié)果的分析和說明進度情況、測試結(jié)果的分析和說明下一步工作的重點和難點下一步工作的重點和難點完成里程碑

17、報告的過程完成里程碑報告的過程第一步：分析前一個里程碑報告的內(nèi)容第一步：分析前一個里程碑報告的內(nèi)容第二步：說明當(dāng)前里程碑的主要進展第二步：說明當(dāng)前里程碑的主要進展第三步：總結(jié)存在的問題、困難和障礙第三步：總結(jié)存在的問題、困難和障礙第四步：列出下一個里程碑的主要工作計劃第四步：列出下一個里程碑的主要工作計劃3/11/2022編輯課件23文檔管理方法：確定最小文檔集文檔管理方法：確定最小文檔集如何確定最小文檔集如何確定最小文檔集重要認識：最小文檔集不是指最簡單文檔集重要認識：最小文檔集不是指最簡單文檔集最重要、最必須的文檔組成最小文檔集最重要、最必須的文檔組成最小文檔集如何實現(xiàn)最小文檔集如何實現(xiàn)最

18、小文檔集人員分工：多人協(xié)作完成一份文檔人員分工：多人協(xié)作完成一份文檔文檔格式：提供統(tǒng)一易用的模板文檔格式：提供統(tǒng)一易用的模板內(nèi)容組織：合并細節(jié)結(jié)構(gòu)，保持總體完整內(nèi)容組織：合并細節(jié)結(jié)構(gòu)，保持總體完整3/11/2022編輯課件24反思：為什么中國人不善于寫文檔？反思：為什么中國人不善于寫文檔？文化背景的原因文化背景的原因官修史與私修史：從孔子談起官修史與私修史：從孔子談起封建專制與思想禁錮：焚書坑儒和文字獄封建專制與思想禁錮：焚書坑儒和文字獄現(xiàn)代教育的原因現(xiàn)代教育的原因缺乏方法教育和人格教育缺乏方法教育和人格教育缺乏法律意識和嚴謹態(tài)度缺乏法律意識和嚴謹態(tài)度官本位、錢本位的價值觀官本位、錢本位的價值觀3/11/2022編輯課件25內(nèi)容提要內(nèi)容提要文檔的分類和等級文檔的分類和等級文檔管理的原則和方法文檔管理的原則和方法文檔示