軟件設計編碼過程

XXXX公司XXXX公司軟件設計編碼過程XXXXXX有限公司文件編號GF_TS_PROC_TS當前版本V3.0機密等級20XX編制者審核者批準者批準日期20XX-3-4XXXXXX有限公司對本文件資料享受著作權(quán)及其它專屬權(quán)利，未經(jīng)書面許可，不得將該等文件資料（其全部或任何部分）披露予任何第三方，或進行修改后使用。

文件更改摘要：日期版本號修訂說明修訂人審核人批準人20XX-5-15V1.0正式發(fā)布早車20XX-3-4V3.0優(yōu)化設計編碼過程20XX-5-31V4.1裁剪單元測試過程目錄TOC\o"1-5"\h\z目的32適用范圍3玄術(shù)語和縮寫3職責3入口準則3輸入37過程流程圖4&過稈描述4選擇設計解決方案5設計原則583設計方法5開發(fā)的復用及外包6概要設計及評審6851概要設計68.5.2概要設計評審8詳細設計及評審8詳細設計8詳細設計評審9建立和維護技術(shù)資料包9編碼1089單元測試108.10代碼走杳11輸出11出口準則11引用文檔1112.使用模板11目的軟件設計編碼的目的在于設計和實現(xiàn)關(guān)于需求的解決方案。本過程規(guī)定了項目開發(fā)設計工作應遵循的步驟和原則，保證《軟件需求說明書》中的各項要求在設計時都能夠得到滿足；對項目的編碼實現(xiàn)進行質(zhì)量控制，保證編碼實現(xiàn)活動按計劃順利完成并與設計相一致。適用范圍適用于公司所有項目的軟件設計及編碼工作。術(shù)語和縮寫術(shù)語或縮略語解釋無職責角色職責項目經(jīng)理組織人員對可選解決方案進行決朿分析參與過程文檔的編寫和評審協(xié)調(diào)項目組內(nèi)各角色之間的協(xié)同合作關(guān)系設計工程師根據(jù)《軟件需求說明書》進行系統(tǒng)整體架構(gòu)的分析和設計編寫《軟件概要設計說明書》及《軟件詳細設計說明書》參加設計評審研發(fā)中心經(jīng)理/總監(jiān)參加設計評審開發(fā)工程師根據(jù)《軟件概要設計說明書》及《軟件詳細設計說明書》完成代碼編寫和代碼走查參與代碼評審參加設計評審項目推進部監(jiān)督軟件設計編碼過程檢查設計編碼文檔參與文檔評審入口準則《用戶需求說明書》《軟件需求說明書》已通過評審《項目總體計劃》及《項目進度安排》已通過評審

