documentation/uml-documentation

Convert TypeScript class relationships into Mermaid UML class diagrams.

Updated Mar 26, 2026
One-click install
npx skills add https://github.com/johnnystefan/test-saas-business --skill documentation-uml-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation/uml-documentation
Source: https://github.com/johnnystefan/test-saas-business/tree/main/skills/documentation/uml-documentation
Command: npx skills add https://github.com/johnnystefan/test-saas-business --skill documentation-uml-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Resolves ambiguity in TypeScript class inheritance and composition by translating domain models into standard UML notation for clearer architecture communication.

Core Features & Use Cases

  • Structured Notation Guide: Defines box layouts, visibility markers, and styling rules so every class, field, and method stays consistent when converted to Mermaid.
  • Relationship Mapping: Explicitly maps extends, implements, and composition cues from constructors to the proper UML edges for inheritance, implementation, and aggregation/composition.
  • Use Case: Document a membership service by converting its TypeScript entities and value objects into a Mermaid class diagram that highlights domain relationships and lifecycle dependencies.

Quick Start

Generate a mermaid UML class diagram that maps the provided service classes and their relationships.

Frequently Asked Questions about documentation/uml-documentation

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

FAQPage Schema
How do I generate a UML class diagram from TypeScript classes?

To generate a UML class diagram from TypeScript classes, the Skill interprets fields, methods, and constructor compositions to produce Mermaid class diagram syntax with proper relationships and visibility annotations.

What is the best way to document TypeScript architecture relationships?

Documenting TypeScript architecture relationships is best handled by translating domain models and class inheritance cues into standard UML notation, which clarifies system structure and resolves ambiguity in complex services.

How does TypeScript constructor composition translate to UML relationships?

TypeScript constructor composition translates to UML relationships by mapping dependency cues to specific UML edges, explicitly defining aggregation, composition, implementation, and inheritance within the generated diagram.

Can I map TypeScript extends and implements to Mermaid diagram edges?

Yes, you can map TypeScript extends and implements keywords to proper Mermaid diagram edges, ensuring class inheritance and interface implementation relationships are accurately visualized with correct notation.

Do I need TypeScript to visualize architecture with UML clarity?

You need TypeScript input to visualize architecture with UML clarity using this Skill, as it specifically requires interpreting TypeScript class relationships, domain entities, and value objects to map system structure.

Why use Mermaid class diagram syntax for architecture documentation?

Using Mermaid class diagram syntax for architecture documentation provides structured notation through defined box layouts and visibility markers, ensuring every class, field, and method stays consistent when converted.