開發(fā)流程規(guī)范--按角色

1、開發(fā)流程規(guī)范質(zhì)控測試室交易業(yè)務(wù)支撐部 2014年09月282 開發(fā)準(zhǔn)備開發(fā)準(zhǔn)備01 編碼調(diào)試編碼調(diào)試02 單元測試單元測試03 代碼審查代碼審查04 系統(tǒng)集成系統(tǒng)集成05目 錄3開發(fā)準(zhǔn)備概述細(xì)化開發(fā)計(jì)劃：包括編程計(jì)劃、單元測試計(jì)細(xì)化開發(fā)計(jì)劃：包括編程計(jì)劃、單元測試計(jì)劃、代碼審查計(jì)劃、系統(tǒng)集成計(jì)劃劃、代碼審查計(jì)劃、系統(tǒng)集成計(jì)劃制定開發(fā)規(guī)范：從展示系統(tǒng)上取組織級的規(guī)制定開發(fā)規(guī)范：從展示系統(tǒng)上取組織級的規(guī)范（范（C+C+編程規(guī)范、編程規(guī)范、JavaJava開發(fā)規(guī)范、開發(fā)規(guī)范、shellshell開開發(fā)規(guī)范等）進(jìn)行裁剪后確定項(xiàng)目組的開發(fā)規(guī)發(fā)規(guī)范等）進(jìn)行裁剪后確定項(xiàng)目組的開發(fā)規(guī)范。范。開發(fā)環(huán)境的準(zhǔn)備：包

2、括對代碼審查、單元測開發(fā)環(huán)境的準(zhǔn)備：包括對代碼審查、單元測試的要求試的要求4 制定開發(fā)計(jì)劃溝通計(jì)劃溝通計(jì)劃系統(tǒng)資源計(jì)劃系統(tǒng)資源計(jì)劃單元測試計(jì)劃單元測試計(jì)劃代碼審查計(jì)劃代碼審查計(jì)劃 配置計(jì)劃配置計(jì)劃系統(tǒng)集成計(jì)劃系統(tǒng)集成計(jì)劃開發(fā)總體開發(fā)總體計(jì)劃計(jì)劃項(xiàng)目經(jīng)理依據(jù)項(xiàng)目規(guī)模確定項(xiàng)目開發(fā)小組，確定每個項(xiàng)目開發(fā)小組的小組負(fù)責(zé)人（開發(fā)組長），對小組的工作目標(biāo)進(jìn)行明確，細(xì)化開發(fā)總體計(jì)劃編程計(jì)劃編程計(jì)劃5 開發(fā)計(jì)劃評審 開發(fā)總體計(jì)劃評審開發(fā)總體計(jì)劃評審評審，一般分為三種形式進(jìn)行：正式的技術(shù)評審，一般會議評審和郵件評審。總體測試計(jì)劃為正式的技術(shù)評審流程如右圖：參與評審的人員有：1.項(xiàng)目經(jīng)理2.開發(fā)組員3.設(shè)計(jì)組長4

3、.需求組長5.測試組長6.QA6 開發(fā)計(jì)劃入庫SVN入庫內(nèi)容： 評審結(jié)束前需制定評審計(jì)劃，并入庫到SVN上 開發(fā)總體計(jì)劃評審結(jié)束需要?dú)w檔入庫 SVN上 評審結(jié)束后輸出評審報告，并入庫到SVN上SVN入庫路徑：u開發(fā)總體計(jì)劃入庫到SVN的目錄： XXXX項(xiàng)目trunkdoc02_管理文檔01_項(xiàng)目管理01_項(xiàng)目計(jì)劃u評審計(jì)劃以及評審報告入到SVN的目錄： XXXX項(xiàng)目trunkdoc03_技術(shù)文檔15_評審記錄07_計(jì)劃評審開發(fā)計(jì)劃入庫開發(fā)計(jì)劃入庫7Java開發(fā)規(guī)范C+編程規(guī)范shell開發(fā)規(guī)范開發(fā)組長組織開發(fā)小組確定編程規(guī)范，例如C+編程規(guī)范、Java開發(fā)規(guī)范、shell開發(fā)規(guī)范等。制定開發(fā)規(guī)

