項(xiàng)目開發(fā)規(guī)范文檔

1、文檔編號號：T/KFFGF文檔版本本：0.1項(xiàng)目編號號：YC_FFLATTFORRM項(xiàng)目開發(fā)規(guī)范文檔編寫人：徐文兵日期：20099-7-20審核人：日期：批準(zhǔn)人：日期：修改記錄錄（REEVISSIONN CHHARTT）0.1徐文兵初稿20099-7-2221概述目的與概概述本文檔為為XX公公司的開開發(fā)規(guī)范范文檔，給開發(fā)發(fā)團(tuán)隊(duì)提提供開發(fā)發(fā)標(biāo)準(zhǔn)和和規(guī)范。整體說明明 在開發(fā)發(fā)規(guī)范中中包含了了兩個(gè)部部分，第第一部分分是項(xiàng)目目開發(fā)流流程規(guī)范范，主要要闡述在在項(xiàng)目開開發(fā)過程程中的各各個(gè)階段段的規(guī)范范。第二二部分為為Coddingg開發(fā)規(guī)范范，Coddingg開發(fā)規(guī)規(guī)范闡述述了在一一個(gè)框架架中的各各個(gè)層的

2、的開發(fā)規(guī)規(guī)范（注：在在第一版版中不包包含對工工作流開開發(fā)的規(guī)規(guī)范制定定）覆蓋范圍圍閱讀對象象項(xiàng)目管理理人員系統(tǒng)設(shè)計(jì)計(jì)人員系統(tǒng)開發(fā)發(fā)人員參考資料料略2 項(xiàng)目目開發(fā)流流程規(guī)范范2.1 業(yè)務(wù)需需求調(diào)研研階段調(diào)研的目目標(biāo) 系系統(tǒng)層面面： 客客戶的系系統(tǒng)運(yùn)行行環(huán)境業(yè)務(wù)層面面：了解解客戶需需要什么么樣的系系統(tǒng)，具體了了解業(yè)務(wù)務(wù)目的，業(yè)務(wù)邏邏輯，業(yè)業(yè)務(wù)數(shù)據(jù)據(jù)，客戶戶的操作作習(xí)慣，頁面風(fēng)風(fēng)格習(xí)慣慣等。調(diào)研的準(zhǔn)準(zhǔn)備工作作：行業(yè)知識識的準(zhǔn)備備：了解客戶戶的行業(yè)業(yè)背景，行業(yè)領(lǐng)領(lǐng)域的業(yè)業(yè)務(wù)術(shù)語語，含義義。結(jié)合合客戶行行業(yè)背景景，了解解客戶的的業(yè)務(wù)知知識。業(yè)務(wù)專家家需求：在行業(yè)領(lǐng)領(lǐng)域的復(fù)復(fù)雜度不不高的情情況下，業(yè)務(wù)分分

3、析人員員直接收收集并學(xué)學(xué)習(xí)行業(yè)業(yè)知識就就可以了了，但行行業(yè)知識識的準(zhǔn)備備工作還還是要做做的在行業(yè)領(lǐng)領(lǐng)域業(yè)務(wù)務(wù)復(fù)雜度度高的情情況下，需要業(yè)業(yè)務(wù)專家家對客戶戶的業(yè)務(wù)務(wù)的進(jìn)行行整理。調(diào)研的流流程：第一步 ，項(xiàng)目目啟動(dòng)階階段 了了解客戶戶的ITT環(huán)境。第二步， 討論論并具體體確定客客戶系統(tǒng)統(tǒng)的范圍圍，并獲獲得客戶戶業(yè)務(wù)功功能點(diǎn)的的原始的的單據(jù)。在這個(gè)個(gè)過程中中準(zhǔn)備一一個(gè)本和和一只筆筆記錄討討論的業(yè)業(yè)務(wù)信息息第三步， 整理理業(yè)務(wù)信信息，和和原始表表單，抽抽取出有有效業(yè)務(wù)務(wù)信息，并對于于不明確確的業(yè)務(wù)務(wù)信息進(jìn)進(jìn)行整理理和歸類類，并制制作成問問卷形式式進(jìn)一步步調(diào)研。第四步， 發(fā)放放調(diào)研問問卷，再再次進(jìn)行行業(yè)

4、務(wù)調(diào)調(diào)研（直直接轉(zhuǎn)到到三）第五步，卷寫調(diào)調(diào)研問卷卷，并內(nèi)內(nèi)部評審審第六步，調(diào)研問問卷客戶戶評審并并確認(rèn)。調(diào)研階段段的交付付項(xiàng)（可可配置項(xiàng)項(xiàng)）軟件需求求說明書書軟件需求求說明書書的目錄錄：1 客戶戶行業(yè)背背景2 客戶戶系統(tǒng)的的意義3 客戶戶系統(tǒng)運(yùn)運(yùn)行的環(huán)環(huán)境4 業(yè)務(wù)務(wù)功能點(diǎn)點(diǎn)描述（業(yè)務(wù)目目的，業(yè)業(yè)務(wù)邏輯輯，業(yè)務(wù)務(wù)數(shù)據(jù)，優(yōu)先級級別，使使用頻率率等） 5 客客戶的操操作習(xí)慣慣，頁面面風(fēng)格習(xí)習(xí)慣。2.2 概要設(shè)設(shè)計(jì)階段段概要設(shè)計(jì)計(jì)階段主主要分兩兩個(gè)步驟驟： 11 框架架設(shè)計(jì) 22業(yè)務(wù)模塊塊概要設(shè)計(jì)計(jì) ,下下面分別別對兩個(gè)個(gè)步驟進(jìn)進(jìn)行描述述：2.2.1框架架設(shè)計(jì)（注：這邊的的框架設(shè)設(shè)計(jì)是按按照傳統(tǒng)統(tǒng)的開

5、發(fā)發(fā)方式進(jìn)進(jìn)行闡述述，基于于平臺的的開發(fā)方方式待補(bǔ)補(bǔ)）框架設(shè)計(jì)計(jì)的目標(biāo)標(biāo)：根據(jù)客戶戶需求，設(shè)計(jì)系系統(tǒng)的后后臺架構(gòu)構(gòu)，前臺臺界面框框架，數(shù)數(shù)據(jù)模型型。在設(shè)設(shè)計(jì)之前前要考慮慮客戶的的業(yè)務(wù)特特點(diǎn)，性性能要求求，已有有的ITT環(huán)境，同時(shí)還還要考慮慮將來業(yè)業(yè)務(wù)的增增長，保保證系統(tǒng)統(tǒng)一定得得可擴(kuò)展展性?？蚣茉O(shè)計(jì)計(jì)包含的的內(nèi)容：后臺框架架：各層層的職能能劃分，技術(shù)實(shí)實(shí)現(xiàn)的方方式，層層之間的的交互規(guī)規(guī)則，異異常處理理規(guī)則，目錄定定義規(guī)則則界面框架架：操作作主界面面定義 頁面面整體風(fēng)風(fēng)格的定定義，頁頁面流轉(zhuǎn)轉(zhuǎn)關(guān)系等等 數(shù)數(shù)據(jù)模型型： 系系統(tǒng)基礎(chǔ)礎(chǔ)數(shù)據(jù)（組織人人員結(jié)構(gòu)構(gòu)，權(quán)限限設(shè)置，字典參參數(shù)設(shè)置置） 業(yè)務(wù)務(wù)數(shù)據(jù)

6、框架設(shè)計(jì)計(jì)階段交交付項(xiàng)：文檔 ：系統(tǒng)架架構(gòu) 界面面框架 數(shù)據(jù)據(jù)模型注：三份份文檔可可以融合合在一份份文檔之之中。2.2.2業(yè)務(wù)模模塊概要要設(shè)計(jì)系統(tǒng)設(shè)計(jì)計(jì)人員根根據(jù)業(yè)務(wù)務(wù)分析人人員的業(yè)業(yè)務(wù)需求求文檔，進(jìn)行概概要設(shè)計(jì)計(jì)。在概概要設(shè)計(jì)計(jì)過程中中主要關(guān)關(guān)注三個(gè)個(gè)關(guān)鍵點(diǎn)點(diǎn)1） 業(yè)業(yè)務(wù)模塊塊的頁面面顯示內(nèi)內(nèi)容：信信息顯示示的內(nèi)容容，顯示示的方式式；交互互接口的的定義，等 舉舉例：查查詢?nèi)藛T員信息模模塊操作說明明，查詢詢條件，顯示字字段，排排序和顯顯示方式式。2）業(yè)務(wù)務(wù)邏輯描描述對業(yè)務(wù)邏邏輯進(jìn)行行詳細(xì)的的描述。3）業(yè)務(wù)務(wù)數(shù)據(jù)項(xiàng)項(xiàng) 業(yè)業(yè)務(wù)模塊塊涉及到到數(shù)據(jù)的的描述。具體的描描述包含含數(shù)據(jù)項(xiàng)名名稱 ，顯示方方式

