軟件開發(fā)流程管理規(guī)范標(biāo)準(zhǔn)

專業(yè)資料專業(yè)資料軟件開發(fā)流程管理規(guī)范軟件開發(fā)流程管理規(guī)范 1一、概述 2二、流程 2三、附件 3附件一、編碼規(guī)范 3、命名空間 3、命名規(guī)則 3文件夾及相關(guān)文件命名規(guī)則 3數(shù)據(jù)庫(kù)表命名規(guī)則 4、代碼規(guī)范 4代碼分層結(jié)構(gòu) 4編碼規(guī)范 5、注釋 6注釋模板設(shè)置 6手工添加注釋 7注釋要求 8附件二、軟件需求申請(qǐng)表 9附件三、軟件開發(fā)申請(qǐng)表 10附件四、項(xiàng)目組成成員表 11附件五、項(xiàng)目策劃/任務(wù)書 12附件六WBS表 13附件七、項(xiàng)目進(jìn)度計(jì)劃表 14附件八、項(xiàng)目風(fēng)險(xiǎn)管理表 15附件九、項(xiàng)目溝通計(jì)劃表 16附件十、項(xiàng)目會(huì)議紀(jì)要 17附件十一、項(xiàng)目狀態(tài)報(bào)告表 18附件十二、項(xiàng)目變更管理表 19附件十三、項(xiàng)目總結(jié)表 20、概述隨著公司規(guī)模的擴(kuò)大、各部門對(duì)軟件需求的激增、提高效率的工作要求， IT部門承接的IT部軟件開發(fā)項(xiàng)目特制訂本流程。T、流程T由上圖可以得出以下幾個(gè)關(guān)鍵步驟：一、需求部門：I、需求部門首先需要填寫《軟件需求申請(qǐng)表》，說(shuō)明需要開發(fā)的軟件具體用途徑、目前工作模式、工作不方便之處、基本功能等信息；IIIT使用系統(tǒng)后需要達(dá)到的狀態(tài)，可節(jié)省的人力、物力，調(diào)高的效率等信息；III、軟件開發(fā)測(cè)試完成之后，接受 IT部門的軟件使用培訓(xùn)，并填寫《參與培訓(xùn)確認(rèn)單》IV、軟件試用結(jié)束后，填寫《軟件驗(yàn)收表》，完成軟件項(xiàng)目的開發(fā)流程；V、在開發(fā)測(cè)試過(guò)程中，遇到開發(fā)風(fēng)險(xiǎn)增加、需求變更等，都需要配合 IT軟件開發(fā)人員填寫相關(guān)的IT部門：、積極對(duì)需求部門提出的《軟件需求申請(qǐng)表》進(jìn)行評(píng)審、審批，限 3個(gè)工作日完成及時(shí)反饋結(jié)果給需求部門；II、指導(dǎo)需求部門填寫各類表格；III、積極評(píng)審需求部門填寫的表格、積極溝通，有效獲得相對(duì)準(zhǔn)確的需求，并填寫完善，讓需求部門簽字確認(rèn)；IV、進(jìn)入開發(fā)流程后，積極填寫《項(xiàng)目成員組成表》、《項(xiàng)目策劃任務(wù)書》、《 WBS表》、《目進(jìn)度計(jì)劃表》等（具體見附件）；V、積極開展人員培訓(xùn)和軟件試用工作，編寫完善的《 XXX軟件試用說(shuō)明書》，并要求相關(guān)人員簽字確認(rèn)，并存檔處理。三、附件附件一、編碼規(guī)范1、命名空間公共類庫(kù)（公司功能業(yè)務(wù)）：（1）全局公共類庫(kù)：例：ECO.Common.DBhelper/Excel/email, 生成dll文件，添加至最小應(yīng)用庫(kù)可全程序引用（2）局部公共類庫(kù)（主要區(qū)分公司），命名方式為專有業(yè)務(wù)場(chǎng)景+專有業(yè)務(wù)名+具體類名：ECO.Gp（總部）/In（國(guó)內(nèi)市場(chǎng)）/Rb（生產(chǎn)）：（公共類庫(kù)）最多三層格式:ECO_英文名詞首字母大寫2、命名規(guī)則文件夾及相關(guān)文件命名規(guī)則文件夾：功能文件夾，采用駝峰形式，首字母大寫全稱窗體文件：采用駝峰形式，首字母大寫全稱c接口：1+采用駝峰形式，首字母大寫全稱c）方法名：采用駝峰形式，首字母大寫全稱窗體控件：同上局部變量：變量類型縮寫（int，fl，str）g）全局變量：不建議使用h）常量：全英文大寫，不建議出現(xiàn)在頁(yè)面i數(shù)組：功能名稱首字母小寫 +駝峰+Arri）j）List集合：功能名稱首字母小寫 +駝峰+Listk字典：功能名稱首字母小寫 +駝峰+Dick）l Dateset+Ds）m）DateTable駝峰+Dt1：類型前綴（小寫）+駝峰樣式名詞或名詞短語(yǔ)對(duì)于基本類型變量，前綴如下表：類型類型intdoublefloat前綴intflstringboolstringbooldatetimebytestrbooldatbyt對(duì)于對(duì)象類型變量，也可以采用類似基本類型方式，如 StringBuilder類型，可使用sb作前綴開頭，后跟變量名駝峰樣式。對(duì)于集合類型變量，如數(shù)組、 List、Dictionary，可以在變量命名的基礎(chǔ)上結(jié)尾加入集合類型簡(jiǎn)寫。如，sqlList，dataDic等。數(shù)據(jù)庫(kù)表命名規(guī)則命名方法：項(xiàng)目大寫首字母 +_+功能（全英文大寫）【多單詞組成的，取單詞首字母大寫組合表字段：類似變量命名索引：表名（或縮寫）+_+列名+idx注：ID、創(chuàng)建人（creator）、創(chuàng)建時(shí)間（createTime）、狀態(tài)（state）、創(chuàng)建人工號(hào)（createID）等字段為必須創(chuàng)建的字段；3、代碼規(guī)范代碼分層結(jié)構(gòu)表現(xiàn)層I11111 F1!表現(xiàn)層I11111 F1!邏輯層1111T1F咅層例如一個(gè)項(xiàng)目的一個(gè)模塊，可以創(chuàng)建文件夾結(jié)構(gòu)如下所示:MO￡_TESTUSERVIC<

