项目简介
[必选] 项目的一般介绍。
功能特性
[必选] 列出项目支持的功能及特性。
- 特性xxxxx。
- 特性xxxxx。
- 特性xxxxx。
项目结构
[必选] 列出项目的工程结构,模块及相应的描述。
| 模块 | 描述 |
|---|---|
| xxx-web | 启动入口层,对外提供Web服务 |
| xxx-application | 应用层,领域服务的门面,用于业务能力组合编排 |
| xxx-infra | 基础设施层,包括核心接口实现,数据库访问等 |
| xxx-domain | 领域层,包括核心业务领域对象,接口能力定义等 |
| xxx-spec | 公用业务域基础包,例如通用的vo,类型转换,枚举,工具类等定义 |
| xxx-sdk | 提供的接入SDK,业务系统通过该SDK接入 |
业务流程
[必选] 列出项目的核心业务流程。
技术架构
[可选] 技术架构图
外部依赖
[可选] 列出项目所依赖的其他系统,比如重试系统依赖DDC。
| 系统名称 | 上游/下游 | 依赖方式 | 依赖说明 |
|---|---|---|---|
| x | x | x | x |
项目文档
[可选]列出项目中的需求文档,PRD文档,参考文档等。
| 文档用途 | 文档地址 |
|---|---|
| xxxx | xxxx |
FAQ
[可选] 列出项目中常见的问题列表。
答:xxxx