code-tour

Generates persona-based guided codebase walkthroughs with file and line anchors.

1|Updated Aug 17, 2026
One-click install
npx skills add https://github.com/NalinDalal/skillset --skill code-tour-nalindalal
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/NalinDalal/skillset/tree/main/skills/architecture/code-tour
Command: npx skills add https://github.com/NalinDalal/skillset --skill code-tour-nalindalal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? New team members and reviewers struggle to understand unfamiliar codebases, and architecture knowledge often lives only in senior engineers' heads. This Skill produces structured, step-by-step code tours that document how a system actually works. ## Core Features & Use Cases - Persona-Tailored Tours: Generates walkthroughs for eight personas including new-joiner, architect, pr-reviewer, security-reviewer, and rca-investigator, each with appropriate depth and focus. - SMIG Writing Structure: Every section follows Situation, Mechanism, Implication, Gotcha so explanations cover both how code works and what to watch out for. - File and Line Anchors: Tours reference real code locations (e.g., apps/api/src/routes/orders.ts:67) and support @tour code annotations to keep documentation connected to source. - Use Case: A new engineer joins your team. Generate a new-joiner tour of your monorepo covering the module map, the core order-placement code path, edge cases like inventory race conditions, and suggested next files to explore. ## Quick Start Ask the agent to create a code tour of this repository for a new joiner, covering the module map, core code path, and edge cases.

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 codebase walkthrough for new team members?▼

Generate a code tour using the new-joiner persona, which produces a high-level overview covering orientation, module map, the core code path with file and line references, edge cases, and suggested next files to explore.

What is the SMIG rule for writing code documentation?▼

SMIG stands for Situation, Mechanism, Implication, Gotcha. Each tour section states what is happening, how it works, why it matters, and what to watch out for, ensuring explanations cover both behavior and risks.

Can code tours be tailored for security reviewers or architects?▼

Yes, eight personas are supported including security-reviewer (attack surfaces, auth flows), architect (system design, trade-offs), pr-reviewer, rca-investigator, and bug-fixer, each with different depth and focus areas.

How do I keep code tour documentation in sync with source code?▼

Add @tour annotations directly in source code comments marking important functions with tour name, step number, persona, and gotchas. Update file references and line numbers in the tour after code changes.

When should I use a code tour instead of regular documentation?▼

Use code tours for guided, persona-specific walkthroughs of complex systems and onboarding. Use general documentation for API references or standalone concepts that do not require a sequential path through the codebase.