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

《系統(tǒng)設(shè)計文檔編寫規(guī)范及示例(1)》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、********系統(tǒng)系統(tǒng)設(shè)計文檔*****系統(tǒng)設(shè)計小組組長：****組員：****************-13-目錄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-13-說明：l在進行系統(tǒng)設(shè)計時可以任意傳統(tǒng)系統(tǒng)設(shè)計方法或面向?qū)ο笙到y(tǒng)設(shè)計方法，或者兩者相結(jié)合，不局限于使用一種方法。l文檔中每章圖都需要配有相應(yīng)的文字解釋。l本文檔中的圖按照章編號，如“1引

2、言”表示第一章，“1.1編寫目的”表示第一章第一節(jié)。第一章第一個圖標(biāo)號為“圖1.1****圖”，而第二個圖標(biāo)號為“圖1.2****圖”，寫在圖的下面，居中。l本文檔中的表也按照章編號，第一章第一個表標(biāo)號為“表1.1****表”，而第二個表標(biāo)號為“表1.2****表”，寫在表的上面，居中。l使用visio畫用例時，Actor及用例的圖示模具（用例圖模具.vss）可以到BB平臺下載。1引言1.1編寫目的說明編寫這份系統(tǒng)設(shè)計說明書的目的，指出預(yù)期的讀者。1.2背景說明：a．待開發(fā)的軟件系統(tǒng)的名稱；b．列出此項目的任務(wù)提出者、開發(fā)者、用戶

3、以及將運行該軟件的計算站（中心）。1.3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。-13-1.4參考資料列出用得著的參考資料，如：a．本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機關(guān)的批文；b．屬于本項目的其他已發(fā)表的文件；c．本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。-13-2系統(tǒng)功能設(shè)計2.1功能模塊設(shè)計根據(jù)分析工作進行系統(tǒng)的功能分配，畫出系統(tǒng)的功能模塊圖（如果使用面向?qū)ο笙到y(tǒng)設(shè)計方法，可以畫包圖）。功能層次圖示

4、例：圖2.1功能模塊圖2.2****模塊設(shè)計列出該模塊及該模塊所包含的每個子模塊的功能。****子模塊：包含。。。。。。。等功能。****子模塊：包含。。。。。。。等功能。。。。。。。。。。。2.3****模塊設(shè)計。。。。。。。。。。。。。。。。。。。。。。。-13-3類設(shè)計說明：l如果使用面向?qū)ο笙到y(tǒng)設(shè)計方法，需要進行類設(shè)計。l此部分內(nèi)容不是必須的。盡可能列出所設(shè)計出的類及其之間的關(guān)系，如果類比較多，可以按照第2章所設(shè)計的模塊（或包）分別畫類圖。示例如下：示例1：網(wǎng)上商店系統(tǒng)中登錄模塊的類圖如圖3.1所示。。。。。。。。。。圖3

5、.1系統(tǒng)登錄模塊類圖-13-示例2：數(shù)據(jù)上傳模塊類圖如圖3.2所示。圖3.2違章數(shù)據(jù)上傳模塊類圖-13-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ù)、是否主鍵、索引、是否允許為空、說明等。介紹表與表之間的邏輯關(guān)系。示例：系統(tǒng)中數(shù)據(jù)庫包括如下各表如表4.1所示。表4.1系統(tǒng)數(shù)據(jù)庫表序號表名

6、(英文)說明1Trialorgan試驗檢測機構(gòu)綜合情況表2Personinfo試驗檢測人員基本信息表3Trialinfo試驗基本信息表4Purchaseapply設(shè)備購置申請表5Redeploy設(shè)備調(diào)撥表（1）試驗檢測機構(gòu)綜合情況表(TrialOrgan)用來存儲試驗室機構(gòu)綜合的基本情況，如表4.2所示。表4.2實驗檢測機構(gòu)綜合情況表Table4.2TrialOrgan屬性(英文)類型主鍵外鍵空值屬性(中文)T_itemidIntYes記錄IDT_nodeidchar(6)NoNoNo機構(gòu)編號T_namevarChar（80）機構(gòu)

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

8、入的工程信息存儲到數(shù)據(jù)庫中在合同信息維護中供用戶選擇。。。。。。。。。。。。-13-6界面設(shè)計說明：l一般情況下，一個較大的功能模塊會包含多個界面，針對每個功能模塊列出界面的轉(zhuǎn)換關(guān)系；l列出主界面以及幾個典型界面的界面設(shè)計結(jié)果。界面轉(zhuǎn)換關(guān)系示例如下