4、范8開發(fā)規(guī)范入庫SVN入庫內(nèi)容： 開發(fā)規(guī)范制定后需經(jīng)過評審后入到SVN庫上SVN入庫路徑：u開發(fā)規(guī)范入庫到SVN的目錄： XXXX項(xiàng)目trunkdoc02_管理文檔06_開發(fā)規(guī)范開發(fā)過程規(guī)范說明：如果機(jī)構(gòu)已經(jīng)存在相應(yīng)的編程規(guī)范且符合項(xiàng)目的實(shí)際情況，則采用之如果機(jī)構(gòu)不存在相應(yīng)的編程規(guī)范或與項(xiàng)目實(shí)際情況有所差異，則由開發(fā)小組共同制定開發(fā)規(guī)范入庫開發(fā)規(guī)范入庫9 質(zhì)量控制質(zhì)量控制內(nèi)容內(nèi)容問題跟蹤缺陷跟蹤控制代碼走查單元測試制定開發(fā)質(zhì)量控質(zhì)辦法開發(fā)組長牽頭組織開發(fā)小組、質(zhì)量控制組共同確定開發(fā)過程開發(fā)質(zhì)量控制辦法。10開發(fā)質(zhì)量控制辦法入庫SVN入庫內(nèi)容： 開發(fā)質(zhì)量控制辦法制定后需經(jīng)過評審后入到SVN庫上S

5、VN入庫路徑：u開發(fā)質(zhì)量控制辦法入庫到SVN的目錄： XXXX項(xiàng)目trunkdoc 02_管理文檔06_開發(fā)規(guī)范u 會議評審記錄SVN的目錄： XXXX項(xiàng)目trunkdoc 03_技術(shù)文檔14_評審記錄08_其它評審記錄說明：如果機(jī)構(gòu)已經(jīng)存在相應(yīng)的質(zhì)量控制辦法且符合項(xiàng)目的實(shí)際情況，則采用之如果機(jī)構(gòu)不存在相應(yīng)的質(zhì)量控制辦法或與項(xiàng)目實(shí)際情況有所差異，則由開發(fā)小組共同制定質(zhì)量控制辦法入庫質(zhì)量控制辦法入庫11 開發(fā)組長協(xié)調(diào)集成組協(xié)助開發(fā)小組完成開發(fā)環(huán)境的準(zhǔn)備 開發(fā)組需要整理開發(fā)環(huán)境的需求并提交給集成組，包括對主機(jī)、存儲、 第三方軟件等方面的需求 集成人員完成開發(fā)環(huán)境部署 開發(fā)人員需確認(rèn)開發(fā)環(huán)境的正確性

6、和完備性開發(fā)環(huán)境準(zhǔn)備過程開發(fā)環(huán)境準(zhǔn)備過程開發(fā)環(huán)境準(zhǔn)備12開發(fā)培訓(xùn) 開發(fā)組長根據(jù)小組開發(fā)的范圍和要求，了解組員的技能、業(yè)務(wù)背景，確定開發(fā)培訓(xùn)的內(nèi)容和計(jì)劃。 根據(jù)培訓(xùn)計(jì)劃，組織給開發(fā)人員的培訓(xùn)，內(nèi)容一般包括業(yè)務(wù)背景、技術(shù)技能、框架知識、開發(fā)工具、開發(fā)環(huán)境等。u培訓(xùn)材料入庫到SVN的目錄： XXXX項(xiàng)目04_培訓(xùn)文檔13 開發(fā)準(zhǔn)備開發(fā)準(zhǔn)備01 編碼調(diào)試編碼調(diào)試02 單元測試單元測試03 代碼審查代碼審查04 系統(tǒng)集成系統(tǒng)集成05目 錄14編碼調(diào)試概述 架構(gòu)設(shè)計(jì)和模塊設(shè)計(jì)已經(jīng)完成之后，由開發(fā)組長組織開發(fā)人員進(jìn)入編碼 編碼調(diào)試包括：代碼編寫、代碼調(diào)試，并且通常需要反復(fù)迭代 編碼調(diào)試過程中要注意缺陷跟蹤和

