skills.rest
vukhanhtruong
vukhanhtruongCOMMUNITY
Explore all skills by this author →
GitHub

architecture-design

Generate ARCHITECTURE.md documentation with diagrams and OpenAPI specs.

9|Updated Oct 22, 2025
Search Tags:#design#architecture#software engineering#documentation#mermaid#openapi#c4 model
One-click install
npx skills add https://github.com/vukhanhtruong/claude-rock --skill architecture-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-design
Source: https://github.com/vukhanhtruong/claude-rock/tree/main/plugins/architecture-design/skills
Command: npx skills add https://github.com/vukhanhtruong/claude-rock --skill architecture-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdown, weasyprint, @mermaid-js/mermaid-cli, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Manually creating and maintaining comprehensive software architecture documentation is a time-consuming and often neglected task. This skill automates the generation of detailed ARCHITECTURE.md files, complete with visual diagrams and API specifications, ensuring consistency and reducing the burden on development teams.

Core Features & Use Cases

  • Interactive Architecture Interviews: Guides you through 5-7 focused questions to gather essential system information, adapting to your project's needs.
  • Comprehensive Documentation: Generates an 11-section ARCHITECTURE.md covering project structure, core components, data stores, deployment, security, and more.
  • Visual Diagrams: Creates 5 essential Mermaid.js diagrams (C4 Context, Container, Component, Data Flow, Deployment) to visualize your system's architecture.
  • API Specifications: Automatically generates OpenAPI 3.0 compliant specifications for your APIs, ensuring clear communication and integration.
  • Use Case: Design an architecture for a new Node.js microservices platform by answering a few questions, and receive a complete documentation package including diagrams and API specs, ready for your repository.

Quick Start

Create architecture documentation for my Node.js e-commerce platform.

Frequently Asked Questions about architecture-design

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

FAQPage Schema
How do I generate comprehensive architecture documentation automatically?▼

Architecture documentation generation automates the creation of detailed ARCHITECTURE.md files through guided interviews and template-driven processes. This Skill conducts a 5-7 question interview about your system, then produces an 11-section document, Mermaid diagrams, and OpenAPI specifications without manual writing.

Can I create C4 model diagrams and system architecture visuals for microservices?▼

Yes. This Skill generates five Mermaid.js diagrams including C4 Context, Container, Component, Data Flow, and Deployment views. It handles microservices, monolith, and serverless patterns, visualizing your architecture from multiple perspectives.

Does this work with OpenAPI specifications and API documentation?▼

Yes. The Skill automatically generates OpenAPI 3.0 compliant specifications for your APIs alongside the architecture documentation, ensuring API contracts are clearly defined and ready for integration.

What file formats and outputs does architecture documentation include?▼

The Skill produces Markdown documentation (ARCHITECTURE.md), Mermaid diagram source files for visual rendering, and OpenAPI 3.0 JSON specifications. WeasyPrint handles PDF export of your complete documentation package.

How do I document existing systems or update architecture for new requirements?▼

The Skill applies to new projects, existing systems, and architecture updates. Answer its focused interview questions about your current setup, technology stack, and requirements, and it generates updated documentation reflecting your system's real state.

What technology stacks and platforms does this support?▼

The Skill loads technology references for Node.js, Python, and Java, adapting recommendations to your stack. It works across monolithic, microservices, and serverless architectures, fitting most modern project patterns.

Related Skills

Explore More Software Engineering Skills→
YougLin-devYougLin-dev
182

architect

Design system architecture and select technology stacks into project.architecture.md.

Community
Advanced
89jobrien89jobrien
4

file-converter

Generate Python code to convert files between document, data, and image formats.

Community
Advanced
majesticlabs-devmajesticlabs-dev
47

mermaid-builder

Generate syntactically valid Mermaid diagrams for flowcharts, sequence, class, state, Gantt, ER, and data lineage.

Official
Advanced
i-standard1i-standard1
6

drawio

Generate .drawio diagram files and embed them in MkDocs documentation.

Official
Intermediate