軟件開(kāi)發(fā)規(guī)范

1、項(xiàng)目組軟件開(kāi)發(fā)行為規(guī)范僅供信息化部使用1 概述1.1 編寫(xiě)目的 為了把公司已經(jīng)發(fā)布的軟件開(kāi)發(fā)過(guò)程規(guī)范有效地運(yùn)作于產(chǎn)品開(kāi)發(fā)活動(dòng)中， 把 各種規(guī)范“逐步形成工程師的作業(yè)規(guī)范” ，特制定本軟件開(kāi)發(fā)行為規(guī)范，以到達(dá) 提高系統(tǒng)質(zhì)量的目的。在本規(guī)范中，闡述了基本的開(kāi)發(fā)模式，包括需求驗(yàn)證、設(shè) 計(jì)、編碼規(guī)范、代碼審查、單元測(cè)試、配置管理等，并明確開(kāi)發(fā)過(guò)程中的方法、 策略、工具以及環(huán)境要求，開(kāi)發(fā)人員都必須遵守本軟件開(kāi)發(fā)規(guī)范。1.2 讀者對(duì)象本規(guī)范讀者對(duì)象為軟件開(kāi)發(fā)項(xiàng)目管理者、項(xiàng)目經(jīng)理、開(kāi)發(fā)組2 需求評(píng)審2.1 過(guò)程要求 按軟件開(kāi)發(fā)過(guò)程經(jīng)驗(yàn)，問(wèn)題暴露越早越好。因此，在實(shí)施設(shè)計(jì)和編碼前，需 對(duì)項(xiàng)目經(jīng)理提供的需求說(shuō)明

2、文檔進(jìn)行充分的驗(yàn)證， 在不明確的需求點(diǎn)上， 需要和 項(xiàng)目經(jīng)理進(jìn)一步核實(shí)，確保對(duì)每個(gè)需求點(diǎn)有清晰、一致的認(rèn)識(shí)和理解。在需求驗(yàn)證的過(guò)程中，需按以下檢查點(diǎn)進(jìn)行逐項(xiàng)檢查（包括不限于） ：1. 所有定義、實(shí)現(xiàn)方法是否清楚地表達(dá)了用戶的原始要求？2. 是否清楚、明確地描述了所有的功能？是否沒(méi)有不能理解或造成誤解的 描述 ？3. 需求定義是否包含了有關(guān)功能、性能、限制、目標(biāo)、質(zhì)量等方面的所有 需求？4. 需求是否可以驗(yàn)證（即是否可以檢驗(yàn)軟件是否滿足了需求）？5. 是否有術(shù)語(yǔ)定義一覽表？6. 是否標(biāo)識(shí)并定義了在將來(lái)可能會(huì)變化的需求？7. 各個(gè)需求之間是否一致？是否有沖突和矛盾？8. 是否定義了系統(tǒng)所有的輸入、

3、輸出及其來(lái)源？主要為客戶或者其他外部接口，是否明確定義了輸入?yún)?shù)和輸出參數(shù)？9. 是否說(shuō)明了如何進(jìn)行系統(tǒng)輸入的合法性檢查？10. 功能性需求是否覆蓋了所有非正常情況的處理？11. 對(duì)異常數(shù)據(jù)產(chǎn)生的結(jié)果是否作了精確的描述？12. 是否充分定義了關(guān)于人機(jī)界面的需求？13. 在不同情況下，是否規(guī)定了系統(tǒng)的響應(yīng)時(shí)間？14. 界面需求是否使軟硬件系統(tǒng)具有兼容性？15. 是否有對(duì)相關(guān)日志做明確要求？以滿足稽核相關(guān)的需要。針對(duì)開(kāi)發(fā)過(guò)程中的需求變更，以上需求驗(yàn)證點(diǎn)同樣適用，并同時(shí)評(píng)估需求變 更給當(dāng)前項(xiàng)目的設(shè)計(jì)和開(kāi)發(fā)帶來(lái)的風(fēng)險(xiǎn)，包括架構(gòu)、安全、進(jìn)度等方面，以便項(xiàng) 目經(jīng)理進(jìn)行計(jì)劃調(diào)整和安排。2.2 工具及環(huán)境1.

