CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

code-documentation-doc-generate

Generate API docs, architecture diagrams, user guides, and technical references from code, keeping documentation comprehensive and maintainable. Use when creating or updating documentation for a codebase.

Quality

67%

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

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 well-sectioned and brief, but every instruction is an abstract directive with no concrete tooling, commands, or examples, and the single referenced resource file is missing from the bundle. Validation is mentioned ("validate accuracy") but never operationalized, leaving the workflow without a real checkpoint.

Suggestions

Make the instructions executable: name concrete tooling and show snippets — e.g., a docstring format to extract, a markdown-lint or docs CI check command, and a skeleton for the documentation plan deliverable.

Operationalize "validate accuracy" as an explicit checkpoint (e.g., cross-check generated API signatures against source, fix discrepancies, re-run) so the workflow has a real feedback loop.

Ship `resources/implementation-playbook.md` in the bundle or remove the two references to it — as written, the skill's only detail resource is a broken pointer.

Delete the redundant Context and Requirements sections and the role-play intro, which restate the description and spend tokens without adding guidance.

DimensionReasoningScore

Conciseness

The body is short and scannable, but entire sections restate the frontmatter description without adding actionable content: the role-play intro ("You are a documentation expert specializing in..."), the Context section ("The user needs automated documentation generation that..."), and the near-empty Requirements section ("Take the requirements, target, and scope from the user's request"). This is more than the minor trimmable instances of a 4.

3 / 5

Actionability

The instructions are high-level hints missing the specific steps to execute — "Extract information from code, configs, and comments", "Add automation (linting, CI) and validate accuracy" — with no named tools, commands, doc templates, or worked examples; the only concrete pointer is the bare file reference `resources/implementation-playbook.md`.

2 / 5

Workflow Clarity

The instruction bullets form a recognizable sequence (identify doc types → extract info → generate docs → add automation and validate), comparable to the anchor-3 example, but "validate accuracy" is a vague action with no checkpoint, verification method, or failure-handling loop, so checkpoints are only implicit.

3 / 5

Progressive Disclosure

Sections are well-organized and the reference to `resources/implementation-playbook.md` is clearly signaled both inline and in a dedicated Resources section, but that file does not exist in the bundle (no resources/ directory at all), so the skill's only progressive-disclosure pointer is dangling and navigation breaks at the first hop.

3 / 5

Total

11

/

20

Passed

Description

75%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.

A solid description that names four concrete documentation artifacts and includes an explicit "Use when" trigger clause in third person. It sits just below the top anchors because trigger coverage lacks synonyms and mention-based phrasings, and the trailing clause "keeping documentation comprehensive and maintainable" is filler rather than a concrete capability.

Suggestions

Broaden the trigger clause with synonyms and mention-based phrasing, e.g. "Use when the user asks to document code, generate API references, write or update a README, or standardize docs across a repo".

Replace the vague clause "keeping documentation comprehensive and maintainable" with a concrete action (e.g., "keeping docs in sync with code via CI checks") or drop it.

Add natural keyword variants users say ("document my code", "docstrings", "docs pipeline") to improve trigger matching.

DimensionReasoningScore

Specificity

Lists several concrete artifacts — "Generate API docs, architecture diagrams, user guides, and technical references from code" — but the only real verb is "Generate" and "keeping documentation comprehensive and maintainable" is vague filler, so it shows minor coverage gaps rather than the comprehensive multi-action coverage of the top anchor.

4 / 5

Completeness

Explicitly answers both: what = "Generate API docs, architecture diagrams, user guides, and technical references from code" and when = "Use when creating or updating documentation for a codebase". The single "when" formulation lacks the multiple concrete trigger phrasings (e.g., mention-based triggers like "when the user mentions READMEs or API references") that distinguish a 5.

4 / 5

Trigger Term Quality

Contains natural terms users would actually say — "API docs", "architecture diagrams", "user guides", "technical references", "documentation", "codebase" — but misses common variations and synonyms such as "document my code", "README", or "docstrings", falling short of the synonym-and-extension coverage of a 5.

4 / 5

Distinctiveness Conflict Risk

Documentation generation from code is a mostly distinct niche with a clear trigger ("creating or updating documentation for a codebase"), but the broad term "documentation" leaves minor overlap risk with closely related technical-writing or README-oriented skills.

4 / 5

Total

16

/

20

Passed

Validation

100%

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

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.