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

詳細(xì)設(shè)計(jì)說明書有限公司

變更記錄目錄文檔介紹（標(biāo)題1、宋體、三號、加粗） 錯誤！未定義書簽。TOC\o"1-5"\h\z文檔目的（標(biāo)題 2、宋體、小三、加粗） 1文檔范圍 1\o"CurrentDocument"讀者對象 1\o"CurrentDocument"參考文獻(xiàn) 11.5.術(shù)語與縮寫解釋 錯誤！未定義書簽。\o"CurrentDocument"1.6. 原型圖例說明 2\o"CurrentDocument"1.7. 系統(tǒng)設(shè)計(jì)編號規(guī)則 2\o"CurrentDocument"1.7.1.功能點(diǎn)編號規(guī)則 21.7.2.表格中的項(xiàng)目編號規(guī)則 2\o"CurrentDocument"系統(tǒng)概述 3\o"CurrentDocument"設(shè)計(jì)約束 3\o"CurrentDocument"設(shè)計(jì)策略 3\o"CurrentDocument"系統(tǒng)總體結(jié)構(gòu) 4\o"CurrentDocument"模塊命名規(guī)則 4\o"CurrentDocument"模塊匯總表 4\o"CurrentDocument"子系統(tǒng)總體設(shè)計(jì) 5\o"CurrentDocument"FUNC_01子系統(tǒng)英文簡稱：子系統(tǒng)1名稱 5數(shù)據(jù)模型（標(biāo)題3、宋體、四號、加粗） 5模塊關(guān)系圖 5\o"CurrentDocument"FUNC_02子系統(tǒng)英文簡稱：子系統(tǒng)2名稱 5\o"CurrentDocument"數(shù)據(jù)模型 5模塊關(guān)系圖 6\o"CurrentDocument"子系統(tǒng)模塊詳細(xì)設(shè)計(jì) 6\o"CurrentDocument"FUNC_XXMW功能塊 6\o"CurrentDocument"FUNC_XXMW_XX功能分類 6\o"CurrentDocument"開發(fā)環(huán)境的配置 8\o"CurrentDocument"運(yùn)行環(huán)境的配置 9\o"CurrentDocument"測試環(huán)境的配置 91前言1.1.文檔目的提示：描述文檔目的（正文，宋體，五號，非加粗）1.2.文檔范1.2.文檔范提示：描述文檔適用的業(yè)務(wù)范疇讀者對象提示：文檔的使用對象提示：描述文檔適用的業(yè)務(wù)范疇讀者對象提示：文檔的使用對象參考文獻(xiàn)提示：列出本文檔的所有參考文獻(xiàn)（可以是非正式出版物），格式如下[標(biāo)識符]作者，文獻(xiàn)名稱，出版單位（或歸屬單位），日期例如：[AAA]作者，《立項(xiàng)建議書》，機(jī)構(gòu)名稱，日期[SPP-PROC-SD]SEPG，系統(tǒng)設(shè)計(jì)規(guī)范，機(jī)構(gòu)名稱，日期名稱術(shù)語提示：文檔中所有表格字體統(tǒng)一為宋體、小五、非加粗原型圖說明提示：設(shè)計(jì)原型的工具不做統(tǒng)一規(guī)定，但是一個系統(tǒng)的原型圖例樣式、界面風(fēng)格要保持一致，要在此章節(jié)進(jìn)行必要的約定和說明。系統(tǒng)設(shè)計(jì)編號規(guī)則1.7.1.功能點(diǎn)編號規(guī)則子系統(tǒng)1：FUNC_01子系統(tǒng)英文簡稱功能模塊1.1：FUNC_01子系統(tǒng)英文簡稱_01功能點(diǎn)1.1.1：FUNC_01子系統(tǒng)英文簡稱_0101子系統(tǒng)2：FUNC_02子系統(tǒng)英文簡稱1.7.2.表格中的項(xiàng)目編號規(guī)則1）第一級a）第二級b）第二級i.第三級ii.第三級2）第一級提示：（1）盡量避免在出現(xiàn)三級和三級以上的項(xiàng)目編號；（2）如果各項(xiàng)目編號之間有先后關(guān)系，在項(xiàng)目編號后加上步驟1，步驟2的描述。但是建議在操作序列一欄中用流程圖表示，文字說明只是做補(bǔ)充。（3）不要試圖用大段的文字來描述復(fù)雜的程序處理流程。（4）如果要分別說明不同業(yè)務(wù)處理的業(yè)務(wù)規(guī)則或者操作序列建議用以下編號規(guī)則：業(yè)務(wù)處理11） 第一級步驟12） 第一級步驟2系統(tǒng)概述提示：（1）說明本系統(tǒng)“是什么”，（2）描述本系統(tǒng)的主要功能。2.1設(shè)計(jì)約束提示：（1）需求約束。體系結(jié)構(gòu)設(shè)計(jì)人員從需求文檔（如《用戶需求說明書》和《軟件需求規(guī)格說明書》）中提取需求約束，例如：本系統(tǒng)應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)或規(guī)范軟件、硬件環(huán)境（包括運(yùn)行環(huán)境和開發(fā)環(huán)境）的約束接口/協(xié)議的約束用戶界面的約束軟件質(zhì)量的約束，如正確性、健壯性、可靠性、效率（性能）、易用性、清晰性、安全性、可擴(kuò)展性、兼容性、可移植性等等。（2）隱含約束。有一些假設(shè)或依賴并沒有在需求文檔中明確指出，但可能會對系統(tǒng)設(shè)計(jì)產(chǎn)生影響，設(shè)計(jì)人員應(yīng)當(dāng)盡可能地在此處說明。例如對用戶教育程度、計(jì)算機(jī)技能的一些假設(shè)或依賴，對支撐本系統(tǒng)的軟件硬件的假設(shè)或依賴等。2.2設(shè)計(jì)策略提示：體系結(jié)構(gòu)設(shè)計(jì)人員根據(jù)產(chǎn)品的需求與發(fā)展戰(zhàn)略，確定設(shè)計(jì)策略。例如：擴(kuò)展策略。說明為了方便本系統(tǒng)在將來擴(kuò)展功能，現(xiàn)在有什么措施復(fù)用策略。說明本系統(tǒng)在當(dāng)前以及將來的復(fù)用策略。折衷策略。說明當(dāng)兩個目標(biāo)難以同時優(yōu)化時如何折衷，例如“時－空”效率折衷，復(fù)雜性與實(shí)用性折衷。2.3系統(tǒng)總體結(jié)構(gòu)提示：將系統(tǒng)分解為若干子系統(tǒng)，繪制物理圖和邏輯圖，說明各子系統(tǒng)的主要功能。說明“如何”以及“為什么”(howandwhy)如此分解系統(tǒng)。說明各子系統(tǒng)如何協(xié)調(diào)工作，從而實(shí)現(xiàn)原系統(tǒng)的功能。可參考《軟件需求規(guī)格說明書》中的系統(tǒng)總體結(jié)構(gòu)圖，對前者功能的細(xì)化，從不同的角度描述系統(tǒng)總體結(jié)構(gòu)2.4模塊命名規(guī)則提示：模塊設(shè)計(jì)人員確定本軟件的模塊命名規(guī)則(例如類、函數(shù)、變量等)，確保模塊設(shè)計(jì)文檔的風(fēng)格與代碼的風(fēng)格保持一致?？梢詮臋C(jī)構(gòu)的編程規(guī)范中摘取或引用(如果存在的話)。2.5模塊匯總表提示：(1)這里的模塊是指相對獨(dú)立的軟件設(shè)計(jì)單元，將整個軟件系統(tǒng)先分成幾個相對獨(dú)立的子系統(tǒng)，再將各子系統(tǒng)劃分不同的功能模塊以及小的功能點(diǎn)。(2)子系統(tǒng)的劃分可參考《軟件需求規(guī)格說明書》中業(yè)務(wù)項(xiàng)的劃分FUNC_O1子系統(tǒng)英文簡稱：子系統(tǒng)1名稱模塊名稱功能簡述FUNC_O1子系統(tǒng)英文簡稱_01FUNC_02子系統(tǒng)英文簡稱：子系統(tǒng)2名稱模塊名稱功能簡述FUNC_02子系統(tǒng)英文簡稱_01子系統(tǒng)總體設(shè)計(jì)3.1FUNC_01子系統(tǒng)英文簡稱：子系統(tǒng)1名稱3.1.1數(shù)據(jù)模型（標(biāo)題3、宋體、四號、加粗）提示：系統(tǒng)統(tǒng)一以PDM文件描述子系統(tǒng)的數(shù)據(jù)模型3.1.2模塊關(guān)系圖提示：（1）將子系統(tǒng)分解為模塊（Module），繪制邏輯圖（如果物理圖和邏輯圖不一樣的話，應(yīng)當(dāng)繪制物理圖），說明各模塊的主要功能。（2）說明“如何”以及“為什么”（howandwhy）如此分解子系統(tǒng)。（3） 說明各模塊如何協(xié)調(diào)工作，從而實(shí)現(xiàn)子系統(tǒng)的功能。3.2FUNC_02子系統(tǒng)英文簡稱：子系統(tǒng)2名稱3.2.1數(shù)據(jù)模型提示：系統(tǒng)統(tǒng)一以PDM文件描述子系統(tǒng)的數(shù)據(jù)模型，如果文件比較龐大，可以考慮只將核心表結(jié)構(gòu)展示到文檔中。3.2.2模塊關(guān)系圖提示：將子系統(tǒng)分解為模塊(Module)，繪制邏輯圖(如果物理圖和邏輯圖不一樣的話，應(yīng)當(dāng)繪制物理圖)，說明各模塊的主要功能。說明“如何”以及“為什么”(howandwhy)如此分解子系統(tǒng)。說明各模塊如何協(xié)調(diào)工作，從而實(shí)現(xiàn)子系統(tǒng)的功能。子系統(tǒng)模塊詳細(xì)設(shè)計(jì)4.1FUNC_XXMW功能塊4.1.1FUNC_XXMW_XX功能分類4.1.1.1FUNC_XXMW_XXXX功能名稱?功能概述功能描述…。?功能點(diǎn)列表功能點(diǎn)名稱描述功能點(diǎn)名稱功能點(diǎn)描述。功能規(guī)則無。規(guī)則描述無。?功能設(shè)計(jì)?功能點(diǎn)名稱

