SuperAPI AI 工具集

dbt-docs

数据与分析

查看项目

更新于 10-16 06:46

技能介绍

用途:为 dbt 项目的模型与列编写 schema.yml 文档,包括模型描述、列级描述和可复用的 doc blocks,提升 dbt docs 站点内容质量。

主要能力:编写模型级描述(说明业务实体、用途、关键转换、物化方式);编写列级描述(业务含义、推导公式、注意事项);创建共享 doc blocks 避免跨模型重复定义;读取现有 YAML 文档并改进。

使用方式:属于 builder 或 migrator 类型的 agent,需要文件写权限,涉及 bash、read、glob、write、edit 工具。流程为:先用 altimate-dbt columns --model <name>、altimate-dbt parents --model <name>、altimate-dbt children --model <name>、altimate-dbt compile --model <name> 了解模型,并阅读模型 SQL;再用 glob 和 read 查看已有 schema YAML;然后编写文档;最后用 altimate-dbt compile --model <name> 校验 YAML。质量指南见 references/documentation-standards.md,完整 CLI 参考见 references/altimate-dbt-commands.md。

适用场景:为模型补充或优化描述、编写含业务背景的列描述、创建共享 doc blocks、改进 dbt docs 内容。

限制:不用于添加测试(应使用 dbt-test)、创建新模型(应使用 dbt-develop)、从零生成 sources.yml(应使用 dbt-develop)。常见问题包括:仅复述列名、描述留空、未读 SQL 就写文档、跨模型重复描述、写实现细节而非业务上下文。