Skip to main content
skill CX Codex

architecture-diagrams — Claude Code skill: how to install

Generates system architecture diagrams, data flows, and C4 models using code formats like Mermaid and PlantUML. Useful when documenting service design directly inside your coding agent.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add aj-geddes/useful-ai-prompts --skill architecture-diagrams -a claude-code
Open on GitHub

What architecture-diagrams does

This skill guides the agent to produce structured system design diagrams using Mermaid and PlantUML. It supports sequence diagrams, C4 context diagrams, component views, and deployment layouts. Text-based diagrams live alongside your project files in Git.

Detailed patterns sit in the references/ directory. The instructions enforce clean subgraph grouping, directional data flows, and consistent naming conventions.

The skill avoids binary image exports completely. Keeping diagrams in plain text prevents the visual drift that usually breaks outdated image assets.

What it helps with

  • generate Mermaid architecture charts for microservices and data layers
  • draft C4 context and component diagrams for technical documentation
  • build sequence diagrams showing API gateway and service interactions
  • map out data flow pipelines and relational database schemas

Example prompts for the agent

  • Create a Mermaid architecture diagram with a client layer, API gateway, and PostgreSQL database
  • Generate a sequence diagram for user authentication through our payment service
  • Draw a C4 component diagram for the order processing backend

How to install architecture-diagrams

1Skills CLI (Vercel)

npx skills add aj-geddes/useful-ai-prompts --skill architecture-diagrams -a claude-code

2Manually: put the files in place

~/.claude/skills/architecture-diagrams/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/architecture-diagrams/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about architecture-diagrams

How to install architecture-diagrams in Claude Code?

Run npx skills add aj-geddes/useful-ai-prompts --skill architecture-diagrams -a claude-code. Alternatively, place the file directly at ~/.claude/skills/architecture-diagrams/SKILL.md.

What does architecture-diagrams do?

It instructs your AI agent to create code-based diagrams using Mermaid and PlantUML. It handles architecture overviews, C4 models, sequence diagrams, and deployment flows.

Why does this skill focus on text-based diagrams?

It avoids proprietary and binary image formats so diagrams stay version-controlled in Git. Text definitions make it easy to update diagrams whenever the codebase changes.

Source text

SKILL.md · MIT
---
name: architecture-diagrams
description: >
  Create system architecture diagrams using Mermaid, PlantUML, C4 model,
  flowcharts, and sequence diagrams. Use when documenting architecture, system
  design, data flows, or technical workflows.
---

# Architecture Diagrams

## Table of Contents

- [Overview](#overview)
- [When to Use](#when-to-use)
- [Quick Start](#quick-start)
- [Reference Guides](#reference-guides)
- [Best Practices](#best-practices)

## Overview

Create clear, maintainable architecture diagrams using code-based diagramming tools like Mermaid and PlantUML for system design, data flows, and technical documentation.

## When to Use

- System architecture documentation
- C4 model diagrams
- Data flow diagrams
- Sequence diagrams
- Component relationships
- Deployment diagrams
- Infrastructure architecture
- Microservices architecture
- Database schemas (visual)
- Integration patterns

## Quick Start

Minimal working example:

```mermaid
graph TB
    subgraph "Client Layer"
        Web[Web App]
        Mobile[Mobile App]
        CLI[CLI Tool]
    end

    subgraph "API Gateway Layer"
        Gateway[API Gateway<br/>Rate Limiting<br/>Authentication]
    end

    subgraph "Service Layer"
        Auth[Auth Service]
        User[User Service]
        Order[Order Service]
        Payment[Payment Service]
        Notification[Notification Service]
    end

    subgraph "Data Layer"
        UserDB[(User DB<br/>PostgreSQL)]
        OrderDB[(Order DB<br/>PostgreSQL)]
        Cache[(Redis Cache)]
        Queue[Message Queue<br/>RabbitMQ]
    end
// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [System Architecture Diagram](references/system-architecture-diagram.md) | System Architecture Diagram |
| [Sequence Diagram](references/sequence-diagram.md) | Sequence Diagram |
| [C4 Context Diagram](references/c4-context-diagram.md) | C4 Context Diagram |
| [Component Diagram](references/component-diagram.md) | Component Diagram |
| [Deployment Diagram](references/deployment-diagram.md) | Deployment Diagram |
| [Data Flow Diagram](references/data-flow-diagram.md) | Data Flow Diagram |
| [Class Diagram](references/class-diagram.md) | Class Diagram |
| [Component Diagram](references/component-diagram-2.md) | Component Diagram |
| [Deployment Diagram](references/deployment-diagram-2.md) | Deployment Diagram |

## Best Practices

### ✅ DO

- Use consistent notation and symbols
- Include legends for complex diagrams
- Keep diagrams focused on one aspect
- Use color coding meaningfully
- Include titles and descriptions
- Version control your diagrams
- Use text-based formats (Mermaid, PlantUML)
- Show data flow direction clearly
- Include deployment details
- Document diagram conventions
- Keep diagrams up-to-date with code
- Use subgraphs for logical grouping

### ❌ DON'T

- Overcrowd diagrams with details
- Use inconsistent styling
- Skip diagram legends
- Create binary image files only
- Forget to document relationships
- Mix abstraction levels in one diagram
- Use proprietary formats

© aj-geddes · MIT · aj-geddes/useful-ai-prompts

Similar skills

Everything for Writing and docs →

From the same set118

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor