Files
Neo-ZQYY/apps/etl/connectors/feiqiu/docs
Neo 80bda9b991 chore(audit): 2026-04-20 历史批次预审 + 文档同步 + .gitignore 修正
- 新增 docs/audit/changes/2026-04-20__historical-batch-pre-audit.md
  157 文件分批盘点审计(7 条主线 + 10 项高/中风险 + 2 份迁移 SQL DDL 清单)
- 补追 docs/audit/changes/2026-04-15__meituan-settle-core-sync.md
  原审计产物因 .gitignore 屏蔽长期未入仓,本次一并追回
- 刷新 docs/audit/audit_dashboard.md(33 条审计记录)
- .gitignore 白名单放行 docs/audit/changes/*.md 与 audit_dashboard.md
  同时屏蔽 changes/changes/ 嵌套误产物目录
- 新增 docs/specs/audit-gap-recovery/tasks.md
  扫描嵌套目录发现 96 份 D 类孤本(从未入过 git history),
  生成独立 PRD 供单开任务清理与补追
- 文档同步(高风险项):
  - apps/backend/docs/API-REFERENCE.md (+69)
  - apps/miniprogram/README.md (+50)
  - apps/etl/connectors/feiqiu/docs/architecture/data_flow.md (+52/-2)
  - apps/etl/connectors/feiqiu/docs/architecture/system_overview.md (+5/-3)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-20 06:32:58 +08:00
..

docs/ — 项目文档

子目录索引

目录 / 文件 内容
architecture/ 架构设计文档 — 系统整体架构、数据流向ODS→DWD→DWS、模块交互关系
api-reference/ API 参考文档25 个端点的标准化文档 + JSON 样本)
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/ 运维文档 — 环境搭建指南、调度配置说明、故障排查手册
CHANGELOG.md 项目级版本变更历史(日期、变更摘要、影响范围)

维护约定

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