項目開發(fā)規(guī)檔

1、T/KFGF文檔編號：文檔版本：0.1項目編號：YC_FLATFORM項目開發(fā)規(guī)范文檔編寫人：徐文兵日期：2009-7-20審核人：日期：批準(zhǔn)人：日期：修改記錄（ REVISION CHART）0.1徐文初稿2009-7-22兵1 概述目的與概述本文檔為XX公司的開發(fā)規(guī)范文檔，給開發(fā)團隊提供開發(fā)標(biāo)準(zhǔn)和規(guī)范。整體說明在開發(fā)規(guī)范中包含了兩個部分，第一部分是項目開發(fā)流程規(guī)范，主要闡述在項目開發(fā)過程中的各個階段的規(guī)范。第二部分為Coding 開發(fā)規(guī)范， Coding 開發(fā)規(guī)范闡述了在一個框架中的各個層的開發(fā)規(guī)范（注：在第一版中不包含對工作流開發(fā)的規(guī)范制定）覆蓋范圍閱讀對象1. 項目管理人員2. 系統(tǒng)設(shè)

2、計人員3. 系統(tǒng)開發(fā)人員參考資料略2 項目開發(fā)流程規(guī)范2.1 業(yè)務(wù)需求調(diào)研階段調(diào)研的目標(biāo)系統(tǒng)層面：客戶的系統(tǒng)運行環(huán)境業(yè)務(wù)層面：了解客戶需要什么樣的系統(tǒng)，具體了解業(yè)務(wù)目的，業(yè)務(wù)邏輯，業(yè)務(wù)數(shù)據(jù)，客戶的操作習(xí)慣，頁面風(fēng)格習(xí)慣等。調(diào)研的準(zhǔn)備工作：行業(yè)知識的準(zhǔn)備：了解客戶的行業(yè)背景，行業(yè)領(lǐng)域的業(yè)務(wù)術(shù)語，含義。結(jié)合客戶行業(yè)背景，了解客戶的業(yè)務(wù)知識。業(yè)務(wù)專家需求 ：在行業(yè)領(lǐng)域的復(fù)雜度不高的情況下，業(yè)務(wù)分析人員直接收集并學(xué)習(xí)行業(yè)知識就可以了，但行業(yè)知識的準(zhǔn)備工作還是要做的在行業(yè)領(lǐng)域業(yè)務(wù)復(fù)雜度高的情況下，需要業(yè)務(wù)專家對客戶的業(yè)務(wù)的進行整理。調(diào)研的流程：第一步，項目啟動階段了解客戶的IT 環(huán)境。第二步，討論并具體

3、確定客戶系統(tǒng)的范圍，并獲得客戶業(yè)務(wù)功能點的原始的單據(jù)。在這個過程中準(zhǔn)備一個本和一只筆記錄討論的業(yè)務(wù)信息第三步，整理業(yè)務(wù)信息，和原始表單，抽取出有效業(yè)務(wù)信息，并對于不明確的業(yè)務(wù)信息進行整理和歸類，并制作成問卷形式進一步調(diào)研。第四步，發(fā)放調(diào)研問卷，再次進行業(yè)務(wù)調(diào)研（直接轉(zhuǎn)到三）第五步，卷寫調(diào)研問卷，并內(nèi)部評審第六步，調(diào)研問卷客戶評審并確認。調(diào)研階段的交付項（可配置項）軟件需求說明書軟件需求說明書的目錄：1 客戶行業(yè)背景2 客戶系統(tǒng)的意義3 客戶系統(tǒng)運行的環(huán)境4 業(yè)務(wù)功能點描述（業(yè)務(wù)目的，業(yè)務(wù)邏輯，業(yè)務(wù)數(shù)據(jù)，優(yōu)先級別，使用頻率等）5 客戶的操作習(xí)慣，頁面風(fēng)格習(xí)慣。2.2 概要設(shè)計階段概要設(shè)計階段主要

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

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

