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

1、 10/10軟件開發(fā)流程管理系統(tǒng)要求規(guī)范 軟件開發(fā)流程管理規(guī)范 軟件開發(fā)流程管理規(guī)范 (1) 一、概述 (2) 二、流程 (2) 三、附件 (3) 附件一、編碼規(guī)范 (3) 1、命名空間 (3) 2、命名規(guī)則 (3) 2.1文件夾及相關文件命名規(guī)則 (3) 2.2數(shù)據庫表命名規(guī)則 (4) 3、代碼規(guī)范 (4) 3.1代碼分層結構 (4) 3.2編碼規(guī)范 (5) 4、解釋 (6) 4.1解釋模板設置 (6) 4.2手工添加解釋 (7) 4.3解釋要求 (8) 附件二、軟件需求申請表 (9) 附件三、軟件開發(fā)申請表 (10) 附件四、項目組成成員表 (11) 附件五、項目策劃/任務書 (12) 附

2、件六、WBS表 (13) 附件七、項目進度計劃表 (14) 附件八、項目風險管理表 (15) 附件九、項目溝通計劃表 (16) 附件十、項目會議紀要 (17) 附件十一、項目狀態(tài)報告表 (18) 附件十二、項目變更管理表 (19) 附件十三、項目總結表 (20) 一、概述 隨著公司規(guī)模的擴大、各部門對軟件需求的激增、提高效率的工作要求，IT部門承接的 軟件開發(fā)項目越來越多，而與之相對應的就是軟件開發(fā)流程不明確，軟件項目的隨意性較大、可追溯性較差、可統(tǒng)計性模糊、可預測性不足是擺在我們面前最直接的問題。為了適應公司的發(fā)展，IT部軟件開發(fā)項目特制訂本流程。 二、流程 由上圖可以得出以下幾個關鍵步驟：

3、 一、需求部門： I、需求部門首先需要填寫軟件需求申請表，說明需要開發(fā)的軟件具體用途徑、目前工作模式、工作不方便之處、基本功能等信息； II、待IT部門評審通過后，通知需求部門，填寫軟件開發(fā)申請表，具體列明需要實現(xiàn)的功能、目前工作流程、使用系統(tǒng)后需要達到的狀態(tài)，可節(jié)省的人力、物力，調高的效率等信息； III、軟件開發(fā)測試完成之后，接受IT部門的軟件使用培訓，并填寫參與培訓確認單； IV、軟件試用結束后，填寫軟件驗收表，完成軟件項目的開發(fā)流程； V、在開發(fā)測試過程中，遇到開發(fā)風險增加、需求變更等，都需要配合IT軟件開發(fā)人員 填寫相關的項目風險管理表和項目變更管理表。 二、IT部門： I、積極對需

4、求部門提出的軟件需求申請表進行評審、審批，限3個工作日完成， 及時反饋結果給需求部門； II 、指導需求部門填寫各類表格； III 、積極評審需求部門填寫的表格、積極溝通，有效獲得相對準確的需求，并填寫完善， 讓需求部門簽字確認； IV 、進入開發(fā)流程后，積極填寫項目成員組成表、項目策劃任務書、WBS 表、 項目進度計劃表等（具體見附件）； V 、積極開展人員培訓和軟件試用工作，編寫完善的XXX 軟件試用說明書，并要求相 關人員簽字確認，并存檔處理。 三、附件 附件一、編碼規(guī)范 1、命名空間 1. 公共類庫（公司功能業(yè)務）： （1 ）全局公共類庫： 例：http:/./doc/a8763acf

5、11a6f524ccbff121dd36a32d7275c725.html mon.DBhelper/Excel/email,生成 dll 文件，添加至最小應用庫可全程序引用 （2）局部公共類庫（主要區(qū)分公司），命名方式為專有業(yè)務場景+專有業(yè)務名+具體類名： 例：ECO.Gp （總部）/In （國內市場）/Rb （生產） 注：（公共類庫）信息登記、評審、信息共享，命名空間最多三層 2. 項目程序文件：項目文件名,以核心功能的英文名稱為準,格式:ECO_英文名詞首字母大寫 2、命名規(guī)則 2.1文件夾及相關文件命名規(guī)則 a) 文件夾：功能文件夾，采用駝峰形式，首字母大寫全稱 窗體文件：采用駝峰形式

6、，首字母大寫全稱 接口：I+采用駝峰形式，首字母大寫全稱 方法名：采用駝峰形式，首字母大寫全稱 窗體控件：同上 b) c) d) e) f) 局部變量：變量類型縮寫（int ，fl ，str ）+駝峰形式 全局變量：不建議使用 g) h) 常量：全英文大寫，不建議出現(xiàn)在頁面 數(shù)組：功能名稱首字母小寫+駝峰+Arr List 集合：功能名稱首字母小寫+駝峰+List 字典：功能名稱首字母小寫+駝峰+Dic Dateset ：功能名稱首字母小寫+駝峰+Ds DateTable ：功能名稱首字母小寫+駝峰+Dt i) j) k) l) m) 附表 1： 類型前綴（小寫）+駝峰樣式名詞或名詞短語對于基