7、改錯15 詳細(xì)設(shè)計(jì)文檔 編程日志 編譯通過、可以啟動的程序和相應(yīng)代碼代碼編寫與調(diào)試開發(fā)人員根據(jù)“編程計(jì)劃”編寫軟件的代碼開發(fā)人員在編寫完成每個模塊時，必須對自己的代碼進(jìn)行必要的審查和調(diào)試開發(fā)人員在編寫完成每個模塊時，必須對自己的代碼進(jìn)行必要的審查和調(diào)試16代碼入庫SVN入庫內(nèi)容： 編譯通過、可以啟動的程序和相應(yīng)代碼需庫到SVN上； 開發(fā)編寫詳細(xì)設(shè)計(jì)文檔經(jīng)評審后需要?dú)w檔入庫 SVN上；SVN入庫路徑：u編譯通過的代碼入庫到SVN的目錄： XXXX項(xiàng)目trunkcodeu詳細(xì)設(shè)計(jì)文檔入到SVN的目錄： XXXX項(xiàng)目trunkdoc03_技術(shù)文檔04_詳細(xì)設(shè)計(jì)u會議評審記錄SVN的目錄： XXXX項(xiàng)

8、目trunkdoc03_技術(shù)文檔14_評審記錄04_IDD評審記錄代碼入庫代碼入庫17 開發(fā)準(zhǔn)備開發(fā)準(zhǔn)備01 編碼調(diào)試編碼調(diào)試02 單元測試單元測試03 代碼審查代碼審查04 系統(tǒng)集成系統(tǒng)集成05目 錄18單元測試概述 詳細(xì)設(shè)計(jì)文檔完成之后，開發(fā)組長可組詳細(xì)設(shè)計(jì)文檔完成之后，開發(fā)組長可組織單元測試案例的編寫；織單元測試案例的編寫； 編碼調(diào)試結(jié)束后，則執(zhí)行單元測試案例編碼調(diào)試結(jié)束后，則執(zhí)行單元測試案例，記錄單元測試結(jié)果，開發(fā)人員，記錄單元測試結(jié)果，開發(fā)人員根據(jù)測根據(jù)測試結(jié)果試結(jié)果則進(jìn)行相應(yīng)的修改。則進(jìn)行相應(yīng)的修改。19編寫并執(zhí)行單元測試用例 單元測試用例需保證覆蓋到一定百分比（參看質(zhì)量目標(biāo)）以上

9、修改的單元測試用例需保證覆蓋到一定百分比（參看質(zhì)量目標(biāo)）以上修改的或增加的代碼或增加的代碼 如果項(xiàng)目有詳細(xì)設(shè)計(jì)文檔，則編寫單元測試用例在編寫代碼前進(jìn)行；如果項(xiàng)目有詳細(xì)設(shè)計(jì)文檔，則編寫單元測試用例在編寫代碼前進(jìn)行；否則編寫單元測試用例在編寫代碼之中或之后進(jìn)行否則編寫單元測試用例在編寫代碼之中或之后進(jìn)行 由開發(fā)組和測試組共同挑選出優(yōu)先級較高和較典型的一部分案例作為由開發(fā)組和測試組共同挑選出優(yōu)先級較高和較典型的一部分案例作為開發(fā)階段的預(yù)測試案例，并納入開發(fā)階段單元測試案例范圍開發(fā)階段的預(yù)測試案例，并納入開發(fā)階段單元測試案例范圍 單元測試案例需要模塊負(fù)責(zé)人審核通過單元測試案例需要模塊負(fù)責(zé)人審核通過用例

10、編寫要求用例編寫要求20執(zhí)行單元測試 開發(fā)人員對自己編寫的代碼進(jìn)行單元測試：開發(fā)人員對自己編寫的代碼進(jìn)行單元測試：l 執(zhí)行單元測試案例，記錄相應(yīng)的處理結(jié)果執(zhí)行單元測試案例，記錄相應(yīng)的處理結(jié)果l 如有單元測試案例不通過，則修改相關(guān)的缺陷如有單元測試案例不通過，則修改相關(guān)的缺陷l 單元測試階段，開發(fā)人員必須保證測試組提供的預(yù)測試案例可以全部通過單元測試階段，開發(fā)人員必須保證測試組提供的預(yù)測試案例可以全部通過 單元測試案例執(zhí)行情況需要模塊負(fù)責(zé)人跟蹤并確保質(zhì)量單元測試案例執(zhí)行情況需要模塊負(fù)責(zé)人跟蹤并確保質(zhì)量用例執(zhí)行說明用例執(zhí)行說明21單元測試交附件入庫SVN入庫內(nèi)容： 單元測試案例編寫后開發(fā)內(nèi)部需進(jìn)行

