arch-diagrams

Generate Mermaid component and sequence diagrams from OpenAPI 3.x YAML files.

Updated Apr 18, 2026
One-click install
npx skills add https://github.com/4797pnkkx5-gif/AI-Augmented-RE --skill arch-diagrams-4797pnkkx5-gif
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arch-diagrams
Source: https://github.com/4797pnkkx5-gif/AI-Augmented-RE/tree/main/skills/arch-diagrams
Command: npx skills add https://github.com/4797pnkkx5-gif/AI-Augmented-RE --skill arch-diagrams-4797pnkkx5-gif

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual effort of turning API specifications into clear architecture documentation by producing component and sequence diagrams directly from OpenAPI inputs.

Core Features & Use Cases

  • Component Diagram Generation: Converts OpenAPI service definitions into a Mermaid component overview with internal services and external clients.
  • Sequence Diagram Creation: Produces one happy-path sequence diagram per service or major interaction flow using operationIds (or HTTP method/path when missing).
  • Elicitation Document Update: Inserts or updates Section 4 (System Architecture Overview) in the elicitation document with diagram sources and review status markers.

Quick Start

Run the arch-diagrams skill after /elicit has produced artifacts/01-elicitation/elicitation-document.md, and ensure your OpenAPI 3.x YAML files are placed under inputs/APIs/.

Frequently Asked Questions about arch-diagrams

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

FAQPage Schema
How do I generate architecture diagrams from OpenAPI 3.x YAML files?

Generate architecture diagrams from OpenAPI 3.x YAML files by placing them under inputs/APIs/ and running the skill to parse service names, endpoints, and schemas into Mermaid component and sequence diagrams embedded in the elicitation document.

Can I create Mermaid sequence diagrams directly from an API specification?

Yes, create Mermaid sequence diagrams directly from an API specification by extracting operationIds or HTTP method and path definitions from OpenAPI files to produce one happy-path sequence diagram per service interaction flow.

What is the best way to keep architecture documentation updated when API contracts change?

Keep architecture documentation updated when API contracts change by running this skill within requirements engineering pipelines to automatically refresh Section 4 of the elicitation document with traceable Mermaid diagram sources and review placeholders.

Do I need an elicitation document to generate component diagrams from OpenAPI inputs?

Yes, an elicitation document is required as the target artifact for writing generated component diagrams, and it should be produced by the elicitation pipeline under artifacts/01-elicitation/ before running this skill.

How does requirements traceability work when converting API definitions to architecture diagrams?

Requirements traceability works by mapping extracted OpenAPI service names and endpoints into Mermaid flowchart LR and sequenceDiagram outputs, then embedding those diagram sources directly into the System Architecture Overview section of the elicitation document.

What happens if my OpenAPI specification is missing operationIds for sequence diagram generation?

If OpenAPI specifications are missing operationIds for sequence diagram generation, the skill falls back to using the HTTP method and path definitions from the API contract to label the interaction flows in the Mermaid sequence diagrams.