系統(tǒng)設(shè)計(jì)編碼過程

1、密 級:內(nèi)部公開文檔編號:xxx_SD_PROC_XTSJBMGC版 本 號:V1.0系統(tǒng)設(shè)計(jì)編碼過程XXXX 有限公司 - XXXX 有限公司對本文件資料享受著作權(quán)及其它專屬權(quán)利,未經(jīng)書面許可,不 得將該等文件資料(其全部或任何部分披露予任何第三方,或進(jìn)行修改后使用。 文件更改摘要: 目 錄1. 目的 /方針 . 32. 范圍 . . 33. 術(shù)語 . . 34. 角色與職責(zé) . . 35. 入口準(zhǔn)則 . . 36. 輸入 . . 37. 流程圖 . . 38. 主要活動(dòng) . . 4 8.1. 設(shè)計(jì)原則 . . 4 8.2. 設(shè)計(jì)方法 . . 4 8.3. 多方案選擇 . . 5 8.4.

2、概要設(shè)計(jì) . . 5 8.4.1. 概要設(shè)計(jì) . . 5 8.4.2. 概要設(shè)計(jì)評審 . . 7 8.5. 詳細(xì)設(shè)計(jì) . . 7 8.5.1. 詳細(xì)設(shè)計(jì) . . 7 8.5.2. 詳細(xì)設(shè)計(jì)評審 . . 7 8.6. 編碼 . . 8 8.7. 單元測試 . . 8 8.8. 代碼走查 . . 8 8.9. 制作用戶文檔 . . 98.10. 變更 . . 99. 輸出 . . 9 10. 出口準(zhǔn)則 . . 9 11. 引用文檔 . . 9 12. 使用模板 . . 101. 目的 /方針系統(tǒng)設(shè)計(jì)編碼的目的在于開發(fā)、設(shè)計(jì)和實(shí)現(xiàn)關(guān)于需求的解決方案。本過程規(guī)定了項(xiàng)目開發(fā)設(shè)計(jì)工作應(yīng)遵循的步驟和原則,保

3、證軟件需求說明書中的 各項(xiàng)要求在設(shè)計(jì)時(shí)都能夠得到滿足; 對項(xiàng)目的編碼實(shí)現(xiàn)進(jìn)行質(zhì)量控制, 保證編碼實(shí)現(xiàn)活動(dòng)按 計(jì)劃順利完成并與設(shè)計(jì)相一致。2. 范圍適用于公司的研發(fā)類、合同開發(fā)類、維護(hù)開發(fā)類項(xiàng)目的系統(tǒng)設(shè)計(jì)編碼過程。3. 術(shù)語無4. 角色與職責(zé) 5. 入口準(zhǔn)則軟件需求說明書已通過評審。6. 輸入軟件需求說明書7. 流程圖 圖 1: 系統(tǒng)設(shè)計(jì)編碼過程示意圖8. 主要活動(dòng)系統(tǒng)設(shè)計(jì)編碼過程包括系統(tǒng)設(shè)計(jì)、系統(tǒng)實(shí)現(xiàn)。系統(tǒng)設(shè)計(jì)是指設(shè)計(jì)軟件系統(tǒng)的體系結(jié)構(gòu)、 數(shù)據(jù)庫、模塊等,在需求和代碼之間建立橋梁,一般分概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)兩個(gè)階段;系統(tǒng) 實(shí)現(xiàn)是指軟件工程師按照系統(tǒng)設(shè)計(jì)去編碼開發(fā), 并進(jìn)行單元測試、 代碼走查;

