CSCI詳細(xì)設(shè)計說明書模板

1、文檔編號： 項目名稱XXXX CSCI詳細(xì)設(shè)計說明書單位名稱XXXX年X月修改記錄版本變更原因變更內(nèi)容簡述編制/修訂者批準(zhǔn)者發(fā)布日期目錄1 范圍1.1 標(biāo)識1.2 CSCI 概述1.3 文檔概述2 引用的文檔3 CSCI 設(shè)計3.1 CSCI結(jié)構(gòu)3.2 CSCI運行組織3.3 CSCI性能要求3.4 CSCI設(shè)計限制和約束3.5 CSCI測試計劃4 CSC 設(shè)計4.x CSC的名稱和唯一標(biāo)識符4.x.y 下一級CSC的名稱和唯一標(biāo)識符4.x.y.z CSU的名稱和唯一標(biāo)識符5 CSCI數(shù)據(jù)說明5.1 CSCI內(nèi)部數(shù)據(jù)元素5.2 CSCI外部接口數(shù)據(jù)元素6 CSCI數(shù)據(jù)文件6.1 CSC和CSU

2、數(shù)據(jù)文件的交叉引用6.x數(shù)據(jù)文件名和唯一標(biāo)識符7 需求可追蹤性1 范圍1.1 標(biāo)識【系統(tǒng)背景】系統(tǒng)標(biāo)識符：（系統(tǒng)標(biāo)識符）系統(tǒng)名稱 ：（系統(tǒng)名稱）縮寫 ：給出系統(tǒng)的縮寫【適用的CSCI】標(biāo)識符：（CSCI標(biāo)識符）名稱 ：（CSCI名稱）縮寫 ：給出CSCI的縮寫1.2 CSCI 概述 【系統(tǒng)功能概述】簡要描述本系統(tǒng)的功能?！綜SCI功能概述】（給出CSCI在需求規(guī)格說明書中對應(yīng)的需求規(guī)格標(biāo)識號的引用）。如有必要可用圖示表示本CSCI在系統(tǒng)中的位置（頂層系統(tǒng)結(jié)構(gòu)圖）。1.3 文檔概述【用途】本文檔用于描述在進(jìn)行CSCI詳細(xì)設(shè)計中每個階段的設(shè)計結(jié)果，提供CSCI的詳細(xì)設(shè)計說明書?！緝?nèi)容】本文檔的主題

3、內(nèi)容如下：描述CSCI的功能和作用；定義CSCI的結(jié)構(gòu)（用一組CSC，以及這些CSC之間的接口關(guān)系，定義CSC的名稱，標(biāo)示符，分配的需求集）；定義CSCI設(shè)計限制；定義CSCI資源使用設(shè)計；定義CSCI每個CSC以及CSU的詳細(xì)設(shè)計。描述每個CSC可追溯的需求規(guī)格和接口規(guī)格說明。 2 引用的文檔按下列格式列出本文檔引用到的所有文檔。 【序號】 【文檔編號】 【文檔名稱】3 （CSCI名稱）詳細(xì)設(shè)計3.1 （CSCI名稱）結(jié)構(gòu)3.1.1 （CSCI名稱） 詳細(xì)結(jié)構(gòu) 【CSC分配】列表給出每個 CSC的分配。表31 CSC分配表名稱唯一標(biāo)識符層級功能需求分配其中：“層級”：該CSC被分解的級數(shù)，如

4、果該CSC沒有子CSC則為1，否則為子CSC層級加1?！靶枨蠓峙洹保悍峙浣o該CSC的需求規(guī)格說明標(biāo)識符。 【CSCI結(jié)構(gòu)描述】 描述本CSCI的結(jié)構(gòu)CSC以及下一級CSC之間的關(guān)系、運行時的簡要流程和在設(shè)計上的考慮等。 【CSCI結(jié)構(gòu)圖】 用一組CSC描述CSCI的內(nèi)部結(jié)構(gòu)圖：給出每個CSC以及下一級CSC（如果有）和它們的接口關(guān)系（結(jié)構(gòu)筐土、類圖等）。3.1.2 （CSCI名稱）內(nèi)部接口 列表給出CSCI結(jié)構(gòu)中定義的所有CSC間的接口名稱，標(biāo)識符，起始CSC和終止CSC的接口的其他信息。表32 CSC內(nèi)部接口分配表名稱標(biāo)識符發(fā)出者CSC名稱接收者CSC名稱功能接口類型相關(guān)的過程傳送的數(shù)據(jù)（過

