項(xiàng)目管理體系文件概要設(shè)計(jì)說(shuō)明書(shū)編撰人：TMO審核人：批準(zhǔn)人：同意日期：-9-1保密級(jí)別：機(jī)密文檔版本：0.0.1北京中軟國(guó)際信息技術(shù)有限企業(yè)版本歷史日期版本說(shuō)明作者目錄1. 引言 11.1. 編寫(xiě)目標(biāo) 11.2. 背景 11.3. 術(shù)語(yǔ) 11.4. 參考資料 12. 總體設(shè)計(jì) 22.1. 系統(tǒng)體系結(jié)構(gòu) 22.2. 系統(tǒng)組成結(jié)構(gòu) 22.3. 運(yùn)行環(huán)境 22.3.1. 運(yùn)行環(huán)境網(wǎng)絡(luò)結(jié)構(gòu)說(shuō)明 32.3.2. 運(yùn)行環(huán)境說(shuō)明細(xì)則 42.3.3. 支持軟件 52.4. 系統(tǒng)關(guān)鍵技術(shù) 53. 構(gòu)件設(shè)計(jì) 53.1. 構(gòu)件1 53.1.1. 功效模塊1 53.1.2. 功效模塊2(示例) 53.1.3. 功效模塊n 63.2. 構(gòu)件之間關(guān)系 64. 接口設(shè)計(jì) 64.1. 外部接口 64.1.1. 接口1 64.1.2. 接口2 64.2. 內(nèi)部接口 64.2.1. 接口1 74.2.2. 接口2 85. 運(yùn)行設(shè)計(jì) 85.1. 運(yùn)行模塊組合 85.2. 運(yùn)行控制 95.3. 運(yùn)行時(shí)間 96. 系統(tǒng)犯錯(cuò)處理 96.1. 犯錯(cuò)信息 96.2. 補(bǔ)救方法 106.3. 系統(tǒng)維護(hù)設(shè)計(jì) 10引言編寫(xiě)目標(biāo){說(shuō)明編寫(xiě)這份概要設(shè)計(jì)說(shuō)明書(shū)目標(biāo)，指出預(yù)期讀者。}背景{描述系統(tǒng)產(chǎn)生背景，包含：a、 需開(kāi)發(fā)軟件系統(tǒng)名稱，和英文縮寫(xiě)（可選），項(xiàng)目編號(hào)（可選）；b、 列出此項(xiàng)目標(biāo)任務(wù)提出者、開(kāi)發(fā)者c、 軟件系統(tǒng)應(yīng)用范圍、用戶。}術(shù)語(yǔ){列出本文件中用到專門(mén)術(shù)語(yǔ)、術(shù)語(yǔ)定義、外文首字母組詞原詞組。}參考資料{本節(jié)列出用得著參考資料，如：a． 本項(xiàng)目經(jīng)核準(zhǔn)計(jì)劃任務(wù)書(shū)或協(xié)議、上級(jí)機(jī)關(guān)批文；b． 屬于本項(xiàng)目標(biāo)其余已發(fā)表文件；c． 本文件中各處引用文件、資料、包含所要用到軟件開(kāi)發(fā)標(biāo)準(zhǔn)。d． 行業(yè)標(biāo)準(zhǔn)和規(guī)范。列出這些文件資料標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位。}總體設(shè)計(jì)系統(tǒng)體系結(jié)構(gòu){編制并描述系統(tǒng)體系結(jié)構(gòu)圖，并說(shuō)明系統(tǒng)運(yùn)行原理。}示例：系統(tǒng)功效結(jié)構(gòu){用一覽表及圖形式說(shuō)明本系統(tǒng)結(jié)構(gòu)（構(gòu)件、各層模塊等）劃分。}示例：運(yùn)行環(huán)境{說(shuō)明本產(chǎn)品運(yùn)行環(huán)境（包含硬件環(huán)境和軟件環(huán)境）要求。依照不一樣類(lèi)型、不一樣規(guī)模項(xiàng)目，項(xiàng)目組能夠?qū)σ韵聝?nèi)容做增減。}硬件環(huán)境{描述本軟件運(yùn)行對(duì)服務(wù)器、客戶端硬件要求：服務(wù)器：主要描述設(shè)備名稱、設(shè)備型號(hào)、設(shè)備數(shù)量、處理器型號(hào)及內(nèi)存容量；客戶端：主要描述客戶端內(nèi)存、處理器、硬盤(pán)容量。描述本軟件運(yùn)行所使用外圍設(shè)備，主要包含：外存放設(shè)備容量、媒體及其存放格式、設(shè)備型號(hào)和數(shù)量等；輸入/輸出設(shè)備型號(hào)和數(shù)量等；數(shù)據(jù)通信設(shè)備型號(hào)和數(shù)量等；其它專用硬件。}軟件環(huán)境{描述本軟件運(yùn)行所使用計(jì)算機(jī)軟件及版本，包含：操作系統(tǒng)；數(shù)據(jù)庫(kù)系統(tǒng)；開(kāi)發(fā)平臺(tái)及工具；通信協(xié)議；其余軟件。}系統(tǒng)關(guān)鍵技術(shù){說(shuō)明系統(tǒng)中使用到關(guān)鍵技術(shù)及對(duì)關(guān)鍵技術(shù)測(cè)評(píng)結(jié)果}構(gòu)件設(shè)計(jì)構(gòu)件列表構(gòu)件列表序號(hào)構(gòu)件分類(lèi)構(gòu)件名稱依賴關(guān)系說(shuō)明復(fù)用情況{應(yīng)說(shuō)明復(fù)用是資產(chǎn)庫(kù)中哪個(gè)構(gòu)件，是完全復(fù)用還是部分復(fù)用}構(gòu)件集成說(shuō)明{應(yīng)確定以下內(nèi)容：集成次序，說(shuō)明集成時(shí)那個(gè)應(yīng)先集成，那個(gè)后集成，能夠依照構(gòu)件依賴關(guān)系確定；集成策略，采取自底向上或自頂向下集成策略等；集成就緒準(zhǔn)則，依照項(xiàng)目標(biāo)實(shí)際情況確定能夠開(kāi)始集成準(zhǔn)則；集成結(jié)束準(zhǔn)則，依照項(xiàng)目標(biāo)實(shí)際情況確認(rèn)能夠結(jié)束集成準(zhǔn)則。}構(gòu)件1{對(duì)構(gòu)件進(jìn)行簡(jiǎn)明說(shuō)明}功效模塊列表模塊列表構(gòu)件名稱模塊編號(hào)模塊名稱對(duì)應(yīng)需求功效編號(hào)所對(duì)應(yīng)需求功效實(shí)現(xiàn)優(yōu)先級(jí)營(yíng)銷(xiāo)管理DS_YXGL01訂單采集SRS_YXGL02.01訂單采集高說(shuō)明：1.模塊編號(hào)，提議采取設(shè)計(jì)英文縮寫(xiě)_模塊名稱縮寫(xiě)（能夠是漢字縮寫(xiě)也能夠是英文縮寫(xiě)）+序列號(hào)方式；比如：DS_YXGL012.假如構(gòu)件是來(lái)至復(fù)用，模塊中也需說(shuō)明模塊是否復(fù)用。功效模塊1{如該功效模塊下有子功效模塊，請(qǐng)采取層級(jí)結(jié)構(gòu)深入說(shuō)明。功效模塊描述，能夠依照項(xiàng)目實(shí)際情況做裁剪和增補(bǔ)。通常需求明確以下內(nèi)容：【模塊編號(hào)】【功效描述】功效模塊概括性描述【前置條件】假如有，請(qǐng)描述進(jìn)入此模塊必要業(yè)務(wù)或數(shù)據(jù)前提?！静僮髡摺空f(shuō)明使用此模塊相關(guān)角色?！九c本模塊相關(guān)代碼表和表】名稱漢字注釋類(lèi)型作用代碼表表√√√√【界面】詳細(xì)設(shè)計(jì)頁(yè)面。【輸入】解釋各輸入數(shù)據(jù)類(lèi)型，并逐項(xiàng)說(shuō)明其媒體、格式、數(shù)值范圍、精度等?！咎幚砹鞒碳罢f(shuō)明】流程圖：流程說(shuō)明：【算法】【輸出】解釋各輸出數(shù)據(jù)類(lèi)型，并逐項(xiàng)說(shuō)明其媒體、格式、數(shù)值范圍、精度等。對(duì)輸出中有明確要求輸出量必須進(jìn)行解釋并舉例，包含對(duì)正常結(jié)果輸出、狀態(tài)輸出及異常輸出，圖形或顯示匯報(bào)描述。}功效模塊2構(gòu)件n功效模塊列表功效模塊m接口設(shè)計(jì){需說(shuō)明接口使用者/調(diào)用者、接口目標(biāo)、內(nèi)容、數(shù)據(jù)格式、讀寫(xiě)方式、約束等。}構(gòu)件接口列表構(gòu)件名稱接口編號(hào)接口名稱接口類(lèi)型說(shuō)明構(gòu)件1內(nèi)部外部…外部接口{本系統(tǒng)與硬件之間及本系統(tǒng)與各支持軟件之間接口。}接口1接口屬性設(shè)計(jì)接口編號(hào)接口名稱接口說(shuō)明數(shù)據(jù)起源調(diào)用者輸入輸出調(diào)用方式說(shuō)明接口2內(nèi)部接口{本系統(tǒng)內(nèi)各構(gòu)件之間接口。}接口1接口屬性設(shè)計(jì)接口編號(hào)接口名稱接口說(shuō)明數(shù)據(jù)起源調(diào)用者輸入輸出處理流程接口處理流程圖配合上面“處理流程”；類(lèi)設(shè)計(jì)類(lèi)名稱分類(lèi)描述使用到其余類(lèi)屬性及方法描述使用/交互其余接口2布署設(shè)計(jì){給出系統(tǒng)布署方案、布署結(jié)構(gòu)圖，盡可能使用圖表形式，并輔以必要文字說(shuō)明。示例：對(duì)網(wǎng)絡(luò)布署結(jié)構(gòu)進(jìn)行說(shuō)明：。。。}系統(tǒng)犯錯(cuò)處理犯錯(cuò)信息{用一覽表方式說(shuō)明每種可能犯錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息形式、含意及處理方法。比如：}錯(cuò)誤分類(lèi)子項(xiàng)及其編碼錯(cuò)誤名稱錯(cuò)誤代碼備注數(shù)據(jù)庫(kù)錯(cuò)誤連接連接超時(shí)連接斷開(kāi)數(shù)據(jù)庫(kù)本身錯(cuò)誤代碼數(shù)據(jù)庫(kù)本身錯(cuò)誤代碼100002+數(shù)據(jù)庫(kù)錯(cuò)誤代碼TCP連接錯(cuò)誤連接連接超時(shí)連接斷開(kāi)其它TCP連接錯(cuò)誤(socket本身錯(cuò)誤代碼)101002+socket錯(cuò)誤代碼配置信息錯(cuò)誤未配置輸入?yún)?shù)10未配置輸出參數(shù)10補(bǔ)救方法{說(shuō)明故障出現(xiàn)后可能采取變通方法，包含：1、后備技術(shù)說(shuō)明準(zhǔn)備采取后備技術(shù)，當(dāng)原始系統(tǒng)數(shù)據(jù)萬(wàn)一丟失時(shí)啟用副本建立和開(kāi)啟技術(shù)。比如，周期性地把磁盤(pán)信息統(tǒng)計(jì)到磁帶上去就