4、在設(shè)計(jì)編碼過 程中同時(shí)進(jìn)行用戶文檔的編制。8.1. 設(shè)計(jì)原則設(shè)計(jì)工作應(yīng)遵循以下原則:正確、完整地反映軟件需求說明書的各項(xiàng)要求,充分考慮其功能、性能、 安全保密、出錯(cuò)處理及其它需求。保證設(shè)計(jì)的易理解性、可追蹤性、可測試性、接口的開放性和兼容性,考慮健 壯性(易修改、可擴(kuò)充、可移植 、重用性。采用適合本項(xiàng)目的設(shè)計(jì)方法。 若系統(tǒng)使用了新工具和新技術(shù), 為了確認(rèn)新工具 和新技術(shù),可以采用快速原型法進(jìn)行技術(shù)預(yù)研?？紤]選用合適的編程語言和開發(fā)工具,制定編碼規(guī)范和系統(tǒng)約定等。吸取以往設(shè)計(jì)的經(jīng)驗(yàn)教訓(xùn),避免重新出現(xiàn)同樣或類似的問題。對于重要的和復(fù)雜度較高的部分要求有相當(dāng)經(jīng)驗(yàn)的設(shè)計(jì)人員擔(dān)任。8.2. 設(shè)計(jì)方法設(shè)計(jì)

5、時(shí)要使用有效的方法進(jìn)行軟件設(shè)計(jì)。主要的軟件設(shè)計(jì)方法包含但不限于:面向結(jié)構(gòu)設(shè)計(jì)方法:結(jié)合 軟件需求說明書 及系統(tǒng)不同層次的數(shù)據(jù)流圖, 把整個(gè)系統(tǒng)分解為模塊 并確定各模塊功能, 確定每個(gè)功能模塊的輸入、 轉(zhuǎn)換和輸出數(shù)據(jù)流, 并考慮各方面 數(shù)據(jù)接口、 存儲方式等。 迭代逐步分解各系統(tǒng)模塊, 直到確定每個(gè)功能模塊只執(zhí)行 一個(gè)行為為止, 同時(shí)細(xì)化數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì), 完善數(shù)據(jù)字典以確保系統(tǒng)能獲得所需的輸 出結(jié)果,從而完成系統(tǒng)構(gòu)架設(shè)計(jì)。面向?qū)ο笤O(shè)計(jì)方法:結(jié)合軟件需求說明書和系統(tǒng)選用的編程語言,確定客戶類(包括子類及 類的各種行為, 并使用設(shè)計(jì)模型及相應(yīng)的列表, 確定每個(gè)對象的客戶 (模塊 關(guān)聯(lián), 并給予必要的方

6、法設(shè)計(jì)。 迭代逐步檢查對象及其方法, 直到系統(tǒng)中每個(gè)對象擁有所 有必需的方法,從而完成系統(tǒng)構(gòu)架設(shè)計(jì)。8.3. 多方案選擇系統(tǒng)設(shè)計(jì)過程進(jìn)行多方案選擇時(shí), 按照 決策分析和決定過程 進(jìn)行系統(tǒng)架構(gòu)選擇和關(guān) 鍵技術(shù)方案的確定,設(shè)計(jì)出多個(gè)侯選的技術(shù)解決方案。設(shè)計(jì)應(yīng)基于成本、進(jìn)度、技術(shù)性能、 生命周期、產(chǎn)品運(yùn)作條件、風(fēng)險(xiǎn)、需求和技術(shù)變化等多個(gè)因素來進(jìn)行,開發(fā)出的解決方案將 作為后續(xù)設(shè)計(jì)工作的基礎(chǔ),必須保證可行性與可操作性。并非所有項(xiàng)目都要求提供多個(gè)技術(shù)解決方案, 但為保證項(xiàng)目質(zhì)量和公司商業(yè)利益, 大型項(xiàng)目 至少應(yīng)提供兩套以上技術(shù)解決方案。 小型項(xiàng)目和中型項(xiàng)目提供一個(gè)技術(shù)決策方案, 對于項(xiàng)目 的級別較小或是

7、公司內(nèi)部項(xiàng)目或?qū)夹g(shù)性要求不大的項(xiàng)目技術(shù)解決方案可以適當(dāng)?shù)牟脺p, 但 對于其中某些重要部分需要提供兩個(gè)以上解決方案。8.4. 制作、購買與復(fù)用系統(tǒng)設(shè)計(jì)過程中,如果某一組建存在進(jìn)行新開發(fā)、采購或復(fù)用多方案選擇時(shí):利用決策 分析和決定過程確定新開發(fā)、采購和復(fù)用方案。參見決策分析和決定過程 。8.5. 概要設(shè)計(jì)概要設(shè)計(jì)是分析各種設(shè)計(jì)方案和定義軟件體系結(jié)構(gòu)的過程。 系統(tǒng)分析師在充分了解需求 的基礎(chǔ)上,依據(jù)軟件需求說明書選用適當(dāng)?shù)脑O(shè)計(jì)方法,分析與設(shè)計(jì)軟件的結(jié)構(gòu)、模塊功 能。 通過系統(tǒng)分解, 確定子系統(tǒng)的功能和子系統(tǒng)之間的關(guān)系, 以及模塊的功能和模塊之間的 關(guān)系,編寫概要設(shè)計(jì)說明書 。 概要設(shè)計(jì)說明書必須

