CtrlK
BlogDocsLog inGet started
Tessl Logo

documentation-templates

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

54

Quality

61%

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/AI-Agents-Safe-Coding-Skills/skills/documentation-templates/SKILL.md

The canonical home for this skill is documentation-templates in administrakt0r/AI-Agents-Safe-Coding-Skills

SKILL.md
Quality
Evals
Security

Quality

Content

68%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 an efficient, well-organized catalog of copy-paste documentation templates with useful tables (when to comment, structure principles) and no concept over-explanation. The chief gaps are placeholder-heavy templates lacking concrete filled examples, the absence of any selection workflow, and a generic filler "When to Use" closing line.

Suggestions

Replace the generic "## When to Use" line with concrete trigger guidance listing the documentation types this skill covers.

Add a short selection workflow (e.g. identify doc type → pick matching template → fill placeholders → verify against the Structure Principles checklist) to give the template catalog a sequenced, validated path.

Convert at least one template's bracketed placeholders into a concrete filled example so the most common case is copy-paste ready without guessing.

DimensionReasoningScore

Conciseness

The body is mostly compact templates and tables that assume Claude's competence; it avoids explaining what a README or PDF is. It is not a clean 5 only because the closing "## When to Use" line ("applicable to execute the workflow or actions described in the overview") is generic filler that earns no token.

4 / 5

Actionability

Copy-paste-ready markdown templates are provided for README, API endpoints, JSDoc/TSDoc, changelog, ADR, and llms.txt. They stop short of anchor 5 because they use bracketed placeholders ([Project Name], [Minimum steps to run], [Request and response example]) rather than concrete filled-in examples covering common cases.

4 / 5

Workflow Clarity

Content is organized into clearly delineated sections, and the README "Essential Sections (Priority Order)" table gives a light sequence, but there is no real multi-step workflow with validation checkpoints — this is a template catalog, not a sequenced process, so it sits at anchor 3 rather than 4.

3 / 5

Progressive Disclosure

No bundle files exist (references/scripts/assets absent), so all content is inline in a single well-sectioned SKILL.md with clear H2 groupings and scannable tables. It is good structure with only minor organization gaps; it is not anchor 5 because no one-level-deep references split the larger template sets out.

4 / 5

Total

15

/

20

Passed

Description

53%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 conveys the skill's scope and lists recognizable documentation categories, giving it a clear niche. Its main weakness is the missing explicit "Use when" trigger guidance and the reliance on category nouns rather than concrete actions, which keeps specificity, trigger quality, and completeness at the midpoint.

Suggestions

Append an explicit trigger clause, e.g. "Use when creating or restructuring README files, API docs, code comments, changelogs, ADRs, or AI-friendly (llms.txt) documentation."

Lead with concrete action verbs (e.g. "Generate", "Scaffold", "Structure") instead of the noun phrase "templates and structure guidelines" to raise specificity.

Add natural synonyms and file extensions users say (readme.md, docstrings/JSDoc, CHANGELOG.md, llms.txt) to broaden trigger-term coverage.

DimensionReasoningScore

Specificity

"Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation." names the domain and several concrete categories, but these are nouns/topics rather than the concrete actions the anchor-3/4 examples call for (e.g. "generate", "fill", "merge").

3 / 5

Completeness

The "what" is clear (templates/structure guidelines across named doc types) but there is no "Use when..." clause or equivalent trigger guidance, which per the judging guidelines caps completeness at 3.

3 / 5

Trigger Term Quality

Natural terms like "README", "API docs", and "code comments" appear, but there are no synonyms or variations (e.g. "readme.md", "docstrings", "JSDoc", "changelog") and the description leans on category labels rather than the phrases a user would naturally say.

3 / 5

Distinctiveness Conflict Risk

"Documentation templates and structure guidelines" scoped to README/API docs/code comments/AI-friendly docs is a mostly distinct niche with only minor overlap risk against general writing skills; it is not the fully explicit, conflict-free trigger set of anchor 5 because no "Use when" phrasing is present.

4 / 5

Total

13

/

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.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

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

Warning

Total

15

/

16

Passed

Repository
administrakt0r/AI-Agents-Safe-Coding-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.