docstring
Document a Python module and its classes using Google style
68
Does it follow best practices?
If you maintain this skill, you can automatically optimize it using the tessl CLI to improve its score:
npx tessl skill review --optimize ./path/to/skillValidation for skill structure
Discovery
32%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 description is too brief and lacks the explicit trigger guidance needed for Claude to reliably select it from a large skill library. While it identifies a specific domain (Python + Google style), it fails to enumerate concrete actions or provide 'Use when...' conditions that would help distinguish it from other documentation-related skills.
Suggestions
Add a 'Use when...' clause with trigger terms like 'docstrings', 'Google style documentation', 'document my Python code', or 'add documentation to classes'.
Expand the action list to include specific capabilities such as 'generate docstrings, format parameter descriptions, document return types, create module-level documentation'.
Include file type triggers like '.py files' and common user phrases like 'add docs', 'write documentation', or 'document this function'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (Python module documentation) and a specific style (Google style), but only mentions one action ('Document') without listing concrete sub-actions like generating docstrings, formatting parameters, or creating module-level documentation. | 2 / 3 |
Completeness | Describes what it does (document Python modules) but completely lacks a 'Use when...' clause or any explicit trigger guidance for when Claude should select this skill. Per rubric guidelines, missing explicit trigger guidance caps this at 2, but the 'what' is also minimal, warranting a 1. | 1 / 3 |
Trigger Term Quality | Includes relevant keywords like 'Python', 'module', 'classes', and 'Google style' that users might say, but misses common variations like 'docstrings', 'documentation', 'pydoc', '.py files', or 'API docs'. | 2 / 3 |
Distinctiveness Conflict Risk | The 'Google style' qualifier adds some distinctiveness from generic documentation skills, but could still overlap with other Python documentation skills or general code documentation tools without clearer boundaries. | 2 / 3 |
Total | 7 / 12 Passed |
Implementation
77%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, highly actionable skill with clear workflows and comprehensive examples. Its main weakness is moderate verbosity - the extensive inline examples and style guidelines, while useful, could be more concise or split into reference files. The checklist at the end provides good validation.
Suggestions
Consider moving the detailed format examples (module, class, constructor, method, dataclass, enum) to a separate EXAMPLES.md reference file to reduce the main skill's token footprint
Consolidate the 'Writing Style Guidelines' section - the good/bad examples are helpful but the bullet points explain concepts Claude already knows
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is reasonably efficient but includes some redundancy - the examples often repeat patterns that could be consolidated, and some sections like 'Writing Style Guidelines' explain concepts Claude already understands well. | 2 / 3 |
Actionability | Provides fully concrete, copy-paste ready examples for every documentation format (module, class, constructor, method, dataclass, enum). Each section has clear before/after patterns with executable Python code. | 3 / 3 |
Workflow Clarity | Clear 5-step sequence with explicit decision points (module path vs class name), disambiguation handling (multiple matches), and a comprehensive checklist for validation at the end. | 3 / 3 |
Progressive Disclosure | Content is well-organized with clear sections, but everything is inline in one file. For a skill this length (~180 lines), some content like the full examples or style guidelines could be split into reference files. | 2 / 3 |
Total | 10 / 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.
Validation — 11 / 11 Passed
Validation for skill structure
No warnings or errors.
- 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.