軟件(結(jié)構(gòu))設(shè)計(jì)說(shuō)明(SDD)

1、精選優(yōu)質(zhì)文檔-傾情為你奉上軟件(結(jié)構(gòu))設(shè)計(jì)說(shuō)明(SDD)說(shuō)明：1.軟件(結(jié)構(gòu))設(shè)計(jì)說(shuō)明(SDD)描述了計(jì)算機(jī)軟件配置項(xiàng)(CSCI的設(shè)計(jì)。它描述了CSCI級(jí)設(shè)計(jì)決策、CSCI體系結(jié)構(gòu)設(shè)計(jì)(概要設(shè)計(jì))和實(shí)現(xiàn)該軟件所需的詳細(xì)設(shè)計(jì)。SDD可用接口設(shè)計(jì)說(shuō)明IDD和數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說(shuō)明DBDD加以補(bǔ)充。2.SDD連同相關(guān)的IDD和DBDD是實(shí)現(xiàn)該軟件的基礎(chǔ)。向需方提供了設(shè)計(jì)的可視性，為軟件支持提供了所需要的信息。3.IDD和DBDD是否單獨(dú)成冊(cè)抑或與SDD合為一份資料視情況繁簡(jiǎn)而定。軟件(結(jié)構(gòu))設(shè)計(jì)說(shuō)明的正文的格式如下：1引言本章應(yīng)分為以下幾條。1.1標(biāo)識(shí)本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí)。(若

2、適用)包括標(biāo)識(shí)號(hào)、標(biāo)題、縮略詞語(yǔ)、版本號(hào)、發(fā)行號(hào)。1.2系統(tǒng)概述本條應(yīng)簡(jiǎn)述本文檔適用的系統(tǒng)和軟件的用途。它應(yīng)描述系統(tǒng)與軟件的一般性質(zhì)；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方、需方、用戶、開發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場(chǎng)；并列出其他有關(guān)文檔。1.3文檔概述本條應(yīng)概述本文檔的用途與內(nèi)容，并描述與其使用有關(guān)的保密性或私密性要求。1.4基線說(shuō)明編寫本系統(tǒng)設(shè)計(jì)說(shuō)明書所依據(jù)的設(shè)計(jì)基線。2引用文件本章應(yīng)列出本文檔引用的所有文檔的編號(hào)、標(biāo)題、修訂版本和日期。本章也應(yīng)標(biāo)識(shí)不能通過(guò)正常的供貨渠道獲得的所有文檔的來(lái)源。3 CSCI級(jí)設(shè)計(jì)決策本章應(yīng)根據(jù)需要分條給出CSCI級(jí)設(shè)計(jì)決策，即CSCI行為

3、的設(shè)計(jì)決策(忽略其內(nèi)部實(shí)現(xiàn)，從用戶的角度看，它如何滿足用戶的需求)和其他影響組成該CSCI的軟件配置項(xiàng)的選擇與設(shè)計(jì)的決策。如果所有這些決策在CSCI需求中均是明確的，或者要推遲到CSCI的軟件配置項(xiàng)設(shè)計(jì)時(shí)指出，本章應(yīng)如實(shí)陳述。為響應(yīng)指定為關(guān)鍵性的需求(如安全性、保密性、私密性需求)而作出的設(shè)計(jì)決策，應(yīng)在單獨(dú)的條中加以描述。如果設(shè)計(jì)決策依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指出這種依賴性。應(yīng)給出或引用理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。CSCI級(jí)設(shè)計(jì)決策的例子如下：a.關(guān)于CSCI應(yīng)接受的輸入和產(chǎn)生的輸出的設(shè)計(jì)決策，包括與其他系統(tǒng)、HWCI, CSCI和用戶的接口(本文的4.5.x標(biāo)識(shí)了本說(shuō)明要考慮的主題)。如果該

4、信息的部分或全部已在接口設(shè)計(jì)說(shuō)明(IDD)中給出，此處可引用。b.有關(guān)響應(yīng)每個(gè)輸入或條件的CSCI行為的設(shè)計(jì)決策，包括該CSCI要執(zhí)行的動(dòng)作、響應(yīng)時(shí)間及其他性能特性、被模式化的物理系統(tǒng)的說(shuō)明、所選擇的方程式/算法/規(guī)則和對(duì)不允許的輸入或條件的處理。c.有關(guān)數(shù)據(jù)庫(kù)/數(shù)據(jù)文件如何呈現(xiàn)給用戶的設(shè)計(jì)決策(本文的4.5.x標(biāo)識(shí)了本說(shuō)明要考慮的主題)。如果該信息的部分或全部已在數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說(shuō)明(DBDD)中給出，此處可引用。d.為滿足安全性、保密性、私密性需求而選擇的方法。e.對(duì)應(yīng)需求所做的其他CSCI級(jí)設(shè)計(jì)決策，例如為提供所需的靈活性、可用性和可維護(hù)性所選擇的方法。4 CSCI體系結(jié)構(gòu)設(shè)計(jì)本章應(yīng)分

