目的與概述

本文檔為XX公司的開(kāi)發(fā)規(guī)范文檔，給開(kāi)發(fā)團(tuán)隊(duì)提供開(kāi)發(fā)標(biāo)準(zhǔn)和規(guī)范。

整體說(shuō)明

    在開(kāi)發(fā)規(guī)范中包含了兩個(gè)部分，第一部分是項(xiàng)目開(kāi)發(fā)流程規(guī)范，主要闡述在項(xiàng)目開(kāi)發(fā)過(guò)程中的各個(gè)階段的規(guī)范。第二部分為Coding開(kāi)發(fā)規(guī)范，Coding開(kāi)發(fā)規(guī)范闡述了在一個(gè)框架中的各個(gè)層的開(kāi)發(fā)規(guī)范

   （注：在第一版中不包含對(duì)工作流開(kāi)發(fā)的規(guī)范制定）

覆蓋范圍

閱讀對(duì)象

1.         項(xiàng)目管理人員

2.         系統(tǒng)設(shè)計(jì)人員

3.         系統(tǒng)開(kāi)發(fā)人員

參考資料

略

 2 項(xiàng)目開(kāi)發(fā)流程規(guī)范

2.1 業(yè)務(wù)需求調(diào)研階段

l 調(diào)研的目標(biāo)

      系統(tǒng)層面： 客戶(hù)的系統(tǒng)運(yùn)行環(huán)境

業(yè)務(wù)層面：了解客戶(hù)需要什么樣的系統(tǒng)，具體了解業(yè)務(wù)目的，業(yè)務(wù)邏輯，業(yè)務(wù)數(shù)據(jù)，客戶(hù)的操作習(xí)慣，頁(yè)面風(fēng)格習(xí)慣等。

 l 調(diào)研的準(zhǔn)備工作：

行業(yè)知識(shí)的準(zhǔn)備：

      了解客戶(hù)的行業(yè)背景，行業(yè)領(lǐng)域的業(yè)務(wù)術(shù)語(yǔ)，含義。結(jié)合客戶(hù)行業(yè)背景，了解客戶(hù)的業(yè)務(wù)知識(shí)。   

      業(yè)務(wù)專(zhuān)家需求：

          在行業(yè)領(lǐng)域的復(fù)雜度不高的情況下，業(yè)務(wù)分析人員直接收集并學(xué)習(xí)行業(yè)知識(shí)就可以了，但行業(yè)知識(shí)的準(zhǔn)備工作還是要做的

          在行業(yè)領(lǐng)域業(yè)務(wù)復(fù)雜度高的情況下，需要業(yè)務(wù)專(zhuān)家對(duì)客戶(hù)的業(yè)務(wù)的進(jìn)行整理。

l 調(diào)研的流程：

第一步 ，項(xiàng)目啟動(dòng)階段 了解客戶(hù)的IT環(huán)境。

第二步， 討論并具體確定客戶(hù)系統(tǒng)的范圍，并獲得客戶(hù)業(yè)務(wù)功能點(diǎn)的原始的單據(jù)。在這個(gè)過(guò)程中準(zhǔn)備一個(gè)本和一只筆記錄討論的業(yè)務(wù)信息

第三步， 整理業(yè)務(wù)信息，和原始表單，抽取出有效業(yè)務(wù)信息，并對(duì)于不明確的業(yè)務(wù)信息進(jìn)行整理和歸類(lèi)，并制作成問(wèn)卷形式進(jìn)一步調(diào)研。

第四步， 發(fā)放調(diào)研問(wèn)卷，再次進(jìn)行業(yè)務(wù)調(diào)研（直接轉(zhuǎn)到三）

第五步，卷寫(xiě)調(diào)研問(wèn)卷，并內(nèi)部評(píng)審

第六步，調(diào)研問(wèn)卷客戶(hù)評(píng)審并確認(rèn)。

l 調(diào)研階段的交付項(xiàng)（可配置項(xiàng)）

軟件需求說(shuō)明書(shū)