4、 在此過(guò)程中，使用 Excel 對(duì)以上檢查點(diǎn)進(jìn)行跟蹤和標(biāo)記。記錄文檔需 check-in 到 svn.2. 評(píng)審?fù)瓿傻男枨笪臋n需 check-in 到 svn。3. 任何需求變更文檔需 check-in 到 svn。4. 登記相關(guān)問(wèn)題，并跟蹤其狀態(tài)。3 系統(tǒng)設(shè)計(jì)及評(píng)審3.1 過(guò)程要求概要設(shè)計(jì)要以軟件需求規(guī)格為基礎(chǔ)， 必須保證需要實(shí)現(xiàn)的需求規(guī)格已經(jīng)被設(shè) 計(jì)。概要設(shè)計(jì)文檔的需涵蓋以下幾方面：1. 涵蓋系統(tǒng)的總體結(jié)構(gòu)、功能。系統(tǒng)共包含哪些模塊，以及模塊之間的關(guān)系。使閱讀者對(duì)系統(tǒng)有了全局觀。2. 明確系統(tǒng)使用的外部接口和資源。包括外部環(huán)境、第三方接口、第三方 技術(shù)架構(gòu)等。3. 模塊設(shè)計(jì)的進(jìn)一步細(xì)化，包

5、括具體的輸入、輸出、處理邏輯、與其他模 塊之間的接口等。4. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)，文檔中明確數(shù)據(jù)的物理結(jié)構(gòu)和邏輯結(jié)構(gòu)，包括數(shù)據(jù)的存 儲(chǔ)方式、緩存策略、備份策略、清理策略等。5. 容災(zāi)設(shè)計(jì)，主要指外部資源或接口不可用時(shí)，系統(tǒng)如何處理，包括客戶 提示信息、錯(cuò)誤現(xiàn)場(chǎng)記錄等。6. 監(jiān)控設(shè)計(jì)，針對(duì)系統(tǒng)中的關(guān)鍵業(yè)務(wù)，特別是對(duì)實(shí)時(shí)性、準(zhǔn)確性要求較高 的功能，需考慮其監(jiān)控指標(biāo)、監(jiān)控方法、業(yè)務(wù)閥值、告警通知的設(shè)計(jì)。7. 安全設(shè)計(jì)，在系統(tǒng)概要設(shè)計(jì)中，要充分考慮系統(tǒng)安全方面的設(shè)計(jì)，包括 數(shù)據(jù)傳輸、數(shù)據(jù)存儲(chǔ)、網(wǎng)絡(luò)攻擊等方面的情況。8. 其他情況，未在以上提及的項(xiàng)目其他情況，可進(jìn)行特別說(shuō)明。 同時(shí)，在概要設(shè)計(jì)過(guò)程中，需遵循以

6、下原則：1、當(dāng)需求規(guī)格發(fā)生變更時(shí)，必須修訂相關(guān)概要設(shè)計(jì)文檔。2、在概要設(shè)計(jì)文檔，必須記錄、驗(yàn)證需求和概要設(shè)計(jì)的跟蹤關(guān)系。3、必須保證概要設(shè)計(jì)文檔和代碼的一致性。當(dāng)發(fā)生設(shè)計(jì)更改時(shí)，必須 修訂相應(yīng)設(shè)計(jì)文檔。4、概要設(shè)計(jì)過(guò)程結(jié)束前，必須通過(guò)評(píng)審，并保存評(píng)審記錄。5、設(shè)計(jì)更改必須經(jīng)過(guò)相關(guān)評(píng)審，并保存評(píng)審記錄。 在概要設(shè)計(jì)評(píng)審階段，可按以下檢查點(diǎn)進(jìn)行逐項(xiàng)驗(yàn)證（包括但不限于）1、是否描述了接口的功能特征 ?2、接口是否便于查錯(cuò) ?3、接口相互之間、和其他模塊、和需求說(shuō)明書(shū)及接口規(guī)格書(shū)保持一致？4、對(duì)接口的數(shù)量和復(fù)雜度進(jìn)行了有效的平衡，使接口數(shù)量控制在一個(gè)較小 數(shù)量，每個(gè)接口具有可接受的復(fù)雜度？5、是否所有

