XXX產(chǎn)品總體設(shè)計說明書作者：版本號：時間：版權(quán)所有：用友軟件股份有限公司UFIDACorp.Ltd.

目錄TOC\o"1-3"1. 變更說明 42. 引言 42.1. 編寫目的 42.2. 背景 42.3. 定義 42.4. 參考資料 53. 設(shè)計原則 54. 總體結(jié)構(gòu)設(shè)計 54.1. 需求規(guī)定 54.1.1. 業(yè)務(wù)角色 54.1.2. 業(yè)務(wù)場景 64.1.3. 業(yè)務(wù)流程 74.2. 總體解決方案 74.3. 總體結(jié)構(gòu) 84.3.1. 業(yè)務(wù)場景實現(xiàn) 94.3.2. 模塊1設(shè)計 104.3.3. 模塊2設(shè)計 114.4. 組件部署 114.5. 開發(fā)環(huán)境 114.6. 運行環(huán)境 124.7. 網(wǎng)絡(luò)安全及軟件保護 125. 總體功能設(shè)計 125.1. 功能設(shè)計 125.1.1. 功能清單 125.1.2. 業(yè)務(wù)組件清單[可選] 125.2. 數(shù)據(jù)結(jié)構(gòu)概要設(shè)計 125.2.1. ER圖 125.3. 外部接口詳細設(shè)計確認 136. 公共平臺設(shè)計 136.1. 基類設(shè)計 136.2. 公共組件設(shè)計 146.3. 平臺設(shè)計 147. 容錯處理 147.1. 出錯信息 147.2. 系統(tǒng)維護設(shè)計 158. 安裝 159. 測試部分 159.1. 測試指南 159.2. 集成策略 159.3. 特殊考慮 1510. 擴展策略 1511. 其他非功能特性 1512. 設(shè)計路標(biāo) 1513. 附錄 16

