Files
medical-mall/pages/mall/analytics/docs
2026-01-23 16:33:11 +08:00
..
2026-01-23 16:33:11 +08:00
2026-01-23 16:33:11 +08:00

数据分析模块文档目录

本目录包含数据分析模块的所有相关文档。

📁 文档结构

pages/mall/analytics/docs/
├── README.md                      # 本文件(文档索引)
├── ANALYTICS_DB_DESIGN.md        # 数据库设计文档
├── ANALYTICS_DB_QUICK_START.md   # 数据库快速开始指南
├── ANALYTICS_PAGES_ANALYSIS.md   # 页面分析文档
├── ANALYTICS_UI_DESIGN.md        # UI 设计文档
└── IMPLEMENTATION_STATUS.md       # 实现状态文档

📚 文档说明

1. ANALYTICS_DB_DESIGN.md

数据库设计文档 - 完整的数据表结构、字段说明、索引、RLS策略、RPC函数设计。

内容包含:

  • 7个 Analytics 专用表的详细字段定义
  • 索引建议
  • RLSRow Level Security权限策略
  • RPC 函数设计实时KPI、趋势数据
  • 使用说明和前端调用示例

适用场景:

  • 数据库架构设计
  • 表结构参考
  • 权限策略配置
  • RPC 函数开发

2. ANALYTICS_DB_QUICK_START.md

快速开始指南 - 数据库部署和使用的快速参考。

内容包含:

  • 文件位置说明
  • 快速部署步骤3步
  • 创建的表列表
  • RPC 函数使用说明
  • 测试数据说明
  • 前端使用示例
  • 验证部署方法
  • 问题排查

适用场景:

  • 首次部署数据库
  • 快速查找使用方法
  • 问题排查参考

3. ANALYTICS_PAGES_ANALYSIS.md

页面分析文档 - 数据分析模块所有页面的功能需求和分析。

内容包含:

  • 已实现的页面清单
  • 需要实现的页面清单
  • 页面功能模块分析
  • 统计指标需求
  • 页面依赖关系
  • 组件复用分析
  • 数据接口需求

适用场景:

  • 页面开发规划
  • 功能需求参考
  • 接口设计参考

4. ANALYTICS_UI_DESIGN.md

UI 设计文档 - 数据分析页面的 UI 设计规范和实现说明。

内容包含:

  • 页面访问 URL
  • UI 设计规范
  • 组件使用说明
  • 响应式设计
  • 交互设计

适用场景:

  • UI 开发参考
  • 组件使用指南
  • 设计规范参考

5. IMPLEMENTATION_STATUS.md

实现状态文档 - 记录各页面的实现进度和状态。

内容包含:

  • 页面实现状态
  • 功能完成度
  • 待办事项
  • 问题记录

适用场景:

  • 项目进度跟踪
  • 开发计划制定

🔗 相关资源

SQL 脚本

所有 SQL 脚本位于:pages/mall/analytics/test/

  • ANALYTICS_DB_SCHEMA.sql - 完整的表结构、索引、RLS、RPC
  • ANALYTICS_TEST_SEED.sql - 完整的测试数据
  • 01_create_tables.sql - 分步:创建表结构
  • 02_insert_test_data.sql - 分步:插入测试数据
  • 03_test_queries.sql - 验证查询示例
  • 04_cleanup.sql - 清理测试数据

测试文档

测试相关文档位于:pages/mall/analytics/test/

  • README.md - 测试数据说明和使用方法
  • SQL_USAGE_GUIDE.md - SQL 脚本执行详细指南

项目文档

  • docs/ANALYTICS_PAGES_ANALYSIS.md - 页面分析文档
  • docs/ANALYTICS_UI_DESIGN.md - UI 设计文档
  • pages/mall/mall.md - 项目需求文档第2.6节数据分析端第10节数据统计分析

🚀 快速开始

  1. 阅读设计文档ANALYTICS_DB_DESIGN.md
  2. 执行部署:参考 ANALYTICS_DB_QUICK_START.md
  3. 插入测试数据:使用 pages/mall/analytics/test/ 中的 SQL 脚本

📝 文档更新记录

  • 2026-01-23 - 创建文档目录和索引
  • 2026-01-23 - 添加数据库设计文档和快速开始指南