5、程名）（名稱：類型） 其中： “名稱”和“標(biāo)識符”：確定從“起始CSC”到“終止CSC”之間的接口名稱和唯一的標(biāo)識符。 “接口類型”：描述該接口的類型，這些類型可能是“中斷”、“過程或方法調(diào)用”、“信號量”等。 “傳送的數(shù)據(jù)”：描述在該接口之間傳輸?shù)臄?shù)據(jù)流名稱。3.1.3 （CSCI名稱）提供的外部接口與CSC內(nèi)部接口關(guān)系 列表給出CSCI結(jié)構(gòu)中定義的本CSCI于其他CSCI間的所有接口的分配。表33 CSCI外部接口分配表名稱標(biāo)識符發(fā)出者CSCI名稱接收者CSC名稱功能接口類型相關(guān)的過程傳送的數(shù)據(jù)（過程名）（名稱：類型） 其中： “名稱”和“標(biāo)識符”：給出其它CSCI 與本CSCI之間的一個

6、接口的名稱和唯一的標(biāo)識符。 “接口類型”：描述該接口的類型，這些類型可能是“中斷”、“過程或方法調(diào)用” 、“信號量”等。 “傳送的數(shù)據(jù)”：描述在該接口之間傳輸?shù)臄?shù)據(jù)流的名稱和類型。3.2 CSCI運行組織 使用狀態(tài)轉(zhuǎn)換圖、活動圖、順序圖或者協(xié)作圖等描述軟件動態(tài)結(jié)構(gòu)的圖示描述CSCI 運行時的動態(tài)結(jié)構(gòu)。 【CSCI狀態(tài)圖】同時給出CSCI的系統(tǒng)狀態(tài)圖，在圖上說明系統(tǒng)每個狀態(tài)之間轉(zhuǎn)換的條件和數(shù)據(jù)流等信息。 【CSCI狀態(tài)表】 給出本CSCI運行時所有的系統(tǒng)狀態(tài)和模式以及該狀態(tài)和模式下相關(guān)的CSC，并給出該狀態(tài)和模式的簡要的描述。表34 CSCI狀態(tài)列表狀態(tài)號狀態(tài)名稱相關(guān)CSC描述（簡要描述本狀態(tài)下

7、的信息） 其他刻畫系統(tǒng)動態(tài)結(jié)構(gòu)的圖示或說明。3.3 CSCI 性能要求 提供對于CSCI在運行時必須滿足的性能要求。例如：內(nèi)存和進(jìn)程時間（給出計算單位）要求、資源占用率或響應(yīng)時間等。 如無要求則用“無?！贝嫦卤?。表35 CSC內(nèi)存/處理時間表CSC名稱CSC標(biāo)識符性能要求3.4 （CSCI名稱）設(shè)計限制和約束 【限制條件】 給出實現(xiàn)和運行本CSCI時出現(xiàn)的硬件和軟件限制和條件（不包括運行平臺）。 【編程語言】 指定使用的編程語言。 【編譯/開發(fā)環(huán)境】 指定適用的編譯環(huán)境（編譯器、編譯環(huán)境選項、編譯依賴的各種類庫、運行庫、模板庫、其他編譯單元等）。 【運行平臺】 指定本CSCI運行時的硬件平臺

8、（計算機(jī)、通訊設(shè)備、網(wǎng)絡(luò)設(shè)備和其他專用設(shè)備等）和軟件平臺（操作系統(tǒng)、數(shù)據(jù)庫管理系統(tǒng)、第三方軟件產(chǎn)品等）。 【標(biāo)準(zhǔn)】 指定實現(xiàn)和運行本CSCI時采用的標(biāo)準(zhǔn)（語言標(biāo)準(zhǔn)、編譯器標(biāo)準(zhǔn)、編碼標(biāo)準(zhǔn)、通訊標(biāo)準(zhǔn)、數(shù)據(jù)格式標(biāo)準(zhǔn)、人機(jī)界面標(biāo)準(zhǔn)等）。3.5 CSCI測試計劃 給出CSCI 測試用例規(guī)格的引用說明。4 CSC 詳細(xì)設(shè)計 從4.1節(jié)開始編號，分小節(jié)描述每個CSC的詳細(xì)設(shè)計。4.x （CSC的名稱和唯一標(biāo)識符）4.x.y 下一級CSC的名稱和唯一標(biāo)識符 如果有下一級CSC劃分，從4.x.1節(jié)開始編號描述4.x節(jié)描述的CSC的下一級CSC的詳細(xì)設(shè)計。 如果無下一級CSC劃分，則略去“y.”，從4.x節(jié)開始編

9、號。 【定義】 給出CSC在第三章CSC 分配表中的引用說明。例如“參見CSC分配表的”。 【CSC環(huán)境和接口】 以圖示給出本CSC提供的所有接口過程的數(shù)據(jù)流格式和方向，以及與這些接口關(guān)聯(lián)的其他CSC。如有必要，給出CSC的狀態(tài)轉(zhuǎn)換圖描述CSC所能經(jīng)歷狀態(tài)和在不同狀態(tài)下的行為。 【CSU分配】 列表給出每個 CSU的分配。表36 CSU分配表名稱唯一標(biāo)識符功能需求分配其中： “需求分配”：與該CSU相關(guān)的分配給CSC的需求規(guī)格說明標(biāo)識符?！綜SC結(jié)構(gòu)描述】 描述本CSC的結(jié)構(gòu)和每個CSU之間的關(guān)系、運行時的簡要流程和在設(shè)計上考慮，用到的設(shè)計模式及其解決的問題等。 【CSC結(jié)構(gòu)圖】 以一組CSU