軟件需求說(shuō)明書(shū)的目錄：

1 客戶(hù)行業(yè)背景

2 客戶(hù)系統(tǒng)的意義

3 客戶(hù)系統(tǒng)運(yùn)行的環(huán)境

4 業(yè)務(wù)功能點(diǎn)描述（業(yè)務(wù)目的，業(yè)務(wù)邏輯，業(yè)務(wù)數(shù)據(jù)，優(yōu)先級(jí)別，使用頻率等）

       5 客戶(hù)的操作習(xí)慣，頁(yè)面風(fēng)格習(xí)慣。

2.2 概要設(shè)計(jì)階段

概要設(shè)計(jì)階段主要分兩個(gè)步驟： 1 框架設(shè)計(jì)   2 業(yè)務(wù)模塊概要設(shè)計(jì) ,下面分別對(duì)兩個(gè)步驟進(jìn)行描述：

2.2.1框架設(shè)計(jì)

       （注：這邊的框架設(shè)計(jì)是按照傳統(tǒng)的開(kāi)發(fā)方式進(jìn)行闡述，基于平臺(tái)的開(kāi)發(fā)方式待補(bǔ)）

l 框架設(shè)計(jì)的目標(biāo)：

根據(jù)客戶(hù)需求，設(shè)計(jì)系統(tǒng)的后臺(tái)架構(gòu)，前臺(tái)界面框架，數(shù)據(jù)模型。在設(shè)計(jì)之前要考慮客戶(hù)的業(yè)務(wù)特點(diǎn)，性能要求，已有的IT環(huán)境，同時(shí)還要考慮將來(lái)業(yè)務(wù)的增長(zhǎng)，保證系統(tǒng)一定得可擴(kuò)展性。

l 框架設(shè)計(jì)包含的內(nèi)容：

后臺(tái)框架： 各層的職能劃分，技術(shù)實(shí)現(xiàn)的方式，層之間的交互規(guī)則，異常處理規(guī)則，目錄定義規(guī)則

   界面框架：操作主界面定義

              頁(yè)面整體風(fēng)格的定義，頁(yè)面流轉(zhuǎn)關(guān)系等

   數(shù)據(jù)模型： 系統(tǒng)基礎(chǔ)數(shù)據(jù)（組織人員結(jié)構(gòu)，權(quán)限設(shè)置，字典參數(shù)設(shè)置）

              業(yè)務(wù)數(shù)據(jù)

l 框架設(shè)計(jì)階段交付項(xiàng)：

文檔 ：系統(tǒng)架構(gòu)

        界面框架

        數(shù)據(jù)模型

注：三份文檔可以融合在一份文檔之中。

2.2.2業(yè)務(wù)模塊概要設(shè)計(jì)

系統(tǒng)設(shè)計(jì)人員根據(jù)業(yè)務(wù)分析人員的業(yè)務(wù)需求文檔，進(jìn)行概要設(shè)計(jì)。在概要設(shè)計(jì)過(guò)程中主要關(guān)注三個(gè)關(guān)鍵點(diǎn)

1） 業(yè)務(wù)模塊的頁(yè)面顯示內(nèi)容：信息顯示的內(nèi)容，顯示的方式；交互接口的定義，等

   舉例：查詢(xún)?nèi)藛T信息模塊

   操作說(shuō)明，查詢(xún)條件，顯示字段，排序和顯示方式。

2）業(yè)務(wù)邏輯描述

       對(duì)業(yè)務(wù)邏輯進(jìn)行詳細(xì)的描述。

3）業(yè)務(wù)數(shù)據(jù)項(xiàng)

   業(yè)務(wù)模塊涉及到數(shù)據(jù)的描述。

   具體的描述包含

   數(shù)據(jù)項(xiàng)名稱(chēng) ，顯示方式，是否必填，輸入方式，相關(guān)邏輯

l 概要設(shè)計(jì)階段的交付項(xiàng)

概要設(shè)計(jì)文檔