7、本類型變量，前綴如下表： 類型int 前綴int dou fl double float string bool str bool datetime byte dat byt 對于對象類型變量，也可以采用類似基本類型方式，如StringBuilder類型，可使用sb作為 前綴開頭，后跟變量名駝峰樣式。 對于集合類型變量，如數(shù)組、List、Dictionary，可以在變量命名的基礎上結尾加入集合類型 簡寫。如，sqlList，dataDic等。 2.2數(shù)據庫表命名規(guī)則 命名方法：項目大寫首字母+_+功能（全英文大寫）【多單詞組成的，取單詞首字母大寫組合】表字段：類似變量命名 索引:表名（或縮寫）

8、+_+列名+idx 注：ID、創(chuàng)建人（creator）、創(chuàng)建時間（createTime）、狀態(tài)（state）、創(chuàng)建人工號（createID）等字段為必須創(chuàng)建的字段; 3、代碼規(guī)范 3.1代碼分層結構 建議每個模塊中代碼至少分三層結構,根據項目大小決定是否采用這種方式,可以先以一兩個 項目測試一下這種結構; 表現(xiàn)層 邏輯層 數(shù)據層 例如一個項目的一個模塊，可以創(chuàng)建文件夾結構如下所示： 表現(xiàn)層頁面*.aspx 數(shù)據層*.cs 邏輯層*.cs 表現(xiàn)層直接面向用戶，邏輯層負責后端邏輯處理，數(shù)據層負責和底層數(shù)據庫交互。 表現(xiàn)層調用邏輯層代碼，只有查詢數(shù)據時，表現(xiàn)層可以直接調用數(shù)據層； 邏輯層負責處理邏輯

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

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

11、2.2表現(xiàn)層 頁面端 1、JS代碼和CSS代碼統(tǒng)一放置在html的head子元素中； 2、JS代碼需要有解釋； 3、頁面控件有嵌套情況的，各級需要縮進，并且各級的頭尾對齊； 頁面處理類 1、頁面加載時謹慎處理Session置空； 2、類中多處用到的變量建議創(chuàng)建成員變量，成員變量應私有化（private），位于類代碼上方； 3、除用于http:/./doc/a8763acf11a6f524ccbff121dd36a32d7275c725.html 前臺調用的如App.direct方法需為public外，其他方法建議均為private； 4、Page_Load方法： 建議將頁面加載方法中內容加入

12、if (!X.IsAjaxRequest) 代碼塊中，避免頁面每次操作后都調用Page_Load方法； 5、獲取頁面的服務端控件的值前需對控件值的null和空進行判斷，避免空指針異常； 6、避免過多或復雜的邏輯處理代碼，統(tǒng)一調用邏輯層代碼，將展現(xiàn)和邏輯分離； 7、對數(shù)據的增刪改操作不要直接調用數(shù)據層，查詢可直接調用數(shù)據層代碼； 3.2.3邏輯層 1、除對表現(xiàn)層提供的接口方法外，其他方法均保持私有 private 2、對數(shù)據庫數(shù)據處理調用數(shù)據處理層代碼 3、對串行的數(shù)據處理時事務保證 4、邏輯代碼容錯性保證 3.2.4數(shù)據處理層 1、除對外提供的接口方法外，其他方法均保持私有 private 2

13、、對數(shù)據庫的底層訪問（獲取數(shù)據庫連接、執(zhí)行sql語句、數(shù)據庫連接關閉）均調用數(shù)據 庫操作幫助類 3、數(shù)據處理層類中只處理數(shù)據，避免業(yè)務邏輯代碼 4、sql語句編寫時避免使用“+” 5、數(shù)據庫操作幫助類中數(shù)據庫操作的容錯性和事務處理（插入、更新、刪除操作需要事務 保證） 4、解釋 編寫任何代碼都需要有代碼解釋，并且代碼修改后也要修改解釋，保證代碼解釋同步。 4.1解釋模板設置 在vs安裝目錄，以下目錄中，找到class.cs文件，修改保存后，重啟vs，之后創(chuàng)建新類時即會自動產生解釋。 D:Program Files (x86)Microsoft Visual Studio 10.0Common7

14、IDEItemTemplatesCacheCSharpCode2052Class.zip 但是修改后沒有效果。 4.2手工添加解釋 創(chuàng)建新對象可以手工添加解釋： 解釋寫法： 塊解釋 解釋包含在/*和*/中，可以有多行。 行解釋 以/開頭，可以有多行，每行前面都以/開頭。 文件頭解釋 /* = * Copyright ? 2013 ECOVACS Inc. All rights reserved! *科沃斯機器人科技(蘇州)有限公司 * =*/ 類文件解釋 /* *DESC :類功能描述 * SINCE : .net版本 * CREATOR:創(chuàng)建人 * DATE: */ 創(chuàng)建日期 方法解釋 /*

15、 *DESC :方法功能描述 * PARAMS:參數(shù)說明 * RETURN:返回值說明 * CREATOR:創(chuàng)建人 * DATE: */ 創(chuàng)建日期4.3解釋要求 a) b) c) d) e) 解釋量：20%30%，項目完成周期延長 20% 解釋地方：段前以及當行之后 上線之前無需版本號，上線之后需版本號，上線前統(tǒng)一為 1.0 解釋與自身方法之間不為空，其他方法必須為空 解釋代碼在上線后全刪除，上線后不允許無效代碼存在 注：解釋中的內容含創(chuàng)建人、創(chuàng)建時間、功能描述、參數(shù)說明、修改人、修改時間、修改描述、返回值；上線后每個源碼備份空間 附件二、軟件需求申請表 申請人：需求部門： 用途描述 目前工作

16、狀態(tài) 基本功能描述 部門主管建議 簽字確認 （時間） 附件三、軟件開發(fā)申請表 需求部門：申請人：具體功能模塊 說明 目前工作流程 項目完成所能 帶來的預期效 益（可節(jié)省的 人力、物力等） 部門主管建議 簽字確認 （時間） 附件四、項目組成成員表一、項目基本情況 項目名稱（Project Name）： 制作人（Prepared by）： 項目經理（Project Manager）：二、項目組成員項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）： 成員姓名項目角色所在部門職責項目起止日投入頻度及聯(lián)系電話主管經理Name Project Role Dept

17、 Name Responsibility 期 Data 工作量 Time Tel No. Supervisor 簽字Signature： 項目贊助人Sponsor 項目經理Project Manager 日期Date： 項目角色包括項目贊助人（Sponsor）、項目經理（Manager）、項目核心成員（Core team）和項目非核心成員（Extended team）。 附件五、項目策劃/任務書一、項目基本情況 項目名稱（Project Name）： 制作人（Prepared by）： 項目經理（Project Manager）：二、項目描述項目編號（Project Code）：審核人（Rev

18、iewed by）：制作日期（Data）： 1、項目背景與目的（所有的項目均起始于某個商業(yè)問題，該部分簡要描述這些問題） 2、項目目標（包括質量目標，工期目標、費用目標和交付產品特征與特征的主要描述） 3、項目里程碑計劃（包含里程碑的時間和成果） 4、評價標準（說明項目成果在何種情況下將被接受） 5、項目假定與約束條件（說明項目的主要假設條件和限制性條件） 6、項目主要利益干系人（包括高管、客戶、職能部門主管、供應商、項目贊助人、項目經理、項目組成成員等干系人）姓名類別部門職務 附件六、WBS表一、項目基本情況 項目名稱（Project Name）：制作人（Prepared by）：項目編號（

19、Project Code）：審核人（Reviewed by）： 項目經理（Project Manager）：制作日期（Data）：二、工作分解結構 分解代碼任務名稱包含活動 Activities Included 工時估算 Estimated Time 人力資源其他資源費用估計 Estimated Cost 工期 Expected Days WBS Code Task Estimated HR Estimated Resources 注：以上工期及費用估算均用最可能值 附件七、項目進度計劃表一、項目基本情況 項目名稱（Project Name）：制作人（Prepared by）：項目編號（Pr

20、oject Code）：審核人（Reviewed by）：制作日期（Data）： 項目經理（Manager）：二、項目進度表周（Week）Project 0 1 2 責任人關鍵里程碑 Team Memmber Milestone 開始29 3 0 3 1 1 2 3 4 5 6 7 8 9 1 1 1 1 2 Start 開工會Kick-off meeting 附件八、項目風險管理表一、項目基本情況 項目名稱（Project Name）： 制作人（Prepared by）： 項目經理（Project Manager）：二、項目風險管理項目編號（Project Code）：審核人（Reviewe

21、d by）：制作日期（Data）： 風險發(fā)生概率的判斷準則 高風險：60%發(fā)生風險的可能性中風險：30-60%發(fā)生風險的可能性低風險：30%發(fā)生風險的可能性 序號Sequenc e NO. 風險描述發(fā)生概率 Happening Probability 影響程度 Influence degree 風險等級風險響應計劃責任人 Risk 開放/關閉 Open/Close d Risk Description Risk Level Risk Plan Response owner 附件九、項目溝通計劃表一、項目基本情況 項目名稱（Project Name）： 制作人（Prepared by）： 項目經

22、理（Project Manager）：二、項目溝通計劃項目編號（Project Code）：審核人（Reviewed by）：制作日期（Data）： 利益干系人所需信息頻率方法責任人Stakeholders Info Needed Frequency Means Risk owner 附件十、項目會議紀要一、基本情況 會議名稱（Meeting Name）：會議日期（Meeting Date）：會議地點（Meeting Place）：記錄人（Minutes By）： 二、會議目標召集人（Called By）： 開始時間（Start Time）： 持續(xù)時間（Meeting Duration）：審核

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