系统分析设计文档模板.docx

系统分析设计文档模板.docx

《系统分析设计文档模板.docx》由会员分享，可在线阅读，更多相关《系统分析设计文档模板.docx（10页珍藏版）》请在冰豆网上搜索。

系统分析设计文档模板

XXX模块/系统

系统分析设计文档模板

文件编号：

版本号：

V0.01

拟制：

日期：

XXXXX有限公司

版权所有不得复制

版本修订记录

日期

版本号

修订人

修改内容

V0.01

初步建立文档

1.引言3

1.1.系统背景3

1.2.编写目的3

1.3.预期读者4

2.总体设计4

2.1.需求说明4

2.2.环境说明4

2.3.技术说明4

2.4.结构设计5

3.功能设计6

3.1.会计科目管理6

3.1.1.功能介绍6

3.1.2.结构设计6

3.1.3.功能设计6

3.2.会计科目配置7

3.2.1.功能介绍7

3.2.2.结构设计7

3.2.3.功能设计7

3.3.生成台账7

3.3.1.功能介绍7

3.3.2.流程设计8

4.数据结构设计9

5.接口设计9

1.概述

1.1.系统背景

【必选】描述本模块或系统的背景和简介。

示例：

本文档描述的是兴业（点芯）账务系统的会计子模块的概要设计，主要提供基于核心账务系统的通用会计功能扩展，实现多场景灵活配置和适配的设计目的，以实现在各银行/分行的推广使用。

1.2.编写目的

【必选】描述本模块或系统的解决的核心问题以及目标。

示例：

针对账务系统的会计模块进行概要的设计说明，以达到一下目的：

1、开发团队内工程师间的业务逻辑和技术设计沟通和传递

2、开发团队与客户的业务逻辑沟通和传递。

1.3.预期读者

示例：

开发人员，项目经理，测试人员，运营，运维等等。

1.4.相关术语

1）列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文

术语

描述

2.需求分析

2.1.总体需求

【必选】概要描述整体需求，建议包含以下几个部分：

1、关键业务领域边界描述

2、系统建设目标及规划

2.2.用例分析

【必选】通用对用例的分析，直观的展示所有角色和相关业务功能，动作的总体关系。

1、介绍和描述系统内与业务相关的所有角色定义和对应的用例。

2、可以根据文档描述的系统或模块的规模，增加子模块细分后进行用例描述和介绍。

2.3.关键业务需求

【必选】业务目标描述

2.4.非功能需求

【可选】

1.应用架构目标描述

2.性能目标描述

3.可靠性描述，如：

数据需要100%保证一致性，100%保证实时性

4.安全性，隔离性目标描述

5.可扩展目标描述

1.总体设计

1.1.内部结构设计

【必选】详细描述系统或模块的内部逻辑结构设计（对标架构设计的逻辑架构）。

目的是让读者概要性的总体了解你的系统或模块内部设计和结构。

建议介绍方式：

3、系统结构图（层次框图）

4、对结构图中各块进行详细功能和设计介绍，同时描述块间的关系。

下图是一个账务系统的示例：

如图所示：

1、蓝色部分为通用账务系统的核心。

2、橙色部分为账务系统的会计模板，是本文档重点设计和说明的部分。

设计说明：

1、会计科目：

设计多级结构（至少两级）的通用会计客户自定义配置模块。

可根据场景需求定义会计科目树。

2、会计科目配置：

配置定义的会计科目与账户类型的关系，以建立账户交易与科目的关联。

科目与账户类型的关系为一对多关系。

3、台账：

在账户产生交易并声称进出账（流水）后，根据会计科目与账户elixir的关系，准实时生成台账。

4、会计报表：

根据台账，进出账和账户余额定制会计报表。

1.2.关系结构设计

【必选】本节点主要用于描述本文设计的系统或模块与外部系统的关系，交互模式等。

让读者了解本系统或模块对外部资源的依赖或对外部系统提供的服务。

1、建议采用结构图连线方式介绍

2、重点介绍整体结构图中，外部系统或模块的角色，需求和能力。

3、标注和描述每个链线的核心动作是什么。

示例：

金融科技平台中的子系统的架构设计PPT图：

以下是针对设计图的详细说明。

。

。

。

1.3.关键技术设计

【可选】对模块或系统中的关键技术设计详细描述，建议编写方式如下：

4、结构：

可以针对多个关键技术设计按子节点描述