2.3 業(yè)務(wù)需求理解階段                                         

2.3.1系統(tǒng)設(shè)計(jì)人員理解需求

在系統(tǒng)設(shè)計(jì)人員理解需求之前，業(yè)務(wù)分析人員必須提供相關(guān)模塊的客戶(hù)需求文檔。 系統(tǒng)設(shè)計(jì)人員閱讀并理解客戶(hù)需求文檔。

l 理解需求文檔的交付結(jié)果（可配置項(xiàng)）

業(yè)務(wù)需求對(duì)于客戶(hù)來(lái)講，目的是什么，解決什么問(wèn)題，有什么意義？

具體業(yè)務(wù)的執(zhí)行邏輯是什么？

在業(yè)務(wù)流轉(zhuǎn)過(guò)程中的業(yè)務(wù)數(shù)據(jù)有哪些？

l 需求理解時(shí)間要求：

簡(jiǎn)單的需求，理解時(shí)間為2-3 小時(shí)

復(fù)雜需求：理解需求時(shí)間4-8小時(shí)

l 復(fù)雜的業(yè)務(wù)需求需要需求分析人員確認(rèn)。

復(fù)雜的業(yè)務(wù)需求按照涉及到的業(yè)務(wù)的復(fù)雜度來(lái)決定的。

2.4 詳細(xì)設(shè)計(jì)階段

   詳細(xì)設(shè)計(jì)階段分兩個(gè)步驟

l 第一步驟，系統(tǒng)設(shè)計(jì)人員根據(jù)業(yè)務(wù)需求的理解,詳細(xì)設(shè)計(jì)業(yè)務(wù)模塊，并出詳細(xì)設(shè)計(jì)文檔

l 第二步驟，核心設(shè)計(jì)人員對(duì)系統(tǒng)設(shè)計(jì)人員的詳細(xì)設(shè)計(jì)文檔進(jìn)行技術(shù)評(píng)審。

2.4.1系統(tǒng)設(shè)計(jì)人員詳細(xì)設(shè)計(jì)階段

系統(tǒng)設(shè)計(jì)人員根據(jù)業(yè)務(wù)需求，詳細(xì)設(shè)計(jì)模塊。

l 詳細(xì)設(shè)計(jì)階段的交付結(jié)果（可配置項(xiàng)）

詳細(xì)設(shè)計(jì)文檔：

業(yè)務(wù)接口定義

數(shù)據(jù)庫(kù)的數(shù)據(jù)項(xiàng)定義

Web頁(yè)面和Js接口定義等

注：對(duì)于復(fù)雜的模塊可以在詳細(xì)設(shè)計(jì)文檔中可以包含了UML類(lèi)圖，和時(shí)序圖 ，從而進(jìn)一步描述設(shè)計(jì)的內(nèi)容

l 詳細(xì)設(shè)計(jì)時(shí)間要求：

簡(jiǎn)單的業(yè)務(wù)需求：2-4小時(shí)

復(fù)雜的業(yè)務(wù)需求4-12小時(shí)

l 詳細(xì)設(shè)計(jì)文檔的書(shū)寫(xiě)原則：

系統(tǒng)設(shè)計(jì)人員在文檔中能描述清楚業(yè)務(wù)模塊的詳細(xì)設(shè)計(jì)，不拘泥于格式。

2.4.2 技術(shù)評(píng)審階段

l 技術(shù)評(píng)審流程：

       1）系統(tǒng)設(shè)計(jì)人員在技術(shù)評(píng)審之前，將自己的詳細(xì)設(shè)計(jì)文檔分發(fā)給技術(shù)評(píng)審的與會(huì)人員。

2）在技術(shù)評(píng)審過(guò)程中，系統(tǒng)設(shè)計(jì)人員首先講述詳細(xì)設(shè)計(jì)文檔

3）評(píng)審人員對(duì)詳細(xì)設(shè)計(jì)中各個(gè)環(huán)節(jié)進(jìn)行詢(xún)問(wèn)和確認(rèn)，提出修改方案。

