系統(tǒng)軟件設(shè)計(jì)報(bào)告模板

1、Neusoft（項(xiàng)目名稱）系統(tǒng)設(shè)計(jì)報(bào)告（部門(mén)名稱）文件編號(hào)：TD202文件版次：QMS2005系統(tǒng)設(shè)計(jì)報(bào)告QMS2005 P-12/11文檔編號(hào)版本號(hào)分冊(cè)名稱第冊(cè)/共冊(cè)總頁(yè)數(shù)正文附錄編制審批生效日期沈陽(yáng)東軟軟件股份有限公司沈陽(yáng)東軟軟件股份有限公司修改記錄版本號(hào)變更控制報(bào)告 編號(hào)更改條款及內(nèi)容更改人審批人更改日期目錄0報(bào)告編制要求51 引言51.1 文檔編制目的51.2 背景61.3 詞匯表61.4 參考資料62 總體設(shè)計(jì)62.1 軟件體系結(jié)構(gòu) 62.2 系統(tǒng)運(yùn)行體系 62.2.1 運(yùn)行體系圖62.2.2 程序/模塊對(duì)應(yīng)表 72.3 系統(tǒng)物理結(jié)構(gòu) 72.4 技術(shù)路線73 系統(tǒng)接口設(shè)計(jì)73.1 用

2、戶接口 73.2 外部系統(tǒng)接口 83.3 模塊間接口 84 子系統(tǒng)/模塊設(shè)計(jì)84.1 子系統(tǒng)/模塊1 （編號(hào)/名稱）94.1.1 功能94.1.2 性能94.1.3 模塊結(jié)構(gòu)94.1.4 子模塊接口設(shè)計(jì)94.2 子系統(tǒng)/模塊2 （編號(hào)/名稱）95 數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)庫(kù)設(shè)計(jì) 95.1 面向?qū)ο髷?shù)據(jù)的數(shù)據(jù)結(jié)構(gòu) 95.2 面向?qū)ο髷?shù)據(jù)庫(kù)設(shè)計(jì)105.3 數(shù)據(jù)安全性105.4 對(duì)象數(shù)據(jù)/模塊對(duì)應(yīng)表106 外部存儲(chǔ)結(jié)構(gòu)設(shè)計(jì) 107 故障處理說(shuō)明108 尚需解決的問(wèn)題 119 附件11編寫(xiě)指南：本模板力圖給出系統(tǒng)設(shè)計(jì)階段可能包括的基本信息，重點(diǎn)在于和需求分析文檔相聯(lián)系。描述系統(tǒng)整體情況。如果某個(gè)章節(jié)在項(xiàng)目或當(dāng)前

3、階段中無(wú)法描述，則可保留其標(biāo)題，注明“不適用”；如果需要對(duì)本模板的個(gè)別章節(jié)詳細(xì)描述，也可將其形成單獨(dú)的文檔，成為本文檔附件。若文檔中的某個(gè)章節(jié)已經(jīng)在其他項(xiàng)目文檔中加以描述，可保留標(biāo)題，注明“參見(jiàn)（文檔編號(hào)）（文檔名稱）（條款）”。形成正式文檔后須刪除斜體字內(nèi)容。0報(bào)告編制要求這里列出本系統(tǒng)設(shè)計(jì)報(bào)告編制的經(jīng)驗(yàn)性要求，須由系統(tǒng)設(shè)計(jì)人員參照其進(jìn)行裁剪以確定 本次報(bào)告編制的相關(guān)規(guī)定。序號(hào)要求1對(duì)各種結(jié)構(gòu)圖要求采用Visio繪制。2軟件體系結(jié)構(gòu)圖通常包括：子系統(tǒng)實(shí)體、子系統(tǒng)間數(shù)據(jù)流、相關(guān)說(shuō)明。3軟件結(jié)構(gòu)圖通常包括：模塊實(shí)體、模塊間數(shù)據(jù)流、數(shù)據(jù)存儲(chǔ)、相關(guān)說(shuō)明。4運(yùn)行體系圖包括：進(jìn)程實(shí)體、啟動(dòng)順序、并發(fā)性、

