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

密 級(jí)：內(nèi)部公開文檔編號(hào)：NTT_SD_XXSJSMS版本號(hào)：V1.0詳細(xì)設(shè)計(jì)說明書惠州市新中新電子技術(shù)開發(fā)有限公司編制：xx生效日期：審核：xx批準(zhǔn)：惠州市新中新電子技術(shù)開發(fā)有限公司對(duì)本文件資料享受著作權(quán)及其它專

屬權(quán)利，未經(jīng)書面許可，不得將該等文件資料（其全部或任何部分）披露予

任何第三方，或進(jìn)行修改后使用。

TOC\o"1-5"\h\z\o"CurrentDocument"1引言 4\o"CurrentDocument"1.1編寫目的 4\o"CurrentDocument"1.2背景 4\o"CurrentDocument"1.3術(shù)語定義 4\o"CurrentDocument"1.4參考資料 4\o"CurrentDocument"2綜合描述 5\o"CurrentDocument"2.1系統(tǒng)目標(biāo) 5\o"CurrentDocument"2.2系統(tǒng)概述 5\o"CurrentDocument"2.3運(yùn)行環(huán)境 5\o"CurrentDocument"2.4程序結(jié)構(gòu)說明 5\o"CurrentDocument"2.5源程序及編譯鏈接組裝說明 6\o"CurrentDocument"3系統(tǒng)詳細(xì)設(shè)計(jì) 73.1子系統(tǒng)名稱1 7\o"CurrentDocument"3.1.1程序名稱1 7\o"CurrentDocument"3.1.2程序名稱2 9\o"CurrentDocument"4用戶界面詳細(xì)設(shè)計(jì) 114.1界面結(jié)構(gòu) 114.1.1界面結(jié)構(gòu)或菜單結(jié)構(gòu) 114.1.2用戶界面圖 114.1.3用戶界面與模塊關(guān)系表 11\o"CurrentDocument"4.2界面處理流程及界面約束描述 12\o"CurrentDocument"4.2.1界面或模塊名1 12\o"CurrentDocument"4.2.2界面或模塊名2 121引言1.1編寫目的依照需求規(guī)格說明書和概要設(shè)計(jì)說明書，在本文檔中詳盡說明軟件的詳細(xì)設(shè)計(jì)，包括修正或者發(fā)行版本號(hào)，以便于編程。如果這個(gè)軟件詳細(xì)設(shè)計(jì)只與整個(gè)系統(tǒng)的一部分有關(guān)系，那么只敘述文檔中說明的部分或子系統(tǒng)。為系統(tǒng)編碼提供依據(jù)。1.2背景說明：這份文檔所描述的軟件系統(tǒng)的名稱；該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計(jì)算中心。1.3術(shù)語定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列舉編寫軟件詳細(xì)設(shè)計(jì)說明書時(shí)所直接參考的資料或其他資源?？赡馨ㄓ脩艚缑骘L(fēng)格指導(dǎo)、合同、標(biāo)準(zhǔn)、系統(tǒng)需求規(guī)格說明、使用實(shí)例文檔或相關(guān)軟件需求規(guī)格說明、概要設(shè)計(jì)說明等。在這里，最好給出詳細(xì)的信息，包括標(biāo)題名稱、作者、版本號(hào)、日期、出版單位或資料來源，以便于讀者查閱這些文獻(xiàn)。2綜合描述2.1系統(tǒng)目標(biāo)系統(tǒng)最終要解決的實(shí)際問題或要達(dá)到的用戶要求，系統(tǒng)如何能夠做到客戶、、壬*滿意。2.2系統(tǒng)概述簡述系統(tǒng)功能，映射詳細(xì)設(shè)計(jì)的基礎(chǔ)輪廓；2.3運(yùn)行環(huán)境描述軟件的運(yùn)行環(huán)境，包括硬件平臺(tái)、操作系統(tǒng)和版本，還有其他軟件組件或與其共存的應(yīng)用程序。如與概要設(shè)計(jì)說明中一致，可注明參照概要設(shè)計(jì)說明，如果概要設(shè)計(jì)中描述的運(yùn)行環(huán)境較為概括無法明確程序的具體分布和運(yùn)行方式，須在本處詳細(xì)說明運(yùn)行環(huán)境，以便能明確程序的具體分布和運(yùn)行。體系結(jié)構(gòu)說明。2.4程序結(jié)構(gòu)說明最終的程序分布圖及說明（可執(zhí)行程序、自己開發(fā)的動(dòng)態(tài)鏈接庫、自己開發(fā)的靜態(tài)鏈接庫、數(shù)據(jù)配置文件、資源文件等最終程序包中包含的程序文件，并非源程序結(jié)構(gòu)）、結(jié)構(gòu)圖及功能與調(diào)用關(guān)系簡要說明、程序種類說明。本節(jié)為以下詳細(xì)設(shè)計(jì)的簡要索引，為系統(tǒng)程序的上層結(jié)構(gòu)體系描述。詳細(xì)設(shè)計(jì)時(shí)可能得不到精確的最終程序文件名列表，但是應(yīng)當(dāng)盡量完整說明其種類和主要文件內(nèi)容，在程序編碼結(jié)束前應(yīng)將本節(jié)補(bǔ)齊，如果在開發(fā)過程中設(shè)計(jì)發(fā)生變化，本節(jié)也應(yīng)當(dāng)做相應(yīng)變更。2.5源程序及編譯鏈接組裝說明本處為源程序和前一節(jié)的最終程序如函數(shù)庫、可執(zhí)行程序、資源文件等的對(duì)照表，以及從源程序文件轉(zhuǎn)化成這些最終文件的具體過程（編譯、鏈接、組裝）描述。在詳細(xì)設(shè)計(jì)時(shí)可能得不到精確的源程序文件名，但是應(yīng)當(dāng)盡量完整說明其種類和主要文件內(nèi)容，在程序編碼結(jié)束前應(yīng)將本節(jié)補(bǔ)齊，如果在開發(fā)過程中設(shè)計(jì)發(fā)生變化，本節(jié)也應(yīng)當(dāng)做相應(yīng)變更。如果不同的文件具有不同的編譯鏈接組裝方式，則應(yīng)在此處分別描述清楚。在此處應(yīng)明確分出各級(jí)編譯單元，即哪些文件需要一起編譯生成一個(gè)或一組編譯后的文件。編譯單元文件可以是最終文件也可以是源程序和最終文件之間的中間文件。因?yàn)樵闯绦蚪Y(jié)構(gòu)以及編譯鏈接組裝方式可能在程序開發(fā)后期才能定出，本節(jié)可以獨(dú)立成冊(cè)，但須與前一節(jié)保持一致。本處應(yīng)注明參見哪個(gè)文件。3系統(tǒng)詳細(xì)設(shè)計(jì)系統(tǒng)詳細(xì)設(shè)計(jì)應(yīng)當(dāng)以2.4節(jié)內(nèi)容為索引，而不是2.5節(jié)，換句話說，應(yīng)當(dāng)以最終的物理功能實(shí)現(xiàn)為主線索，源程序的結(jié)構(gòu)作為輔線索。如：在說明公共函數(shù)所在的動(dòng)態(tài)鏈接庫時(shí)，如果動(dòng)態(tài)鏈接庫只有一個(gè)，而對(duì)應(yīng)的源程序有三個(gè)，應(yīng)當(dāng)先在下面某節(jié)描述本動(dòng)態(tài)鏈接庫，說明動(dòng)態(tài)鏈接庫的詳細(xì)設(shè)計(jì)，然后在動(dòng)態(tài)鏈接庫的詳細(xì)設(shè)計(jì)中說明它的源程序構(gòu)成，并列出源程序與函數(shù)的對(duì)照表。如果某一源程序僅包含公共變量或約定等信息，而且這些內(nèi)容已經(jīng)在其它地方說明，則此處也應(yīng)注明，作為索引。在本節(jié)的下一層描述函數(shù)詳細(xì)設(shè)計(jì)。如果遇到概要設(shè)計(jì)中沒有寫明的邏輯問題，則應(yīng)通知概要設(shè)計(jì)人員及時(shí)討論并變更概要設(shè)計(jì)。如果源程序和最終程序的對(duì)應(yīng)關(guān)系不能確定，則可略去此關(guān)系說明，直接在下一層描述函數(shù)詳細(xì)設(shè)計(jì)。如果系統(tǒng)很大可以按照第2章第4節(jié)的索引將本章分解成若干子文件描述，每份描述子系統(tǒng)的文件可以直接按本章的章節(jié)描述，也可以加進(jìn)第2節(jié)的章節(jié)進(jìn)一步描述子系統(tǒng)的綜述部分，子系統(tǒng)設(shè)計(jì)文件均重新編章節(jié)序號(hào)，分出的子系統(tǒng)的設(shè)計(jì)文件需要在本章各節(jié)注明并詳細(xì)描述接口。本處無文字。3.1子系統(tǒng)名稱13.1.1程序名稱13.1.1.1程序特征描述程序名稱1表示的是什么類型，如可執(zhí)行程序、動(dòng)態(tài)鏈接庫、函數(shù)、成員函數(shù)子過程等，如果是物理文件名如：可執(zhí)行程序，可以在此描述它的來源。如果是函數(shù)，則可在此描述其調(diào)用形式，如：intGetNum(intiNum1,charcChal);3.1.1.2程序功能性能描述程序名稱1所完成的功能，如果有明確的性能指標(biāo)分配，應(yīng)當(dāng)也在此注明。3.1.1.3輸入/輸出項(xiàng)如果是函數(shù)則說明：輸入?yún)?shù)、輸出參數(shù)、返回值，以及函數(shù)的處理對(duì)象在處理前和處理后的狀態(tài)。如果是其它形式的處理單元，則描述相應(yīng)的輸入輸出形式和內(nèi)容。如果輸入輸出需要某種條件觸發(fā)，需明確描述輸入輸出項(xiàng)的發(fā)生條件。如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.1.4數(shù)據(jù)結(jié)構(gòu)說明公共變量，內(nèi)存數(shù)據(jù)結(jié)構(gòu)，存取的數(shù)據(jù)庫表和字段，存取機(jī)制說明。如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。涉及的表結(jié)構(gòu)以及字段說明。3.1.1.5接口定義本處描述調(diào)用和被調(diào)用關(guān)系，本程序名稱1代表的實(shí)體被哪個(gè)或哪些實(shí)體主調(diào)，被調(diào)用或被觸發(fā)方式；另外本實(shí)體調(diào)用的可執(zhí)行程序公共函數(shù)庫或函數(shù)，以及調(diào)用或觸發(fā)方式。3.1.1.6算法上述因素的具體邏輯關(guān)系精確描述，如內(nèi)存數(shù)據(jù)結(jié)構(gòu)的初始化公式，計(jì)算公式等，數(shù)據(jù)庫表及字段與內(nèi)存變量的對(duì)應(yīng)等。如果在功能中可以嚴(yán)格描述上述因素的邏輯關(guān)系，如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.1.7程序邏輯流程圖從程序出發(fā)，描述程序功能和算法的的邏輯流程圖，如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.1.8測試要點(diǎn)列出本程序?qū)嶓w的測試要點(diǎn)，表明本實(shí)體能做到什么，不能做到什么，為編寫單元測試用例和組裝測試用例提供依據(jù)，組裝測試用例主要以接口部分的設(shè)計(jì)和測試要點(diǎn)為依據(jù)。3.1.2程序名稱23.1.2.1程序特征描述程序名稱1表示的是什么類型，如可執(zhí)行程序、動(dòng)態(tài)鏈接庫、函數(shù)、成員函數(shù)子過程等，如果是物理文件名如：可執(zhí)行程序，可以在此描述它的來源。如果是函數(shù)，則可在此描述其調(diào)用形式，如：intGetNum(intiNum1,charcChal);3.1.2.2程序功能性能描述程序名稱1所完成的功能，如果有明確的性能指標(biāo)分配，應(yīng)當(dāng)也在此注明。3.1.2.3輸入/輸出項(xiàng)如果是函數(shù)則說明：輸入?yún)?shù)、輸出參數(shù)、返回值，以及函數(shù)的處理對(duì)象在處理前和處理后的狀態(tài)。如果是其它形式的處理單元，則描述相應(yīng)的輸入輸出形式和內(nèi)容。如果輸入輸出需要某種條件觸發(fā)，需明確描述輸入輸出項(xiàng)的發(fā)生條件。如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.2.4數(shù)據(jù)結(jié)構(gòu)說明公共變量，內(nèi)存數(shù)據(jù)結(jié)構(gòu)，存取的數(shù)據(jù)庫表和字段，存取機(jī)制說明。如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。涉及的表結(jié)構(gòu)以及字段說明。3.1.2.5接口定義本處描述調(diào)用和被調(diào)用關(guān)系，本程序名稱1代表的實(shí)體被哪個(gè)或哪些實(shí)體主調(diào)，被調(diào)用或被觸發(fā)方式；另外本實(shí)體調(diào)用的可執(zhí)行程序公共函數(shù)庫或函數(shù)，以及調(diào)用或觸發(fā)方式。3.1.2.6算法上述因素的具體邏輯關(guān)系精確描述，如內(nèi)存數(shù)據(jù)結(jié)構(gòu)的初始化公式，計(jì)算公式等，數(shù)據(jù)庫表及字段與內(nèi)存變量的對(duì)應(yīng)等。如果在功能中可以嚴(yán)格描述上述因素的邏輯關(guān)系，如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.2.7程序邏輯流程圖從程序出發(fā)，描述程序功能和算法的的邏輯流程圖，如本程序名稱代表的實(shí)體是一個(gè)無算法的實(shí)體如字體資源文件，則本節(jié)可略。3.1.2.8測試要點(diǎn)列出本程序?qū)嶓w的測試要點(diǎn)，表明本實(shí)體能做到什么，不能做到什么，為編寫單元測試用例和組裝測試用例提供依據(jù)，組裝測試用例主要以接口部分的設(shè)計(jì)和測試要點(diǎn)為依據(jù)。4用戶界面詳細(xì)設(shè)計(jì)因?yàn)橛脩艚缑骐m然也屬于程序功能的一部分，但是多數(shù)系統(tǒng)的用戶界面較為復(fù)雜和瑣碎，需要將其與后臺(tái)處理分開設(shè)計(jì)，包括數(shù)據(jù)庫表設(shè)計(jì)。用戶界面是作為外部接口的一部分體現(xiàn)在概要設(shè)計(jì)中的。本章著重設(shè)計(jì)用戶界面的外觀要素和界面處理流程，以及主要的界面級(jí)和界面事件級(jí)的約束。本章可以單獨(dú)成冊(cè)，也可以融在前一章說明。本處無文字。4.1界面結(jié)構(gòu)4.1.1界面結(jié)構(gòu)或菜單結(jié)構(gòu)在本處描述界面的結(jié)構(gòu)，可以以樹形結(jié)構(gòu)的形式描述，并加以說明。也可以以其它方式。4.1.2用戶界面圖以上述結(jié)構(gòu)為索引描述每個(gè)用戶界面，可以用工具畫出，在此處說明其編號(hào)。如果界面較為明確也可以略去本節(jié)。4.1.3用戶界面與模塊關(guān)系表用戶界面名稱用戶界面編號(hào)隸屬的子系統(tǒng)相