db-spec-generator

Generates database design specifications, Mermaid ERD diagrams, and overview documents from DDL or use cases.

Updated Aug 15, 2026
One-click install
npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill db-spec-generator-jacksonlee-tw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: db-spec-generator
Source: https://github.com/jacksonlee-tw/mystock-vue/tree/main/mystock-analysis/.github/skills/db-spec-generator
Command: npx skills add https://github.com/jacksonlee-tw/mystock-vue --skill db-spec-generator-jacksonlee-tw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, complete database design documentation is time-consuming and error-prone. This Skill automates the creation of standardized DB specification documents, ERD diagrams, and cross-module database overviews from DDL, schema files, use cases, or plain descriptions. ## Core Features & Use Cases - DB Specification Generation: Produces full table design specs with columns, constraints, indexes, data dictionaries, and seed data following project templates. - Mermaid ERD Diagrams: Creates entity-relationship diagrams with PK/FK/UK markers, Chinese field annotations, and DDL synchronization checklists. - Cross-Module Overview Documents: Generates system-level database architecture overviews covering module relationships, performance optimization, and migration strategies. - Use Case: Provide a CREATE TABLE DDL or a use case document, and receive a complete Spring Boot + JPA + PostgreSQL-aligned design document ready for backend developers. ## Quick Start Ask the AI to generate a DB specification document and ERD diagram from your DDL or module description, for example: generate the database design spec for the employee management module.

Frequently Asked Questions about db-spec-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a database design document from DDL?▼

Provide your CREATE TABLE statements or schema.sql file and the Skill reads the project templates, then produces a full DB specification with table details, constraints, indexes, data dictionary, and seed data. It also generates a matching Mermaid ERD document.

How to create an ERD diagram from a use case description?▼

Describe the module's business functionality or paste a use case document, and the Skill designs the tables following naming conventions, then renders a Mermaid erDiagram with PK, FK, and UK markers plus relationship cardinality notation.

What database and framework conventions does this support?▼

The generated documents follow Spring Boot, JPA/Hibernate, and PostgreSQL 14+ conventions by default, including snake_case columns, BIGINT primary keys, audit fields like creator and createtime, and TIMESTAMP mapping to LocalDateTime.

Can I generate only an ERD without the full specification?▼

Yes. When you only request an ERD, the Skill applies just the ERD template and outputs the Mermaid diagram, DDL synchronization checklist, index summary, and business rule constraints without the full specification document.

What are the limitations of generated database documentation?▼

Output quality depends on the completeness of your input; vague descriptions require follow-up questions about project name, module, and tables. The Skill also requires reading the three project template files before each run, so those templates must exist in the repository.