5、條描述CSCI體系結(jié)構(gòu)設(shè)計(jì)。如果設(shè)計(jì)的部分或全部依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指出這種依賴性。如果設(shè)計(jì)信息在多條中出現(xiàn)，則可只描述一次，而在其他條引用。應(yīng)給出或引用為理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。4.1體系結(jié)構(gòu)4.1.1程序(模塊)劃分用一系列圖表列出本CSCI內(nèi)的每個(gè)程序(包括每個(gè)模塊和子程序)的名稱、標(biāo)識(shí)符、功能及其所包含的源標(biāo)準(zhǔn)名。4.1.2程序(模塊)層次結(jié)構(gòu)關(guān)系用一系列圖表列出本CSCI內(nèi)的每個(gè)程序(包括每個(gè)模塊和子程序)之間的層次結(jié)構(gòu)與調(diào)用關(guān)系。4.2全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。4.2.1常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說(shuō)明，具體常量說(shuō)明

6、等。4.2.2變量包括數(shù)據(jù)文件名稱及其所在目錄，功能說(shuō)明，具體變量說(shuō)明等。4.2.3數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說(shuō)明，具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明(定義、注釋、取值)等。4.3 CSCI部件本條應(yīng)：a.標(biāo)識(shí)構(gòu)成該CSCI的所有軟件配置項(xiàng)。應(yīng)賦予每個(gè)軟件配置項(xiàng)一個(gè)項(xiàng)目唯一標(biāo)識(shí)符。注:軟件配置項(xiàng)是CSCI設(shè)計(jì)中的一個(gè)元素，如CSCI的一個(gè)主要的分支、該分支的一個(gè)組成部分、一個(gè)類、對(duì)象、模塊、函數(shù)、例程或數(shù)據(jù)庫(kù).軟件配置項(xiàng)可以出現(xiàn)在一個(gè)層次結(jié)構(gòu)的不同層次上，并且可以由其他軟件配置項(xiàng)組成.設(shè)計(jì)中的軟件配置項(xiàng)與實(shí)現(xiàn)它們的代碼和數(shù)據(jù)實(shí)體(例程、過(guò)程、數(shù)據(jù)庫(kù)、數(shù)據(jù)文件等)或包含這些實(shí)體的計(jì)算機(jī)文件之間，可以有也可以沒(méi)

7、有一對(duì)一的關(guān)系。一個(gè)數(shù)據(jù)庫(kù)可以被處理為一個(gè)CSCI，也可被處理為一個(gè)軟件配置項(xiàng)。SDD可以通過(guò)與所采用的設(shè)計(jì)方法學(xué)一致的名字來(lái)引用軟件配置項(xiàng)。b.給出軟件配置項(xiàng)的靜態(tài)關(guān)系(如“組成”)。根據(jù)所選擇的軟件設(shè)計(jì)方法學(xué)可以給出多種關(guān)系(例如，采用面向?qū)ο蟮脑O(shè)計(jì)方法時(shí)，本條既可以給出類和對(duì)象結(jié)構(gòu)，也可以給出CSCI的模塊和過(guò)程結(jié)構(gòu))。c.陳述每個(gè)軟件配置項(xiàng)的用途，并標(biāo)識(shí)分配給它的CSCI需求與CSCI級(jí)設(shè)計(jì)決策(需求的分配也可在6.a中提供)。d.標(biāo)識(shí)每個(gè)軟件配置項(xiàng)的開發(fā)狀態(tài)/類型(如新開發(fā)的軟件配置項(xiàng)、重用已有設(shè)計(jì)或軟件的軟件配置項(xiàng)、再工程的已有設(shè)計(jì)或軟件、為重用而開發(fā)的軟件等)。對(duì)于已有設(shè)計(jì)或軟件

8、，本說(shuō)明應(yīng)提供標(biāo)識(shí)信息，如名稱、版本、文檔引用、庫(kù)等。e.描述CSCI(若適用，每個(gè)軟件配置項(xiàng))計(jì)劃使用的計(jì)算機(jī)硬件資源(例如處理器能力、內(nèi)存容量、輸入/輸出設(shè)備能力、輔存容量和通信/網(wǎng)絡(luò)設(shè)備能力)。這些描述應(yīng)覆蓋該CSCI的資源使用需求中提及的、影響該cscl的系統(tǒng)級(jí)資源分配中提及的、以及在軟件開發(fā)計(jì)劃的資源使用度量計(jì)劃中提及的所有計(jì)算機(jī)硬件資源。如果一給定的計(jì)算機(jī)硬件資源的所有使用數(shù)據(jù)出現(xiàn)在同一個(gè)地方，如在一個(gè)SDD中，則本條可以引用它。針對(duì)每一計(jì)算機(jī)硬件資源應(yīng)包括如下信息： 1)得到滿足的CSCI需求或系統(tǒng)級(jí)資源分配； 2)使用數(shù)據(jù)所基于的假設(shè)和條件(例如，典型用法、最壞情況用法、特定事

9、件的假設(shè))； 3)影響使用的特殊考慮(例如虛存的使用、覆蓋的使用、多處理器的使用或操作系統(tǒng)開銷、庫(kù)軟件或其他的實(shí)現(xiàn)開銷的影響)； 4)所使用的度量單位(例如處理器能力百分比、每秒周期、內(nèi)存字節(jié)數(shù)、每秒千字節(jié))； 5)進(jìn)行評(píng)估或度量的級(jí)別(例如軟件配置項(xiàng),CSCI或可執(zhí)行程序)。f.指出實(shí)現(xiàn)每個(gè)軟件配置項(xiàng)的軟件放置在哪個(gè)程序庫(kù)中。4.4執(zhí)行概念本條應(yīng)描述軟件配置項(xiàng)間的執(zhí)行概念。為表示軟件配置項(xiàng)之間的動(dòng)態(tài)關(guān)系，即CSCI運(yùn)行期間它們?nèi)绾谓换サ?，本條應(yīng)包含圖示和說(shuō)明，(若適用)包括執(zhí)行控制流、數(shù)據(jù)流、動(dòng)態(tài)控制序列、狀態(tài)轉(zhuǎn)換圖、時(shí)序圖、配置項(xiàng)之間的優(yōu)先關(guān)系、中斷處理、時(shí)間/序列關(guān)系、異常處理、并發(fā)執(zhí)行

10、、動(dòng)態(tài)分配與去分配、對(duì)象/進(jìn)程/任務(wù)的動(dòng)態(tài)創(chuàng)建與刪除和其他的動(dòng)態(tài)行為。4.5接口設(shè)計(jì)本條應(yīng)分條描述軟件配置項(xiàng)的接口特性，既包括軟件配置項(xiàng)之間的接口，也包括與外部實(shí)體，如系統(tǒng)、配置項(xiàng)及用戶之間的接口。如果這些信息的部分或全部已在接口設(shè)計(jì)說(shuō)明(IDD)、本文的第5章或其他地方說(shuō)明的話，可在此處引用。4.5.1接口標(biāo)識(shí)與接口圖本條應(yīng)陳述賦予每個(gè)接口的項(xiàng)目唯一標(biāo)識(shí)符，(若適用)并用名字、編號(hào)、版本和文檔引用等標(biāo)識(shí)接口實(shí)體(軟件配置項(xiàng)、系統(tǒng)、配置項(xiàng)、用戶等)。接口標(biāo)識(shí)應(yīng)說(shuō)明哪些實(shí)體具有固定接口特性(從而把接口需求強(qiáng)加給接口實(shí)體)，哪些實(shí)體正在開發(fā)或修改(因而已把接口需求分配給它們)。(若適用)應(yīng)該提供一