10、給出本CSC的內(nèi)部結(jié)構(gòu)，這些CSU為主要是對象（類）。要求給出這些CSU之間的數(shù)據(jù)流和控制流信息，并給出這些CSU引出到CSC用于完成CSC每個接口過程的那些接口。 【運行組織】 使用流程圖、活動圖、協(xié)作圖或者順序圖描述CSC運行時的任務(wù)模型和運行時刻的表示模型。 【設(shè)計限制和約束】 【限制條件】 給出實現(xiàn)和運行本CSCI時出現(xiàn)的硬件和軟件限制和條件（不包括運行平臺）。 【編程語言】 指定使用的編程語言。 【編譯/開發(fā)環(huán)境】 指定適用的編譯環(huán)境（編譯器、編譯環(huán)境選項、編譯依賴的各種類庫、運行庫、模板庫、其他編譯單元等）。【CSC測試計劃】 給出CSC具體的CSC的測試用例規(guī)格（在CSCI測試用

11、例規(guī)格中）的引用說明。4.x.y.z （CSU的名稱和唯一標(biāo)識符） 從4.x.y.1節(jié)開始編號。分節(jié)描述每個CSU的詳細(xì)設(shè)計。關(guān)于CSU的設(shè)計說明參見CSU詳細(xì)設(shè)計規(guī)格編制規(guī)范。5 （CSCI名稱）數(shù)據(jù)說明 描述CSCI的全局?jǐn)?shù)據(jù)元素。5.1 （CSCI名稱）內(nèi)部數(shù)據(jù)元素 【數(shù)據(jù)元素定義】表5.1 （CSCI名稱）全局內(nèi)部數(shù)據(jù)元素定義表名稱標(biāo)識符意義數(shù)據(jù)類型初始值度量單位值域/合法性檢查精確度精度/分辨率輸入方式/輸入媒體來源數(shù)量/頻度安全/保密條件 【數(shù)據(jù)元素結(jié)構(gòu)】給出表5.1中給出的數(shù)據(jù)類型（除使用的程序設(shè)計語言的內(nèi)部數(shù)據(jù)類型、開發(fā)編譯環(huán)境中提供的數(shù)據(jù)類型之外）的所有數(shù)據(jù)類型的定義和說明。

12、這些數(shù)據(jù)結(jié)構(gòu)采用軟件CSCI詳細(xì)設(shè)計偽代碼使用規(guī)范中的定義的相關(guān)規(guī)范來描述。5.2 （CSCI名稱）外部接口的數(shù)據(jù)元素表5.2外部接口的數(shù)據(jù)元素定義表名稱標(biāo)識符接口標(biāo)識符定義位置（給出描述本數(shù)據(jù)元素的設(shè)計文檔和章節(jié)編號）6 （CSCI名稱）數(shù)據(jù)文件6.1 CSC和CSU數(shù)據(jù)文件的交叉引用 給出每個CSCI全局?jǐn)?shù)據(jù)文件在CSC和CSU中使用的映像關(guān)系。 使用如下表所示的格式（每個數(shù)據(jù)文件占用一行）：表61 數(shù)據(jù)文件映像表文件標(biāo)識符引用文件的CSC引用文件的CSU（文件的唯一標(biāo)識符）（分格，每一格給出一個CSC）（分格，每一格給出在前面給出的CSC中的一個CSU）6.x（數(shù)據(jù)文件名和唯一標(biāo)識符）

13、從6.2節(jié)開始編號，分節(jié)給出表61中給出的每個數(shù)據(jù)文件的用途、容量、訪問方式以及文件的內(nèi)部數(shù)據(jù)格式等特性。 【文件用途】 描述文件在本CSCI中起到的角色和和作用。 【訪問方式】 描述文件被訪問時的方式。 【位置】給出該文件的物理位置。 【安全/保密條件】 描述文件在CSCI中被訪問時的權(quán)限設(shè)置、加密限制等。 【數(shù)據(jù)容量】 給出文件的尺寸和數(shù)據(jù)容量的描述。 【文件數(shù)據(jù)結(jié)構(gòu)】給出構(gòu)成文件的所有數(shù)據(jù)元素的結(jié)構(gòu)關(guān)系，并給出每個數(shù)據(jù)元素的定義和說明。 這些數(shù)據(jù)結(jié)構(gòu)采用軟件CSCI詳細(xì)設(shè)計偽代碼使用規(guī)范中的定義的相關(guān)規(guī)范來描述。7 需求可追蹤性 給出CSCI中的軟件需求規(guī)格和接口需求規(guī)格在CSC和CSU中被分配的映像關(guān)系（CSU有可能部分參與這些需求規(guī)格）。 使用如下表示的格式：