8、經(jīng)過技術(shù)評審。8.5.1. 概要設(shè)計(jì)概要設(shè)計(jì)是建立整個(gè)軟件的體系結(jié)構(gòu), 包括子系統(tǒng)、 模塊以及相關(guān)層次的說明、 每一模 塊的接口定義等。包括:總體架構(gòu)設(shè)計(jì)接口設(shè)計(jì)界面總體設(shè)計(jì)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)出錯(cuò)處理設(shè)計(jì)(可選系統(tǒng)安全設(shè)計(jì)系統(tǒng)部署等概要設(shè)計(jì)入口準(zhǔn)則是軟件需求說明書評審?fù)ㄟ^概要設(shè)計(jì)輸入是軟件需求說明書概要設(shè)計(jì)輸出形成概要設(shè)計(jì)說明書 、 數(shù)據(jù)庫設(shè)計(jì)說明書等概要設(shè)計(jì)的工作步驟:1. 項(xiàng)目經(jīng)理確定系統(tǒng)設(shè)計(jì)人員, 并討論確定階段出口準(zhǔn)則, 通盤考慮并跟蹤上游順延下來 的進(jìn)度、技術(shù)難度等風(fēng)險(xiǎn)、問題,與相關(guān)人員溝通,制定階段計(jì)劃。必要時(shí),請高層參 與問題解決;2. 評估、 確認(rèn)需求分析結(jié)果, 并對可重用的軟件