11、個(gè)或多個(gè)接口圖以描述這些接口。4.5.x(接口的項(xiàng)目唯一標(biāo)識(shí)符)本條(從4.5.2開始編號(hào))應(yīng)用項(xiàng)目唯一標(biāo)識(shí)符標(biāo)識(shí)接口，應(yīng)簡(jiǎn)要標(biāo)識(shí)接口實(shí)體，并且應(yīng)根據(jù)需要?jiǎng)澐譃閹讞l描述接口實(shí)體的單方或雙方的接口特性。如果一給定的接口實(shí)體本文沒(méi)有提到(例如，一個(gè)外部系統(tǒng))，但是其接口特性需要在本SDD描述的接口實(shí)體時(shí)提到，則這些特性應(yīng)以假設(shè)、或“當(dāng)未提到實(shí)體這樣做時(shí)，提到的實(shí)體將”的形式描述。本條可引用其他文檔(例如數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn))代替本條的描述信息。本設(shè)計(jì)說(shuō)明應(yīng)包括以下內(nèi)容，(若適用)它們可按適合于要提供的信息的任何次序給出，并且應(yīng)從接口實(shí)體角度指出這些特性之間的區(qū)別(例如數(shù)據(jù)元素的大小、頻

12、率或其他特性的不同期望)。a.由接口實(shí)體分配給接口的優(yōu)先級(jí)；b.要實(shí)現(xiàn)的接口的類型(例如實(shí)時(shí)數(shù)據(jù)傳輸、數(shù)據(jù)的存儲(chǔ)與檢索等)；c.接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問(wèn)、接收的單個(gè)數(shù)據(jù)元素的特性，例如： 1)名稱/標(biāo)識(shí)符； a)項(xiàng)目唯一標(biāo)識(shí)符； b)非技術(shù)(自然語(yǔ)言)名稱； c)標(biāo)準(zhǔn)數(shù)據(jù)元素名稱； d)縮寫名或同義名； 2)數(shù)據(jù)類型(字母數(shù)字、整數(shù)等)； 3)大小與格式(例如字符串的長(zhǎng)度與標(biāo)點(diǎn)符號(hào))； 4)計(jì)量單位(如米、元、納秒等)； 5)范圍或可能值的枚舉(如0-99)； 6)準(zhǔn)確度(正確程度)與精度(有效數(shù)位數(shù))； 7)優(yōu)先級(jí)、時(shí)序、頻率、容量、序列和其他約束，如數(shù)據(jù)元素是否可被更新，業(yè)務(wù)規(guī)則是

13、否適用； 8)保密性與私密性約束； 9)來(lái)源(設(shè)置/發(fā)送實(shí)體)與接收者(使用/接收實(shí)體)。d.接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問(wèn)、接收的數(shù)據(jù)元素集合體(記錄、消息、文件、數(shù)組、顯示、報(bào)表等)的特性，例如： 1)名稱/標(biāo)識(shí)符； a)項(xiàng)目唯一標(biāo)識(shí)符； b)非技術(shù)(自然語(yǔ)言)名稱； c)技術(shù)名稱(如代碼或數(shù)據(jù)庫(kù)中的記錄或數(shù)據(jù)結(jié)構(gòu)名)； d)縮寫名或同義名； 2)數(shù)據(jù)元素集合體中的數(shù)據(jù)元素及其結(jié)構(gòu)(編號(hào)、次序、分組)； 3)媒體(如盤)及媒體上數(shù)據(jù)元素/集合體的結(jié)構(gòu)； 4)顯示和其他輸出的視聽特性(如顏色、布局、字體、圖標(biāo)及其他顯示元素、蜂鳴聲、亮度等)； 5)數(shù)據(jù)集合體之間的關(guān)系，如排序/訪問(wèn)特性；

14、6)優(yōu)先級(jí)、時(shí)序、頻率、容量、序列和其他約束，如數(shù)據(jù)集合體是否可被更新，業(yè)務(wù)規(guī)則是否適用； 7)保密性與私密性約束； 8)來(lái)源(設(shè)置/發(fā)送實(shí)體)與接收者(使用/接收實(shí)體)。e.接口實(shí)體為該接口使用通信方法的特性，例如： 1)項(xiàng)目唯一標(biāo)識(shí)符； 2)通信鏈路/帶寬/頻率/媒體及其特性； 3)消息格式化； 4)流控制(如序列編號(hào)與緩沖區(qū)分配)； 5)數(shù)據(jù)傳輸率、周期或非周期和傳送間隔； 6)路由、尋址及命名約定； 7)傳輸服務(wù)，包括優(yōu)先級(jí)與等級(jí)； 8)安全性/保密性/私密性考慮，如加密、用戶鑒別、隔離、審核等。f.接口實(shí)體為該接口使用協(xié)議的特性，例如： 1)項(xiàng)目唯一標(biāo)識(shí)符； 2)協(xié)議的優(yōu)先級(jí)/層；

