skills.rest
zvadaadam
zvadaadamCOMMUNITY
Explore all skills by this author →
𝕏@adamzvadaGitHub

tour

Generate a self-contained HTML tour explaining a codebase subsystem.

47|5|Updated Apr 13, 2026
Search Tags:#architecture#documentation#codebase#engineering#explorer#tour#html-tour
One-click install
npx skills add https://github.com/zvadaadam/az-skills --skill tour-zvadaadam
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tour
Source: https://github.com/zvadaadam/az-skills/tree/main/skills/engineering/tour
Command: npx skills add https://github.com/zvadaadam/az-skills --skill tour-zvadaadam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces a self-contained HTML tour that explains a codebase subsystem without requiring readers to read the source code themselves.

Core Features & Use Cases

  • Synthesize parallel explorer findings into a cohesive HTML tour with inline diagrams and a readable narrative.
  • Provide a structured overview, including an overview, key concepts, how it works, and a file map to facilitate onboarding and maintenance.
  • Offer optional critique mode to surface architectural issues and improvement ideas.

Quick Start

Provide a target subsystem question and let the tour generator produce a standalone HTML tour document.

Frequently Asked Questions about tour

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

FAQPage Schema
How do I generate an HTML codebase tour for onboarding new engineers?▼

Generate an HTML codebase tour by providing a target subsystem question, and the tool synthesizes parallel explorer findings into a self-contained HTML document with inline diagrams, a narrative, and a file map for quick onboarding.

What is the best way to explain a complex codebase architecture without forcing readers to read the source code?▼

The best way to explain codebase architecture without reading source code is generating a self-contained HTML tour that coordinates parallel explorer findings to synthesize a unified narrative, visual diagrams, and a structured file map.

Can I automatically surface architectural issues and improvement ideas for my codebase?▼

Yes, you can automatically surface architectural issues by enabling the optional critique mode, which analyzes the codebase subsystem during the HTML tour generation process to highlight architectural problems and suggest improvements.

Does the generated codebase documentation include a file map for navigation?▼

Yes, the generated codebase documentation includes a structured file map alongside an overview, key concepts, and a how it works section, providing a browser-friendly HTML document that facilitates quick comprehension and maintenance.

How do I create self-contained codebase documentation for offline viewing?▼

Create self-contained codebase documentation by running the tour generator with a target subsystem prompt, which outputs a standalone browser-friendly HTML document that can be opened directly without requiring external dependencies or a server.

What are the limitations of using an automated HTML tour for codebase exploration?▼

The automated HTML tour synthesizes findings from parallel explorers into a static document, meaning it provides a snapshot of the codebase subsystem at generation time and does not offer real-time interactive codebase exploration or dynamic updates.

Related Skills

Explore More Software Engineering Skills→
riezriez
1

code-exploration

Coordinate one-question-at-a-time code exploration before implementation.

Community
Intermediate
PaddlePaddlePaddlePaddle
3.7k

research-report

Generate a self-contained HTML research report with embedded CSS and Mermaid diagrams.

Official
Advanced
mattfletcher94mattfletcher94
1

festina-map-engineering

Map codebase subsystems, data flows, and dependencies into engineering docs.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate