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".
62
54%
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 covers the basics of what the skill does and when to use it, including explicit trigger phrases. However, it lacks specificity in the concrete actions it performs (e.g., what kind of database documentation—schema diagrams, column descriptions, migration docs?) and uses somewhat fluffy language like 'comprehensive guidance and automation.' The trigger terms could be broader to capture more natural user phrasings.
Suggestions
List specific concrete actions the skill performs, e.g., 'Generates schema documentation, documents table relationships, creates column-level descriptions, and produces ERD summaries.'
Add more natural trigger term variations such as 'DB docs', 'schema documentation', 'table docs', 'database schema', '.sql documentation' to improve matching coverage.
Remove vague filler like 'comprehensive guidance and automation' and replace with specific capabilities to improve specificity and distinctiveness.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | It names the domain (database documentation) and mentions 'automated documentation generation,' but does not list multiple specific concrete actions like generating ERD diagrams, documenting table relationships, or describing column-level annotations. | 2 / 3 |
Completeness | It explicitly answers both 'what does this do' (automated documentation generation for databases) and 'when should Claude use it' with explicit trigger phrases ('generate docs', 'document schema', 'create database documentation'). | 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 'schema docs', 'table documentation', 'DB docs', or 'ERD'. | 2 / 3 |
Distinctiveness Conflict Risk | The focus on 'database documentation' is somewhat specific, but the phrase 'generate docs' is generic enough to potentially conflict with other documentation-related skills (e.g., API docs, code docs). | 2 / 3 |
Total | 9 / 12 Passed |
Implementation
42%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The skill provides highly actionable, executable SQL queries for database introspection across PostgreSQL and MySQL, which is its primary strength. However, it is excessively verbose for a SKILL.md file — the inline SQL queries, narrative examples, and comprehensive error table create a monolithic document that would consume significant context window. The workflow lacks validation checkpoints between extraction and generation steps.
Suggestions
Move the detailed SQL queries into a companion reference file (e.g., QUERIES.md) and keep only a brief workflow overview in SKILL.md with links to the queries
Add validation checkpoints: verify database connectivity before starting, validate that table inventory is non-empty before proceeding to column extraction, and verify generated Markdown renders correctly
Replace the narrative examples with a concrete input/output example showing a small schema (2-3 tables) and the exact Markdown output produced
Split PostgreSQL and MySQL guidance into separate referenced files to reduce inline content and avoid the reader parsing both when only one is needed
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is extremely verbose at ~150+ lines. It includes lengthy SQL queries inline that could be referenced or templated, explains concepts Claude already knows (what a data dictionary is, what foreign keys are), and the examples section describes scenarios narratively rather than showing concrete input/output. The error handling table, while useful, adds significant bulk. | 1 / 3 |
Actionability | The skill provides fully executable SQL queries for each introspection step, covering PostgreSQL and MySQL variants. The queries are copy-paste ready with specific system catalog tables, joins, and column selections. The output format expectations are concrete. | 3 / 3 |
Workflow Clarity | The 10 steps are clearly sequenced from extraction through generation, but there are no validation checkpoints. There's no step to verify database connectivity, validate query results before proceeding, or check that generated documentation is complete/well-formed. For a multi-step process generating documentation from live databases, validation gaps are notable. | 2 / 3 |
Progressive Disclosure | This is a monolithic wall of content with everything inline — long SQL queries, error handling tables, examples, and resources all in one file. The PostgreSQL vs MySQL variants could be split into separate reference files, and the SQL queries could be in a companion file. No references to external detail files are used despite the content length warranting it. | 1 / 3 |
Total | 7 / 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
70e9fa4
- 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.