CtrlK
CommunityDocumentationLog inGet started
Tessl Logo

database-documentation-gen

tessl i github:jeremylongshore/claude-code-plugins-plus-skills --skill 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".

54%

Overall

SKILL.md
Review
Evals

Validation

81%
CriteriaDescriptionResult

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

metadata_version

'metadata' field is not a dictionary

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

13

/

16

Passed

Implementation

20%

This skill is a generic template that has been minimally customized for database documentation. It contains no database-specific guidance, no actual documentation generation code or commands, and no examples of what database documentation should look like. The content could apply to any technical task and provides no value beyond what Claude already knows about software development processes.

Suggestions

Add concrete, executable code examples for extracting schema information (e.g., SQL queries for table structures, column types, foreign keys, indexes)

Include specific documentation output formats with examples (e.g., Markdown table schemas, ERD generation commands, data dictionary templates)

Replace generic workflow steps with database-specific actions like 'Run `pg_dump --schema-only` to extract schema' or 'Query information_schema.columns for column metadata'

Remove all generic software development guidance (permissions, network failures, resource constraints) that Claude already knows and focus only on database documentation specifics

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. Nearly every section is padded with unnecessary context.

1 / 3

Actionability

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

1 / 3

Workflow Clarity

Steps are numbered and sequenced, but they're generic software development lifecycle steps, not specific to database documentation. No validation checkpoints specific to documentation quality or schema accuracy. The workflow could apply to literally any technical task.

2 / 3

Progressive Disclosure

References external files in Resources section which is good structure, but the main content is a monolithic wall of generic text. The referenced files use placeholder paths that may not exist. Overview and Examples sections at the bottom are empty placeholders.

2 / 3

Total

6

/

12

Passed

Activation

82%

The description has good trigger term coverage and completeness with explicit 'when to use' guidance. However, it lacks specificity about concrete actions (what exactly does it generate?) and uses somewhat awkward phrasing ('Process use when'). The description would benefit from listing specific documentation outputs like schema diagrams, table descriptions, or relationship mappings.

Suggestions

Add specific concrete actions like 'generates ERD diagrams, documents table relationships, creates column-level descriptions, exports schema metadata'

Fix the awkward opening 'Process use when' to proper third-person voice like 'Generates database documentation automatically'

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 explicit trigger guidance.

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 other documentation skills. The database focus helps but isn't strongly distinctive.

2 / 3

Total

10

/

12

Passed

Reviewed

Table of Contents

ValidationImplementationActivation

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.