系统分析设计文档模板

XXX模块/系统系统分析设计文档模板文献编号：版本号：V0.01拟制：日期：XXXXX有限公司版权全部不得复制

版本修订统计日期版本号修订人修改内容V0.01初步建立文档

目录1. 引言 31.1. 系统背景 31.2. 编写目的 31.3. 预期读者 42. 总体设计 42.1. 需求阐明 42.2. 环境阐明 42.3. 技术阐明 42.4. 构造设计 53. 功效设计 63.1. 会计科目管理 63.1.1. 功效介绍 63.1.2. 构造设计 63.1.3. 功效设计 63.2. 会计科目配备 73.2.1. 功效介绍 73.2.2. 构造设计 73.2.3. 功效设计 73.3. 生成台账 73.3.1. 功效介绍 73.3.2. 流程设计 84. 数据构造设计 95. 接口设计 9

概述系统背景【必选】描述本模块或系统的背景和介绍。示例：本文档描述的是兴业（点芯）账务系统的会计子模块的概要设计，重要提供基于核心账务系统的通用会计功效扩展，实现多场景灵活配备和适配的设计目的，以实现在各银行/分行的推广使用。编写目的【必选】描述本模块或系统的解决的核心问题以及目的。示例：针对账务系统的会计模块进行概要的设计阐明，以达成一下目的：开发团体内工程师间的业务逻辑和技术设计沟通和传递开发团体与客户的业务逻辑沟通和传递。预期读者示例：开发人员，项目经理，测试人员，运行，运维等等。有关术语1）列出本文档中用到的可能会引发混淆的专门术语、定义和缩写词的原文术语描述需求分析总体需求【必选】概要描述整体需求，建议包含下列几个部分：核心业务领域边界描述系统建设目的及规划用例分析【必选】通用对用例的分析，直观的展示全部角色和有关业务功效，动作的总体关系。介绍和描述系统内与业务有关的全部角色定义和对应的用例。能够根据文档描述的系统或模块的规模，增加子模块细分后进行用例描述和介绍。核心业务需求【必选】业务目的描述非功效需求【可选】应用架构目的描述性能目的描述可靠性描述，如：数据需要100%确保一致性，100%确保明时性安全性，隔离性目的描述可扩展目的描述总体设计内部构造设计【必选】具体描述系统或模块的内部逻辑构造设计（对标架构设计的逻辑架构）。目的是让读者概要性的总体理解你的系统或模块内部设计和构造。建议介绍方式：系统构造图（层次框图）对构造图中各块进行具体功效和设计介绍，同时描述块间的关系。下图是一种账务系统的示例：如图所示：蓝色部分为通用账务系统的核心。橙色部分为账务系统的会计模板，是本文档重点设计和阐明的部分。设计阐明：会计科目：设计多级构造（最少两级）的通用会计客户自定义配备模块。可根据场景需求定义会计科目树。会计科目配备：配备定义的会计科目与账户类型的关系，以建立账户交易与科目的关联。科目与账户类型的关系为一对多关系。台账：在账户产生交易并声称进出账（流水）后，根据会计科目与账户elixir的关系，准实时生成台账。会计报表：根据台账，进出账和账户余额定制会计报表。关系构造设计【必选】本节点重要用于描述本文设计的系统或模块与外部系统的关系，交互模式等。让读者理解本系统或模块对外部资源的依赖或对外部系统提供的服务。建议采用构造图连线方式介绍重点介绍整体构造图中，外部系统或模块的角色，需求和能力。标注和描述每个链线的核心动作是什么。示例：金融科技平台中的子系统的架构设计PPT图：下列是针对设计图的具体阐明。。。。 核心技术设计【可选】对模块或系统中的核心技术设计具体描述，建议编写方式以下：构造：能够针对多个核心技术设计按子节点描述方式：描述的方式建议图文方式，重点在逻辑。范畴：任何非文档内其它节点特定描述的设计内容，涉及但不限于：算法，特别数据构造，逻辑构造，文献存储方案，技巧，经验设计等。非功效性设计可维护性，可测试性，高可用，负载均衡，安全性，性能等设计描述或方案。运行环境阐明【可选】如果是模块，则能够简朴描述依赖的所属系统环境，如果是系统则对运行环境的具体阐明，涉及：服务器，网络或提供商等。可选描述方式涉及：针对云服务环境的阐明，需要描述采用的服务配备自建环境需要对整体硬件，网络和环境进行阐明。软件环境阐明涉及：OS，基础软件，平台依赖服务或软件等功效设计该模块的设计思路为：以现有稳定的核心账务模块为基础，扩展通用的会计模块，实现会计科目与账务交易建立关系，并声称通用财务台账，以适应多个场景的财务需求。该章节具体描述本模块的核心功效设计。功效1功效介绍【必选】需要明确对功效进行具体描述和介绍，涉及功效的体现方式，解决逻辑，使用角色，使用办法，达成的目的等。重点在：这个功效是干什么用的？最简示例：会计科目的管理采用定义通用科目树的方式进行管理。全部的科目节点都在业务产生前，由财务部门分析业务后预先定义好，然后通过该模块定义到系统内使用。顶级（根）科目需要定义该类科目的借贷关系（借贷与账户增减的关系），其全部子科目继承顶级科目的借贷关系。构造设计【可选】对功效设计的数据构造或逻辑构造的单独阐明，可根据该功效对构造的依赖程度来拟定与否需单独描述。能够采用文字，自定义图形或ER图描述。最简示例：科目管理的功效设计采用通用多根的树型构造设计，设计为单表自关联模式（id，parentId）功效设计【必选】针对该功效的具体设计阐明，涉及核心数据，重要功效及描述。重点：这个功效是怎么用的？最简示例：该功效为BOSS运行管理功效。重要业务数据涉及：编码，途径（用于快速搜索），名称，借贷关系，备注重要功效：添加/编辑顶级科目，添加/编辑节点科目，删除节点科目，查询科目等流程设计【可选】根据具体功效拟定与否需要流程设计描述。数据管理功效，无需流程设计业务逻辑功效，必须有流程设计。描述方式：时序图+文字阐明如果流程中涉及核心实体的状态变更，请增加状态图描述和阐明。下列是示例：如上图所示，台账生成的重要解决流程阐明以下：请求交易：支付核心（或交易）在组装交易过程中，调用账务系统的账户交易模块，发起账务交易。交易解决：账户交易模块进行账务交易解决，核心为根据账务模块编码，类型和账务逻辑完毕参加账户的上下账余额变动解决进出账：根据账务交易解决生成对应的进出账流水查询科目：根据参加方的账户类型，查询对应的科目生产消息：成功（失败则不生产消息）完毕账务交易后，理解公布异步的生成台账的告知消息，并在消息中附带本次交易的科目和交易流水号。账户交易模块同时返回调用端本次交易成果。消费消息：台账生成模块订阅消息中心的消息，收到消息后，准备启动生成解决。生成台账解决：根据消费的消息体内容（科目和流水），生成台账。数据构造对该模块的整体数据构造进行完整的设计阐明。数据库设计：建议采用ER图+SQL脚本方式，不推荐直接采用二维表方式展示（除非表构造较少，5个及下列）。其它数据构造：图形+文字描述方式。接口设计【可选】如果有接口设计则下面的两个子节点为必选。接口方案【