Files

docs/ — 项目文档

子目录索引

目录 / 文件 内容
architecture/ 架构设计文档 — 系统整体架构、数据流向ODS→DWD→DWS、模块交互关系
api-reference/ API 参考文档25 个端点的标准化文档 + JSON 样本)
audit/ 审计目录(历史归档,新记录已迁移至根 docs/audit/
audit/repo/ 仓库审计报告(由 scripts/audit/ 自动生成:文件清单、调用流、文档对齐)
business-rules/ 业务规则文档 — 指数算法、DWS 口径定义、SCD2 处理规则等业务逻辑
database/ 数据库文档统一目录 — 层级概览 + ODS/DWD/DWS/ETL_Admin 表级文档
database/overview/ 层级概览 / 速查索引(表清单、主键、记录数、业务域分类)
database/ODS/ ODS 层表手册main/mappings/changes
database/DWD/ DWD 层表手册main 表 + Ex 扩展表)
database/DWS/ DWS 层表手册(助教、财务、会员、指数等)
database/ETL_Admin/ ETL 管理层表手册etl_cursor/etl_run/etl_task
etl_tasks/ ETL 任务文档ODS/DWD/DWS/指数任务说明与机制)
operations/ 运维文档 — 环境搭建指南、调度配置说明、故障排查手册
reports/ 分析报告(数据质量、一致性检查等输出)
requirements/ 需求文档(功能需求、口径补充、指数 PRD 等)
CHANGELOG.md 项目级版本变更历史(日期、变更摘要、影响范围)

维护约定

  • 代码变更涉及表结构或口径时,同步更新 database/
  • 审计一览表通过 python scripts/audit/gen_audit_dashboard.py(在项目根目录执行)重新生成
  • 审计变更记录已统一迁移至根 docs/audit/changes/
  • 审计报告通过 python -m scripts.audit.run_audit 重新生成,不要手动编辑
  • 文档统一 UTF-8 编码,中文撰写