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".
56
47%
Does it follow best practices?
Impact
Pending
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
67%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 its domain (database documentation) and provides explicit trigger phrases, which is good for completeness. However, it lacks concrete action specificity—relying on vague terms like 'comprehensive guidance and automation' instead of listing specific capabilities. The opening 'Process use when' is awkward phrasing, and the description could be more distinctive by detailing exactly what database documentation artifacts it produces.
Suggestions
Replace vague phrases like 'comprehensive guidance and automation' with specific concrete actions such as 'generate table schema docs, document column types and relationships, create ER diagrams, describe indexes and constraints'.
Add more natural trigger term variations users might say, such as 'DB docs', 'table documentation', 'schema reference', 'data dictionary', or 'ERD'.
Fix the awkward opening 'Process use when' to use proper third-person voice, e.g., 'Generates database documentation including...'
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | It names the domain (database documentation) and mentions 'automated documentation generation,' but the actions are vague—'comprehensive guidance and automation' is fluff without listing concrete actions like 'generate ER diagrams, document table schemas, describe relationships.' | 2 / 3 |
Completeness | It answers both 'what' (automated documentation generation for databases) and 'when' (explicit trigger phrases like 'generate docs', 'document schema', 'create database documentation'), satisfying the completeness requirement with explicit triggers. | 3 / 3 |
Trigger Term Quality | It includes some useful trigger phrases like 'generate docs', 'document schema', and 'create database documentation', but misses common variations users might say such as 'DB docs', 'table documentation', 'schema description', or 'ERD'. | 2 / 3 |
Distinctiveness Conflict Risk | The focus on 'database documentation' is somewhat specific, but 'documentation generation' could overlap with general documentation skills or code documentation skills. The database qualifier helps but isn't strongly reinforced throughout. | 2 / 3 |
Total | 9 / 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.
This skill provides useful SQL introspection queries for database documentation but suffers from excessive verbosity and poor content organization. The inline SQL queries make the document very long when they could be referenced from a separate file, and several steps (especially the generation/formatting steps) lack concrete implementation. Adding validation checkpoints and splitting content into a concise overview with referenced detail files would significantly improve quality.
Suggestions
Move the SQL queries into a referenced file (e.g., QUERIES.md or queries.sql) and keep only a concise workflow overview in SKILL.md to dramatically improve conciseness and progressive disclosure.
Add explicit validation checkpoints: verify database connectivity before querying, confirm schema access permissions, and validate generated output completeness (e.g., check that all tables have documentation entries).
Replace the narrative Examples section with a concrete output template showing the exact Markdown format expected for a single table, making step 8 actionable rather than vague.
Remove explanations of concepts Claude already knows (e.g., what information_schema is, what foreign keys are, what junction tables represent) to reduce token usage.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is excessively verbose with long inline SQL queries that could be in a referenced file, redundant explanations, and sections like Examples that describe scenarios narratively without adding actionable value. The error handling table, while useful, adds significant length. Much of this content (what information_schema is, how foreign keys work) is knowledge Claude already has. | 1 / 3 |
Actionability | The SQL queries are concrete and mostly executable, which is good. However, the overall workflow lacks a complete executable script or template—it's a series of individual queries without glue code showing how to assemble them into actual Markdown output. Step 8 ('Generate the data dictionary in Markdown format') is vague and not executable. | 2 / 3 |
Workflow Clarity | The 10 steps are sequenced logically, but there are no validation checkpoints. There's no step to verify database connectivity, confirm permissions before proceeding, or validate the generated output. For a workflow that queries live databases, missing connection verification and output validation is a notable gap. | 2 / 3 |
Progressive Disclosure | The entire skill is a monolithic wall of text with no references to supporting files. The long SQL queries, error handling table, examples, and resources are all inline. The SQL queries alone could be in a referenced file, and the examples section adds bulk without actionable structure. No bundle files exist to offload content to. | 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
3a2d27d
- 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.