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

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

2、表也根據(jù)章編號,第一章第一個表標號為“表1.1*表,而第二個表標號為“表1.2*表,寫在表的上面,居中.使用visio畫用例時,Actor及用例的圖示模具用例圖模具.vss可以到BB平臺下載.1.1 編寫目的說明編寫這份系統(tǒng)設計說明書的目的,指出預期的讀者.1.2 背景說明：a.待開發(fā)的軟件系統(tǒng)的名稱；b.列出此工程的任務提出者、開發(fā)者、用戶以及將運行該軟件的計算站中央1.3 定義列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組.1.4 參考資料列出用得著的參考資料,如:a.本工程的經(jīng)核準的方案任務書或合同、上級機關的批文；b.屬于本工程的其他已發(fā)表的文件；c.本文件中各處引用的文件、

3、資料、包括所要用到的軟件開發(fā)標準.列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源.2系統(tǒng)功能設計2.1 功能模塊設計根據(jù)分析工作進行系統(tǒng)的功能分配,畫出系統(tǒng)的功能模塊圖如果使用面向對象系統(tǒng)設計方法,可以畫包圖.功能層次圖例如：圖2.1功能模塊圖2.2 *模塊設計列出該模塊及該模塊所包含的每個子模塊的功能.*子模塊：包含.等功能.*子模塊：包含.等功能.00000000002.3 *模塊設計000000000000000000000003類設計說明：如果使用面向對象系統(tǒng)設計方法,需要進行類設計.此局部內容不是必須的.盡可能列出所設計出的類及其之間的關系,如果

4、類比擬多,可以根據(jù)第2章所設計的模塊或包分別畫類圖.例如如下：例如1:網(wǎng)上商店系統(tǒng)中登錄模塊的類圖如圖3,1所示.圖3.1系統(tǒng)登錄模塊類圖eredTrialVersioneredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregistereredTriaeredTriaVersionVersioneredTrialVersioneredTri

5、alVersioneredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaeredTriaVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVersionVer

6、sionVersionVersionVersionVersionVersionEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersion例如2:數(shù)據(jù)上傳模塊類圖如圖3.2所示EA9.2UnregisteredTrialVersionclassSystemEA9.2UnregisteredTrialVersionEA9.EA9.2UnregisterEA9.22UnregisteredTrialVersionEA9.2UnregisteredTrialVersion-EEAi9.2IllegalDataDllDataUploadDataU

7、ploadEA9.人,T_typeNum,:int.丁.、,.lacc.2UrWegasteTNDiTrialVersionEA9.2U-misContinue:bool,-.strCaqejalP:string“registeredst就就豺黜曲EA9.2EA9.EA9.2UnregisteredTrialVersionEA9.2U+start(string):bool+stop.:bool2Umregnsteredf,刊adsVersLonrR)EA9.2U# IrregalDateUpload():void# 0nregisteedTrtaiLMersionEA+UnInitialize

8、.:int+OnTimer(unit):voidnregisteredTrialVersionEA9.29.2EA9.2UnregisteredIn9VersionEA9.2UnregisteredTrialVersionEA9.2EA9.2UnregisteredTriaVersionEA9.2UnregisteredTrialVersionEA9.2EA9.2Unregistered幫STVersion_EA-m_steq_lock:CRITICAL_SECTION-m_typeNum:intEA9.2Unregistered1呷rial1gVersionEA-EA9.2Unr曲嘲昨獻Tr

9、oalVersionEA+AddIllegal(wchar_t*):intEA9.2Unr扇iGSW：瞰ersionEA9.2UnregisteredTrialVersiontagIllegalInfo9.2UnrejisteredhTrnalVersion+imageName_1:string+9.2unregsegMDMVrsonEA9.2EA9.29.29.2UnregisteredTrialVersion-EA9.2EA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersio

10、nEA9.2UnregisteredTrialVersionEA9.2EA9.2EA9.2MsXMLUnreg/癡翎oT璃XMerMDonuEA9.2Urregi-spNodeList:CComPtr-UnregisteredTrialVersionEA9.2Unregi+Load(LPCTSTR):BOOL+CreateXML():BOOLsteredTrialVersionsteredTrialVersionJnreg喇gBMddTciiaTFVecsmoRixMEDAMNo&UnregisteredTrialVersionEA9.2EA9.2EA9.2EA9.2EA9.2EA9.2Unr

11、egisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregisterUnregister圖3.2違章數(shù)據(jù)上傳模塊類圖EA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9

12、.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2Unregi

13、sterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisterEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2Unregister-5-EA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregistereredTrialVersionEA9.2UnregisteredTrialVersionEA9.2UnregisteredTrialVersion

14、EA9.2Unregister4數(shù)據(jù)庫設計說明：如果使用面向對象需求分析方法,需要建立對象-關系模型.此局部內容不是必須的.根據(jù)系統(tǒng)需求分析結果盡量畫出E-R圖E-R圖不是必須的,并根據(jù)這些工作設計出實現(xiàn)系統(tǒng)功能所需要的數(shù)據(jù)庫表的結構.并以表格的形式盡可能列出每一個數(shù)據(jù)庫表的表結構,即字段名、類型、長度、小數(shù)位數(shù)、是否主鍵、索引、是否允許為空、說明等.介紹表與表之間的邏輯關系.例如：系統(tǒng)中數(shù)據(jù)庫包括如下各表如表4,1所示.表4,1系統(tǒng)數(shù)據(jù)庫表表名英文1Trialorgan試驗檢測機構綜合情況表2Personinfo試驗檢測人員根本信息表3Trialinfo試驗根本信息表4Purchaseapp

