CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

create-documentation

Generate markdown documentation for a module or feature

Quality

69%

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

Quality

Content

75%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 content is a strong, concrete, well-structured guide: it tells Claude exactly where docs go, how navigation works, and what an MDX page should look like, with a single well-signaled external style reference. The main weaknesses are redundant task/process step lists and the absence of any output-validation step.

Suggestions

Merge the overlapping "Your Task" and "Process" sections into one sequenced workflow to remove duplicated steps and trim token cost.

Add an explicit validation checkpoint after writing, e.g., build or preview the docs site and confirm the new page renders and appears in the correct meta.json navigation position.

Inline a short example of the Sharp-style nested parameter table format instead of deferring it entirely to WRITING_STYLE.md, so the guidance is self-contained.

DimensionReasoningScore

Conciseness

The body is efficient and project-specific (file tree, meta.json format, MDX template), but the four-step "Your Task" list and seven-step "Process" list overlap heavily (both say read source, check existing docs, write), and "Identify the audience - Who will read this? What do they need?" is explanation Claude does not need. This fits 'Efficient; minor instances of over-explanation that could be trimmed' rather than the level-5 'every token earns its place'.

4 / 5

Actionability

Highly concrete: exact paths (content/docs/api/<class>.mdx), a copy-paste-ready meta.json example, a full MDX page template with frontmatter, parameter table, and Callout component usage. Minor gaps keep it at 4 rather than 5: the method/type template sections are placeholder slots rather than a worked example, and the nested-table style is deferred entirely to WRITING_STYLE.md ("Sharp-style nested parameter tables (see WRITING_STYLE.md)") without showing the format.

4 / 5

Workflow Clarity

A clear, ordered sequence is present twice ("Your Task" and "Process") with a scope checkpoint ("Ask the user if unclear"), and navigation/cross-reference steps are included. It is not a 5 because there is no validation step for the output — e.g., verifying the MDX page builds, the page appears correctly in navigation, or links resolve — leaving a minor validation gap consistent with the level-4 anchor.

4 / 5

Progressive Disclosure

Well-organized single-file skill with clearly-labeled sections (Documentation Structure, Where to Put Documentation, MDX File Format, Guidelines) and exactly one external reference, WRITING_STYLE.md, which is clearly signaled and one level deep ("Read WRITING_STYLE.md first" and again under Guidelines). It is not a 5 because the inlined format material (full directory tree, MDX template, Fumadocs components) could arguably be split into a reference file, and the skill is well over 50 lines, so the simple-skill exception does not apply.

4 / 5

Total

16

/

20

Passed

Description

50%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 states a clear, single-scope capability but is bare-bones: no explicit 'when to use' guidance, limited trigger vocabulary, and only one concrete action. All dimensions sit at the midpoint because the 'what' is genuine but nothing distinguishes or activates it.

Suggestions

Add an explicit 'Use when...' clause with concrete triggers, e.g., 'Use when the user asks to document a module or feature, write an API reference or guide, or add MDX pages.'

Enumerate the concrete actions the skill performs (create or update MDX pages, place docs in the correct content/docs/ section, update meta.json navigation, add cross-references) to raise specificity.

Include natural synonyms users would actually say, such as 'docs', 'MDX', 'API reference', 'guides', and 'documentation', to improve trigger-term coverage.

DimensionReasoningScore

Specificity

"Generate markdown documentation for a module or feature" names the domain and a single concrete action, but does not list several specific actions (e.g., creating or updating MDX pages, updating meta.json navigation, adding cross-references). It matches the anchor 'Names domain and 1-2 concrete actions, but not comprehensive' rather than the level-4 anchor requiring several specific actions.

3 / 5

Completeness

The description has a clear 'what' (generate markdown documentation for a module or feature) but no 'when' — there is no 'Use when...' clause or equivalent trigger guidance, which caps completeness at 3 per the judging guidelines. It is not a 2 because the 'what' is specific rather than vague.

3 / 5

Trigger Term Quality

Terms like "markdown documentation", "module", and "feature" are relevant, but common natural variations users would say ("docs", "document this", "MDX", "API reference", "guide") are missing. This fits 'Some relevant keywords but missing common variations or synonyms' rather than level 4's good keyword coverage.

3 / 5

Distinctiveness Conflict Risk

"Generate markdown documentation" is somewhat specific to documentation authoring, but without trigger phrases it could overlap with other writing, formatting, or README-generation skills. It is not a 4 because it lacks a clear niche with distinct triggers that minimize conflict risk.

3 / 5

Total

12

/

20

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.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 2 suspicious

Warning

Total

15

/

16

Passed

Repository

LibPDF-js/core

Path

.opencode/skills/create-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.