軟件開發(fā)流程管理系統(tǒng)要求規(guī)范

1、軟件開發(fā)流程管理規(guī)范軟件開發(fā)流程管理規(guī)范.1一、概述.2二、流程.2三、附件.3附件一、編碼規(guī)范.31、命名空間.32、命名規(guī)則.32.1文件夾及相關(guān)文件命名規(guī)則.32.2數(shù)據(jù)庫表命名規(guī)則.43、代碼規(guī)范.43.1代碼分層結(jié)構(gòu).43.2編碼規(guī)范.54、注釋.64.1注釋模板設(shè)置.64.2手工添加注釋.74.3注釋要求.8附件二、軟件需求申請表.9附件三、軟件開發(fā)申請表.10附件四、項目組成成員表.11附件五、項目策劃/任務(wù)書 .12附件六、WBS表 .13附件七、項目進度計劃表.14附件八、項目風險管理表.15附件九、項目溝通計劃表.16附件十、項目會議紀要.17附件十一、項目狀態(tài)報告表.18

2、附件十二、項目變更管理表.19附件十三、項目總結(jié)表.20一、概述隨著公司規(guī)模的擴大、各部門對軟件需求的激增、提高效率的工作要求，IT部門承接的軟件開發(fā)項目越來越多，而與之相對應(yīng)的就是軟件開發(fā)流程不明確，軟件項目的隨意性較大、可追溯性較差、可統(tǒng)計性模糊、可預(yù)測性不足是擺在我們面前最直接的問題。為了適應(yīng)公司的發(fā)展，IT部軟件開發(fā)項目特制訂本流程。二、流程由上圖可以得出以下幾個關(guān)鍵步驟：一、需求部門：I、需求部門首先需要填寫軟件需求申請表，說明需要開發(fā)的軟件具體用途徑、目前工作模式、工作不方便之處、基本功能等信息；II、待 IT部門評審?fù)ㄟ^后，通知需求部門，填寫軟件開發(fā)申請表，具體列明需要實現(xiàn)的功能

3、、目前工作流程、使用系統(tǒng)后需要達到的狀態(tài)，可節(jié)省的人力、物力，調(diào)高的效率等信息；III、軟件開發(fā)測試完成之后，接受 IT部門的軟件使用培訓，并填寫參與培訓確認單；IV、軟件試用結(jié)束后，填寫軟件驗收表，完成軟件項目的開發(fā)流程；V、在開發(fā)測試過程中，遇到開發(fā)風險增加、需求變更等，都需要配合 IT軟件開發(fā)人員填寫相關(guān)的項目風險管理表和項目變更管理表。二、IT部門：I、積極對需求部門提出的軟件需求申請表進行評審、審批，限 3個工作日完成，及時反饋結(jié)果給需求部門；II、指導(dǎo)需求部門填寫各類表格；III、積極評審需求部門填寫的表格、積極溝通，有效獲得相對準確的需求，并填寫完善，讓需求部門簽字確認；IV、進

4、入開發(fā)流程后，積極填寫項目成員組成表、項目策劃任務(wù)書、WBS表、項目進度計劃表等（具體見附件）；V、積極開展人員培訓和軟件試用工作，編寫完善的XXX軟件試用說明書，并要求相關(guān)人員簽字確認，并存檔處理。三、附件附件一、編碼規(guī)范1、命名空間1.公共類庫（公司功能業(yè)務(wù)）：（1 ）全局公共類庫：例：ECO.Common.DBhelper/Excel/email,生成 dll文件，添加至最小應(yīng)用庫可全程序引用（2）局部公共類庫（主要區(qū)分公司），命名方式為專有業(yè)務(wù)場景+專有業(yè)務(wù)名+具體類名：例：ECO.Gp（總部）/In（國內(nèi)市場）/Rb（生產(chǎn)）注：（公共類庫）信息登記、評審、信息共享，命名空間最多三層2

5、.項目程序文件：項目文件名,以核心功能的英文名稱為準,格式:ECO_英文名詞首字母大寫2、命名規(guī)則2.1文件夾及相關(guān)文件命名規(guī)則a)文件夾：功能文件夾，采用駝峰形式，首字母大寫全稱窗體文件：采用駝峰形式，首字母大寫全稱接口：I+采用駝峰形式，首字母大寫全稱方法名：采用駝峰形式，首字母大寫全稱窗體控件：同上b)c)d)e)f)局部變量：變量類型縮寫（int，fl，str）+駝峰形式全局變量：不建議使用g)h)常量：全英文大寫，不建議出現(xiàn)在頁面數(shù)組：功能名稱首字母小寫+駝峰+ArrList集合：功能名稱首字母小寫+駝峰+List字典：功能名稱首字母小寫+駝峰+DicDateset：功能名稱首字母小

6、寫+駝峰+DsDateTable：功能名稱首字母小寫+駝峰+Dti)j)k)l)m)附表 1：類型前綴（小寫）+駝峰樣式名詞或名詞短語對于基本類型變量，前綴如下表：類型int前綴intdoufldoublefloatstringboolstrbooldatetimebyte.datbyt.對于對象類型變量，也可以采用類似基本類型方式，如 StringBuilder類型，可使用 sb作為前綴開頭，后跟變量名駝峰樣式。對于集合類型變量，如數(shù)組、List、Dictionary，可以在變量命名的基礎(chǔ)上結(jié)尾加入集合類型簡寫。如，sqlList，dataDic等。2.2數(shù)據(jù)庫表命名規(guī)則命名方法：項目大寫首

7、字母+_+功能（全英文大寫）【多單詞組成的，取單詞首字母大寫組合】表字段：類似變量命名索引:表名（或縮寫）+_+列名+idx注：ID、創(chuàng)建人（creator）、創(chuàng)建時間（createTime）、狀態(tài)（state）、創(chuàng)建人工號（createID）等字段為必須創(chuàng)建的字段;3、代碼規(guī)范3.1代碼分層結(jié)構(gòu)建議每個模塊中代碼至少分三層結(jié)構(gòu),根據(jù)項目大小決定是否采用這種方式,可以先以一兩個項目測試一下這種結(jié)構(gòu);表現(xiàn)層邏輯層數(shù)據(jù)層例如一個項目的一個模塊，可以創(chuàng)建文件夾結(jié)構(gòu)如下所示：表現(xiàn)層頁面 *.aspx數(shù)據(jù)層 *.cs邏輯層 *.cs表現(xiàn)層直接面向用戶，邏輯層負責后端邏輯處理，數(shù)據(jù)層負責和底層數(shù)據(jù)庫交互。

8、表現(xiàn)層調(diào)用邏輯層代碼，只有查詢數(shù)據(jù)時，表現(xiàn)層可以直接調(diào)用數(shù)據(jù)層；邏輯層負責處理邏輯，為表現(xiàn)層提供調(diào)用接口，其數(shù)據(jù)操作需要調(diào)用數(shù)據(jù)層提供接口；數(shù)據(jù)層負責提供和處理數(shù)據(jù)，需要為邏輯層提供調(diào)用接口，所有與數(shù)據(jù)庫的操作都只能在該層實現(xiàn)。3.2編碼規(guī)范3.2.1通用a)b)c)d)e)f)g)h)i)j)k)l)類功能必須唯一：每個文件中只有一個類（不包括內(nèi)部類）行寬限制在 80個字符內(nèi)，必須按最低優(yōu)先級換行方法代碼限制在 200行內(nèi)類代碼建議限制在 1500行內(nèi)方法參數(shù)過長，應(yīng)分行顯示，逗號至于末尾每行聲明一個變量，且盡量賦初值，同類型必須連續(xù)寫復(fù)合語句都需加大括號 ，不要寫在一行，if、else盡量

9、配對出現(xiàn)，try、catch、finally高扇入、合理扇出（盡量不超過三層）縮進不允許空行遞歸要慎用，goto不允許使用方法內(nèi)禁止更改傳遞過來的參數(shù)實體類中變量應(yīng)私有化，應(yīng)包含每個變量的 set及 get方法m)避免三層以上嵌套循環(huán)n)o)p)q)r)s)t)u)代碼應(yīng)包含正確性和容錯性處理（try、catch、finally）編程時應(yīng)考慮代碼的效率（時間、空間），多循環(huán)內(nèi)側(cè)，變量聲明放在循環(huán)外對象比較用對應(yīng)方法不用“=”，例如：equals，compare to計算盡量避免除法設(shè)計方法可重用性else、finally、catch、日志必須有出口堆常量統(tǒng)一定義，避免用常量字符串變量必須初始化