7、的接口都能描述了必要的類型、數(shù)量、質(zhì)量等信息？6、操作界面是否考慮了用戶（例如：提供準(zhǔn)確、清晰、有用的提示信息）7、是否模塊化設(shè)計(jì)？8、模塊遵循高內(nèi)聚、低耦合的原則？9、是否每一部分的設(shè)計(jì)都可以追溯到需求說(shuō)明書(shū)，接口規(guī)格說(shuō)明書(shū)、或其 他產(chǎn)品文檔？10、對(duì)所繼承下來(lái)的那些特別和不常用的特性對(duì)目前設(shè)計(jì)的影響是否進(jìn)行了 分析？11、需求規(guī)格評(píng)審中不完整的需求是否都已經(jīng)解決 ?12、設(shè)計(jì)是否考慮了檢錯(cuò)和恢復(fù)措施？（例如：輸入檢查，數(shù)據(jù)錯(cuò)誤后如何 恢復(fù)）13、是否考慮了異常情況？14、是否完全準(zhǔn)確描述了所有的出錯(cuò)情況？15、設(shè)計(jì)是否能夠滿足所有系統(tǒng)集成方面的要求？3.3 工具及環(huán)境1. 概要設(shè)計(jì)文檔及其

8、評(píng)審文檔需 check-in 到 svn 中。2. 概要設(shè)計(jì)過(guò)程中的問(wèn)題跟蹤需記錄。4 系統(tǒng)實(shí)現(xiàn)4.1 過(guò)程要求編碼必須以設(shè)計(jì)文檔為基礎(chǔ)， 必須保證所有的設(shè)計(jì)都被編碼實(shí)現(xiàn)。 當(dāng)設(shè)計(jì)發(fā) 生變更時(shí)， 必須修改相關(guān)代碼。 同時(shí)必須保證設(shè)計(jì)文檔和代碼的一致性。 當(dāng)代碼 的修改已經(jīng)造成設(shè)計(jì)更改時(shí)，必須修訂相應(yīng)設(shè)計(jì)文檔。在系統(tǒng)實(shí)現(xiàn)過(guò)程中，需遵循以下規(guī)范：1. 遵照各項(xiàng)編碼規(guī)范。2. 所有代碼使用 svn 進(jìn)行統(tǒng)一管理，并至少提供開(kāi)發(fā)、測(cè)試、生產(chǎn)三種構(gòu) 建腳本。3. 在系統(tǒng)開(kāi)始之前，需在 svn 上創(chuàng)建對(duì)應(yīng)的分支，開(kāi)發(fā)工作統(tǒng)一在分支上 進(jìn)行。4. 針對(duì)開(kāi)發(fā)任務(wù)的分解，需要參照單人單任務(wù)在兩天以內(nèi)完成的標(biāo)準(zhǔn)。

