code-documentation

Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.

Quality

82%

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

Quality

Content

65%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-organized, example-rich reference skill with strong actionable templates, but it is monolithic and lacks any process workflow with validation checkpoints, capping workflow clarity and progressive disclosure.

Suggestions

Move the full OpenAPI/Swagger spec and the complete README template into reference files (e.g., references/openapi-template.yaml, references/readme-template.md) and link to them from SKILL.md to improve progressive disclosure and conciseness.

Add a brief documentation workflow (draft -> review against principles -> verify examples run -> publish) with a validation checkpoint so multi-step documentation efforts have explicit sequencing.

Tighten or trim the inline OpenAPI YAML to the minimal illustrating fields, keeping only what teaches the pattern, to reduce token cost.

Dimension	Reasoning	Score
Conciseness	The body is mostly lean, example-driven templates with little concept explanation, but the full OpenAPI YAML and complete README template are lengthy inline blocks that could be tightened, matching the level-2 anchor of mostly efficient with some unnecessary bulk.	2 / 3
Actionability	Provides concrete, copy-paste-ready templates (README structure, JSDoc/TSDoc, OpenAPI spec, ADR) and explicit GOOD/BAD comment examples, matching the level-3 anchor of fully executable, specific examples.	3 / 3
Workflow Clarity	Content is organized by documentation type rather than as a sequenced process, and there are no validation checkpoints or feedback loops; this fits the level-2 anchor of structure present but checkpoints missing.	2 / 3
Progressive Disclosure	It is a single, fairly long file with well-labeled sections but no external references or split-out detail files; the full OpenAPI/README templates are inline content that could be separated, matching the level-2 anchor of structure present but content that should be separate is inline.	2 / 3
	Total	9 / 12 Passed

Description

100%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong, third-person description that concisely states concrete capabilities and pairs them with an explicit "Use for..." trigger clause, covering both what and when without padding.

Dimension	Reasoning	Score
Specificity	Names multiple concrete documentation artifacts — "API docs, README files, inline comments, and technical guides" — matching the level-3 anchor of listing several specific actions rather than a vague domain.	3 / 3
Completeness	Explicitly states what it does ("Writing effective code documentation") and when to use it ("Use for documenting codebases, APIs, or writing developer guides"), satisfying the level-3 requirement of both an explicit what and an explicit trigger clause.	3 / 3
Trigger Term Quality	Uses natural terms a user would say ("README files", "API docs", "inline comments", "codebases", "APIs", "developer guides"); coverage is broad enough to match the level-3 anchor rather than missing common variations.	3 / 3
Distinctiveness Conflict Risk	"code documentation" is a clear niche with distinct triggers (codebases/APIs/developer guides) unlikely to fire for unrelated skills; it is not generic enough to conflict broadly, matching the level-3 anchor.	3 / 3
	Total	12 / 12 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: MoizIbnYousaf/Ai-Agent-Skills
Path: skills/code-documentation/SKILL.md
Commit: 039ad59

Reviewed: about 6 hours 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.