init: 项目初始提交 - NeoZQYY Monorepo 完整代码

apps/etl/pipelines/feiqiu/docs/README.md

@@ -0,0 +1,31 @@
+# docs/ — 项目文档
+
+## 子目录索引
+
+| 目录 / 文件 | 内容 |
+|-------------|------|
+| [`architecture/`](architecture/README.md) | 架构设计文档 — 系统整体架构、数据流向（ODS→DWD→DWS）、模块交互关系 |
+| [`api-reference/`](api-reference/) | API 参考文档（25 个端点的标准化文档 + JSON 样本） |
+| [`audit/`](audit/README.md) | 审计统一目录（AI 变更审计 + 仓库审计报告） |
+| [`audit/changes/`](audit/changes/) | AI 逐次变更审计记录 |
+| [`audit/repo/`](audit/repo/) | 仓库审计报告（由 `scripts/audit/` 自动生成：文件清单、调用流、文档对齐） |
+| [`audit/audit_dashboard.md`](audit/audit_dashboard.md) | 审计一览表 — 基于审计源记录自动生成的汇总视图（时间线 + 模块索引） |
+| [`business-rules/`](business-rules/README.md) | 业务规则文档 — 指数算法、DWS 口径定义、SCD2 处理规则等业务逻辑 |
+| [`database/`](database/README.md) | 数据库文档统一目录 — 层级概览 + ODS/DWD/DWS/ETL_Admin 表级文档 |
+| [`database/overview/`](database/overview/) | 层级概览 / 速查索引（表清单、主键、记录数、业务域分类） |
+| [`database/ODS/`](database/ODS/) | ODS 层表手册（main/mappings/changes） |
+| [`database/DWD/`](database/DWD/) | DWD 层表手册（main 表 + Ex 扩展表） |
+| [`database/DWS/`](database/DWS/) | DWS 层表手册（助教、财务、会员、指数等） |
+| [`database/ETL_Admin/`](database/ETL_Admin/) | ETL 管理层表手册（etl_cursor/etl_run/etl_task） |
+| [`etl_tasks/`](etl_tasks/README.md) | ETL 任务文档（ODS/DWD/DWS/指数任务说明与机制） |
+| [`operations/`](operations/README.md) | 运维文档 — 环境搭建指南、调度配置说明、故障排查手册 |
+| [`reports/`](reports/) | 分析报告（数据质量、一致性检查等输出） |
+| [`requirements/`](requirements/) | 需求文档（功能需求、口径补充、指数 PRD 等） |
+| [`CHANGELOG.md`](CHANGELOG.md) | 项目级版本变更历史（日期、变更摘要、影响范围） |
+
+## 维护约定
+
+- 代码变更涉及表结构或口径时，同步更新 `database/`
+- 审计一览表通过 `python scripts/gen_audit_dashboard.py` 重新生成，不要手动编辑
+- 审计报告通过 `python -m scripts.audit.run_audit` 重新生成，不要手动编辑
+- 文档统一 UTF-8 编码，中文撰写