軟件開發(fā)流程管理規(guī)范標準

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

表現(xiàn)層頁面 *.aspx數(shù)據(jù)層*.cs邏輯層*.cs表現(xiàn)層直接面向用戶，邏輯層負責后端邏輯處理，數(shù)據(jù)層負責和底層數(shù)據(jù)庫交互。表現(xiàn)層調用邏輯層代碼，只有查詢數(shù)據(jù)時，表現(xiàn)層可以直接調用數(shù)據(jù)層；編碼規(guī)范通用類功能必須唯一：每個文件中只有一個類（不包括內部類）80c）200行內1500行內方法參數(shù)過長，應分行顯示，逗號至于末尾每行聲明一個變量，且盡量賦初值，同類型必須連續(xù)寫復合語句都需加大括｛｝，不要寫在一行、else盡量配對出現(xiàn)、catch 、finh）高扇入、合理扇出（盡量不超過三層）縮進不允許空行遞歸要慎用，goto不允許使用k）方法內禁止更改傳遞過來的參數(shù)l） 實體類中變量應私有化，應包含每個變量的 set及get方m）避免三層以上嵌套循環(huán)代碼應包含正確性和容錯性處理（try、catch、finally）編程時應考慮代碼的效率（時間、空間），多循環(huán)內側，變量聲明放在循環(huán)外=="，例如：equals，compareq）計算盡量避免除法設計方法可重用性else、finally、catch、日志必須有出口t）堆常量統(tǒng)一定義，避免用常量字符串u）變量必須初始化表現(xiàn)層頁面端1、JS代碼和CSS代碼統(tǒng)一放置在 html的head子元素中;2、JS代碼需要有注釋；3、頁面控件有嵌套情況的，各級需要縮進，并且各級的頭尾對齊；頁面處理類1、頁面加載時謹慎處理Session置空；2、類中多處用到的變量建議創(chuàng)建成員變量，成員變量應私有( private)，位于類代碼上方；3、除用于E前臺調用的如App.direct方法需為public外，其他方法建議均為private；4、Page_Load方法：建議將頁面加載方法中內容加入if(!X.IsAjaxRequest){}代碼塊中，避免頁面每次操作后都調用Page_Load方法；}5、獲取頁面的服務端控件的值前需對控件值的 null和空進行判斷，避免空指針異常；6、避免過多或復雜的邏輯處理代碼，統(tǒng)一調用邏輯層代碼，將展現(xiàn)和邏輯分離；7、對數(shù)據(jù)的增刪改操作不要直接調用數(shù)據(jù)層，查詢可直接調用數(shù)據(jù)層代碼；邏輯層1、除對表現(xiàn)層提供的接口方法外，其他方法均保持私有 private2、對數(shù)據(jù)庫數(shù)據(jù)處理調用數(shù)據(jù)處理層代碼3、對串行的數(shù)據(jù)處理時事務保證4、邏輯代碼容錯性保證數(shù)據(jù)處理層1、除對外提供的接口方法外，其他方法均保持私有 private2、對數(shù)據(jù)庫的底層訪(獲取數(shù)據(jù)庫連接、執(zhí)行 sql語句、數(shù)據(jù)庫連接關)均調用數(shù)據(jù)庫操作幫助類3、數(shù)據(jù)處理層類中只處理數(shù)據(jù)，避免業(yè)務邏輯代碼4、sql語句編寫時避免使用“+”5、數(shù)據(jù)庫操作幫助類中數(shù)據(jù)庫操作的容錯性和事務處理(插入、更新、刪除操作需要事務保證)4、注釋編寫任何代碼都需要有代碼注釋，并且代碼修改后也要修改注釋，保證代碼注釋同步。注釋模板設置在vs安裝目錄，以下目錄中，找到class.cs文件，修改保存后，重啟vs，之后創(chuàng)建新類時即會自動產生注釋。D:\ProgramFiles (x86)\Microsoft Visual 10.0\Common7\IDE\ltemTemplatesCache\CSharp\Code\2052\CIass.zipc<013EJOVA 5rightsreserved!l J 匚船沃胡機罵人抵獨蘇州 石農公司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：但是修改后沒有效果。手工添加注釋創(chuàng)建新對象可以手工添加注釋:注釋寫法:塊注釋/*和*/行注釋以//開頭，可以有多行，每行前面都以 //開頭。文件頭注釋/*:Copyright?2013ECOVACSInc.Allrightsreserved!*科沃斯機器人科技(蘇州)有限公司類文件注釋/**DESC:類功能描述SINCE:.net版本CREATOR:創(chuàng)建人*DATE:*DATE:創(chuàng)建日期方法注釋/*/**DESC:方法功能描述PARAMS:參數(shù)說明RETURN:返回值說明*DATE:創(chuàng)建日期CREATOR:*DATE:創(chuàng)建日期注釋要求a）注釋量：20%~30%，項目完成周期延長 b）注釋地方：段前以及當行之后上線之前無需版本號，上線之后需版本號，上線前統(tǒng)一為 1.0注釋與自身方法之間不為空，其他方法必須為空注釋代碼在上線后全刪除，上線后不允許無效代碼存在個源碼備份空間附件二、軟件需求申請表需求部門：需求部門：用途描述申請人：目前工作狀態(tài)基本功能描述部門主管建議簽字確認（時間）附件三、軟件開發(fā)申請表需求部門： 申請人：具體功能模塊說明目前工作流程（力、物力等）部門主管建議簽字確認（時間）附件四、項目組成成員表項目組成成員表項目組成成員表ProjectTeamMembers一、項目基本情況項目名稱(ProjectName):制作人(Preparedby)：項目編號(ProjectCode)項目經理(Project審核人(Reviewedby)：Manager):丿.成員項目組成員只項目角色所在部門職責項目起止日投入頻度及聯(lián)系電話主管經理ProjectRoleDeptNameResponsibility Data工作量TimeTelNo.SupervisorName簽字Signature:項目贊助人Sponsor項目經理ProjectManagerDate:項目角色包括項目贊助( Sponsor)、項目經(Manager)、項目核心成(Coreteam和項目非核心成(Extendedteam )。附件五、項目策劃/任務書項目策劃/任務書ProjectPlan/Charter一、項目基本情況項目名稱(ProjectName): 項目編號(ProjectCode)制作人(Preparedby): 審核人（Reviewed項目經理（Project by）：Manager):

生【炸口甘口1k1

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