CtrlK
BlogDocsLog inGet started
Tessl Logo

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".

Install with Tessl CLI

npx tessl i github:jeremylongshore/claude-code-plugins-plus-skills --skill database-documentation-gen
What are skills?

59

Does it follow best practices?

Validation for skill structure

SKILL.md
Review
Evals

Discovery

82%

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 provides adequate trigger terms and completeness with explicit trigger phrases, but suffers from vague capability descriptions ('comprehensive guidance and automation' is fluff). The opening 'Process use when' appears to be a grammatical error. The description would benefit from listing specific concrete actions the skill performs.

Suggestions

Replace vague phrases like 'comprehensive guidance and automation' with specific actions such as 'generate table schemas', 'document foreign key relationships', 'create ERD diagrams'

Fix the grammatical error 'Process use when' at the beginning - unclear what this means

Add more distinctive database-specific triggers like 'SQL schema', 'table documentation', 'database ERD' to reduce overlap with general documentation skills

DimensionReasoningScore

Specificity

Names the domain (database documentation) and mentions 'automated documentation generation' but lacks concrete specific actions like 'generate ERD diagrams', 'document table relationships', or 'create column descriptions'.

2 / 3

Completeness

Explicitly answers both what ('automated documentation generation with comprehensive guidance') and when ('Trigger with phrases like...'). Has clear trigger guidance even if phrased differently than 'Use when...'.

3 / 3

Trigger Term Quality

Includes natural trigger phrases users would say: 'generate docs', 'document schema', 'create database documentation'. These are realistic terms users would use when needing this skill.

3 / 3

Distinctiveness Conflict Risk

Focuses on database documentation which is somewhat specific, but 'documentation generation' could overlap with API docs, code docs, or general documentation skills. The database focus helps but isn't strongly distinctive.

2 / 3

Total

10

/

12

Passed

Implementation

20%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

This skill is a generic template that could apply to virtually any technical task, with no database documentation-specific content. It lacks executable code, specific tools (like SchemaSpy, dbdocs, or SQL queries for extracting schema info), and concrete examples of documentation output. The content explains basic project management concepts Claude already knows rather than providing actionable database documentation guidance.

Suggestions

Add concrete code examples showing how to extract schema information (e.g., SQL queries for table structures, relationships, indexes) and generate documentation

Specify actual documentation tools or approaches (e.g., generating markdown from information_schema, using tools like SchemaSpy, or creating ERD diagrams)

Include an example of expected documentation output format (table descriptions, column definitions, relationship diagrams)

Remove generic boilerplate about permissions, network failures, and deployment that applies to any task and focus on database-specific guidance

DimensionReasoningScore

Conciseness

Extremely verbose with generic boilerplate that applies to any task, not specifically database documentation. Explains obvious concepts like 'verify credentials' and 'check network connectivity' that Claude already knows. Almost no database-specific content.

1 / 3

Actionability

No concrete code, commands, or executable examples. Entirely abstract guidance like 'Execute implementation' and 'Run comprehensive tests' without any specific database documentation tools, SQL queries, or actual documentation generation commands.

1 / 3

Workflow Clarity

Steps are numbered and sequenced, but they're generic project management steps rather than database documentation-specific workflows. No validation checkpoints specific to documentation generation, no feedback loops for verifying generated docs are accurate.

2 / 3

Progressive Disclosure

References external files in Resources section, but the main content is a monolithic wall of generic text. The referenced files use placeholder paths that may not exist. Overview section appears at the end rather than the beginning.

2 / 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.

Validation9 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

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

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.