11、評審，并將評審后的案例入庫到SVN上；評審產(chǎn)生的會議紀(jì)要和用評審結(jié)果報告需入庫到SVN庫上； 執(zhí)行后的用例結(jié)果表同樣需入到SVN庫上；SVN入庫路徑：u單元測試用例入庫到SVN的目錄： XXXX項(xiàng)目03_技術(shù)文檔05_單元測試01_單元測試用例u單元測試報告SVN的目錄： XXXX項(xiàng)目03_技術(shù)文檔05_單元測試03_單元測試報告u會議評審記錄SVN的目錄： XXXX項(xiàng)目03_技術(shù)文檔14_評審記錄06_測試用例評審記錄案例入庫案例入庫22 開發(fā)準(zhǔn)備開發(fā)準(zhǔn)備01 編碼調(diào)試編碼調(diào)試02 單元測試單元測試03 代碼審查代碼審查04 系統(tǒng)集成系統(tǒng)集成05目 錄23代碼審查概述 代碼審查包括兩種方式：

12、代碼靜態(tài)工具代碼審查包括兩種方式：代碼靜態(tài)工具檢查和代碼人工評審檢查和代碼人工評審 代碼靜態(tài)檢查子過程包括以下活動：安代碼靜態(tài)檢查子過程包括以下活動：安裝代碼靜態(tài)檢查工具、對代碼進(jìn)行靜態(tài)裝代碼靜態(tài)檢查工具、對代碼進(jìn)行靜態(tài)檢查并輸出檢查報告、檢查缺陷修改情檢查并輸出檢查報告、檢查缺陷修改情況。況。 代碼人工評審子過程包括以下活動：確代碼人工評審子過程包括以下活動：確定審查范圍、編寫代碼審查列表、代碼定審查范圍、編寫代碼審查列表、代碼審查。審查。單元測試完成后，開發(fā)組長確定代碼審查的人員，制定代碼審查計(jì)劃，組織單元測試完成后，開發(fā)組長確定代碼審查的人員，制定代碼審查計(jì)劃，組織進(jìn)行代碼審查，輸出相應(yīng)

13、的報告。進(jìn)行代碼審查，輸出相應(yīng)的報告。24制定代碼審查計(jì)劃開發(fā)組長結(jié)合項(xiàng)目的裁剪報告以及項(xiàng)目的實(shí)際情況，制定代碼審 查計(jì)劃代碼審查計(jì)劃的內(nèi)容應(yīng)包括：代碼審查方式、范圍以及時間安排確定后提交項(xiàng)目組進(jìn)行審核代碼審查方式和范圍制定的標(biāo)準(zhǔn)代碼審查方式和范圍制定的標(biāo)準(zhǔn)所有開發(fā)人員入庫的代碼必須進(jìn)行靜態(tài)檢查。如果復(fù)用之前的代碼則無須進(jìn)行，避免代碼修改影響到老系統(tǒng)在項(xiàng)目裁剪時人工評審活動屬于可裁剪項(xiàng)，當(dāng)項(xiàng)目緊急時，可以不做人工評審或者只選取部分核心代碼進(jìn)行審查25準(zhǔn)備環(huán)境準(zhǔn)備環(huán)境檢查代碼并輸出檢查代碼并輸出報告報告檢查缺陷修改情況檢查缺陷修改情況開發(fā)組長組織進(jìn)行代碼靜態(tài)檢查，相關(guān)開發(fā)人員按照代碼靜態(tài)工具檢查

