documenting-architecture

Generate architecture overview Markdown and Mermaid diagrams from codebase analysis.

11|1|Updated Aug 6, 2025
One-click install
npx skills add https://github.com/thkt/claude-config --skill documenting-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenting-architecture
Source: https://github.com/thkt/claude-config/tree/main/ja/skills/documenting-architecture
Command: npx skills add https://github.com/thkt/claude-config --skill documenting-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

コードベース分析からアーキテクチャの概要とMermaidダイアグラムを自動生成します。

Core Features & Use Cases

  • プロジェクト概要と技術スタックの検出
  • ディレクトリ構造とモジュール関係の Mermaid 図生成
  • 主要コンポーネントの統計と依存関係の可視化

Quick Start

/docs:architecture を実行して現在のリポジトリのアーキテクチャを生成します。

Frequently Asked Questions about documenting-architecture

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

FAQPage Schema
How do I automatically generate architecture diagrams from my codebase?

Architecture diagram generation extracts your project structure, modules, and dependencies to produce visual documentation. This Skill analyzes your codebase and outputs Mermaid diagrams showing module relationships and dependency graphs without manual mapping.

Can I generate architecture documentation from a multi-language repository?

Yes, this Skill applies tree-sitter-based parsing to handle multiple programming languages. It extracts project structure, identifies modules and tech-stack components across language boundaries, then produces unified Markdown and Mermaid documentation.

What output does the architecture generation produce?

The Skill generates Markdown documentation containing project overview, detected technology stack, and component statistics alongside Mermaid diagrams visualizing directory structure, module relationships, and dependency graphs.

Do I need to manually map dependencies to use this tool?

No. Dependency visualization is automated through codebase analysis. The Skill extracts module relationships and tech-stack information directly from your repository structure without requiring manual configuration or dependency mapping.

How does this approach compare to manually documenting architecture?

Automated generation from codebase analysis ensures your documentation stays synchronized with actual code structure and dependencies. Manual approaches require ongoing updates; this Skill regenerates accurate diagrams on demand from current code.