CtrlK
BlogDocsLog inGet started
Tessl Logo

writing-web-documentation

Write, rewrite, review, and organize developer-facing documentation for web software projects. Use when creating or improving README files, docs homepages, quickstarts, tutorials, how-to guides, API/reference pages, conceptual explanations, migration guides, or troubleshooting content for frontend, backend, full-stack, SDK, API, or framework-based web products. This skill applies strong information architecture, task-first page structure, clear voice, runnable examples, version and prerequisite hygiene, accessibility rules, and docs-as-code maintenance habits. Do not use it for marketing copy, legal text, or non-technical customer-support articles.

72

Quality

89%

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

SKILL.md
Quality
Evals
Security

Quality

Content

78%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 a well-structured instruction-only overview: a strong page-type taxonomy, a concrete default workflow with a verification gate, and disciplined progressive disclosure to real references and templates. The only soft spots are minor philosophical padding and validation that lives in a referenced checklist rather than inline.

Suggestions

Trim the philosophical framing ("Good documentation is not a dump of product facts..." and the "Final instruction" section) to tighten the token budget without losing actionable guidance.

Inline the 5-8 highest-priority review-checklist items next to step 7 so the validation gate is actionable without loading assets/review-checklist.md.

Add an explicit validate→fix→retry loop (e.g., "if the checklist fails, fix the flagged items and re-run before delivering") to strengthen the workflow's feedback loop.

DimensionReasoningScore

Conciseness

Mostly lean and well-bulleted without explaining concepts Claude already knows, but the philosophical framing lines ("Good documentation is not a dump of product facts" and the "Final instruction" section) are mild over-explanation that could be trimmed.

4 / 5

Actionability

Concrete, specific instruction-level guidance throughout — an explicit fact-inventory checklist, a preferred skeleton order, and runnable-example rules — though the actual review checks live only in an external file rather than inlined.

4 / 5

Workflow Clarity

A clear 7-step numbered default workflow with a verification gate ("Run the review checklist" before delivering), but it relies on an external checklist for the validation details rather than spelling a validate→fix→retry feedback loop inline.

4 / 5

Progressive Disclosure

A clear overview pointing to one-level-deep references and assets, each signalled with purpose in a table and file list, with explicit "load on demand" guidance; verified bundle files exist and references do not nest further.

5 / 5

Total

17

/

20

Passed

Description

100%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 exemplary: it states concrete actions, comprehensive natural trigger terms, and an explicit use-when clause with a negative boundary. Voice is correctly third-person imperative throughout.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — "Write, rewrite, review, and organize developer-facing documentation" — covering a comprehensive range of doc tasks rather than vague abstraction.

5 / 5

Completeness

Explicitly states what the skill does ("Write, rewrite, review, and organize developer-facing documentation") and when to use it ("Use when creating or improving...") with concrete trigger phrases and a negative-use boundary.

5 / 5

Trigger Term Quality

Exhaustive natural-language triggers spanning README files, docs homepages, quickstarts, tutorials, how-to guides, API/reference pages, migration guides, and troubleshooting, plus product qualifiers like frontend/backend/full-stack/SDK/API.

5 / 5

Distinctiveness Conflict Risk

A clear niche — developer-facing web documentation — with distinct triggers and an explicit exclusion list ("Do not use it for marketing copy, legal text, or non-technical customer-support articles"), minimizing overlap with adjacent skills.

5 / 5

Total

20

/

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
onmax/nuxt-skills
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.