4、數(shù)據(jù)交換。5物理結(jié)構(gòu)圖包括：物理節(jié)點(diǎn)實(shí)體、物理節(jié)點(diǎn)分布、物理節(jié)點(diǎn)描述、物理節(jié)點(diǎn)間相互關(guān) 系。6對(duì)數(shù)據(jù)庫(kù)結(jié)構(gòu)的描述要求米用結(jié)構(gòu)圖方式描述，而非米用過(guò)多表格。7數(shù)據(jù)庫(kù)結(jié)構(gòu)圖主要包括：表實(shí)體、表間關(guān)系、主要字段、相關(guān)說(shuō)明四部分。8對(duì)于平臺(tái)性產(chǎn)品，要求有系統(tǒng)層次的劃分圖。9通常要隔離應(yīng)用對(duì)數(shù)據(jù)庫(kù)的直接訪冋。1引言1.1 文檔編制目的說(shuō)明編寫(xiě)這份報(bào)告的目的，指出預(yù)期的讀者1.2 背景敘述系統(tǒng)設(shè)計(jì)階段的目標(biāo)、作用范圍以及其他應(yīng)向讀者說(shuō)明的理解本報(bào)告所需的背景， 如與公司其它軟件之間的聯(lián)系等。1.3 詞匯表列出本系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)中專門(mén)術(shù)語(yǔ)的定義、英文縮寫(xiě)詞的原詞組和意義、項(xiàng)目組內(nèi)達(dá)成致意見(jiàn)的專用詞匯，同時(shí)要求

5、繼承全部的先前過(guò)程中定義過(guò)的詞匯詞匯名稱詞匯含義備注備注中注明該詞匯的來(lái)源，或有其他更詳細(xì)的解釋的文檔位置；以及對(duì)該詞匯的其他叫法1.4 參考資料列出編寫(xiě)本報(bào)告時(shí)參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號(hào)、出版日 期和出版單位。列出編寫(xiě)本報(bào)告時(shí)查閱的In ternet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及其網(wǎng)址。2總體設(shè)計(jì)2.1 軟件體系結(jié)構(gòu)以圖表形式（軟件體系結(jié)構(gòu)圖及軟件結(jié)構(gòu)圖）給出軟件子系統(tǒng)結(jié)構(gòu)和模塊組成結(jié)構(gòu)。如 果對(duì)某子系統(tǒng)單獨(dú)編制系統(tǒng)設(shè)計(jì)報(bào)告，則在此處不必列出其內(nèi)部自用模塊。為滿足確定的設(shè)計(jì)單元的可跟蹤性和可維護(hù)性，需采用唯一性標(biāo)識(shí)確定每個(gè)子系統(tǒng)與模 塊。對(duì)設(shè)計(jì)單元的標(biāo)識(shí)可以采用序列

6、號(hào)、層次編碼或自定義其他的方法。2.2 系統(tǒng)運(yùn)行體系2.2.1 運(yùn)行體系圖主要考慮以下幾個(gè)問(wèn)題：1）系統(tǒng)有多少個(gè)程序要運(yùn)行；2） 每個(gè)程序的生命周期（什么時(shí)候開(kāi)始，什么時(shí)候結(jié)束）；3）系統(tǒng)有哪些地方需要并發(fā)，采用什么方式，如果是多線程 /進(jìn)程的方式，那些進(jìn)程/線 程間通訊問(wèn)題、生命周期問(wèn)題怎么解決。這些問(wèn)題盡量用圖表方式描述，有必要的話采用多個(gè)圖表方式。2.2.2 程序/模塊對(duì)應(yīng)表以列表形式描述子系統(tǒng)/模塊與運(yùn)行程序間的對(duì)應(yīng)關(guān)系。描述方式同“系統(tǒng)特性/模塊對(duì)應(yīng)表程序1程序2程序n模塊1RR模塊2RRR模塊mRRR”（ Relate）表示模塊m和完成系統(tǒng)特性n有關(guān)。從上圖可見(jiàn)程序2與三個(gè)模塊1、

