SuperAPI AI 工具集

06-table-documentation

写作与研究

查看项目

更新于 10-15 20:33

技能介绍

用途:为 Gold 层(生产级数据分层中的黄金层)表制定统一文档标准,覆盖表命名、列描述与治理元数据,使文档同时面向业务用户与技术用户(含 Genie 等 LLM)。

主要能力:规范代理键、业务键、外键的命名(如 {entity}_key、自然名称);要求使用双用途描述格式“[定义]。Business:[业务背景与用例]。Technical:[实现细节与计算逻辑]”,不强制加“LLM:”前缀;规定表注释需包含层级与用途、粒度(一行代表什么)、业务用例与技术实现;要求 TBLPROPERTIES 包含 delta 性能项(如 delta.enableChangeDataFeed、delta.enableRowTracking、delta.enableDeletionVectors、delta.autoOptimize.autoCompact、delta.autoOptimize.optimizeWrite)、quality、layer、source_layer、source_table、domain、entity_type、contains_pii、data_classification、business_owner、technical_owner,维度需 scd_type,事实需 grain 与 gold_type。还包括 SCD Type 2 字段 effective_from、effective_to、is_current 的文档要求,以及主外键、校验清单与常见错误(业务键作主键、缺少 grain、使用“LLM:”前缀)。

使用方式:编写任何 Gold 层 SQL(TVF、查询、MERGE)前,先查阅 gold_layer_design/yaml/**/*.yaml 中的 YAML 模式定义,YAML 是唯一事实来源;参考 references/documentation-templates.md 与 references/llm-optimization.md,模板见 assets/templates/gold-table-docs.yaml。输入来自 05-erd-diagrams 等前序技能的 ERD 与粒度定义,输出为带双用途描述的 YAML 模式、完整 TBLPROPERTIES 及列血缘元数据,下一步进入 07-design-validation 交叉校验。

限制:资料未说明具体运行环境、依赖版本或收费情况;未提供可直接执行的完整命令,仅给出需保持原样的 TBLPROPERTIES 示例。属于文档规范类技能,不替代实际建模决策。