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

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

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

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

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

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

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

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

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

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

10、應(yīng)用性質(zhì)（如工資計(jì)算）的程序需要算）的程序需要4 4級(jí)文檔級(jí)文檔3/11/2022編輯課件14內(nèi)容提要內(nèi)容提要文檔的分類和等級(jí)文檔的分類和等級(jí)文檔管理的原則和方法文檔管理的原則和方法文檔示例與討論文檔示例與討論3/11/2022編輯課件15文檔管理的基本原則文檔管理的基本原則完整性原則完整性原則項(xiàng)目文檔集應(yīng)覆蓋軟件開發(fā)的完整流程項(xiàng)目文檔集應(yīng)覆蓋軟件開發(fā)的完整流程簡(jiǎn)潔性原則簡(jiǎn)潔性原則編寫文檔不應(yīng)浪費(fèi)過(guò)多的時(shí)間和經(jīng)歷編寫文檔不應(yīng)浪費(fèi)過(guò)多的時(shí)間和經(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í)慣制定編寫計(jì)劃，明確編寫責(zé)任制定編寫計(jì)劃，明確編寫責(zé)任檢查文檔質(zhì)量，提高利用效率檢查文檔質(zhì)量，提高利用效率控制文檔范圍，保護(hù)知識(shí)產(chǎn)權(quán)控制文檔范圍，保護(hù)知識(shí)產(chǎn)權(quán)實(shí)施版本控制，有效記錄歷史實(shí)施版本控制，有效記錄歷史3/11/2022編輯課件17文檔管理方法：如何命名？文檔管理方法：如何命名？命名規(guī)范的重要性命名規(guī)范的重要性統(tǒng)一的對(duì)外形象（舉例）統(tǒng)一的對(duì)外形象（舉例）有效的文檔分類（舉例）有效的文檔分類（舉例）快速的文檔查找（舉例）快速的文檔查找（舉

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

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

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

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

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

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

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