Can I customize the documentation output location?

By default, the skill saves files to the docs/ directory, but it will explicitly ask you if you prefer a different location before writing.

How does this skill help with backend development?

It automates the tedious task of tracing code execution paths across services and documenting them as visual flowcharts and structured technical text.

Does it support event-driven architectures?

Yes, the skill is designed to identify message publishing patterns for tools like SNS, Kafka, and RabbitMQ to include them in the system flow.

What diagram format does it use?

It generates Mermaid.js sequence diagrams, which are widely supported and render natively in platforms like GitHub, GitLab, and Notion.

Backend Use Case Documentation

Name: Backend Use Case Documentation
Author: mixomat

bymixomat

API開発

Generates structured backend documentation and Mermaid sequence diagrams to visualize API flows and system behaviors.

概要

This skill automates the creation of comprehensive backend use case documentation by analyzing controllers, service interactions, and event flows. It translates complex code logic into readable Markdown files featuring Mermaid sequence diagrams, state transition maps, and validation rules, ensuring that technical debt is reduced and system architecture remains transparent for the entire development team. It is particularly effective for mapping out REST endpoints, microservice communication, and event-driven architectures.

主な機能

Automated discovery of API entry points and service handlers
Identification of event-driven interactions like SNS, Kafka, and RabbitMQ
Detailed tracking of entity state transitions and validation logic
0 GitHub stars
Generation of Mermaid sequence diagrams for visual flow representation
Standardized Markdown output with relative links to relevant source code

ユースケース

Creating technical onboarding guides for legacy system features and behaviors
Visualizing complex microservice interactions and event-driven workflows
Documenting a new REST API endpoint's full request-response lifecycle

概要

主な機能

Automated discovery of API entry points and service handlers
Identification of event-driven interactions like SNS, Kafka, and RabbitMQ
Detailed tracking of entity state transitions and validation logic
0 GitHub stars
Generation of Mermaid sequence diagrams for visual flow representation
Standardized Markdown output with relative links to relevant source code

ユースケース

Creating technical onboarding guides for legacy system features and behaviors
Visualizing complex microservice interactions and event-driven workflows
Documenting a new REST API endpoint's full request-response lifecycle