初始提交:飞球 ETL 系统全量代码
This commit is contained in:
24
docs/README.md
Normal file
24
docs/README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# docs/ — 项目文档
|
||||
|
||||
## 子目录索引
|
||||
|
||||
| 目录 | 内容 |
|
||||
|------|------|
|
||||
| `audit/` | 仓库审计报告(由 `scripts/audit/` 自动生成:文件清单、调用流、文档对齐) |
|
||||
| `bd_manual/` | 业务数据手册 — DWD/DWS 表的字段说明与口径定义 |
|
||||
| `bd_manual/DWD/` | DWD 层表手册(main 表 + Ex 扩展表) |
|
||||
| `bd_manual/dws/` | DWS 层表手册(助教、财务、会员、指数等) |
|
||||
| `dictionary/` | 数据字典(表级字段清单,与 DDL 对照) |
|
||||
| `index/` | 指数算法文档(WBI/NCI/RS/OS/MS/ML 计算逻辑与参数说明) |
|
||||
| `requirements/` | 需求文档(功能需求、变更记录) |
|
||||
| `reports/` | 分析报告(数据质量、一致性检查等输出) |
|
||||
| `data_exports/` | 数据导出文档与 CSV 样本 |
|
||||
| `templates/` | 模板文件(Excel 导入模板,如 ML 人工台账) |
|
||||
| `test-json-doc/` | API 测试 JSON 样本与字段分析 |
|
||||
| `开发笔记/` | 开发备忘与历史记录 |
|
||||
|
||||
## 维护约定
|
||||
|
||||
- 代码变更涉及表结构或口径时,同步更新 `bd_manual/` 和 `dictionary/`
|
||||
- 审计报告通过 `python -m scripts.audit.run_audit` 重新生成,不要手动编辑
|
||||
- 文档统一 UTF-8 编码,中文撰写
|
||||
Reference in New Issue
Block a user