CtrlK
BlogDocsLog inGet started
Tessl Logo

documentation-templates

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

58

Quality

68%

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

75%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-organized, lean collection of copy-paste-ready documentation templates with clear sectioning and no padding. It scores consistently strong across all dimensions with only minor organization and conciseness trim opportunities.

DimensionReasoningScore

Conciseness

The body is lean and mostly templates/tables with minimal prose, assuming Claude's competence; the 'Structure Principles' and 'When to Comment' tables are mild over-explanation of concepts Claude already knows and could be trimmed.

4 / 5

Actionability

It provides concrete, copy-paste-ready templates (README, API endpoint, JSDoc/TSDoc, changelog, ADR, llms.txt) with minor gaps such as placeholder text like '[Request and response example]'.

4 / 5

Workflow Clarity

Content is organized into clearly numbered sections (1–7) with a priority-order table; as a templates reference rather than a multi-step process it needs no validation checkpoints, and there are no destructive or batch operations.

4 / 5

Progressive Disclosure

The skill is self-contained with a clear H2/H3 hierarchy and no external references (no bundle files present); all ~196 lines are inline, which is reasonable for a single reference but could be split into per-template reference files.

4 / 5

Total

16

/

20

Passed

Description

61%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 conveys a clear, distinct domain with natural trigger terms, but it omits explicit 'when to use' guidance and frames its actions as objects rather than concrete verbs, which caps completeness and specificity.

Suggestions

Add an explicit 'Use when...' clause naming trigger scenarios (e.g., 'Use when writing or reviewing READMEs, API docs, code comments, changelogs, or ADRs').

Replace the noun-based framing ('templates and structure guidelines') with concrete verbs (e.g., 'Generate, structure, and review documentation').

Add common synonyms and file extensions (e.g., 'docs', 'docstrings', 'CHANGELOG.md', 'ADRs') to broaden trigger-term coverage.

DimensionReasoningScore

Specificity

The description names the domain and enumerates several concrete documentation types ('README, API docs, code comments, and AI-friendly documentation'), but the stated actions are nouns ('templates and structure guidelines') rather than concrete verbs, leaving coverage of what it does generic.

3 / 5

Completeness

It clearly answers 'what' but provides no 'Use when...' clause or equivalent explicit trigger guidance, so completeness is capped at 3 per the judging guideline.

3 / 5

Trigger Term Quality

It includes natural terms users actually say ('README', 'API docs', 'code comments', 'documentation'), but omits common synonyms such as 'docs', 'docstrings', 'changelog', or 'ADR'.

4 / 5

Distinctiveness Conflict Risk

The documentation-writing niche with specific triggers (README, API docs, code comments) is mostly distinct, with only minor overlap risk against general writing skills.

4 / 5

Total

14

/

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.