9、5. 開(kāi)發(fā)過(guò)程中，單元測(cè)試通過(guò)的代碼需要及時(shí) check-in 到 svn。6. 代碼進(jìn)入系統(tǒng)測(cè)試前需進(jìn)行評(píng)審， 可以是集中評(píng)審或者交叉評(píng)審的方式。 評(píng)審內(nèi)容包括基本編碼規(guī)范、基本邏輯、日志規(guī)范、出錯(cuò)處理等。7. 單元測(cè)試的覆蓋率需在 80%以上。具體的單元測(cè)試要點(diǎn)如下：對(duì)所測(cè)模塊的數(shù)據(jù)進(jìn)行測(cè)試。檢查不正確或不一致的數(shù)據(jù)類型說(shuō)明、使用尚未附值或尚未初始化 的變量、錯(cuò)誤的初始值或缺省值。設(shè)計(jì)測(cè)試用例查找由于不正確的計(jì)算（包括算法錯(cuò)、表達(dá)式符號(hào)表 示不正確、 運(yùn)算精度不夠等）、不正確的比較或不正常的控制流 （包括不 同數(shù)據(jù)類型量的相互比較、不適當(dāng)?shù)匦薷牧搜h(huán)變量、錯(cuò)誤的或不可能 的循環(huán)終止條件等）

10、而導(dǎo)致的錯(cuò)誤。檢查模塊有沒(méi)有對(duì)預(yù)見(jiàn)錯(cuò)誤的條件設(shè)計(jì)比較完善的錯(cuò)誤處理功能， 保證其邏輯上的正確性。邊界檢查，注意設(shè)計(jì)數(shù)據(jù)、控制中剛好等于、大于或小于確定的比 較值的用例。8. 開(kāi)發(fā)過(guò)程中，需進(jìn)行持續(xù)化構(gòu)建，保證 check-in 的代碼質(zhì)量。9. 項(xiàng)目中引進(jìn)的新技術(shù)需經(jīng)過(guò)統(tǒng)一評(píng)審。5 測(cè)試5.1 過(guò)程要求在系統(tǒng)交付給測(cè)試組進(jìn)行測(cè)試前，開(kāi)發(fā)人員需在內(nèi)部進(jìn)行第一輪功能測(cè)試。 測(cè)試過(guò)程中需保持測(cè)試代碼的準(zhǔn)確性和測(cè)試環(huán)境的獨(dú)立性。 具體測(cè)試內(nèi)容包含但 不限于以下幾方面：1. 功能測(cè)試。對(duì)照需求文檔中的功能點(diǎn)， 對(duì)系統(tǒng)的功能進(jìn)行測(cè)試驗(yàn)證， 確保 系統(tǒng)完全滿足需求文檔中的要求。2. 平臺(tái)兼容性測(cè)試。 在不同

11、的瀏覽器、 硬件配置環(huán)境下進(jìn)行測(cè)試， 主要瀏覽 器包括 Firefox,safari,IE, chrome 。針對(duì)移動(dòng)端，需涵蓋三個(gè)主流操作系統(tǒng)， iOS, Android 和 Windows Mobile 。 硬件兼容性則包括不同的智能終端，PC,MAC,IPAD等其他機(jī)型的不同分辨率下的兼容性測(cè)試。3不同網(wǎng)絡(luò)環(huán)境下測(cè)試。針對(duì)移動(dòng)端的應(yīng)用，驗(yàn)證不同網(wǎng)絡(luò)環(huán)境下，終端應(yīng)用功能與性能方面是否正常 （ 數(shù)據(jù)業(yè)務(wù)是否會(huì)中斷，業(yè)務(wù)模塊是否出現(xiàn)異常 ）網(wǎng)絡(luò)環(huán)境包含：4G信號(hào)，3G信號(hào)，2G強(qiáng)信號(hào)。6 開(kāi)發(fā)計(jì)劃6.1 過(guò)程要求軟件開(kāi)發(fā)是一項(xiàng)復(fù)雜、 長(zhǎng)期的系統(tǒng)工程， 為保證開(kāi)發(fā)能夠順利地進(jìn)行實(shí)施， 必須要制定

