Name: documentation
Rating: 46.400000000000006 (1 reviews)
Author: administrakt0r

documentation

Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.

Quality

48%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

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/SKILL.md

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

Quality

Content

42%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-structured catalog of eight documentation phases, but it is verbose from templated repetition and offers only high-level actions with copy-paste invocation strings rather than executable guidance. Validation is limited to a single end-of-workflow checklist with no per-phase checkpoints.

Suggestions

Collapse the repeated per-phase template into a compact table or shared pattern to cut the boilerplate and lift conciseness.

Add per-phase validation checkpoints (e.g., verify OpenAPI spec parses, confirm README examples run) so the workflow has explicit feedback loops.

Provide at least one executable example per phase (e.g., a sample command or generated snippet) instead of only 'Use @skill ...' prompts to improve actionability.

Dimension	Reasoning	Score
Conciseness	Roughly 250 lines repeat the same 'Skills to Invoke / Actions / Copy-Paste Prompts' template across eight phases with thin prompts like 'Use @docs-architect to plan documentation structure', making it noticeably padded.	2 / 5
Actionability	Copy-paste invocation prompts and numbered actions give some concrete guidance, but the actions are high-level ('Extract API endpoints', 'Generate OpenAPI specs') with no executable code or commands.	3 / 5
Workflow Clarity	Phases 1-8 are clearly sequenced and a final Quality Gates checklist exists, but there are no per-phase validation checkpoints or feedback loops, so checkpoints remain implicit.	3 / 5
Progressive Disclosure	The body is well-sectioned into phases and doc types, but no references/scripts/assets bundle files exist and all content is inlined in one file that could plausibly split phase detail into separate references.	3 / 5
	Total	11 / 20 Passed

Description

55%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 workflow covers across multiple documentation types but omits any explicit 'when to use' trigger guidance, which limits its completeness and trigger quality. Third-person voice is correctly used and the niche is reasonably specific.

Suggestions

Add an explicit 'Use when...' clause naming concrete trigger phrases (e.g., 'Use when the user asks to generate API docs, write a README, or document code').

Include natural synonyms and file extensions users say ('README', '.md', 'JSDoc', 'OpenAPI', 'changelog') to broaden trigger-term coverage.

Sharpen actions into verbs ('Generates', 'Scaffolds', 'Extracts') rather than listing coverage nouns to lift specificity from 4 toward 5.

Dimension	Reasoning	Score
Specificity	Names the domain and several concrete coverage areas ('API docs, architecture docs, README files, code comments, and technical writing'), listing multiple specific outputs with only minor gaps in action verbs.	4 / 5
Completeness	Provides a clear 'what' (documentation generation workflow covering listed types) but has no 'Use when...' clause or equivalent explicit trigger guidance, capping completeness at 3 per the rubric.	3 / 5
Trigger Term Quality	Includes relevant natural terms like 'API docs', 'README files', and 'code comments', but lacks common synonyms, file extensions, or phrasings users actually say ('document my code', 'write a README').	3 / 5
Distinctiveness Conflict Risk	'Documentation generation workflow' is a recognizable niche and the enumerated doc types help, but 'documentation' is broad enough to overlap with several related doc skills.	3 / 5
	Total	13 / 20 Passed

Validation

93%

Warnings & errors only

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

Criteria	Description	Result
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: plugins/AI-Agents-Safe-Coding-Skills-claude/skills/documentation/SKILL.md
Commit: 57c135b

Reviewed: 3 days ago

Table of Contents

Discovery Implementation Validation

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.