項目概要設(shè)計說明書模板

1、XX公司 概要設(shè)計說明書模板(2014年)架構(gòu)設(shè)計說明書模板目 錄第1章簡介11.1編寫目的11.2文檔的控制11.3文檔的審批11.4項目干系人1第2章業(yè)務(wù)和需要的理解22.1業(yè)務(wù)發(fā)展方向22.2當(dāng)前組織結(jié)構(gòu)22.3當(dāng)前IT環(huán)境22.4標(biāo)準(zhǔn)約定2第3章探索方案和方法33.1項目定義33.2系統(tǒng)上下文33.3主題模型33.4功能性需求列表43.5非功能性需求列表63.6用例圖7第4章項目交付架構(gòu)84.1應(yīng)用架構(gòu)概況圖84.2架構(gòu)決策84.3架構(gòu)部件（組件）模型圖94.4系統(tǒng)運行部署圖104.5項目計劃114.6項目的例外責(zé)任114.7項目依賴124.8風(fēng)險和規(guī)避124.9問題和假設(shè)124.10

2、假設(shè)條件12第5章運營支撐標(biāo)準(zhǔn)135.1服務(wù)級別標(biāo)準(zhǔn)135.2服務(wù)資源及規(guī)范13主要業(yè)務(wù)名詞和術(shù)語定義14參考文獻15第1章 簡介1.1 編寫目的主要說明本文檔的作用。例如，提供架構(gòu)決策和具體設(shè)計依據(jù)，為把增加的服務(wù)或功能引入生產(chǎn)環(huán)境提供指導(dǎo)。如果此文檔作為項目驗收的依據(jù)或有其他特別作用，應(yīng)特別注明。1.2 文檔的控制以列表的形式，列出文檔的版本信息、變更歷史、變更內(nèi)容和具體作者。日期版本信息作者變更歷史2014/03/24V 0.1劉通新建1.3 文檔的審批以列表的形式，列出所有的文檔的審閱人（Reviewer）、審批人（Approver）和他們的職務(wù)。此文檔已經(jīng)被如下人員審批：姓名職務(wù)XX

3、XXXXXXXXXXXXXXXXXXXXXX1.4 項目干系人以列表的形式，列出所有直接參與或受項目實施后期運營影響的干系人及其組織和職務(wù)，包括客戶技術(shù)聯(lián)系人、業(yè)務(wù)聯(lián)系人和第三方公司的代表等。姓名所在組織 職務(wù)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX第2章 業(yè)務(wù)和需要的理解主要說明對業(yè)務(wù)需求的理解、項目背景和企業(yè)規(guī)范信息的介紹。此模板以電子商務(wù)項目為例進行介紹。2.1 業(yè)務(wù)發(fā)展方向發(fā)展電子商務(wù)網(wǎng)絡(luò)零售，實施“科技轉(zhuǎn)型、智慧電商”戰(zhàn)略。網(wǎng)絡(luò)零售將成為與實體店面并駕齊驅(qū)、相互協(xié)同的渠道。銷售的品類包括家電零售、快速消費品、百貨產(chǎn)品、家居產(chǎn)品、娛樂產(chǎn)品和圖書等。利用網(wǎng)

4、絡(luò)和云計算平臺便捷的優(yōu)勢，提供一站式的購物體驗。結(jié)合電視、電話等購物、咨詢平臺，實現(xiàn)技術(shù)創(chuàng)新、數(shù)據(jù)研究、倉儲配送能力位居世界前列，滿足上億人的在線物質(zhì)和精神的生活需求。2.2 當(dāng)前組織結(jié)構(gòu)組織包括總經(jīng)理辦公室、采購管理中心、市場管理中心、信息技術(shù)管理中心、金融產(chǎn)品中心、物流產(chǎn)品中心、財務(wù)管理中心和人力資源管理中心等。2.3 當(dāng)前IT環(huán)境商品倉儲管理庫存系統(tǒng)、訂單系統(tǒng)、促銷系統(tǒng)、支付系統(tǒng)、BI系統(tǒng)和價格系統(tǒng)等。這些系統(tǒng)之間是通過Web Service方式實現(xiàn)彼此之間的接口調(diào)用的。2.4 標(biāo)準(zhǔn)約定當(dāng)前的標(biāo)準(zhǔn)預(yù)定文檔包括需求規(guī)格說明書模板、架構(gòu)設(shè)計說明書模板、程序編碼規(guī)范、系統(tǒng)集成原則和規(guī)范、系統(tǒng)測

