jsdoc-comment-generator
Jsdoc Comment Generator - Auto-activating skill for Technical Documentation. Triggers on: jsdoc comment generator, jsdoc comment generator Part of the Technical Documentation skill category.
35
Quality
3%
Does it follow best practices?
Impact
93%
1.00xAverage score across 3 eval scenarios
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./planned-skills/generated/17-technical-docs/jsdoc-comment-generator/SKILL.mdQuality
Discovery
7%Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.
This description is essentially a template placeholder with minimal useful content. It lacks concrete actions, natural trigger terms, and explicit usage guidance. The only distinguishing element is the 'JSDoc' keyword, but without explaining what the skill actually does or when to use it, Claude cannot effectively select this skill.
Suggestions
Add specific actions the skill performs, e.g., 'Generates JSDoc comments for JavaScript/TypeScript functions, including @param, @returns, @throws, and @example tags.'
Include a 'Use when...' clause with natural triggers like 'Use when the user asks to document functions, add JSDoc comments, generate API documentation, or mentions @param/@returns annotations.'
Add natural keyword variations users would say: 'document this function', 'add comments', 'API docs', 'function documentation', '.js', '.ts' files.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description only states 'Jsdoc Comment Generator' and 'Technical Documentation' without describing any concrete actions. It doesn't explain what the skill actually does (e.g., generates JSDoc comments, parses functions, adds parameter descriptions). | 1 / 3 |
Completeness | The description fails to answer 'what does this do' beyond the name, and has no explicit 'Use when...' clause. The 'Triggers on' section is not a proper when-to-use guidance, just keyword matching. | 1 / 3 |
Trigger Term Quality | The triggers listed are just 'jsdoc comment generator' repeated twice. Missing natural variations users would say like 'document this function', 'add JSDoc', 'generate documentation', 'comment my code', '@param', '@returns'. | 1 / 3 |
Distinctiveness Conflict Risk | The term 'JSDoc' is fairly specific to JavaScript documentation, which provides some distinctiveness. However, 'Technical Documentation' is generic and could overlap with other documentation skills. | 2 / 3 |
Total | 5 / 12 Passed |
Implementation
0%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill content is essentially a placeholder template with no actual JSDoc-specific guidance. It contains no executable code examples, no JSDoc syntax patterns, no workflow for generating comments, and wastes tokens on generic descriptions that provide zero actionable value.
Suggestions
Add concrete JSDoc syntax examples showing @param, @returns, @typedef, @example tags with actual code
Provide a clear workflow: 1) Identify function signature, 2) Document parameters with types, 3) Document return value, 4) Add usage example
Include copy-paste ready templates for common patterns (functions, classes, modules, type definitions)
Remove all generic boilerplate text ('provides automated assistance', 'follows industry best practices') and replace with specific JSDoc conventions
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is padded with generic boilerplate that explains nothing specific about JSDoc. Phrases like 'provides automated assistance' and 'follows industry best practices' are filler that waste tokens without adding value. | 1 / 3 |
Actionability | No concrete code, commands, or examples of actual JSDoc syntax are provided. The skill describes what it does abstractly but never shows how to generate a JSDoc comment or provides any executable guidance. | 1 / 3 |
Workflow Clarity | No workflow or steps are defined. The content lists vague capabilities but provides no sequence for generating JSDoc comments, no validation steps, and no process to follow. | 1 / 3 |
Progressive Disclosure | The content is a monolithic block of generic text with no structure pointing to detailed resources, examples, or reference materials. No links to JSDoc syntax guides or related documentation. | 1 / 3 |
Total | 4 / 12 Passed |
Validation
81%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 9 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 9 / 11 Passed | |
- Commit
0c08951
- 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.