CtrlK
BlogDocsLog inGet started
Tessl Logo

you-might-not-need-a-comment

Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc

64

Quality

77%

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/you-might-not-need-a-comment/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

87%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content is concise, actionable, and well-structured with concrete examples for both anti-patterns and exceptions. The only gap is the absence of a verification step in the workflow for a batch, code-modifying pass.

Suggestions

Add a verification checkpoint to the Steps, e.g. after applying fixes run typecheck/build to confirm no comment was load-bearing (machine-read annotations, license headers) before finishing.

Consider a brief "do not touch" reminder in the Steps pointing back to the preserved annotation prefixes, so the destructive pass guards its own exceptions.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it never explains what comments or TSDoc are, and every section (rule, anti-patterns, correct patterns, bias, steps) carries load-bearing guidance.

3 / 3

Actionability

Concrete examples accompany every anti-pattern (`// increment counter` above `counter++`, machine-read annotation prefixes to preserve) and give clear, decision-ready guidance — appropriate for an instruction-only skill.

3 / 3

Workflow Clarity

The two Steps are sequenced and branch on fix=true/false, but a batch code-modification pass has no validation checkpoint (e.g. confirming the build/typecheck still passes), capping workflow clarity at 2.

2 / 3

Progressive Disclosure

At ~40 lines with no external references needed, the well-organized sections (rule, anti-patterns, correct patterns, bias, steps) satisfy progressive disclosure for a simple skill.

3 / 3

Total

11

/

12

Passed

Description

67%

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 concrete and distinctive, clearly stating what the skill does. Its main weakness is the missing explicit "Use when…" trigger guidance and limited natural keyword variations.

Suggestions

Append an explicit trigger clause, e.g. "Use when cleaning up inline comments, reducing comment noise, or converting documentation comments to TSDoc."

Add common natural phrasings users would say (e.g. "code comments", "comment cleanup") to broaden trigger coverage.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — "Analyze and fix", "remove noise", "promote genuine documentation to TSDoc" — each tied to a specific, verifiable operation rather than vague language.

3 / 3

Completeness

The what is explicit, but there is no "Use when…" clause or equivalent trigger guidance, so per the judging guideline completeness is capped at 2.

2 / 3

Trigger Term Quality

"redundant or self-explanatory inline comments" and "TSDoc" are natural terms, but common user phrasings like "clean up comments", "code comments", or "comment noise" are missing, so coverage is partial.

2 / 3

Distinctiveness Conflict Risk

The comment-reduction / TSDoc-promotion niche is specific and unlikely to trigger for unrelated skills, giving it a clear distinct position.

3 / 3

Total

10

/

12

Passed

Validation

93%

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

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository
simstudioai/sim
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.