CtrlK
BlogDocsLog inGet started
Tessl Logo

documentation-templates

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

61

Quality

73%

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

Quality

Content

81%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 tight, well-structured catalog of concrete, copy-paste-ready documentation templates across seven common types, with clear navigation and unambiguous single-purpose guidance. Weaknesses are minor: a few generic placeholders and a flat inline structure that forgoes progressive disclosure to deeper reference files.

Suggestions

Replace generic placeholders in key templates (e.g., "[Minimum steps to run]", "Concept 1: Brief explanation") with brief concrete examples to push actionability toward 5.

Consider splitting the larger templates (full README, per-endpoint API reference) into reference files under references/ with one-level-deep, clearly signaled links to improve progressive disclosure.

Remove the opening blockquote that restates the frontmatter description, or trim the "Essential Sections (Priority Order)" table where it duplicates the README template, to reach a 5 on conciseness.

DimensionReasoningScore

Conciseness

The body is lean and table/template-driven with minimal prose and assumes Claude knows what a README, API doc, or changelog is, fitting the "efficient; minor instances that could be trimmed" anchor. It is not a 5 because the opening blockquote restates the frontmatter description and the "Essential Sections (Priority Order)" table partially duplicates the README template that follows, and not a 3 because there is no unnecessary concept explanation to tighten.

4 / 5

Actionability

It provides copy-paste-ready, concrete templates (README, per-endpoint API docs, JSDoc/TSDoc, changelog, ADR, llms.txt) that cover common documentation cases, fitting the "mostly executable; minor gaps" anchor. It is not a 5 because several placeholders remain generic ("[Minimum steps to run]", "Concept 1: Brief explanation") and not a 3 because the templates are real and usable rather than pseudocode or high-level hints.

4 / 5

Workflow Clarity

This is a simple single-purpose template skill whose single action (apply the appropriate template) is unambiguous, with a priority-order table and numbered sections guiding selection, so the simple-skill exception allows a 5. No destructive or batch operations are present, so the cap-3 rule does not apply, and the guidance is clearer than the anchor-4 "minor validation gaps" case.

5 / 5

Progressive Disclosure

Content is well-organized into seven clearly headed, scannable sections with tables and templates and is easy to navigate, fitting the "good structure; minor organization gaps" anchor. It is not a 5 because everything is inline with no overview-pointing-to-deeper-references split (and at ~188 lines some larger templates could reasonably live in separate reference files), and not a 3 because the structure is clearly better than "could be better organized" with buried references.

4 / 5

Total

17

/

20

Passed

Description

66%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 clearly communicates what the skill provides (documentation templates and structure guidelines across README, API docs, code comments, and AI-friendly docs) with good trigger-term coverage and a distinct niche. Its main weakness is the absence of an explicit "Use when..." trigger clause in the description field, which caps completeness at 3.

Suggestions

Append an explicit trigger clause to the description, e.g. "Use when writing or scaffolding README files, API documentation, code comments, changelogs, or AI-friendly docs (llms.txt)."

Broaden trigger-term coverage by adding synonyms and extensions users actually say (e.g., JSDoc/TSDoc, docstrings, changelog, ADR, .md) to raise trigger-term quality toward 5.

Tighten the action verbs beyond "templates and structure guidelines" to concrete capabilities (e.g., "Scaffold, structure, and review") for stronger specificity.

DimensionReasoningScore

Specificity

The description names the documentation domain and enumerates several concrete artifact types ("README, API docs, code comments, and AI-friendly documentation"), matching the anchor that lists several specific items with minor coverage gaps. It is not a 3 because it goes beyond 1-2 concrete actions with well-enumerated types, and not a 5 because the verbs are limited ("templates and structure guidelines") rather than a comprehensive action set.

4 / 5

Completeness

The description gives a clear "what" ("Documentation templates and structure guidelines... README, API docs, code comments, and AI-friendly documentation") but contains no "Use when..." clause, so per the guideline a missing explicit trigger caps completeness at 3. It is not a 4 because the "when" is absent from the description field itself, and not a 2 because the "what" is clear rather than vague.

3 / 5

Trigger Term Quality

Natural user-facing terms like "README", "API docs", "code comments", and "AI-friendly documentation" give good keyword coverage, fitting the "good coverage; a few natural terms missing" anchor. It is not a 5 because synonyms (e.g., JSDoc, docstrings) and file extensions are absent, and not a 3 because the terms present are solidly natural rather than merely "some relevant keywords."

4 / 5

Distinctiveness Conflict Risk

The template-and-structure framing around specific documentation types is a clear niche with only minor overlap risk against closely related writing/documentation skills, matching the "mostly distinct" anchor. It is not a 5 because README/API-doc triggers could still overlap with generic documentation skills, and not a 3 because it is far more specific than "Works with document files."

4 / 5

Total

15

/

20

Passed

Validation

81%

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

Validation13 / 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

relative_links

Relative link issues: 2 missing

Warning

Total

13

/

16

Passed

Repository
vudovn/ag-kit
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.