表現(xiàn)層頁(yè)面 *.aspx數(shù)據(jù)層*.cs邏輯層*.cs表現(xiàn)層直接面向用戶，邏輯層負(fù)責(zé)后端邏輯處理，數(shù)據(jù)層負(fù)責(zé)和底層數(shù)據(jù)庫(kù)交互。表現(xiàn)層調(diào)用邏輯層代碼，只有查詢數(shù)據(jù)時(shí)，表現(xiàn)層可以直接調(diào)用數(shù)據(jù)層；編碼規(guī)范通用類功能必須唯一：每個(gè)文件中只有一個(gè)類（不包括內(nèi)部類）80c）200行內(nèi)1500行內(nèi)方法參數(shù)過(guò)長(zhǎng)，應(yīng)分行顯示，逗號(hào)至于末尾每行聲明一個(gè)變量，且盡量賦初值，同類型必須連續(xù)寫復(fù)合語(yǔ)句都需加大括｛｝，不要寫在一行、else盡量配對(duì)出現(xiàn)、catch 、finh）高扇入、合理扇出（盡量不超過(guò)三層）縮進(jìn)不允許空行遞歸要慎用，goto不允許使用k）方法內(nèi)禁止更改傳遞過(guò)來(lái)的參數(shù)l） 實(shí)體類中變量應(yīng)私有化，應(yīng)包含每個(gè)變量的 set及get方m）避免三層以上嵌套循環(huán)代碼應(yīng)包含正確性和容錯(cuò)性處理（try、catch、finally）編程時(shí)應(yīng)考慮代碼的效率（時(shí)間、空間），多循環(huán)內(nèi)側(cè)，變量聲明放在循環(huán)外=="，例如：equals，compareq）計(jì)算盡量避免除法設(shè)計(jì)方法可重用性else、finally、catch、日志必須有出口t）堆常量統(tǒng)一定義，避免用常量字符串u）變量必須初始化表現(xiàn)層頁(yè)面端1、JS代碼和CSS代碼統(tǒng)一放置在 html的head子元素中;2、JS代碼需要有注釋；3、頁(yè)面控件有嵌套情況的，各級(jí)需要縮進(jìn)，并且各級(jí)的頭尾對(duì)齊；頁(yè)面處理類1、頁(yè)面加載時(shí)謹(jǐn)慎處理Session置空；2、類中多處用到的變量建議創(chuàng)建成員變量，成員變量應(yīng)私有( private)，位于類代碼上方；3、除用于E前臺(tái)調(diào)用的如App.direct方法需為public外，其他方法建議均為private；4、Page_Load方法：建議將頁(yè)面加載方法中內(nèi)容加入if(!X.IsAjaxRequest){}代碼塊中，避免頁(yè)面每次操作后都調(diào)用Page_Load方法；}5、獲取頁(yè)面的服務(wù)端控件的值前需對(duì)控件值的 null和空進(jìn)行判斷，避免空指針異常；6、避免過(guò)多或復(fù)雜的邏輯處理代碼，統(tǒng)一調(diào)用邏輯層代碼，將展現(xiàn)和邏輯分離；7、對(duì)數(shù)據(jù)的增刪改操作不要直接調(diào)用數(shù)據(jù)層，查詢可直接調(diào)用數(shù)據(jù)層代碼；邏輯層1、除對(duì)表現(xiàn)層提供的接口方法外，其他方法均保持私有 private2、對(duì)數(shù)據(jù)庫(kù)數(shù)據(jù)處理調(diào)用數(shù)據(jù)處理層代碼3、對(duì)串行的數(shù)據(jù)處理時(shí)事務(wù)保證4、邏輯代碼容錯(cuò)性保證數(shù)據(jù)處理層1、除對(duì)外提供的接口方法外，其他方法均保持私有 private2、對(duì)數(shù)據(jù)庫(kù)的底層訪(獲取數(shù)據(jù)庫(kù)連接、執(zhí)行 sql語(yǔ)句、數(shù)據(jù)庫(kù)連接關(guān))均調(diào)用數(shù)據(jù)庫(kù)操作幫助類3、數(shù)據(jù)處理層類中只處理數(shù)據(jù)，避免業(yè)務(wù)邏輯代碼4、sql語(yǔ)句編寫時(shí)避免使用“+”5、數(shù)據(jù)庫(kù)操作幫助類中數(shù)據(jù)庫(kù)操作的容錯(cuò)性和事務(wù)處理(插入、更新、刪除操作需要事務(wù)保證)4、注釋編寫任何代碼都需要有代碼注釋，并且代碼修改后也要修改注釋，保證代碼注釋同步。注釋模板設(shè)置在vs安裝目錄，以下目錄中，找到class.cs文件，修改保存后，重啟vs，之后創(chuàng)建新類時(shí)即會(huì)自動(dòng)產(chǎn)生注釋。D:\ProgramFiles (x86)\Microsoft Visual 10.0\Common7\IDE\ltemTemplatesCache\CSharp\Code\2052\CIass.zipc<013EJOVA 5rightsreserved!l J 匚船沃胡機(jī)罵人抵獨(dú)蘇州 石農(nóng)公司using ;winT=…科— ■"二e■] ”二■-

