軟件概要設(shè)計模板

1、 XX 概要設(shè)計說明書 目 錄1簡介41.1目的41.2范圍4軟件名稱4軟件功能4軟件應(yīng)用41.3實現(xiàn)系統(tǒng)環(huán)境4器件特性描述4器件工作原理介紹4關(guān)鍵寄存器介紹42概要設(shè)計52.1第0層設(shè)計描述5軟件系統(tǒng)上下文定義5設(shè)計思路(可選)62.2第一層設(shè)計描述6系統(tǒng)架構(gòu)（功能分解和物理分解）6功能實現(xiàn)與模塊/子系統(tǒng)的關(guān)系7分解描述9接口描述92.3第二層設(shè)計描述（Optional）10模塊1名稱102.4132.5數(shù)據(jù)庫（可選）13實體、屬性及它們之間的關(guān)系13實體關(guān)系圖132.6文件的組織14文件的命名方式14文件的組織目錄結(jié)構(gòu)14 XX 概要設(shè)計說明書 關(guān)鍵詞：能夠體現(xiàn)文檔描述內(nèi)容主要方面的詞匯。

2、 摘 要： 縮略語清單：對本文所用縮略語進行說明，要求提供每個縮略語的英文全名和中文解釋。 縮略語 英文全名 中文解釋1 簡介1.1 目的 這部分要描述文檔的目的。應(yīng)該指明讀者。1.2 范圍1.2.1 軟件名稱 對軟件命名1.2.2 軟件功能 解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關(guān)文檔）1.2.3 軟件應(yīng)用 描述軟件的應(yīng)用（可直接描述也可以參考其他軟件文檔）1.3 實現(xiàn)系統(tǒng)環(huán)境 描述本軟件的硬件應(yīng)用平臺（主要涉及關(guān)鍵器件的介紹和環(huán)境組網(wǎng)方式）1.3.1 器件特性描述 本器件所支持的規(guī)格、工作模式及其異同1.3.2 器件工作原理介紹The description of th

3、e work principle of the device we used in our solution.1.3.3 關(guān)鍵寄存器介紹The description of the registers used in the work mode our solution.2 概要設(shè)計 2.1 第0層設(shè)計描述2.1.1 軟件系統(tǒng)上下文定義 描述系統(tǒng)如何與外部實體一道組成功能實體（一般用圖描述）外部實體屬性描述只限于軟件設(shè)計和描述相關(guān)的屬性。2.1.2 設(shè)計思路(可選) 2.1.2.1 基本設(shè)計思路說明系統(tǒng)采取的基本設(shè)計思路,概要描述為什么采取本方案。2.1.2.2 設(shè)計約束1 遵循標準 描述本軟

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

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

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

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

8、述。2.2.4.1 模塊/子系統(tǒng)接口 本節(jié)描述模塊/子系統(tǒng)的接口。1 模塊/子系統(tǒng) 1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：2.2.4.2 進程接口 本節(jié)描述進程的接口。1 進程1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：2.3 第二層設(shè)計描述（Optional） .L1中定義的每個實體的進一步設(shè)計在下面的章節(jié)進行描述。 對每個模塊重復(fù)使用下

9、述的格式。2.3.1 模塊1名稱 不要寫直接“模塊1名稱”，用簡短的詞語命名模塊.2.3.1.1 模塊架構(gòu)（物理分解）運用物理框圖描述組成軟件模塊的構(gòu)件（子模塊），描述之間的“靜態(tài)”關(guān)系。2.3.1.2 功能實現(xiàn)與子模塊的關(guān)系 用如下矩陣圖說明模塊的功能需求的實現(xiàn)與各子模塊的分配關(guān)系：子模塊1子模塊2子模塊n模塊的功能需求1模塊的功能需求2模塊的功能需求n 2.3.1.3 分解描述 描述模塊的分解，并描述每個子模塊的功能等屬性。.1 子模塊描述 a) 子模塊 1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：

10、Functions 功能列表：.2 并發(fā)進程描述 本節(jié)描述模塊中的并發(fā)進程。 對于外部實體，從屬屬性不必描述。a) 進程1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：.3 數(shù)據(jù)描述 本節(jié)描述模塊中的數(shù)據(jù)結(jié)構(gòu)。 外部數(shù)據(jù)實體不必描述。a) 數(shù)據(jù)實體1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的： 2.3.1.4 接口描述描述模塊內(nèi)部的接口關(guān)系，如兩個子模塊間的接口等。接口描述可以使用接口文件

11、，參數(shù)表。對于外部實體只有同被描述軟件相關(guān)的接口才需描述。.1 子模塊接口 本節(jié)描述子模塊的接口。a) 子模塊1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：.2 進程接口 本節(jié)描述進程的接口。a) 進程1接口描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：2.42.5 數(shù)據(jù)庫（可選）2.5.1 實體、屬性及它們之間的關(guān)系 本節(jié)列出所有的數(shù)據(jù)存儲類的實體，詳細

12、描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關(guān)系也要注明。2.5.2 實體關(guān)系圖This section should display the E-R diagram for all the entities listed above. 2.6 文件的組織2.6.1 文件的命名方式The description of the organization for the files and directory of code file. 2.6.2 文件的組織目錄結(jié)構(gòu)The description of the source code files directory organization2.6.3 參考資料清單：請羅列本文檔所參考的有關(guān)參考文獻和相關(guān)文檔，格式如下：作者書名（或雜志、文獻、文檔）出版社（或期號、卷號、公司文檔編號）出版日期+起止頁碼例如：1 D. B. L