14、指南安裝相應(yīng)的代碼靜態(tài)檢查工具。目前C+代碼使用CppCheck進(jìn)行檢查，JAVA代碼使用FindBugs進(jìn)行檢查，圈復(fù)雜度使用SourceMonitor進(jìn)行統(tǒng)計(jì)使用相應(yīng)的工具對代碼進(jìn)行靜態(tài)檢查，工具自動生成報告，采集報告中的數(shù)據(jù)，按照代碼靜態(tài)檢查報告模板輸出相應(yīng)的檢查報告，QA在審計(jì)時會檢查相關(guān)報告；代碼靜態(tài)檢查需要至少進(jìn)行兩輪的檢查，在開發(fā)階段完成后，QA會對代碼靜態(tài)檢查活動以及檢查報告的完整性以及準(zhǔn)確性進(jìn)行審計(jì)，必要時，QA會抽查部分項(xiàng)目的檢查結(jié)果開發(fā)人員對于檢查出來的問題進(jìn)行修改，其中：l高級警告必須進(jìn)行修改； l低級警告視實(shí)際情況選擇是否進(jìn)行修改； l對于圈復(fù)雜度高的模塊，如果沒有特

15、殊要求需要進(jìn)行優(yōu)化； l檢查出來的問題修改完后應(yīng)再進(jìn)行一次代碼檢查，并且按照要求輸出相應(yīng)的檢查報告。靜態(tài)工具檢查26確定審查范圍確定審查范圍人工評審需要在每個開發(fā)人員用代碼靜態(tài)檢查工具檢查自己的代碼無高級警告之后再開始進(jìn)行。編寫代碼審查列表編寫代碼審查列表 代碼審查代碼審查開發(fā)組長（或者架構(gòu)師）組織項(xiàng)目主要技術(shù)人員，對于項(xiàng)目中技術(shù)和模塊的重要程度進(jìn)行分析，結(jié)合當(dāng)前項(xiàng)目實(shí)際情況，確定代碼評審的范圍和評審的方式。例如，核心技術(shù)和核心模塊必須代碼評審，非核心模塊走查等。對于需要納入的部門技術(shù)資源池的核心代碼，需要嚴(yán)格按照部門技術(shù)資產(chǎn)管理相關(guān)流程進(jìn)行代碼評審。根據(jù)項(xiàng)目的實(shí)際情況編寫代碼審查列表，列表中

16、可以涉及對代碼各個方面的問題，如業(yè)務(wù)需求點(diǎn)、改造點(diǎn)、格式、算法效率、內(nèi)存使用等等。此外，代碼審查列表頁可以直接用公共既定的審查列表，或者在之前的審查列表上進(jìn)行更新。開發(fā)組根據(jù)項(xiàng)目需求以及模塊的重要性，確定代碼審查范圍、方式和計(jì)劃，開發(fā)人員進(jìn)行代碼審查，并將結(jié)果填入代碼審查列表中。如發(fā)現(xiàn)代碼審查不通過，記錄在代碼評審報告中，并且開發(fā)人員修改相關(guān)的缺陷。人工評審27代碼審查文檔入庫代碼審查代碼審查入庫入庫SVN入庫內(nèi)容： 開發(fā)人員需對評審后的代碼入庫到SVN上；SVN入庫路徑：u代碼評審記錄入庫到SVN的目錄： XXXX項(xiàng)目trunkdoc 03_技術(shù)文檔14_評審記錄05_代碼評審記錄28 開發(fā)

17、準(zhǔn)備開發(fā)準(zhǔn)備01 編碼調(diào)試編碼調(diào)試02 單元測試單元測試03 代碼審查代碼審查04 系統(tǒng)集成系統(tǒng)集成05目 錄29系統(tǒng)集成概述 完成單元測試、代碼審查后，即模塊開完成單元測試、代碼審查后，即模塊開發(fā)已基本完成，由開發(fā)組長指定開發(fā)人發(fā)已基本完成，由開發(fā)組長指定開發(fā)人員搭建集成環(huán)境，進(jìn)行系統(tǒng)集成，確保員搭建集成環(huán)境，進(jìn)行系統(tǒng)集成，確保模塊、組件之間的接口兼容性，編寫模塊、組件之間的接口兼容性，編寫Deploy guide，并形成可以交付測試組，并形成可以交付測試組的程序和組件。的程序和組件。 系統(tǒng)集成子過程包括以下活動：系統(tǒng)集成子過程包括以下活動：制定系統(tǒng)集成計(jì)劃、搭建集成環(huán)境、系統(tǒng)集制定系統(tǒng)集成