7、2、n相關(guān)。2.3 系統(tǒng)物理結(jié)構(gòu)描述使用本軟件系統(tǒng)典型用戶的物理設(shè)備分布圖及設(shè)備上相應(yīng)基本軟件配置。軟件環(huán)境 包括：操作系統(tǒng)、數(shù)據(jù)庫(kù)、以及其它支撐軟件；硬件環(huán)境包括：主機(jī)類型、網(wǎng)絡(luò)類型、存儲(chǔ) 器容量、其它特殊設(shè)備。要求：1）盡量為系統(tǒng)的每個(gè)物理節(jié)點(diǎn)定義一個(gè)和功能相關(guān)的名稱，名稱的含義在詞匯表中說(shuō) 明；2）結(jié)合運(yùn)行體系圖中提到的“程序”，將相關(guān)的“運(yùn)行程序”分布到各個(gè)物理節(jié)點(diǎn)中;3）米用網(wǎng)絡(luò)拓?fù)鋱D表示。2.4 技術(shù)路線描述本軟件系統(tǒng)在實(shí)現(xiàn)過(guò)程中所采用的技術(shù)路線、方法。對(duì)較新的技術(shù)給予詳細(xì)的闡述 及必要的說(shuō)明，在可能的情況下給出相應(yīng)的技術(shù)參考資料。3系統(tǒng)接口設(shè)計(jì)3.1 用戶接口描述該軟件與用戶的接

8、口，包括用戶輸入輸出界面樣式、操作方式和界面間的轉(zhuǎn)移關(guān)系如具有等同作用的文件（如使用開(kāi)發(fā)工具編寫(xiě)的界面原型程序等），本處僅需列出該文件名、保管部門(mén)即可。要求：1）列舉實(shí)現(xiàn)某用戶接口對(duì)應(yīng)的程序名稱；2）用戶接口描述采用對(duì)話圖或者界面原型程序表示；3）需要對(duì)逐個(gè)程序進(jìn)行說(shuō)明。3.2 外部系統(tǒng)接口描述該軟件與其它系統(tǒng)的接口，主要說(shuō)明1）系統(tǒng)所使用的外部系統(tǒng)提供的編程接口；2）本系統(tǒng)向其它系統(tǒng)提供的編程接口。 如具有等同作用的文件（如包含接口說(shuō)明及注釋 的源文件程序頭文件、接口幫助的超文本文件等），本處僅需列出該文件名、保管部 門(mén)即可；3）本系統(tǒng)和外部系統(tǒng)相關(guān)的硬件接口、通信協(xié)議及規(guī)程、數(shù)據(jù)交換格式等

9、。要求：1）對(duì)所有相關(guān)的外部系統(tǒng)逐個(gè)描述；2）對(duì)接口詳細(xì)描述。3.3 模塊間接口描述各相關(guān)模塊間的接口，主要說(shuō)明：1）某接口的目的以及實(shí)現(xiàn)的基本任務(wù)；2）列出與該接口相關(guān)的模塊名稱及編號(hào)；3）描述在相關(guān)各模塊中的使用（調(diào)用）方式；4）逐個(gè)說(shuō)明和接口相關(guān)的類和數(shù)據(jù)格式。只要模塊間有存在關(guān)系，就必須逐個(gè)的按照上述要求描述。如果建立了軟件體系結(jié)構(gòu)圖， 要求圖中所有模塊間有連線的都必須全部說(shuō)明，沒(méi)連線的事實(shí)存在的也應(yīng)進(jìn)行說(shuō)明。4子系統(tǒng)/模塊設(shè)計(jì)對(duì)軟件體系結(jié)構(gòu)中描述的子系統(tǒng)與模塊的設(shè)計(jì)情況分別進(jìn)行說(shuō)明，如有必要可對(duì)某子系 統(tǒng)或模塊編制單獨(dú)的“子系統(tǒng)或模塊詳細(xì)設(shè)計(jì)報(bào)告”。4.1 子系統(tǒng)/模塊1 （編號(hào)/名

