Does it work with any codebase?

While specifically optimized for the Miyabi framework and Rust projects, it uses grep to identify entity patterns and can be used for any project following the Miyabi architectural standard.

Can this skill generate visual diagrams?

Yes, the skill automatically generates Mermaid.js code to create visual representations of entity relationships, sequences, and data flows directly within your documentation.

What is the Miyabi Entity-Relation model?

It is a structural framework within the Miyabi project that defines 14 core entities (like Issue, Task, and Agent) and 39 specific relationships to govern autonomous, issue-driven development.

When is the best time to trigger this skill?

It is most effective after implementing new features, when performing architectural refactors, or when you need to provide a high-level explanation of how specific components interact.

Miyabi Entity-Relation Documentation Generator

Name: Miyabi Entity-Relation Documentation Generator
Author: ShunsukeHayashi

byShunsukeHayashi

•

学習とドキュメンテーション

Generates structured technical documentation and Mermaid diagrams based on the Miyabi Entity-Relation model to map system components and workflows.

This Claude Code skill automates the creation of high-quality technical documentation by leveraging the Miyabi framework's core Entity-Relation model, which consists of 14 specific entities and 39 relationships. It analyzes your codebase to identify system components—such as Issues, Tasks, and Agents—and automatically generates feature-specific docs, architecture overviews, and visual Mermaid diagrams. By mapping implementation files to high-level entities, it ensures your project's architectural maps and relationship diagrams stay synchronized with your code in an issue-driven development environment.

主な機能

017 GitHub stars

02Automated Mermaid.js diagram generation for visual workflows

03Entity-Relation mapping for 14 core entities and 39 relations

04Pattern-based templates for feature and architecture documentation

05Automatic file-to-entity relationship mapping

06Grep-based entity identification within Rust-based codebases

ユースケース

01Updating complex architecture diagrams and data flow maps automatically

02Generating comprehensive documentation after implementing new features

03Explaining interactions between Issues, Tasks, and Agents to team members

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add shunsukehayashi/miyabi documentation-generation

For use in Claude.ai and ChatGPT

Download Skill