system-architecture-doc

Generate Structurizr DSL models and READMEs with C4 diagrams from repository data.

1|Updated Dec 17, 2025
One-click install
npx skills add https://github.com/JonnyCBB/claude-code-config --skill system-architecture-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: system-architecture-doc
Source: https://github.com/JonnyCBB/claude-code-config/tree/main/plugins/eng-utils/skills/system-architecture-doc
Command: npx skills add https://github.com/JonnyCBB/claude-code-config --skill system-architecture-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documenting complex systems with consistent architecture diagrams and readable documentation is error-prone and time-consuming. This skill automates end-to-end architecture documentation by generating enriched Structurizr DSL models and human-readable READMEs, including C4 diagrams, sequence walkthroughs, and deployment notes for quick publishing.

Core Features & Use Cases

  • Enriched Structurizr DSL model with repository metadata, ownership, and deployment context
  • Generated C4 system context, container, and component views with SVG renderings
  • Human-readable README.md with diagrams, flows, and practical usage guidance
  • Phase-driven workflow with validation, rendering, and easy incremental updates

Quick Start

Provide a system name or repository path to generate architecture documentation with C4 diagrams and a publish-ready README.

Frequently Asked Questions about system-architecture-doc

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

FAQPage Schema
How do I automate system architecture documentation with C4 diagrams?

Automate system architecture documentation by providing a system name or repository path to generate an enriched Structurizr DSL model. This produces C4 diagrams, sequence flows, and a human-readable README with deployment notes.

What is the best way to generate a Structurizr DSL model from existing code?

Generate a Structurizr DSL model by inputting your repository data, which identifies architectural requirements and dependencies. The output is an enriched model containing ownership, deployment context, and C4 system views.

Can I generate C4 container and component views for a software repository automatically?

Generate C4 container and component views automatically by processing repository inputs. The system creates SVG renderings of system context, containers, and components, embedding them directly within a publish-ready README.

Does this architecture documentation workflow handle validation and rendering errors?

The architecture documentation workflow handles validation and rendering errors using a phase-driven process with error handling and progress gating. It ensures Structurizr DSL validation, rendering steps, and storage actions are performed reliably.

How do I document system dependencies and deployment context in a README?

Document system dependencies and deployment context in a README by processing repository data to capture metadata and ownership. The output README includes practical usage guidance, sequence walkthroughs, and deployment notes.