9、或功能模塊進(jìn)行性能測試, 通盤考慮整個(gè) 系統(tǒng)結(jié)構(gòu)、功能擴(kuò)展性;3. 系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì):3-1用選定的工具 (如需求功能矩陣表等 和開發(fā)計(jì)劃設(shè)定的交付方式 (如小版本漸進(jìn)交付 及設(shè)計(jì)方法,結(jié)合設(shè)計(jì)原則(如功能模塊化等 ,將系統(tǒng)分解為若干子系統(tǒng)、功能模塊,并 3-2確定子系統(tǒng)、功能模塊及其間的關(guān)系;確定子系統(tǒng)、功能模塊間的約束、假設(shè)和依賴(如系統(tǒng)運(yùn)行環(huán)境和開發(fā)、測試環(huán)境等,并考 慮系統(tǒng)并發(fā)性和分布性要求 ;3-3結(jié)合以上內(nèi)容,對系統(tǒng)的模塊邏輯實(shí)現(xiàn)和集成方法進(jìn)行設(shè)計(jì),降低使軟件難于實(shí)現(xiàn)、測 試(必要時(shí)測試人員參與討論 、維護(hù)的因素,形成高內(nèi)聚、低耦合的系統(tǒng)體系結(jié)構(gòu);3-4定義錯(cuò)誤處理和恢復(fù)策略,對可

10、能出現(xiàn)的故障進(jìn)行分解,確定處理對策;4. 數(shù)據(jù)體系結(jié)構(gòu)設(shè)計(jì):4-1確定項(xiàng)目數(shù)據(jù)庫設(shè)計(jì)規(guī)則以便于系統(tǒng)統(tǒng)一,其中包括:庫命名,邏輯設(shè)計(jì),物理設(shè)計(jì), 安全性設(shè)計(jì)及優(yōu)化,管理規(guī)則等;4-2數(shù)據(jù)庫設(shè)計(jì)一般要經(jīng)過“邏輯設(shè)計(jì)物理設(shè)計(jì)安全性設(shè)計(jì)優(yōu)化”等步驟,通常要迭 代進(jìn)行:4-3邏輯設(shè)計(jì)分析軟件系統(tǒng)模塊及其之間的數(shù)據(jù)操作, 使用抽象數(shù)據(jù)類型設(shè)計(jì), 轉(zhuǎn)換數(shù)據(jù)對象的屬性及其 關(guān)聯(lián)、接口等內(nèi)容,設(shè)計(jì)并完善數(shù)據(jù)字典及其約束條件,實(shí)現(xiàn)數(shù)據(jù)的變量封裝結(jié)構(gòu)設(shè)計(jì)。面 向結(jié)構(gòu)設(shè)計(jì)方法中為創(chuàng)建與數(shù)據(jù)庫相關(guān)的數(shù)據(jù)流圖或?qū)嶓w關(guān)系圖; 若采用面向?qū)ο蠓椒? 則 分析類信息傳遞內(nèi)容,并創(chuàng)建類圖;4-4物理設(shè)計(jì)設(shè)計(jì)表結(jié)構(gòu),與實(shí)體關(guān)系圖或

11、類圖相結(jié)合;對表結(jié)構(gòu)進(jìn)行規(guī)范化處理;4-5安全性設(shè)計(jì)考慮數(shù)據(jù)庫的登陸訪問限制,用戶密碼加密,操作訪問權(quán)限等系統(tǒng)安全設(shè)計(jì);4-6優(yōu)化分析并優(yōu)化數(shù)據(jù)庫的 “時(shí) -空” (即性能, 容量等 效率, 盡可能 “提高處理速度” 并且 “降 低數(shù)據(jù)占用空間” 。分析“時(shí) -空”效率的瓶頸,找出優(yōu)化對象(目標(biāo) ,并確定優(yōu)先級;消除對象(目標(biāo)間的對抗性,必要時(shí)給出折中方案;給出優(yōu)化的具體措施, 如逐步評估、 優(yōu)化數(shù)據(jù)庫環(huán)境參數(shù), 對表格進(jìn)行反規(guī)范化處理等, 堅(jiān)持信息隱蔽等原則,加強(qiáng)數(shù)據(jù)設(shè)計(jì)可維護(hù)性;8.5.2. 概要設(shè)計(jì)評審為保證概要設(shè)計(jì)的正確性、 完整性和與需求的一致性, 應(yīng)對概要設(shè)計(jì)說明書以及相關(guān)文 檔進(jìn)

12、行技術(shù)評審。 選用技術(shù)評審會(huì)議的方式, 提請?jiān)u審管理部門組織評審, 具體過程參見 評 審規(guī)程 。評審組成員包括但不限于:項(xiàng)目經(jīng)理、需求分析人員、系統(tǒng)分析師、軟件工程師、 QA 工程師、技術(shù)或業(yè)務(wù)專家輸入:概要設(shè)計(jì)說明書 ;輸出:概要設(shè)計(jì)說明書 、 評審報(bào)告 、 數(shù)據(jù)庫設(shè)計(jì)說明書 ;檢查單:概要設(shè)計(jì)檢查單概要設(shè)計(jì)評審?fù)ㄟ^后, 概要設(shè)計(jì)說明書及其評審記錄納入受控庫管理。 負(fù)責(zé)概要設(shè)計(jì)的 系統(tǒng)分析師填寫需求跟蹤矩陣的相關(guān)設(shè)計(jì)項(xiàng)。8.6. 詳細(xì)設(shè)計(jì)概要設(shè)計(jì)評審?fù)ㄟ^后,依據(jù)軟件需求說明書 ,根據(jù)概要設(shè)計(jì)說明書 ,高級軟件 工程師進(jìn)一步細(xì)化系統(tǒng)的設(shè)計(jì)。針對每個(gè)子系統(tǒng)從功能、性能、輸入輸出、流程、接口、用

13、戶界面等方面實(shí)施具體的詳細(xì)設(shè)計(jì),編寫詳細(xì)設(shè)計(jì)說明書 。 詳細(xì)設(shè)計(jì)說明書必須經(jīng)過 技術(shù)評審。8.6.1. 詳細(xì)設(shè)計(jì)根據(jù)確定的設(shè)計(jì)方法, 選擇適當(dāng)工具進(jìn)行詳細(xì)設(shè)計(jì), 以獲得關(guān)于處理邏輯、 數(shù)據(jù)結(jié)構(gòu)和 數(shù)據(jù)定義的更加詳盡的描述,最終產(chǎn)生軟件工程師可用的模塊說明。可以包含:描述功能參數(shù)說明性能(可選用戶界面流程邏輯算法等詳細(xì)設(shè)計(jì)輸出詳細(xì)設(shè)計(jì)說明書 、細(xì)化的數(shù)據(jù)庫設(shè)計(jì)說明書等。8.6.2. 詳細(xì)設(shè)計(jì)評審為保證詳細(xì)設(shè)計(jì)的正確性、 完整性和與概要設(shè)計(jì)和需求的一致性, 應(yīng)對詳細(xì)設(shè)計(jì)說明書 以及相關(guān)文檔進(jìn)行技術(shù)評審。 由項(xiàng)目經(jīng)理作為評審組長, 組織按照組內(nèi)評審、 輪查的方式進(jìn) 行,或由項(xiàng)目經(jīng)理指定人員按個(gè)人復(fù)查

14、的方式進(jìn)行,具體過程參見評審規(guī)程。評審組成員包括但不限于:系統(tǒng)分析師、軟件工程師、 QA 工程師、項(xiàng)目經(jīng)理、技 術(shù)或業(yè)務(wù)專家;輸入:詳細(xì)設(shè)計(jì)說明書 ;輸出:詳細(xì)設(shè)計(jì)說明書 、 會(huì)議紀(jì)要 ;檢查單:詳細(xì)設(shè)計(jì)檢查單詳細(xì)設(shè)計(jì)評審?fù)ㄟ^后, 詳細(xì)設(shè)計(jì)說明書及其評審記錄納入受控庫管理。 負(fù)責(zé)詳細(xì)設(shè)計(jì)的 高級軟件工程師填寫需求跟蹤矩陣的相關(guān)設(shè)計(jì)項(xiàng)。8.7. 編碼系統(tǒng)設(shè)計(jì)完成后,進(jìn)入編碼階段。項(xiàng)目組在系統(tǒng)設(shè)計(jì)時(shí)開始制定編碼規(guī)范, 在進(jìn)入編碼階段之前, 必須確定項(xiàng)目的編碼規(guī) 范:直接使用公司現(xiàn)有的編碼規(guī)范引用公司現(xiàn)有的編碼規(guī)范, 在設(shè)計(jì)階段開始此基礎(chǔ)上進(jìn)行修改, 生成項(xiàng)目的編碼規(guī) 范,必須經(jīng)過 EPG 審批后使

15、用。公司沒有的, 項(xiàng)目組應(yīng)在設(shè)計(jì)階段開始建立新的編碼規(guī)范, 經(jīng)過 EPG 審批后使用。 編碼是把系統(tǒng)設(shè)計(jì)轉(zhuǎn)換為程序代碼的過程。軟件工程師:依據(jù)設(shè)計(jì)說明書,開展具體的程序代碼的編寫。嚴(yán)格項(xiàng)目的編程規(guī)范及項(xiàng)目組的系統(tǒng)約定。借鑒以往編碼的經(jīng)驗(yàn)和代碼復(fù)用。8.8. 單元測試編碼完成的系統(tǒng)各模塊必須經(jīng)過單元測試。由模塊開發(fā)人員進(jìn)行,有條件的可以由其它開發(fā)人員進(jìn)行互換測試。測試需要關(guān)注以下幾個(gè)方面:源代碼編譯 -測試代碼是否通過編譯。SQL 腳本 -測試數(shù)據(jù)庫腳本、存儲過程運(yùn)行是否正常。模塊接口 -對被測模塊,信息是否能正確地流入和流出。局部數(shù)據(jù)結(jié)構(gòu) -在模塊的工作過程中,其內(nèi)部的數(shù)據(jù)能否保持其完整性。

16、邊界條件 -在邊界上模塊是否能正常工作。覆蓋條件 -模塊的運(yùn)行是是否滿足設(shè)計(jì)的邏輯要求。出錯(cuò)處理 -檢查模塊的錯(cuò)誤處理設(shè)施是否有效。建議引用測試工具自動(dòng)執(zhí)行單元測試。互換測試發(fā)現(xiàn)的問題納入缺陷管理,參見缺陷管理規(guī)程 。輸出單元測試報(bào)告 ,納入測試庫管理。利用工具自動(dòng)執(zhí)行單元測試的,可由工具直接導(dǎo)出測試報(bào)告手動(dòng)執(zhí)行的,按模板生成單元測試報(bào)告完成各模塊的單元測試后,負(fù)責(zé)編碼的軟件工程師填寫需求跟蹤矩陣的相關(guān)編碼模塊。 單元測試后形成單元測試報(bào)告8.9. 代碼走查軟件模塊經(jīng)過單元測試, 由項(xiàng)目經(jīng)理在進(jìn)度計(jì)劃中策劃并安排軟件工程師進(jìn)行程序代碼 檢查,檢查發(fā)現(xiàn)的問題納入缺陷管理(參見缺陷管理規(guī)程 ,直到

17、問題解決。代碼走查采用個(gè)人復(fù)查方式執(zhí)行。具體過程參見評審規(guī)程代碼走查通過后代碼納入測試庫管理。代碼走查后形成代碼走查單8.10. 制作用戶文檔系統(tǒng)設(shè)計(jì)與實(shí)現(xiàn)過程中還須輸出用戶操作手冊 、 用戶安裝手冊等用戶文檔。由項(xiàng) 目經(jīng)理指定人員完成。 在系統(tǒng)設(shè)計(jì)階段構(gòu)造用戶文檔的框架和基本內(nèi)容, 在編碼及單元測試 過程中進(jìn)行充實(shí),在確認(rèn)測試之前完成編寫。用戶文檔經(jīng)過確認(rèn)測試納入受控庫管理。8.11. 變更對進(jìn)入受控庫的設(shè)計(jì)、編碼及用戶文檔的變更,按變更管理規(guī)程執(zhí)行。8.12. 建立和維護(hù)數(shù)據(jù)包TDP :Technical Data Package,技術(shù)數(shù)據(jù)包是一些元素的集合,這些元素和一種類型 的產(chǎn)品或產(chǎn)品組件相關(guān)。包括:產(chǎn)品總體結(jié)構(gòu)描述、確定的需求、產(chǎn)品組件描述、產(chǎn)品相關(guān) 生命周期過程描述(如果沒有在獨(dú)立的產(chǎn)品組件中描述 、關(guān)鍵產(chǎn)品特性、必須的物理特性 和約束關(guān)系、接口需求、保證需求被滿足的驗(yàn)收條件、可操作性場景等。把這些相關(guān)工作產(chǎn) 品