詳細(xì)設(shè)計(jì)說明書(公司內(nèi)部使用)

僅供內(nèi)部使用XX產(chǎn)品系列XX模塊(版本號)詳細(xì)設(shè)計(jì)說明書編制審批

目錄1. 簡介 31.1. 編寫目的 31.2. 背景 31.3. 術(shù)語和縮寫 31.4. 參考資料 32. 模塊說明 32.1. 模塊描述 32.2. 框架流程及功能描述 32.3. 算法邏輯 32.4. 資源消耗 32.5. 未解決問題 43. 接口定義 43.1. 外部接口 43.2. 內(nèi)部函數(shù)接口 44. 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 44.1. 邏輯結(jié)構(gòu) 44.2. 物理結(jié)構(gòu) 44.3. 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 45. 特殊處理 45.1. 初始化處理 45.2. 異常處理 55.3. Debug模式 56. 修訂記錄 5

簡介編寫目的說明編寫這份詳細(xì)設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。背景待開發(fā)軟件模塊的名稱。術(shù)語和縮寫術(shù)語/縮寫含義參考資料模塊說明模塊描述模塊編號，需參考概要設(shè)計(jì)中的編號。對模塊的功能、性能和接口需求描述?？蚣芰鞒碳肮δ苊枋鲈敿?xì)描述模塊框架中各單元的功能設(shè)計(jì)和對應(yīng)的函數(shù)劃分?？刹捎肐PO圖，序列圖。算法邏輯清晰說明關(guān)鍵算法或邏輯，包括算法及實(shí)現(xiàn)細(xì)節(jié)，控制邏輯的各種分支情況，數(shù)據(jù)的流向等?？墒褂昧鞒虉D、PDL語言等進(jìn)行分析。資源消耗詳細(xì)說明該模塊需要系統(tǒng)分配的各種資源，如內(nèi)存、線程、文件句柄等。未解決問題說明在詳細(xì)設(shè)計(jì)過程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問題。接口定義外部接口詳細(xì)說明本模塊與上層系統(tǒng)的接口詳細(xì)定義，包括函數(shù)名及傳遞參數(shù)等。內(nèi)部函數(shù)接口說明本模塊內(nèi)部各函數(shù)之間的接口定義，包括函數(shù)名及傳遞參數(shù)等。數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)邏輯結(jié)構(gòu)給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識、定義、長度及它們之間的層次的或表格的相互關(guān)系。物理結(jié)構(gòu)給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲要求，訪問方法、存取單位、存取的物理關(guān)系（索引、設(shè)備、存取區(qū)域）、設(shè)計(jì)考慮和保密條件。數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系說明各個(gè)應(yīng)用程序與訪問這些數(shù)據(jù)結(jié)構(gòu)的各個(gè)函數(shù)之間的對應(yīng)關(guān)系，可采用如下的矩陣圖的形式：相關(guān)模塊數(shù)據(jù)結(jié)構(gòu)1函數(shù)1、函數(shù)2…數(shù)據(jù)結(jié)