generating-database-documentation
tessl i github:jeremylongshore/claude-code-plugins-plus-skills --skill generating-database-documentationThis skill enables Claude to automatically generate comprehensive documentation for existing database schemas using the database-documentation-gen plugin. It is triggered when the user requests database documentation, ERD diagrams, or a data dictionary. The plugin supports multiple database engines and generates documentation that includes ERD diagrams, table relationships, column descriptions, indexes, triggers, stored procedures, and interactive HTML documentation. Use this skill when you need to document existing database schemas for team onboarding, architectural reviews, or data governance purposes. The trigger terms include "database documentation", "ERD diagram", "data dictionary", and `/db-docs`.
Validation
75%| Criteria | Description | Result |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
metadata_version | 'metadata' field is not a dictionary | Warning |
license_field | 'license' field is missing | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 12 / 16 Passed | |
Implementation
20%This skill content reads more like marketing copy than actionable documentation. It describes what the plugin does conceptually but fails to provide any concrete commands, configuration examples, or executable code that Claude could actually use. The verbose explanations of obvious concepts waste tokens without adding value.
Suggestions
Add concrete plugin invocation syntax showing exact commands or API calls (e.g., `/db-docs --connection postgres://... --output ./docs/`)
Replace abstract examples with actual input/output showing real command usage and expected documentation structure
Remove explanatory filler text like 'This skill empowers Claude' and 'saving time and ensuring consistency' - focus on what to do, not why it's useful
Add validation steps for common failure modes (connection errors, permission issues, unsupported database engines)
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is verbose and explains concepts Claude already knows (what ERD diagrams are, what documentation includes). Phrases like 'empowers Claude' and 'saving time and ensuring consistency' are filler that don't add actionable value. | 1 / 3 |
Actionability | No concrete code, commands, or executable guidance provided. The examples describe what 'the skill will' do abstractly rather than showing actual plugin invocation syntax, configuration, or command-line usage. | 1 / 3 |
Workflow Clarity | Steps are listed in a logical sequence (activation → analysis → generation), but there are no validation checkpoints, error handling, or feedback loops for when database connections fail or schema analysis encounters issues. | 2 / 3 |
Progressive Disclosure | Content is organized into sections but everything is inline in one file. The 'Integration' section hints at other capabilities that could be linked to separate docs. No references to detailed configuration guides or API documentation. | 2 / 3 |
Total | 6 / 12 Passed |
Activation
100%This is a strong skill description that clearly articulates specific capabilities (ERD diagrams, table relationships, indexes, triggers, stored procedures), provides explicit trigger guidance with natural keywords, and defines clear use cases. The description is comprehensive yet focused, making it easy for Claude to distinguish when to select this skill over others.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'generate comprehensive documentation', 'ERD diagrams', 'table relationships', 'column descriptions', 'indexes', 'triggers', 'stored procedures', and 'interactive HTML documentation'. | 3 / 3 |
Completeness | Clearly answers both what (generates ERD diagrams, data dictionaries, table relationships, etc.) AND when ('Use this skill when you need to document existing database schemas for team onboarding, architectural reviews, or data governance purposes'). | 3 / 3 |
Trigger Term Quality | Includes natural keywords users would say: 'database documentation', 'ERD diagram', 'data dictionary', '/db-docs', plus contextual triggers like 'team onboarding', 'architectural reviews', 'data governance'. | 3 / 3 |
Distinctiveness Conflict Risk | Clear niche focused specifically on database schema documentation with distinct triggers like 'ERD diagram', 'data dictionary', and the slash command '/db-docs' that are unlikely to conflict with other skills. | 3 / 3 |
Total | 12 / 12 Passed |
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.