CtrlK
BlogDocsLog inGet started
Tessl Logo

jsdoc

Full JSDoc format guide for TypeScript, covering @example formats (short, multi-line, multi-variant), tag usage (@default, @deprecated, what to avoid), documentation patterns for properties/enums/functions, and tag order.

64

Quality

76%

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

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/jsdoc/SKILL.md
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.

The body is a tight, highly actionable format guide with concrete code examples and correct/incorrect tables throughout. Structure is good, though it is a single ~189-line monolithic reference rather than a split overview-plus-references layout.

DimensionReasoningScore

Conciseness

Mostly lean tables and code examples with little over-explanation of concepts Claude already knows; not 5 because a few prose asides ('Do not add @default false... when the TypeScript type already makes the default obvious') slightly duplicate the tables.

4 / 5

Actionability

Provides copy-paste-ready code for every pattern (property, default, enum, nested, function) plus explicit correct/incorrect tables and do/don't lists covering the common cases, matching the 'fully executable, copy-paste ready' anchor.

5 / 5

Workflow Clarity

As a format-guide skill it has no destructive/batch operation requiring validation checkpoints, and the explicit ordered 'Tag order' section gives a clear sequence with do/don't rules; not 5 because there is no checklist or feedback loop, though none is strictly needed here.

4 / 5

Progressive Disclosure

Well-organized into clear sections (@example format, Tags, Documentation patterns, Guidelines, Tag order) with no nested references; not 5 because at ~189 lines it is a single monolithic reference rather than a lean overview pointing to one-level-deep reference files, and no bundle files exist to offload detail.

4 / 5

Total

17

/

20

Passed

Description

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

The description is specific and distinct, clearly scoping a JSDoc/TypeScript format guide with concrete coverage areas. Its main weakness is the absence of any 'Use when...' trigger guidance, which caps completeness at 3.

Suggestions

Add an explicit trigger clause, e.g. 'Use when writing or reviewing JSDoc/TSDoc comments on TypeScript types, properties, enums, or functions.'

Include common synonyms users might say ('doc comments', 'TSDoc', 'documentation comments') alongside 'JSDoc' to improve trigger term coverage.

Lead with a concrete action verb framing (e.g. 'Write and format JSDoc comments...') in addition to the 'guide' framing.

DimensionReasoningScore

Specificity

Names the domain (JSDoc for TypeScript) and lists several specific coverage areas (@example formats, tag usage, documentation patterns for properties/enums/functions, tag order), matching the 'several specific actions; minor gaps' anchor; not 5 because it frames a reference guide rather than enumerating concrete single-task verbs.

4 / 5

Completeness

Clearly answers 'what' (full format guide covering listed topics) but provides no 'Use when...' clause or equivalent trigger guidance, so per the rubric's explicit cap completeness cannot exceed 3.

3 / 5

Trigger Term Quality

Includes natural terms a user would say ('JSDoc', 'TypeScript', '@example', '@default', '@deprecated') with good coverage; not 5 because common synonyms like 'doc comments', 'TSDoc', or 'documentation comments' are missing.

4 / 5

Distinctiveness Conflict Risk

'JSDoc format guide for TypeScript' is a clear niche with distinct triggers and minimal overlap risk with other skills; fits the 'clear niche, minimal conflict risk' anchor.

5 / 5

Total

16

/

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
kubb-labs/kubb
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.