code-documentation-doc-generate

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

Quality

37%

Does it follow best practices?

Impact

—

No eval scenarios have been run

Securityby

Passed

No known issues

Fix and improve this skill with Tessl

tessl review fix ./skills/code-documentation-doc-generate/SKILL.md

Quality

Content

35%

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

The skill is well-structured into clear sections and respects token budget reasonably, but its instructions are vague and non-executable, and its only detailed-example reference points to a missing file. It reads more as a scope statement than operational guidance.

Suggestions

Replace abstract instruction bullets with concrete, executable steps (specific tools, commands, or doc-generation patterns).

Add a validation/feedback checkpoint (e.g. lint generated docs, verify against source, fix and re-check) to the workflow.

Either create `resources/implementation-playbook.md` or remove the dead reference, so progressive disclosure points to real content.

Dimension	Reasoning	Score
Conciseness	The body is lean and does not lecture on concepts Claude already knows, but the opening paragraph repeats the frontmatter description verbatim and the Context/Limitations sections restate the purpose, so it could be tightened.	2 / 3
Actionability	Instructions are abstract and descriptive ('Extract information from code, configs, and comments', 'Add automation (linting, CI) and validate accuracy') with no concrete commands, code, or tool names, and the only examples live in a referenced file that does not exist.	1 / 3
Workflow Clarity	A discernible sequence exists (identify audiences, extract, generate, add automation/validate) but it is an unmarked bullet list with no explicit validation checkpoints or feedback loops for error recovery.	2 / 3
Progressive Disclosure	Sections are well-organized and the resource is clearly signaled one level deep, but the referenced `resources/implementation-playbook.md` does not exist in the bundle, so navigation is effectively a dead link.	2 / 3
	Total	7 / 12 Passed

Description

40%

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 names a clear domain and several concrete deliverables but is padded with buzzwords and written in second-person voice. It lacks any explicit 'Use when...' trigger guidance, leaving the activation conditions implicit.

Suggestions

Add an explicit trigger clause, e.g. 'Use when generating API, architecture, or user documentation from a codebase'.

Rewrite in third person and drop the buzzword padding ('AI-powered analysis', 'industry best practices', 'comprehensive, maintainable') in favor of concrete actions.

Include natural user phrasing variations (e.g. 'generate docs', 'document a codebase', 'API reference') to improve trigger coverage.

Dimension	Reasoning	Score
Specificity	It lists concrete deliverables ('Generate API docs, architecture diagrams, user guides, and technical references') but pads with buzzwords ('AI-powered analysis and industry best practices', 'comprehensive, maintainable') and uses second-person voice ('You are a documentation expert'), which the guidelines penalize by one level.	1 / 3
Completeness	It clearly states what the skill does (generates documentation from code), but the 'when' is entirely missing with no explicit trigger guidance, which caps completeness at 2 per the guidelines.	2 / 3
Trigger Term Quality	Relevant natural terms appear ('API docs', 'architecture diagrams', 'user guides', 'technical references'), but there is no 'Use when...' clause and common phrasing variations users might say are missing.	2 / 3
Distinctiveness Conflict Risk	'Documentation from code' is a recognizable niche, but the broad framing ('comprehensive, maintainable documentation') could still overlap with general writing or doc-formatting skills.	2 / 3
	Total	7 / 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: sickn33/antigravity-awesome-skills
Commit: 5e31f23

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