CtrlK
BlogDocsLog inGet started
Tessl Logo

docs

ALWAYS use this when writing docs

43

Quality

42%

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 ./.cursor/skills/docs/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

85%

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

The body is an efficient, well-organized set of concrete style rules that respects the token budget and assumes Claude's competence. It would benefit from a worked before/after example to lift actionability from guidance to copy-paste ready.

DimensionReasoningScore

Conciseness

The body is a lean list of one-line style rules with no padding and no explanation of concepts Claude already knows; every line earns its place.

3 / 3

Actionability

Rules like "Chunks of text should not be more than 2 sentences long" and "prefix the commit message with docs:" are concrete, but there is no executable example or before/after illustration to make them copy-paste ready.

2 / 3

Workflow Clarity

This is a simple single-purpose skill whose guidance is unambiguous imperative rules; per the simple-skill note, clear single-action guidance scores 3.

3 / 3

Progressive Disclosure

Under 50 lines with no bundle files and well-organized as discrete rules; the referenced example path is a repo file, not a nested reference, so it qualifies for the simple-skill exception.

3 / 3

Total

11

/

12

Passed

Description

0%

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 too vague to be a useful trigger: it gives no concrete capabilities and only a weak "when" cue. It fails the completeness threshold of an explicit what-and-when statement and would conflict with many skills.

Suggestions

Add concrete actions the skill performs, e.g. "Write, edit, and format documentation pages following house style rules."

Include natural trigger terms users would say, such as "documentation", "docs pages", "readme", or "writing docs", in an explicit "Use when..." clause.

Specify the scope to reduce conflicts, e.g. noting it targets the project's docs site content rather than general writing.

DimensionReasoningScore

Specificity

The phrase "when writing docs" names no concrete actions or capabilities, only a vague activity, matching the vague/abstract anchor.

1 / 3

Completeness

It states only a vague "when" trigger and never says what the skill does, so both what and when are weak/missing.

1 / 3

Trigger Term Quality

"writing docs" is overly generic and offers no natural keyword variations a user would say; it does not cover common terms like "documentation", "readme", or "docs page".

1 / 3

Distinctiveness Conflict Risk

"when writing docs" is so generic it would conflict with nearly any writing or documentation-related skill.

1 / 3

Total

4

/

12

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
revokslab/ShipFree
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.