docs: 统一文档日期和状态规范

This commit is contained in:
张翔
2026-03-08 22:00:52 +08:00
parent 0087a90b89
commit b9995785ab
22 changed files with 4983 additions and 13609 deletions
+23 -70
View File
@@ -4,7 +4,7 @@
> 版本: v1.0
> 日期: 2026-03-04
> 作者: 张翔
> 状态: 初稿
> 状态: 正式发布
---
@@ -19,8 +19,8 @@
## 参考文档
- 《健身房管理系统基础版产品设计文档》 GYM-PRD-BASIC-001
- 《健身房管理系统基础版系统概要设计文档》 GYM-HLD-BASIC-001
- 《健身房管理系统基础版系统详细设计文档》 GYM-LLD-BASIC-001
- 《健身房管理系统基础版业务概要设计文档》 GYM-B-HLD-BASIC-001
- 《健身房管理系统基础版业务详细设计文档》 GYM-B-LLD-BASIC-001
- Vue 3 官方文档
- uniapp 官方文档
- TypeScript 官方文档
@@ -39,33 +39,13 @@
### 1.2 客户端架构
```
┌─────────────────────────────────────────────────────────────────────────┐
│ 前端客户端架构 │
├─────────────────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 会员小程序 (uniapp+Vue3) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 会员注册/登录 • 课程预约 • 扫码签到 • 会员卡管理 │ │
│ │ • 个人中心 • 消息通知 • 数据统计 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 教练端App (uniapp+Vue3) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 课程管理 • 排班管理 • 会员管理 • 签到管理 │ │
│ │ • 数据统计 • 消息通知 • 个人中心 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 管理后台PC (Vue3+Vite+Element Plus) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 会员管理 • 课程管理 • 预约管理 • 签到管理 │ │
│ │ • 财务管理 • 数据统计 • 系统管理 • 订阅管理 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────┘
```mermaid
graph LR
subgraph 前端客户端架构
A[会员小程序 uniapp+Vue3<br/>• 会员注册/登录<br/>• 课程预约<br/>• 扫码签到<br/>• 会员卡管理<br/>• 个人中心<br/>• 消息通知<br/>• 数据统计]
B[教练端App uniapp+Vue3<br/>• 课程管理<br/>• 排班管理<br/>• 会员管理<br/>• 签到管理<br/>• 数据统计<br/>• 消息通知<br/>• 个人中心]
C[管理后台PC Vue3+Vite+Element Plus<br/>• 会员管理<br/>• 课程管理<br/>• 预约管理<br/>• 签到管理<br/>• 财务管理<br/>• 数据统计<br/>• 系统管理<br/>• 订阅管理]
end
```
### 1.3 技术栈选型
@@ -116,46 +96,19 @@
### 2.1 分层架构
```
┌─────────────────────────────────────────────────────────────────────────┐
│ 前端分层架构 │
├─────────────────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 表现层 (Presentation Layer) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 页面组件 • 业务组件 • 基础组件 • 布局组件 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 状态管理层 (State Management Layer) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 全局状态 • 模块状态 • 组件状态 • 持久化状态 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 业务逻辑层 (Business Logic Layer) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • Composables • Hooks • Utils • Validators │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 数据访问层 (Data Access Layer) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • API Service • WebSocket • Cache • Storage │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────────────────┐ │
│ │ 基础设施层 (Infrastructure Layer) │ │
│ ├─────────────────────────────────────────────────────────────────┤ │
│ │ • 路由 • 拦截器 • 错误处理 • 日志 • 监控 │ │
│ └─────────────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────────────┘
```mermaid
flowchart TB
subgraph 前端分层架构
A[表现层 Presentation Layer<br/>• 页面组件<br/>• 业务组件<br/>• 基础组件<br/>• 布局组件]
B[状态管理层 State Management Layer<br/>• 全局状态<br/>• 模块状态<br/>• 组件状态<br/>• 持久化状态]
C[业务逻辑层 Business Logic Layer<br/>• Composables<br/>• Hooks<br/>• Utils<br/>• Validators]
D[数据访问层 Data Access Layer<br/>• API Service<br/>• WebSocket<br/>• Cache<br/>• Storage]
E[基础设施层 Infrastructure Layer<br/>• 路由<br/>• 拦截器<br/>• 错误处理<br/>• 日志<br/>• 监控]
A --> B
B --> C
C --> D
D --> E
end
```
### 2.2 模块划分