輸入《用戶需求說明書》《軟件需求說明書》技術(shù)資料需求跟蹤矩陣過程流程圖軟件設計編碼過程>選可{案方?jīng)Q解計設輸入用戶需求說明書/軟件需求說明書計設要概需求跟蹤矩陣1剪裁可{計設細詳概要設計說明書概要設計說明書/詳

細設計說明書/

數(shù)據(jù)庫設計說明書建立技術(shù)數(shù)據(jù)包<開始丿11選擇設計解決方案1>選可{案方?jīng)Q解計設輸入用戶需求說明書/軟件需求說明書計設要概需求跟蹤矩陣1剪裁可{計設細詳概要設計說明書概要設計說明書/詳

細設計說明書/

數(shù)據(jù)庫設計說明書建立技術(shù)數(shù)據(jù)包<開始丿11選擇設計解決方案1概要設計輸出決策分析報告概要設計說明書詳細設計說明書/數(shù)據(jù)庫設計說明書評審報告技術(shù)數(shù)據(jù)包清單、圖1系統(tǒng)設計編碼過程示意圖過程描述軟件設計編碼過程包括軟件設計和系統(tǒng)實現(xiàn)。軟件設計是指設計軟件系統(tǒng)的體系結(jié)構(gòu)、數(shù)據(jù)庫、模塊等，在需求和代碼之間建立橋梁，一般分概要設計和詳細設計兩個階段；系統(tǒng)實現(xiàn)是指軟件工程師按照系統(tǒng)設計去編碼開發(fā)，并進行代碼評審。選擇設計解決方案設計工程師根據(jù)對需求的理解，制定多個針對需求的解決方案。項目經(jīng)理組織項目組內(nèi)的工程師以及需求工程師對各解決方案優(yōu)缺點進行分析，并挑選最佳的技術(shù)解決方案。如必要時，可邀請項目組以外的工程師參與方案選擇。并非所有項目都要求提供多個技術(shù)解決方案，但為保證項目質(zhì)量和公司商業(yè)利益，大型項目至少應提供兩套以上技術(shù)解決方案。小型項目和中型項目提供一個技術(shù)決策方案，對于項目的級別較小或是公司內(nèi)部項目或?qū)夹g(shù)性要求不大的項目技術(shù)解決方案可以適當?shù)牟眉簦珜τ谄渲心承┲匾糠中枰峁﹥蓚€以上解決方案。具體過程參見《決策分析過程》。設計原則設計工作應該遵循以下原則：正確、完整地反映《軟件需求說明書》的各項要求，充分考慮其功能、性能、安全保密、出錯處理及其它需求。保證設計的易理解性、可追蹤性、可測試性、接口的開放性和兼容性，考慮健壯性（易修改、可擴充、可移植）、重用性。采用適合本項目的設計方法。若系統(tǒng)使用了新工具和新技術(shù)，為了確認新工具和新技術(shù)，可以采用快速原型法進行技術(shù)預研?？紤]選用合適的編程語言和開發(fā)工具，制定編碼規(guī)范和系統(tǒng)約定等。吸取以往設計的經(jīng)驗教訓，避免重新出現(xiàn)同樣或類似的問題。對于重要的和復雜度較高的部分要求有相當經(jīng)驗的設計人員擔任。接口設計準則：提高模塊獨立性保持接口簡潔，降低接口復雜程度保持公司接口設計習慣便于重用設計方法設計時要使用有效的方法進行軟件設計。主要的軟件設計方法包含但不限于：結(jié)構(gòu)化設計方法：結(jié)合《軟件需求說明書》及系統(tǒng)不同層次的數(shù)據(jù)流圖，把整個系統(tǒng)分解為模塊并確定各模塊功能，確定每個功能模塊的輸入、轉(zhuǎn)換和輸出數(shù)據(jù)流，并考慮各方面數(shù)據(jù)接口、存儲方式等。迭代逐步分解各系統(tǒng)模塊，直到確定每個功能模塊只執(zhí)行一個行為為止，同時細化數(shù)據(jù)結(jié)構(gòu)設計，完善數(shù)據(jù)字典以確保系統(tǒng)能獲得所需的輸出結(jié)果，從而完成系統(tǒng)構(gòu)架設計。面向?qū)ο笤O計方法：結(jié)合《軟件需求說明書》和系統(tǒng)選用的編程語言，確定客戶類（包括子類）及類的各種行為，并使用設計模型及相應的列表，確定每個對象的客戶（模塊）關(guān)聯(lián)，并給予必要的方法設計。迭代逐步檢查對象及其方法，直到系統(tǒng)中每個對象擁有所有必需的方法，從而完成系統(tǒng)構(gòu)架設計。開發(fā)的復用及外包設計過程中應考慮是否可以復用以往項目或公用組件庫的設計及編碼，并遵循以下重用原則：不確定已有產(chǎn)品是否可以重用時，應深思熟慮重用前應了解相關(guān)產(chǎn)品是否已發(fā)布給客戶使用，并通過一定時間驗證，確保不存在嚴重問題如果在當前的時間、技術(shù)的約束下無法實現(xiàn)項目目標，方可考慮外包。概要設計及評審概要設計是分析各種設計方案和定義軟件體系結(jié)構(gòu)的過程。軟件設計工程師在充分了解需求的基礎上，依據(jù)《軟件需求說明書》選用適當?shù)脑O計方法，分析與設計軟件的結(jié)構(gòu)、模塊功能。通過系統(tǒng)分解，確定子系統(tǒng)的功能和子系統(tǒng)之間的關(guān)系，以及模塊的功能和模塊之間的關(guān)系，編寫《概要設計說明書》?！陡乓O計說明書》必須經(jīng)過技術(shù)評審。如果詳細設計活動被裁剪，那么在《概要設計說明書》中必須包含數(shù)據(jù)庫結(jié)構(gòu)設計內(nèi)容，下一活動則進行編碼。8.5.1概要設計概要設計是建立整個軟件的體系結(jié)構(gòu)，包括子系統(tǒng)、模塊以及相關(guān)層次的說明、每一模塊的接口定義等。包括：總體架構(gòu)設計>接口設計界面總體設計數(shù)據(jù)結(jié)構(gòu)設計系統(tǒng)出錯處理設計（可選）系統(tǒng)安全設計系統(tǒng)部署等概要設計的工作步驟：項目經(jīng)理確定系統(tǒng)分析員，并討論確定階段出口準則，通盤考慮并跟蹤上游順延下來的進度、技術(shù)難度等風險、問題，與相關(guān)人員溝通。必要時，請高層參與問題解決；評估、確認需求分析結(jié)果，并考慮是否可以復用以往項目或項目經(jīng)驗庫的設計及編碼，通盤考慮整個系統(tǒng)結(jié)構(gòu)、功能擴展性；系統(tǒng)體系結(jié)構(gòu)設計：a）用選定的工具（如需求功能矩陣表等）和開發(fā)計劃設定的交付方式（如小版本漸進交付）及設計方法，結(jié)合設計原則（如功能模塊化等），將系統(tǒng)分解為若干子系統(tǒng)、功能模塊，并確定子系統(tǒng)、功能模塊及其間的關(guān)系；b）確定子系統(tǒng)、功能模塊間的約束、假設和依賴（如系統(tǒng)運行環(huán)境和開發(fā)、測試環(huán)境等，并考慮系統(tǒng)并發(fā)性和分布性要求）；c）結(jié)合以上內(nèi)容，對系統(tǒng)的模塊邏輯實現(xiàn)和集成方法進行設計，降低使軟件難于實現(xiàn)、測試（必要時測試人員參與討論）、維護的因素，形成高內(nèi)聚、低耦合的系統(tǒng)體系結(jié)構(gòu)；d）定義錯誤處理和恢復策略，對可能出現(xiàn)的故障進行分解，確定處理對策；數(shù)據(jù)庫設計：a）確定項目數(shù)據(jù)庫設計規(guī)則以便于系統(tǒng)統(tǒng)一，其中包括：庫命名，邏輯設計，物理設計，安全性設計及優(yōu)化，管理規(guī)則等；b）數(shù)據(jù)庫設計一般要經(jīng)過“邏輯設計一物理設計一安全性設計一優(yōu)化”等步驟，通常要迭代進行：?邏輯設計分析軟件系統(tǒng)模塊及其之間的數(shù)據(jù)操作，使用抽象數(shù)據(jù)類型設計，轉(zhuǎn)換數(shù)據(jù)對象的屬性及其關(guān)聯(lián)、接口等內(nèi)容，設計并完善數(shù)據(jù)字典及其約束條件，實現(xiàn)數(shù)據(jù)的變量封裝結(jié)構(gòu)設計。面向結(jié)構(gòu)設計方法中為創(chuàng)建與數(shù)據(jù)庫相關(guān)的數(shù)據(jù)流圖或?qū)嶓w關(guān)系圖；若采用面向?qū)ο蠓椒?，則分析類信息傳遞內(nèi)容，并創(chuàng)建類圖；物理設計設計表結(jié)構(gòu)，與實體關(guān)系圖或類圖相結(jié)合；對表結(jié)構(gòu)進行規(guī)范化處理；安全性設計考慮數(shù)據(jù)庫的登陸訪問限制，用戶密碼加密，操作訪問權(quán)限等系統(tǒng)安全設計；c）優(yōu)化分析并優(yōu)化數(shù)據(jù)庫的“時-空”（即性能，容量等）效率，盡可能“提高處理速度”并且“降低數(shù)據(jù)占用空間”。分析“時-空”效率的瓶頸，找出優(yōu)化對象（目標），并確定優(yōu)先級；消除對象（目標）間的對抗性，必要時給出折中方案；給出優(yōu)化的具體措施，如逐步評估、優(yōu)化數(shù)據(jù)庫環(huán)境參數(shù)，對表格進行反規(guī)范化處理等，堅持信息隱蔽等原則，加強數(shù)據(jù)設計可維護性；8.5.2概要設計評審為保證概要設計的正確性、完整性和與需求的一致性，應對概要設計說明書以及相關(guān)文檔進行技術(shù)評審。選用技術(shù)評審會議的方式，提請評審管理部門組織評審，具體過程參見《評審過程》。評審組成員包括但不限于：項目經(jīng)理、需求工程師、系統(tǒng)分析員、開發(fā)工程師、質(zhì)量保證工程師、技術(shù)或業(yè)務專家輸入：《概要設計說明書》、《軟件需求說明書》、《數(shù)據(jù)庫設計說明書》輸出：《概要設計說明書》、《軟件需求說明書》、《數(shù)據(jù)庫設計說明書》、《評審報告》、《評審問題跟蹤表》概要設計評審通過后，概要設計說明書及其評審記錄納入受控庫管理。負責概要設計的系統(tǒng)分析員填寫《需求跟蹤矩陣》的相關(guān)設計項。詳細設計及評審對于項目規(guī)模較小、技術(shù)難度較低的項目，可以對設計過程進行裁剪。概要設計評審通過后，如果詳細設計過程沒有被裁剪，依據(jù)《軟件需求說明書》及《概要設計說明書》，系統(tǒng)分析員進一步細化系統(tǒng)的設計。針對每個子系統(tǒng)從功能、性能、輸入輸出、流程、接口、用戶界面等方面實施具體的詳細設計，編寫《詳細設計說明書》?！对敿氃O計說明書》必須經(jīng)過技術(shù)評審。8.6.1詳細設計根據(jù)確定的設計方法，并考慮是否可以復用以往項目或項目經(jīng)驗庫的設計及編碼，通盤考慮整個系統(tǒng)結(jié)構(gòu)、功能擴展性；選擇適當工具進行詳細設計，以獲得關(guān)于處理邏輯、數(shù)據(jù)結(jié)構(gòu)和數(shù)據(jù)定義的更加詳盡的描述，最終產(chǎn)生開發(fā)工程師可用的模塊說明?？梢园好枋龉δ軈?shù)說明性能（可選）用戶界面?流程邏輯?算法等詳細設計輸出《詳細設計說明書》、細化的《數(shù)據(jù)庫設計說明書》等。《數(shù)據(jù)庫設計說明書》可裁剪，裁剪的話需要在《概要設計說明書》中數(shù)據(jù)庫結(jié)構(gòu)中填寫相關(guān)內(nèi)容。8.6.2詳細設計評審為保證詳細設計的正確性、完整性和與概要設計和需求的一致性，項目經(jīng)理應組織人員對詳細設計說明書以及相關(guān)文檔進行技術(shù)評審。具體過程參見《評審過程》。?評審組成員包括但不限于：項目經(jīng)理、系統(tǒng)分析員、開發(fā)工程師、質(zhì)量保證工程師、技術(shù)或業(yè)務專家；?輸入：《詳細設計說明書》；?輸出：《詳細設計說明書》、《評審報告》、《評審問題跟蹤表》；詳細設計評審通過后，詳細設計說明書及其評審記錄納入受控庫管理。負責詳細設計的系統(tǒng)分析員填寫《需求跟蹤矩陣》的相關(guān)設計項。建立和維護技術(shù)資料包TDP：TechnicalDataPackage，技術(shù)資料包是一些元素的集合，這些元素和一種類型的產(chǎn)品或產(chǎn)品組件相關(guān)，技術(shù)資料包可能包括：產(chǎn)品總體結(jié)構(gòu)描述、確定的需求、產(chǎn)品組件描述、產(chǎn)品相關(guān)生命周期過程描述（如果沒有在獨立的產(chǎn)品組件中描述）、關(guān)鍵產(chǎn)品特性、必須的物理特性和約束關(guān)系、接口需求、保證需求被滿足的驗收條件、可操作性場景等。項目組需要把這些相關(guān)工作產(chǎn)品（概要設計、詳細設計、用戶提供的技術(shù)資料、公司開發(fā)所需的技術(shù)資料）納入到技術(shù)資料包（TDP）進行管理，填寫《技術(shù)數(shù)據(jù)包清單》并明確各角色人員對相關(guān)資料的訪問權(quán)限，記錄于《配置管理計劃》中。編碼系統(tǒng)設計完成后，進入編碼階段。項目組在系統(tǒng)設計時開始制定編碼規(guī)范，在進入編碼階段之前，必須確定項目的編碼規(guī)范：直接使用公司現(xiàn)有的編碼規(guī)范，請參見“編碼規(guī)范”文件夾。引用公司現(xiàn)有的編碼規(guī)范，在設計階段開始此基礎上進行修改，生成項目的編碼規(guī)范，必須經(jīng)過EPG審批后使用。公司沒有的，項目組應在設計階段開始建立新的編碼規(guī)范，經(jīng)過EPG審批后使用。編碼是把系統(tǒng)設計轉(zhuǎn)換為程序代碼的過程。軟件工程師：依據(jù)設計說明書，開展具體的程序代碼的編寫。嚴格項目的編程規(guī)范及項目組的系統(tǒng)約定。借鑒以往編碼的經(jīng)驗和代碼復用。編碼完成后系統(tǒng)進行單元測試或者代碼評審，具體根據(jù)《項目過程定義裁剪表》選擇相關(guān)活動（可以二選一，也可以全部進行）。單元測試單元測試分為單元測試用例設計及單元測試執(zhí)行兩個工作。單元測試用例的設計可以使用工具生成或人工設計，輸出可以是文檔化的測試用例《單元測試用例及記錄》或者測試源代碼。項目組可根據(jù)實際情況進行裁剪。單元測試需要關(guān)注以下幾個方面：源代碼編譯測試代碼是否通過編譯。SQL腳本測試數(shù)據(jù)庫腳本、存儲過程運行是否正常。模塊接口對被測模塊，信息是否能正確地流入和流出。局部數(shù)據(jù)結(jié)構(gòu)在模塊的工作過程中，其內(nèi)部的數(shù)據(jù)能否保持其完整性。邊界條件在邊界上模塊是否能正常工作。覆蓋條件模塊的運行是是否滿足設計的邏輯要求。?出錯處理——檢查模塊的錯誤處理設施是否有效。單元測試伴隨著缺陷修改的工作，模塊通過測試后，應在《單元測試報告》中記錄單元測試的結(jié)果以及遺留問題，作為集成測試開始的依據(jù)。完成各模塊的單元測試后，負責編碼的軟件工程師填寫《需求跟蹤矩陣》的相關(guān)編碼模塊。單元測試活動可根據(jù)項目特征進行裁剪。代碼走查項目經(jīng)理安排評審人員進行程序代碼檢查，檢查發(fā)現(xiàn)的問題納入缺陷管理（參見《缺陷管理規(guī)程》），直到問題解決。代碼評審采用個人復查方式執(zhí)