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

1、文檔編號(hào)： 項(xiàng)目名稱(chēng)XXXX CSCI詳細(xì)設(shè)計(jì)說(shuō)明書(shū)單位名稱(chēng)XXXX年X月修改記錄版本變更原因變更內(nèi)容簡(jiǎn)述編制/修訂者批準(zhǔn)者發(fā)布日期目錄1 范圍1.1 標(biāo)識(shí)1.2 CSCI 概述1.3 文檔概述2 引用的文檔3 CSCI 設(shè)計(jì)3.1 CSCI結(jié)構(gòu)3.2 CSCI運(yùn)行組織3.3 CSCI性能要求3.4 CSCI設(shè)計(jì)限制和約束3.5 CSCI測(cè)試計(jì)劃4 CSC 設(shè)計(jì)4.x CSC的名稱(chēng)和唯一標(biāo)識(shí)符4.x.y 下一級(jí)CSC的名稱(chēng)和唯一標(biāo)識(shí)符4.x.y.z CSU的名稱(chēng)和唯一標(biāo)識(shí)符5 CSCI數(shù)據(jù)說(shuō)明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)識(shí)符7 需求可追蹤性1 范圍1.1 標(biāo)識(shí)【系統(tǒng)背景】系統(tǒng)標(biāo)識(shí)符：（系統(tǒng)標(biāo)識(shí)符）系統(tǒng)名稱(chēng) ：（系統(tǒng)名稱(chēng)）縮寫(xiě) ：給出系統(tǒng)的縮寫(xiě)【適用的CSCI】標(biāo)識(shí)符：（CSCI標(biāo)識(shí)符）名稱(chēng) ：（CSCI名稱(chēng)）縮寫(xiě) ：給出CSCI的縮寫(xiě)1.2 CSCI 概述 【系統(tǒng)功能概述】簡(jiǎn)要描述本系統(tǒng)的功能?！綜SCI功能概述】（給出CSCI在需求規(guī)格說(shuō)明書(shū)中對(duì)應(yīng)的需求規(guī)格標(biāo)識(shí)號(hào)的引用）。如有必要可用圖示表示本CSCI在系統(tǒng)中的位置（頂層系統(tǒng)結(jié)構(gòu)圖）。1.3 文檔概述【用途】本文檔用于描述在進(jìn)行CSCI詳細(xì)設(shè)計(jì)中每個(gè)階段的設(shè)計(jì)結(jié)果，提供CSCI的詳細(xì)設(shè)計(jì)說(shuō)明書(shū)?！緝?nèi)容】本文檔的主題

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

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

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

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

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

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

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

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

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

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

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