軟件設(shè)計(jì)文檔模板

1、*項(xiàng)目需求詳細(xì)設(shè)計(jì)*項(xiàng)目組2016年12月15日變更記錄日期版本號(hào)修改人變更內(nèi)容描述審核人批準(zhǔn)人2016-12-151.0初稿目錄目錄2一、導(dǎo)言21、編寫(xiě)目的22、背景23、術(shù)語(yǔ)定義34、參考資料35、約定3二、總體設(shè)計(jì)31、系統(tǒng)概述32、設(shè)計(jì)策略33、系統(tǒng)總體結(jié)構(gòu)41部署架構(gòu)圖42功能結(jié)構(gòu)圖43技術(shù)架構(gòu)圖54、公共設(shè)計(jì)5三、功能設(shè)計(jì)51、客戶管理模塊51客戶投訴功能5四、補(bǔ)充變更設(shè)計(jì)8五、數(shù)據(jù)對(duì)象設(shè)計(jì)8一、導(dǎo)言1、編寫(xiě)目的簡(jiǎn)略說(shuō)明文檔編寫(xiě)的目的、作用，并指出項(xiàng)目組將以此文檔為依據(jù)指導(dǎo)系統(tǒng)的開(kāi)發(fā)及編碼工作。2、背景說(shuō)明一下項(xiàng)目建設(shè)背景，著重說(shuō)明項(xiàng)目建設(shè)的必要性，并概要介紹項(xiàng)目實(shí)現(xiàn)的主要功能模塊

2、。3、術(shù)語(yǔ)定義文檔中所使用專業(yè)術(shù)語(yǔ)的定義、文檔中所使用簡(jiǎn)稱的說(shuō)明等。4、參考資料系統(tǒng)中引用參考資料說(shuō)明。5、約定文檔中使用標(biāo)記符號(hào)、特殊顏色作標(biāo)注的原因或者對(duì)某些有出入的內(nèi)容作出解釋等。二、總體設(shè)計(jì)1、系統(tǒng)概述概述系統(tǒng)的主要模塊，及各個(gè)模塊實(shí)現(xiàn)的主要功能。2、設(shè)計(jì)策略系統(tǒng)的設(shè)計(jì)策略，即設(shè)計(jì)原則。說(shuō)明系統(tǒng)設(shè)計(jì)時(shí)定下的規(guī)范和考慮因素，比如數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范、編碼規(guī)范以及系統(tǒng)擴(kuò)展性、安全性、易用性等。3、系統(tǒng)總體結(jié)構(gòu)1部署架構(gòu)圖如:氈日百行厝巧康圖郵署結(jié)鞫2功能結(jié)構(gòu)圖客戶管理貨運(yùn)公司如:客戶、廠商管理京電施催通系統(tǒng)賬款營(yíng)理配件管理IIIIIII3技術(shù)架構(gòu)圖如:業(yè)務(wù)近R指口rI4L業(yè)務(wù)服分號(hào)Spri呻轉(zhuǎn)口

3、84I他于RFI四巴灰生產(chǎn)靶青甲的瑞片卬民式/Eeh3Hibernate數(shù)據(jù)持久房肝、_松都還日睜f*itteruicgr研附m4、公共設(shè)計(jì)通用功能、通用函數(shù)、公用幫助、系統(tǒng)全局參數(shù)等的設(shè)計(jì)。三、功能設(shè)計(jì)設(shè)計(jì)文檔的主要內(nèi)容，按模塊、功能的順序逐級(jí)寫(xiě)明實(shí)現(xiàn)內(nèi)容。1、客戶管理模塊1客戶投訴功能此功能用于處理客戶投訴，分為客戶投訴信息錄入和客戶投訴信息處理兩個(gè)流程。舉例說(shuō)明：1客戶信息錄入。本功能為客戶投訴的錄入界面，由客服人員將客戶的投訴意見(jiàn)錄入本系統(tǒng)中，以備查和處理。本功能可以錄入客戶姓名、客戶電話、客戶投訴分類(lèi)、客戶投訴意見(jiàn)等。2界面定義。該功能包含兩個(gè)界面，一個(gè)是客戶信息投訴列表，另一個(gè)是客

4、戶投訴信息明細(xì)頁(yè)面?？蛻粜畔⑼对V列表，輸出列為單據(jù)ID、投訴人類(lèi)型、投訴人名稱、聯(lián)系電話、投訴人車(chē)牌號(hào)、被投訴人信息、錄入日期、錄入人員等等。如圖：客戶投訴信息明細(xì)，是客服錄入客戶投訴信息的界面，如圖:單堀D客戶編號(hào)聯(lián)系電話“客戶蛀名查看客戶信息根投訴2型鞭徜標(biāo)-就投訴人蛀名投而原因3界面說(shuō)明。1 ）界面元素:對(duì)象名稱顯示信息取值控制規(guī)則其它說(shuō)明單據(jù)ID輸入框自動(dòng)生成的編號(hào)不口編輯，輸入框置灰客戶編號(hào)輸入框如果客戶輸入車(chē)牌號(hào)，則自動(dòng)帶出此值不口編輯，輸入框置灰客戶名稱輸入框必輸，輸入長(zhǎng)度20投訴人類(lèi)型下拉框默認(rèn)顯示：客戶1,客戶;2,經(jīng)銷(xiāo)商；必輸投訴人車(chē)牌號(hào)碼輸入框非必輸，如果輸入該項(xiàng)后，自動(dòng)帶出客戶編號(hào)項(xiàng)的值投訴人身份證號(hào)輸入框非必輸聯(lián)系電話輸入框必輸被投訴人下拉框默認(rèn)顯示：經(jīng)1,經(jīng)銷(xiāo)商；必輸銷(xiāo)商2財(cái)務(wù)公司專員被投訴人姓名輸入框必輸投訴原因輸入域必輸2 ）按鈕說(shuō)明。新增：點(diǎn)擊新增，界面跳轉(zhuǎn)到空白明細(xì)界面。修改：首先檢驗(yàn)，必須選中一條數(shù)據(jù)，如果選擇多條，默認(rèn)取第一條數(shù)據(jù),將相關(guān)參數(shù)傳遞給明細(xì)界面，明細(xì)界面獲取之后展示在頁(yè)面上刪除：可選擇多條數(shù)據(jù)進(jìn)行刪除。4也