skills.rest
529-studio
529-studioOFFICIAL
Explore all skills by this author →
GitHub

code-tour

Generate structured CodeTour JSON artifacts for guided codebase navigation.

2|1|Updated Mar 25, 2026
Search Tags:#architecture#documentation#onboarding#code-review#walkthrough#codetour
One-click install
npx skills add https://github.com/529-studio/Vmarble-Warehouse-Management-Client --skill code-tour-529-studio
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/529-studio/Vmarble-Warehouse-Management-Client/tree/main/.agents/skills/code-tour
Command: npx skills add https://github.com/529-studio/Vmarble-Warehouse-Management-Client --skill code-tour-529-studio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the difficulty of onboarding new team members or explaining complex code paths by creating structured, interactive walkthroughs that guide the reader through specific files and lines of code.

Core Features & Use Cases

  • Guided Walkthroughs: Generate step-by-step tours that open directly to relevant code blocks.
  • Persona-Targeted Narratives: Tailor explanations for specific audiences like new joiners, architects, or PR reviewers.
  • Use Case: Create an architecture tour for a new engineer to explain the request lifecycle in the warehouse management system, or generate a PR tour to highlight critical changes for a reviewer.

Quick Start

Use the code-tour skill to generate an onboarding tour for a new engineer that walks through the core service layer and API entry points.

Frequently Asked Questions about code-tour

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

FAQPage Schema
How do I create a guided walkthrough for onboarding new engineers to a complex codebase?▼

You can create a guided walkthrough by generating structured CodeTour JSON artifacts that provide step-by-step navigation, anchoring narrative explanations to specific file paths and line ranges within your codebase.

What is the best way to document architecture and code paths for pull request reviews?▼

Documenting architecture for PR reviews is best handled by generating guided tours that anchor narrative steps to specific file paths and line ranges, highlighting critical changes directly for the reviewer.

Can I tailor codebase walkthrough narratives for specific audiences like architects or new joiners?▼

Yes, you can tailor codebase walkthrough narratives for specific audiences by targeting persona-specific explanations, ensuring technical accuracy and reader-focused context using the SMIG narrative framework.

How does a structured code tour help explain the request lifecycle in a system?▼

A structured code tour explains the request lifecycle by opening directly to relevant code blocks, guiding the reader step-by-step through core service layers and API entry points with anchored narrative context.

Do I need any specific dependencies to generate CodeTour JSON artifacts for my repository?▼

No specific dependencies are required to generate CodeTour JSON artifacts, as the skill operates independently to produce structured navigation files that map narrative steps to your existing file paths.

Related Skills

Explore More Software Engineering Skills→
JamkrisJamkris
86

code-tour

Create .tour JSON artifacts anchored to files and line ranges for codebase walkthroughs.

Community
Advanced
Patasse97Patasse97

code-tour

Create CodeTour walkthroughs anchored to specific files and lines.

Community
Advanced
forbotsakeforbotsake
5

document-release

Synchronize post-release documentation with code changes after a PR merge.

Official
Advanced
woxiangyangzhimaowoxiangyangzhimao
3

code-tour

Guide step-by-step file and line navigation through codebases.

Community
Advanced