系統(tǒng)分析設(shè)計文檔-模板

./XXX模塊/系統(tǒng)系統(tǒng)分析設(shè)計文檔模板文件編號：版本號：V0.01擬制：日期：XXXXX所有不得復(fù)制版本修訂記錄日期版本號修訂人修改容V0.01初步建立文檔目錄1.引言31.1.系統(tǒng)背景31.2.編寫目的31.3.預(yù)期讀者42.總體設(shè)計42.1.需求說明42.2.環(huán)境說明42.3.技術(shù)說明42.4.結(jié)構(gòu)設(shè)計53.功能設(shè)計63.1.會計科目管理63.1.1.功能介紹63.1.2.結(jié)構(gòu)設(shè)計63.1.3.功能設(shè)計63.2.會計科目配置73.2.1.功能介紹73.2.2.結(jié)構(gòu)設(shè)計73.2.3.功能設(shè)計73.3.生成臺賬73.3.1.功能介紹73.3.2.流程設(shè)計84.數(shù)據(jù)結(jié)構(gòu)設(shè)計95.接口設(shè)計9概述系統(tǒng)背景[必選]描述本模塊或系統(tǒng)的背景和簡介。示例：本文檔描述的是興業(yè)〔點芯賬務(wù)系統(tǒng)的會計子模塊的概要設(shè)計,主要提供基于核心賬務(wù)系統(tǒng)的通用會計功能擴(kuò)展,實現(xiàn)多場景靈活配置和適配的設(shè)計目的,以實現(xiàn)在各銀行/分行的推廣使用。編寫目的[必選]描述本模塊或系統(tǒng)的解決的核心問題以及目標(biāo)。示例：針對賬務(wù)系統(tǒng)的會計模塊進(jìn)行概要的設(shè)計說明,以達(dá)到一下目的：開發(fā)團(tuán)隊工程師間的業(yè)務(wù)邏輯和技術(shù)設(shè)計溝通和傳遞開發(fā)團(tuán)隊與客戶的業(yè)務(wù)邏輯溝通和傳遞。預(yù)期讀者示例：開發(fā)人員,項目經(jīng)理,測試人員,運(yùn)營,運(yùn)維等等。相關(guān)術(shù)語1列出本文檔中用到的可能會引起混淆的專門術(shù)語、定義和縮寫詞的原文術(shù)語描述需求分析總體需求[必選]概要描述整體需求,建議包含以下幾個部分：關(guān)鍵業(yè)務(wù)領(lǐng)域邊界描述系統(tǒng)建設(shè)目標(biāo)及規(guī)劃用例分析[必選]通用對用例的分析,直觀的展示所有角色和相關(guān)業(yè)務(wù)功能,動作的總體關(guān)系。介紹和描述系統(tǒng)與業(yè)務(wù)相關(guān)的所有角色定義和對應(yīng)的用例?？梢愿鶕?jù)文檔描述的系統(tǒng)或模塊的規(guī)模,增加子模塊細(xì)分后進(jìn)行用例描述和介紹。關(guān)鍵業(yè)務(wù)需求[必選]業(yè)務(wù)目標(biāo)描述非功能需求[可選]應(yīng)用架構(gòu)目標(biāo)描述性能目標(biāo)描述可靠性描述,如：數(shù)據(jù)需要100%保證一致性,100%保證實時性安全性,隔離性目標(biāo)描述可擴(kuò)展目標(biāo)描述總體設(shè)計部結(jié)構(gòu)設(shè)計[必選]詳細(xì)描述系統(tǒng)或模塊的部邏輯結(jié)構(gòu)設(shè)計〔對標(biāo)架構(gòu)設(shè)計的邏輯架構(gòu)。目的是讓讀者概要性的總體了解你的系統(tǒng)或模塊部設(shè)計和結(jié)構(gòu)。建議介紹方式：系統(tǒng)結(jié)構(gòu)圖〔層次框圖對結(jié)構(gòu)圖中各塊進(jìn)行詳細(xì)功能和設(shè)計介紹,同時描述塊間的關(guān)系。下圖是一個賬務(wù)系統(tǒng)的示例：如圖所示：藍(lán)色部分為通用賬務(wù)系統(tǒng)的核心。橙色部分為賬務(wù)系統(tǒng)的會計模板,是本文檔重點設(shè)計和說明的部分。設(shè)計說明：會計科目：設(shè)計多級結(jié)構(gòu)〔至少兩級的通用會計客戶自定義配置模塊?？筛鶕?jù)場景需求定義會計科目樹。會計科目配置：配置定義的會計科目與賬戶類型的關(guān)系,以建立賬戶交易與科目的關(guān)聯(lián)?？颇颗c賬戶類型的關(guān)系為一對多關(guān)系。臺賬：在賬戶產(chǎn)生交易并聲稱進(jìn)出賬〔流水后,根據(jù)會計科目與賬戶elixir的關(guān)系,準(zhǔn)實時生成臺賬。會計報表：根據(jù)臺賬,進(jìn)出賬和賬戶余額定制會計報表。關(guān)系結(jié)構(gòu)設(shè)計[必選]本節(jié)點主要用于描述本文設(shè)計的系統(tǒng)或模塊與外部系統(tǒng)的關(guān)系,交互模式等。讓讀者了解本系統(tǒng)或模塊對外部資源的依賴或?qū)ν獠肯到y(tǒng)提供的服務(wù)。建議采用結(jié)構(gòu)圖連線方式介紹重點介紹整體結(jié)構(gòu)圖中,外部系統(tǒng)或模塊的角色,需求和能力。標(biāo)注和描述每個鏈線的核心動作是什么。示例：金融科技平臺中的子系統(tǒng)的架構(gòu)設(shè)計PPT圖：以下是針對設(shè)計圖的詳細(xì)說明。。。。關(guān)鍵技術(shù)設(shè)計[可選]對模塊或系統(tǒng)中的關(guān)鍵技術(shù)設(shè)計詳細(xì)描述,建議編寫方式如下：結(jié)構(gòu)：可以針對多個關(guān)鍵技術(shù)設(shè)計按子節(jié)點描述方式：描述的方式建議圖文方式,重點在邏輯。圍：任何非文檔其他節(jié)點特定描述的設(shè)計容,包括但不限于：算法,特別數(shù)據(jù)結(jié)構(gòu),邏輯結(jié)構(gòu),文件存儲方案,技巧,經(jīng)驗設(shè)計等。非功能性設(shè)計可維護(hù)性,可測試性,高可用,負(fù)載均衡,安全性,性能等設(shè)計描述或方案。運(yùn)行環(huán)境說明[可選]如果是模塊,則可以簡單描述依賴的所屬系統(tǒng)環(huán)境,如果是系統(tǒng)則對運(yùn)行環(huán)境的詳細(xì)說明,包括：服務(wù)器,網(wǎng)絡(luò)或提供商等?？蛇x描述方式包括：針對云服務(wù)環(huán)境的說明,需要描述采用的服務(wù)配置自建環(huán)境需要對整體硬件,網(wǎng)絡(luò)和環(huán)境進(jìn)行說明。軟件環(huán)境說明包括：OS,基礎(chǔ)軟件,平臺依賴服務(wù)或軟件等功能設(shè)計該模塊的設(shè)計思路為：以現(xiàn)有穩(wěn)定的核心賬務(wù)模塊為基礎(chǔ),擴(kuò)展通用的會計模塊,實現(xiàn)會計科目與賬務(wù)交易建立關(guān)系,并聲稱通用財務(wù)臺賬,以適應(yīng)各種場景的財務(wù)需求。該章節(jié)詳細(xì)描述本模塊的核心功能設(shè)計。功能1功能介紹[必選]需要明確對功能進(jìn)行詳細(xì)描述和介紹,包括功能的表現(xiàn)方式,處理邏輯,使用角色,使用方法,達(dá)到的目的等。重點在：這個功能是干什么用的？最簡示例：會計科目的管理采用定義通用科目樹的方式進(jìn)行管理。所有的科目節(jié)點都在業(yè)務(wù)產(chǎn)生前,由財務(wù)部門分析業(yè)務(wù)后預(yù)先定義好,然后通過該模塊定義到系統(tǒng)使用。頂級〔根科目需要定義該類科目的借貸關(guān)系〔借貸與賬戶增減的關(guān)系,其所有子科目繼承頂級科目的借貸關(guān)系。結(jié)構(gòu)設(shè)計[可選]對功能設(shè)計的數(shù)據(jù)結(jié)構(gòu)或邏輯結(jié)構(gòu)的單獨說明,可根據(jù)該功能對結(jié)構(gòu)的依賴程度來確定是否需單獨描述?？梢圆捎梦淖?自定義圖形或ER圖描述。最簡示例：科目管理的功能設(shè)計采用通用多根的樹型結(jié)構(gòu)設(shè)計,設(shè)計為單表自關(guān)聯(lián)模式〔id,parentId功能設(shè)計[必選]針對該功能的詳細(xì)設(shè)計說明,包括核心數(shù)據(jù),主要功能及描述。重點：這個功能是怎么用的？最簡示例：該功能為BOSS運(yùn)營管理功能。主要業(yè)務(wù)數(shù)據(jù)包括：編碼,路徑〔用于快速搜索,名稱,借貸關(guān)系,備注主要功能：添加/編輯頂級科目,添加/編輯節(jié)點科目,刪除節(jié)點科目,查詢科目等流程設(shè)計[可選]根據(jù)具體功能確定是否需要流程設(shè)計描述。數(shù)據(jù)管理功能,無需流程設(shè)計業(yè)務(wù)邏輯功能,必須有流程設(shè)計。描述方式：時序圖+文字說明如果流程中涉及核心實體的狀態(tài)變更,請增加狀態(tài)圖描述和說明。以下是示例：如上圖所示,臺賬生成的主要處理流程說明如下：請求交易：支付核心〔或交易在組裝交易過程中,調(diào)用賬務(wù)系統(tǒng)的賬戶交易模塊,發(fā)起賬務(wù)交易。交易處理：賬戶交易模塊進(jìn)行賬務(wù)交易處理,核心為根據(jù)賬務(wù)模塊編碼,類型和賬務(wù)邏輯完成參與賬戶的上下賬余額變動處理進(jìn)出賬：根據(jù)賬務(wù)交易處理生成對應(yīng)的進(jìn)出賬流水查詢科目：根據(jù)參與方的賬戶類型,查詢對應(yīng)的科目生產(chǎn)消息：成功〔失敗則不生產(chǎn)消息完成賬務(wù)交易后,理解發(fā)布異步的生成臺賬的通知消息,并在消息中附帶本次交易的科目和交易流水號。賬戶交易模塊同步返回調(diào)用端本次交易結(jié)果。消費(fèi)消息：臺賬生成模塊訂閱消息中心的消息,收到消息后,準(zhǔn)備啟動生成處理。生成臺賬處理：根據(jù)消費(fèi)的消息體容〔科目和流水,生成臺賬。數(shù)據(jù)結(jié)構(gòu)對該模塊的整體數(shù)據(jù)結(jié)構(gòu)進(jìn)行完整的設(shè)計說明。數(shù)據(jù)庫設(shè)計：建議采用ER圖+SQL腳本方式,不推薦直接采用二維表方式展示〔除非表結(jié)構(gòu)較少,5個及以下。其他數(shù)據(jù)結(jié)構(gòu)：圖形+文字描述方式。接口設(shè)計[可選]如果有接口設(shè)計則下面的兩個子節(jié)點為必選。接口方案[必選]描述接