CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documenting-warehouse-sources

Write or update the user-facing posthog.com documentation for a PostHog Data warehouse import source. Use when adding a new source doc, fixing an inconsistent or stub source doc, or standardizing the docs at contents/docs/cdp/sources. Covers the canonical template, shared snippets, the auto-rendered <SourceParameters /> and <SourceTables /> components, frontmatter, and the docsUrl/slug rule that prevents 404s.

Quality

90%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

—

The risk profile of this skill

SKILL.md
Quality
Evals
Security

Quality

Content

82%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

Highly actionable, project-grounded content with a complete template, exact commands, and a validation audit. The main gaps are minor redundancy (duplicated frontmatter, checklist restating rules) and a topic- rather than sequence-oriented presentation of the workflow.

Suggestions

Drop the duplicated frontmatter block from the 'Canonical template' (reference the 'Frontmatter' section) to tighten conciseness.

Add a short ordered 'workflow' list (write doc → set sourceId → use snippets → verify slug → run audit) to make the step sequence explicit alongside the checklist.

Consider moving the full canonical template into a references/ file and keeping only an annotated outline in SKILL.md to improve progressive disclosure.

DimensionReasoningScore

Conciseness

The body is dense and project-specific with no generic-concept padding ('the doc just renders what the API returns'), but the frontmatter block is duplicated verbatim in both the 'Frontmatter' and 'Canonical template' sections, and the checklist re-encapsulates earlier rules — minor trims that keep it below the lean top anchor.

4 / 5

Actionability

Fully executable guidance: a complete canonical doc template, exact frontmatter fields, named shared snippets with purposes, the runnable audit command 'python manage.py audit_source_docs --docs-dir ../posthog.com/contents/docs/cdp/sources' with its failure conditions, and concrete exemplars (Stripe Option 1/Option 2, Postgres, ClickHouse).

5 / 5

Workflow Clarity

All steps and checkpoints exist (template → sourceId match → snippets → slug agreement → audit → checklist) with a real validation gate (audit fails on missing files or bad sourceId, plus 301 redirect requirement), but the steps are organized by topic rather than an explicitly ordered sequence, so the reader assembles the order themselves.

4 / 5

Progressive Disclosure

A well-organized single-file skill with clear section headers; the cross-references to /implementing-warehouse-sources and to posthog.com paths are clearly signaled and one level deep, and no bundle files exist to manage. It is above the ~50-line simple-skill threshold, and the full template/checklist could arguably live in a reference file, so it does not reach the top anchor.

4 / 5

Total

17

/

20

Passed

Description

92%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: concrete actions, explicit 'Use when' triggers, and a well-scoped niche with specific named artifacts. Only weakness is slightly incomplete synonym coverage in trigger terms.

Suggestions

Add a few natural synonym triggers such as 'documentation page', 'connector doc', or 'source documentation' to broaden trigger-term coverage.

Consider mentioning the pairing with the implementing-warehouse-sources skill in the description to further reduce overlap ambiguity when shipping a new source.

DimensionReasoningScore

Specificity

Multiple concrete actions are stated ('Write or update the user-facing posthog.com documentation', 'adding a new source doc, fixing an inconsistent or stub source doc, or standardizing the docs') with named artifacts (canonical template, shared snippets, SourceParameters/SourceTables components, docsUrl/slug rule), giving comprehensive coverage in third-person voice.

5 / 5

Completeness

Explicitly answers both 'what' (writes/updates posthog.com source docs; covers template, snippets, components, frontmatter, docsUrl/slug rule) and 'when' via a concrete 'Use when...' clause listing three trigger scenarios.

5 / 5

Trigger Term Quality

Good natural phrases users would say ('adding a new source doc', 'fixing an inconsistent or stub source doc', 'standardizing the docs'), but a few common variations (e.g. 'documentation page', 'connector doc') are missing, so coverage is not fully comprehensive.

4 / 5

Distinctiveness Conflict Risk

Clear niche — the posthog.com documentation for PostHog Data warehouse import sources — with distinct, specific triggers that are unlikely to fire for unrelated skills, keeping conflict risk minimal.

5 / 5

Total

19

/

20

Passed

Validation

100%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

PostHog/posthog

Path

.agents/skills/documenting-warehouse-sources/SKILL.md

Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.