10、3.2.2表現(xiàn)層頁面端1、JS代碼和 CSS代碼統(tǒng)一放置在 html的 head子元素中；2、JS代碼需要有注釋；3、頁面控件有嵌套情況的，各級需要縮進，并且各級的頭尾對齊；頁面處理類1、頁面加載時謹慎處理 Session置空；2、類中多處用到的變量建議創(chuàng)建成員變量，成員變量應(yīng)私有化（private），位于類代碼上方；3、除用于 E前臺調(diào)用的如 App.direct方法需為 public外，其他方法建議均為 private；4、Page_Load方法：建議將頁面加載方法中內(nèi)容加入if (!X.IsAjaxRequest)代碼塊中，避免頁面每次操作后都調(diào)用 Page_Load方法；5

11、、獲取頁面的服務(wù)端控件的值前需對控件值的 null和空進行判斷，避免空指針異常；6、避免過多或復(fù)雜的邏輯處理代碼，統(tǒng)一調(diào)用邏輯層代碼，將展現(xiàn)和邏輯分離；7、對數(shù)據(jù)的增刪改操作不要直接調(diào)用數(shù)據(jù)層，查詢可直接調(diào)用數(shù)據(jù)層代碼；3.2.3邏輯層1、除對表現(xiàn)層提供的接口方法外，其他方法均保持私有 private2、對數(shù)據(jù)庫數(shù)據(jù)處理調(diào)用數(shù)據(jù)處理層代碼3、對串行的數(shù)據(jù)處理時事務(wù)保證4、邏輯代碼容錯性保證3.2.4數(shù)據(jù)處理層1、除對外提供的接口方法外，其他方法均保持私有 private2、對數(shù)據(jù)庫的底層訪問（獲取數(shù)據(jù)庫連接、執(zhí)行 sql語句、數(shù)據(jù)庫連接關(guān)閉）均調(diào)用數(shù)據(jù)庫操作幫助類3、數(shù)據(jù)處理層類中只處理數(shù)據(jù)，

12、避免業(yè)務(wù)邏輯代碼4、sql語句編寫時避免使用“+”5、數(shù)據(jù)庫操作幫助類中數(shù)據(jù)庫操作的容錯性和事務(wù)處理（插入、更新、刪除操作需要事務(wù)保證）4、注釋編寫任何代碼都需要有代碼注釋，并且代碼修改后也要修改注釋，保證代碼注釋同步。4.1注釋模板設(shè)置在 vs安裝目錄，以下目錄中，找到 class.cs文件，修改保存后，重啟 vs，之后創(chuàng)建新類時即會自動產(chǎn)生注釋。D:ProgramFiles(x86)MicrosoftVisualStudio10.0Common7IDEItemTemplatesCacheCSharpCode2052Class.zip但是修改后沒有效果。4.2手工添加注釋創(chuàng)建新對象可以手工添

13、加注釋：注釋寫法：塊注釋注釋包含在/*和*/中，可以有多行。行注釋以/開頭，可以有多行，每行前面都以/開頭。文件頭注釋/* =* Copyright 2013 ECOVACS Inc. All rights reserved!*科沃斯機器人科技(蘇州)有限公司*=*/類文件注釋/*DESC:類功能描述* SINCE : .net版本* CREATOR:創(chuàng)建人* DATE:*/創(chuàng)建日期方法注釋/*DESC:方法功能描述* PARAMS:參數(shù)說明* RETURN:返回值說明* CREATOR:創(chuàng)建人* DATE:*/創(chuàng)建日期4.3注釋要求a)b)c)d)e)注釋量：20%30%，項目完成周期延長

14、20%注釋地方：段前以及當行之后上線之前無需版本號，上線之后需版本號，上線前統(tǒng)一為 1.0注釋與自身方法之間不為空，其他方法必須為空注釋代碼在上線后全刪除，上線后不允許無效代碼存在注：注釋中的內(nèi)容含創(chuàng)建人、創(chuàng)建時間、功能描述、參數(shù)說明、修改人、修改時間、修改描述、返回值；上線后每個源碼備份空間附件二、軟件需求申請表需求部門：用途描述申請人：目前工作狀態(tài)基本功能描述部門主管建議簽字確認（時間）附件三、軟件開發(fā)申請表需求部門：申請人：具體功能模塊說明目前工作流程項目完成所能帶來的預(yù)期效益（可節(jié)省的人力、物力等）部門主管建議簽字確認（時間）附件四、項目組成成員表項目組成成員表Project Team

15、 Members一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目經(jīng)理（Project Manager）：二、項目組成員項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）：成員姓名項目角色所在部門職責項目起止日 投入頻度及聯(lián)系電話主管經(jīng)理NameProject RoleDept NameResponsibility期 Data工作量 TimeTel No.Supervisor簽字 Signature：項目贊助人 Sponsor項目經(jīng)理 Project Manager日期 Date：項目角色包括項目贊助人（Spo

