CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

documentation-generation-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/documentation-generation-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-organized with sensible sections (use/not-use, context, instructions, safety, output format), but it operates entirely at the level of high-level directives: no tools, commands, or examples make the guidance executable, and its single detailed reference points to a file missing from the bundle. Validation is mentioned only in passing, leaving the workflow without real checkpoints.

Suggestions

Make the instructions executable by naming concrete tooling and snippets — e.g. specific documentation linters (vale, markdownlint), a sample CI docs-check job, and an example doc skeleton — instead of directives like "Add automation (linting, CI) and validate accuracy".

Fix or remove the `resources/implementation-playbook.md` reference: the file does not exist in the bundle, so either ship the playbook with the promised examples and templates or drop the pointer and inline the essential details.

Add explicit validation checkpoints to the workflow, such as verifying generated docs against actual code signatures, running the doc linter before finishing, and re-checking after fixes (validate -> fix -> retry).

Cut the redundancy between the intro paragraph, "Context", and "Requirements" sections, which restate the frontmatter description without adding guidance.

DimensionReasoningScore

Conciseness

The body is short and scannable, but the intro ("You are a documentation expert specializing in..."), the "Context" section, and the near-empty "Requirements" section ("Take the requirements, target, and scope from the user's request") largely restate the frontmatter description, and "using AI-powered analysis and industry best practices" is filler. Mostly efficient but could be tightened, matching anchor 3 rather than 2, since there is no concept-explaining padding, just redundancy.

3 / 5

Actionability

Instructions are high-level hints — "Extract information from code, configs, and comments", "Add automation (linting, CI) and validate accuracy" — with no named tools, commands, doc structures, or examples, and the only concrete pointer ("open `resources/implementation-playbook.md`") targets a file that does not exist in the bundle. This matches anchor 2 (minimal concrete guidance, missing specific steps) rather than 3, which requires at least some concrete or pseudocode-level detail.

2 / 5

Workflow Clarity

A rough ordered sequence is present (identify doc types and audiences, extract, generate, add automation and validate) and validation is mentioned ("validate accuracy"), but checkpoints are implicit with no commands or verification steps, matching anchor 3 (steps listed but validation gaps). It is above anchor 2 because the steps are reasonably defined rather than poorly specified, and below anchor 4, which requires most checkpoints to be explicit.

3 / 5

Progressive Disclosure

Section structure is clean and the reference to `resources/implementation-playbook.md` is clearly signaled in both "Instructions" and "Resources", but the bundle contains no such file, so the one-level-deep disclosure path dead-ends. This lands at anchor 3 (structure present, organization compromised) rather than 4, since a broken referenced path is more than a minor organization gap, and well above anchor 2, whose problem is inlined or buried content.

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 strong description: it names four concrete documentation deliverables, uses third person, and includes an explicit 'Use when' clause. Its main limitation is that the when-clause mostly restates the what rather than enumerating distinct user trigger phrases, and a few natural synonyms (README, docs) are absent.

DimensionReasoningScore

Specificity

"Generate API docs, architecture diagrams, user guides, and technical references from code" lists several concrete deliverables, though the action set is a single verb plus a soft goal ("keeping documentation comprehensive and maintainable"). This matches anchor 4 (several specific actions, minor gaps) rather than 5, which requires multiple distinct concrete actions, and is clearly above anchor 3's 1-2 actions.

4 / 5

Completeness

Both parts are explicit: the what ("Generate API docs, architecture diagrams, user guides, and technical references from code") and the when ("Use when creating or updating documentation for a codebase"). The when clause is explicit but largely restates the what instead of adding distinct concrete trigger phrases, matching anchor 4 rather than 5; it is comfortably above anchor 3, where when is only weakly implied.

4 / 5

Trigger Term Quality

Natural terms users would say are present: "API docs", "architecture diagrams", "user guides", "technical references", "documentation", "codebase". Coverage is good but misses common variations like "README", plain "docs", or "docstrings", so it fits anchor 4 rather than 5's comprehensive synonym/extension coverage, and is well above anchor 3's partial keyword set.

4 / 5

Distinctiveness Conflict Risk

"from code" and "for a codebase" pin a clear niche (code-derived documentation) with distinct artifact triggers, giving minor overlap risk only with closely related skills like generic writing or README generators. This is anchor 4 (mostly distinct) rather than 5, whose example shows minimal conflict risk with multiple distinct triggers, and above anchor 3's noticeable overlap potential.

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/documentation-generation-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.