概要設(shè)計(jì)說明書(模板)

第*頁（共*頁）項(xiàng)目組名稱系統(tǒng)軟件概要設(shè)計(jì)說明書編寫：日期：審核：日期：批準(zhǔn)：日期：受控狀態(tài)：是發(fā)布版次：1.0日期：版本變更記錄日期版本變更說明作者YYYY-MM-DD1.0初始版本目錄TOC\o"1-3"\h\z1 引言 41.1 編寫目的 41.2 背景 41.3 定義 51.4 參考資料 52 總體設(shè)計(jì) 52.1 需求規(guī)定 52.2 運(yùn)行環(huán)境 72.3 基本設(shè)計(jì)概念和處理流程 72.3.1 系統(tǒng)建設(shè)的原則 72.3.2 基本設(shè)計(jì)概念 82.3.3 基本處理流程 82.4 系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 92.4.1 系統(tǒng)模塊結(jié)構(gòu) 92.4.2 類分析與設(shè)計(jì) 92.4.3 類圖 112.5 功能需求與程序的關(guān)系 113 用戶接口設(shè)計(jì) 124 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) 13引言編寫目的說明編寫這份概要設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。以下為示例：概要設(shè)計(jì)說明書建立在前期的需求分析基礎(chǔ)之上，目的在于明確說明模擬股票交易系統(tǒng)的客戶端與服務(wù)端后臺的基本框架，登錄，股票交易，買賣，顯示，查詢等幾個模塊的數(shù)據(jù)流程圖，了解系統(tǒng)中數(shù)據(jù)的基本流向，以更好地計(jì)劃、指導(dǎo)、規(guī)范開發(fā)過程。它是為了說明整個系統(tǒng)的體系架構(gòu)，以及需求用例的各個功能點(diǎn)在架構(gòu)中的體現(xiàn)，為系統(tǒng)的詳細(xì)設(shè)計(jì)人員進(jìn)行詳細(xì)設(shè)計(jì)時的輸入?yún)⒖嘉臋n。預(yù)期讀者為：系統(tǒng)設(shè)計(jì)人員及開發(fā)人員。背景以下為示例：當(dāng)下購買股票是現(xiàn)代人一種非常風(fēng)靡的理財(cái)、投資的方式，而模擬股票交易系統(tǒng)的存在也尤為重要。任何一種理財(cái)、投資工具都具有其不同的風(fēng)險(xiǎn)及回報(bào)，回報(bào)越高，風(fēng)險(xiǎn)也越大。股票投資相比于銀行儲蓄及債券購買，它的風(fēng)險(xiǎn)最高，但若能掌握好，也能給人們帶來非常高的經(jīng)濟(jì)收益。然而目前的上市公司已有上千家，每日產(chǎn)生的信息量更是難以估計(jì)，若沒有現(xiàn)金的電腦軟件佐以輔助，是很難了解市場的運(yùn)作情況并做出判斷?？梢哉f，買股票不使用相應(yīng)的分析軟件無異于“盲人騎瞎馬”，想要穩(wěn)住收益又不被套住是很困難的，具有很大的不確定性。故而，“工欲善其事，必先利其器”，買股票也是如此。因此模擬股票交易系統(tǒng)的存在意義也顯得尤為重要。本系統(tǒng)可以幫助用戶進(jìn)行模擬的股票交易訓(xùn)練，方便初學(xué)者熟悉和掌握股票交易的流程和操作細(xì)節(jié)，讓投資者們更加熟練的掌握股票交易的規(guī)則和玩法，便于日后實(shí)盤操作。定義說明文檔中使用的術(shù)語與縮略語，若沒有相關(guān)說明，則寫“無”。以下為示例：（1）C/S：客戶端/服務(wù)器端結(jié)構(gòu)，是軟件系統(tǒng)體系結(jié)構(gòu)，通過它可以充分利用兩端硬件環(huán)境的優(yōu)勢，將任務(wù)合理分配到Client端和Server端來實(shí)現(xiàn)，降低了系統(tǒng)的通訊開銷。參考資料列出本文檔涉及或可能使用到的參考資料，如：本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書和合同、上級機(jī)關(guān)的批文。屬于本項(xiàng)目的其他已發(fā)表的文件；本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。以下為示例：（1）軟件工程開發(fā)報(bào)告模板標(biāo)準(zhǔn)：概要設(shè)計(jì)說明書（GB8567——88）（2）軟件需求說明書（V1.0）總體設(shè)計(jì)需求規(guī)定以下只列出部分示例，需自行補(bǔ)充完整。說明對本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求。以下為示例：本系統(tǒng)主要完成的功能有：股票信息查詢、用戶信息管理、資金管理、股票交易、交易信息管理、用戶管理、資金審批功能。股票信息查詢功能：針對游客和用戶，開放股票信息查詢功能，股票用戶、普通用戶可以通過本系統(tǒng)實(shí)現(xiàn)查看指定股票市場的相關(guān)股票信息，如當(dāng)前價格、開盤價格、市盈率。用戶信息管理功能：該功能包括：用戶的登錄、注冊、個人信息修改功能。股票用戶可以通過本系統(tǒng)進(jìn)行用戶的登錄、注冊、個人信息修改。資金管理功能：資金管理用例的功能又可細(xì)分為：轉(zhuǎn)入資金功能、轉(zhuǎn)出資金功能。轉(zhuǎn)入資金功能：根據(jù)用戶需求可以申請向自己的賬戶里面轉(zhuǎn)入資金以便于購買股票。轉(zhuǎn)出資金功能：根據(jù)用戶需求可以申請由自己的賬戶里面轉(zhuǎn)出部分或全部資金到用戶的銀行賬戶上去。股票交易功能：股票交易用例又可細(xì)分為：購買功能、出售功能、撤單功能。購買功能：股票用戶登錄系統(tǒng)后，可以在任意時刻買進(jìn)某股市的股票。出售功能：股票用戶可以在任何時間出售自己有的股票，以賺取利益。撤單功能：股票用戶在購買或賣出股票的交易中由于突發(fā)原因需要停止交易可提出撤單。交易信息管理功能：交易歷史管理用例的功能又可細(xì)分為：查看歷史成交功能、查看委托追蹤功能。查看歷史成交功能：用戶可登陸系統(tǒng)查看自己的股票交易明細(xì)。查看委托追蹤：用戶查看未成交的委托單信息追蹤。用戶管理功能：用戶管理用例的功能又可細(xì)分為：登陸功能、注冊功能、個人信息修改功能。登陸功能:股票用戶通過登錄進(jìn)入股票操作的主界面。注冊功能:游客可以用過系統(tǒng)注冊功能來注冊用戶，以能夠進(jìn)行股票交易。個人信息修改功能:股票用戶可以通過主界面的修改個人信息功能來修改自己的個人信息。資金審批功能：又可細(xì)分為：轉(zhuǎn)入資金功能、轉(zhuǎn)出資金功能。轉(zhuǎn)入資金功能：根據(jù)用戶需求可以申請向自己的賬戶里面轉(zhuǎn)入資金以便于購買股票。轉(zhuǎn)出資金功能：根據(jù)用戶需求可以申請由自己的賬戶里面轉(zhuǎn)出部分或全部資金到用戶的銀行賬戶上去。本系統(tǒng)對于輸入輸出數(shù)據(jù)的要求如下：表2-1用戶登錄用例的輸入輸出數(shù)據(jù)要求編號數(shù)據(jù)項(xiàng)數(shù)據(jù)類型輸入/輸出范圍例子1用戶名字符串輸入1-12個字符“jack”2密碼字符串輸入1-12個字符“123”3數(shù)量int輸入0~232123運(yùn)行環(huán)境以下為示例：處理器：酷睿I3及以上系列的處理器，主頻為1.5Ghz以上運(yùn)行內(nèi)存：1GMB以上硬盤空間：10G或更多編譯系統(tǒng)：JDK1.6及以上操作系統(tǒng)：WindowsXP基本設(shè)計(jì)概念和處理流程說明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式。以下為部分示例：系統(tǒng)建設(shè)的原則作為股票交易系統(tǒng)旨在為股民用戶提供最即時的股票信息，方便用戶隨時隨地查閱股票的相關(guān)信息。另外，此軟件的最終用戶為廣大股民，他們的教育水平和技術(shù)專長殘參差不齊，因此，該軟件的設(shè)計(jì)在保證實(shí)現(xiàn)網(wǎng)上信息發(fā)布基本功能的同時，還要注重對軟件的操作要盡量簡單，容易上手?；驹O(shè)計(jì)概念在本系統(tǒng)的設(shè)計(jì)過程中要用的很多技術(shù)，列舉如下：數(shù)據(jù)庫管理：中心數(shù)據(jù)庫負(fù)責(zé)存儲和備份重要的股票和用戶信息，所以合理的管理和維護(hù)非常重要。服務(wù)器建立：本系統(tǒng)建立在C/S體系結(jié)構(gòu)上，所以必須為用戶提供一個服務(wù)器，以便用戶訪問并查詢相關(guān)股票信息?；咎幚砹鞒谈鶕?jù)文檔《軟件需求說明書》中圖3-1設(shè)備管理系統(tǒng)頂層用例圖，該系統(tǒng)的主要用例描述如下：1．用戶管理用例（1）用戶注冊子用例該子用例描述未注冊用戶若想進(jìn)行股票交易，必須先注冊后登錄系統(tǒng)才可進(jìn)行操作。未注冊用戶進(jìn)行注冊，先填寫用戶名、密碼進(jìn)行注冊，點(diǎn)擊注冊按鈕，跳出相應(yīng)界面進(jìn)行個人詳細(xì)信息的填寫。若注冊成功，把用戶相關(guān)信息寫入數(shù)據(jù)庫，用戶即可進(jìn)行相關(guān)操作。該場景涉及到的人員的信息包含用戶名、密碼、手機(jī)號、郵箱和所在地等。未注冊用戶通過填寫用戶名、密碼、確認(rèn)密碼、手機(jī)號、郵箱和所在地等信息來成功注冊。（2）用戶登錄子用例該子用例描述對已注冊用戶登錄系統(tǒng)進(jìn)行處理，已注冊用戶輸入用戶名和密碼點(diǎn)擊登錄按鈕進(jìn)入主界面。該過程客戶端將用戶填寫的信息提交到服務(wù)器，服務(wù)器通過調(diào)用數(shù)據(jù)庫中的信息進(jìn)行對客戶端輸入信息的驗(yàn)證。若用戶存在，則進(jìn)入主界面，若用戶不存在，則提示用戶進(jìn)行注冊操作。該場景涉及到的人員的信息包含用戶名，密碼和角色。管理員和用戶通過輸入用戶名、密碼和角色等信息登錄系統(tǒng)。系統(tǒng)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)模塊結(jié)構(gòu)說明系統(tǒng)的模塊結(jié)構(gòu)。以下為示例：根據(jù)文檔《軟件需求說明書》中圖3-1設(shè)備管理系統(tǒng)頂層用例圖，模擬股票交易系統(tǒng)的模塊結(jié)構(gòu)如圖2-1所示，包括：用戶管理模塊、股票信息查詢模塊、股票交易模塊、資金管理模塊和交易歷史管理模塊。圖2-1系統(tǒng)模塊結(jié)構(gòu)類分析與設(shè)計(jì)分析與設(shè)計(jì)系統(tǒng)中的類。以下為部分示例：根據(jù)對象分析的結(jié)果，對象“用戶”、“管理員”、“股票”和“賬戶”在名稱上沒有語義重復(fù)，因此它們分別對應(yīng)一個類，具體描述如下：對象“用戶”對應(yīng)類“User”對象“管理員”對應(yīng)類“Admin”對象“股票”對應(yīng)類“Stock”對象“賬戶”對應(yīng)類“Account”1．User類（1）屬性設(shè)計(jì)根據(jù)上文分析結(jié)果，類User只擁有一個對象“用戶”，因此該類的屬性同對象“用戶”的屬性一一對應(yīng)如下：對象“用戶”的屬性“用戶名”對應(yīng)類User的屬性userName，數(shù)據(jù)類型為String對象“用戶”的屬性“密碼”對應(yīng)類User的屬性password，數(shù)據(jù)類型為String對象“用戶”的屬性“姓名”對應(yīng)類User的屬性name，數(shù)據(jù)類型為String對象“用戶”的屬性“性別”對應(yīng)類User的屬性gender，數(shù)據(jù)類型為char對象“用戶”的屬性“身份證號碼”對應(yīng)類User的屬性cardID，數(shù)據(jù)類型為String對象“用戶”的屬性“電話號碼”對應(yīng)類User的屬性phoneNumber，數(shù)據(jù)類型為String對象“用戶”的屬性“電子郵箱”對應(yīng)類User的屬性email，數(shù)據(jù)類型為String（2）方法設(shè)計(jì)類User中的構(gòu)造方法與存取方法設(shè)計(jì)如下：publicUser(Stringusername,Stringpassword,Stringname,Chargender,StringcardID,StringphoneNumber,Stringemail)：構(gòu)造方法publicvoidsetUserName(StringnewUserName)：該存取方法接收外來字符串類型的參數(shù)newUserName，將該參數(shù)的值保存在屬userName中publicStringgetUserName()：該存取方法將屬性userName中的值以字符串類型返回給調(diào)用者User類中其余的存取方法的設(shè)計(jì)與上述第2項(xiàng)和第3項(xiàng)類似。publicvoidregister()：該方法利用User類的屬性userName、pwd、name、gender、id和email實(shí)現(xiàn)用戶注冊功能，注冊成功返回注冊成功信息，注冊失敗返回注冊失敗信息publicvoiduserLogin()：該方法利“User”的屬性userName,和pwd實(shí)現(xiàn)用戶登錄功能，登錄成功返回登錄成功信息，登錄失敗返回登錄失敗信息publicvoidmoidifyPWD(SringoldPWD,StringnewPWD)：該方法利用User類的屬性password實(shí)現(xiàn)用戶修改密碼功能，修改成功返回修改成功信息，修改失敗返回錯誤信息。類User”中其余屬性的修改方法類似修改密碼的方法類圖將類的分析與設(shè)計(jì)結(jié)果畫成類圖。以下為部分示例：根據(jù)類分析與設(shè)計(jì)的結(jié)果，Person類、User類、Admin類、Stock類和Account類對應(yīng)的類圖分別如下圖所示：圖2-2類圖功能需求與程序的關(guān)系用一張矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系。以下為示例：根據(jù)文檔《軟件需求說明書》中股票交易模擬系統(tǒng)頂層用例圖可以看出，用戶登錄、用戶注冊、個人信息修改與管理員登錄都屬于用戶管理模塊，這兩個用例場景的功能在用戶管理管理模塊中實(shí)現(xiàn)。用戶購買股票以及賣出股票都屬于股票交易，這兩個用例場景的功能在股票交易模塊中實(shí)現(xiàn)。查詢股票信息所持股查詢、余額查詢與查詢歷史交易信息都屬于查詢，這兩個用例場景的功能在查詢模塊中實(shí)現(xiàn)。用戶轉(zhuǎn)入資金申請/審批以及轉(zhuǎn)出資金申請/審批屬于資金管理模塊，這兩個用例場景的功能在資金管理模塊中實(shí)現(xiàn)。綜上，本系統(tǒng)的可分為用戶管理模塊、股票信息查詢模塊、股票交易模塊、資金管理模塊和交易歷史管理模塊。表2-2功能需求與模塊的關(guān)系用戶管理模塊股票交易模塊資金管理模塊股票信息查詢模塊交易歷史管理模塊用戶注冊√用戶登錄√管理員登錄√個人信息修改√個人信息查詢√密碼修改√股票購買√股票出售√申請轉(zhuǎn)入資金√申請轉(zhuǎn)出資金√審核轉(zhuǎn)入資金√審核轉(zhuǎn)出資金√查看持有股信息√查看買賣歷史記錄√查看歷史交易記錄√用戶接口設(shè)計(jì)說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及軟件的回答信息，如沒有則寫“無”。系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識符以及它們之中每個數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識、定義、長度及它們之間的層次的或表格的相互關(guān)系。以下為部分示例：表4-1用戶表User字段名數(shù)據(jù)類型長度NOTNUL