CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

68

Quality

81%

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

71%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 clear, well-organized guideline with concrete file-mapping rules and examples. Its main weakness is workflow validation: docs-same-PR updates lack an explicit verify/fix/retry checkpoint.

Suggestions

Add an explicit validation step with a feedback loop, e.g. run the docs build, read errors, fix, and only mark the checklist complete when it builds — this would lift workflow_clarity above the batch-operation cap of 3.

Tighten the four Examples which repeat the same 'File / Action' structure; collapse into a table or trim redundant scenarios to improve conciseness.

Consider moving the per-file naming map or the full checklist into a references/ file and linking from the body to strengthen progressive disclosure.

DimensionReasoningScore

Conciseness

Mostly efficient list-based content that assumes domain competence without padding; a few sections (e.g. the four near-identical examples) repeat structure and could be tightened.

4 / 5

Actionability

Provides concrete file-mapping rules and scenario-specific file paths ('useSuspense.ts → docs/core/api/useSuspense.md'), but guidance is path-level rather than copy-paste executable doc content, leaving minor gaps.

4 / 5

Workflow Clarity

A clear 4-step finding sequence and a checklist exist, but verification is only an implicit checkbox ('Verified documentation builds correctly') with no explicit validation checkpoint or fix-and-retry feedback loop for this same-PR batch update.

3 / 5

Progressive Disclosure

Well-organized into titled sections with no nested references; for a sub-100-line skill with no bundle files this is appropriate, though the examples/checklist could arguably live in reference files.

4 / 5

Total

15

/

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, well-scoped description that names concrete documentation actions and provides explicit, package-specific trigger guidance. Minor trigger-term synonym gaps are the only weakness.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions across doc types (API reference Docusaurus/MDX, README, JSDoc/TSDoc, migration guides, deprecation notices, changelog) with comprehensive coverage of the documentation domain.

5 / 5

Completeness

Explicitly answers both what (write/update/format docs for @data-client public APIs) and when ('Use when changing exported APIs (docs must update in the same PR), writing new package docs, or updating the dataclient.io site') with concrete trigger phrases.

5 / 5

Trigger Term Quality

Good natural-term coverage ('documentation', 'API reference', 'README', 'JSDoc', 'migration guides', 'deprecation notices', 'changelog'), though a few common phrasings a user might say (e.g. 'docs', 'comment my code') are absent.

4 / 5

Distinctiveness Conflict Risk

Scoped to a single package (@data-client) with distinct, package-specific triggers, giving it a clear niche with minimal conflict risk against other skills.

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.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
reactive/data-client
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.