doc-generator

Use this skill when the user wants to generate documentation, write docstrings, create API docs, build a README, or produce HTML/PDF documentation from code.

Quality

78%

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/doc-generator/SKILL.md

Quality

Content

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

A lean, mostly actionable reference catalog of documentation-generation recipes with good section structure. Its main weakness is the absence of any workflow sequencing or validation/verification steps for the file-writing recipes, and a couple of stubs and duplicated sections that could be tightened.

Suggestions

Add a brief validation step after each file-writing recipe (e.g. 'open the generated docs/index.html to confirm output' or 'run make html and check for warnings') to lift workflow_clarity above 3.

Implement generate_docstring instead of leaving a `pass` stub, or replace it with a concrete, executable AST/signature-based implementation so actionability reaches the top band.

Move the full Google-Style docstring template and Sphinx conf.py into reference files (e.g. references/docstring-template.md, references/sphinx-setup.md) and link from SKILL.md to reduce duplication and improve progressive_disclosure.

Dimension	Reasoning	Score
Conciseness	The body is overwhelmingly executable code with minimal explanatory prose and assumes Claude's competence, but the full Google-Style docstring template and the Quick Reference table partially duplicate content already shown in earlier sections, keeping it just below the lean 5 anchor.	4 / 5
Actionability	Most sections provide copy-paste-ready code or commands (pdoc CLI, AST extraction, Sphinx setup, OpenAPI export), but generate_docstring is left as a `pass` stub with only comment hints and 'analyze its signature and body' is vague, a minor gap.	4 / 5
Workflow Clarity	The skill is a multi-recipe catalog rather than a sequenced workflow; sections are self-contained and the Quick Reference aids navigation, but there is no sequencing or validation checkpoint, and file-writing recipes (pdoc --output-dir, sphinx make html) lack any verify step.	3 / 5
Progressive Disclosure	Content is well organized into clearly headed sections with a Quick Reference for navigation and no nested references, but at ~150 lines the Sphinx conf.py and full docstring template could be split into reference files, leaving minor organization gaps versus the 5 anchor.	4 / 5
	Total	15 / 20 Passed

Description

88%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 with an explicit use-trigger and five concrete, distinct capabilities that clearly answer both what and when. It could reach the top band by adding file-extension synonyms (.md, .rst, .pdf) and tightening distinctiveness against general writing skills.

Dimension	Reasoning	Score
Specificity	Lists five concrete actions — 'generate documentation, write docstrings, create API docs, build a README, or produce HTML/PDF documentation' — giving comprehensive coverage of the skill's capabilities.	5 / 5
Completeness	Explicitly answers both what (the five generation tasks) and when via a clear 'Use this skill when the user wants to...' trigger clause with concrete trigger phrases.	5 / 5
Trigger Term Quality	Natural phrases users would say ('write docstrings', 'create API docs', 'build a README', 'generate documentation', HTML/PDF) are well covered, but synonyms and file extensions (.md, .rst, .pdf) are absent, stopping short of the 5 anchor.	4 / 5
Distinctiveness Conflict Risk	The code-to-documentation niche with triggers like docstrings, API docs, and README is mostly distinct, though 'generate documentation' is broad enough to risk minor overlap with a general writing/markdown skill.	4 / 5
	Total	18 / 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: ProwlrBot/prowlr-marketplace
Path: skills/doc-generator/SKILL.md
Commit: 32f0050

Reviewed: 3 days 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.