15、3)分組，包括分段與重組、路由及尋址； 4)合法性檢查、錯(cuò)誤控制、恢復(fù)過(guò)程； 5)同步，包括連接的建立、保持、終止； 6)狀態(tài)、標(biāo)識(shí)和其他報(bào)告特性。g.其他特性，如接口實(shí)體的物理兼容性(尺寸、容限、負(fù)荷、電壓、接插件的兼容性等)。5 CSCI詳細(xì)設(shè)計(jì)本章應(yīng)分條描述CSCI的每個(gè)軟件配置項(xiàng)。如果設(shè)計(jì)的部分或全部依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指出這種依賴性。如果該設(shè)計(jì)信息在多條中出現(xiàn)，則可只描述一次，而在其他條引用。應(yīng)給出或引用為理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。軟件配置項(xiàng)的接口特性可在此處描述，也可在第4章或接口設(shè)計(jì)說(shuō)明(IDD)中描述。數(shù)據(jù)庫(kù)軟件配置項(xiàng)，或用于操作/訪問(wèn)數(shù)據(jù)庫(kù)的軟件配置項(xiàng)，可在此處描述，

16、也可在數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說(shuō)明(DBDD)中描述。5.x(軟件配置項(xiàng)的項(xiàng)目唯一標(biāo)識(shí)符或軟件配置項(xiàng)組的指定符)本條應(yīng)用項(xiàng)目唯一標(biāo)識(shí)符標(biāo)識(shí)軟件配置項(xiàng)并描述它。(若適用)描述應(yīng)包括以下信息。作為一種變通，本條也可以指定一組軟件配置項(xiàng)，并分條標(biāo)識(shí)和描述它們。包含其他軟件配置項(xiàng)的軟件配置項(xiàng)可以引用那些軟件配置項(xiàng)的說(shuō)明，而無(wú)需在此重復(fù)。a.(若有)配置項(xiàng)設(shè)計(jì)決策，諸如(如果以前未選)要使用的算法；b.軟件配置項(xiàng)設(shè)計(jì)中的約束、限制或非常規(guī)特征；c.如果要使用的編程語(yǔ)言不同于該CSCI所指定的語(yǔ)言.應(yīng)該指出，并說(shuō)明使用它的理由；d.如果軟件配置項(xiàng)由過(guò)程式命令組成或包含過(guò)程式命令(如數(shù)據(jù)庫(kù)管理系統(tǒng)(DBMS)中用

17、于定義表單與報(bào)表的菜單選擇、用于數(shù)據(jù)庫(kù)訪問(wèn)與操縱的聯(lián)機(jī)DBMS查詢、用于自動(dòng)代碼生成的圖形用戶接口(GUI)構(gòu)造器的輸入、操作系統(tǒng)的命令或shell腳本)，應(yīng)有過(guò)程式命令列表和解釋它們的用戶手冊(cè)或其他文檔的引用； e.如果軟件配置項(xiàng)包含、接收或輸出數(shù)據(jù)，(若適用)應(yīng)有對(duì)其輸入、輸出和其他數(shù)據(jù)元素以及數(shù)據(jù)元素集合體的說(shuō)明。(若適用)本文的4.5.x提供要包含主題的列表。軟件配置項(xiàng)的局部數(shù)據(jù)應(yīng)與軟件配置項(xiàng)的輸入或輸出數(shù)據(jù)分開來(lái)描述。如果該軟件配置項(xiàng)是一個(gè)數(shù)據(jù)庫(kù)，應(yīng)引用相應(yīng)的數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說(shuō)明(DBDD)；接口特性可在此處提供，也可引用本文第4章或相應(yīng)接口設(shè)計(jì)說(shuō)明。f.如果軟件配置項(xiàng)包含邏輯，給出其要使用的邏輯，(若適用)包括： 1)該軟件配置項(xiàng)執(zhí)行啟動(dòng)時(shí)，其內(nèi)部起作用的條件； 2)把控制交給其他軟件配置項(xiàng)的條件； 3)對(duì)每個(gè)輸入的響應(yīng)及響應(yīng)時(shí)間，包括數(shù)據(jù)轉(zhuǎn)換、重命名和數(shù)據(jù)傳送操作； 4)該軟件配置項(xiàng)運(yùn)行期間的操作序列和動(dòng)態(tài)控制序列，包括： a)序列控制方法； b)該方法的邏輯與輸入條件，如計(jì)時(shí)偏差、優(yōu)先級(jí)賦值； C)數(shù)據(jù)在內(nèi)存中的進(jìn)出； d)離散輸入信號(hào)的感知，以及在