5、方式：

描述的方式建议图文方式，重点在逻辑。

6、范围：

任何非文档内其他节点特定描述的设计内容，包括但不限于：

算法，特别数据结构，逻辑结构，文件存储方案，技巧，经验设计等。

1.4.非功能性设计

可维护性，可测试性，高可用，负载均衡，安全性，性能等设计描述或方案。

1.5.运行环境说明

【可选】如果是模块，则可以简单描述依赖的所属系统环境，如果是系统则对运行环境的详细说明，包括：

服务器，网络或提供商等。

可选描述方式包括：

1、针对云服务环境的说明，需要描述采用的服务配置

2、自建环境需要对整体硬件，网络和环境进行说明。

3、软件环境说明包括：

OS，基础软件，平台依赖服务或软件等

2.功能设计

该模块的设计思路为：

以现有稳定的核心账务模块为基础，扩展通用的会计模块，实现会计科目与账务交易建立关系，并声称通用财务台账，以适应各种场景的财务需求。

该章节详细描述本模块的核心功能设计。

2.1.功能1

2.1.1.功能介绍

【必选】需要明确对功能进行详细描述和介绍，包括功能的表现方式，处理逻辑，使用角色，使用方法，达到的目的等。

重点在：

这个功能是干什么用的？

最简示例：

会计科目的管理采用定义通用科目树的方式进行管理。

所有的科目节点都在业务产生前，由财务部门分析业务后预先定义好，然后通过该模块定义到系统内使用。

顶级（根）科目需要定义该类科目的借贷关系（借贷与账户增减的关系），其所有子科目继承顶级科目的借贷关系。

2.1.2.结构设计

【可选】对功能设计的数据结构或逻辑结构的单独说明，可根据该功能对结构的依赖程度来确定是否需单独描述。

可以采用文字，自定义图形或ER图描述。

最简示例：

科目管理的功能设计采用通用多根的树型结构设计，设计为单表自关联模式（id，parentId）

2.1.3.功能设计

【必选】针对该功能的详细设计说明，包括核心数据，主要功能及描述。

重点：

这个功能是怎么用的？

最简示例：

该功能为BOSS运营管理功能。

主要业务数据包括：

编码，路径（用于快速搜索），名称，借贷关系，备注

主要功能：

添加/编辑顶级科目，添加/编辑节点科目，删除节点科目，查询科目等

2.1.4.流程设计

【可选】根据具体功能确定是否需要流程设计描述。

1、数据管理功能，无需流程设计

2、业务逻辑功能，必须有流程设计。

3、描述方式：

时序图+文字说明

4、如果流程中涉及核心实体的状态变更，请增加状态图描述和说明。

以下是示例：

如上图所示，台账生成的主要处理流程说明如下：

1、请求交易：

支付核心（或交易）在组装交易过程中，调用账务系统的账户交易模块，发起账务交易。

2、交易处理：

账户交易模块进行账务交易处理，核心为根据账务模块编码，类型和账务逻辑完成参与账户的上下账余额变动处理

3、进出账：

根据账务交易处理生成对应的进出账流水

4、查询科目：

根据参与方的账户类型，查询对应的科目

5、生产消息：

成功（失败则不生产消息）完成账务交易后，理解发布异步的生成台账的通知消息，并在消息中附带本次交易的科目和交易流水号。

6、账户交易模块同步返回调用端本次交易结果。

7、消费消息：

台账生成模块订阅消息中心的消息，收到消息后，准备启动生成处理。

8、生成台账处理：

根据消费的消息体内容（科目和流水），生成台账。

3.数据结构

对该模块的整体数据结构进行完整的设计说明。

1、数据库设计：

建议采用ER图+SQL脚本方式，不推荐直接采用二维表方式展示（除非表结构较少，5个及以下）。

2、其他数据结构：

图形+文字描述方式。

4.接口设计

【可选】如果有接口设计则下面的两个子节点为必选。

4.1.接口方案

【必选】描述接口的实现方案，包括：

结构，协议，安全等。

一般可选为：

dubbo，cxf,openapi,json自定义等。

4.2.接口定义

【必选】，需要对具体接口的能力描述，报文描述。

这里可以是核心部分接口详细描述，非重点功能接口概要描述。

4.2.1.功能介绍

4.2.2.报文说明

5.附件

这里可以引用文档中涉及的其他文档说明，可以包括PRD等。