4）最后項(xiàng)目技術(shù)負(fù)責(zé)人確認(rèn)調(diào)整后的設(shè)計(jì)方案。

l 技術(shù)階段的交付結(jié)果（可配置項(xiàng)）

業(yè)務(wù)確定的詳細(xì)設(shè)計(jì)文檔。

注：此文檔是交付確認(rèn)的標(biāo)準(zhǔn)之一。

2.5 Coding階段

系統(tǒng)開(kāi)發(fā)人員根據(jù)業(yè)務(wù)的項(xiàng)目詳細(xì)設(shè)計(jì)文檔，進(jìn)行實(shí)際Coding過(guò)程。

在Coding過(guò)程中的注意事項(xiàng)

1） 在Coding過(guò)程中嚴(yán)格按照Coding開(kāi)發(fā)規(guī)范來(lái)執(zhí)行。

2）在Coding過(guò)程中，發(fā)現(xiàn)詳細(xì)設(shè)計(jì)文檔中的嚴(yán)重缺陷，則需要和項(xiàng)目設(shè)計(jì)人員確認(rèn)，如非常復(fù)雜，則需重新技術(shù)評(píng)審。

3）在詳細(xì)設(shè)計(jì)發(fā)生改變時(shí)，需要及時(shí)更新詳細(xì)設(shè)計(jì)文檔。

2.6 業(yè)務(wù)模塊確認(rèn)交付階段

項(xiàng)目技術(shù)負(fù)責(zé)人和業(yè)務(wù)分析人員共同對(duì)業(yè)務(wù)模塊進(jìn)行驗(yàn)收。

驗(yàn)收步驟：

1）業(yè)務(wù)分析人員確認(rèn)功能模塊實(shí)現(xiàn)功能和客戶(hù)需求一致

2）技術(shù)負(fù)責(zé)人對(duì)功能模塊進(jìn)行技術(shù)上的確認(rèn)。

3）測(cè)試人員的測(cè)試報(bào)告

注：第三步主要看公司的具體的情況和業(yè)務(wù)復(fù)雜度，

    第三步完成流程如下：

   1）準(zhǔn)備測(cè)試階段 測(cè)試人員根據(jù)業(yè)務(wù)需求，設(shè)定一個(gè)業(yè)務(wù)環(huán)境，寫(xiě)成測(cè)試腳本，

   2）測(cè)試階段   根據(jù)測(cè)試環(huán)境和業(yè)務(wù)需求 進(jìn)行測(cè)試

   3）根據(jù)測(cè)試的結(jié)果，出測(cè)試報(bào)告。

2.7 系統(tǒng)集成測(cè)試

根據(jù)客戶(hù)業(yè)務(wù)需求，測(cè)試人員設(shè)定一個(gè)測(cè)試環(huán)境，編寫(xiě)測(cè)試腳本，在測(cè)試服務(wù)器上部署好系統(tǒng)。按照測(cè)試用例進(jìn)行業(yè)務(wù)功能上測(cè)試。

測(cè)試人員準(zhǔn)備工作清單：

測(cè)試用例

測(cè)試腳本

當(dāng)前實(shí)現(xiàn)模塊

硬件設(shè)備：

等同條件的客戶(hù)運(yùn)行環(huán)境

系統(tǒng)集成測(cè)試階段交付項(xiàng)（可配置項(xiàng)）：

系統(tǒng)集成測(cè)試報(bào)告

系統(tǒng)集成測(cè)試報(bào)告格式

功能點(diǎn) 測(cè)試人 測(cè)試腳本 測(cè)試結(jié)果   異常原因

2.8 系統(tǒng)打包部署

    客服安裝人員將系統(tǒng)打包成一個(gè)安裝文件，供在客戶(hù)的系統(tǒng)環(huán)境中部署系統(tǒng)

系統(tǒng)集成測(cè)試階段交付項(xiàng)（可配置項(xiàng)）：

系統(tǒng)安裝文件