CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

writing-docs

Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.

Quality

83%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

78%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.

A highly actionable, well-organized style guide with concrete commands, exact paths, and excellent do/don't examples — essentially everything needed to execute is on the page. Its weaknesses are minor: some duplicated guidance that could be trimmed, no validation checkpoints in the page-creation workflow, and no progressive disclosure for a 250-line body whose reference material could live in separate files.

Suggestions

Move the "Special components" reference material (Steps, ExperimentalBadge, AvailableFrom patterns, CompatibilityTable props, optional-parameter rules) into a references/ file and keep a one-line pointer per component in SKILL.md.

Consolidate the duplicated AvailableFrom guidance ("Version indicators" vs. "Special components > AvailableFrom") and the duplicated preview-card instructions into single sections.

Add a validation checkpoint to the "Adding a new page" workflow, e.g., verifying the docs build or twoslash snippets pass before committing.

DimensionReasoningScore

Conciseness

The body is dense and rule-driven with good/bad example pairs and no explanation of concepts Claude already knows, but there is minor redundancy — AvailableFrom placement rules appear both under "Version indicators" and again under "Special components", and preview-card generation is described in both the "Adding a new page" steps and its own section — so anchor 4 rather than the every-token-earns-its-place profile of 5.

4 / 5

Actionability

Guidance is fully executable throughout: exact file paths (packages/docs/sidebars.ts), exact commands (bun render-cards.ts, --overwrite=<composition-id>), the full CompatibilityTable prop list, and copy-paste-ready do/don't snippets covering the common formatting cases — a clear anchor 5 match.

5 / 5

Workflow Clarity

"Adding a new page" is a clear numbered 4-step sequence ending in a concrete command, and "Streamlining existing docs" provides a scan checklist, but there are no explicit validation checkpoints (e.g., verifying the page builds or twoslash passes), which keeps it below the feedback-loop profile of anchor 5.

4 / 5

Progressive Disclosure

The ~250-line body is entirely inline with no bundle files or references; the "Special components" material (Steps, AvailableFrom, CompatibilityTable props, optional-parameter patterns) is reference-style content that could be offloaded to a references/ file, matching anchor 3's inline-content-that-could-be-separate profile despite good section headers — the under-50-lines exception does not apply.

3 / 5

Total

16

/

20

Passed

Description

82%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 well-formed description that clearly and explicitly states both what the skill does and when to use it, with a distinct Remotion-specific niche and good natural trigger terms. Its only weakness is that the capability statement itself is thin — the concrete detail lives in the trigger clause rather than an enumeration of what the skill covers.

DimensionReasoningScore

Specificity

"Guides for writing and editing Remotion documentation" names the domain with two fairly generic actions; the concrete specifics ("adding docs pages, editing MDX files") appear in the trigger clause rather than as an enumerated list of capabilities, matching anchor 3 rather than the several-specific-actions profile of anchor 4.

3 / 5

Completeness

It explicitly answers both parts: the what ("Guides for writing and editing Remotion documentation") in third person, and the when via a concrete "Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content" clause with three specific triggers — a clear anchor 5 match.

5 / 5

Trigger Term Quality

Natural phrases users would say are present — "adding docs pages", "editing MDX files", "packages/docs", "documentation content" — but common variations like "updating the docs" or "Remotion docs" are missing, placing it at anchor 4 rather than comprehensive anchor 5.

4 / 5

Distinctiveness Conflict Risk

The niche is unmistakable (Remotion documentation, MDX files in packages/docs) with distinct trigger phrases, so it would not fire for unrelated documentation or general writing skills — minimal conflict risk.

5 / 5

Total

17

/

20

Passed

Validation

93%

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

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 4 suspicious

Warning

Total

15

/

16

Passed

Repository

remotion-dev/remotion

Path

.agents/skills/writing-docs/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.