系統(tǒng)設(shè)計說明書湖南大唐先一科技有限公司 -（項目名稱）系統(tǒng)設(shè)計說明書章節(jié)說明件控制檔編號版本號分冊名稱第冊/共冊總頁數(shù)正文附錄編制審批生效日期湖南大唐先一科技有限公司修改變更記錄：更改條款及內(nèi)容更改人審批人更改日期目錄TOC\o"1-3"\h\z1 引言 31.1 文檔編制目的 31.2 背景 41.3 詞匯表 41.4 參考資料 42 總體設(shè)計 42.1 軟件體系結(jié)構(gòu) 42.2 系統(tǒng)運行體系 42.2.1 運行體系圖 42.2.2 程序/模塊對應(yīng)表 52.3 系統(tǒng)物理結(jié)構(gòu) 52.4 技術(shù)路線 53 系統(tǒng)接口設(shè)計 53.1 用戶接口 53.2 外部系統(tǒng)接口 63.3 模塊間接口 64 子系統(tǒng)/模塊設(shè)計 64.1 子系統(tǒng)/模塊1（編號/名稱） 74.1.1 功能 74.1.2 性能 74.1.3 模塊結(jié)構(gòu) 74.1.4 子模塊接口設(shè)計 74.2 子系統(tǒng)/模塊2（編號/名稱） 75 數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)庫設(shè)計 75.1 面向?qū)ο髷?shù)據(jù)的數(shù)據(jù)結(jié)構(gòu) 85.2 面向?qū)ο髷?shù)據(jù)庫設(shè)計 85.3 數(shù)據(jù)安全性 85.4 對象數(shù)據(jù)/模塊對應(yīng)表 86 外部存儲結(jié)構(gòu)設(shè)計 87 故障處理說明 98 尚需解決的問題 9編寫指南：本模板力圖給出系統(tǒng)設(shè)計階段可能包括的基本信息，重點在于和需求分析文檔相聯(lián)系。描述系統(tǒng)整體情況。如果某個章節(jié)在項目或當(dāng)前階段中無法描述，則可保留其標(biāo)題，注明“不適用”；如果需要對本模板的個別章節(jié)詳細(xì)描述，也可將其形成單獨的文檔，成為本文檔附件。若文檔中的某個章節(jié)已經(jīng)在其他項目文檔中加以描述，可保留標(biāo)題，注明“參見（文檔編號）（文檔名稱）（條款）”。形成正式文檔后須刪除斜體字內(nèi)容。0 報告編制要求這里列出本系統(tǒng)設(shè)計報告編制的經(jīng)驗性要求，須由系統(tǒng)設(shè)計人員參照其進(jìn)行裁剪以確定本次報告編制的相關(guān)規(guī)定。序號要求1對各種結(jié)構(gòu)圖要求采用Visio繪制。2軟件體系結(jié)構(gòu)圖通常包括：子系統(tǒng)實體、子系統(tǒng)間數(shù)據(jù)流、相關(guān)說明。3軟件結(jié)構(gòu)圖通常包括：模塊實體、模塊間數(shù)據(jù)流、數(shù)據(jù)存儲、相關(guān)說明。4運行體系圖包括：進(jìn)程實體、啟動順序、并發(fā)性、數(shù)據(jù)交換。5物理結(jié)構(gòu)圖包括：物理節(jié)點實體、物理節(jié)點分布、物理節(jié)點描述、物理節(jié)點間相互關(guān)系。6對數(shù)據(jù)庫結(jié)構(gòu)的描述要求采用結(jié)構(gòu)圖方式描述，而非采用過多表格。7數(shù)據(jù)庫結(jié)構(gòu)圖主要包括：表實體、表間關(guān)系、主要字段、相關(guān)說明四部分。8對于平臺性產(chǎn)品，要求有系統(tǒng)層次的劃分圖。9通常要隔離應(yīng)用對數(shù)據(jù)庫的直接訪問。引言文檔編制目的說明編寫這份報告的目的，指出預(yù)期的讀者。背景敘述系統(tǒng)設(shè)計階段的目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的理解本報告所需的背景，如與公司其它軟件之間的聯(lián)系等。詞匯表列出本系統(tǒng)設(shè)計說明書中專門術(shù)語的定義、英文縮寫詞的原詞組和意義、項目組內(nèi)達(dá)成一致意見的專用詞匯，同時要求繼承全部的先前過程中定義過的詞匯。詞匯名稱詞匯含義備注備注中注明該詞匯的來源，或有其他更詳細(xì)的解釋的文檔位置；以及對該詞匯的其他叫法。參考資料列出編寫本報告時參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號、出版日期和出版單位。列出編寫本報告時查閱的Internet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及其網(wǎng)址?？傮w設(shè)計軟件體系結(jié)構(gòu)以圖表形式（軟件體系結(jié)構(gòu)圖及軟件結(jié)構(gòu)圖）給出軟件子系統(tǒng)結(jié)構(gòu)和模塊組成結(jié)構(gòu)。如果對某子系統(tǒng)單獨編制《系統(tǒng)設(shè)計報告》，則在此處不必列出其內(nèi)部自用模塊。為滿足確定的設(shè)計單元的可跟蹤性和可維護(hù)性，需采用唯一性標(biāo)識確定每個子系統(tǒng)與模塊。對設(shè)計單元的標(biāo)識可以采用序列號、層次編碼或自定義其他的方法。系統(tǒng)運行體系運行體系圖主要考慮以下幾個問題：1） 系統(tǒng)有多少個程序要運行；2） 每個程序的生命周期（什么時候開始，什么時候結(jié)束）；3） 系統(tǒng)有哪些地方需要并發(fā)，采用什么方式，如果是多線程/進(jìn)程的方式，那些進(jìn)程/線程間通訊問題、生命周期問題怎么解決。這些問題盡量用圖表方式描述，有必要的話采用多個圖表方式。程序/模塊對應(yīng)表以列表形式描述子系統(tǒng)/模塊與運行程序間的對應(yīng)關(guān)系。描述方式同“系統(tǒng)特性/模塊對應(yīng)表”。程序1程序2……程序n模塊1RR模塊2RR……R模塊mRR“R”（Relate）表示模塊m和完成系統(tǒng)特性n有關(guān)。從上圖可見程序2與三個模塊1、2、n相關(guān)。系統(tǒng)物理結(jié)構(gòu)描述使用本軟件系統(tǒng)典型用戶的物理設(shè)備分布圖及設(shè)備上相應(yīng)基本軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫、以及其它支撐軟件；硬件環(huán)境包括：主機(jī)類型、網(wǎng)絡(luò)類型、存儲器容量、其它特殊設(shè)備。要求：1） 盡量為系統(tǒng)的每個物理節(jié)點定義一個和功能相關(guān)的名稱，名稱的含義在詞匯表中說明；2） 結(jié)合運行體系圖中提到的“程序”，將相關(guān)的“運行程序”分布到各個物理節(jié)點中；3） 采用網(wǎng)絡(luò)拓?fù)鋱D表示。技術(shù)路線描述本軟件系統(tǒng)在實現(xiàn)過程中所采用的技術(shù)路線、方法。對較新的技術(shù)給予詳細(xì)的闡述及必要的說明，在可能的情況下給出相應(yīng)的技術(shù)參考資料。系統(tǒng)接口設(shè)計用戶接口描述該軟件與用戶的接口，包括用戶輸入輸出界面樣式、操作方式和界面間的轉(zhuǎn)移關(guān)系。如具有等同作用的文件（如使用開發(fā)工具編寫的界面原型程序等），本處僅需列出該文件名、保管部門即可。要求：1） 列舉實現(xiàn)某用戶接口對應(yīng)的程序名稱；2） 用戶接口描述采用對話圖或者界面原型程序表示；3） 需要對逐個程序進(jìn)行說明。外部系統(tǒng)接口描述該軟件與其它系統(tǒng)的接口，主要說明1） 系統(tǒng)所使用的外部系統(tǒng)提供的編程接口；2） 本系統(tǒng)向其它系統(tǒng)提供的編程接口。如具有等同作用的文件（如包含接口說明及注釋的源文件程序頭文件、接口幫助的超文本文件等），本處僅需列出該文件名、保管部門即可；3） 本系統(tǒng)和外部系統(tǒng)相關(guān)的硬件接口、通信協(xié)議及規(guī)程、數(shù)據(jù)交換格式等。要求：1） 對所有相關(guān)的外部系統(tǒng)逐個描述；2） 對接口詳細(xì)描述。模塊間接口描述各相關(guān)模塊間的接口，主要說明：1） 某接口的目的以及實現(xiàn)的基本任務(wù)；2） 列出與該接口相關(guān)的模塊名稱及編號；3） 描述在相關(guān)各模塊中的使用(調(diào)用)方式；4） 逐個說明和接口相關(guān)的類和數(shù)據(jù)格式。只要模塊間有存在關(guān)系，就必須逐個的按照上述要求描述。如果建立了軟件體系結(jié)構(gòu)圖，要求圖中所有模塊間有連線的都必須全部說明，沒連線的事實存在的也應(yīng)進(jìn)行說明。子系統(tǒng)/模塊設(shè)計對軟件體系結(jié)構(gòu)中描述的子系統(tǒng)與模塊的設(shè)計情況分別進(jìn)行說明，如有必要可對某子系統(tǒng)或模塊編制單獨的“子系統(tǒng)或模塊詳細(xì)設(shè)計報告”。子系統(tǒng)/模塊1（編號/名稱）功能簡述本子系統(tǒng)或模塊實現(xiàn)的功能需求。性能說明對本子系統(tǒng)或模塊的性能要求，包括精度、時間特性和處理速度。模塊結(jié)構(gòu)采用“模塊內(nèi)部結(jié)構(gòu)圖”、“模塊數(shù)據(jù)流圖”或“模塊狀態(tài)圖”（可選）重點描述模塊內(nèi)部結(jié)構(gòu)。子模塊接口設(shè)計描述各相關(guān)模塊間的接口，主要說明：1） 某接口的目的以及實現(xiàn)的基本任務(wù)；2） 列出與該接口相關(guān)的子模塊名稱和編號；3） 描述在相關(guān)各子模塊中的使用(調(diào)用)方式；4） 逐個說明和接口相關(guān)的類和數(shù)據(jù)格式。只要子模塊間有存在關(guān)系，就必須逐個的按照上述要求描述。如果建立了模塊內(nèi)部結(jié)構(gòu)圖，要求圖中所有子模塊間有連線的都必須全部說明，沒連線的事實存在的也應(yīng)進(jìn)行說明。子系統(tǒng)/模塊2（編號/名稱）……數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)庫設(shè)計本部分對系統(tǒng)實現(xiàn)中最重要的對象數(shù)據(jù)進(jìn)行描述。如有必要，可對此部分編制單獨的“數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)庫設(shè)計報告”。面向?qū)ο髷?shù)據(jù)的數(shù)據(jù)結(jié)構(gòu)使用列表方式，描述對象數(shù)據(jù)的各項基本特征。數(shù)據(jù)名（標(biāo)識）結(jié)構(gòu)描述數(shù)據(jù)用途訪問方式和要求存儲要求其他說明：（描述對確定的對象數(shù)據(jù)的其他相關(guān)說明）面向?qū)ο髷?shù)據(jù)庫設(shè)計根據(jù)“對象數(shù)據(jù)列表”進(jìn)行數(shù)據(jù)庫設(shè)計。要求：1） 描述數(shù)據(jù)庫結(jié)構(gòu)；2） 描述數(shù)據(jù)庫安全性要求；3） 描述數(shù)據(jù)庫理想性能要求。數(shù)據(jù)安全性如果某些數(shù)據(jù)對安全性、容錯性等有特殊要求，須描述相應(yīng)的解決方案。對象數(shù)據(jù)/模塊對應(yīng)表以列表形式描述對象數(shù)據(jù)與子系統(tǒng)/模塊間的對應(yīng)關(guān)系。描述方式同“系統(tǒng)特性/模塊對應(yīng)表”。模塊1模塊2……模塊m對象數(shù)據(jù)1RR對象數(shù)