瀏覽代碼

docs(readme): 文档索引加入 SSOT 职责边界

索引段起首加 SSOT 原则;每张分组表"内容"列改为"职责",逐行
重写为加粗前缀(**架构** / **建模方法论** / **开发方法论** 等)+ 边界简述。
顺带修:02-权限与账号行缺尾 `|` 表格闭合;样板链接 `§6` → `§7`
对齐 kb/30 重编号。
tianyu.chu 2 周之前
父節點
當前提交
85884c39cb
共有 2 個文件被更改,包括 23 次插入22 次删除
  1. 22 22
      README.md
  2. 1 0
      kb/92-重构进度.md

+ 22 - 22
README.md

@@ -58,46 +58,46 @@ PG/ES ──DataX(raw)──> RAW ──> ODS ──> DWD ──> DWS ──> TD
 
 ## 文档索引
 
-文件按编号前缀分组,序号越小越基础、越靠前阅读。
+文件按编号前缀分组,序号越小越基础、越靠前阅读。每篇文档是其主题的**唯一权威**(SSOT),跨文档用 `§` 锚点互引、不复述。
 
 ### 0x 项目与环境
 
-| 文档 | 内容                                               |
-|----|--------------------------------------------------|
-| [00-项目架构](kb/00-项目架构.md) | 模块关系图、Spark SQL / DataX 执行时序、DataX 脚本详细使用说明、配置管理 |
-| [01-运行环境](kb/01-运行环境.md) | CDH 技术栈版本、平台架构图、开发侧约束                            |
-| [02-权限与账号](kb/02-权限与账号.md) | 鉴权链路、job账号 vs 个人账号
+| 文档 | 职责 |
+|----|----|
+| [00-项目架构](kb/00-项目架构.md) | **架构**:模块关系、数据流、DataX/Spark 脚本使用、conf 配置分层、manual/ 目录定位 |
+| [01-运行环境](kb/01-运行环境.md) | **基础设施**:CDH 版本矩阵、集群拓扑、开发侧约束 |
+| [02-权限与账号](kb/02-权限与账号.md) | **鉴权链路**:HS2 doAs / PySpark / Ranger / LDAP;job 账号 vs 个人账号 |
 
 ### 1x 业务上下文
 
-| 文档 | 内容 |
+| 文档 | 职责 |
 |----|----|
-| [10-业务流程](kb/10-业务流程.md) | Hobby Stocks 用户侧 + 商家侧 + 售后全链路流程图 |
-| [11-数据资产](kb/11-数据资产.md) | 业务库、埋点数据、爬虫数据、采购数据清单 |
-| [12-同步方案](kb/12-同步方案.md) | PG  Hive 存量/增量/历史归档/CDC 同步策略与阶段演进 |
+| [10-业务流程](kb/10-业务流程.md) | **业务全景**:用户 + 商家 + 售后全链路流程 |
+| [11-数据资产](kb/11-数据资产.md) | **数据源清单**:业务库 / 埋点 / 爬虫 / 采购(同步方案见 12) |
+| [12-同步方案](kb/12-同步方案.md) | **同步策略**:PG→Hive 存量 / 增量 / 历史归档 / CDC 阶段演进 |
 
 ### 2x 数仓建模
 
-| 文档 | 内容 |
+| 文档 | 职责 |
 |----|----|
-| [20-数仓分层与建模](kb/20-数仓分层与建模.md) | 分层定义、主题域、总线矩阵、维度建模五步法、同步策略 |
-| [21-命名规范](kb/21-命名规范.md) ★ | 五段式表名、字段规则、词根字典、建表自检 Checklist |
-| [22-指标体系](kb/22-指标体系.md) | 指标分类、逻辑结构、指标/维度/度量字典 |
-| [23-标签体系](kb/23-标签体系.md) | TDM 层用户/商品/商家画像设计 |
+| [20-数仓分层与建模](kb/20-数仓分层与建模.md) | **建模方法论**:分层定义、主题域、总线矩阵、维度五步法;存储 / raw 类型契约 |
+| [21-命名规范](kb/21-命名规范.md) ★ | **命名规则**:Hive 表 / 字段 / 词根字典 + 建表 Checklist |
+| [22-指标体系](kb/22-指标体系.md) | **指标字典**:指标 / 维度 / 度量定义与口径 |
+| [23-标签体系](kb/23-标签体系.md) | **TDM 画像**:用户 / 商品 / 商家标签 |
 
 ### 3x 开发流程
 
-| 文档 | 内容 |
+| 文档 | 职责 |
 |----|----|
-| [30-开发规范](kb/30-开发规范.md) | TPAD 任务规范、数仓数据开发流程、代码 / SQL 规范、Git 协作规范 |
-| [31-UDF手册](kb/31-UDF手册.md) | UDF 自查表 |
+| [30-开发规范](kb/30-开发规范.md) | **开发方法论**:TPAD、数据开发流程、代码/SQL/Git 规范、DDL/jobs 文件组织、manual/ 临时 SQL、样板 |
+| [31-UDF手册](kb/31-UDF手册.md) | **UDF 登记表**:通用 + 业务 UDF 清单 |
 
 ### 9x 过渡资料
 
