XXX模塊/系統(tǒng)系統(tǒng)分析設(shè)計(jì)文檔模板文獻(xiàn)編號：版本號：V0.01擬制：日期：XXXXX有限公司版權(quán)全部不得復(fù)制

版本修訂統(tǒng)計(jì)日期版本號修訂人修改內(nèi)容V0.01初步建立文檔

目錄1. 引言 31.1. 系統(tǒng)背景 31.2. 編寫目的 31.3. 預(yù)期讀者 42. 總體設(shè)計(jì) 42.1. 需求闡明 42.2. 環(huán)境闡明 42.3. 技術(shù)闡明 42.4. 構(gòu)造設(shè)計(jì) 53. 功效設(shè)計(jì) 63.1. 會計(jì)科目管理 63.1.1. 功效介紹 63.1.2. 構(gòu)造設(shè)計(jì) 63.1.3. 功效設(shè)計(jì) 63.2. 會計(jì)科目配備 73.2.1. 功效介紹 73.2.2. 構(gòu)造設(shè)計(jì) 73.2.3. 功效設(shè)計(jì) 73.3. 生成臺賬 73.3.1. 功效介紹 73.3.2. 流程設(shè)計(jì) 84. 數(shù)據(jù)構(gòu)造設(shè)計(jì) 95. 接口設(shè)計(jì) 9

