CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documentation

Add documentation for contributors and developers.

Quality

61%

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

Quality

Content

57%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 token-efficient and assumes competence, but it reads as scattered policy statements rather than actionable or sequenced guidance: no file paths or commands for the website/docs folders, no validation steps, and no section headers to separate the three documentation forms. It is a reasonable briefing but stops short of being executable.

Suggestions

Add section headers for the three documentation forms (code comments / DESIGN.md / website) and move each policy under its header so the body is skimmable.

Provide concrete paths and commands, e.g. where the 11ty website lives and how to run it, so 'update the 3.x folder' is executable rather than descriptive.

Turn the policies into a short ordered checklist (identify affected docs -> update DESIGN.md -> update versioned website folder -> update migration doc for breaking changes) with an explicit verification step.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence, with no explanation of known concepts; only minor trimming opportunities remain ('should always be kept up-to-date', the restated folder-version example), matching 'Efficient; minor instances of over-explanation that could be trimmed'.

4 / 5

Actionability

Concrete rules exist ('update the documentation in the 3.x folder', 'ensure the migration document has been updated'), but key execution details are missing — no paths to the website or docs folders, no commands, no file locations — matching 'Some concrete guidance but incomplete'.

3 / 5

Workflow Clarity

Conditional rules ('If you are making a breaking change...', 'if 1.x/2.x/3.x folders are available...') convey what to do per situation, but there is no sequenced workflow and no validation checkpoints, matching 'sequence present but checkpoints missing or implicit'.

3 / 5

Progressive Disclosure

No bundle files exist (references/, scripts/, assets/ are absent) and the body references no external files, so this is scored on internal organization alone: the three documentation forms (code comments, DESIGN.md, website) are interwoven across headerless paragraphs, matching 'Some structure but could be better organized'.

3 / 5

Total

13

/

20

Passed

Description

45%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 concise and in third person but under-specified: one generic action, no 'use when' trigger guidance, and no distinctive terms (DESIGN.md, docs website, migration guides) that would set it apart. It answers 'what' only weakly and 'when' not at all.

Suggestions

Add an explicit trigger clause, e.g. 'Use when adding or updating repo documentation: DESIGN.md files, the docs website, or migration guides for breaking changes.'

Enumerate the concrete actions the skill covers (update DESIGN.md, update the versioned docs website folder, update migration documents) instead of the generic 'Add documentation'.

Include natural trigger terms users would say such as 'docs', 'README', 'DESIGN.md', 'migration guide', and 'documentation website' to improve both trigger quality and distinctiveness.

DimensionReasoningScore

Specificity

The description names the domain ('documentation') but offers only one generic action ('Add documentation') with an audience qualifier, matching the anchor 'Names the domain but actions are minimal or generic'. It lacks the second concrete action needed for a 3.

2 / 5

Completeness

The 'what' is present ('Add documentation for contributors and developers') but there is no 'Use when...' clause or equivalent trigger guidance, which caps completeness at 3 per the judging guidelines.

3 / 5

Trigger Term Quality

'documentation', 'contributors', 'developers' are relevant keywords users might say, but common variations and synonyms ('docs', 'README', 'DESIGN.md', 'docs website') are missing, matching 'Some relevant keywords but missing common variations'.

3 / 5

Distinctiveness Conflict Risk

'Add documentation for contributors and developers' is somewhat specific via its audience qualifier, but 'documentation' is a broad term with overlap risk against general docs/README tasks, matching 'Somewhat specific but could still overlap with similar skills'.

3 / 5

Total

11

/

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

microsoft/fast

Path

.github/skills/documentation/SKILL.md

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.