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

1、文檔編號：項目名稱XXXX CSCI 詳細設(shè)計說明書單位名稱XXXX 年 X 月修改記錄版本變更原因變更內(nèi)容簡述編制/ 修訂 者批準者發(fā)布日 期目錄1 范圍標識CSCI 概述文檔概述2 引用的文檔3 CSCI 設(shè)計CSCI 結(jié)構(gòu)CSCI 運行組織CSCI 性能要求CSCI 設(shè)計限制和約束CSCI 測試計劃4 CSC 設(shè)計CSC 的名稱和唯一標識符下一級 CSC的名稱和唯一標識符CSU 的名稱和唯一標識符5 CSCI 數(shù)據(jù)說明CSCI 內(nèi)部數(shù)據(jù)元素CSCI 外部接口數(shù)據(jù)元素6 CSCI 數(shù)據(jù)文件CSC 和 CSU數(shù)據(jù)文件的交叉引用 數(shù)據(jù)文件名和唯一標識符7 需求可追蹤性1 范圍標識【系統(tǒng)背景】

2、系統(tǒng)標識符：（系統(tǒng)標識符） 系統(tǒng)名稱 ：（系統(tǒng)名稱） 縮寫 ：給出系統(tǒng)的縮寫【適用的 CSCI】 標識符：（CSCI標識符） 名稱 ：（CSCI名稱） 縮寫 ：給出 CSCI的縮寫CSCI 概述【系統(tǒng)功能概述】 簡要描述本系統(tǒng)的功能?！綜SCI功能概述】（給出 CSCI在需求規(guī)格說明書中對應(yīng)的需求規(guī)格標識號的引用） 。 如有必要可用圖示表示本 CSCI在系統(tǒng)中的位置（頂層系統(tǒng)結(jié)構(gòu)圖） 文檔概述【用途】CSCICSC本文檔用于描述在進行 CSCI 詳細設(shè)計中每個階段的設(shè)計結(jié)果，提供 的詳細設(shè)計說明書?！緝?nèi)容】本文檔的主題內(nèi)容如下：描述 CSCI的功能和作用；定義 CSCI 的結(jié)構(gòu)（用一組 CSC

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

4、級加 1?！靶枨蠓峙洹保悍峙浣o該 CSC的需求規(guī)格說明標識符。 【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間的接口名稱，標識符，起始 CSC和 終止 CSC的接口的其他信息。表 3 2 CSC內(nèi)部接口分配表名稱標識 符發(fā)出者 CSC 名稱接收者 CSC名稱功能接口類型相關(guān) 的過 程傳送的數(shù)據(jù)（

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

6、它 CSCI 與本 CSCI之間的一個接口的名稱和唯一的標識符。 “接口類型”：描述該接口的類型，這些類型可能是“中斷” 、“過程或方法 調(diào)用” 、“信號量”等?！皞魉偷臄?shù)據(jù)”：描述在該接口之間傳輸?shù)臄?shù)據(jù)流的名稱和類型。CSCI 運行組織使用狀態(tài)轉(zhuǎn)換圖、 活動圖、順序圖或者協(xié)作圖等描述軟件動態(tài)結(jié)構(gòu)的圖示描 述 CSCI 運行時的動態(tài)結(jié)構(gòu)?！綜SCI狀態(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)和模式的簡要的描述。表 3 4 CSCI 狀態(tài)列表狀態(tài)

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

8、CSCI運行時的硬件平臺（計算機、通訊設(shè)備、網(wǎng)絡(luò)設(shè)備和其他專用 設(shè)備等）和軟件平臺（操作系統(tǒng)、數(shù)據(jù)庫管理系統(tǒng)、第三方軟件產(chǎn)品等） ?！緲藴省恐付▽崿F(xiàn)和運行本 CSCI時采用的標準 （語言標準、 編譯器標準、 編碼標準、 通訊標準、數(shù)據(jù)格式標準、人機界面標準等）CSCI 測試計劃給出 CSCI 測試用例規(guī)格的引用說明。4 CSC 詳細設(shè)計從節(jié)開始編號，分小節(jié)描述每個 CSC的詳細設(shè)計。 （CSC的名稱和唯一標識符） 下一級 CSC的名稱和唯一標識符如果有下一級 CSC劃分，從節(jié)開始編號描述節(jié)描述的 CSC的下一級 CSC的詳 細設(shè)計。如果無下一級 CSC劃分，則略去“ y. ”，從節(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)下的行為?！綜SU分配】列表給出每個 CSU的分配。表 3 6 CSU分配表名稱唯一標識符功能需求分配其中：“需求分配”：與該 CSU相關(guān)的分配給 CSC的需求規(guī)格說明標識符CSC結(jié)構(gòu)描述】描述本 CSC的結(jié)構(gòu)和每個 CSU之間的關(guān)系、運行時的簡要流程和在設(shè)計上考 慮，用到的設(shè)計模式及其解決的問題等。【CSC結(jié)構(gòu)圖】以一組

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

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

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

13、符）從節(jié)開始編號，分節(jié)給出表 61 中給出的每個數(shù)據(jù)文件的用途、容量、訪 問方式以及文件的內(nèi)部數(shù)據(jù)格式等特性。【文件用途】描述文件在本 CSCI中起到的角色和和作用?！驹L問方式】 描述文件被訪問時的方式?！疚恢谩?給出該文件的物理位置。【安全 / 保密條件】描述文件在 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詳細設(shè)計偽代碼使用規(guī)范中的定義的相關(guān) 規(guī)范來描述。7 需求可追蹤性給出 CSCI中的軟件需求規(guī)格和接口需求規(guī)格在 CSC和 CSU中被分配的映像 關(guān)系（ CSU有可能部分參與這些需求規(guī)格） 。使用如下表示的格式：表 7 1 需求、接口規(guī)格映像