CtrlK
BlogDocsLog inGet started
Tessl Logo

code-documenter

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

75

Quality

92%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Quality

Content

85%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

This is a well-structured skill with strong actionability, clear workflow sequencing with validation checkpoints, and excellent progressive disclosure through a well-organized reference table. The main weakness is moderate verbosity — three full docstring examples inline plus some redundant constraint items and a keyword dump could be trimmed. Overall, it's a high-quality skill that effectively balances overview content with pointers to detailed references.

Suggestions

Trim to one or two inline docstring examples (e.g., Google-style + JSDoc) and move the NumPy example to the python-docstrings.md reference to reduce token usage.

Remove the 'Knowledge Reference' keyword list at the bottom — it adds no actionable value and wastes tokens.

DimensionReasoningScore

Conciseness

Generally efficient but includes some unnecessary content. The constraints section has items Claude already knows (e.g., 'Write inaccurate or untested documentation' is obvious). The Knowledge Reference line at the bottom is a keyword dump that adds little value. The examples are useful but three full docstring examples is borderline verbose when the reference files exist.

2 / 3

Actionability

Provides fully concrete, executable examples for Google-style, NumPy-style, and JSDoc docstrings. Validation commands are specific and copy-paste ready (e.g., `python -m doctest file.py`, `npx @redocly/cli lint openapi.yaml`). The workflow steps give clear, actionable instructions.

3 / 3

Workflow Clarity

The 6-step core workflow is clearly sequenced with an explicit validation step that includes specific commands per language/framework, a feedback loop ('If validation fails: fix examples and re-validate before proceeding'), and a clear gate before the final Report step. This is a well-structured workflow with proper checkpoints.

3 / 3

Progressive Disclosure

Excellent use of a reference table with 8 clearly signaled, one-level-deep references organized by topic with 'Load When' context. The SKILL.md serves as a concise overview with quick-reference examples while deferring detailed guidance to specific reference files. Navigation is intuitive and well-structured.

3 / 3

Total

11

/

12

Passed

Description

100%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

This is a strong skill description that clearly defines its scope around technical documentation with specific formats and use cases. It includes both a 'Use when' and 'Invoke for' clause providing comprehensive trigger coverage. The description is concise yet thorough, listing concrete actions and natural trigger terms that developers would use.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions: 'generates, formats, and validates technical documentation' with explicit subtypes including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides.

3 / 3

Completeness

Clearly answers both 'what' (generates, formats, validates technical documentation of various types) and 'when' with explicit 'Use when...' and 'Invoke for...' clauses listing specific trigger scenarios like adding docstrings, creating API docs, building doc sites, and writing tutorials.

3 / 3

Trigger Term Quality

Excellent coverage of natural terms users would say: 'docstrings', 'OpenAPI', 'Swagger', 'JSDoc', 'API documentation', 'documentation sites', 'tutorials', 'user guides', 'getting started guides', 'doc portals'. These are terms developers naturally use when requesting documentation help.

3 / 3

Distinctiveness Conflict Risk

Clearly carved out niche around technical documentation with highly specific triggers like OpenAPI/Swagger, JSDoc, doc portals, and docstrings. Unlikely to conflict with general coding skills or content writing skills due to the precise technical documentation focus.

3 / 3

Total

12

/

12

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.

Validation11 / 11 Passed

Validation for skill structure

No warnings or errors.

Repository
Jeffallan/claude-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.