7、，是否必必填，輸入方方式，相關(guān)邏邏輯概要設(shè)計(jì)計(jì)階段的的交付項(xiàng)項(xiàng)概要設(shè)計(jì)計(jì)文檔2.3業(yè)業(yè)務(wù)需求求理解階段段2.3.1系統(tǒng)統(tǒng)設(shè)計(jì)人人員理解解需求在系統(tǒng)設(shè)設(shè)計(jì)人員員理解需需求之前前，業(yè)務(wù)務(wù)分析人人員必須須提供相相關(guān)模塊塊的客戶戶需求文文檔。 系統(tǒng)設(shè)設(shè)計(jì)人員員閱讀并并理解客客戶需求求文檔。理解需求求文檔的的交付結(jié)結(jié)果（可可配置項(xiàng)項(xiàng)）業(yè)務(wù)需求求對于客客戶來講講，目的的是什么么，解決決什么問問題，有有什么意意義？具體業(yè)務(wù)務(wù)的執(zhí)行行邏輯是是什么？在業(yè)務(wù)流流轉(zhuǎn)過程程中的業(yè)業(yè)務(wù)數(shù)據(jù)據(jù)有哪些些？需求理解解時(shí)間要要求：簡單的需需求，理理解時(shí)間間為2-3 小小時(shí)復(fù)雜需求求：理解解需求時(shí)時(shí)間4-8小時(shí)時(shí)復(fù)雜的業(yè)業(yè)務(wù)需求

8、求需要需需求分析析人員確確認(rèn)。復(fù)雜的業(yè)業(yè)務(wù)需求求按照涉涉及到的的業(yè)務(wù)的的復(fù)雜度度來決定定的。2.4詳詳細(xì)設(shè)計(jì)計(jì)階段詳細(xì)設(shè)計(jì)計(jì)階段分分兩個(gè)步步驟第一步驟驟，系統(tǒng)統(tǒng)設(shè)計(jì)人人員根據(jù)據(jù)業(yè)務(wù)需需求的理理解,詳詳細(xì)設(shè)計(jì)計(jì)業(yè)務(wù)模模塊，并并出詳細(xì)細(xì)設(shè)計(jì)文文檔第二步驟驟，核心心設(shè)計(jì)人人員對系系統(tǒng)設(shè)計(jì)計(jì)人員的的詳細(xì)設(shè)設(shè)計(jì)文檔檔進(jìn)行技技術(shù)評審審。2.4.1系統(tǒng)統(tǒng)設(shè)計(jì)人人員詳細(xì)細(xì)設(shè)計(jì)階階段系統(tǒng)設(shè)計(jì)計(jì)人員根根據(jù)業(yè)務(wù)務(wù)需求，詳細(xì)設(shè)設(shè)計(jì)模塊塊。詳細(xì)設(shè)計(jì)計(jì)階段的的交付結(jié)結(jié)果（可可配置項(xiàng)項(xiàng)）詳細(xì)設(shè)計(jì)計(jì)文檔：業(yè)務(wù)接口口定義數(shù)據(jù)庫的的數(shù)據(jù)項(xiàng)項(xiàng)定義Web頁頁面和JJs接口口定義等等注：對于于復(fù)雜的的模塊可可以在詳詳細(xì)設(shè)計(jì)計(jì)文檔中中可

