skills.rest
radius-project
radius-projectOFFICIAL
Explore all skills by this author →
WebsiteGitHub

architecture-documenter

Document application architectures and generate Mermaid diagrams from source code.

1.7k|136|Updated Feb 20, 2021
Search Tags:#architecture#documentation#mermaid#code-analysis#diagram#system-design
One-click install
npx skills add https://github.com/radius-project/radius --skill architecture-documenter-radius-project
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-documenter
Source: https://github.com/radius-project/radius/tree/main/.github/skills/architecture-documenter
Command: npx skills add https://github.com/radius-project/radius --skill architecture-documenter-radius-project

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Document architectures and generate Mermaid diagrams grounded in actual source code to ensure diagrams stay in sync with the codebase.

Core Features & Use Cases

  • Code-grounded diagrams: Generate Mermaid diagrams directly from code to reflect real relationships.
  • Progressive depth: Start with high-level overviews, then drill into details as needed.
  • Multiple diagram types: Component, sequence, ER, and deployment diagrams supported.

Quick Start

Describe the code scope you want diagrammed and generate Mermaid diagrams that reflect the real architecture.

Frequently Asked Questions about architecture-documenter

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

FAQPage Schema
How do I generate Mermaid diagrams from source code to document system architecture?▼

Generate Mermaid diagrams from source code by analyzing entry points, tracing call chains, and mapping package structure to produce code-backed component, sequence, ER, and deployment diagrams that reflect real relationships.

Can I create a sequence diagram that traces actual call chains in my codebase?▼

Yes, sequence diagrams can be created by tracing actual call chains within the codebase. The analysis maps method invocations and control flow to generate accurate sequence diagrams grounded in real source code.

What's the best way to keep architecture documentation in sync with the codebase?▼

Keep architecture documentation in sync by generating diagrams directly from source code analysis rather than maintaining manual diagrams. This code-grounded approach ensures documentation reflects real package structure and dependencies.

Does this approach support generating deployment maps and ER models for system design reviews?▼

Yes, deployment maps and ER models are supported alongside component and sequence diagrams. These multiple diagram types facilitate architecture reviews, onboarding, and knowledge transfer using standardized Mermaid syntax.

How do I document application architecture with progressive depth for onboarding?▼

Document application architecture with progressive depth by starting with high-level component overviews, then drilling into detailed call chains and package structures as needed for comprehensive onboarding and knowledge transfer.

Related Skills

Explore More Software Engineering Skills→
workinprogress-aiworkinprogress-ai

devenv-chat-with-code

Explain codebase architecture with cited references to files and line numbers.

Official
Advanced
atilladenizatilladeniz
2

system-design

Generate Mermaid diagrams for system design and architecture visualization.

Community
Basic
abudhahirabudhahir

senior-architect

Generate architecture diagrams and analyze dependencies for software systems.

Community
Advanced
rysweetrysweet
2

mermaid-diagram-generator

Convert architecture and workflow descriptions into valid Mermaid diagrams.

Community
Intermediate