系統軟件設計報告模板

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

2、戶接口 73.2 外部系統接口 83.3 模塊間接口 84 子系統/模塊設計84.1 子系統/模塊1 （編號/名稱）94.1.1 功能94.1.2 性能94.1.3 模塊結構94.1.4 子模塊接口設計94.2 子系統/模塊2 （編號/名稱）95 數據結構與數據庫設計 95.1 面向對象數據的數據結構 95.2 面向對象數據庫設計105.3 數據安全性105.4 對象數據/模塊對應表106 外部存儲結構設計 107 故障處理說明108 尚需解決的問題 119 附件11編寫指南：本模板力圖給出系統設計階段可能包括的基本信息，重點在于和需求分析文檔相聯系。描述系統整體情況。如果某個章節(jié)在項目或當前

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

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

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

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

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

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

9、。要求：1）對所有相關的外部系統逐個描述；2）對接口詳細描述。3.3 模塊間接口描述各相關模塊間的接口，主要說明：1）某接口的目的以及實現的基本任務；2）列出與該接口相關的模塊名稱及編號；3）描述在相關各模塊中的使用（調用）方式；4）逐個說明和接口相關的類和數據格式。只要模塊間有存在關系，就必須逐個的按照上述要求描述。如果建立了軟件體系結構圖， 要求圖中所有模塊間有連線的都必須全部說明，沒連線的事實存在的也應進行說明。4子系統/模塊設計對軟件體系結構中描述的子系統與模塊的設計情況分別進行說明，如有必要可對某子系 統或模塊編制單獨的“子系統或模塊詳細設計報告”。4.1 子系統/模塊1 （編號/名

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

11、的也應進行說明。4.2 子系統/模塊2 （編號/名稱）5數據結構與數據庫設計本部分對系統實現中最重要的對象數據進行描述。如有必要，可對此部分編制單獨的“數 據結構與數據庫設計報告”。5.1面向對象數據的數據結構使用列表方式，描述對象數據的各項基本特征數據名（標識）結構描述數據用途訪冋方式和要求存儲要求其他說明：（描述對確定的對象數據的其他相關說明）5.2 面向對象數據庫設計根據“對象數據列表”進行數據庫設計。要求：1）描述數據庫結構；2）描述數據庫安全性要求；3）描述數據庫理想性能要求。5.3 數據安全性如果某些數據對安全性、容錯性等有特殊要求，須描述相應的解決方案。5.4 對象數據/模塊對應表以列表形式描述對象數據與子系統/模塊間的對應關系。描述方式同“系統特性/模塊對應表模塊1模塊2模塊m對象數據1RR對象數據2RRR對象數據nRR6外部存儲結構設計說明本系統存貯于磁盤等持久性存貯