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

系統(tǒng)分析設(shè)計(jì)文檔-模板用時(shí)可以刪除XXX模塊/系統(tǒng)系統(tǒng)分析設(shè)計(jì)文檔模板XXXXX有限公司1.引言..................................................................................................................錯(cuò)誤!未定義書簽。.系統(tǒng)背景...........................................................................................錯(cuò)誤!未定義書簽。.編寫目的...........................................................................................錯(cuò)誤!未定義書簽。.預(yù)期讀者...........................................................................................錯(cuò)誤!未定義書簽。2.總體設(shè)計(jì)..........................................................................................................錯(cuò)誤!未定義書簽。.需求說(shuō)明...........................................................................................錯(cuò)誤!未定義書簽。.環(huán)境說(shuō)明...........................................................................................錯(cuò)誤!未定義書簽。.技術(shù)說(shuō)明...........................................................................................錯(cuò)誤!未定義書簽。.結(jié)構(gòu)設(shè)計(jì)...........................................................................................錯(cuò)誤!未定義書簽。3.功能設(shè)計(jì)..........................................................................................................錯(cuò)誤!未定義書簽。.會(huì)計(jì)科目管理...................................................................................錯(cuò)誤!未定義書簽。功能介紹..................................................................................錯(cuò)誤!未定義書簽。結(jié)構(gòu)設(shè)計(jì)..................................................................................錯(cuò)誤!未定義書簽。功能設(shè)計(jì)..................................................................................錯(cuò)誤!未定義書簽。.會(huì)計(jì)科目配置...................................................................................錯(cuò)誤!未定義書簽。功能介紹..................................................................................錯(cuò)誤!未定義書簽。結(jié)構(gòu)設(shè)計(jì)..................................................................................錯(cuò)誤!未定義書簽。功能設(shè)計(jì)..................................................................................錯(cuò)誤!未定義書簽。.生成臺(tái)賬...........................................................................................錯(cuò)誤!未定義書簽。功能介紹..................................................................................錯(cuò)誤!未定義書簽。流程設(shè)計(jì)..................................................................................錯(cuò)誤!未定義書簽。4.數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)..................................................................................................錯(cuò)誤!未定義書簽。5.接口設(shè)計(jì)..........................................................................................................錯(cuò)誤!未定義書簽。1.1.系統(tǒng)背景【必選】描述本模塊或系統(tǒng)的背景和簡(jiǎn)介。本文檔描述的是興業(yè)(點(diǎn)芯)賬務(wù)系統(tǒng)的會(huì)計(jì)子模塊的概要設(shè)計(jì)，主要提供基于核心賬務(wù)的1.2.編寫目的【必選】描述本模塊或系統(tǒng)的解決的核心問(wèn)題以及目標(biāo)。明，以達(dá)到一下目的：1、開發(fā)團(tuán)隊(duì)內(nèi)工程師間的業(yè)務(wù)邏輯和技術(shù)設(shè)計(jì)溝通和傳遞1.3.預(yù)期讀者開發(fā)人員，項(xiàng)目經(jīng)理，測(cè)試人員，運(yùn)營(yíng)，運(yùn)維等等。1.4.相關(guān)術(shù)語(yǔ)1)列出本文檔中用到的可能會(huì)引起混淆的專門術(shù)語(yǔ)、定義和縮寫詞的原文術(shù)語(yǔ)術(shù)語(yǔ)描述2.需求分析2.1.總體需求【必選】概要描述整體需求，建議包含以下幾個(gè)部分：2.2.用例分析【必選】通用對(duì)用例的分析，直觀的展示所有角色和相關(guān)業(yè)務(wù)功能，動(dòng)作的總體關(guān)的所有角色定義和對(duì)應(yīng)的用例。2、可以根據(jù)文檔描述的系統(tǒng)或模塊的規(guī)模，增加子模塊細(xì)分后進(jìn)行用例描述和2.3.關(guān)鍵業(yè)務(wù)需求【必選】業(yè)務(wù)目標(biāo)描述2.4.非功能需求【可選】1.應(yīng)用架構(gòu)目標(biāo)描述2.性能目標(biāo)描述4.安全性，隔離性目標(biāo)描述5.可擴(kuò)展目標(biāo)描述1.1.內(nèi)部結(jié)構(gòu)設(shè)計(jì)【必選】詳細(xì)描述系統(tǒng)或模塊的內(nèi)部邏輯結(jié)構(gòu)設(shè)計(jì)(對(duì)標(biāo)架構(gòu)設(shè)計(jì)的邏輯架構(gòu))。目的是讓讀者概要性的總體了解你的系統(tǒng)或模塊內(nèi)部設(shè)計(jì)和結(jié)構(gòu)。建議介紹方式：系統(tǒng)結(jié)構(gòu)圖(層次框圖)4、對(duì)結(jié)構(gòu)圖中各塊進(jìn)行詳細(xì)功能和設(shè)計(jì)介紹，同時(shí)描述塊間的關(guān)系。下圖是一個(gè)賬務(wù)系統(tǒng)的示例：2、橙色部分為賬務(wù)系統(tǒng)的會(huì)計(jì)模板，是本文檔重點(diǎn)設(shè)計(jì)和說(shuō)明的部分。1、會(huì)計(jì)科目：設(shè)計(jì)多級(jí)結(jié)構(gòu)(至少兩級(jí))的通用會(huì)計(jì)客戶自定義配置模塊?？筛鶕?jù)場(chǎng)景需求2、會(huì)計(jì)科目配置：配置定義的會(huì)計(jì)科目與賬戶類型的關(guān)系，以建立賬戶交易與科目的關(guān)聯(lián)。：根據(jù)臺(tái)賬，進(jìn)出賬和賬戶余額定制會(huì)計(jì)報(bào)表。1.2.關(guān)系結(jié)構(gòu)設(shè)計(jì)【必選】本節(jié)點(diǎn)主要用于描述本文設(shè)計(jì)的系統(tǒng)或模塊與外部系統(tǒng)的關(guān)系，交互模式等。讓讀者了解本系統(tǒng)或模塊對(duì)外部資源的依賴或?qū)ν獠肯到y(tǒng)提供的服務(wù)。2、重點(diǎn)介紹整體結(jié)構(gòu)圖中，外部系統(tǒng)或模塊的角色，需求和能力。示例：金融科技平臺(tái)中的子系統(tǒng)的架構(gòu)設(shè)PT圖：以下是針對(duì)設(shè)計(jì)圖的詳細(xì)說(shuō)明。。。。1.3.關(guān)鍵技術(shù)設(shè)計(jì)【可選】對(duì)模塊或系統(tǒng)中的關(guān)鍵技術(shù)設(shè)計(jì)詳細(xì)描述，建議編寫方式如下：6、范圍：任何非文檔內(nèi)其他節(jié)點(diǎn)特定描述的設(shè)計(jì)內(nèi)容，包括但不限于：算法，特別數(shù)據(jù)結(jié)構(gòu)，邏輯結(jié)構(gòu)，文件存儲(chǔ)方案，技巧，經(jīng)驗(yàn)設(shè)計(jì)等。1.4.非功能性設(shè)計(jì)可維護(hù)性，可測(cè)試性，高可用，負(fù)載均衡，安全性，性能等設(shè)計(jì)描述或方案。1.5.運(yùn)行環(huán)境說(shuō)明【可選】如果是模塊，則可以簡(jiǎn)單描述依賴的所屬系統(tǒng)環(huán)境，如果是系統(tǒng)則對(duì)運(yùn)行環(huán)境的詳細(xì)說(shuō)明，包括：服務(wù)器，網(wǎng)絡(luò)或提供商等?？蛇x描述方式包括：針對(duì)云服務(wù)環(huán)境的說(shuō)明，需要描述采用的服務(wù)配置自建環(huán)境需要對(duì)整體硬件，網(wǎng)絡(luò)和環(huán)境進(jìn)行說(shuō)明。2.功能設(shè)計(jì)該模塊的設(shè)計(jì)思路為：以現(xiàn)有穩(wěn)定的核心賬務(wù)模塊為基礎(chǔ)，擴(kuò)展通用的會(huì)計(jì)模。詳細(xì)描述本模塊的核心功能設(shè)計(jì)。2.1.1.功能介紹【必選】需要明確對(duì)功能進(jìn)行詳細(xì)描述和介紹，包括功能的表現(xiàn)方式，處理邏輯，使用角色，使用方法，達(dá)到的目的等。重點(diǎn)在：這個(gè)功能是干什么用的會(huì)計(jì)科目的管理采用定義通用科目樹的方式進(jìn)行管理。所有的科目節(jié)點(diǎn)都在業(yè)務(wù)產(chǎn)生前，由財(cái)務(wù)部門分析業(yè)務(wù)后預(yù)先定義好，然后通過(guò)該模塊定義到系統(tǒng)內(nèi)使用。頂級(jí)(根)科目需要定義該類科目的借貸關(guān)系(借貸與賬戶增減的關(guān)系)，其所有子科目繼承頂級(jí)科目的借貸關(guān)系。2.1.2.結(jié)構(gòu)設(shè)計(jì)【可選】對(duì)功能設(shè)計(jì)的數(shù)據(jù)結(jié)構(gòu)或邏輯結(jié)構(gòu)的單獨(dú)說(shuō)明，可根據(jù)該功能對(duì)結(jié)構(gòu)的依科目管理的功能設(shè)計(jì)采用通用多根的樹型結(jié)構(gòu)設(shè)計(jì)，設(shè)計(jì)為單表自關(guān)聯(lián)模式(id，parentId)2.1.3.功能設(shè)計(jì)個(gè)功能是怎么用的主要功能：添加/編輯頂級(jí)科目，添編輯節(jié)點(diǎn)科目，刪除節(jié)點(diǎn)科目，查詢科2.1.4.流程設(shè)計(jì)【可選】根據(jù)具體功能確定是否需要流程設(shè)計(jì)描述。數(shù)據(jù)管理功能，無(wú)需流程設(shè)計(jì)業(yè)務(wù)邏輯功能，必須有流程設(shè)計(jì)。明如果流程中涉及核心實(shí)體的狀態(tài)變更，請(qǐng)?jiān)黾訝顟B(tài)圖描述和說(shuō)明。如上圖所示，臺(tái)賬生成的主要處理流程說(shuō)明如下：1、請(qǐng)求交易：支付核心(或交易)在組裝交易過(guò)程中，調(diào)用賬務(wù)系統(tǒng)的賬戶交易模塊，發(fā)起賬務(wù)交易。2、交易處理：賬戶交易模塊進(jìn)行賬務(wù)交易處理，核心為根據(jù)賬務(wù)模塊編碼，類型和賬務(wù)邏輯完成參與賬戶的上下賬余額變動(dòng)處理處理生成對(duì)應(yīng)的進(jìn)出賬流水、查詢科目：根據(jù)參與方的賬戶類型，查詢對(duì)應(yīng)的科目5、生產(chǎn)消息：成功(失敗則不生產(chǎn)消息)完成賬務(wù)交易后，理解發(fā)布異步的生成臺(tái)賬的通知消息，并在消息中附帶本次交易的科目和交易流水號(hào)。7、消費(fèi)消息：臺(tái)賬生成模塊訂閱消息中心的消息，收到消息后，準(zhǔn)備啟動(dòng)生成8、生成臺(tái)賬處