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

時間：2023-06-05 20:54:02 | 來源：網(wǎng)站運營

時間：2023-06-05 20:54:02 來源：網(wǎng)站運營

詳細(xì)設(shè)計說明書：

1 引言

1.1 編寫目的

［編寫說明］簡要地說明設(shè)計的目的。

1.2 范圍

［編寫說明］

簡要說明本系統(tǒng)的實現(xiàn)細(xì)節(jié)，不包括概要設(shè)計部分, 也不包括系統(tǒng)中硬件的設(shè)計。例如：

1. 細(xì)化模塊的詳細(xì)劃分。

2. 確定系統(tǒng)的命名規(guī)則（模塊、類、方法等），確保系統(tǒng)的設(shè)計風(fēng)格與代碼的風(fēng)格一致。

3. 定義模塊間接口方法命名標(biāo)準(zhǔn)、入?yún)⒏袷?、返回格式?br>
4. 規(guī)定編碼規(guī)范及其他設(shè)計約束。

5. 確定底層類實現(xiàn)所采用的技術(shù)框架。

6. 確定選取表現(xiàn)層的技術(shù)，及其展示的統(tǒng)一風(fēng)格。

…

指明本文檔的讀者。

1.3 術(shù)語

［編寫說明］

列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組及說明。可以援引概要設(shè)計說明書中的相關(guān)說明，或省略。

縮寫、術(shù)語	說明

1.4 參考資料

［編寫說明］

列出編寫本說明書時參考的文件(如經(jīng)核準(zhǔn)的工作任務(wù)說明書或合同等)、資料、技術(shù)標(biāo)準(zhǔn)，以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位?？梢栽乓O(shè)計說明書中的相關(guān)說明，或省略。

1.5 約定

［編寫說明］

說明本文件中版式編排、特殊字體及標(biāo)記等相關(guān)約定。

2 模塊設(shè)計

［編寫說明］

對《概要設(shè)計說明書》所定義的每一個模塊進行詳細(xì)說明。

2.1 模塊1

2.1.1 描述

［編寫說明］

對模塊進行描述，包括模塊ID，模塊名稱（如文件名稱等），實現(xiàn)的功能等。

2.1.2 用戶界面

［編寫說明］

對有用戶界面的模塊，描繪模塊的操作界面圖，并進行界面單元功能描述。

2.1.3 類設(shè)計

［編寫說明］

如果本模塊有類，說明為了實現(xiàn)本模塊功能需要使用到的類的描述。

2.1.3.1 類圖

［編寫說明］

圖示本模塊及相關(guān)模塊的類圖。

2.1.3.2 類1（名稱）

1. 屬性1：名稱及描述

2. 屬性2：名稱及描述

3. …

4. 方法1：名稱、功能描述、參數(shù)描述、返回值描述、方法結(jié)構(gòu)、方法算法描述

5. 方法2

6. …

2.1.3.3 類2

參照類1方式進行描述。

2.1.4 處理流程

［編寫說明］

采用流程圖（時序圖、協(xié)作圖等）、文字、表格等形式描述模塊的全部處理流程，說明相關(guān)的數(shù)據(jù)流，條件，入口和出口等信息。

2.1.5 關(guān)聯(lián)模塊

［編寫說明］

說明為了實現(xiàn)本功能需要調(diào)用的其它模塊、類或方法。

2.1.6 其他程序設(shè)計

［編寫說明］

如果本模塊有諸如腳本語言等程序設(shè)計，參照如下方式描述。

［裁剪說明］

根據(jù)項目實際情況，可以裁剪。

2.1.6.1 程序之間的關(guān)系

［編寫說明］

可以以圖示、表格、文字等形式說明程序之間及與相關(guān)類的關(guān)系。

2.1.6.2 程序1

1. 程序名稱

2. 功能描述

3. 算法描述

2.1.6.3 程序2

［編寫說明］

參照程序的方式進行描述。

2.1.7 相關(guān)的數(shù)據(jù)表

［編寫說明］

本模塊如引用數(shù)據(jù)表說明相關(guān)數(shù)據(jù)表的名稱等信息。本模塊如引用存儲過程、視圖等數(shù)據(jù)庫對象及其他數(shù)據(jù)結(jié)構(gòu)等，可以參照數(shù)據(jù)表的描述方式進行描述。

2.2 模塊2

參照模塊1的方式進行編寫，以此類推。

3 接口設(shè)計

［編寫說明］

對《概要設(shè)計說明書》中定義的接口進行細(xì)化，接口描述應(yīng)包含以下一些內(nèi)容：

1. 用途

說明接口的功能。

2. 輸入

說明調(diào)用該接口需要輸入哪些數(shù)據(jù)。

3. 參數(shù)、數(shù)據(jù)格式

說明調(diào)用本接口需要的參數(shù)，并詳細(xì)描述參數(shù)的具體格式。

4. 通訊協(xié)議

指出采用的通訊協(xié)議。

5. 輸出

說明調(diào)用本接口后的結(jié)果。

6. 異常情況處理

描述使用該項界面數(shù)據(jù)過程中，若出現(xiàn)異常情況的話，如何處置。

4 配置文件說明

［編寫說明］

本系統(tǒng)如有配置文件，描述配置文件格式和配置方法

5 非功能性需求設(shè)計

［編寫說明］

針對《概要設(shè)計說明書》中定義的非功能性需求，包括安全性、性能、日志、自管理等進行具體設(shè)計。

6 附錄