CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documentation

Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.

Quality

74%

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 ./engineering/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.

A clean, well-structured overview that reads as a content spec rather than a working guide. Its strongest asset is the per-doc-type checklist; its weakness is that it never shows how to produce or verify a document, and it spends lines on generic writing principles Claude already applies.

Suggestions

Add one compact skeleton or before/after example for the highest-frequency case (e.g., a minimal README outline) so the guidance is exemplary rather than purely descriptive.

Add a short numbered procedure with a verification checkpoint, e.g., 1. Identify the reader and doc type, 2. Draft against the checklist, 3. Verify every code example runs and every link resolves.

Replace the generic Principles section (principles Claude already follows) with non-obvious guidance, such as doc-type selection heuristics or conventions for keeping docs current.

DimensionReasoningScore

Conciseness

The doc-type checklists are compact and mostly earn their tokens (e.g., "Quick start (< 5 minutes to first success)", "Rollback steps", "Escalation path"), but roughly a fifth of the body — the entire Principles section ("Write for the reader", "Show, don't tell", "Don't bury the lede") — restates writing fundamentals Claude already knows. Not 2 because there is no padded prose or concept explanation; not 4 because the generic Principles block is more than a minor trim.

3 / 5

Actionability

The checklists give concrete, specific content requirements per doc type ("Rate limits and pagination", "Who to ask for what"), which is actionable for an instruction-only skill, but there is no template, skeleton, or example document showing what good output looks like, and no concrete procedure for producing one. Not 4 because nothing is copy-paste ready or exemplary; not 2 because the per-type bullets are specific instructions, not vague hints.

3 / 5

Workflow Clarity

There is no process at all — no steps for gathering source material, drafting, or verifying the result. The deliverable per doc type is clearly enumerated, which keeps this above score 2, but no sequence and no validation checkpoints (e.g., 'confirm code examples run before publishing', 'check links') exist, so it cannot reach 4. The destructive/batch cap does not apply since documentation is not a risky operation.

3 / 5

Progressive Disclosure

The body is under 50 lines with well-organized sections (## Document Types with ### per type, ## Principles) and no need for external references — no references/, scripts/, or assets/ exist — matching the guideline that a short, self-contained, well-sectioned skill scores 5 with no bundle files.

5 / 5

Total

14

/

20

Passed

Description

78%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.

A strong description that explicitly pairs a clear 'what' with a rich set of natural-language 'when' triggers. Its main weakness is that the capability side is a single generic action pair, while the doc-type list appears only as trigger material rather than stated capabilities.

Suggestions

Promote the doc types into stated capabilities, e.g., 'Write and maintain READMEs, API references, runbooks, architecture docs, and onboarding guides' — this would raise specificity from enumerating one action ('write') to several concrete deliverables.

Add a couple of missing natural trigger synonyms such as 'user guide', 'how-to', or 'reference doc' to round out trigger-term coverage.

DimensionReasoningScore

Specificity

The description names the domain ("technical documentation") with one action pair ("Write and maintain") plus a trigger-phrase enumeration ("API docs, architecture docs, or operational runbooks"), but never lists several concrete actions like a score-4 example ("Extracts text from PDF files, fills forms, converts pages to images"). It is above score 2 because the actions are not generic, and below 4 because the capability list is thin — 'maintain' is the only action beyond 'write'.

3 / 5

Completeness

It clearly answers both questions: what ("Write and maintain technical documentation") and when ("Trigger with 'write docs for', 'document this' ... or when the user needs help with any form of technical writing"), matching the anchor for explicit what-and-when with concrete trigger phrases. Not below 5 since the 'when' clause is explicit and phrase-level, not merely implied.

5 / 5

Trigger Term Quality

Natural phrases users would actually say are present: "write docs for", "document this", "create a README", "write a runbook", "onboarding guide". It falls short of score 5's 'comprehensive coverage including synonyms and file extensions' because common variations like "user guide", "how-to", "manual", or "technical writer" are missing.

4 / 5

Distinctiveness Conflict Risk

The niche (technical writing: READMEs, runbooks, architecture docs) is fairly distinct with specific triggers, but phrases like "document this" and "create a README" carry minor overlap risk with code-documentation or repo-init skills. Not 5 because the boundary between 'technical documentation' and code-comment/README-generation skills isn't sharply drawn; not 3 because the enumerated trigger phrases are much more specific than 'Works with document files'.

4 / 5

Total

16

/

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

anthropics/knowledge-work-plugins

Path

engineering/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.