Generate full project documentation packages (index, README/overview, development setup, database ERDs, architecture UML, REST/web UI specs, logging, emails, scheduled jobs, ops runbooks, Jira/Git guides, PRDs). Use when asked to inspect a codebase and produce markdown docs under docs/ plus supporting README.
63
73%
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/documentation-project/SKILL.mdQuality
Discovery
85%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 description that excels in specificity and completeness, clearly listing numerous concrete deliverables and including an explicit 'Use when' clause. Its main weakness is in trigger term quality—while it covers the output types well, it could better anticipate the natural language users would employ when requesting documentation generation. The description is distinctive enough to avoid conflicts with other skills.
Suggestions
Expand trigger terms to include common user phrasings like 'document my project', 'generate docs', 'write documentation for this codebase', or 'create technical documentation'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description lists many specific concrete deliverables: index, README/overview, development setup, database ERDs, architecture UML, REST/web UI specs, logging, emails, scheduled jobs, ops runbooks, Jira/Git guides, and PRDs. This is highly specific about what the skill produces. | 3 / 3 |
Completeness | It clearly answers both 'what' (generate full project documentation packages with a comprehensive list of document types) and 'when' (Use when asked to inspect a codebase and produce markdown docs under docs/ plus supporting README). The explicit 'Use when' clause is present. | 3 / 3 |
Trigger Term Quality | It includes some natural terms like 'documentation', 'README', 'codebase', 'markdown docs', and 'docs/' but misses common user phrasings like 'document my project', 'generate docs', 'write documentation', or 'code documentation'. The trigger terms are more focused on outputs than on how users would phrase requests. | 2 / 3 |
Distinctiveness Conflict Risk | This skill has a very clear niche: generating comprehensive project documentation packages from codebase inspection. The combination of specific deliverables (ERDs, UML, runbooks, PRDs) and the output location (docs/ directory) makes it highly distinctive and unlikely to conflict with other skills. | 3 / 3 |
Total | 11 / 12 Passed |
Implementation
62%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill provides a comprehensive documentation generation framework with a clear workflow and validation checklist, which are its strongest aspects. However, it leans toward descriptive rather than actionable guidance—lacking concrete output examples, sample markdown snippets, or executable commands—and is more verbose than necessary given that much of the per-document detail could be offloaded to the referenced template file. The missing bundle files (research_checklist.md, doc_templates.md) weaken the progressive disclosure structure.
Suggestions
Add at least one concrete example of a completed doc section (e.g., a sample database.md with Mermaid ERD) so Claude has a clear output target to match.
Move the detailed per-document specifications into references/doc_templates.md and keep SKILL.md focused on the workflow, key principles, and validation checklist to improve conciseness.
Include the referenced bundle files (references/research_checklist.md and references/doc_templates.md) so the progressive disclosure structure actually functions.
Add specific commands or tool invocations where applicable (e.g., a markdown lint command, a Mermaid validation step) to increase actionability.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is reasonably well-structured but includes some verbose descriptions that Claude could infer (e.g., explaining what each doc section should contain in paragraph form when bullet points or a table would suffice). The per-document sections repeat patterns that could be condensed into a template reference. | 2 / 3 |
Actionability | The skill provides clear structural guidance and lists what each document should contain, but lacks executable code examples, concrete command snippets, or sample markdown output. Most instructions are descriptive ('Document each cron or background job') rather than showing exactly what the output should look like. It references templates in references/doc_templates.md but those files are not provided. | 2 / 3 |
Workflow Clarity | The 5-step workflow is clearly sequenced with a logical progression from audit → capture facts → generate → cross-link/verify → final pass. The validation checklist at the end serves as an explicit verification checkpoint, and the cross-linking step includes specific checks (Mermaid compilation, TODO labeling for unknowns). This constitutes a clear feedback loop for a documentation generation task. | 3 / 3 |
Progressive Disclosure | The skill references two external files (references/research_checklist.md and references/doc_templates.md) which is good progressive disclosure design, but neither file is provided in the bundle, making it impossible to verify the references work. The main SKILL.md itself is quite long (~100 lines of detailed per-document specifications) that could arguably live in the templates reference file, keeping the SKILL.md leaner. | 2 / 3 |
Total | 9 / 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.
c0b2e4b
Table of Contents
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.