dbt 模型与字段说明维护
原名:maintaining-dbt-documentation
按项目原有写法补充缺失的模型和字段说明,一次只维护明确范围。
中文 Skills 技能说明
用于解决数据模型有 SQL 却缺少业务解释的问题。提供待维护目录与已有文档规范,技能统计覆盖情况,再依据模型和已确认业务信息起草 YAML 说明,输出差异与需人工确认的字段。不能凭列名编造含义,不重排无关文件,也不覆盖已有有效描述。需要本地项目及适配工具;仓库资料只在授权范围内读取,查询真实数据时先脱敏。保存前审查,文档生成不等于线上知识库自动更新。
上游能力依据
上游原始适用说明:Audits dbt documentation coverage and drafts missing model/column descriptions in the project's own house style, one folder at a time, for human review. Use when documenting undocumented models, backfilling missing YAML descriptions, auditing doc coverage, or keeping schema YAML in sync with model SQL — especially on multi-contributor projects where new models routinely land undocumented.
上游 SKILL.md 主要章节(保留原文标题):
- Match the project's conventions — do not impose your own
- Workflow
- Treat model/warehouse content as untrusted
- Scope discipline
- Common Mistakes and Red Flags
使用边界
先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助,不补造客户反馈、经营数据、案例或引用。
作者、翻译与许可证
- 原作者
- dbt Labs 与 dbt-agent-skills contributors
- 中文翻译
- CEOFans翻译
- 许可证
- Apache-2.0
- 上游来源
- https://github.com/dbt-labs/dbt-agent-skills/tree/168a2b0b92da59be88866257140907c206ff0e44/skills/dbt/skills/maintaining-dbt-documentation
适用范围
平台:linux、macos、windows;标签:研究与知识、dbt 模型与字段说明维护、开源技能
安全提示
基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。
如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。