CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

document

Technical documentation expert for creating clear, comprehensive documentation including API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks. Use when creating or improving technical documentation.

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 ./plugins/dev-skills/skills/document/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

63%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 well-structured and actionable for API docs and ADRs, with copy-paste templates and a sensible general workflow. Its weaknesses are inlined full templates that belong in reference files, a generic principles section that restates what Claude already knows, and missing concrete guidance for three of the five documented doc types.

Suggestions

Move the full OpenAPI and ADR examples into references/ files (e.g. references/templates/openapi.yaml, references/templates/adr.md) and keep only short skeletons or key-field notes inline, turning the 240-line body into a lean overview.

Trim the 'Documentation Principles' section to only non-obvious house conventions — audience mapping and maintainability practices — and drop generic advice like 'Use clear, concise language' and 'Structure with headings and lists' that Claude already knows.

Add a validation step to each workflow, e.g. after generating an OpenAPI spec, re-check every endpoint against the service code and verify the spec with a linter before delivering, and provide at least brief concrete templates or skeletons for runbooks, onboarding guides, and architecture docs.

DimensionReasoningScore

Conciseness

The body is mostly efficient — per-flag task workflows and doc-type contents are useful — but includes unnecessary padding: a full 48-line OpenAPI example and 33-line ADR example that mostly re-teach formats Claude already knows, plus a generic 'Documentation Principles' section ('Use clear, concise language', 'Avoid jargon without explanation') that states what Claude already knows. Not a 2 because the examples double as house-style templates and much of the body is genuinely task-relevant; not a 4 because the trimming opportunities are substantial, not minor.

3 / 5

Actionability

The body provides copy-paste-ready templates for two doc types — a complete OpenAPI 3.0 YAML spec and a full ADR markdown example — plus concrete per-flag workflows ('Read the service code to understand endpoints', 'Generate OpenAPI 3.0 specification'). Not a 5 because the other three doc types (architecture docs, onboarding, runbooks) get only bullet lists of what to include with no example or command; not a 3 because the guidance that exists is executable rather than pseudocode.

4 / 5

Workflow Clarity

A clear 7-step general sequence ('Identify Audience → Choose Format → Gather Information → Structure Content → Add Examples → Review for Clarity → Include Next Steps') with a review checkpoint, and per-flag entry steps like reading service code before generating API docs. Not a 5 because the per-flag sections are unordered bullet checklists rather than sequenced steps and there is no explicit verify-output step (e.g. validating the generated OpenAPI against the actual code); not a 3 because a coherent sequence with checkpoints is present for the main path.

4 / 5

Progressive Disclosure

Section headers organize the content, but this ~240-line SKILL.md inlines full templates (the complete OpenAPI spec and full ADR example) that clearly belong in separate reference files, e.g. references/templates/openapi.yaml and references/templates/adr.md, and no bundle files exist. This matches the anchor for 'some structure but content that should be separate is inline'. Not a 4 because ~80 lines of template content belong in external files; not a 2 because headers do provide real navigation structure.

3 / 5

Total

14

/

20

Passed

Description

75%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 solid, third-person description that clearly names the documentation domain and its artifact types with an explicit 'Use when' trigger. Its main weakness is the generic trigger clause, which repeats 'technical documentation' rather than enumerating the concrete situations (documenting an API, writing an ADR, creating a runbook) that would help routing.

Suggestions

Expand the 'Use when' clause with concrete trigger phrases, e.g. 'Use when the user asks to write or update docs, document an API/service, create an ADR, write a runbook, or build an onboarding guide.'

Add natural synonyms and variations users actually say — 'docs', 'user guide', 'onboarding guide', 'reference documentation' — to the what or when portion.

Mention the supported output formats/special cases (e.g. OpenAPI 3.0 specs, Mermaid architecture diagrams) so triggers like 'generate an OpenAPI spec' or 'draw an architecture diagram' land on this skill.

DimensionReasoningScore

Specificity

The description lists several concrete documentation artifacts — 'API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks' — matching the anchor for several specific actions with minor gaps. It is not a 5 because the actions themselves reduce to just 'creating' and 'improving' with no finer-grained capabilities, and not a 3 because the artifact-type coverage is comprehensive rather than 1-2 items.

4 / 5

Completeness

It answers both questions: the 'what' is concrete ('creating clear, comprehensive documentation including API docs (OpenAPI), ADRs...') and the 'when' is explicit ('Use when creating or improving technical documentation'). Not a 5 because the 'when' is a single generic phrase without concrete trigger variations like 'when the user asks to document an API or write a runbook', matching the anchor where 'when' could be more explicit or specific.

4 / 5

Trigger Term Quality

Natural keywords users would say appear in the text: 'API docs', 'OpenAPI', 'ADRs', 'runbooks', 'developer guides', 'technical documentation' — good coverage per the anchor, with a few natural terms missing such as 'docs', 'user guide', or 'onboarding'. Not a 5 because the 'Use when' clause adds no new trigger variations and common synonyms are absent; not a 3 because keyword coverage goes well beyond one or two generic terms.

4 / 5

Distinctiveness Conflict Risk

The named artifact types (OpenAPI specs, ADRs, runbooks) carve out a mostly distinct niche with only minor overlap risk against closely related skills like general writing or code-comment skills. Not a 5 because 'technical documentation' is itself a broad category that could overlap with README-generation or writing-assistant skills.

4 / 5

Total

16

/

20

Passed

Validation

87%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

14

/

16

Passed

Repository

rikdc/ai-skills

Path

plugins/dev-skills/skills/document/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.