18、計(jì)劃、搭建集成環(huán)境、系統(tǒng)集成。成。30制定系統(tǒng)集成計(jì)劃 系統(tǒng)集成計(jì)劃應(yīng)該與項(xiàng)目總體計(jì)劃、開發(fā)計(jì)劃中的進(jìn)度、資源安排等系統(tǒng)集成計(jì)劃應(yīng)該與項(xiàng)目總體計(jì)劃、開發(fā)計(jì)劃中的進(jìn)度、資源安排等一致一致 根據(jù)各組件、模塊的可用性、模塊之前的依賴性、測試設(shè)備、規(guī)程、根據(jù)各組件、模塊的可用性、模塊之前的依賴性、測試設(shè)備、規(guī)程、集成環(huán)境及人員技能等選擇相應(yīng)集成順序方案以及集成階段完成的標(biāo)集成環(huán)境及人員技能等選擇相應(yīng)集成順序方案以及集成階段完成的標(biāo)準(zhǔn)準(zhǔn) 由項(xiàng)目經(jīng)理、設(shè)計(jì)人員、開發(fā)人員、測試人員評審集成計(jì)劃由項(xiàng)目經(jīng)理、設(shè)計(jì)人員、開發(fā)人員、測試人員評審集成計(jì)劃 集成計(jì)劃包括前期的模塊集成計(jì)劃、以及后期的系統(tǒng)集成計(jì)劃包括前期

19、的模塊集成計(jì)劃、以及后期的系統(tǒng)/外圍接口集成計(jì)外圍接口集成計(jì)劃劃31 開發(fā)人員識別產(chǎn)品集成環(huán)境需求，包括數(shù)據(jù)庫、主機(jī)、產(chǎn)品環(huán)境、數(shù)據(jù)開發(fā)人員識別產(chǎn)品集成環(huán)境需求，包括數(shù)據(jù)庫、主機(jī)、產(chǎn)品環(huán)境、數(shù)據(jù)遷移等遷移等 集成人員根據(jù)開發(fā)人員提交的集成環(huán)境需求進(jìn)行環(huán)境搭建，環(huán)境搭建不集成人員根據(jù)開發(fā)人員提交的集成環(huán)境需求進(jìn)行環(huán)境搭建，環(huán)境搭建不僅包括系統(tǒng)本身環(huán)境搭建，還需要包括外部系統(tǒng)的集成環(huán)境搭建僅包括系統(tǒng)本身環(huán)境搭建，還需要包括外部系統(tǒng)的集成環(huán)境搭建 開發(fā)人員部署應(yīng)用開發(fā)人員部署應(yīng)用 開發(fā)人員檢查、驗(yàn)證測試環(huán)境開發(fā)人員檢查、驗(yàn)證測試環(huán)境搭建集成環(huán)境32功能模塊集成開完完成并完成單元測試后，以模塊為單為進(jìn)

20、行集成；功能模塊集成包括數(shù)據(jù)庫、中間件、公共組件、子模塊之間的集成，確保模塊內(nèi)部接口的準(zhǔn)確性和健壯性；編寫該模塊的Deploy guide，包括環(huán)境變量設(shè)置、創(chuàng)建路徑、新建數(shù)據(jù)庫對象、部署應(yīng)用等內(nèi)容；評審并修訂該模塊的deploy guide根據(jù)功能規(guī)格說明書和可運(yùn)營系統(tǒng)的現(xiàn)有實(shí)現(xiàn)編寫用戶手冊、幫助文檔、培訓(xùn)教材；手冊編寫完成之后，開發(fā)組長應(yīng)組織人員對手冊進(jìn)行評審；模塊集成完以后，程序提交測試前，需要給測試提供模塊實(shí)現(xiàn)的相關(guān)培訓(xùn)；開發(fā)完成模塊的開發(fā)、單元測試，并且完成了模塊內(nèi)部的集成測試以后，提交代碼和Deploy guide給測試組進(jìn)行模塊功能測試33系統(tǒng)系統(tǒng)/ /外圍接口集成外圍接口集成模塊開發(fā)和集成完成后需對整個系統(tǒng)進(jìn)行集成，一般包括：后臺集成、前臺集成、前后臺集成，確保整個系統(tǒng)業(yè)務(wù)功能的實(shí)來；系統(tǒng)集成完成之后，需對該系統(tǒng)與其它系統(tǒng)外圍接口進(jìn)行集成，確保與其它系統(tǒng)