CtrlK
BlogDocsLog inGet started
Tessl Logo

docs-sync

Keep ioredis documentation synchronized with code behavior. Use when an agent changes public APIs, options, Redis command support, examples, generated typings, connection behavior, Cluster/Sentinel behavior, Pub/Sub, pipelines, transactions, scan streams, reconnect behavior, TypeScript usage, or release-facing behavior that may require README or docs updates.

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

75%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 strong instruction-only skill: lean, repository-specific, and immediately executable, with a clear workflow and a real, well-targeted reference file. The main improvement levers are de-duplicating the surface inventory and decision triggers between SKILL.md and the reference, and adding an explicit fix-and-revalidate loop to the verification step.

Suggestions

Collapse the closing 'Documentation Decision Checklist' into step 1's inspection criteria (or move it to references/doc-coverage-checklist.md) — it repeats the same triggers already covered in steps 1 and 3.

Replace vague verification phrasing with exact commands: e.g., the tsd invocation for test/typing/ and the specific `bin/*.js` override files to edit for command signature changes.

Add an explicit feedback loop in step 5: 'If the tsd test or format-check fails, fix the declaration/example and re-run before proceeding.'

DimensionReasoningScore

Conciseness

The body assumes Claude's competence throughout — no Redis/PubSub concept explanations, just repo-specific paths, commands, and decision rules. It is not a 5 because the closing 'Documentation Decision Checklist' substantially restates triggers already covered in steps 1 and 3, and step 2's surface inventory duplicates content in references/doc-coverage-checklist.md, so some tokens could be trimmed.

4 / 5

Actionability

Highly concrete: exact file paths (`lib/redis/RedisOptions.ts`, `bin/overrides.js` context), copy-paste commands (`npm run docs`, `node bin/index.js`, `npm run format-check`), and unambiguous decision rules per change type. Not a 5 because a few instructions remain slightly underspecified — 'run the focused tsd test' and 'update generator config in `bin/`' name no exact command or file (the latter's specifics live only in the reference file).

4 / 5

Workflow Clarity

The five-step workflow (inspect → find surface → update → keep examples honest → verify) is clearly sequenced, and step 5 provides explicit verification commands plus a decision checklist. It falls short of a 5 because there is no error-recovery feedback loop (e.g., what to do when the tsd test or format-check fails) — validation is listed but retry/fix guidance is implicit.

4 / 5

Progressive Disclosure

Well-organized sections with a single, clearly signaled, one-level-deep reference ('also read `references/doc-coverage-checklist.md`' for broad audits), and the referenced file exists and matches its purpose. Not a 5 because step 2 inlines the full documentation-surface inventory that is also maintained in the reference file — that inventory could live entirely in the reference, making the split slightly less than clean.

4 / 5

Total

16

/

20

Passed

Description

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

An exemplary description: third-person, tight, and fully explicit about both what it does and when to use it, with trigger terms drawn from the domain's real vocabulary. The only nit is that the what-clause states one action while the how (JSDoc, examples, typings, migration wording) lives in the body rather than the description.

DimensionReasoningScore

Specificity

The 'what' is concrete and single-purpose — 'Keep ioredis documentation synchronized with code behavior' — with the update targets named (README, docs). It lists several specific surfaces, but the capability itself is one action rather than the multiple distinct actions of the anchor-5 example, and it does not enumerate what 'synchronized' involves (update examples, JSDoc, typings) in the what-clause.

4 / 5

Completeness

It explicitly answers both questions: a clear what ('Keep ioredis documentation synchronized with code behavior') and an explicit, concrete 'Use when an agent changes...' clause listing specific trigger conditions and closing with the release-facing catch-all 'that may require README or docs updates'.

5 / 5

Trigger Term Quality

The 'Use when' clause is a comprehensive list of natural trigger vocabulary — 'public APIs, options, Redis command support, examples, generated typings, connection behavior, Cluster/Sentinel behavior, Pub/Sub, pipelines, transactions, scan streams, reconnect behavior, TypeScript usage' plus 'README or docs updates' — closely matching the phrases a contributor to this repo would actually say, including both feature names and artifact names.

5 / 5

Distinctiveness Conflict Risk

It occupies a clear niche (ioredis documentation sync) with domain-specific triggers (Cluster/Sentinel, scan streams, generated typings) that virtually no other skill would share, so mis-triggering risk is minimal despite the intentionally broad list within its own repo.

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
redis/ioredis
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.