skills.rest
jrodrigopuca
jrodrigopucaCOMMUNITY
Explore all skills by this author →
GitHub

create-data-model-docs

Generate data model documentation with ER diagrams from schemas and migrations.

Updated Feb 10, 2026
Search Tags:#documentation#database#schema#data modeling#persistence#ERD
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill create-data-model-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-data-model-docs
Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs/sub-skills/create-data-model-docs
Command: npx skills add https://github.com/jrodrigopuca/skills --skill create-data-model-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating clear and accurate documentation for data models, ensuring that persisted entities, their fields, constraints, and relationships are well-understood and consistently represented.

Core Features & Use Cases

  • Entity Identification: Automatically identifies persisted entities within a given scope.
  • Detailed Documentation: Documents fields, constraints, and relationships based on evidence.
  • ER Diagram Generation: Creates an evidence-based Entity-Relationship Diagram (ERD).
  • Lifecycle Description: Describes the lifecycle of entities when observable.
  • Use Case: Generate comprehensive documentation for your application's database schema, including an ERD, field definitions, and relationship mappings, ensuring consistency between the code and the documentation.

Quick Start

Generate documentation for the data model within the 'user-profile' scope using the provided schema files.

Frequently Asked Questions about create-data-model-docs

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

FAQPage Schema
How do I generate data model documentation from existing database schemas and ORM models?▼

Data model documentation is generated by analyzing schemas, migrations, and ORM models to identify persisted entities, document fields and constraints, and produce an evidence-based ER diagram.

Can I automatically create an ER diagram from my repository's database configuration?▼

Yes, an evidence-based ER diagram can be automatically created by analyzing your database configurations and schema files to map entity relationships accurately.

How do I document database constraints and entity relationships based on repository evidence?▼

Database constraints and relationships are documented by extracting evidence from schemas and migrations, ensuring alignment with repository files while marking uncertainties and removing obsolete entries.

What is the best way to keep data model documentation aligned with evolving schema migrations?▼

The best way to keep data model documentation aligned is by analyzing current migrations and schemas to remove obsolete entries and mark uncertainties based on the latest repository evidence.

Does this data modeling approach work with ORM models and raw database schemas?▼

Yes, this approach works by analyzing both ORM models and raw database schemas to identify persisted entities and describe their lifecycle when observable.

How are uncertainties handled when generating entity-relationship diagrams from code?▼

When generating entity-relationship diagrams from code, uncertainties are explicitly marked to ensure the documentation remains evidence-based and transparent about any ambiguous schema relationships.

Related Skills

Explore More Software Engineering Skills→
crgarcia12crgarcia12

data-model-extractor

Extract database schemas and generate Mermaid ER diagrams from ORM models.

Community
Advanced
hiromimahiromima

Entity-Relation Based Documentation

Convert Miyabi's ER model into documentation and Mermaid diagrams.

Community
Intermediate
TorbenMerraldTorbenMerrald
1

Backend Models

Define and enforce database models and entity schemas across ORM and migration scripts.

Community
Advanced
cwilliams5cwilliams5
1

review-dead-code

Identify dead code and generate a removal plan for codebases.

Community
Advanced