功能點(diǎn)名稱：功能點(diǎn)名稱界面原型提示：如果是前臺功能，通過visio或者其他工具繪制界面原型，如果不是前臺功能則為空。本次開發(fā)設(shè)計(jì)采用visio繪制界面原型頁面校驗(yàn)提示：通過序號方式一一闡述校驗(yàn)規(guī)則和約束*號必輸項(xiàng)、默認(rèn)登錄人等信息不在此羅列，由開發(fā)規(guī)范明確操作序列提示：可以通過流程圖方式或者文字描述業(yè)務(wù)操作的序列包括前臺操作流程和后臺處理流程圖：查詢、增加、修改、刪除、明細(xì)等具有簡單操作的按鈕不在此羅列，由開發(fā)規(guī)范明確；復(fù)雜業(yè)務(wù)需后臺處理圖依賴功能列出需要調(diào)用的模塊間的功能名稱、參數(shù)信息（接口）處理詳細(xì)描提示：對于復(fù)雜的功能，需要詳細(xì)描述的，在此處補(bǔ)充；一般情況下，操作序列為流述程圖時，此處作為詳細(xì)說明的補(bǔ)充。1.{a.b.}2.{a.b.}{c.d.

}3.具體開發(fā)中用到的方法名不用描述，只需描述處理思路，不能照搬需求規(guī)格說明書提供功能列出給其他功能提供的模塊間的功能名稱、參數(shù)信息數(shù)據(jù)操作功能描述輸入?yún)?shù)輸出參數(shù)業(yè)務(wù)規(guī)則提示：對應(yīng)功能點(diǎn)列表的功能點(diǎn)2中的子功能名稱提示：對應(yīng)功能點(diǎn)列表的功能點(diǎn)2中的子功能名稱關(guān)鍵SQL功能描述SQL語句提示：對應(yīng)功能點(diǎn)列表的功能點(diǎn)2中的子功能名稱提示：如果sql語句在功能點(diǎn)內(nèi)部還需要拆分成多個，建議以以下方式：sqll:select1fromdual;單表操作的SQL不用列出SQL語句，有需要明確的檢索條件時，在數(shù)據(jù)操作的業(yè)務(wù)規(guī)則中描述5開發(fā)環(huán)境的配置提示：說明本系統(tǒng)應(yīng)當(dāng)在什么樣的環(huán)境下開發(fā)