SuperAPI AI 工具集

data-contract

数据与分析

查看项目

更新于 10-16 06:48

技能介绍

用途:当需要编写数据契约、定义 schema 协议或设定数据质量保证时使用。多数数据故障源于生产者改了列却没通知下游,数据契约把 schema、语义和质量保证写成显式、带版本的协议,并明确负责人与破坏性变更策略,让生产者与消费者共享唯一事实来源。

必要输入(未提供时需询问):数据资产(表、事件、主题或 API 及其含义);生产者与消费者(谁拥有、谁依赖);schema(字段、类型、哪些必填,以及易混淆字段的语义);质量预期(新鲜度、完整性、有效范围、唯一性)。

输出格式:标题为 Data Contract: [asset] v[x.y],注明生产者(负责人)、消费者、状态。正文分六部分:1. Schema,逐字段列出名称、类型、是否必填、描述/语义、约束(枚举、范围、格式);2. 语义,说明时区、货币/单位、null 含义、迟到数据处理、粒度/唯一性等非显而易见含义;3. 质量 SLA,可度量保证,如新鲜度(每日 06:00 UTC 前更新)、完整性、有效性、唯一性;4. 所有权与支持,负责人、问题提交渠道、响应预期;5. 版本与破坏性变更,schema 采用语义化版本,定义何为破坏性(删改字段、收紧类型、改语义)与非破坏性(新增可选字段),以及弃用窗口;6. 变更流程,如何提议、需哪些受影响消费者签字、通知期。

质量检查:每个字段有类型、必填标记和清晰语义;SLA 可度量而非“应保持新鲜”;明确破坏性与非破坏性变更;破坏性变更需弃用窗口与签字流程;指定负责人与升级路径。

反模式:语义留白(未记录时区/单位/null 处理是头号静默数据 bug);SLA 含糊;破坏性变更无通知;跳过所有权;非正式版本管理。

限制:资料未提供具体安装命令、收费方式、平台支持或运行环境信息。