diagram-generation

Generate Mermaid diagram code from textual prompts for architectures and data flows.

13.1k|2.2k|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/BasedHardware/omi --skill diagram-generation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diagram-generation
Source: https://github.com/BasedHardware/omi/tree/main/.cursor/skills/diagram-generation
Command: npx skills add https://github.com/BasedHardware/omi --skill diagram-generation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of translating complex architectures into clear Mermaid diagrams.

Core Features & Use Cases

  • Architecture diagrams: Visualize system structure, components, and interactions.
  • Data flow diagrams: Map data movement, transformations, and state transitions.
  • Documentation and PRs: Quickly generate diagrams to accompany docs, code reviews, and design discussions.
  • Use Case: When reviewing a PR that changes service boundaries, generate a diagram showing affected modules and data paths.

Quick Start

Create a Mermaid diagram showing the data flow for our authentication system, including OAuth providers, session management, and token refresh.

Frequently Asked Questions about diagram-generation

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

FAQPage Schema
How do I generate Mermaid diagrams from textual architecture descriptions?

To generate Mermaid diagrams from textual architecture descriptions, you provide a prompt detailing your system structure, data flows, or component interactions, and the skill outputs the corresponding Mermaid diagram code for documentation or PRs.

Can I create data flow and sequence diagrams for documentation using Mermaid?

Yes, you can create data flow and sequence diagrams for documentation using Mermaid by supplying a textual prompt describing data movement, transformations, or component interactions, which the skill translates into visual Mermaid diagram code.

What is the best way to visualize system architecture for a PR description?

The best way to visualize system architecture for a PR description is to generate a Mermaid diagram from a textual prompt, allowing you to quickly map affected modules, service boundaries, and data paths for code reviews.

Do I need any specific diagramming tools to map data paths and component relationships?

You do not need any specific external diagramming tools to map data paths and component relationships, as the skill directly translates textual architectural prompts into standard Mermaid diagram code without dependencies.

Does this approach work for onboarding and architectural analysis of complex systems?

Yes, this approach works for onboarding and architectural analysis of complex systems by translating textual descriptions of architectures and data paths into clear Mermaid diagrams for quick visual explanations.