16、nsor）、項目經(jīng)理（Manager）、項目核心成員（Core team）和項目非核心成員（Extended team）。附件五、項目策劃/任務(wù)書項目策劃/任務(wù)書Project Plan/Charter一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目經(jīng)理（Project Manager）：二、項目描述項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）：1、項目背景與目的（所有的項目均起始于某個商業(yè)問題，該部分簡要描述這些問題）2、項目目標（包括質(zhì)量目標，工期目標、費用目標和交付產(chǎn)品特征與特征的主要描述）3、項

17、目里程碑計劃（包含里程碑的時間和成果）4、評價標準（說明項目成果在何種情況下將被接受）5、項目假定與約束條件（說明項目的主要假設(shè)條件和限制性條件）6、項目主要利益干系人（包括高管、客戶、職能部門主管、供應(yīng)商、項目贊助人、項目經(jīng)理、項目組成成員等干系人）姓名類別部門職務(wù)附件六、WBS表WBS表Project Work Breakdown Structure一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目編號（Project Code）：審核人（Reviewed by）：項目經(jīng)理（Project Manager）：制作日期（Data）：二、工作分解結(jié)構(gòu)分

18、解代碼任務(wù)名稱包含活動ActivitiesIncluded工時估算EstimatedTime人力資源其他資源費用估計EstimatedCost工期ExpectedDaysWBS CodeTaskEstimated HREstimatedResources注：以上工期及費用估算均用最可能值附件七、項目進度計劃表項目進度計劃表Project Schedule一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）：項目經(jīng)理（Manager）：二、項目進度表周（Week）Pro

19、ject012責任人關(guān)鍵里程碑Team MemmberMilestone開始293031123456789101112Start開工會 Kick-off meeting附件八、項目風險管理表項目風險表Project Risk Management一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目經(jīng)理（Project Manager）：二、項目風險管理項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）：風險發(fā)生概率的判斷準則高風險：60%發(fā)生風險的可能性中風險：30-60%發(fā)生風險的可能性低風險：30%發(fā)生風險的

20、可能性序號Sequence NO.風險描述發(fā)生概率HappeningProbability影響程度Influencedegree風險等級風險響應(yīng)計劃責任人Risk開放/關(guān)閉Open/ClosedRisk DescriptionRisk LevelRiskPlanResponseowner附件九、項目溝通計劃表項目溝通計劃表Project Communication Plan一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目經(jīng)理（Project Manager）：二、項目溝通計劃項目編號（Project Code）：審核人（Reviewed by）：制作

21、日期（Data）：利益干系人所需信息頻率方法責任人StakeholdersInfo NeededFrequencyMeansRisk owner附件十、項目會議紀要項目會議紀要Project Meeting Minutes一、基本情況會議名稱（Meeting Name）：會議日期（Meeting Date）：會議地點（Meeting Place）：記錄人（Minutes By）：二、會議目標召集人（Called By）：開始時間（Start Time）：持續(xù)時間（Meeting Duration）：審核人（Reviewed By）：簡要說明會議的目標，包括期望達到的結(jié)果三、參加人員（列出參加會

22、議的人員，他在項目中的頭銜或角色）四、發(fā)放材料（列出會議討論的所有項目資料）五、發(fā)言記錄（記錄發(fā)言人的觀點、意見和建議）六、會議決議（說明會議結(jié)論）七、會議紀要發(fā)放范圍附件十一、項目狀態(tài)報告表項目狀態(tài)報告表一、項目基本情況項目名稱（Project Name）：制作人（Prepared by）：項目經(jīng)理（Project Manager）：當前項目狀況項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）：比計劃提前按計劃進行落后計劃匯報周期二、當前任務(wù)狀態(tài)（簡要描述任務(wù)進展情況）關(guān)鍵人物狀態(tài)指示狀態(tài)描述三、本周期內(nèi)的主要活動（對本周期內(nèi)的主要交付物進行總結(jié)）四、下一個匯報周期內(nèi)的活動計劃（描述活動需要與項目計劃和 WBS相對應(yīng)）五、財務(wù)狀況六、上期遺留問題的處理（說明上一個匯報周期內(nèi)問題的處理意見和處理結(jié)果）七、本期問題與求助附件十二、項目變更管理表項目變更管理表Project Change Management一、項目基本情況項目名稱（P