code-tour

Generate a CODE_TOUR.md onboarding guide with Mermaid diagrams for unfamiliar codebases.

7|Updated May 28, 2026

Search Tags:#architecture #documentation #onboarding #mermaid #codebase #analysis

Ready to run

npx skills add https://github.com/zcaceres/skills --skill code-tour-zcaceres

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/zcaceres/skills/tree/main/skills/code-tour
Command: npx skills add https://github.com/zcaceres/skills --skill code-tour-zcaceres

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the cognitive overload of navigating an unfamiliar codebase by automatically generating a high-level architectural map and onboarding guide.

Core Features & Use Cases

Automated Onboarding: Generates a CODE_TOUR.md file that identifies key components, data flow, and entry points.
Visual Documentation: Creates Mermaid diagrams to visualize system architecture and component relationships.
Use Case: When joining a new project or auditing a legacy repository, use this skill to get a structured, clickable guide to the most important files and patterns without manually exploring every directory.

Quick Start

Invoke the code tour skill by typing /code-tour in your terminal to generate an onboarding guide for the current repository.

Frequently Asked Questions about code-tour

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

FAQPage Schema

How do I generate an onboarding guide for an unfamiliar codebase?▼

To generate an onboarding guide for an unfamiliar codebase, you need a tool that analyzes project structure and entry points to produce a structured map. This skill automatically synthesizes repository files into a concise CODE_TOUR.md document.

Can I automatically visualize codebase architecture and component relationships?▼

Yes, you can automatically visualize codebase architecture and component relationships using Mermaid diagrams. This skill analyzes your repository file system to map data flow and system structure directly into visual documentation.

What is the best way to document core components for a legacy repository audit?▼

The best way to document core components during a legacy repository audit is to synthesize a clickable architectural map. This skill identifies key patterns and entry points, generating a structured guide without requiring manual directory exploration.

Does generating a code tour require write access to the repository?▼

Generating a code tour does not require write access to the repository. This skill requires only read-only access to the repository file system to analyze the project structure and output the documentation.

What are the limitations of automated codebase analysis for project onboarding?▼

A limitation of automated codebase analysis is its intermediate implementation depth, which provides a high-level architectural map rather than exhaustive line-by-line logic. It synthesizes core components and entry points to reduce cognitive overload, not replace deep code review.