軟件設計說明書編寫規(guī)范

1、軟件設計說明書編寫規(guī)范目錄軟件設計說明書編寫規(guī)范11、 編寫目的22、 應用文檔23、 要求及內(nèi)容22.2 編寫格式要求22.3 說明書內(nèi)容22.3.3 說明書目的22.3.4 參考資料及文檔22.3.5 設計原則32.3.6 接口描述42.3.7 功能描述42.3.8 接口協(xié)議52.3.9 編程協(xié)定52.3.10 數(shù)據(jù)結(jié)構(gòu)62.3.11 邏輯結(jié)構(gòu)62.3.12 程序流程62.3.13 源文件列表82.3.14 其他92.4 文檔修訂歷史94、 編寫文檔注意事項95、 樣例及模板文檔9編寫目的項目主管或軟件工程師根據(jù)軟件需求說明書，對程序系統(tǒng)的設計考慮，包括程序系統(tǒng)的基本處理流程、程序系統(tǒng)的組

2、織結(jié)構(gòu)、模塊劃分、功能分配、接口設計。運行設計、數(shù)據(jù)結(jié)構(gòu)設計和出錯處理設計等，需編寫軟件設計說明書，本文檔供項目主管和軟件工程師遵循用戶需求規(guī)格說明書（見用戶需求規(guī)格說明書編寫規(guī)范）如何編寫軟件設計說明書所編寫的規(guī)范。二、應用文檔本文在編寫時所應用到下列文件：文檔編排格式規(guī)范軟件需求規(guī)格說明書UML時序圖規(guī)范說明書三、要求及內(nèi)容2） 編寫格式要求在編寫軟件設計說明書時，對封面、正文、字體及編號應參考文檔編排格式規(guī)范約定的格式對封面、正文、字體、大綱及編號進行編寫。2） 說明書內(nèi)容2） 說明書目的軟件設計說明書又可稱系統(tǒng)設計或程序設計，這里所說的系統(tǒng)是指程序系統(tǒng)。編制的目的是說明對程序系統(tǒng)的設計

3、考慮，包括程序系統(tǒng)的基本處理流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設計。運行設計、數(shù)據(jù)結(jié)構(gòu)設計和出錯處理設計等；更詳細設計說明是將一個軟件系統(tǒng)各個層次中的每一個程序（每個模塊或子程序）的設計考慮，此時可對程序較為詳細設計，如果一個軟件系統(tǒng)比較簡單，層次很少，可直接編寫系統(tǒng)設計，本說明書可供軟件設計師、項目主管及測試人員使用。2） 參考資料及文檔列出編寫本說明書時參考的文件（如經(jīng)核準的計劃任務書或合同、上級機關的批文等)、資料、技術標準，以及他們的作者、標題、編號、發(fā)布日期和出版單位等。2） 設計原則2.2,3,1界面設計原則設計大體遵循以下原則：A.界面簡潔大方B.附有詳細的說明C

4、.遵循用戶的操作習慣D.具有指引性E.色調(diào)協(xié)調(diào)數(shù)據(jù)結(jié)構(gòu)設計原則設計大體遵循以下原則：A.每個數(shù)據(jù)表都設有主鍵，做為流水號，放在第一字段；字段名使用中文字段命名。B.字段類型使用字符型，整形，浮點型，時間型及二進制型。C.只使用數(shù)據(jù)庫的存儲功能，數(shù)據(jù)表間的關系以程序邏輯實現(xiàn)控制。程序結(jié)構(gòu)設計原則程序結(jié)構(gòu)設計，對軟件程序做出一個劃分，應根據(jù)具體情況不同，做出不同的調(diào)整,程序結(jié)構(gòu)設計過程中，經(jīng)常用到的程序結(jié)構(gòu)劃分方式包括：A.根據(jù)功能劃分B.根據(jù)技術劃分C.根據(jù)程序借口劃分D.程序結(jié)構(gòu)劃分應大體遵循以下原則：應以用戶為中心劃分圍繞中心問題劃分符合結(jié)構(gòu)清晰，層次簡明的原則2.2.3.4框圖、UML協(xié)作

