詳細設(shè)計說明書-模板

文檔作者：文檔呈送：文檔抄送：XX項目詳細設(shè)計說明書<VX.Y>編寫：審核：批準：參與評審：

變更記錄版本號變化狀態(tài)修改點說明變更人存放位置審批人審批日期*變化狀態(tài)：C――創(chuàng)建，A——增加，M——修改，D——刪除修改點說明：對變化狀態(tài)進行簡單解釋，如增加了某項功能，修改了某個模塊等信息。不允許出現(xiàn)“根據(jù)評審意見修改等字樣”注：當文檔未評審?fù)ㄟ^前版本號標識規(guī)則為V0.X,第一次評審?fù)ㄟ^后，版本號直接升級為V1.0，之后變更按照V1.X升級。

目錄TOC\o"1-3"\h\z1 前提和約束 4編寫目的 4預(yù)期讀者和閱讀建議 4定義、縮寫詞、略語 4參考資料 52 前提和約束 6前提條件 6限制和約束 63 綜合描述 63.1 系統(tǒng)目標 63.2 系統(tǒng)需求 63.3 系統(tǒng)概述 73.4 程序結(jié)構(gòu)說明 73.5 源程序及編譯鏈接組裝說明 74 系統(tǒng)詳細設(shè)計 74.1 XXX子系統(tǒng)名稱 84.1.1 XXX包名稱 94.2 XXX子系統(tǒng)名稱2 105 用戶界面詳細設(shè)計（可裁剪） 105.1 界面結(jié)構(gòu) 115.1.1 界面結(jié)構(gòu)或菜單結(jié)構(gòu) 115.1.2 用戶界面圖（如無此需要，可省略） 115.2 界面處理流程及界面約束描述（如無此需要，可省略） 115.2.1 界面或模塊名1 115.2.2 處理流程 115.2.3 界面約束與事件約束 115.2.4 觸發(fā)方式 115.2.5 界面或模塊名2 116 尚未解決的問題 127 資源對象說明 12

文檔簡介[說明]本部分要描述文檔的目的，幫助讀者對本文檔建立基本印象，并為閱讀后續(xù)內(nèi)容掃清障。藍色字體部分是文檔的說明，請各位同事在完成文檔撰寫后刪除該部分。編寫目的[說明]本部分主要闡述文檔目的，而非項目目的。否則造成同一項目多個文檔之間的內(nèi)容重復(fù)，不利于文檔維護。預(yù)期讀者和閱讀建議[說明]指定需要認真閱讀此文檔的人員。本小節(jié)應(yīng)指明文檔針對的讀者對象，最好列出各種讀者角色，并說明每種讀者角色應(yīng)該重點閱讀的章節(jié)。指明文檔組織方式，簡要描述各文檔各部分關(guān)注的內(nèi)容和解決的問題。定義、縮寫詞、略語[說明]按字母或拼音順序列出所有的定義和縮略語，以便讀者可以正確地理解《架構(gòu)設(shè)計說明書》，包括詞頭和縮寫。注意：只需要列出對理解本文有用的術(shù)語。序號術(shù)語/縮略語說明/定義英文全稱中文譯名123...參考資料[說明]列舉編寫《架構(gòu)設(shè)計說明書》時所參考的資料或其它來源。包括但不限于：用戶界面風格指導(dǎo)、合同、標準、系統(tǒng)需求規(guī)格說明書、用戶需求、相關(guān)產(chǎn)品的產(chǎn)品需求規(guī)格說明書等。可根據(jù)項目的實際情況選擇參考資料的范圍，但至少應(yīng)包括用戶需求說明書和需求分析說明書。作者文獻名稱出版單位（或歸屬單位）版本或日期