15、ly設備購置申請表5Redeploy設備調撥表1試驗檢測機構綜合情況表TrialOrgan用來存儲試驗室機構綜合的根本情況,如表4,2所示表4.2實驗檢測機構綜合情況表Table4.2TrialOrgan屬性英文主鍵外鍵空值屬性中文T_itemidIntYes記錄IDT_nodeidchar(6)NoNoNo機構編號T_namevarChar(80)機構名稱T_organkindvarChar(20)結構性質T_addressvarChar(100)Yes 5接口及過程設計針又t2.1所設計的模塊,盡可能畫出每個模塊的IPO表.例如如下：IPO表主要說明了銷售治理模塊各個文件的輸入、輸出數(shù)據(jù)流

16、及輸入到輸出的中間處理過程.銷售治理模塊每個文件的主要功能的IPO表如表5.1所示.表5.1銷售治理模塊IPO表子模塊名稱I輸入P處理將用戶輸入的單位信息單位信息維護用戶輸入單位信息存儲到數(shù)據(jù)庫中將用戶輸入的工程信息工程信息維護用戶輸入工程信息O輸出在工程信息維護中顯示供用戶選擇在合同信息維護中供用戶選擇存儲到數(shù)據(jù)庫中6界面設計說明：一般情況下,一個較大的功能模塊會包含多個界面,針對每個功能模塊列出界面的轉換關系；列出主界面以及幾個典型界面的界面設計結果.界面轉換關系例如如下：進入銷售治理模塊后,可以通過主界面左側的導航進入到各個子模塊,每個子模塊文件之間的跳轉與包含關系如圖6.1所示.圖中沒

17、有連線的文件之間是相互獨立的.Zwjs_Main.dfm圖4.1銷售治理模塊跳轉與包含關系圖界面設計結果例如如下：系統(tǒng)采用多文檔窗體結構,如圖4.2所示,在主窗體上分為菜單欄、通用工具欄、導航欄、操作工具欄和工作窗口區(qū)五個局部.不同喜好風格的用戶可以根據(jù)自己的使用風格使用這個系統(tǒng).菜單和通用工具欄同普通系統(tǒng)一樣,提供了系統(tǒng)的全部操作功能的接口；導航欄使用了非常直觀的樹視圖結構,整個功能一幕了然,在樹視圖中包含部門列表和小組列表,查看、維護部門和小組信息非常方便.通用工具欄菜單欄公路客運站箔治理系統(tǒng)員工根本信良I電系統(tǒng)人員管塞已司機及車輛治理)線路及車次信息治理(I)車票管,0車站間信息傳燃日操

18、作那么圖理口忸)苦助三回兇00l(aaosoE5J|I-穹站務治理-人員治理E金部門室部部組都公募輸票歸融財運售推員工根本信息|顯示所有員工信息53性別姓名出生日期籍費日日日日尋回機柄路號留司車統(tǒng)工考工工作勤作資Y001D3rooio4Y001D5Y00106rooioT0108Y00109roonoYOODOlYOOOD2YD0003Y00004Y000D500006YOOOOTYOOOD6r00301TOO1張小藝壬睦曉張成趙虎劉武張路齊齊張紅張一張二三四武路齊巴男女男男男男男女空男男女男女男女男玄1980-1-11981-1-1igso-1-i1980-1-11960-1-)1980-W

19、1980-1-11801-1-11901-1-11981-1-1I9B1-1-1I901-1-LI9B1-1-1I9B1-1-1I981-1-LISBl2l-lI9B1-1-1I981-1-L遼寧省遼寧省沈一.江寧看遼寧省遼寧省遼寧省遼寧省遼寧省遼寧有帙.遼寧省遼寧省遼寧省遼寧省遼寧省遼寧琉遼寧省遼寧省遼寧琉Z1212121212121Zl21212121ZJ2121ZJ21員工根本信息導航欄工作窗口區(qū)靠首條圈上條畫下條G尾條Q查詢皆添加曾修改建K-&提二0I閆I國關閉操作工具欄)圖4.2主窗口界面圖(2)工作窗口中大量使用表格結構顯示數(shù)據(jù),這樣設計使窗口裝載的信息量大,便于用戶的瀏覽多條信息

20、；對于字段數(shù)量較多的表格,選擇右鍵彈出菜單中的“查看詳細信息選項(或雙擊要查看的信息條目)將彈出這個條目的詳細信息選項卡,如圖4.3所示,用戶可以很直觀的查看條目的詳細信息.圖4.3員工根本信息卡片窗口(3)統(tǒng)一的操作工具欄,對于每個可以轉載數(shù)據(jù)信息的窗體,都使用由主窗體提供的統(tǒng)一的操作工具欄來進行數(shù)據(jù)信息的瀏覽和維護操作,系統(tǒng)將首先根據(jù)是哪個數(shù)據(jù)窗體的請求來選擇相應的操作.例如,在圖4.3中,可以通過點擊操作工具欄中的“首條、上條、“下條、“尾條按鈕來移動當前記錄；用戶可以通過點擊“查詢按鈕來彈出相應的查詢窗口,如在此時將彈出查詢員工信息窗體,供用戶操作；可以通過點擊“添加按鈕來彈出相應的添加窗口；可以通過點擊“修改按鈕來修改相應的條目.(4)使用主子表結構顯示具有類似主子關系的表格,例如,圖4.4中的員工工根本信息表和員工工作時間安排表,這使用戶的