5、圖和UML時序圖程序需包含系統(tǒng)結(jié)構(gòu)框圖，較為復雜時應提供相應的UML協(xié)作圖（見UML時序圖規(guī)范說明書）。在涉及到復雜方法體時應引用程序員為方法或過程編寫的UML時序圖。接口才苗述軟件模塊分配A.數(shù)據(jù)處理軟件模塊；數(shù)據(jù)處理軟件模塊是整個軟件的基礎，為整個軟件提供分析數(shù)據(jù)，其接口要求如下表：此處加入接口要求表B.數(shù)據(jù)分析軟件模塊；分析軟件模塊包括電能、電壓、電量、諧波4個模塊，是整個軟件的功能實現(xiàn)，實現(xiàn)軟件的分析功能，其接口要求分別如表1,表2,表3,表4及表5:此處加入表說明：表5是xxxxxx.C.報表軟件模塊；報表軟件模塊是為整用戶提供報表功能，其接口要求如下表：此處加入接口要求表D.主界面

6、軟件模塊；主界面軟件模塊是整個軟件的總控，為軟件的各個模塊提供接口，其接口要求如下表：此處加入接口要求表由于上表較長，表中分為3部分，表中第2部分說明為：xxxxxxxxxxxxx模塊之間的關系此處加入模塊之間的關系功育的函述A.功能說明此處加入功能說明B.功能框圖此處加入功能框圖C.時順圖復雜功能可用UML時序圖（見UML時序圖規(guī)范說明書）表示。接口協(xié)議此處加入接口協(xié)議編程協(xié)定A.操作系統(tǒng)windowsNT操作系統(tǒng)，或windows98操作系統(tǒng).B.編程工具Delphi7.0編程工具，由于該軟件工具具有可視化編程，對象化處理的優(yōu)點，利于我們快速完成編程工作，減少編程BUG,提高工作效率，降低

7、開發(fā)成本；因此，我們確定使用該軟件為軟件的主界面，分析，及報表功能的開發(fā)平臺。VC+編程工具，由于該軟件具有編程深度高，實現(xiàn)靈活，有利于完成我們軟件中的入庫程序。另外，根據(jù)本軟件的特點：xxxxxxxxxxxxxC.編輯、調(diào)試、聯(lián)接程序此處加入編輯、調(diào)試、聯(lián)接程序D.編譯工具此處加入編譯工具E.模擬、仿真數(shù)據(jù)模擬數(shù)據(jù)使用過去的真實數(shù)據(jù)，數(shù)據(jù)如下：此處加入數(shù)據(jù)過程、方法如下：此處加入過程、方法F.診斷、測試程序此處加入診斷、測試程序G.檢測程序此處加入檢測程序2.2.8數(shù)據(jù)結(jié)構(gòu)A.物理結(jié)構(gòu)此處加入物理結(jié)構(gòu)B.庫結(jié)構(gòu)此處加入庫結(jié)構(gòu)C.鏈路結(jié)構(gòu)此處加入鏈路結(jié)構(gòu)D.表結(jié)構(gòu)此處加入表結(jié)構(gòu)E.內(nèi)部存貯區(qū)分

8、配此處加入內(nèi)部存貯區(qū)分配2.2.9邏輯結(jié)構(gòu)A.常量定義此處加入常量定義B.變量定義此處加入變量定義C.結(jié)構(gòu)定義此處加入結(jié)構(gòu)定義D.全局定義此處加入全局定義2.2.10程序流程A.主程序1)功能此處加入功能入口參數(shù)此處加入入口參數(shù)出口參數(shù)此處加入出口參數(shù)4）局部變量此處加入局部變量5）函數(shù)調(diào)用此處加入函數(shù)調(diào)用6）對象調(diào)用此處加入對象調(diào)用7）流程圖此處加入流程圖UML時序圖（見UML時序圖規(guī)范說明書）僅用于復雜程序流程，一般可用流程圖表示即可。B.子程序1）功能此處加入功能入口參數(shù)此處加入入口參數(shù)出口參數(shù)此處加入出口參數(shù)4）局部變量此處加入局部變量5）函數(shù)調(diào)用此處加入函數(shù)調(diào)用6）流程圖此處加入流程圖UML時序圖或協(xié)作圖（見UML時序圖規(guī)范說明書）僅用于復雜程序流程，一般可用流程圖表示即可。C.信息及通訊1）信息類型此處加入信息類型2）信息等級此處加入信息等級3）功能此處加入功能入口參數(shù)此處加入入口參數(shù)出口參數(shù)此處加入出口參數(shù)6）局部變量此處加入局部變量7）隊列此處加入隊列8）流程圖此處加入流程圖D.對象1）功能此處加入功能入口參數(shù)此處加入入口參數(shù)出口參數(shù)此處加入出口參數(shù)4）變量（私有，公有，重載等）此處加入變量函數(shù)此處加入函數(shù)6）屬性此處加入屬性7）流程圖此處加入流程圖2.2.11源文件列表此處加入源文