documenting-dbt-models

用途：为 dbt 模型及其字段编写 schema.yml 文档，强调记录“为什么”而不仅是“是什么”，涵盖粒度、业务规则与注意事项。\n\n主要能力：通过查找并阅读已有 schema.yml 学习项目文档风格（描述长度、格式、是否含粒度/规则/注意事项、字段描述深度、meta 标签用法）；阅读模型 SQL 理解转换、业务逻辑、连接与过滤；检查该模型现有文档避免重复；按模型与字段补充描述。字段文档按类型关注重点：主键写来源系统与唯一性，外键写关联对象与 NULL 处理，指标写计算公式、单位与排除项，日期写时区与代表事件，状态/分类列列出全部取值及业务含义，布尔/标志写业务含义，计算字段写公式与除零等边界处理。\n\n使用方式：先运行 find . -name "schema.yml" | head -5 定位文件，用 cat 阅读已文档化模型；运行 cat models/<path>/<model_name>.sql 阅读 SQL；用 find . -name "schema.yml" -exec grep -l "<model_name>" {} \; 与 grep -A 100 查找已有文档；匹配项目风格后用 version / models / columns 结构写入描述；最后运行 dbt docs generate，可选 dbt docs serve 本地预览。\n\n限制与注意：资料强调必须匹配项目已有文档风格，不应引入不同格式；避免只描述“是什么”、缺少粒度说明、不记录 NULL 处理、字段留空或直接复制字段名作为描述。文档模板为默认示例，需按项目实际风格调整。未提供收费、平台及其他功能信息。