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

82%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

65%

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

Highly actionable Remotion-specific documentation guidance with strong executable examples, undermined by some repetition and the absence of explicit verification checkpoints in its workflows and of any progressive file structure for its detailed reference material.

Suggestions

De-duplicate: keep preview-card generation and AvailableFrom guidance in one place each, cross-referencing from the other section instead of restating.

Add an explicit verification checkpoint to the page-creation workflow (e.g., confirm the new page renders and its entry sits correctly in sidebars.ts before generating cards).

Consider moving the detailed component reference (CompatibilityTable props, AvailableFrom variants, Step formatting rules) into a reference file under references/ and linking to it from the body, so SKILL.md stays an overview.

Dimension	Reasoning	Score
Conciseness	Mostly lean and Remotion-specific, but not every token earns its place: preview-card generation appears in both the "Adding a new page" steps and a separate "Generating preview cards" section, and AvailableFrom guidance is repeated at lines ~35 and ~121-139.	2 / 3
Actionability	Provides copy-paste-ready, executable guidance throughout — exact commands ("bun render-cards.ts"), real frontmatter snippets, twoslash/`// ---cut---` fence patterns, and exact CompatibilityTable prop values — fully matching the executable anchor.	3 / 3
Workflow Clarity	The "Adding a new page" flow is a clear numbered sequence and "Streamlining existing docs" gives an audit checklist, but no explicit validation/verification checkpoint (e.g., confirm the page renders or the card generated) is present, fitting the sequence-with-implicit-checkpoints anchor.	2 / 3
Progressive Disclosure	Well-organized into navigable sections with one clearly signaled external skill reference (docs-demo), but as a 217-line single file with no bundle/reference files, detailed component reference material (CompatibilityTable, AvailableFrom variants) is inline rather than split into one-level-deep reference files.	2 / 3
	Total	9 / 12 Passed

Description

100%

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-crafted description: third-person, concise, with explicit triggers and a distinct Remotion-specific niche. It cleanly answers both what the skill does and when to invoke it.

Dimension	Reasoning	Score
Specificity	Names multiple concrete actions — "writing and editing Remotion documentation", "adding docs pages", "editing MDX files in packages/docs", "writing documentation content" — matching the multi-action anchor rather than the single-domain level 2.	3 / 3
Completeness	Explicitly answers both what ("Guides for writing and editing Remotion documentation") and when with a clear "Use when adding docs pages, editing MDX files..." trigger clause, matching the full what+when anchor.	3 / 3
Trigger Term Quality	Uses natural terms a Remotion contributor would actually say ("docs pages", "MDX files", "packages/docs", "documentation content"), covering common variations rather than just one keyword.	3 / 3
Distinctiveness Conflict Risk	Scoped to Remotion documentation with repo-specific triggers (MDX files in packages/docs), giving it a clear niche unlikely to fire for unrelated skills.	3 / 3
	Total	12 / 12 Passed

Validation

93%

Warnings & errors only

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

Criteria	Description	Result
relative_links	Relative link issues: 4 suspicious	Warning

	Total	15 / 16 Passed

Repository: remotion-dev/remotion
Path: .agents/skills/writing-docs/SKILL.md
Commit: 06f2fd7

Reviewed: 2 days ago

Table of Contents

Discovery Implementation Validation

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.