12、 科學(xué)、合理、切實(shí)可行的實(shí)施計(jì)劃，制定嚴(yán)格的時(shí)間進(jìn)度表，明確各個(gè)環(huán)節(jié)實(shí)施的時(shí)間，以 指導(dǎo)和控制項(xiàng)目的全面實(shí)施。在系統(tǒng)實(shí)現(xiàn)過(guò)程中，需遵循以下規(guī)范：1. 軟件項(xiàng)目計(jì)劃必須以產(chǎn)品 /軟件的需求規(guī)格為基礎(chǔ)。當(dāng)發(fā)生需求更改時(shí)，必須修訂 軟件開(kāi)發(fā)計(jì)劃。2. 對(duì)于軟件項(xiàng)目計(jì)劃中各項(xiàng)工作產(chǎn)品和工作任務(wù)，必須進(jìn)行規(guī)模和工作量的軟件估 計(jì)，并在軟件項(xiàng)目計(jì)劃文檔中記錄估計(jì)的方法和估計(jì)數(shù)據(jù)3. 對(duì)某項(xiàng)工作產(chǎn)品和任務(wù)的軟件， 同時(shí)采用兩種或以上的方法進(jìn)行估計(jì)， 以避免一種 方法的偏差4. 盡量采用歷史經(jīng)驗(yàn)數(shù)據(jù)進(jìn)行軟件估計(jì)5. 在“軟件開(kāi)發(fā)計(jì)劃”中須包括項(xiàng)目管理活動(dòng)的計(jì)劃6. 在“軟件開(kāi)發(fā)計(jì)劃”包括人員的培訓(xùn)計(jì)劃7. 在

13、“軟件開(kāi)發(fā)計(jì)劃” 中應(yīng)考慮軟件項(xiàng)目進(jìn)行風(fēng)險(xiǎn)分析與評(píng)估， 可能存在的風(fēng)險(xiǎn)領(lǐng)域 含：需求的不明確和變更、外部的限制與對(duì)外的依賴、人力資源的到位情況、人力 資源的技術(shù)等級(jí)滿足要求狀況、技術(shù)問(wèn)題等，造成的計(jì)劃變更。8. 在開(kāi)發(fā)活動(dòng)中，必須按照項(xiàng)目跟蹤與監(jiān)控計(jì)劃和體制，對(duì)照“軟件開(kāi)發(fā)計(jì)劃” ，跟 蹤項(xiàng)目開(kāi)發(fā)的實(shí)際結(jié)果和性能。 當(dāng)實(shí)際結(jié)果和 “軟件項(xiàng)目計(jì)劃”發(fā)生偏離時(shí)，必須 進(jìn)行分析， 根據(jù)分析結(jié)果標(biāo)明糾正措施。 必要的情況下， 要及時(shí)修訂“軟件項(xiàng)目計(jì) 劃”9. 在軟件項(xiàng)目跟蹤監(jiān)控活動(dòng)中， 必須定期進(jìn)行總結(jié)和評(píng)審， 撰寫(xiě)開(kāi)發(fā)狀態(tài)報(bào)告。 根據(jù) 項(xiàng)目的特點(diǎn)，報(bào)告的周期可以為周、雙周、月。7 數(shù)據(jù)安全7.1 過(guò)程要求21 世紀(jì)是一個(gè)信息爆炸的時(shí)代，數(shù)據(jù)是信息的主要載體，數(shù)據(jù)安全保證了信息的可用 性。而數(shù)據(jù)備份作為保證數(shù)據(jù)安全的方法之一， 則顯得尤為重要。 數(shù)據(jù)安全不僅在防范計(jì)算 機(jī)病毒、系統(tǒng)漏洞中有體現(xiàn)，更多的還有代碼安全，數(shù)據(jù)庫(kù)防脫庫(kù)及數(shù)據(jù)庫(kù)備份安全。在系統(tǒng)實(shí)現(xiàn)過(guò)程中，需遵循以下規(guī)范：1. 加強(qiáng)開(kāi)發(fā)人員安全意識(shí)培訓(xùn)， 近年來(lái)的一系列企業(yè)泄密事件的發(fā)生， 根本原因還在 于安