10、稱）4.1.1 功能簡(jiǎn)述本子系統(tǒng)或模塊實(shí)現(xiàn)的功能需求。4.1.2 性能說(shuō)明對(duì)本子系統(tǒng)或模塊的性能要求，包括精度、時(shí)間特性和處理速度。4.1.3 模塊結(jié)構(gòu)采用“模塊內(nèi)部結(jié)構(gòu)圖”、“模塊數(shù)據(jù)流圖”或“模塊狀態(tài)圖”（可選）重點(diǎn)描述模塊內(nèi)部 結(jié)構(gòu)。4.1.4 子模塊接口設(shè)計(jì)描述各相關(guān)模塊間的接口，主要說(shuō)明：1）某接口的目的以及實(shí)現(xiàn)的基本任務(wù)；2）列出與該接口相關(guān)的子模塊名稱和編號(hào)；3）描述在相關(guān)各子模塊中的使用（調(diào)用）方式；4）逐個(gè)說(shuō)明和接口相關(guān)的類和數(shù)據(jù)格式。只要子模塊間有存在關(guān)系，就必須逐個(gè)的按照上述要求描述。如果建立了模塊內(nèi)部結(jié)構(gòu) 圖，要求圖中所有子模塊間有連線的都必須全部說(shuō)明，沒(méi)連線的事實(shí)存在

11、的也應(yīng)進(jìn)行說(shuō)明。4.2 子系統(tǒng)/模塊2 （編號(hào)/名稱）5數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)庫(kù)設(shè)計(jì)本部分對(duì)系統(tǒng)實(shí)現(xiàn)中最重要的對(duì)象數(shù)據(jù)進(jìn)行描述。如有必要，可對(duì)此部分編制單獨(dú)的“數(shù) 據(jù)結(jié)構(gòu)與數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告”。5.1面向?qū)ο髷?shù)據(jù)的數(shù)據(jù)結(jié)構(gòu)使用列表方式，描述對(duì)象數(shù)據(jù)的各項(xiàng)基本特征數(shù)據(jù)名（標(biāo)識(shí)）結(jié)構(gòu)描述數(shù)據(jù)用途訪冋方式和要求存儲(chǔ)要求其他說(shuō)明：（描述對(duì)確定的對(duì)象數(shù)據(jù)的其他相關(guān)說(shuō)明）5.2 面向?qū)ο髷?shù)據(jù)庫(kù)設(shè)計(jì)根據(jù)“對(duì)象數(shù)據(jù)列表”進(jìn)行數(shù)據(jù)庫(kù)設(shè)計(jì)。要求：1）描述數(shù)據(jù)庫(kù)結(jié)構(gòu)；2）描述數(shù)據(jù)庫(kù)安全性要求；3）描述數(shù)據(jù)庫(kù)理想性能要求。5.3 數(shù)據(jù)安全性如果某些數(shù)據(jù)對(duì)安全性、容錯(cuò)性等有特殊要求，須描述相應(yīng)的解決方案。5.4 對(duì)象數(shù)據(jù)/模塊對(duì)應(yīng)表以列表形式描述對(duì)象數(shù)據(jù)與子系統(tǒng)/模塊間的對(duì)應(yīng)關(guān)系。描述方式同“系統(tǒng)特性/模塊對(duì)應(yīng)表模塊1模塊2模塊m對(duì)象數(shù)據(jù)1RR對(duì)象數(shù)據(jù)2RRR對(duì)象數(shù)據(jù)nRR6外部存儲(chǔ)結(jié)構(gòu)設(shè)計(jì)說(shuō)明本系統(tǒng)存貯于磁盤(pán)等持久性存貯