feat: 根目录文档、脚本、gitignore
This commit is contained in:
@@ -0,0 +1,154 @@
|
||||
# 产品整体架构文档
|
||||
|
||||
## 1. 产品定位
|
||||
|
||||
### 1.1 产品目标
|
||||
<!-- 描述产品要解决的核心问题 -->
|
||||
|
||||
### 1.2 核心价值
|
||||
<!-- 产品的独特价值主张 -->
|
||||
|
||||
### 1.3 目标用户
|
||||
<!-- 主要用户群体及其特征 -->
|
||||
|
||||
### 1.4 使用场景
|
||||
<!-- 典型使用场景描述 -->
|
||||
|
||||
---
|
||||
|
||||
## 2. 系统整体架构
|
||||
|
||||
### 2.1 架构分层
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────┐
|
||||
│ 表现层 (Presentation) │
|
||||
├─────────────────────────────────────────┤
|
||||
│ 业务层 (Business) │
|
||||
├─────────────────────────────────────────┤
|
||||
│ 数据层 (Data) │
|
||||
├─────────────────────────────────────────┤
|
||||
│ 基础设施层 (Infrastructure) │
|
||||
└─────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 2.2 技术架构概览
|
||||
<!-- 技术栈、框架选择、部署架构 -->
|
||||
|
||||
### 2.3 系统依赖关系
|
||||
<!-- 内部模块依赖、外部服务依赖 -->
|
||||
|
||||
---
|
||||
|
||||
## 3. 业务架构图
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph 业务域A
|
||||
A1[子域1]
|
||||
A2[子域2]
|
||||
end
|
||||
|
||||
subgraph 业务域B
|
||||
B1[子域3]
|
||||
B2[子域4]
|
||||
end
|
||||
|
||||
A1 --> B1
|
||||
A2 --> B2
|
||||
```
|
||||
|
||||
### 3.1 核心业务域划分
|
||||
<!-- 各业务域的职责说明 -->
|
||||
|
||||
### 3.2 业务域关系
|
||||
<!-- 域之间的协作关系 -->
|
||||
|
||||
### 3.3 主业务流程
|
||||
<!-- 端到端业务流程概述 -->
|
||||
|
||||
---
|
||||
|
||||
## 4. 核心业务流程说明
|
||||
|
||||
### 4.1 用户主流程
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[开始] --> B[步骤1]
|
||||
B --> C[步骤2]
|
||||
C --> D[步骤3]
|
||||
D --> E[结束]
|
||||
```
|
||||
|
||||
### 4.2 管理流程
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[管理操作] --> B{判断}
|
||||
B -->|条件1| C[处理1]
|
||||
B -->|条件2| D[处理2]
|
||||
```
|
||||
|
||||
### 4.3 数据流转流程
|
||||
<!-- 数据在系统中的流动路径 -->
|
||||
|
||||
---
|
||||
|
||||
## 5. 数据架构
|
||||
|
||||
### 5.1 核心数据实体
|
||||
<!-- 主要数据实体列表 -->
|
||||
|
||||
| 实体名称 | 描述 | 主要属性 |
|
||||
|---------|------|---------|
|
||||
| 实体A | 描述A | 属性1, 属性2 |
|
||||
| 实体B | 描述B | 属性3, 属性4 |
|
||||
|
||||
### 5.2 实体关系
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
ENTITY_A ||--o{ ENTITY_B : contains
|
||||
ENTITY_A {
|
||||
string id
|
||||
string name
|
||||
}
|
||||
ENTITY_B {
|
||||
string id
|
||||
string entity_a_id
|
||||
}
|
||||
```
|
||||
|
||||
### 5.3 数据生命周期
|
||||
<!-- 数据的创建、更新、归档、删除流程 -->
|
||||
|
||||
---
|
||||
|
||||
## 6. 权限与角色体系
|
||||
|
||||
### 6.1 角色定义
|
||||
|
||||
| 角色名称 | 职责描述 | 操作范围 |
|
||||
|---------|---------|---------|
|
||||
| 角色A | 职责A | 范围A |
|
||||
| 角色B | 职责B | 范围B |
|
||||
|
||||
### 6.2 权限分层
|
||||
<!-- 权限的层级结构 -->
|
||||
|
||||
### 6.3 控制逻辑
|
||||
<!-- 权限校验的实现逻辑 -->
|
||||
|
||||
---
|
||||
|
||||
## 7. 系统扩展点分析
|
||||
|
||||
### 7.1 可扩展模块
|
||||
<!-- 设计上预留的扩展点 -->
|
||||
|
||||
### 7.2 可插拔能力
|
||||
<!-- 可替换/可插拔的组件 -->
|
||||
|
||||
### 7.3 易变业务点
|
||||
<!-- 预期会频繁变化的业务逻辑 -->
|
||||
@@ -0,0 +1,69 @@
|
||||
# 系统能力模型总结
|
||||
|
||||
## 1. 当前系统具备的核心能力
|
||||
|
||||
<!-- 每项能力一句话概括，不超过 10 项 -->
|
||||
|
||||
1. **能力1**: 一句话描述该能力
|
||||
2. **能力2**: 一句话描述该能力
|
||||
3. **能力3**: 一句话描述该能力
|
||||
|
||||
---
|
||||
|
||||
## 2. 能力依赖关系图
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph 平台层
|
||||
P1[平台能力1]
|
||||
P2[平台能力2]
|
||||
end
|
||||
|
||||
subgraph 业务层
|
||||
B1[业务能力1]
|
||||
B2[业务能力2]
|
||||
end
|
||||
|
||||
P1 --> B1
|
||||
P2 --> B2
|
||||
B1 --> B2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 可复用能力清单
|
||||
|
||||
| 能力名称 | 复用场景 | 复用方式 |
|
||||
|---------|---------|---------|
|
||||
| 能力1 | 场景A, 场景B | 方式描述 |
|
||||
| 能力2 | 场景C | 方式描述 |
|
||||
|
||||
---
|
||||
|
||||
## 4. 平台级能力
|
||||
|
||||
<!-- 多个业务都依赖的底层能力 -->
|
||||
|
||||
### 4.1 能力A
|
||||
- **描述**:
|
||||
- **使用方**:
|
||||
- **实现位置**:
|
||||
|
||||
### 4.2 能力B
|
||||
- **描述**:
|
||||
- **使用方**:
|
||||
- **实现位置**:
|
||||
|
||||
---
|
||||
|
||||
## 5. 业务定制能力
|
||||
|
||||
<!-- 特定业务场景才需要的能力 -->
|
||||
|
||||
### 5.1 业务X 定制能力
|
||||
- **描述**:
|
||||
- **业务场景**:
|
||||
|
||||
### 5.2 业务Y 定制能力
|
||||
- **描述**:
|
||||
- **业务场景**:
|
||||
@@ -0,0 +1,114 @@
|
||||
# {模块名称}
|
||||
|
||||
## 1. 模块定位
|
||||
|
||||
### 1.1 模块目标
|
||||
<!-- 该模块要解决什么问题 -->
|
||||
|
||||
### 1.2 解决问题
|
||||
<!-- 具体解决的业务/技术问题 -->
|
||||
|
||||
---
|
||||
|
||||
## 2. 功能清单
|
||||
|
||||
| 功能名称 | 功能描述 | 输入 | 输出 | 依赖模块 |
|
||||
|---------|---------|------|------|---------|
|
||||
| 功能1 | 描述1 | 输入1 | 输出1 | 模块A |
|
||||
| 功能2 | 描述2 | 输入2 | 输出2 | 模块B |
|
||||
|
||||
---
|
||||
|
||||
## 3. 核心逻辑
|
||||
|
||||
### 3.1 业务规则
|
||||
<!-- 穷举所有业务规则 -->
|
||||
|
||||
1. **规则1**: 规则描述
|
||||
2. **规则2**: 规则描述
|
||||
|
||||
### 3.2 校验逻辑
|
||||
<!-- 穷举所有校验条件 -->
|
||||
|
||||
| 校验项 | 校验规则 | 错误提示 |
|
||||
|-------|---------|---------|
|
||||
| 校验1 | 规则描述 | 错误信息 |
|
||||
| 校验2 | 规则描述 | 错误信息 |
|
||||
|
||||
### 3.3 状态流转
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> 初始状态
|
||||
初始状态 --> 状态A: 事件1
|
||||
状态A --> 状态B: 事件2
|
||||
状态B --> [*]: 结束
|
||||
状态A --> 异常状态: 异常事件
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 数据结构
|
||||
|
||||
### 4.1 涉及数据表
|
||||
<!-- 该模块涉及的数据库表 -->
|
||||
|
||||
| 表名 | 描述 | 关键字段 |
|
||||
|-----|------|---------|
|
||||
| 表A | 描述A | 字段1, 字段2 |
|
||||
| 表B | 描述B | 字段3, 字段4 |
|
||||
|
||||
### 4.2 字段说明
|
||||
<!-- 关键字段逐个说明 -->
|
||||
|
||||
**表A**
|
||||
|
||||
| 字段名 | 类型 | 说明 | 约束 |
|
||||
|-------|------|------|------|
|
||||
| id | bigint | 主键 | 自增 |
|
||||
| name | varchar | 名称 | 非空 |
|
||||
|
||||
### 4.3 数据关联
|
||||
<!-- 与其他模块的数据关联关系 -->
|
||||
|
||||
---
|
||||
|
||||
## 5. 对外接口
|
||||
|
||||
### 5.1 API 列表
|
||||
|
||||
| 接口 | 方法 | 路径 | 描述 |
|
||||
|-----|------|------|------|
|
||||
| 接口1 | GET | /api/xxx | 描述1 |
|
||||
| 接口2 | POST | /api/yyy | 描述2 |
|
||||
|
||||
### 5.2 事件机制
|
||||
<!-- 发布/订阅的事件 -->
|
||||
|
||||
| 事件名称 | 触发时机 | 消费者 |
|
||||
|---------|---------|--------|
|
||||
| 事件1 | 时机1 | 消费者A |
|
||||
|
||||
### 5.3 回调机制
|
||||
<!-- 回调接口定义 -->
|
||||
|
||||
---
|
||||
|
||||
## 6. 异常与边界处理
|
||||
|
||||
### 6.1 异常情况
|
||||
|
||||
| 异常场景 | 处理方式 | 返回信息 |
|
||||
|---------|---------|---------|
|
||||
| 场景1 | 处理方式1 | 信息1 |
|
||||
| 场景2 | 处理方式2 | 信息2 |
|
||||
|
||||
### 6.2 边界条件
|
||||
|
||||
| 边界条件 | 处理逻辑 |
|
||||
|---------|---------|
|
||||
| 条件1 | 逻辑1 |
|
||||
| 条件2 | 逻辑2 |
|
||||
|
||||
### 6.3 性能考虑
|
||||
<!-- 大数据量、高并发等场景的处理 -->
|
||||
Reference in New Issue
Block a user