5、試用例模板和測試報告模板等。第3章 探索方案和方法3.1 項目定義設(shè)計并實現(xiàn)基于多供應(yīng)商的電子商務(wù)系統(tǒng)解決方案，支持類似于淘寶網(wǎng)店對各店鋪自行管理商品、價格、庫存，自行發(fā)起促銷活動。確保顧客在網(wǎng)上的商品瀏覽、咨詢、購物、支付、退換貨過程中有良好的購買體驗。建立網(wǎng)上銷售系統(tǒng)，為合作伙伴提供商品銷售平臺。分析并解決建立網(wǎng)店所涉及的商品、店鋪、價格、庫存、訂單和促銷等多個功能模塊的技術(shù)問題。3.2 系統(tǒng)上下文 圖 3-1 電子商務(wù)系統(tǒng)上下文圖3.3 主題模型主題模型是指系統(tǒng)中所涉及的表單實體，也就是我們通常所說的Entity。該系統(tǒng)主要所涉及的Entity包括：表 3-1 Entity表單實體信息表

6、店鋪商品庫存訂單會員支付店鋪編碼商品編碼倉庫信息訂單信息基本信息支付帳號店鋪名稱商品目錄庫位信息店鋪編碼社交關(guān)系用戶信息供應(yīng)商編碼商品狀態(tài)商品編碼銷售渠道配送方式證件信息供應(yīng)商名稱內(nèi)容信息供應(yīng)商編碼收貨方聯(lián)系地址郵箱信息店鋪服務(wù)區(qū)域關(guān)聯(lián)的店鋪商品入庫批次收貨地址支付帳號手機綁定店鋪售后服務(wù)促銷買點可賣庫存訂單發(fā)票信息優(yōu)惠卷帳號安全保護問題店鋪信用等級售后服務(wù)鎖定庫存商品編碼積分帳戶會員等級信息登錄密碼庫存更新流水支付流水3.4 功能性需求列表序號功能性需求名稱功能需求描述備注說明FR001店鋪展示提供標(biāo)準(zhǔn)店鋪和裝修店鋪兩種模式。標(biāo)準(zhǔn)店鋪展示新品、熱銷、推薦商品，以及店鋪名稱、介紹、信用、促銷活

7、動信息。裝修店鋪由商家自行排版需要排版的定制開發(fā)FR002商品瀏覽商品瀏覽及搜索頁面應(yīng)顯示最低價格的商品；商品明細頁應(yīng)給出銷售此商品的其他商家列表，列表中包括價格和配送費用信息；客戶可以由單個商品切換到此商品的所有商家列表，查看在售商家商品價格、庫存、促銷、時效，商家服務(wù)信息，商家信用信息，允許顧客自主排序和篩選。需要商家信息排序規(guī)則的自由化定制FR003商品評價、咨詢和投訴客戶可以在商品頁面向商家提出咨詢問題；已購買商品的客戶可以對購買商品的體驗進行評分，評分的范圍包括商品與描述是否相符、送貨速度、賣家服務(wù)態(tài)度、配送服務(wù)態(tài)度、安裝服務(wù)態(tài)度和商品包裝等；客戶還可以發(fā)起投訴，專業(yè)客服介入投訴過程

8、，督促商家進行投訴的有效處理和回復(fù)。需要流程的定制開發(fā)FR004商品價格商家可自行配置商品的銷售價、促銷價和生效/失效時間。FR005購物車需要在購物車中按照店鋪對商品進行分組展示，展示的內(nèi)容包括各商家的運費、促銷價格和配送方式等。FR006訂單支付到貨確認環(huán)后，商家在客戶確認后才收到貨款。后臺需在客戶確認后觸發(fā)分帳過程FR007客服服務(wù)客服人員應(yīng)可以查詢店鋪信息和訂單狀態(tài)，處理店鋪投訴和退換貨請求。注釋：FR，是Functional Requirement的縮寫，表示功能性需求。3.5 非功能性需求列表序號需求名稱需求詳細NFR001安全性網(wǎng)絡(luò)的不同區(qū)域之間必須使用防火墻進行隔離；從網(wǎng)絡(luò)、操