概述系統(tǒng)背景【必選】描述本模塊或系統(tǒng)的背景和介紹。示例：本文檔描述的是興業(yè)（點(diǎn)芯）賬務(wù)系統(tǒng)的會計(jì)子模塊的概要設(shè)計(jì)，重要提供基于核心賬務(wù)系統(tǒng)的通用會計(jì)功效擴(kuò)展，實(shí)現(xiàn)多場景靈活配備和適配的設(shè)計(jì)目的，以實(shí)現(xiàn)在各銀行/分行的推廣使用。編寫目的【必選】描述本模塊或系統(tǒng)的解決的核心問題以及目的。示例：針對賬務(wù)系統(tǒng)的會計(jì)模塊進(jìn)行概要的設(shè)計(jì)闡明，以達(dá)成一下目的：開發(fā)團(tuán)體內(nèi)工程師間的業(yè)務(wù)邏輯和技術(shù)設(shè)計(jì)溝通和傳遞開發(fā)團(tuán)體與客戶的業(yè)務(wù)邏輯溝通和傳遞。預(yù)期讀者示例：開發(fā)人員，項(xiàng)目經(jīng)理，測試人員，運(yùn)行，運(yùn)維等等。有關(guān)術(shù)語1）列出本文檔中用到的可能會引發(fā)混淆的專門術(shù)語、定義和縮寫詞的原文術(shù)語描述需求分析總體需求【必選】概要描述整體需求，建議包含下列幾個部分：核心業(yè)務(wù)領(lǐng)域邊界描述系統(tǒng)建設(shè)目的及規(guī)劃用例分析【必選】通用對用例的分析，直觀的展示全部角色和有關(guān)業(yè)務(wù)功效，動作的總體關(guān)系。介紹和描述系統(tǒng)內(nèi)與業(yè)務(wù)有關(guān)的全部角色定義和對應(yīng)的用例。能夠根據(jù)文檔描述的系統(tǒng)或模塊的規(guī)模，增加子模塊細(xì)分后進(jìn)行用例描述和介紹。核心業(yè)務(wù)需求【必選】業(yè)務(wù)目的描述非功效需求【可選】應(yīng)用架構(gòu)目的描述性能目的描述可靠性描述，如：數(shù)據(jù)需要100%確保一致性，100%確保明時(shí)性安全性，隔離性目的描述可擴(kuò)展目的描述總體設(shè)計(jì)內(nèi)部構(gòu)造設(shè)計(jì)【必選】具體描述系統(tǒng)或模塊的內(nèi)部邏輯構(gòu)造設(shè)計(jì)（對標(biāo)架構(gòu)設(shè)計(jì)的邏輯架構(gòu)）。目的是讓讀者概要性的總體理解你的系統(tǒng)或模塊內(nèi)部設(shè)計(jì)和構(gòu)造。建議介紹方式：系統(tǒng)構(gòu)造圖（層次框圖）對構(gòu)造圖中各塊進(jìn)行具體功效和設(shè)計(jì)介紹，同時(shí)描述塊間的關(guān)系。下圖是一種賬務(wù)系統(tǒng)的示例：如圖所示：藍(lán)色部分為通用賬務(wù)系統(tǒng)的核心。橙色部分為賬務(wù)系統(tǒng)的會計(jì)模板，是本文檔重點(diǎn)設(shè)計(jì)和闡明的部分。設(shè)計(jì)闡明：會計(jì)科目：設(shè)計(jì)多級構(gòu)造（最少兩級）的通用會計(jì)客戶自定義配備模塊。可根據(jù)場景需求定義會計(jì)科目樹。會計(jì)科目配備：配備定義的會計(jì)科目與賬戶類型的關(guān)系，以建立賬戶交易與科目的關(guān)聯(lián)。科目與賬戶類型的關(guān)系為一對多關(guān)系。臺賬：在賬戶產(chǎn)生交易并聲稱進(jìn)出賬（流水）后，根據(jù)會計(jì)科目與賬戶elixir的關(guān)系，準(zhǔn)實(shí)時(shí)生成臺賬。會計(jì)報(bào)表：根據(jù)臺賬，進(jìn)出賬和賬戶余額定制會計(jì)報(bào)表。關(guān)系構(gòu)造設(shè)計(jì)【必選】本節(jié)點(diǎn)重要用于描述本文設(shè)計(jì)的系統(tǒng)或模塊與外部系統(tǒng)的關(guān)系，交互模式等。讓讀者理解本系統(tǒng)或模塊對外部資源的依賴或?qū)ν獠肯到y(tǒng)提供的服務(wù)。建議采用構(gòu)造圖連線方式介紹重點(diǎn)介紹整體構(gòu)造圖中，外部系統(tǒng)或模塊的角色，需求和能力。標(biāo)注和描述每個鏈線的核心動作是什么。示例：金融科技平臺中的子系統(tǒng)的架構(gòu)設(shè)計(jì)PPT圖：下列是針對設(shè)計(jì)圖的具體闡明。。。。 核心技術(shù)設(shè)計(jì)【可選】對模塊或系統(tǒng)中的核心技術(shù)設(shè)計(jì)具體描述，建議編寫方式以下：構(gòu)造：能夠針對多個核心技術(shù)設(shè)計(jì)按子節(jié)點(diǎn)描述方式：描述的方式建議圖文方式，重點(diǎn)在邏輯。范疇：任何非文檔內(nèi)其它節(jié)點(diǎn)特定描述的設(shè)計(jì)內(nèi)容，涉及但不限于：算法，特別數(shù)據(jù)構(gòu)造，邏輯構(gòu)造，文獻(xiàn)存儲方案，技巧，經(jīng)驗(yàn)設(shè)計(jì)等。非功效性設(shè)計(jì)可維護(hù)性，可測試性，高可用，負(fù)載均衡，安全性，性能等設(shè)計(jì)描述或方案。運(yùn)行環(huán)境闡明【可選】如果是模塊，則能夠簡樸描述依賴的所屬系統(tǒng)環(huán)境，如果是系統(tǒng)則對運(yùn)行環(huán)境的具體闡明，涉及：服務(wù)器，網(wǎng)絡(luò)或提供商等。可選描述方式涉及：針對云服務(wù)環(huán)境的闡明，需要描述采用的服務(wù)配備自建環(huán)境需要對整體硬件，網(wǎng)絡(luò)和環(huán)境進(jìn)行闡明。軟件環(huán)境闡明涉及：OS，基礎(chǔ)軟件，平臺依賴服務(wù)或軟件等功效設(shè)計(jì)該模塊的設(shè)計(jì)思路為：以現(xiàn)有穩(wěn)定的核心賬務(wù)模塊為基礎(chǔ)，擴(kuò)展通用的會計(jì)模塊，實(shí)現(xiàn)會計(jì)科目與賬務(wù)交易建立關(guān)系，并聲稱通用財(cái)務(wù)臺賬，以適應(yīng)多個場景的財(cái)務(wù)需求。該章節(jié)具體描述本模塊的核心功效設(shè)計(jì)。功效1功效介紹【必選】需要明確對功效進(jìn)行具體描述和介紹，涉及功效的體現(xiàn)方式，解決邏輯，使用角色，使用辦法，達(dá)成的目的等。重點(diǎn)在：這個功效是干什么用的？最簡示例：會計(jì)科目的管理采用定義通用科目樹的方式進(jìn)行管理。全部的科目節(jié)點(diǎn)都在業(yè)務(wù)產(chǎn)生前，由財(cái)務(wù)部門分析業(yè)務(wù)后預(yù)先定義好，然后通過該模塊定義到系統(tǒng)內(nèi)使用。頂級（根）科目需要定義該類科目的借貸關(guān)系（借貸與賬戶增減的關(guān)系），其全部子科目繼承頂級科目的借貸關(guān)系。構(gòu)造設(shè)計(jì)【可選】對功效設(shè)計(jì)的數(shù)據(jù)構(gòu)造或邏輯構(gòu)造的單獨(dú)闡明，可根據(jù)該功效對構(gòu)造的依賴程度來擬定與否需單獨(dú)描述。能夠采用文字，自定義圖形或ER圖描述。最簡示例：科目管理的功效設(shè)計(jì)采用通用多根的樹型構(gòu)造設(shè)計(jì)，設(shè)計(jì)為單表自關(guān)聯(lián)模式（id，parentId）功效設(shè)計(jì)【必選】針對該功效的具體設(shè)計(jì)闡明，涉及核心數(shù)據(jù)，重要功效及描述。重點(diǎn)：這個功效是怎么用的？最簡示例：該功效為BOSS運(yùn)行管理功效。重要業(yè)務(wù)數(shù)據(jù)涉及：編碼，途徑（用于快速搜索），名稱，借貸關(guān)系，備注重要功效：添加/編輯頂級科目，添加/編輯節(jié)點(diǎn)科目，刪除節(jié)點(diǎn)科目，查詢科目等流程設(shè)計(jì)【可選】根據(jù)具體功效擬定與否需要流程設(shè)計(jì)描述。數(shù)據(jù)管理功效，無需流程設(shè)計(jì)業(yè)務(wù)邏輯功效，必須有流程設(shè)計(jì)。描述方式：時(shí)序圖+文字闡明如果流程中涉及核心實(shí)體的狀態(tài)變更，請?jiān)黾訝顟B(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ù)交易后，理解公布異步的生成臺賬的告知消息，并在消息中附帶本次交易的科目和交易流水號。賬戶交易模塊同時(shí)返回調(diào)用端本次交易成果。消費(fèi)消息：臺賬生成模塊訂閱消息中心的消息，收到消息后，準(zhǔn)備啟動生成解決。生成臺賬解決：根據(jù)消費(fèi)的消息體內(nèi)容（科目和流水），生成臺賬。數(shù)據(jù)構(gòu)造對該模塊的整體數(shù)據(jù)構(gòu)造進(jìn)行完整的設(shè)計(jì)闡明。數(shù)據(jù)庫設(shè)計(jì)：建議采用ER圖+SQL腳本方式，不推薦直接采用二維表方式展示（除非表構(gòu)造較少，5個及下列）。其它數(shù)據(jù)構(gòu)造：圖形+文字描述方式。接口設(shè)計(jì)【可選】如果有接口設(shè)計(jì)則下面的兩個子節(jié)點(diǎn)為必選。接口方案【