code-tour

Generate reusable CodeTour .tour JSON artifacts with verified file paths and line numbers.

Updated Mar 26, 2026
One-click install
npx skills add https://github.com/luongldptit/move-ticket --skill code-tour-luongldptit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/luongldptit/move-ticket/tree/main/.agent/skills/code-tour
Command: npx skills add https://github.com/luongldptit/move-ticket --skill code-tour-luongldptit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the inefficiency of ad-hoc, one-off code explanations by generating reusable, step-by-step CodeTour artifacts that anchor directly to real code files and line numbers, making codebase walkthroughs consistent, scalable, and easy to share across teams.

Core Features & Use Cases

  • Persona-Targeted Tours: Automatically adjusts tour depth and focus based on the reader's role, such as new joiner, architect, PR reviewer, or RCA investigator.
  • Verified Code Anchors: All file paths, line numbers, and code selections are validated for existence and accuracy before inclusion, eliminating broken tour steps.
  • Multiple Use Cases: Supports onboarding tours, architecture walkthroughs, PR review tours, root cause analysis tours, security reviews, and feature explanation requests.
  • Narrative Structure: Tours follow a logical story arc instead of flat file listings, guiding readers through orientation, core execution paths, edge cases, and next steps.

Quick Start

Use the code-tour skill to generate a 10-step onboarding tour for the payment service codebase targeted at new backend engineers.

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 codebase walkthrough for onboarding new engineers?

Create a guided codebase walkthrough by generating CodeTour .tour JSON artifacts that anchor step-by-step narrative explanations directly to verified real file paths and line numbers. This provides a structured, reusable onboarding tour instead of flat documentation or ad-hoc chat responses.

Can I generate a CodeTour for a PR review or root cause analysis?

Yes, you can generate a CodeTour for PR reviews, root cause analysis, architecture walkthroughs, security audits, and feature explanation tasks. The tour depth and focus automatically adjust based on the specific reader persona, such as a PR reviewer or RCA investigator.

How do CodeTour files make sure referenced code anchors are not broken?

CodeTour files ensure referenced code anchors are not broken by validating all file paths, line numbers, and code selections for existence and accuracy before inclusion. This validation eliminates broken tour steps and guarantees accurate navigation to the intended code.

What is the best way to document software architecture for new team members?

The best way to document software architecture for new team members is using a narrative story arc tour. Tours guide readers logically through orientation, core execution paths, edge cases, and next steps, which is more effective than flat file listings for explaining complex architecture.

Does the generated CodeTour JSON work with the VS Code extension?

Yes, the generated CodeTour JSON works seamlessly with the CodeTour VS Code extension. The artifacts strictly adhere to the official CodeTour schema, ensuring full compatibility and immediate integration within the VS Code development environment.

How do I structure a codebase tour instead of just listing files?

Structure a codebase tour by following a logical narrative story arc rather than listing files flatly. This approach guides readers sequentially through orientation, core execution paths, edge cases, and next steps, creating a more effective and engaging guided walkthrough.