database-documentation-gen
Process use when you need to work with database documentation. This skill provides automated documentation generation with comprehensive guidance and automation. Trigger with phrases like "generate docs", "document schema", or "create database documentation".
36
33%
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 ./plugins/database/database-documentation-gen/skills/database-documentation-gen/SKILL.mdQuality
Discovery
40%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 suffers from vague, circular language ('comprehensive guidance and automation' adds no information) and fails to specify concrete actions the skill performs. While it does include some trigger phrases and narrows the domain to database documentation, the lack of specific capabilities makes it hard to distinguish from other documentation skills and gives Claude little basis for confident selection.
Suggestions
Replace the vague 'automated documentation generation with comprehensive guidance and automation' with specific actions like 'Generates table definitions, documents column types and constraints, creates relationship diagrams, and produces schema change logs'.
Expand trigger terms to include common variations like 'SQL docs', 'schema documentation', 'ERD', 'table definitions', 'database dictionary', '.sql files'.
Remove the awkward opening 'Process use when you need to' and rewrite in proper third person voice, e.g., 'Generates documentation for database schemas and structures.'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | The description says 'automated documentation generation with comprehensive guidance and automation' which is vague and circular. It does not list concrete actions like 'generate ER diagrams', 'document table relationships', or 'extract column definitions'. The phrase 'comprehensive guidance and automation' is meaningless fluff. | 1 / 3 |
Completeness | It attempts to answer both 'what' (documentation generation) and 'when' (trigger phrases provided), but the 'what' is extremely vague and the 'when' guidance, while present with trigger phrases, is undermined by the weak capability description. The 'Use when' equivalent exists but the overall quality is marginal. | 2 / 3 |
Trigger Term Quality | It includes some useful trigger phrases like 'generate docs', 'document schema', and 'create database documentation', which are terms users might naturally say. However, it misses common variations like 'ERD', 'table definitions', 'schema docs', 'SQL documentation', or specific database types. | 2 / 3 |
Distinctiveness Conflict Risk | The mention of 'database documentation' provides some specificity that distinguishes it from general documentation skills, but 'generate docs' is generic enough to conflict with other documentation-related skills. The database focus helps but isn't strongly reinforced with specific capabilities. | 2 / 3 |
Total | 7 / 12 Passed |
Implementation
27%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The skill provides genuinely useful SQL introspection queries for database documentation generation, but suffers from poor organization and verbosity. The inline SQL queries make the document very long when they should be in separate reference files, the documentation generation steps lack concrete output templates, and there are no validation checkpoints in the workflow despite this being a multi-step data extraction process.
Suggestions
Move the SQL queries into separate reference files (e.g., `queries-postgresql.md` and `queries-mysql.md`) and keep SKILL.md as a concise overview with workflow steps pointing to those files.
Add a concrete Markdown output template showing exactly what the generated documentation should look like, rather than describing it abstractly in step 8.
Add validation checkpoints after database connection and after each extraction step (e.g., 'Verify table count matches expected schema size before proceeding').
Replace the narrative examples with concrete input/output pairs showing a small sample schema and the exact Markdown documentation that would be generated.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is extremely verbose with long inline SQL queries that could be in a separate reference file. The examples section describes scenarios narratively rather than showing concrete output. The overview explains what database documentation is, which Claude already knows. The entire file is well over 100 lines when much of this could be condensed. | 1 / 3 |
Actionability | The SQL queries are concrete and executable, which is good. However, the actual documentation generation steps (8, 9, 10) are vague instructions like 'Generate the data dictionary in Markdown format' without showing the actual Markdown template or output format. The examples section describes scenarios narratively rather than showing concrete input/output pairs. | 2 / 3 |
Workflow Clarity | The 10 steps are sequenced logically (extract tables → columns → constraints → relationships → generate docs), but there are no validation checkpoints. There's no step to verify database connectivity, validate query results, or check that the generated documentation is complete. The error handling table is helpful but separate from the workflow rather than integrated as checkpoints. | 2 / 3 |
Progressive Disclosure | This is a monolithic wall of text with no bundle files to offload content to. The lengthy SQL queries for PostgreSQL and MySQL should be in separate reference files. The error handling table, examples, and resources could all be in supporting files. Everything is crammed into a single document with no references to external files. | 1 / 3 |
Total | 6 / 12 Passed |
Validation
81%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 9 / 11 Passed
Validation for skill structure
| Criteria | Description | Result |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 9 / 11 Passed | |
- Commit
4801da6
- 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.