用途:生成客户可读的 Markdown 数据目录,其 YAML frontmatter 是有效的 DS_CATALOG_V1 机器契约,用于记录业务实体、关系、来源、分级、血缘与隐私分类,并显式保留推断或假设的不确定性。
主要能力:按业务粒度盘点实体,记录来源访问、分级、体量、profile 指针、分类、血缘与待解问题;为每个关系分配稳定 rel-* 标识,记录端点、最大基数、两端最小值、成对连接键字段、置信度与证据依据;核对覆盖计数;由 YAML 事实渲染人类可读章节,并以规范的数据科学辅导免责声明结尾。
使用方式:先确认项目名称与调用方批准的持久输出路径;准备数据源清单与访问状态、业务实体名称与粒度、已声明关系、已有 profile 路径、隐私分类或标准引用;用 scripts/validate_catalog.py 校验,命令为 uv run python scripts/validate_catalog.py <catalog.md>。可参考 catalog-contract.md、dcat-crosswalk.md、provenance.md、ds-catalog-v1.md、northwind-catalog.md 及 assets/ds-catalog-v1.schema.json。
限制:目录丰富须由用户驱动,不得静默修改;来源只记路径或连接引用,不嵌入凭据;DCAT 对齐为非约束性,不声称符合 RDF/DCAT;分级记录与分级行为分离;渲染工具不得推断新关系;实体粒度、关系端点、连接键配对或端点最小值不明确时应停止并请求澄清;证据不足时保留 inferred 或 assumed;未确认目标前不得持久写入;隐私解释未知时转交 privacy-standards 或 Privacy Planner。列统计与特征元数据保留在 profile_ref 后,不复制进目录。契约、工作流、模式、模板、示例与校验器为仓库原创,采用 CC BY 4.0 许可。