9、作系統(tǒng)和應(yīng)用軟件層面實現(xiàn)用戶認證管理；阻止SQL注入、跨站腳本攻擊等常見的網(wǎng)站攻擊行為；通過專業(yè)安全軟件如APPSCAN的白盒和黑盒測試；保存應(yīng)用核心操作如登錄、取消訂單的審計日志。NFR002易用性應(yīng)保證前臺用戶和業(yè)務(wù)用戶的操作簡單，界面易學(xué)習(xí)。NFR003高可靠性要保證訂單和支付等數(shù)據(jù)準(zhǔn)確無誤的被轉(zhuǎn)換和保存；在和其它系統(tǒng)交互時，要保證數(shù)據(jù)不丟失、不重復(fù)、完整無誤的進行交換。NFR004響應(yīng)時間商品瀏覽等基礎(chǔ)頁面的響應(yīng)時間不超過1秒；訂單操作等非瀏覽類頁面的響應(yīng)時間不超過3秒。NFR005業(yè)務(wù)容量系統(tǒng)應(yīng)當(dāng)可以支持用戶每小時訪問1億頁面；同時可以支持10萬條訂單的創(chuàng)建。NFR006高可用性系統(tǒng)

10、的網(wǎng)絡(luò)架構(gòu)、中間件服務(wù)器、數(shù)據(jù)庫服務(wù)器和存儲設(shè)備都應(yīng)當(dāng)實現(xiàn)高可用性方案，消除單點故障。NFR007可擴展性通過簡單的增加物理或虛擬處理節(jié)點賴支持更高的業(yè)務(wù)容量要求，類似Google的Hadoop架構(gòu)。NFR008數(shù)據(jù)存儲量預(yù)分配5TB存儲空間支持未來3年的數(shù)據(jù)存儲需求NFR009在線用戶數(shù)500萬NFR010并發(fā)用戶數(shù)25萬NFR011數(shù)據(jù)庫備份數(shù)據(jù)庫每日必須執(zhí)行一次全備；由于數(shù)據(jù)庫備份時對網(wǎng)站的性能影響較大，必須在凌晨1時以后執(zhí)行，3小時之內(nèi)完成備份。注釋：NFR，是Non-Functional Requirement的縮寫，表示非功能性需求。3.6 用例圖圖 3-2 電子商務(wù)系統(tǒng)用例圖第4

11、章 項目交付架構(gòu)4.1 應(yīng)用架構(gòu)概況圖圖 4-1 電子商務(wù)系統(tǒng)應(yīng)用架構(gòu)概況圖4.2 架構(gòu)決策決策主題商品價格信息獲取方式編號：AD01 問題描述與電子商務(wù)系統(tǒng)有接口的價格系統(tǒng)尚不具備完整的價格緩存管理，價格圖片生成等高級功能，只有價格查詢功能。電子商務(wù)系統(tǒng)的商品價格可以采取調(diào)用價格系統(tǒng)API接口的方式實時查詢并獲得商品的價格信息，也可以采取由價格系統(tǒng)批量推送的方式。前提與假設(shè)價格系統(tǒng)的價格管理功能按時開發(fā)完成；價格系統(tǒng)無法在電子商務(wù)系統(tǒng)上線時間節(jié)點前完成緩存、圖片功能；年商品銷售額達到1000萬以上。決策考慮因素最小化系統(tǒng)總體壓力和確保價格顯示的準(zhǔn)確性。可選方案方案1：電子商務(wù)系統(tǒng)實時查詢商品

