某省某市研發(fā)中心委外項目驗收標準指導(dǎo)說明書（知識研究或個人學(xué)習(xí)）

項目代碼驗收報告文檔驗收架構(gòu)設(shè)計驗收總體架構(gòu)驗收架構(gòu)圖此處需要附上架構(gòu)圖要求架構(gòu)設(shè)計能夠很清晰地描述系統(tǒng)內(nèi)部的模塊劃分，與外部系統(tǒng)的邊界關(guān)系例如：模塊清單列表模塊名稱模塊說明XXXX模塊主要作用說明系統(tǒng)架構(gòu)設(shè)計評估說明驗收標準：能夠深入了解系統(tǒng)架構(gòu)清晰各子系統(tǒng)邊界，如系統(tǒng)臺與外部系統(tǒng)又關(guān)聯(lián)則清晰理解外部系統(tǒng)與本項目系統(tǒng)臺邊界，邊界定義一般為各個系統(tǒng)的。對于不清楚的地方，則需要求合作伙伴進行架構(gòu)補充描述業(yè)務(wù)流程設(shè)計評估評估文檔中是否包含又系統(tǒng)的主要業(yè)務(wù)流程各模塊的交互時序圖時序圖是否交代清晰。臺系統(tǒng)與外部邊界評估評估與外界時間接口文檔是否齊全接口文檔質(zhì)量接口定義是否合理總體架構(gòu)小節(jié)對架構(gòu)的合理性，規(guī)范性，文檔質(zhì)量進行總結(jié)。例如：合理性項目架構(gòu)設(shè)計合理/不合理，其中XXXXXXX設(shè)計不合理XXXXXXX設(shè)計不合理XXXXXXX設(shè)計不合理規(guī)范性XXXX設(shè)計未包含主要的邏輯圖/時序圖，無法全局性描述系統(tǒng)xxxxxx業(yè)務(wù)場景XXXX未包含xxxxxxxx，導(dǎo)致xxxxxxxx文檔質(zhì)量文檔質(zhì)量較好/較差XXXXXX文檔未能描述清楚XXXXXXXX缺少XXXXXXXXX技術(shù)架構(gòu)驗收技術(shù)架構(gòu)圖此處需要附上整體技術(shù)架構(gòu)圖（要求伙伴必須提供）例如：技術(shù)架構(gòu)設(shè)計評估此處需附技術(shù)架構(gòu)圖該技術(shù)架構(gòu)圖需包含本項目中用到的所有技術(shù)文檔中一定要包含技術(shù)架構(gòu)圖，即用了那些技術(shù)進行了系統(tǒng)的開發(fā)和應(yīng)用，每種語言不一樣，此處未文字性描述，例如：該項目使用了JAVA常用的技術(shù)棧，其中XXXXX項目模塊使用了.net技術(shù)，XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX系統(tǒng)詳細設(shè)計驗收標準：文檔中一定要有各子系統(tǒng)/模塊的詳細說明，需說明該模塊的主要作用，說明中還需包含有那些模塊調(diào)用該模塊的服務(wù)，該模塊調(diào)用了那些模塊模塊邊界設(shè)計驗收該項需要按以模塊清單列表中的模塊，以模塊的維度進行評估必須查看所有模塊的接口定義（接口文檔）是否滿足需求檢查接口文檔規(guī)范，描述是否清晰接口文檔需包含接口協(xié)議描述，使用場景描述，所有入?yún)⒚枋?，所有出參描述，?shù)據(jù)結(jié)構(gòu)描述，接口調(diào)用的樣例接口字段中如有枚舉，必須將枚舉一一列出說明，比如：訂單狀態(tài)1，已下單2，待支付3，已支付4，已完成接口邏輯設(shè)計驗收系統(tǒng)詳細設(shè)計說明書/系統(tǒng)業(yè)務(wù)流程圖及說明再這兩個文檔中，對于某個業(yè)務(wù)流程的系統(tǒng)梳理需要有系統(tǒng)交互時序流程設(shè)計及時序交互詳細說明，時序圖主要是描述某業(yè)務(wù)流程下，系統(tǒng)之間的交互情況例子：接口說明文檔標準：每個接口需要有接口執(zhí)行邏輯說明，不限文字，流程圖，或者時序圖進行說明描述。在接口執(zhí)行邏輯說明中，如訪問了外部資源，則需要有訪問策略說明：如：進行數(shù)據(jù)內(nèi)存存儲保存再redis中，存儲策略為保存24小時數(shù)據(jù)庫設(shè)計驗收檢查數(shù)據(jù)庫設(shè)計的規(guī)范，文檔中需包含表明，作用描述，字段類型，字段說明，字段長度，如有枚舉，必須將枚舉一一列出說明系統(tǒng)詳細設(shè)計驗收小結(jié)對系統(tǒng)詳細設(shè)計的驗收情況進行小結(jié)描述代碼走查驗收整體代碼結(jié)構(gòu)合作伙伴對其代碼工程目錄結(jié)構(gòu)以文檔形式進行詳細說明按照系統(tǒng)架構(gòu)結(jié)合技術(shù)架構(gòu)，核實清楚模塊的代碼，工程數(shù)量輸出代碼模塊清單列表代碼模塊模塊說明代碼路徑開發(fā)語言代碼檢查按照常規(guī)的代碼編寫規(guī)范檢查，對于合作伙伴不能提供的源碼，需要核實項目合同中是否有相應(yīng)的條款規(guī)定（可直接找周東進行核實），需明確不提供的源碼是在合同中明確規(guī)定的。如合作伙伴不能提供源碼，且又不在項目合同中明確規(guī)定的，則需反饋項目經(jīng)理及合作伙伴必須提供源代碼如合作伙伴不能提供源碼，且又不在項目合同中明確規(guī)定的，如是不涉及到業(yè)務(wù)層面的（即與業(yè)務(wù)實現(xiàn)有依賴關(guān)系的），則需要合作伙伴提供對應(yīng)的詳細API使用文檔（含第三方應(yīng)用包）檢查注釋，檢查原則：所有的主要代碼分支判斷或者算法都要進行注釋，注釋必須清晰數(shù)據(jù)腳本檢查該項檢查提交上來的數(shù)據(jù)腳本與數(shù)據(jù)庫設(shè)計文檔中是否一致。代碼安全掃描標準所有的代碼必須進行內(nèi)部的代碼安全掃描（與運維余文進行聯(lián)系，使用fortify進行靜態(tài)代碼掃描），掃描結(jié)果中的中，高風險問題必須進行修復(fù)，對掃描出來的結(jié)果發(fā)給合作伙伴進行整改，如其整改超過3次提交的代碼還未解決，反饋項目經(jīng)理，暫停驗收。部署發(fā)布驗收該項驗收標準為合作伙伴提交上來的開發(fā)手冊/部署手冊需要在無合作伙伴的指導(dǎo)支撐下，開發(fā)及運維能夠獨立進行項目所有應(yīng)用的編譯及部署，及初始化數(shù)據(jù)庫。使得交付給測試進行功能測試驗收的環(huán)境能夠運行正常。開發(fā)手冊/部署手冊