軟件詳細(xì)設(shè)計(jì)說(shuō)明模板-包設(shè)計(jì)版

1、軟件詳細(xì)設(shè)計(jì)說(shuō)明V4.0-1XX-XXX-XX標(biāo)記數(shù)量修改單號(hào)簽字日期編制XXXX會(huì)簽軟件詳細(xì)設(shè)計(jì)說(shuō)明校對(duì)XXXX標(biāo)檢XXXX共11頁(yè)第1頁(yè)審核批準(zhǔn)XXXX中國(guó)船舶工業(yè)系統(tǒng)工程研究院會(huì)簽XXXXGr002.6C軟件詳細(xì)設(shè)計(jì)說(shuō)明修訂記錄版本號(hào)修訂狀態(tài)簡(jiǎn)要說(shuō)明修訂內(nèi)容和范圍修訂日期修訂人批準(zhǔn)日期注：修訂記錄在體系文件發(fā)布后換版時(shí)使用，修訂狀態(tài)欄填寫：A增加，MH修改,D刪除5目次1范圍21.1標(biāo)識(shí)21.2系統(tǒng)概述21.3文檔概述22引用文檔23 CSCI詳細(xì)設(shè)計(jì) 23.1 XX包（包唯一標(biāo)識(shí)）23.1.1 類匯總表23.2執(zhí)行方案63.2.1 XX 功能/業(yè)務(wù) 63.3數(shù)據(jù)庫(kù)表設(shè)計(jì)（可選） 64需

2、求可追蹤性75注釋7圖序圖1 XX包內(nèi)類關(guān)系圖3圖2 XX類活動(dòng)圖5圖3 XX時(shí)序圖6表1XX包內(nèi)類匯總表3表2軟件內(nèi)部接口表3表3類變量/數(shù)據(jù)說(shuō)明表4表4 類操作描述表 4表5所用算法5表6 數(shù)據(jù)庫(kù)表結(jié)構(gòu) 7表7 需求追蹤表（正向） 7表8 需求追蹤表（逆向） 7Gr002.6C軟件詳細(xì)設(shè)計(jì)說(shuō)明1范圍1.1 標(biāo)識(shí)本條應(yīng)描述本文檔所適用系統(tǒng)和軟件的完整標(biāo)識(shí)，適用時(shí)，包括其標(biāo)識(shí)號(hào)、名 稱、縮略名、版本號(hào)和發(fā)布號(hào)。簡(jiǎn)要說(shuō)明軟件的標(biāo)識(shí)號(hào)、發(fā)布號(hào)、名稱、縮略名、版本號(hào)。a）軟件標(biāo)識(shí)號(hào)：b）發(fā)布號(hào)：V01c）名稱：d）縮略名：e）版本號(hào)：V1.01.2 系統(tǒng)概述本條應(yīng)概述本文檔所適用系統(tǒng)和軟件的用途。分

3、別簡(jiǎn)要說(shuō)明系統(tǒng)的用途、軟件用途標(biāo)識(shí)需方、用戶、開(kāi)發(fā)方等。a）需方：b）用戶：c）開(kāi)發(fā)方：1.3 文檔概述本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求。2引用文檔本章應(yīng)列出引用文檔的編號(hào)、標(biāo)題、編寫單位、修訂版及日期，還應(yīng)標(biāo)識(shí)不能 通過(guò)正常采購(gòu)活動(dòng)得到的文檔的來(lái)源。示例：a）文檔名稱1，編號(hào)（若有），編寫單位，版本（若有），日期；b）文檔名稱2，編號(hào)（若有），編寫單位，版本（若有），日期。3 CSCI詳細(xì)設(shè)計(jì)設(shè)計(jì)人員確定軟部件/包命名規(guī)則，確保軟件設(shè)計(jì)文檔的風(fēng)格與代碼的風(fēng)格保持 一致。可以從機(jī)構(gòu)的編程規(guī)范中摘取或引用（如果存在的話）。另外，描述類的開(kāi)發(fā)類型，包括新研、改進(jìn)

4、、安全重用、采購(gòu)等。詳細(xì)說(shuō)明類的具體信息。3.1 XX包（包唯一標(biāo)識(shí)）詳細(xì)描述CSCI包/組件的功能。3.1.1 類匯總表表1XX包內(nèi)類匯總表序號(hào)標(biāo)識(shí)名稱說(shuō)明開(kāi)發(fā)類型123.1.1.1 類關(guān)系圖畫出該包的所有類圖，類只寫類名稱，不寫具體變量和操作。a.tsc&E* sesiderMtiwic:XMt:Ztrmc:Stride二 tur:rtcri"<creatc 1Eirfis 1圖1 XX包內(nèi)類關(guān)系圖3.1.1.2 類內(nèi)部接口設(shè)計(jì)表2 軟件內(nèi)部接口表序 號(hào)接口名稱接口標(biāo)識(shí)接口提供者接口使用者類關(guān)系1XXXPAK2 PAK1*01Pak1Pak223.1.1.3 類的唯