9、以包包含了UUML類類圖，和和時(shí)序圖圖 ，從從而進(jìn)一一步描述述設(shè)計(jì)的的內(nèi)容詳細(xì)設(shè)計(jì)計(jì)時(shí)間要要求：簡單的業(yè)業(yè)務(wù)需求求：2-4小時(shí)時(shí)復(fù)雜的業(yè)業(yè)務(wù)需求求4-112小時(shí)時(shí)詳細(xì)設(shè)計(jì)計(jì)文檔的的書寫原原則：系統(tǒng)設(shè)計(jì)計(jì)人員在在文檔中中能描述述清楚業(yè)業(yè)務(wù)模塊塊的詳細(xì)細(xì)設(shè)計(jì)，不拘泥泥于格式式。2.4.2 技技術(shù)評審審階段技術(shù)評審審流程：1）系系統(tǒng)設(shè)計(jì)計(jì)人員在在技術(shù)評評審之前前，將自自己的詳詳細(xì)設(shè)計(jì)計(jì)文檔分分發(fā)給技技術(shù)評審審的與會(huì)會(huì)人員。2）在技技術(shù)評審審過程中中，系統(tǒng)統(tǒng)設(shè)計(jì)人人員首先先講述詳詳細(xì)設(shè)計(jì)計(jì)文檔3）評審審人員對對詳細(xì)設(shè)設(shè)計(jì)中各各個(gè)環(huán)節(jié)節(jié)進(jìn)行詢詢問和確確認(rèn)，提提出修改改方案。4）最后后項(xiàng)目技技術(shù)負(fù)責(zé)責(zé)人確

10、認(rèn)認(rèn)調(diào)整后后的設(shè)計(jì)計(jì)方案。技術(shù)階段段的交付付結(jié)果（可配置置項(xiàng)）業(yè)務(wù)確定定的詳細(xì)細(xì)設(shè)計(jì)文文檔。注：此文文檔是交交付確認(rèn)認(rèn)的標(biāo)準(zhǔn)準(zhǔn)之一。2.5CCodiing階階段系統(tǒng)開發(fā)發(fā)人員根根據(jù)業(yè)務(wù)務(wù)的項(xiàng)目目詳細(xì)設(shè)設(shè)計(jì)文檔檔，進(jìn)行行實(shí)際CCodiing過過程。在Coddingg過程中中的注意意事項(xiàng)1） 在在Coddingg過程中中嚴(yán)格按按照Coodinng開發(fā)發(fā)規(guī)范來來執(zhí)行。2）在CCodiing過過程中，發(fā)現(xiàn)詳詳細(xì)設(shè)計(jì)計(jì)文檔中中的嚴(yán)重重缺陷，則需要要和項(xiàng)目目設(shè)計(jì)人人員確認(rèn)認(rèn)，如非非常復(fù)雜雜，則需需重新技技術(shù)評審審。3）在詳詳細(xì)設(shè)計(jì)計(jì)發(fā)生改改變時(shí)，需要及及時(shí)更新新詳細(xì)設(shè)設(shè)計(jì)文檔檔。2.6業(yè)業(yè)務(wù)模塊塊確認(rèn)交付

11、付階段項(xiàng)目技術(shù)術(shù)負(fù)責(zé)人人和業(yè)務(wù)務(wù)分析人人員共同同對業(yè)務(wù)務(wù)模塊進(jìn)進(jìn)行驗(yàn)收收。驗(yàn)收步驟驟：1）業(yè)務(wù)務(wù)分析人人員確認(rèn)認(rèn)功能模模塊實(shí)現(xiàn)現(xiàn)功能和和客戶需需求一致致2）技術(shù)術(shù)負(fù)責(zé)人人對功能能模塊進(jìn)進(jìn)行技術(shù)術(shù)上的確確認(rèn)。3）測試試人員的的測試報(bào)報(bào)告注：第三三步主要要看公司司的具體體的情況況和業(yè)務(wù)務(wù)復(fù)雜度度， 第三步步完成流流程如下下：1）準(zhǔn)備備測試階階段 測試人人員根據(jù)據(jù)業(yè)務(wù)需需求，設(shè)設(shè)定一個(gè)個(gè)業(yè)務(wù)環(huán)環(huán)境，寫寫成測試試腳本， 22）測試試階段 根根據(jù)測試試環(huán)境和和業(yè)務(wù)需需求 進(jìn)進(jìn)行測試試 33）根據(jù)據(jù)測試的的結(jié)果，出測試試報(bào)告。2.7 系統(tǒng)集集成測試試根據(jù)客戶戶業(yè)務(wù)需需求，測測試人員員設(shè)定一一個(gè)測試試環(huán)境，編寫測測試腳本本，在測測試服務(wù)務(wù)器上部部署好系系統(tǒng)。按按照測試試用例進(jìn)進(jìn)行業(yè)務(wù)務(wù)功能上上測試。測試人員員準(zhǔn)備工工作清單單：測試用例例測試腳本本當(dāng)前實(shí)現(xiàn)現(xiàn)模塊硬件設(shè)備