CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

packages-documentation

Write, update, and format documentation for @data-client public APIs - API reference (Docusaurus/MDX), README files, JSDoc/TSDoc docstrings, usage examples, migration guides, deprecation notices, changelog entries. Use when changing exported APIs (docs must update in the same PR), writing new package docs, or updating the dataclient.io site.

70

Quality

88%

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

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.

A well-structured, highly actionable skill body: exact file mappings, a frontmatter template, worked examples, and a closing checklist, with no filler or generic explanations. The main improvements are trimming the checklist's overlap with earlier sections and replacing the hedged documentation-build verification with a concrete command.

DimensionReasoningScore

Conciseness

The body is efficient — the React/Vue section packs repo-specific conventions Claude cannot know into dense, useful lists, and nothing explains general programming concepts. Minor trims are possible: the checklist partially repeats the Format section, and 'Documentation should be updated in the same commit or PR' restates the frontmatter description. It is above the midpoint but not the 'every token earns its place' anchor.

4 / 5

Actionability

Guidance is fully concrete: exact file mappings ('useSuspense.ts → docs/core/api/useSuspense.md'), a copy-paste frontmatter template, and four worked examples (new hook, signature change, deprecation, new option) that cover the common cases. As an instruction skill, its absence of runnable code is not penalized since every step names exact paths.

5 / 5

Workflow Clarity

The four-step 'Finding the Right Documentation File' sequence is clear and the checklist provides a pre-completion checkpoint. The gap is validation: 'Verified documentation builds correctly (if applicable)' is hedged and gives no build command, so it sits between the most-checkpoints (4) and explicit-validation (5) anchors. Not a destructive or batch operation, so no cap applies.

4 / 5

Progressive Disclosure

No bundle files exist, so all guidance lives in the single SKILL.md, which is appropriately sectioned (~113 lines) for a single-purpose documentation skill. External repo references ('website/framework-docs/README.md', '.cursor/rules/skills-sync.mdc') are clearly signaled with exact paths. Minor gap: the dense React/Vue convention block could arguably live in a reference file — good structure, not perfect.

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 that pairs a comprehensive, concrete list of documentation capabilities with an explicit three-condition 'Use when' clause, all in third person. The only gap is minor: a few natural synonym trigger terms are absent.

DimensionReasoningScore

Specificity

The description lists multiple concrete actions and artifacts — 'API reference (Docusaurus/MDX), README files, JSDoc/TSDoc docstrings, usage examples, migration guides, deprecation notices, changelog entries' — giving comprehensive coverage of the skill's capabilities in third-person voice.

5 / 5

Completeness

It explicitly answers both questions: a clear 'what' ('Write, update, and format documentation for @data-client public APIs...') followed by an explicit 'Use when' clause with three concrete trigger conditions.

5 / 5

Trigger Term Quality

Good keyword coverage with natural phrases users would say ('changing exported APIs', 'writing new package docs', 'updating the dataclient.io site'), but a few natural synonyms are missing (e.g., 'doc comments', 'typedoc', 'API docs'). It falls between the good-coverage (4) and comprehensive-synonyms (5) anchors, closer to 4.

4 / 5

Distinctiveness Conflict Risk

The niche is tightly scoped to @data-client package documentation and the dataclient.io site with distinct triggers, so it is clearly distinguishable from generic documentation skills and unlikely to fire for the wrong skill.

5 / 5

Total

19

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

metadata_field

'metadata' should map string keys to string values

Warning

Total

14

/

16

Passed

Repository

reactive/data-client

Path

.agents/skills/packages-documentation/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.