12、價格，不在電子商務(wù)系統(tǒng)本地保存價格數(shù)據(jù)。價格的緩存更新、圖片生成由價格系統(tǒng)觸發(fā)推送到電子商務(wù)系統(tǒng)的價格緩存和價格圖片服務(wù)器；方案2：價格系統(tǒng)批量推送價格，電子商務(wù)系統(tǒng)本地保存價格數(shù)據(jù)，價格的緩存更新、圖片生成由電子商務(wù)系統(tǒng)獲得更新的價格數(shù)據(jù)后批量執(zhí)行。決策分析方案1：系統(tǒng)為準(zhǔn)。系統(tǒng)的壓力較大。尤其大促銷時段，可能造成緩存頻繁更新，系統(tǒng)總體壓力上升。方案2：電子商務(wù)系統(tǒng)本地也有價格數(shù)據(jù)，不需要實時查詢價格系統(tǒng)，系統(tǒng)總體壓力較小。系統(tǒng)批量推送數(shù)據(jù)給電子商務(wù)系統(tǒng)，商品供應(yīng)商更新的價格不能實時立即生效。選擇方案結(jié)論：與客戶一致認為確保電子商務(wù)系統(tǒng)的總體壓力較低更為重要，尤其大促銷時性能壓力大，應(yīng)采取較

13、為安全穩(wěn)妥的方案，所以選擇方案2。對于商品供應(yīng)商的價格更新不能實時生效的問題，可以通過與供應(yīng)商溝通，要求供應(yīng)商提前輸入價格數(shù)據(jù)的方式解決。4.3 架構(gòu)部件（組件）模型圖這里主要對組件模型圖的一種表現(xiàn)形式-時序圖進行舉例。圖 4-2 顧客收貨和退貨時序圖4.4 系統(tǒng)運行部署圖系統(tǒng)運行部署圖所涉及的軟硬件列表如下：需求內(nèi)容單位軟件產(chǎn)品名稱產(chǎn)品描述基礎(chǔ)應(yīng)用平臺1套DB2IBM 數(shù)據(jù)庫產(chǎn)品4套HTTP ServerIBM Web服務(wù)器產(chǎn)品2套WebsphereIBM Websphere Application中間件產(chǎn)品企業(yè)服務(wù)總線1套WebSphere Message BrokerIBM支持ESB的企

14、業(yè)服務(wù)總線產(chǎn)品電子商務(wù)系統(tǒng)1套WebSphere CommerceIBM電子商務(wù)產(chǎn)品緩存數(shù)據(jù)存取1套IBM WebSphere eXtreme SclaeIBM高速數(shù)據(jù)緩存服務(wù)產(chǎn)品訪問負載均衡2套F5F5負載均衡設(shè)備安全接入和管控1套WebSealIBM單點登錄SSO服務(wù)的認證網(wǎng)關(guān)產(chǎn)品1套TAMIBM Tivoli Access Manager統(tǒng)一接入認證產(chǎn)品1套頁面防護軟件提供網(wǎng)頁防篡改服務(wù)的產(chǎn)品1套IPS提供入侵防護的網(wǎng)絡(luò)產(chǎn)品4.5 項目驗收條件列出項目的具體驗收條件和標(biāo)準(zhǔn)4.6 項目計劃列出項目的工作分解結(jié)構(gòu)和時限性要求。4.7 項目例外責(zé)任列出不包括在項目實施范圍內(nèi)的應(yīng)用和IT基礎(chǔ)設(shè)施交付的內(nèi)容。4.8 項目依賴列出項目可能有的依賴條件，例如此項目的交付依于一些待開發(fā)的軟件產(chǎn)品或服務(wù)等。4.9 風(fēng)險和規(guī)避以列表的形式，列出項目可能的風(fēng)險和規(guī)避方案，這里的風(fēng)險包括業(yè)務(wù)資源短缺所帶來的風(fēng)險和技術(shù)使用的風(fēng)險。4.10 問題以列表的形式，列出項目當(dāng)前的問題、問題的優(yōu)先級和可能的解決方案等。4.11 約束和假設(shè)條件列出項目的強制合同約束，以及可能的假設(shè)前提條件。第5章 運營支撐標(biāo)準(zhǔn)5.1 服務(wù)級別標(biāo)準(zhǔn)列出項目所交付的系統(tǒng)在系統(tǒng)上線后需要遵守的服務(wù)標(biāo)準(zhǔn)，也就是我們通常所