create-data-model-docs

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.