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.
32
27%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./skills/code-documentation-doc-generate/SKILL.mdQuality
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.
The description identifies a clear domain (code documentation) and lists several output types, but relies on buzzwords like 'AI-powered analysis' and 'industry best practices' instead of concrete actions. It critically lacks a 'Use when...' clause, making it difficult for Claude to know when to select this skill. The use of second-person framing ('You are') violates the third-person voice requirement.
Suggestions
Add an explicit 'Use when...' clause with trigger terms like 'generate docs', 'document this code', 'API reference', 'README', 'docstrings', 'explain this codebase'.
Replace vague phrases like 'AI-powered analysis and industry best practices' with specific actions such as 'parses function signatures, extracts docstrings, maps module dependencies'.
Rewrite in third person voice (e.g., 'Generates API docs, architecture diagrams...') instead of the current second-person 'You are' framing.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Names the domain (documentation from code) and lists some outputs (API docs, architecture diagrams, user guides, technical references), but uses vague qualifiers like 'AI-powered analysis' and 'industry best practices' which are buzzwords rather than concrete actions. | 2 / 3 |
Completeness | Describes what it does (generate various documentation types) but completely lacks a 'Use when...' clause or any explicit trigger guidance for when Claude should select this skill. Per rubric guidelines, missing 'Use when' caps completeness at 2, and the 'what' is also somewhat vague, warranting a 1. | 1 / 3 |
Trigger Term Quality | Includes some relevant keywords like 'API docs', 'architecture diagrams', 'user guides', 'technical references', and 'documentation', but misses common user variations like 'README', 'docstrings', 'JSDoc', 'swagger', or 'code comments'. Also lacks natural phrasing users would say. | 2 / 3 |
Distinctiveness Conflict Risk | The documentation focus provides some specificity, but 'documentation from code' is broad enough to overlap with code commenting skills, README generators, or general writing skills. The mention of architecture diagrams could also conflict with diagramming skills. | 2 / 3 |
Total | 7 / 12 Passed |
Implementation
22%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill reads more like a high-level project brief than actionable guidance for Claude. It lacks concrete code examples, specific tool commands, executable workflows, and validation steps. The instructions are abstract descriptions of what to do rather than how to do it, making it difficult for Claude to produce consistent, high-quality documentation output.
Suggestions
Add concrete, executable examples for at least one documentation type (e.g., generating API docs with a specific tool like pydoc, Sphinx, or TypeDoc, with actual commands and configuration snippets).
Replace abstract instructions like 'Extract information from code' with specific steps: what tools to use, what patterns to look for, what output format to produce, with copy-paste ready code or commands.
Add validation checkpoints to the workflow, such as 'Run doc linter to verify formatting' with a specific command, and include a feedback loop for fixing issues before finalizing output.
Provide the referenced `resources/implementation-playbook.md` bundle file, or inline the most critical templates and examples so the skill has standalone value.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill includes some unnecessary sections like 'Context' that restates the description, and 'Use this skill when' / 'Do not use this skill when' sections that are somewhat obvious. However, it's not excessively verbose and stays relatively brief overall. | 2 / 3 |
Actionability | The instructions are vague and abstract — 'Identify required doc types,' 'Extract information from code,' 'Generate docs with consistent terminology' are descriptions of goals, not concrete executable steps. There are no code examples, specific commands, tool configurations, or copy-paste ready snippets. | 1 / 3 |
Workflow Clarity | The instructions list high-level steps without clear sequencing, no validation checkpoints, and no feedback loops. For a documentation generation pipeline that could involve linting, CI integration, and multiple output types, the lack of concrete workflow steps and verification is a significant gap. | 1 / 3 |
Progressive Disclosure | The skill references `resources/implementation-playbook.md` for detailed examples and templates, which is a good one-level-deep reference. However, no bundle files were provided, so we can't verify the reference exists, and the main content itself is too thin to serve as a useful overview — it defers substance without providing enough standalone value. | 2 / 3 |
Total | 6 / 12 Passed |
Validation
90%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 10 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 10 / 11 Passed | |
- Repository
- sickn33/antigravity-awesome-skills
- Commit
79d9c42
- 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.