軟件概要設計模板

1、.-. XX 概要設計說明書 目 錄 TOC o 2-3 h z t 標題 1,1 HYPERLINK l _Toc211913232 1簡介 XX 概要設計說明書 關鍵詞：能夠體現(xiàn)文檔描述內(nèi)容主要方面的詞匯。 摘 要： 縮略語清單：對本文所用縮略語進行說明，要求提供每個縮略語的英文全名和中文解釋。 縮略語 英文全名 中文解釋 簡介 目的 這部分要描述文檔的目的。應該指明讀者。 范圍 軟件名稱 對軟件命名 軟件功能 解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關文檔） 軟件應用 描述軟件的應用（可直接描述也可以參考其他軟件文檔） 實現(xiàn)系統(tǒng)環(huán)境 描述本軟件的硬件應用平臺（主要涉及關

2、鍵器件的介紹和環(huán)境組網(wǎng)方式） 器件特性描述 本器件所支持的規(guī)格、工作模式及其異同 器件工作原理介紹The description of the work principle of the device we used in our solution. 關鍵寄存器介紹The description of the registers used in the work mode our solution. 概要設計 第0層設計描述 軟件系統(tǒng)上下文定義 描述系統(tǒng)如何與外部實體一道組成功能實體（一般用圖描述）外部實體屬性描述只限于軟件設計和描述相關的屬性。 設計思路(可選) 基本設計思路說明系統(tǒng)采取的基

3、本設計思路,概要描述為什么采取本方案。 設計約束 遵循標準 描述本軟件所遵循的標準、規(guī)范 硬件限制 描述本軟件系統(tǒng)實現(xiàn)的硬件限制 技術限制 描述本軟件的技術限制 安全性和可靠性設計方案 遵循標準 描述本軟件所遵循的標準、規(guī)范 硬件限制 描述本軟件系統(tǒng)實現(xiàn)的硬件限制 技術限制 描述本軟件的技術限制 其他 描述其他有關的設計考慮 第一層設計描述系統(tǒng)架構(gòu)（功能分解和物理分解）描述組成軟件系統(tǒng)的構(gòu)件（子系統(tǒng)、模塊），描述之間的“靜態(tài)”關系。一般采用系統(tǒng)方框圖的形式。要按照子系統(tǒng)組成系統(tǒng)，模塊組成子系統(tǒng)的方式組織描述。系統(tǒng)方框圖應能規(guī)定出系統(tǒng)的整體架構(gòu)，說明組成系統(tǒng)的各部分是如何搭配成一個完整系統(tǒng)的。系

4、統(tǒng)方框圖應畫成二種：一種是功能性的，說明系統(tǒng)有哪些功能？應由哪些功能模塊來實現(xiàn)？畫出這些功能模塊之間、本系統(tǒng)與其它接口系統(tǒng)之間的邏輯關系； 描述它們間的接口方式， 遵循的協(xié)議規(guī)范等。 如果是升級類產(chǎn)品， 在原有功能方框框圖上增加、刪除、修改。 另一種是物理性的，說明系統(tǒng)由具體的哪些軟件模塊來實現(xiàn)。注：對于簡單功能的軟件系統(tǒng)，可省略“功能分解”（功能框圖）這一步驟，而直接進行“物理分解”（物理框圖）?？蓽y性設計的整體結(jié)構(gòu)描述也應在這里給出。說明整體系統(tǒng)可測性方面的層次結(jié)構(gòu)，之間的邏輯關系，主要的功能接口定義，子系統(tǒng)、模塊應具有的主要可測性規(guī)格與設計描述。功能實現(xiàn)與模塊/子系統(tǒng)的關系 描述系統(tǒng)是如

5、何運作以實現(xiàn)系統(tǒng)需求的。對于可測性性設計的功能，如果有單獨的功能模塊則在下面用單獨的小節(jié)進行功能實現(xiàn)原理描述，如果只是某些功能需求的一部分功能，則在相應的功能需求中進行說明。 用如下矩陣圖說明各項功能需求的實現(xiàn)與各模塊/子系統(tǒng)的分配關系：模塊/子系統(tǒng) 1模塊/子系統(tǒng)2模塊/子系統(tǒng) n功能需求1功能需求2功能需求n 分解描述模塊/子系統(tǒng)描述 模塊/子系統(tǒng) 1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：并發(fā)進程描述 本節(jié)描述系統(tǒng)中的并發(fā)進程。 對于外部實體，從屬屬性不必描述。 進

6、程1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表： 數(shù)據(jù)描述 本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。 外部數(shù)據(jù)實體不必描述。 數(shù)據(jù)實體1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的： 接口描述 本節(jié)描述軟件系統(tǒng)中設計實體(如模塊/子系統(tǒng)）的接口. 接口描述可以使用接口文件，參數(shù)表。 對于外部實體只有同被描述軟件相關的接口才需描述。 模塊/子系統(tǒng)接口 本節(jié)描述模塊/子系統(tǒng)的接口。模塊/子系統(tǒng) 1接口描述D

7、escribe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：進程接口 本節(jié)描述進程的接口。 進程1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表： 第二層設計描述（Optional） .L1中定義的每個實體的進一步設計在下面的章節(jié)進行描述。 對每個模塊重復使用下述的格式。 模塊1名稱 不要寫直接“模塊1名稱”，用簡短的詞語命名模塊.模塊架構(gòu)（物理分解）運用物理框圖描述組成軟件模塊

8、的構(gòu)件（子模塊），描述之間的“靜態(tài)”關系。功能實現(xiàn)與子模塊的關系 用如下矩陣圖說明模塊的功能需求的實現(xiàn)與各子模塊的分配關系：子模塊1子模塊2子模塊n模塊的功能需求1模塊的功能需求2模塊的功能需求n 分解描述 描述模塊的分解，并描述每個子模塊的功能等屬性。子模塊描述 子模塊 1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：并發(fā)進程描述 本節(jié)描述模塊中的并發(fā)進程。 對于外部實體，從屬屬性不必描述。 進程1描述Describe as follows 按照以下格式描述：Identifi

9、cation 標識：Type 類型：Purpose目的：Functions 功能列表： 數(shù)據(jù)描述 本節(jié)描述模塊中的數(shù)據(jù)結(jié)構(gòu)。 外部數(shù)據(jù)實體不必描述。 數(shù)據(jù)實體1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的： 接口描述描述模塊內(nèi)部的接口關系，如兩個子模塊間的接口等。接口描述可以使用接口文件，參數(shù)表。對于外部實體只有同被描述軟件相關的接口才需描述。 子模塊接口 本節(jié)描述子模塊的接口。子模塊1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Pu

10、rpose目的：Functions 功能列表：進程接口 本節(jié)描述進程的接口。 進程1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表： 數(shù)據(jù)庫（可選） 實體、屬性及它們之間的關系 本節(jié)列出所有的數(shù)據(jù)存儲類的實體，詳細描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關系也要注明。 實體關系圖This section should display the E-R diagram for all the entities li

11、sted above. 文件的組織 文件的命名方式The description of the organization for the files and directory of code file. 文件的組織目錄結(jié)構(gòu)The description of the source code files directory organization參考資料清單：請羅列本文檔所參考的有關參考文獻和相關文檔，格式如下：作者書名（或雜志、文獻、文檔）出版社（或期號、卷號、公司文檔編號）出版日期+起止頁碼例如：D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 966 （英文文章格式）D. W