CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documentation-templates

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

Quality

72%

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 ./skills/documentation-templates/SKILL.md
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 template collection with copy-paste-ready structures and useful decision tables, scoring solidly across all dimensions. The main deductions are unfilled placeholder examples, the filler 'When to Use' boilerplate sentence, and the lack of any explicit selection/usage guidance for applying the templates.

Suggestions

Delete the boilerplate 'When to Use' section ('This skill is applicable to execute the workflow or actions described in the overview.') — it is filler that adds no information.

Fill key placeholders with one concrete worked example (e.g., a real Quick Start snippet and a filled request/response example) so the templates model real usage, not just shape.

Add a brief selection guide at the top (e.g., a table mapping the user's task — 'write a README', 'document an endpoint', 'add JSDoc' — to the section number) to make application unambiguous.

DimensionReasoningScore

Conciseness

The body is almost pure payload — templates as code blocks, comparison tables, and minimal prose — with no explanation of concepts Claude already knows. It is not a 5 because the trailing boilerplate 'This skill is applicable to execute the workflow or actions described in the overview.' is pure filler, and the time-sensitive '(2025)' heading would benefit from placement in a dated/deprecated context.

4 / 5

Actionability

Templates for README, per-endpoint API docs, JSDoc/TSDoc, changelog, ADR, and llms.txt are copy-paste-ready structures, and the 'When to Comment' table gives concrete decision guidance. Not a 5 because several placeholders are unfilled skeletons ('[Minimum steps to run]', '[Request and response example]', 'Feature 1'), so specific worked examples for common cases are missing.

4 / 5

Workflow Clarity

This is a single-purpose template-collection skill with no multi-step process and no destructive/batch operations, so no validation cap applies; each numbered section is self-contained and unambiguous, and 'Templates are starting points. Adapt to your project's needs' gives application guidance. Not a 5 because there is no explicit guidance on how to select and apply the right template in a real documentation task.

4 / 5

Progressive Disclosure

No bundle files exist, and the ~190-line body is cleanly organized into seven numbered sections with no nested or dangling references. Good structure with all content in one appropriately-sized file, though the per-doc-type templates could be split into one-level-deep reference files to keep SKILL.md as a leaner overview.

4 / 5

Total

16

/

20

Passed

Description

57%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 states what the skill provides and names several concrete documentation types, but lacks any explicit 'Use when...' trigger guidance, capping its completeness. Trigger terms are good but omit several covered areas (changelog, ADR, llms.txt), and the generic 'documentation' framing creates some overlap risk with other writing-related skills.

Suggestions

Append a trigger clause such as: 'Use when creating or restructuring READMEs, API references, code comments/docstrings, changelogs, ADRs, or llms.txt files.'

Include the other covered doc types (changelog, ADR, llms.txt) as keywords so users searching those terms activate the skill.

Use third-person action verbs for the deliverables (e.g., 'Provides templates for...' ) instead of the generic noun phrase 'templates and structure guidelines' to sharpen specificity.

DimensionReasoningScore

Specificity

Names the domain ('Documentation templates and structure guidelines') and specific doc types ('README, API docs, code comments, and AI-friendly documentation'), but the actions themselves are generic deliverables ('templates', 'guidelines') rather than concrete verbs — matching anchor 3 (domain plus 1-2 concrete items, not comprehensive), not anchor 4 which expects several specific actions.

3 / 5

Completeness

The 'what' is clear (documentation templates and structure guidelines for named doc types), but there is no 'Use when...' clause or equivalent explicit trigger guidance, which caps completeness at 3 per the judging guidelines. Not score 4 because 'when' is entirely absent rather than merely under-specified.

3 / 5

Trigger Term Quality

'README', 'API docs', 'code comments', and 'AI-friendly documentation' are natural terms users would say when needing this skill. A few natural terms are missing (changelog, ADR, llms.txt, docstrings), matching anchor 4 rather than anchor 5's comprehensive synonym/extension coverage.

4 / 5

Distinctiveness Conflict Risk

'Documentation' is a broad domain that overlaps with general writing and technical-writing skills, though the named doc types (README, API docs, code comments) narrow the scope. This sits at anchor 3 ('somewhat specific but could still overlap with similar skills') rather than anchor 4's 'mostly distinct'.

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

Validation — 15 / 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

Path

skills/documentation-templates/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.