5、一標(biāo)識(shí)（XX類）本包/組件詳細(xì)描述的類列表如所示序號(hào)類標(biāo)識(shí)類名稱備注1.2.3.注釋:1.軟件項(xiàng)目負(fù)責(zé)人根據(jù)項(xiàng)目實(shí)際情況，選擇主要的類進(jìn)行詳細(xì)描述。類列表中的類需進(jìn)行 跟蹤。2該列表中至少包含概要設(shè)計(jì)中的類3.1.131類說(shuō)明給出該類的簡(jiǎn)要描述。3.1.1.3.2 類數(shù)據(jù)對(duì)類變量/數(shù)據(jù)進(jìn)行說(shuō)明。表3類變量/數(shù)據(jù)說(shuō)明表數(shù)據(jù)名稱標(biāo)識(shí)可見(jiàn)性數(shù)據(jù)類型數(shù)據(jù)說(shuō)明發(fā)送業(yè)務(wù)信 息界面m_form_se ndl nfoprivate3.1.1.3.3 類操作描述類的具體操作函數(shù)，對(duì)函數(shù)輸入輸出參數(shù)進(jìn)行說(shuō)明，對(duì)函數(shù)處理過(guò)程可以采用活動(dòng)圖的方式進(jìn)行描述。表4類操作描述表序號(hào)操作標(biāo)識(shí)操作名稱可見(jiàn)性功能描述4.lnit

6、_Ywxx_lnterface初始化業(yè)務(wù)信息查詢 界面private顯示業(yè)務(wù)信息查詢界面控件5.6.7.注釋：使用者可以根據(jù)習(xí)慣選擇使用3.1.1.331章節(jié)形式（建議邏輯流程復(fù)雜，活動(dòng)圖較多時(shí)使用）或者3.1.1.3.3.2章節(jié)表格形式（建議邏輯流程簡(jiǎn)單，活動(dòng)圖較少或者不需要使用活動(dòng)圖描述時(shí)使用）對(duì)類的操作進(jìn)行描述。3.1.1.3.3.1 操作標(biāo)識(shí)（操作名稱）a）數(shù)據(jù)元素對(duì)該操作的輸入、輸出參數(shù)進(jìn)行定義和描述。如此內(nèi)容已在前面描述可在此引 用或省略。b）邏輯流程（可選）以活動(dòng)圖的形式對(duì)該操作的順序、動(dòng)態(tài)控制序列，異常與錯(cuò)誤處理等內(nèi)容進(jìn)行 描述。9$F接收目標(biāo)伯忌按收導(dǎo)航倍息.接收解球命眷圖2

7、 XX類活動(dòng)圖C）所用算法表5所用算法d）其它設(shè)計(jì)如有需要，給出類設(shè)計(jì)中的約束、限制或非常規(guī)特征；要使用的規(guī)定CSCI語(yǔ)言之外的編程語(yǔ)言和它的使用原理等。3.1.133.2表6 函數(shù)描述表函數(shù)定義返回值函數(shù)名稱（參數(shù)）所屬接口名稱接口標(biāo)識(shí)簡(jiǎn)單描述描述一下這個(gè)函數(shù)的功能和作用。參數(shù)說(shuō)明名稱in/out類型簡(jiǎn)短描述參數(shù)名 稱填寫 in （輸 入）或 者out（輸類型描述參數(shù)的相關(guān)說(shuō)明，可以包括數(shù)據(jù)值的有效范 圍，輸出的形式、數(shù)里和頻度，輸出媒體、對(duì)輸 出圖形及符號(hào)的說(shuō)明、安全保密條件等等。若是 數(shù)據(jù)結(jié)構(gòu)類型，則在 4.1.6中描述。出）返回值示例：true:配置站位成功； false:配置站位失敗

8、。邏輯流程 （可選）以活動(dòng)圖的形式對(duì)該操作的順序、動(dòng)態(tài)控制序列，異常與錯(cuò)誤處理等內(nèi)容進(jìn) 行描述。算法描述對(duì)使用的算法進(jìn)行簡(jiǎn)單描述，包括輸入、輸出及算法本身。其它設(shè)計(jì)如有需要，給出類設(shè)計(jì)中的約束、限制或非常規(guī)特征；要使用的規(guī)定CSCI語(yǔ)言之外的編程語(yǔ)言和它的使用原理等。3.2 執(zhí)行方案必須覆蓋需求中的業(yè)務(wù)流程3.2.1 XX功能/業(yè)務(wù)3.2.1.1 實(shí)現(xiàn)流程圖3 XX時(shí)序圖3.2.1.2 流程說(shuō)明對(duì)序列圖配以適當(dāng)?shù)奈淖终f(shuō)明。3.2.1.3 補(bǔ)充說(shuō)明（可選）對(duì)復(fù)雜的流程附以活動(dòng)圖進(jìn)行詳細(xì)說(shuō)明。3.3 數(shù)據(jù)庫(kù)表設(shè)計(jì)（可選）若是有數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明或者在概要設(shè)計(jì)文檔中已說(shuō)明，則本節(jié)可選。示例:表7數(shù)據(jù)庫(kù)表結(jié)構(gòu)序 號(hào)字段名稱字段標(biāo)識(shí)字段類型長(zhǎng)度主鍵外鍵非空注釋1是/否是/否是/否默認(rèn)值等24需求可追蹤性表8 需求追蹤表（正向）軟件詳細(xì)設(shè)計(jì)說(shuō)明軟件概要設(shè)計(jì)說(shuō)