skills.rest
ShunsukeHayashi
ShunsukeHayashiCOMMUNITY
Explore all skills by this author →
Website𝕏@The_AGI_WAYGitHub

Entity-Relation Based Documentation

Generate documentation from Miyabi's Entity-Relation Model with Mermaid diagrams.

Updated Aug 27, 2026
Search Tags:#architecture#documentation#mermaid diagrams#code documentation#auto-generation#entity-relation
One-click install
npx skills add https://github.com/ShunsukeHayashi/miyabi-mcp-bundle --skill entity-relation-based-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Entity-Relation Based Documentation
Source: https://github.com/ShunsukeHayashi/miyabi-mcp-bundle/tree/main/claude-plugins/miyabi-full/skills/documentation-generation
Command: npx skills add https://github.com/ShunsukeHayashi/miyabi-mcp-bundle --skill entity-relation-based-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of technical documentation by leveraging a structured Entity-Relation Model. It eliminates the manual effort of writing and maintaining documentation, ensuring accuracy and consistency with your codebase.

Core Features & Use Cases

  • ER Model-Based Generation: Generates documentation based on Miyabi's 14 entities and 39 relationships, providing a consistent and structured approach.
  • Mermaid Diagram Creation: Automatically generates visual Mermaid diagrams to illustrate complex entity relationships and data flows.
  • Pattern-Based Documentation: Offers templates for generating feature documentation, architecture overviews, and component explanations.
  • Use Case: After implementing a new feature that involves several interconnected components, use this Skill to automatically generate updated architecture documentation, including a Mermaid diagram illustrating the new entity relationships and data flow.

Quick Start

Generate documentation for the 'Agent' entity, including its relationships and a Mermaid diagram.

Frequently Asked Questions about Entity-Relation Based Documentation

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

FAQPage Schema
How do I auto-generate documentation from my codebase structure?▼

Auto-generate documentation by leveraging your code's Entity-Relation Model to extract entities and relationships, then automatically create Mermaid diagrams and architecture docs that stay synchronized with implementation.

Can I generate Mermaid diagrams automatically from my code's architecture?▼

Yes, this Skill automatically generates Mermaid diagrams from your ER model, visualizing entity relationships and data flows without manual diagram creation.

What's the best way to keep architecture documentation in sync with code changes?▼

Use ER-based documentation generation to automate extraction of entities and relations from your codebase, ensuring docs reflect actual implementation whenever you update components.

How do I document interconnected components and their relationships?▼

Map your interconnected components through the Entity-Relation Model, which automatically generates documentation showing how entities relate, data flows between them, and links to implementation files.

Does this work for documenting Miyabi-based projects?▼

Yes, this Skill is designed specifically for Miyabi projects, extracting all 14 ER entities and 39 relations to generate consistent, structured architecture and feature documentation.

Related Skills

Explore More Software Engineering Skills→
hiromimahiromima

Entity-Relation Based Documentation

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

Community
Intermediate
cosmixcosmix
53

diagramming

Convert textual system descriptions into Mermaid diagrams.

Community
Basic
nimadorostkarnimadorostkar
25

diagrams

Generate Mermaid diagrams as code for version-controlled documentation.

Community
Intermediate
vndeevndee
3

adr

Document architectural decisions with context, rationale, and trade-offs.

Community
Advanced