系統(tǒng)設(shè)計文檔編寫規(guī)范及示例

1、*系統(tǒng)系統(tǒng)設(shè)計文檔*系統(tǒng)設(shè)計小組組長：*組員：* * * *目 錄1 引 言11.1編寫目的11.2背景11.3定義11.4參考資料12 系統(tǒng)功能設(shè)計32.1 功能模塊設(shè)計32.2 *模塊設(shè)計32.3 *模塊設(shè)計33 類設(shè)計44 數(shù)據(jù)庫設(shè)計65 接口及過程設(shè)計76 界面設(shè)計87 其它設(shè)計128 小 結(jié)13說明：l 在進行系統(tǒng)設(shè)計時可以任意傳統(tǒng)系統(tǒng)設(shè)計方法或面向?qū)ο笙到y(tǒng)設(shè)計方法，或者兩者相結(jié)合，不局限于使用一種方法。l 文檔中每章圖都需要配有相應(yīng)的文字解釋。l 本文檔中的圖按照章編號，如“1 引言”表示第一章，“1.1 編寫目的”表示第一章第一節(jié)。第一章第一個圖標號為“圖1.1 *圖”，而第二個

2、圖標號為“圖1.2 *圖”，寫在圖的下面，居中。l 本文檔中的表也按照章編號，第一章第一個表標號為“表1.1 *表”，而第二個表標號為“表1.2 *表”，寫在表的上面，居中。l 使用visio畫用例時，Actor及用例的圖示模具（用例圖模具.vss）可以到BB平臺下載。1 引 言1.1編寫目的說明編寫這份系統(tǒng)設(shè)計說明書的目的，指出預(yù)期的讀者。1.2背景說明：a 待開發(fā)的軟件系統(tǒng)的名稱；b 列出此項目的任務(wù)提出者、開發(fā)者、用戶以及將運行該軟件的計算站（中心）。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4參考資料列出用得著的參考資料，如：a 本項目的經(jīng)核準的計劃任務(wù)書

3、或合同、上級機關(guān)的批文；b 屬于本項目的其他已發(fā)表的文件；c 本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標準。 列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2 系統(tǒng)功能設(shè)計2.1 功能模塊設(shè)計根據(jù)分析工作進行系統(tǒng)的功能分配，畫出系統(tǒng)的功能模塊圖（如果使用面向?qū)ο笙到y(tǒng)設(shè)計方法，可以畫包圖）。功能層次圖示例：圖 2.1 功能模塊圖2.2 *模塊設(shè)計列出該模塊及該模塊所包含的每個子模塊的功能。*子模塊：包含。等功能。*子模塊：包含。等功能。2.3 *模塊設(shè)計。3 類設(shè)計說明：l 如果使用面向?qū)ο笙到y(tǒng)設(shè)計方法，需要進行類設(shè)計。l 此部分內(nèi)容不是必須的

4、。盡可能列出所設(shè)計出的類及其之間的關(guān)系，如果類比較多，可以按照第2章所設(shè)計的模塊（或包）分別畫類圖。示例如下：示例1：網(wǎng)上商店系統(tǒng)中登錄模塊的類圖如圖3.1所示。圖3.1 系統(tǒng)登錄模塊類圖示例2：數(shù)據(jù)上傳模塊類圖如圖3.2所示。圖3.2 違章數(shù)據(jù)上傳模塊類圖4 數(shù)據(jù)庫設(shè)計說明：l 如果使用面向?qū)ο笮枨蠓治龇椒?，需要建立對?關(guān)系模型。l 此部分內(nèi)容不是必須的。根據(jù)系統(tǒng)需求分析結(jié)果盡量畫出E-R圖（E-R圖不是必須的），并根據(jù)這些工作設(shè)計出實現(xiàn)系統(tǒng)功能所需要的數(shù)據(jù)庫表的結(jié)構(gòu)。并以表格的形式盡可能列出每一個數(shù)據(jù)庫表的表結(jié)構(gòu)，即字段名、類型、長度、小數(shù)位數(shù)、是否主鍵、索引、是否允許為空、說明等。介紹

5、表與表之間的邏輯關(guān)系。示例：系統(tǒng)中數(shù)據(jù)庫包括如下各表如表4.1所示。表4.1 系統(tǒng)數(shù)據(jù)庫表序號表名(英文)說明1Trialorgan試驗檢測機構(gòu)綜合情況表2Personinfo試驗檢測人員基本信息表3Trialinfo試驗基本信息表4Purchaseapply設(shè)備購置申請表5Redeploy設(shè)備調(diào)撥表（1）試驗檢測機構(gòu)綜合情況表(TrialOrgan)用來存儲試驗室機構(gòu)綜合的基本情況，如表4.2所示。表4.2 實驗檢測機構(gòu)綜合情況表Table 4.2 TrialOrgan屬性(英文)類型主鍵外鍵空值屬性(中文)T_itemidIntYes記錄IDT_nodeidchar(6)NoNoNo機構(gòu)編

6、號T_namevarChar（80）機構(gòu)名稱T_organkindvarChar(20)結(jié)構(gòu)性質(zhì)T_addressvarChar(100)Yes聯(lián)系地址5 接口及過程設(shè)計針對2.1所設(shè)計的模塊，盡可能畫出每個模塊的IPO表。示例如下：IPO表主要說明了銷售管理模塊各個文件的輸入、輸出數(shù)據(jù)流及輸入到輸出的中間處理過程。銷售管理模塊每個文件的主要功能的IPO表如表5.1所示。表5.1銷售管理模塊IPO表子模塊名稱I(輸入)P(處理)O(輸出)單位信息維護用戶輸入單位信息將用戶輸入的單位信息存儲到數(shù)據(jù)庫中在工程信息維護中顯示供用戶選擇工程信息維護用戶輸入工程信息將用戶輸入的工程信息存儲到數(shù)據(jù)庫中在合

7、同信息維護中供用戶選擇。6 界面設(shè)計說明：l 一般情況下，一個較大的功能模塊會包含多個界面，針對每個功能模塊列出界面的轉(zhuǎn)換關(guān)系；l 列出主界面以及幾個典型界面的界面設(shè)計結(jié)果。界面轉(zhuǎn)換關(guān)系示例如下：進入銷售管理模塊后，可以通過主界面左側(cè)的導航進入到各個子模塊，每個子模塊文件之間的跳轉(zhuǎn)與包含關(guān)系如圖6.1所示。圖中沒有連線的文件之間是相互獨立的。圖4.1 銷售管理模塊跳轉(zhuǎn)與包含關(guān)系圖界面設(shè)計結(jié)果示例如下：系統(tǒng)采用多文檔窗體結(jié)構(gòu)，如圖4.2所示，在主窗體上分為菜單欄、通用工具欄、導航欄、操作工具欄和工作窗口區(qū)五個部分。不同喜好風格的用戶可以根據(jù)自己的使用風格使用這個系統(tǒng)。菜單和通用工具欄同普通系統(tǒng)一

8、樣，提供了系統(tǒng)的全部操作功能的接口；導航欄使用了非常直觀的樹視圖結(jié)構(gòu)，整個功能一幕了然，在樹視圖中包含部門列表和小組列表，查看、維護部門和小組信息非常方便。圖圖4.2 主窗口界面圖(2) 工作窗口中大量使用表格結(jié)構(gòu)顯示數(shù)據(jù)，這樣設(shè)計使窗口裝載的信息量大，便于用戶的瀏覽多條信息；對于字段數(shù)量較多的表格，選擇右鍵彈出菜單中的“查看詳細信息”選項（或雙擊要查看的信息條目）將彈出這個條目的詳細信息選項卡，如圖4.3所示，用戶可以很直觀的查看條目的詳細信息。圖4.3 員工基本信息卡片窗口(3) 統(tǒng)一的操作工具欄，對于每個可以轉(zhuǎn)載數(shù)據(jù)信息的窗體，都使用由主窗體提供的統(tǒng)一的操作工具欄來進行數(shù)據(jù)信息的瀏覽和維

9、護操作，系統(tǒng)將首先根據(jù)是哪個數(shù)據(jù)窗體的請求來選擇相應(yīng)的操作。例如，在圖4.3中，可以通過點擊操作工具欄中的“首條”、“”上條、“下條”、“尾條”按鈕來移動當前記錄；用戶可以通過點擊“查詢”按鈕來彈出相應(yīng)的查詢窗口，如在此時將彈出查詢員工信息窗體，供用戶操作；可以通過點擊“添加”按鈕來彈出相應(yīng)的添加窗口；可以通過點擊“修改”按鈕來修改相應(yīng)的條目。(4) 使用主子表結(jié)構(gòu)顯示具有類似主子關(guān)系的表格，例如，圖4.4中的員工工基本信息表和員工工作時間安排表，這使用戶的瀏覽或維護工作更加直觀。圖4.4 員工工作時間安排窗口(5) 大量使用幫助信息，在設(shè)計這個系統(tǒng)時，仔細的學習了Windows的界面設(shè)計風格，在窗口內(nèi)提供了大量的標簽幫助信息，使用戶更能理解操作的意義，同時窗口狀態(tài)欄內(nèi)也隨時顯示給用戶“即時”的幫助信息。7 其它設(shè)計說明：l 其它設(shè)計包含：代碼設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計、出錯設(shè)計等l 比部分內(nèi)容不是必須的。代碼設(shè)計示例：合同代碼格式