Code Tour
Create CodeTour files — persona-targeted, step-by-step walkthroughs of a codebase that link directly to files and line numbers. CodeTour files live in .tours/ and work with the VS Code CodeTour extension.
Overview
A great tour is a narrative — a story told to a specific person about what matters, why it matters, and what to do next. Only create .tour JSON files. Never modify source code.
When to Use This Skill
- User asks to create a code tour, onboarding tour, or architecture walkthrough
- User says "tour for this PR", "explain how X works", "vibe check", "RCA tour"
- User wants a contributor guide, security review, or bug investigation walkthrough
- Any request for a structured walkthrough with file/line anchors
Core Workflow
1. Discover the repo
Before asking anything, explore the codebase:
In parallel: list root directory, read README, check config files.
Then: identify language(s), framework(s), project purpose. Map folder structure 1-2 levels deep. Find entry points — every path in the tour must be real.
If the repo has fewer than 5 source files, create a quick-depth tour regardless of persona — there's not enough to warrant a deep one.
2. Infer the intent
One message should be enough. Infer persona, depth, and focus silently.
| User says |
Persona |
Depth |
| "tour for this PR" |
pr-reviewer |
standard |
| "why did X break" / "RCA" |
rca-investigator |
standard |
| "onboarding" / "new joiner" |
new-joiner |
standard |
| "quick tour" / "vibe check" |
vibecoder |
quick |
| "architecture" |
architect |
deep |
| "security" / "auth review" |
security-reviewer |
standard |
| (no qualifier) |
new-joiner |
standard |
When intent is ambiguous, default to new-joiner persona at standard depth — it's the most generally useful.
3. Read actual files
Every file path and line number must be verified. A tour pointing to the wrong line is worse than no tour.
4. Write the tour
Save to .tours/<persona>-<focus>.tour.
{
"$schema": "https://aka.ms/codetour-schema",
"title": "Descriptive Title — Persona / Goal",
"description": "Who this is for and what they'll understand after.",
"ref": "<current-branch-or-commit>",
"steps": []
}
Step types
| Type |
When to use |
Example |
| Content |
Intro/closing only (max 2) |
{ "title": "Welcome", "description": "..." } |
| Directory |
Orient to a module |
{ "directory": "src/services", "title": "..." } |
| File + line |
The workhorse |
{ "file": "src/auth.ts", "line": 42, "title": "..." } |
| Selection |
Highlight a code block |
{ "file": "...", "selection": {...}, "title": "..." } |
| Pattern |
Regex match (volatile files) |
{ "file": "...", "pattern": "class App", "title": "..." } |
| URI |
Link to PR, issue, doc |
{ "uri": "https://...", "title": "..." } |
Step count
| Depth |
Steps |
Use for |
| Quick |
5-8 |
Vibecoder, fast exploration |
| Standard |
9-13 |
Most personas |
| Deep |
14-18 |
Architect, RCA |
Writing descriptions — SMIG formula
- S — Situation: What is the reader looking at?
- M — Mechanism: How does this code work?
- I — Implication: Why does this matter for this persona?
- G — Gotcha: What would a smart person get wrong?
5. Validate
Personas
| Persona |
Goal |
Must cover |
| Vibecoder |
Get the vibe fast |
Entry point, main modules. Max 8 steps. |
| New joiner |
Structured ramp-up |
Directories, setup, business context |
| Bug fixer |
Root cause fast |
Trigger -> fault points -> tests |
| RCA investigator |
Why did it fail |
Causality chain, observability anchors |
| Feature explainer |
End-to-end |
UI -> API -> backend -> storage |
| PR reviewer |
Review correctly |
Change story, invariants, risky areas |
| Architect |
Shape and rationale |
Boundaries, tradeoffs, extension points |
| Security reviewer |
Trust boundaries |
Auth flow, validation, secret handling |
| Refactorer |
Safe restructuring |
Seams, hidden deps, extraction order |
| External contributor |
Contribute safely |
Safe areas, conventions, landmines |
Narrative Arc
- Orientation —
file or directory step (never content-only first step — blank in VS Code)
- High-level map — 1-3 directory steps showing major modules
- Core path — file/line steps, the heart of the tour
- Closing — what the reader can now do, suggested follow-ups
Anti-Patterns
| Anti-pattern |
Fix |
| File listing — "this file contains the models" |
Tell a story. Each step depends on the previous. |
| Generic descriptions |
Name the specific pattern unique to this codebase. |
| Line number guessing |
Never write a line you didn't verify by reading. |
| Too many steps for quick depth |
Actually cut steps. |
| Hallucinated files |
If it doesn't exist, skip the step. |
| Recap closing — "we covered X, Y, Z" |
Tell the reader what they can now do. |
| Content-only first step |
Anchor step 1 to a file or directory. |
Cross-References
- Related:
engineering/codebase-onboarding — for broader onboarding beyond tours
- Related:
engineering/pr-review-expert — for automated PR review workflows
- CodeTour extension: microsoft/codetour
- Real-world tours: coder/code-server
1---2name: code-tour3description: Creates persona-targeted, step-by-step CodeTour walkthroughs that link to real files and line numbers for onboarding, architecture, PR review, and more.4---56# Code Tour78Create **CodeTour** files — persona-targeted, step-by-step walkthroughs of a codebase that link directly to files and line numbers. CodeTour files live in `.tours/` and work with the [VS Code CodeTour extension](https://github.com/microsoft/codetour).910## Overview1112A great tour is a **narrative** — a story told to a specific person about what matters, why it matters, and what to do next. Only create `.tour` JSON files. Never modify source code.1314## When to Use This Skill1516- User asks to create a code tour, onboarding tour, or architecture walkthrough17- User says "tour for this PR", "explain how X works", "vibe check", "RCA tour"18- User wants a contributor guide, security review, or bug investigation walkthrough19- Any request for a structured walkthrough with file/line anchors2021## Core Workflow2223### 1. Discover the repo2425Before asking anything, explore the codebase:2627In parallel: list root directory, read README, check config files.28Then: identify language(s), framework(s), project purpose. Map folder structure 1-2 levels deep. Find entry points — every path in the tour must be real.2930If the repo has fewer than 5 source files, create a quick-depth tour regardless of persona — there's not enough to warrant a deep one.3132### 2. Infer the intent3334One message should be enough. Infer persona, depth, and focus silently.3536| User says | Persona | Depth |37|-----------|---------|-------|38| "tour for this PR" | pr-reviewer | standard |39| "why did X break" / "RCA" | rca-investigator | standard |40| "onboarding" / "new joiner" | new-joiner | standard |41| "quick tour" / "vibe check" | vibecoder | quick |42| "architecture" | architect | deep |43| "security" / "auth review" | security-reviewer | standard |44| (no qualifier) | new-joiner | standard |4546When intent is ambiguous, default to **new-joiner** persona at **standard** depth — it's the most generally useful.4748### 3. Read actual files4950**Every file path and line number must be verified.** A tour pointing to the wrong line is worse than no tour.5152### 4. Write the tour5354Save to `.tours/<persona>-<focus>.tour`.5556```json57{58 "$schema": "https://aka.ms/codetour-schema",59 "title": "Descriptive Title — Persona / Goal",60 "description": "Who this is for and what they'll understand after.",61 "ref": "<current-branch-or-commit>",62 "steps": []63}64```6566### Step types6768| Type | When to use | Example |69|------|-------------|---------|70| **Content** | Intro/closing only (max 2) | `{ "title": "Welcome", "description": "..." }` |71| **Directory** | Orient to a module | `{ "directory": "src/services", "title": "..." }` |72| **File + line** | The workhorse | `{ "file": "src/auth.ts", "line": 42, "title": "..." }` |73| **Selection** | Highlight a code block | `{ "file": "...", "selection": {...}, "title": "..." }` |74| **Pattern** | Regex match (volatile files) | `{ "file": "...", "pattern": "class App", "title": "..." }` |75| **URI** | Link to PR, issue, doc | `{ "uri": "https://...", "title": "..." }` |7677### Step count7879| Depth | Steps | Use for |80|-------|-------|---------|81| Quick | 5-8 | Vibecoder, fast exploration |82| Standard | 9-13 | Most personas |83| Deep | 14-18 | Architect, RCA |8485### Writing descriptions — SMIG formula8687- **S — Situation**: What is the reader looking at?88- **M — Mechanism**: How does this code work?89- **I — Implication**: Why does this matter for this persona?90- **G — Gotcha**: What would a smart person get wrong?9192### 5. Validate9394- [ ] Every `file` path relative to repo root (no leading `/` or `./`)95- [ ] Every `file` confirmed to exist96- [ ] Every `line` verified by reading the file97- [ ] First step has `file` or `directory` anchor98- [ ] At most 2 content-only steps99- [ ] `nextTour` matches another tour's `title` exactly if set100101## Personas102103| Persona | Goal | Must cover |104|---------|------|------------|105| **Vibecoder** | Get the vibe fast | Entry point, main modules. Max 8 steps. |106| **New joiner** | Structured ramp-up | Directories, setup, business context |107| **Bug fixer** | Root cause fast | Trigger -> fault points -> tests |108| **RCA investigator** | Why did it fail | Causality chain, observability anchors |109| **Feature explainer** | End-to-end | UI -> API -> backend -> storage |110| **PR reviewer** | Review correctly | Change story, invariants, risky areas |111| **Architect** | Shape and rationale | Boundaries, tradeoffs, extension points |112| **Security reviewer** | Trust boundaries | Auth flow, validation, secret handling |113| **Refactorer** | Safe restructuring | Seams, hidden deps, extraction order |114| **External contributor** | Contribute safely | Safe areas, conventions, landmines |115116## Narrative Arc1171181. **Orientation** — `file` or `directory` step (never content-only first step — blank in VS Code)1192. **High-level map** — 1-3 directory steps showing major modules1203. **Core path** — file/line steps, the heart of the tour1214. **Closing** — what the reader can now do, suggested follow-ups122123## Anti-Patterns124125| Anti-pattern | Fix |126|---|---|127| **File listing** — "this file contains the models" | Tell a story. Each step depends on the previous. |128| **Generic descriptions** | Name the specific pattern unique to this codebase. |129| **Line number guessing** | Never write a line you didn't verify by reading. |130| **Too many steps** for quick depth | Actually cut steps. |131| **Hallucinated files** | If it doesn't exist, skip the step. |132| **Recap closing** — "we covered X, Y, Z" | Tell the reader what they can now *do*. |133| **Content-only first step** | Anchor step 1 to a file or directory. |134135## Cross-References136137- Related: `engineering/codebase-onboarding` — for broader onboarding beyond tours138- Related: `engineering/pr-review-expert` — for automated PR review workflows139- CodeTour extension: [microsoft/codetour](https://github.com/microsoft/codetour)140- Real-world tours: [coder/code-server](https://github.com/coder/code-server/blob/main/.tours/contributing.tour)
Alireza Rezvani