-| 文档 | 内容 |
+| 文档 | 职责 |
 |----|----|
-| [90-重构路线](kb/90-重构路线.md) | 基于老项目代码分析的重构路线(P0-P3) |
-| [92-重构进度](kb/92-重构进度.md) | 重构任务 checklist 与当前进度 |
+| [90-重构路线](kb/90-重构路线.md) | **重构决策**:P0-P3 聚簇、已完成结论、待启动方案 |
+| [92-重构进度](kb/92-重构进度.md) | **重构执行**:阶段 checklist + changelog |
 
 ## 阅读建议
 
@@ -108,4 +108,4 @@ PG/ES ──DataX(raw)──> RAW ──> ODS ──> DWD ──> DWS ──> TD
 4. [21-命名规范](kb/21-命名规范.md) — 熟悉命名规则(★ 最高频参考)
 5. [30-开发规范](kb/30-开发规范.md) — 熟悉开发流程
 
-**开发样板**:`conf/templates/` 下按引擎分 datax / spark 两类,详见 [30-开发规范 §6](kb/30-开发规范.md#6-开发样板)。
+**开发样板**:`conf/templates/` 下按引擎分 datax / spark 两类,详见 [30-开发规范 §7](kb/30-开发规范.md#7-开发样板)。

+ 1 - 0
kb/92-重构进度.md

@@ -185,3 +185,4 @@
 | 2026-04-22 | **conf/templates 按引擎顶层重组 + README 样板段迁入 kb/30 §6**:`conf/templates/{datasource,datax/{raw,ads,manual},sql,ddl}/` → `conf/templates/{datax/{datasource,sync},spark/{sql,ddl}}/`。datasource 挪进 datax/ 匹配其仅服务于 DataX 的事实(Spark 入口只读 Hive,不读 ini);datax/{raw,ads,manual} 三空目录合并为 datax/sync/(kb/21 §3.9 删后三分类在样板层级无意义);sql/ddl 归 spark/ 按执行引擎归属。已备 3 份 datasource ini 随 git mv 挪入 datax/datasource/,头注释不含 conf/templates 字面量不需改。README 原 L111-116 "样板(待补充)"整段删除,替换为一句指向 kb/30 §6 链接;kb/30 新增 §6 开发样板(原 §6 相关文档 → §7);kb/90 §2.1 模板目录行同步更新目录字面量 + 入口从 README 改指 kb/30 §6 | — |
 | 2026-04-22 | **kb/21 §3.9 DataX ini 命名移出**:kb/21 主题收敛到 Hive 表/字段/词根命名,§3.9 "DataX ini 文件命名"(命名模板表 + 导出类双下划线规则 + 通用约定 + 样板指引 + 老命名反思)整节删除,§8 速查表同删 3 行 DataX ini;DataX ini 命名示例已在 kb/00 §1 目录树 + §9.5 文件命名速查中体现,不再单独成节。连带清理 7 处跨文档 §3.9 引用:kb/00(L143 示例标题 + L582 §9.5 jobs/ads 行)、kb/30(§3.4.7 docs commit 示例改指 §3.4)、kb/90(§2.1 硬编码表 3 行 + §2.5 目标态段)。kb/21 §5.1 顺手清理一条残留垃圾字符 `buyc1` | — |
 | 2026-04-22 | **kb/00 §9 样板 job 结构迁入 kb/30 §4**:kb/00 主题收敛到架构(模块/数据流/配置),§9 "DDL/jobs 组织 + migration 模式 + 命名速查" 属数仓开发方法论,整节(§9.1–§9.6)迁入 kb/30 新增的 §4 数仓开发文件组织;kb/30 原 §4/§5/§6/§7 顺序后移为 §5/§6/§7/§8,§6 manual/ 临时 SQL 规范里 "详见 `00-项目架构.md` §9.6" 改指本文 §4.6(就近内引)。外部引用更新:kb/90 §八 csv-to-hdfs 行"参见"列改指 kb/30 §4.3;kb/92 阶段 1 csv-to-hdfs checklist 里 "§9.3 模板" 改指 kb/30 §4.3。历史 changelog 里带 "§9.x" 的条目保留不改(历史 snapshot) | — |
+| 2026-04-22 | **README 文档索引加入 SSOT 职责边界**:索引段起首加一行 SSOT 原则(每篇文档是其主题的唯一权威,跨文档用 `§` 锚点互引不复述);5 张分组表 "内容" 列改为 "职责",每行重写为加粗前缀(**架构** / **基础设施** / **鉴权链路** / **建模方法论** / **命名规则** / **开发方法论** 等)+ 边界简述。顺带修两处:02-权限与账号行原来缺尾 `|` 表格闭合;末尾开发样板链接 `§6` 改 `§7`(对齐上一条 kb/30 §4 插入后的重编号) | — |