6、，業(yè)務(wù)分析人員必須提供相關(guān)模塊的客戶需求文檔。 系統(tǒng)設(shè)計人員閱讀并理解客戶需求文檔。理解需求文檔的交付結(jié)果（可配置項）業(yè)務(wù)需求對于客戶來講，目的是什么，解決什么問題，有什么意義？具體業(yè)務(wù)的執(zhí)行邏輯是什么？在業(yè)務(wù)流轉(zhuǎn)過程中的業(yè)務(wù)數(shù)據(jù)有哪些？需求理解時間要求：簡單的需求，理解時間為2-3小時復(fù)雜需求：理解需求時間4-8 小時復(fù)雜的業(yè)務(wù)需求需要需求分析人員確認。復(fù)雜的業(yè)務(wù)需求按照涉及到的業(yè)務(wù)的復(fù)雜度來決定的。2.4 詳細設(shè)計階段詳細設(shè)計階段分兩個步驟第一步驟，系統(tǒng)設(shè)計人員根據(jù)業(yè)務(wù)需求的理解, 詳細設(shè)計業(yè)務(wù)模塊，并出詳細設(shè)計文檔第二步驟，核心設(shè)計人員對系統(tǒng)設(shè)計人員的詳細設(shè)計文檔進行技術(shù)評審。2.4.1

7、系統(tǒng)設(shè)計人員詳細設(shè)計階段系統(tǒng)設(shè)計人員根據(jù)業(yè)務(wù)需求，詳細設(shè)計模塊。詳細設(shè)計階段的交付結(jié)果（可配置項）詳細設(shè)計文檔：業(yè)務(wù)接口定義數(shù)據(jù)庫的數(shù)據(jù)項定義Web頁面和 Js 接口定義等注：對于復(fù)雜的模塊可以在詳細設(shè)計文檔中可以包含了UML類圖，和時序圖 ，從而進一步描述設(shè)計的內(nèi)容詳細設(shè)計時間要求：簡單的業(yè)務(wù)需求：2-4 小時復(fù)雜的業(yè)務(wù)需求4-12 小時詳細設(shè)計文檔的書寫原則：系統(tǒng)設(shè)計人員在文檔中能描述清楚業(yè)務(wù)模塊的詳細設(shè)計，不拘泥于格式。2.4.2技術(shù)評審階段技術(shù)評審流程 ：1）系統(tǒng)設(shè)計人員在技術(shù)評審之前，將自己的詳細設(shè)計文檔分發(fā)給技術(shù)評審的與會人員。2）在技術(shù)評審過程中，系統(tǒng)設(shè)計人員首先講述詳細設(shè)計文檔

8、3）評審人員對詳細設(shè)計中各個環(huán)節(jié)進行詢問和確認，提出修改方案。4）最后項目技術(shù)負責(zé)人確認調(diào)整后的設(shè)計方案。技術(shù)階段的交付結(jié)果（可配置項）業(yè)務(wù)確定的詳細設(shè)計文檔。注：此文檔是交付確認的標(biāo)準(zhǔn)之一。2.5 Coding 階段系統(tǒng)開發(fā)人員根據(jù)業(yè)務(wù)的項目詳細設(shè)計文檔，進行實際Coding 過程。在 Coding 過程中的注意事項1） 在 Coding 過程中嚴(yán)格按照Coding 開發(fā)規(guī)范來執(zhí)行。2）在 Coding 過程中，發(fā)現(xiàn)詳細設(shè)計文檔中的嚴(yán)重缺陷，則需要和項目設(shè)計人員確認，如非常復(fù)雜，則需重新技術(shù)評審。3）在詳細設(shè)計發(fā)生改變時，需要及時更新詳細設(shè)計文檔。2.6 業(yè)務(wù)模塊確認交付階段項目技術(shù)負責(zé)人和業(yè)務(wù)分析人員共同對業(yè)務(wù)模塊進行驗收。驗收步驟：1）業(yè)務(wù)分析人員確認功能模塊實現(xiàn)功能和客戶需求一致2）技術(shù)負責(zé)人對功能模塊進行技術(shù)上的確認。3）測試人員的測試報告注：第三步主要看公司的具體的情況和業(yè)務(wù)復(fù)雜度，第三步完成流程如下：1）準(zhǔn)備測試階段測試人員根據(jù)業(yè)務(wù)需求，設(shè)定一個業(yè)務(wù)環(huán)境，寫成測試腳本，2）測試階段根據(jù)測試環(huán)境和業(yè)務(wù)需求進行測試3 ）根據(jù)測試的結(jié)果，出測試報告。2.7 系統(tǒng)集成測試根據(jù)客戶業(yè)務(wù)需求，測試人員設(shè)定一個測試環(huán)境，編寫測試腳本，在測試服務(wù)器上部署好系統(tǒng)。按照測試用例進行業(yè)務(wù)功能上測試。測試人員準(zhǔn)備工作清單：測試用例測試腳本當(dāng)前實現(xiàn)