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

51%

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 ./skills/code-documentation-doc-generate/SKILL.md

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 skill is reasonably well-structured and concise, but its instructions are abstract rather than executable, validation is only vaguely mentioned, and the lone external reference points to a file that is not bundled.

Suggestions

Replace abstract directives with concrete, executable guidance — e.g. specific doc-generation commands, template scaffolds, or a worked example of extracting an API reference from source.

Add an explicit validation checkpoint with a feedback loop (e.g. 'verify generated docs against source by running X; if drift found, regenerate') to raise workflow clarity.

Either create and ship resources/implementation-playbook.md or remove the dangling reference, since the file is currently absent from the bundle.

Dimension	Reasoning	Score
Conciseness	The body is mostly efficient with no over-explanation of basics, but it duplicates the description's opening line verbatim and the 'Context' section restates the skill's purpose ('living documentation that stays synchronized with code') without adding new guidance.	3 / 5
Actionability	Instructions are high-level directives ('Extract information from code, configs, and comments', 'Add automation (linting, CI) and validate accuracy') with no concrete commands, tools, templates, or worked examples, leaving the specific execution steps unspecified.	2 / 5
Workflow Clarity	A rough sequence exists (identify → extract → generate → automate/validate) but the only validation reference ('validate accuracy') is vague with no checkpoint or feedback loop, so checkpoints are implicit rather than explicit.	3 / 5
Progressive Disclosure	Sections are well organized and the body signals a one-level reference to 'resources/implementation-playbook.md', but the referenced file does not exist in any bundle directory (references/, scripts/, assets/ are empty), so navigation leads to a missing file.	3 / 5
	Total	11 / 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 is specific and reasonably distinctive but written in second person and lacks any explicit 'Use when' trigger, capping completeness at 3 and costing a specificity point.

Suggestions

Rewrite in third person (e.g. 'Generates documentation from code...') to recover the specificity penalty and match skill-description conventions.

Append an explicit trigger clause such as 'Use when generating API docs, architecture diagrams, or user guides from a codebase' to lift completeness above 3.

Add common synonyms users actually say ('docs', 'readme', 'code documentation') to broaden trigger-term coverage.

Dimension	Reasoning	Score
Specificity	Lists several concrete outputs ('Generate API docs, architecture diagrams, user guides, and technical references') which would anchor at 4, but the second-person 'You are a documentation expert' voice triggers the 1-point specificity penalty per the rubric.	3 / 5
Completeness	It clearly states the 'what' (generate documentation from code) but provides no 'Use when...' clause or equivalent explicit trigger guidance, which the rubric caps at 3.	3 / 5
Trigger Term Quality	Contains natural terms a user would likely say ('API docs', 'architecture diagrams', 'user guides', 'technical references', 'documentation') with good coverage, though common synonyms like 'docs', 'readme', or 'code comments' are missing.	4 / 5
Distinctiveness Conflict Risk	The 'documentation from code' framing plus enumerated output types carves a mostly distinct niche with only minor overlap risk against general documentation skills.	4 / 5
	Total	14 / 20 Passed

Validation

100%

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 — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: rmyndharis/antigravity-skills
Path: skills/code-documentation-doc-generate/SKILL.md
Commit: 3eff4af

Reviewed: 1 day 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.