前提和約束前提條件[說明]對詳細設(shè)計工作依賴的上游文檔做說明?？墒褂帽砀窕蛭淖诌M行簡要說明，沒有的項目寫無。類別文件名稱主要依據(jù)章節(jié)及內(nèi)容是否完全依據(jù)需求是架構(gòu)是概要設(shè)計是其他前提條件是特殊情況說明：限制和約束[說明]闡述應(yīng)遵循的重要限制和約束，包括技術(shù)條件、軟硬件條件、功能、性能目標約束等。綜合描述系統(tǒng)目標[說明]系統(tǒng)最終要解決的實際問題或要達到的用戶要求，系統(tǒng)如何能夠做到客戶滿意。系統(tǒng)需求[說明]系統(tǒng)由上游文檔規(guī)定的需求的簡要說明。說明本系統(tǒng)，本文檔涵蓋的需求及功能實現(xiàn)部分。系統(tǒng)概述[說明]簡述系統(tǒng)功能，映射詳細設(shè)計的基礎(chǔ)輪廓。用系統(tǒng)結(jié)構(gòu)圖表示系統(tǒng)內(nèi)的包和主要類的名稱、標識符和它們之間的層次結(jié)構(gòu)關(guān)系，可以以系統(tǒng)體系結(jié)構(gòu)劃分，也可以由類類別劃分(邊界類、控制類、助手類、實體類、數(shù)據(jù)類)，甚至可以由功能結(jié)構(gòu)劃分。程序結(jié)構(gòu)說明[說明]結(jié)合上游文件中的邏輯視圖，描述最終的程序劃分、結(jié)構(gòu)圖及功能與調(diào)用關(guān)系簡要說明、程序種類說明。本節(jié)為以下詳細設(shè)計的簡要索引，為系統(tǒng)程序的上層結(jié)構(gòu)體系描述。詳細設(shè)計時可能得不到精確的最終程序文件名列表，但是應(yīng)當盡量完整說明其種類和主要文件內(nèi)容。建議使用UML圖配合文字說明。源程序及編譯鏈接組裝說明[說明]結(jié)合上游文件中的物理視圖，本處為源程序和前一節(jié)的最終程序如函數(shù)庫、可執(zhí)行程序、資源文件等的對照表，以及從源程序文件轉(zhuǎn)化成這些最終文件的具體過程（編譯、鏈接、組裝）描述。在詳細設(shè)計時可能得不到精確的源程序文件名，但是應(yīng)當盡量完整說明其種類和主要文件內(nèi)容。如果不同的文件具有不同的編譯鏈接組裝方式，則應(yīng)在此處分別描述清楚。在此處應(yīng)明確分出各級編譯單元，即哪些文件需要一起編譯生成一個或一組編譯后的文件。編譯單元文件可以是最終文件也可以是源程序和最終文件之間的中間文件。建議使用UML圖配合文字說明。系統(tǒng)詳細設(shè)計[說明]系統(tǒng)詳細設(shè)計應(yīng)當以3.4節(jié)程序結(jié)構(gòu)說明節(jié)內(nèi)容為索引，而不是3.5節(jié)源程序及編譯鏈接組裝說明，換句話說，應(yīng)當以最終的物理功能實現(xiàn)（邏輯視圖）為主線索，源程序的結(jié)構(gòu)（物理視圖）作為輔線索，結(jié)合數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)視圖）進行存儲設(shè)計，結(jié)合模塊間交互（運行視圖）。編寫原則為公用的，重要的，接口類的程序段，應(yīng)當盡量組織在文檔前部，以示聲明。功能性的可以放在文檔偏后的位置，如果使用公共模塊應(yīng)當標明引用章節(jié)位置。建議在設(shè)計時做好公共模塊的封裝和組織。如：在說明公共函數(shù)所在的動態(tài)鏈接庫時，如果動態(tài)鏈接庫只有一個，而會被三個其他程序調(diào)用，應(yīng)當先描述本動態(tài)鏈接庫，說明動態(tài)鏈接庫的詳細設(shè)計，其他程序調(diào)用時說明引用地址，并列出源程序與函數(shù)的對照表。如果遇到概要設(shè)計中沒有寫明的邏輯問題，則應(yīng)通知概要設(shè)計人員及時討論并變更概要設(shè)計。本章描述重點是程序段（面向?qū)ο笾蟹Q作類中的方法或在面向過程中稱為函數(shù)）。在描述程序段過程中兼顧數(shù)據(jù)，流程，結(jié)構(gòu)等內(nèi)容。菜單級別組織：參考上游文檔中五視圖的劃分，建議如下劃分詳細設(shè)計內(nèi)容對系統(tǒng)模塊的劃分可按以下兩種方式進行：方式一按系統(tǒng)的層級進行分解，每個層機中分別描述模塊的功能及交互數(shù)據(jù)等內(nèi)容，如：4.1系統(tǒng)第一層分解描述4.1,1系統(tǒng)第二層分解4.1.1.1系統(tǒng)第三層分解4.1.1.1.1函數(shù)名稱1方式二先劃分子系統(tǒng)再劃分包，再劃分類，最后至方法：4.1子系統(tǒng)4.1.1包定義4.1.1.1類定義4.1.1.1.1方法名稱1以下以方式二為例說明：菜單層級可以根據(jù)項目大小變化，方法或函數(shù)內(nèi)的內(nèi)容框架應(yīng)當按照模板進行描述。本處無文字。XXX子系統(tǒng)名稱[說明]子系統(tǒng)描述，參考上游文件進行描述。說明子系統(tǒng)的功能。建議使用UML包圖描述并附加說明。需概括說明可以被其他系統(tǒng)調(diào)用接口，及需要調(diào)用其他接口情況。如果較多可以使用列表說明。XXX包名稱[說明]說明本包的功能，作用，劃分依據(jù)，包內(nèi)類的相互關(guān)系及其他包相關(guān)內(nèi)容。建議使用UML類圖并并附加說明。需概括說明可以被其他包調(diào)用接口，及需要調(diào)用其他包的情況。如果較多可以使用列表說明。XXX類名稱[說明]說明本類的功能，作用，劃分依據(jù)，類內(nèi)各個函數(shù)的相互關(guān)系及其他包相關(guān)內(nèi)容。需說明可以被其他類調(diào)用接口，及需要調(diào)用其他類的情況。如果較多可以使用列表說明。XXXXX函數(shù)或方法名稱1方法特征描述[說明]<可在此描述其調(diào)用形式，如：intGetNum(intiNum1,charcCha1);>功能性能描述[說明]<方法所完成的功能，如果有明確的性能指標分配，應(yīng)當也在此注明。該章節(jié)將作為單元測試的輸入>輸入/輸出項[說明]<如果是函數(shù)則說明：輸入?yún)?shù)、輸出參數(shù)、返回值，以及函數(shù)的處理對象在處理前和處理后的狀態(tài)。如果是其它形式的處理單元，則描述相應(yīng)的輸入輸出形式和內(nèi)容。如果輸入輸出需要某種條件觸發(fā)，需明確描述輸入輸出項的發(fā)生條件。異常拋出算做輸出>數(shù)據(jù)結(jié)構(gòu)說明[說明]<公共變量，內(nèi)存數(shù)據(jù)結(jié)構(gòu)，存取的數(shù)據(jù)庫表和字段，存取機制說明。>調(diào)用關(guān)系[說明]<本處描述調(diào)用和被調(diào)用關(guān)系，本方法被哪個或哪些實體主調(diào)，被調(diào)用或被觸發(fā)方式；另外本方法調(diào)用的可執(zhí)行程序公共函數(shù)庫或函數(shù)，以及調(diào)用或觸發(fā)方式。>算法[說明]<上述因素的具體邏輯關(guān)系精確描述，如內(nèi)存數(shù)據(jù)結(jié)構(gòu)的初始化公式，計算公式等，數(shù)據(jù)庫表及字段與內(nèi)存變量的對應(yīng)等。建議使用UML圖并附上說明>程序邏輯流程圖[說明]<從程序出發(fā)，描述程序功能和算法的的邏輯流程圖，建議使用UML圖并附上說明>XXX子系統(tǒng)名稱2[說明]<下一級章節(jié)如4.1.>。。。用戶界面詳細設(shè)計<因為用戶界面雖然也屬于程序功能的一部分，但是多數(shù)系統(tǒng)的用戶界面較為復(fù)雜和瑣碎，需要將其與后臺處理分開設(shè)計，包括數(shù)據(jù)庫表設(shè)計。用戶界面是作為外部接口的一部分體現(xiàn)在概要設(shè)計中的。本章著重設(shè)計用戶界面的外觀要素和界面處理流程，以及主要的界面級和界面事件級的約束。控制臺程序可以以文字說明，WEB或窗口程序建議以圖片說明。本處無文字。>界面結(jié)構(gòu)界面結(jié)構(gòu)或菜單結(jié)構(gòu)基本框架框架結(jié)構(gòu)描述Container“container“就是將頁面中的所有元素包在一起的部分，這部分還可以命名為:“wrapper“,“wrap“,“page“.Header“header”是頁面的頭部區(qū)域，一般來講，它包含網(wǎng)站的logo和一些其他元素。這部分還可以命名為:“header”(或pageHeader).Navbar“navbar“等同于橫向的導(dǎo)航欄，是最典型的網(wǎng)頁元素。這部分還可以命名為:“nav”,“navigation”,“nav-wrapper”.Menu“Menu”區(qū)域包含一般的鏈接和菜單，這部分還可以命名為:“subNav“,“l(fā)inks“，“sidebar-main”.Main“Main”是網(wǎng)頁的主要區(qū)域，所有業(yè)務(wù)的處理區(qū)域。這部分還可以命名為:“content“,“main-content”(或“mainContent”)。Footer“Footer”包含附加信息如軟件的開發(fā)商信息或軟件版本發(fā)布信息，這部分還可以命名為:“copyright“界面設(shè)計及模塊分析界面設(shè)計采用CSS+DIV重構(gòu)界面。將界面數(shù)據(jù)表現(xiàn)和樣式分離，提高頁面瀏覽速度，不使用TABLE。提供頁面信息交互。提供操作結(jié)果確認在提交數(shù)據(jù)，或是載有數(shù)據(jù)的頁面關(guān)閉，或其他需要和用戶進行確認交互的場景，需要軟件能夠提供一個以彈出頁面形式，要求用戶確認執(zhí)行結(jié)果的對話框，例如：提示確認輸入信息正確：彈出對話框，并將已填寫的內(nèi)容列出，要求用戶確認內(nèi)容的正確性，給出“確定”和“取消”的選擇按鈕；與正在進行的操作無關(guān)的按鈕應(yīng)該加以屏蔽，例如：按鈕背景為灰色顯示；對可能造成數(shù)據(jù)無法恢復(fù)的操作必須提供確認信息，給用戶放棄選擇的機會；非法的輸入或操作應(yīng)有足夠的提示說明；對運行過程中出現(xiàn)問題而引起錯誤的地方要有提示，讓用戶明白錯誤出處，避免形成無限期的等待；頁面信息提示在web頁面提供的功能中，很多情況需要系統(tǒng)發(fā)送一些必要的提示信息到頁面顯示給用戶，這些信息的分類有：警告信息、禁止信息、操作執(zhí)行成功信息、操作執(zhí)行失敗信息、錯誤信息、提示信息。這些信息在當前頁面或彈出頁面上顯示。如果采用彈出對話框的形式，對話框的頁面結(jié)構(gòu)如下圖：標題區(qū)：簡要給出此次提示信息的性質(zhì)，例如：提示：確認提交！圖標區(qū)：給出和