Can it generate visual diagrams automatically?

Yes, it is designed to produce Mermaid sequence and flow diagrams that visualize the specific relationships (R1-R39) between your project entities.

How does this skill identify entities in my code?

The skill utilizes grep and pattern matching tools to detect references to core entities like Issues, Tasks, and Agents within your source files and crates.

What is the best time to trigger this skill?

It is most effective when used immediately after implementing new features, when updating architecture overview files, or when explaining complex component interactions to stakeholders.

Is this skill restricted to the Miyabi framework?

While it is specifically optimized for Miyabi's 14-entity model, it provides a robust structural pattern that can be adapted for any documentation requiring entity-relation mapping.

Entity-Relation Documentation Generator

Name: Entity-Relation Documentation Generator
Author: ShunsukeHayashi

byShunsukeHayashi

•

Content Management

Generates comprehensive architecture and feature documentation based on Miyabi's 14-entity and 39-relationship model.

About

This skill automates the creation of high-quality technical documentation by mapping code components to Miyabi's specialized Entity-Relation (ER) model. It identifies complex relationships between issues, tasks, agents, and pull requests to produce standardized feature documents, Mermaid diagrams, and architecture overviews. By extracting entity references directly from source code, it ensures your project's documentation remains perfectly synchronized with implementation while following established structural patterns and best practices.

Key Features

Automated Mermaid diagram generation for visual system architecture
Automated grep-based workflow for extracting entity references from crates
Mapping of 14 core Miyabi entities including Issues, Tasks, and Agents
Direct implementation-to-document file mapping for better traceability
Standardized templates for feature-specific and architectural documentation
7 GitHub stars

Use Cases

Generating detailed documentation for newly implemented features
Updating complex architecture docs after structural code changes
Visualizing component interactions and data flows using ER diagrams

About

Key Features

Automated Mermaid diagram generation for visual system architecture
Automated grep-based workflow for extracting entity references from crates
Mapping of 14 core Miyabi entities including Issues, Tasks, and Agents
Direct implementation-to-document file mapping for better traceability
Standardized templates for feature-specific and architectural documentation
7 GitHub stars

Use Cases

Generating detailed documentation for newly implemented features
Updating complex architecture docs after structural code changes
Visualizing component interactions and data flows using ER diagrams