CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

50

Quality

55%

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

48%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 with an explicit validation step in its workflow, but the actual guidance stays at the directive level with no concrete commands or examples, and its only external reference points to a file that is missing from the bundle. Administrative/time-sensitive frontmatter-adjacent content and a verbatim description repeat also cost token efficiency.

Suggestions

Add at least one concrete, executable example to the Instructions (e.g., a sample doc-generation pipeline command or a short before/after doc snippet) so the guidance is not purely high-level.

Ship the referenced resources/implementation-playbook.md in the bundle or fix the path to an existing file — the currently dangling reference breaks progressive disclosure despite being clearly signaled.

Trim the verbatim description repeat in the intro and move the time-sensitive administrative details ("Modified in AAS on 2026-09-05") into a clearly labeled maintenance/deprecated section or drop them from the body.

DimensionReasoningScore

Conciseness

The body is mostly lean bullet-style guidance, but the intro paragraph repeats the frontmatter description verbatim, the "Compatibility and maintenance" section carries administrative detail ("Modified in AAS on 2026-09-05") that is time-sensitive and not in a deprecated/old-patterns section, and "industry best practices" reappears as filler. It is not 2 because it never explains concepts Claude already knows.

3 / 5

Actionability

Instructions like "Identify required doc types and target audiences" and "Extract information from code, configs, and comments" are high-level directives with no concrete commands, tool invocations, or examples anywhere in the body; the worked example is narrative ("inspect its implementation and test fixtures") rather than executable. It is not 3 because no executable code or specific command is given, and not 1 because the bullet list does provide real directional structure.

2 / 5

Workflow Clarity

The instruction bullets form a discernible identify → extract → generate → validate sequence with an explicit validation checkpoint ("Validate generated examples against actual routes and the current build") reinforced by the worked example ("run the existing schema/doc build... Record which commands actually ran"). It is not 5 because there is no error-recovery or feedback loop if validation fails, and not 3 because validation is explicit rather than implicit; doc generation is not a destructive or batch operation, so the cap-3 rule does not apply.

4 / 5

Progressive Disclosure

Sections are well organized and the single reference is clearly signaled twice ("open resources/implementation-playbook.md" and the Resources section), one level deep. However, that referenced file does not exist anywhere in the bundle (no resources/, references/, scripts/, or assets/ directories are present), so the pointer is dangling and navigation breaks — more than the "minor organization gaps" of anchor 4, but better structured than anchor 2.

3 / 5

Total

12

/

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 names a distinct niche and several concrete outputs, but it opens in second person, ends on buzzword filler, and entirely lacks a "Use when..." trigger clause, which caps completeness at the midpoint. Adding explicit trigger guidance and third-person voice would lift it substantially.

Suggestions

Append an explicit trigger clause, e.g. "Use when the user asks to generate API docs, architecture diagrams, or user guides from a codebase, or to standardize documentation across a repository."

Rewrite in third person ("Generates API docs, architecture diagrams, user guides, and technical references from code...") to remove the second-person persona opening and satisfy the voice guideline.

Replace "using AI-powered analysis and industry best practices" with concrete actions (e.g., "extracts information from code, configs, and comments") and add natural synonyms such as README or docstrings to improve trigger coverage.

DimensionReasoningScore

Specificity

"Generate API docs, architecture diagrams, user guides, and technical references" lists several concrete outputs, matching the anchor 4 example, but the second-person opening "You are a documentation expert" incurs the rubric's −1 voice penalty, and "AI-powered analysis and industry best practices" is buzzword padding. It is above anchor 2 because it goes well beyond merely naming the documentation domain.

3 / 5

Completeness

The description clearly answers "what" (generate documentation from code) but contains no "Use when..." clause or equivalent trigger guidance, which the judging guidelines cap at 3. It is not 4 because the "when" is absent rather than merely implicit or underspecific.

3 / 5

Trigger Term Quality

Terms like "API docs", "architecture diagrams", "user guides", "technical references", and "documentation" are phrases users would naturally say, giving good keyword coverage. It is not 5 because common synonyms and extensions (README, docstrings, .md, "write docs") are missing.

4 / 5

Distinctiveness Conflict Risk

"documentation from code" plus the specific artifact types define a mostly distinct niche with only minor overlap risk against general writing or code-explanation skills. It is not 5 because phrases like "API docs" and "user guides" could still collide with generic writing skills.

4 / 5

Total

14

/

20

Passed

Validation

93%

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

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository
sickn33/agentic-awesome-skills
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.