變更說明序號變更位置變更內(nèi)容說明變更人變更日期改進功能HYPERLINK刪掉：執(zhí)行入庫操作時，檢查人才庫中是否有這些人員的簡歷，如果有提示是否刪除人才庫中的簡歷。2005-07-06新增功能HYPERLINK合并報表升級注意事項增加第8條2005-07-0857.3零售管理系統(tǒng)環(huán)境要求HYPERLINK新增零售管理系統(tǒng)環(huán)境要求2005-07-1168.2零售管理系統(tǒng)安裝說明HYPERLINK新增零售管理系統(tǒng)安裝說明2005-07-1174.10.3注意事項HYPERLINK新增零售管理注意事項2005-07-1改進功能HYPERLINK補充OA相關(guān)功能模塊分類調(diào)整2005-07-12引言編寫目的[說明編寫這份總體設(shè)計說明書的目的,指出預(yù)期的讀者。本文檔指導(dǎo)詳細設(shè)計的內(nèi)容。]背景[說明：a.待開發(fā)軟件系統(tǒng)的名稱；b.列出此項目的任務(wù)提出者、開發(fā)者、用戶。]定義[列出本文件用到的專門術(shù)語的定義和外文首字母組詞的原詞組。]參考資料[列出有關(guān)的參考文件,如：a.本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同,上級機關(guān)的批文；b.屬于本項目的其他已發(fā)表文件；c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。]設(shè)計原則[可選][對于設(shè)計的原則性規(guī)范，包括對詳細設(shè)計的指導(dǎo)和規(guī)范。因為總有些東西在后面的設(shè)計中沒有辦法描述得面面俱到。有了基本的原則，可以在發(fā)生爭議時，人員變動時成為決策的依據(jù)。盡量貼近本產(chǎn)品的設(shè)計，如果確實沒有，可以忽略。下面是舉例。]界面與數(shù)據(jù)的分離，通過對象模型，將界面與數(shù)據(jù)分離，同時將界面之間的耦合度也降低以實現(xiàn)界面的復(fù)用。業(yè)務(wù)與技術(shù)分離：將軟件的業(yè)務(wù)資源和技術(shù)分離開來，使得軟件對于業(yè)務(wù)的擴展是開放的，同時對于技術(shù)的遷移也是開放的。業(yè)務(wù)可以給予不同的技術(shù)實現(xiàn)，同樣的技術(shù)可以實現(xiàn)其他業(yè)務(wù)。所有的復(fù)雜的業(yè)務(wù)邏輯應(yīng)該進行完整地分析，設(shè)計和實現(xiàn)形成一個個具有通用性和代表性的單元，同時對需求進行某些范圍內(nèi)的估計，在設(shè)計時留有一些余地。因為一個簡單需求的變化很可能導(dǎo)致整個設(shè)計結(jié)構(gòu)的崩潰，所以必須加以控制。OCP原則總體結(jié)構(gòu)設(shè)計需求規(guī)定業(yè)務(wù)角色[按照下表去描述系統(tǒng)涉及到的所有角色，描述它們的重要性，它們的特點，可以根據(jù)需要，建立自己的表格。]UserRoleCodeUserRoleNameRoleCategoryRoleImportanceRoleDescriptionQuestionUR1客戶執(zhí)行層ExternalB客戶的業(yè)務(wù)部門關(guān)心部門級的決策信息，甚至一些實時和明細的信息這幾天是多少怎么樣?UR1-1客戶財務(wù)執(zhí)行層——包括財務(wù)部門、會計部門財務(wù)是多少，怎么樣UR1-2客戶營銷執(zhí)行層——企業(yè)內(nèi)部供應(yīng)鏈上的相關(guān)部門營銷是多少，怎么樣?UR1-3客戶人力資源執(zhí)行層——企業(yè)人力資源相關(guān)部門人力怎么樣，是多少？UR2客戶決策層ExternalA客戶企業(yè)領(lǐng)導(dǎo)人對企業(yè)級信息的需求跨越了多個部門，大粒度的信息。新增加了對企業(yè)管理知識的需求，從傳統(tǒng)的經(jīng)驗知識型向理智科學(xué)型轉(zhuǎn)變最近有異常嗎？怎么解決？UR2-1客戶決策者——決策者實際上并不直接接觸系統(tǒng)，而是依賴于UR2-2、UR2-3和UR2-4整理的信息。異常情況怎么解決？表1角色分類業(yè)務(wù)場景ScenarioIDUS1ScenarioRoles(UR2-3),包括了UR1的角色Name用戶設(shè)計預(yù)算編制流程ImportanceAPreScenarios無Description某用戶指定預(yù)算編制包括戰(zhàn)略規(guī)劃、體系編制、體系下發(fā)、預(yù)算編制、數(shù)據(jù)校驗、各級審核、匯總上報、上級審批（調(diào)整）、最終發(fā)布等過程。FeatureScenarioIDScenarioRolesNameImportancePreScenarios無DescriptionFeature表2業(yè)務(wù)場景表業(yè)務(wù)流程[可選][對流程性強的產(chǎn)品，不僅要列出應(yīng)用場景清單，而且需要明確關(guān)鍵業(yè)務(wù)流程。業(yè)務(wù)流程需要劃分階段的，在圖的左側(cè)劃分。如圖：]圖1XX業(yè)務(wù)關(guān)系圖總體解決方案[可選][網(wǎng)絡(luò)拓撲圖（Topology）。網(wǎng)絡(luò)拓撲圖的主要目的是讓讀者明白系統(tǒng)的網(wǎng)絡(luò)概況。了解產(chǎn)品是C/S還是B/S應(yīng)用。對于多級集團企業(yè)，如何支持總部與分子公司和辦事處的網(wǎng)絡(luò)通信。對于單一企業(yè)，明確其內(nèi)部網(wǎng)絡(luò)環(huán)境的劃分和外部網(wǎng)絡(luò)環(huán)境的劃分，以及它們之間的聯(lián)系。]圖2網(wǎng)絡(luò)拓撲圖[根據(jù)產(chǎn)品策略提出產(chǎn)品總體解決方案，并對方案進行必要說明，對于重大問題要詳細說明解決方案。對總體解決方案中用到的核心技術(shù)逐一介紹。核心技術(shù)包括自己開發(fā)的核心技術(shù)和必須使用的第三方的核心技術(shù),要求詳細設(shè)計師和開發(fā)人員必須使用。比如MSMQ，ADO.NET，。對于常見的數(shù)據(jù)庫平臺等可以不作說明。]總體結(jié)構(gòu)[使用結(jié)構(gòu)圖。使用結(jié)構(gòu)圖重點要標(biāo)出系統(tǒng)實現(xiàn)方面有哪些模塊組成，這些模塊之間的接口協(xié)議是什么，以及接口傳輸?shù)膬?nèi)容語義。最好能夠在圖上標(biāo)出模塊清單中的模塊標(biāo)號和接口清單中的接口標(biāo)號。]圖3使用結(jié)構(gòu)圖[列出本產(chǎn)品的子產(chǎn)品（模塊），可以用圖/表方式，并對這些模塊命名，這些命名是目錄/包、數(shù)據(jù)庫等命名的基礎(chǔ).模塊的含義是指：根據(jù)系統(tǒng)運作的設(shè)想而劃分的具有明確職責(zé)的單元，他不根據(jù)用戶領(lǐng)域問題的具體流程去劃分，但是能夠解決用戶的領(lǐng)域問題。]模塊編號模塊名稱模塊依賴外部接口編號模塊對外接口編號模塊職責(zé)請給出清晰的定義模塊編號模塊名稱模塊依賴外部接口編號模塊對外接口編號模塊職責(zé)請給出清晰的定義表3模塊表接口編號接口名稱模塊1編號模塊2編號接口內(nèi)容語義請給出清晰的定義，該模塊的詳細設(shè)計師能夠按照此描述了解該接口的大致情況，可以構(gòu)思實現(xiàn)方案。批量/單條通信協(xié)議/技術(shù)性能要求1000行/秒備注表4接口表業(yè)務(wù)場景實現(xiàn)[針對每一個應(yīng)用場景，用SequenceDiagram的形式畫出實現(xiàn)方案，圖中有前面歸納的角色出現(xiàn)，如果某個場景不需要畫，請說明原因。模塊之間的協(xié)作圖(不是類！)]圖4圖5模塊1設(shè)計[分模塊介紹主要功能以及解決用戶的主要問題。該模塊內(nèi)部的實現(xiàn)機制可以進行描寫，但是需要你根據(jù)情況判斷最核心的部分是那些，盡量少把詳細設(shè)計的內(nèi)容放在這里。][可選][功能明細清單：核心工作原理/理論/技術(shù)：內(nèi)部模塊清單：數(shù)據(jù)訪問層：應(yīng)用層（規(guī)則層）：表示層：分析模型示意圖：]模塊2設(shè)計[分模塊介紹主要功能以及解決用戶的主要問題。該模塊內(nèi)部的實現(xiàn)機制可以進行描寫，但是需要你根據(jù)情況判斷最核心的部分是那些，盡量少把詳細設(shè)計的內(nèi)容放在這里。[可選]功能明細清單：核心工作原理/理論/技術(shù)：內(nèi)部模塊清單：數(shù)據(jù)訪問層：應(yīng)用層（規(guī)則層）：表示層：分析模型示意圖：模塊運行組合方案及模塊組合控制關(guān)系，如啟用、期初、結(jié)帳等]組件部署[UML的DeploymentView。描述部署節(jié)點、部署單元（組件）的分布關(guān)系。標(biāo)注出組件之間的關(guān)系和通信。]圖6部署圖開發(fā)環(huán)境[介紹開發(fā)語言和工具（包括版本）及相關(guān)規(guī)范分析、設(shè)計方法和工具及相應(yīng)規(guī)范開發(fā)和測試環(huán)境，如數(shù)據(jù)及版本、操作系統(tǒng)及版本]運行環(huán)境[簡要地說明本系統(tǒng)的運行環(huán)境支持（包括硬件環(huán)境和支持環(huán)境）的規(guī)定如硬件操作系統(tǒng)及版本數(shù)據(jù)庫及版本網(wǎng)絡(luò)]網(wǎng)絡(luò)安全及軟件保護[介紹本系統(tǒng)的網(wǎng)絡(luò)安全方案和軟件保護解決方案（由于保密要求，這里只介紹解決方案）]總體功能設(shè)計[總體功能設(shè)計是從用戶能夠使用的功能的角度描述產(chǎn)品功能設(shè)計功能清單[列出菜單結(jié)構(gòu)。]業(yè)務(wù)組件清單[可選][列出業(yè)務(wù)組件的文件結(jié)構(gòu)設(shè)計。包括關(guān)鍵組件的文件，配置文件，其它信息。]數(shù)據(jù)結(jié)構(gòu)概要設(shè)計[分組件描述實體間關(guān)聯(lián)關(guān)系，包括基本檔案和業(yè)務(wù)數(shù)據(jù)]ER圖[分組件列出業(yè)務(wù)組件清單]外部接口詳細設(shè)計確認[設(shè)計本組件與其他組件的接口關(guān)系，以及本組件與平臺接口關(guān)系，需要明細到具體調(diào)用接口，各組可以將本組對外提供的服務(wù)設(shè)計為統(tǒng)一接口類對外提供的接口]序號功能說明提供的服務(wù)語義表5對外服務(wù)接口表外部提供的接口組件名功能說明提供的服務(wù)平臺明晰產(chǎn)品組語義表6外部服務(wù)接口表公共平臺設(shè)計[列出本系統(tǒng)公共平臺的層次結(jié)構(gòu)]基類設(shè)計[列出本系統(tǒng)提供的所有基類（對于由VisualBasic開發(fā)工具的代碼，每個Class都為基類），并逐個描述他的功能及使用說明，對復(fù)雜基類的設(shè)計見UML分析設(shè)計模型]圖7基類設(shè)計公共組件設(shè)計[列出本系統(tǒng)提供的所有公共組件，并逐個描述他的功能及使用說明，對復(fù)雜公共組件的設(shè)計見UML分析設(shè)計模型，涉及的數(shù)據(jù)庫設(shè)計見系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計]平臺設(shè)計[列出本系統(tǒng)提供的所有組件，并逐個描述他的功能及使用說明，每個平臺的詳細設(shè)計見ROSE分析設(shè)計模型，涉及的數(shù)據(jù)庫設(shè)計見系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計]容錯處理出錯信息[用一覽表的方式說明每種可能的出錯或故障情況出現(xiàn)時,系統(tǒng)輸出信息的形式、含義及處理方法。]系統(tǒng)維護設(shè)