nw-diagram

Generate C4 architecture diagrams from design documents in Mermaid, PlantUML, or C4 formats.

Updated Mar 18, 2024
One-click install
npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-diagram-v1bh0r
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nw-diagram
Source: https://github.com/v1bh0r/precise-ledger-pro/tree/main/nWave/skills/nw-diagram
Command: npx skills add https://github.com/v1bh0r/precise-ledger-pro --skill nw-diagram-v1bh0r

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating consistent C4 architecture diagrams for system context, container boundaries, and component relationships from existing design docs, saving time and reducing miscommunication.

Core Features & Use Cases

  • Generates C4 diagrams (context, container, component) in Mermaid, PlantUML, or C4 format from architecture design docs.
  • Supports multiple output formats and levels to match stakeholder needs.
  • Enables rapid iteration of architecture visuals as the docs evolve.

Quick Start

Invoke the nw-diagram generator for a target architecture component to produce diagrams in Mermaid, PlantUML, or C4 format.

Frequently Asked Questions about nw-diagram

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

FAQPage Schema
How do I generate C4 architecture diagrams from existing design documents?

You can generate C4 architecture diagrams directly from markdown design documents. The tool parses architecture-design.md, component-boundaries.md, and technology-stack.md files to produce context, container, and component diagrams automatically.

What is the best way to create Mermaid or PlantUML diagrams for system context and container boundaries?

The best way to create Mermaid or PlantUML diagrams for system context is to use a generator that reads your architecture docs. This ensures your C4 diagrams stay consistent with your design documentation as it evolves.

What files do I need to prepare before generating C4 architecture diagrams?

You need to prepare three specific markdown files: docs/architecture/architecture-design.md, docs/architecture/component-boundaries.md, and docs/architecture/technology-stack.md. These files provide the structural context required to generate the diagrams.

Can I output architecture diagrams in both Mermaid and PlantUML formats?

Yes, you can output architecture diagrams in Mermaid, PlantUML, or C4 formats. This allows you to match the visualization format to the specific needs of different developers and stakeholders reviewing the system.

How do I keep architecture diagrams updated when the design docs change?

You keep architecture diagrams updated by re-invoking the generator against your target architecture component. It rapidly iterates the architecture visuals by reading the updated markdown design documents and outputting to a configurable directory.