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

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

2、件六、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部門承接的 軟件開(kāi)發(fā)項(xiàng)目越來(lái)越多，而與之相對(duì)應(yīng)的就是軟件開(kāi)發(fā)流程不明確，軟件項(xiàng)目的隨意性較大、可追溯性較差、可統(tǒng)計(jì)性模糊、可預(yù)測(cè)性不足是擺在我們面前最直接的問(wèn)題。為了適應(yīng)公司的發(fā)展，IT部軟件開(kāi)發(fā)項(xiàng)目特制訂本流程。 二、流程 由上圖可以得出以下幾個(gè)關(guān)鍵步驟：

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

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

5、11a6f524ccbff121dd36a32d7275c725.html mon.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ù)）信息登記、評(píng)審、信息共享，命名空間最多三層 2. 項(xiàng)目程序文件：項(xiàng)目文件名,以核心功能的英文名稱為準(zhǔn),格式:ECO_英文名詞首字母大寫 2、命名規(guī)則 2.1文件夾及相關(guān)文件命名規(guī)則 a) 文件夾：功能文件夾，采用駝峰形式，首字母大寫全稱 窗體文件：采用駝峰形式

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

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

8、+_+列名+idx 注：ID、創(chuàng)建人（creator）、創(chuàng)建時(shí)間（createTime）、狀態(tài)（state）、創(chuàng)建人工號(hào)（createID）等字段為必須創(chuàng)建的字段; 3、代碼規(guī)范 3.1代碼分層結(jié)構(gòu) 建議每個(gè)模塊中代碼至少分三層結(jié)構(gòu),根據(jù)項(xiàng)目大小決定是否采用這種方式,可以先以一兩個(gè) 項(xiàng)目測(cè)試一下這種結(jié)構(gòu); 表現(xiàn)層 邏輯層 數(shù)據(jù)層 例如一個(gè)項(xiàng)目的一個(gè)模塊，可以創(chuàng)建文件夾結(jié)構(gòu)如下所示： 表現(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ù)層； 邏輯層負(fù)責(zé)處理邏輯

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

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

11、2.2表現(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、除用于http:/./doc/a8763acf11a6f524ccbff121dd36a32d7275c725.html 前臺(tái)調(diào)用的如App.direct方法需為public外，其他方法建議均為private； 4、Page_Load方法： 建議將頁(yè)面加載方法中內(nèi)容加入

12、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ù)層代碼； 3.2.3邏輯層 1、除對(duì)表現(xiàn)層提供的接口方法外，其他方法均保持私有 private 2、對(duì)數(shù)據(jù)庫(kù)數(shù)據(jù)處理調(diào)用數(shù)據(jù)處理層代碼 3、對(duì)串行的數(shù)據(jù)處理時(shí)事務(wù)保證 4、邏輯代碼容錯(cuò)性保證 3.2.4數(shù)據(jù)處理層 1、除對(duì)外提供的接口方法外，其他方法均保持私有 private 2

13、、對(duì)數(shù)據(jù)庫(kù)的底層訪問(wèn)（獲取數(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、解釋 編寫任何代碼都需要有代碼解釋，并且代碼修改后也要修改解釋，保證代碼解釋同步。 4.1解釋模板設(shè)置 在vs安裝目錄，以下目錄中，找到class.cs文件，修改保存后，重啟vs，之后創(chuàng)建新類時(shí)即會(huì)自動(dòng)產(chǎn)生解釋。 D:Program Files (x86)Microsoft Visual Studio 10.0Common7

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

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

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

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

18、iewed by）：制作日期（Data）： 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)目名稱（Project Name）：制作人（Prepared by）：項(xiàng)目編號(hào)（

19、Project Code）：審核人（Reviewed by）： 項(xiàng)目經(jīng)理（Project Manager）：制作日期（Data）：二、工作分解結(jié)構(gòu) 分解代碼任務(wù)名稱包含活動(dòng) Activities Included 工時(shí)估算 Estimated Time 人力資源其他資源費(fèi)用估計(jì) Estimated Cost 工期 Expected Days WBS Code Task Estimated HR Estimated Resources 注：以上工期及費(fèi)用估算均用最可能值 附件七、項(xiàng)目進(jìn)度計(jì)劃表一、項(xiàng)目基本情況 項(xiàng)目名稱（Project Name）：制作人（Prepared by）：項(xiàng)目編號(hào)（Pr

20、oject Code）：審核人（Reviewed by）：制作日期（Data）： 項(xiàng)目經(jīng)理（Manager）：二、項(xiàng)目進(jìn)度表周（Week）Project 0 1 2 責(zé)任人關(guān)鍵里程碑 Team Memmber Milestone 開(kāi)始29 3 0 3 1 1 2 3 4 5 6 7 8 9 1 1 1 1 2 Start 開(kāi)工會(huì)Kick-off meeting 附件八、項(xiàng)目風(fēng)險(xiǎn)管理表一、項(xiàng)目基本情況 項(xiàng)目名稱（Project Name）： 制作人（Prepared by）： 項(xiàng)目經(jīng)理（Project Manager）：二、項(xiàng)目風(fēng)險(xiǎn)管理項(xiàng)目編號(hào)（Project Code）：審核人（Reviewe

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

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

23、人（Reviewed By）： 簡(jiǎn)要說(shuō)明會(huì)議的目標(biāo)，包括期望達(dá)到的結(jié)果 三、參加人員（列出參加會(huì)議的人員，他在項(xiàng)目中的頭銜或角色） 四、發(fā)放材料（列出會(huì)議討論的所有項(xiàng)目資料） 五、發(fā)言記錄（記錄發(fā)言人的觀點(diǎn)、意見(jiàn)和建議） 六、會(huì)議決議（說(shuō)明會(huì)議結(jié)論） 七、會(huì)議紀(jì)要發(fā)放范圍 附件十一、項(xiàng)目狀態(tài)報(bào)告表一、項(xiàng)目基本情況 項(xiàng)目名稱（Project Name）： 制作人（Prepared by）： 項(xiàng)目經(jīng)理（Project Manager）：當(dāng)前項(xiàng)目狀況項(xiàng)目編號(hào)（Project Code）：審核人（Reviewed by）：制作日期（Data）： 比計(jì)劃提前 按計(jì)劃進(jìn)行落后計(jì)劃匯報(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àn)和處理結(jié)果） 七、本期問(wèn)題與求助 附件十二、項(xiàng)目變更管理表 一、項(xiàng)目基本情況 項(xiàng)目名稱（Project Name