‹ 首页

write-report

@signalpilot-labs · 收录于 5 天前 · 上游提交 6 天前

Generates an HTML report summarizing dbt project work: decisions, SQL, queries, verifier results, and visual charts. Only load when explicitly requested.

适合你,如果经常需要向团队展示 dbt 项目的工作成果与决策过程

/ 通过 npx 安装 校验哈希
npx oh-my-skill add signalpilot-labs/signalpilot/write-report
/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- signalpilot-labs/signalpilot/write-report
/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify signalpilot-labs/signalpilot/write-report
安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
473GitHub stars
~835上下文体积 · 单文件
索引托管

怎么用

商店整理自技能原文 · 版本 436a4c4 · 表述以原文为准
它做什么

生成一个自包含的HTML文件,汇总dbt项目工作,包含执行摘要、决策日志、SQL模型、查询记录、验证器结果和数据可视化图表。

什么时候触发

在第8步验证全部通过后自动触发,作为最终文档步骤。

装好后可以这样说
触发技能生成报告。
同上.
如果已触发,会询问是否重新生成。
技能原文 SKILL.md作者撰写 · Apache-2.0 · 436a4c4

Write Report

Generate a single self-contained HTML file at <project_dir>/report.html that gives the user complete confidence in what was built and why.

When to Load

Load this skill ONLY after Step 8 verification is complete and all checks pass. This is the final step - it documents the work, it does not change any models.

Report Structure

Write the HTML file with these sections in order:

1. Executive Summary (top of page)

A colored status banner showing:

  • Task: the original task description (1-2 sentences)
  • Result: PASS / FAIL with model count
  • Models built/edited: list with materialization type
  • Total turns used: from the agent run
2. Decision Log

A table showing every major decision the agent made:

| # | Decision | Reasoning | Evidence | |---|----------|-----------|----------|

Include decisions about:

  • Which driving table to use and why
  • Which columns to include/exclude and why
  • JOIN types chosen and why
  • Filters applied (or not applied) and why
  • Strategy choices (snapshot strategy, materialization, etc.)

Each row must cite the specific tool output, query result, or skill rule that informed the decision. No unsupported claims.

3. SQL Models Written

For each model created or edited:

  • The full SQL (in a collapsible <details> block)
  • A plain-English explanation of what each CTE does
  • The data flow: source tables → CTEs → final SELECT
4. Queries Executed

A collapsible section listing every query_database call the agent made:

  • The SQL query
  • The result (first 5 rows)
  • Why it was run (what decision it informed)

Group by purpose: "Schema Discovery", "Data Profiling", "Verification".

5. Verifier Reports

Two subsections - Structure Verifier and Value Verifier:

  • Each CHECK result (PASS/FAIL/SKIP) with the exact output
  • For any FAIL that was fixed: what changed and why
  • Final state: all checks that passed
6. Data Visualizations

Embed inline SVG or HTML/CSS charts (no external dependencies):

Row Count Waterfall: horizontal bar chart showing source rows → model rows, with JOIN multipliers/reductions annotated.

Column Coverage: a grid showing YML columns vs model SELECT columns (green = matched, red = missing, gray = extra).

NULL Heatmap: for each model column, show the % NULL as a colored cell (green = 0%, yellow = partial, red = 100%).

Use inline CSS and simple HTML elements (<div> with background-color, width as percentage). Do NOT use JavaScript libraries - the report must render in any browser with zero dependencies.

7. Reproducibility

List the exact commands to rebuild from scratch:

dbt deps
dbt run --select <model1> <model2>
dbt test
HTML Template Rules
  • Single self-contained .html file - all CSS inline in <style> block
  • No external CDN links, no JavaScript libraries
  • Use a clean sans-serif font (font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif)
  • Color scheme: #22c55e for PASS, #ef4444 for FAIL, #f59e0b for WARN, #6b7280 for SKIP
  • Collapsible sections use <details><summary> HTML elements
  • Tables use border-collapse: collapse with alternating row colors
  • Maximum width 900px, centered
Rules
  • Do NOT modify any model files. This skill is READ-ONLY documentation.
  • Do NOT run dbt commands. Read existing results only.
  • Query the database for chart data (row counts, NULL percentages) using query_database.
  • The report must be accurate - every number must come from a tool call or query result, not from memory.
按 Apache-2.0 许可原样转载,未经改动 · 在 GitHub 查看 →

评论

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。