Htjc.I]■L

ul.—I —=—*1 —. JiJI+ ———”n丄 二一” 一一丄 申，n(Starger1rSMwarkvera1cn$>=z.Bijsiag5y*tv,Lii)q:f^nlifiu3in>g''?tr.T亠/■■SINCEi^targetSranewzrjcverai2AIE:

gej社^zr.ejLd-eircu-n^ir^aF-scei(cliJB^sa^eire^re-iT^ajLei：但是修改后沒(méi)有效果。手工添加注釋創(chuàng)建新對(duì)象可以手工添加注釋:注釋寫法:塊注釋/*和*/行注釋以//開頭，可以有多行，每行前面都以 //開頭。文件頭注釋/*:Copyright?2013ECOVACSInc.Allrightsreserved!*科沃斯機(jī)器人科技(蘇州)有限公司類文件注釋/**DESC:類功能描述SINCE:.net版本CREATOR:創(chuàng)建人*DATE:*DATE:創(chuàng)建日期方法注釋/*/**DESC:方法功能描述PARAMS:參數(shù)說(shuō)明RETURN:返回值說(shuō)明*DATE:創(chuàng)建日期CREATOR:*DATE:創(chuàng)建日期注釋要求a）注釋量：20%~30%，項(xiàng)目完成周期延長(zhǎng) b）注釋地方：段前以及當(dāng)行之后上線之前無(wú)需版本號(hào)，上線之后需版本號(hào)，上線前統(tǒng)一為 1.0注釋與自身方法之間不為空，其他方法必須為空注釋代碼在上線后全刪除，上線后不允許無(wú)效代碼存在個(gè)源碼備份空間附件二、軟件需求申請(qǐng)表需求部門：需求部門：用途描述申請(qǐng)人：目前工作狀態(tài)基本功能描述部門主管建議簽字確認(rèn)（時(shí)間）附件三、軟件開發(fā)申請(qǐng)表需求部門： 申請(qǐng)人：具體功能模塊說(shuō)明目前工作流程（力、物力等）部門主管建議簽字確認(rèn)（時(shí)間）附件四、項(xiàng)目組成成員表項(xiàng)目組成成員表項(xiàng)目組成成員表ProjectTeamMembers一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName):制作人(Preparedby)：項(xiàng)目編號(hào)(ProjectCode)項(xiàng)目經(jīng)理(Project審核人(Reviewedby)：Manager):丿.成員項(xiàng)目組成員只項(xiàng)目角色所在部門職責(zé)項(xiàng)目起止日投入頻度及聯(lián)系電話主管經(jīng)理ProjectRoleDeptNameResponsibility Data工作量TimeTelNo.SupervisorName簽字Signature:項(xiàng)目贊助人Sponsor項(xiàng)目經(jīng)理ProjectManagerDate:項(xiàng)目角色包括項(xiàng)目贊助( Sponsor)、項(xiàng)目經(jīng)(Manager)、項(xiàng)目核心成(Coreteam和項(xiàng)目非核心成(Extendedteam )。附件五、項(xiàng)目策劃/任務(wù)書項(xiàng)目策劃/任務(wù)書ProjectPlan/Charter一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName): 項(xiàng)目編號(hào)(ProjectCode)制作人(Preparedby): 審核人（Reviewed項(xiàng)目經(jīng)理（Project by）：Manager):

生【炸口甘口1k1

/o+o、一、項(xiàng)目描述1、項(xiàng)目背景與目的（所有的項(xiàng)目均起始于某個(gè)商業(yè)問(wèn)題，該部分簡(jiǎn)要描述這些問(wèn)題）2、項(xiàng)目目標(biāo)（包括質(zhì)量目標(biāo)，工期目標(biāo)、費(fèi)用目標(biāo)和交付產(chǎn)品特征與特征的主要描述）3、項(xiàng)目里程碑計(jì)劃（包含里程碑的時(shí)間和成果）4、評(píng)價(jià)標(biāo)準(zhǔn)（說(shuō)明項(xiàng)目成果在何種情況下將被接受）5、項(xiàng)目假定與約束條件（說(shuō)明項(xiàng)目的主要假設(shè)條件和限制性條件）6、項(xiàng)目主要利益干系人（包括高管、客戶、職能部門主管、供應(yīng)商、項(xiàng)目贊助人、項(xiàng)目經(jīng)理、項(xiàng)目組成成員等干系人姓名 類別 部門 職務(wù)附件六、WBS 表一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName):項(xiàng)目編號(hào)(ProjectCode)制作人(Preparedby)：審核人(Reviewedby):項(xiàng)目經(jīng)理(Project制作日期(Data)：Manager):二、工作分解結(jié)構(gòu)分解代碼 任務(wù)名稱包含活動(dòng)工時(shí)估算人力資源 其他資源 費(fèi)用估計(jì) 工期WBSWBS表ProjectWorkBreakdownStructureWBSCodeTaskActivitiesIncludedEstimatedTimeEstimatedHREstimatedResourcesEstimatedCostExpectedDays附件七、項(xiàng)目進(jìn)度計(jì)劃表附件八、項(xiàng)目風(fēng)險(xiǎn)管理表項(xiàng)目風(fēng)險(xiǎn)表項(xiàng)目風(fēng)險(xiǎn)表ProjectRiskManagement一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName):項(xiàng)目編號(hào)(ProjectCode)制作人(Preparedby):審核人(Reviewedby):項(xiàng)目經(jīng)理(Project制作日期(Data)：Manager):風(fēng)險(xiǎn)項(xiàng)星風(fēng)率管理斷準(zhǔn)則高風(fēng)險(xiǎn)：＞60%發(fā)生風(fēng)險(xiǎn)的可能性序號(hào)SequenceNO.風(fēng)險(xiǎn)描述RiskDescription發(fā)生概率HappeningProbability影響程度Influencedegree風(fēng)險(xiǎn)等級(jí)風(fēng)險(xiǎn)響應(yīng)計(jì)劃RiskLevelRiskPlanResponse責(zé)任人Riskowner開放/關(guān)閉Open/Closed項(xiàng)目溝通計(jì)劃表ProjectCommunicationPlan一、項(xiàng)目基本情況項(xiàng)目名稱(項(xiàng)目溝通計(jì)劃表ProjectCommunicationPlan一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName):制作人(Preparedby):項(xiàng)目編號(hào)(ProjectCode)審核人(Reviewedby):項(xiàng)目經(jīng)理（Project制作日期（Data）:Manager):利益項(xiàng)系人通計(jì)劃Stakeholders所需信息頻率方法責(zé)任人InfoNeededFrequencyMeansRiskowner附件十、項(xiàng)目會(huì)議紀(jì)要項(xiàng)目會(huì)議紀(jì)要ProjectMeetingMinutes一、基本情況會(huì)議名稱(MeetingName): 召集人(CalledBy):會(huì)議日期(MeetingDate): 開始時(shí)間(StartTime):會(huì)議地點(diǎn)(MeetingPlace): 持續(xù)時(shí)間(MeetingDuration)記錄人(MinutesBy)： 審核人(ReviewedBy二、會(huì)議目標(biāo)簡(jiǎn)要說(shuō)明會(huì)議的目標(biāo)，包括期望達(dá)到的結(jié)果三、參加人員(列出參加會(huì)議的人員，他在項(xiàng)目中的頭銜或角色)四、發(fā)放材料(列出會(huì)議討論的所有項(xiàng)目資料)五、發(fā)言記錄(記錄發(fā)言人的觀點(diǎn)、意見和建議)六、會(huì)議決議(說(shuō)明會(huì)議結(jié)論)七、會(huì)議紀(jì)要發(fā)放范圍附件十一、項(xiàng)目狀態(tài)報(bào)告表項(xiàng)目狀態(tài)報(bào)告表一、項(xiàng)目基本情況一、項(xiàng)目基本情況項(xiàng)目名稱(ProjectName):制作人(Preparedby):項(xiàng)目經(jīng)理（Project項(xiàng)目編號(hào)（ProjectCode）審核人（Reviewedby）:制作日期（Data）：Manager):□按計(jì)劃進(jìn)行□比計(jì)劃提前□落后計(jì)劃當(dāng)報(bào)周目狀況二、當(dāng)前任務(wù)狀態(tài)（簡(jiǎn)要描述任務(wù)進(jìn)展情況）關(guān)鍵人物狀態(tài)指示狀態(tài)描述三、本周期內(nèi)的主要活動(dòng)（對(duì)本周期內(nèi)的主要交付物進(jìn)行總結(jié)）四、下一個(gè)匯報(bào)周期內(nèi)的活動(dòng)計(jì)劃（描述活動(dòng)需要與項(xiàng)目計(jì)劃和WBS相對(duì)應(yīng)）.五、財(cái)務(wù)狀況六、上期遺留問(wèn)題的處理（說(shuō)明上一個(gè)匯報(bào)周期內(nèi)問(wèn)題的處理意見和處理結(jié)果）七、本期問(wèn)題與求助附件十二、項(xiàng)目變更管理表項(xiàng)目變更