AGENT SKILL

code-tour

Use when the user asks to create a CodeTour .tour file — persona-targeted, step-by-step walkthroughs that link to real files and line numbers. Trigger for: create a tour, onboarding tour, architecture tour, PR review tour, explain how X works, vibe check, RCA tour, contributor guide, or any structured code walkthrough request.

License 许可
MIT
所属仓库
msm47/Gitskil
最近更新
2026-06-22
Stars
★ 0
Forks
0

01 前言 Front Matter

name
code-tour
description
Use when the user asks to create a CodeTour .tour file — persona-targeted, step-by-step walkthroughs that link to real files and line numbers. Trigger for: create a tour, onboarding tour, architecture tour, PR review tour, explain how X works, vibe check, RCA tour, contributor guide, or any structured code walkthrough request.

03 SKILL.md 正文

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

  • [ ] Every file path relative to repo root (no leading / or ./)
  • [ ] Every file confirmed to exist
  • [ ] Every line verified by reading the file
  • [ ] First step has file or directory anchor
  • [ ] At most 2 content-only steps
  • [ ] nextTour matches another tour's title exactly if set

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

  1. Orientation — file or directory step (never content-only first step — blank in VS Code)
  2. High-level map — 1-3 directory steps showing major modules
  3. Core path — file/line steps, the heart of the tour
  4. 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

04 同仓库更多 Skills

msm47
msm47/Gitskil

syllabus

Generates a curated supplementary reading list from any course syllabus using Consensus academic search. Grill-me intake (syllabus input format + course audience + year range) plus a grouping forcing-options checkpoint before any search runs — so the reading list matches the course's level and recency need. Parses the syllabus to extract topics and learning outcomes, searches Consensus for recent peer-reviewed papers per topic, and produces a professionally formatted .docx with clickable Consensus links, plain-language summaries calibrated to audience level, and Bloom-higher-order discussion questions tied to course learning goals. Triggers whenever a user uploads a syllabus, course outline, or curriculum document and wants supplementary readings. Also triggers on: 'syllabus reading list', 'find papers for my course', 'create a reading list from this syllabus', 'recent research for my class', 'supplementary readings', 'find journal articles for these topics', 'what recent papers cover this material', 'any new research on these course topics', 'update my syllabus with recent papers'. Even casual mentions when a syllabus is attached should trigger this skill.

★ 0
msm47
msm47/Gitskil

research

Default entry point for any research request — a hybrid router that classifies the question deterministically and either delegates to a specialist research skill (pulse for trends/sentiment, grants for NIH funding, litreview for academic literature, syllabus for course reading, patent for prior-art + IP landscape, dossier for entity research) or runs its own plan-decompose-multi-source-search-synthesize-cite fallback workflow when no specialist matches. Always surfaces the routing decision so users can override. Triggers — "research [topic]", "look into [topic]", "what do we know about [topic]", "investigate [topic]", "find me information on [topic]", "do some research on [topic]", "I need to understand [topic]", or any research request that doesn't obviously match a more-specific specialist skill. Output is a markdown briefing (default) or .docx document (on request) with full citations and an audit log.

★ 0
msm47
msm47/Gitskil

pulse

Multi-source recency research skill that takes the pulse of any topic across Reddit, Hacker News, the open web, and optionally X/Twitter within a configurable recent window (default 30 days). Forcing intake clarifies topic specificity, angle (trend/sentiment/problems/opportunities/comparison), time window, and platform scope before searching. Returns a synthesized briefing with citations, engagement metrics, and cross-platform pattern analysis. Triggers: 'pulse on [topic]', 'what's happening with [topic]', 'what are people saying about [topic]', 'current conversation about [topic]', 'take the pulse of [topic]', 'trending: [topic]', 'find me info on [topic]', or any variation requesting multi-source recency intelligence on a topic. Also use for competitor research, trend discovery, tool comparisons, and audience sentiment analysis.

★ 0
msm47
msm47/Gitskil

patent

Patent prior-art and landscape intelligence skill — not generic patent help. Commits to one of five sub-use-cases via forcing intake (novelty search / freedom-to-operate / competitive landscape / acquisition diligence / litigation prior-art) before any search runs. Searches Google Patents, Espacenet, USPTO, and optionally Lens.org for citation-graph signals. Output is an editable Word document (.docx) with verdict, ranked closest art (claim-text extracted), CPC-class-aware landscape, family-resolved hits, geographic coverage, FTO flags where applicable, strategy recommendations, and full audit log. Triggers: 'prior art search for [invention]', 'patent search on [topic]', 'freedom to operate analysis', 'FTO for [product]', 'patent landscape for [field]', 'is [invention] novel', 'patents on [topic]', 'competitive patent analysis', 'prior art for litigation', 'patent diligence on [company]'. Produces search signal, not legal advice — always recommends consulting a patent attorney before filing or licensing decisions. Trademark, copyright, and trade-secret questions are out of scope.

★ 0
msm47
msm47/Gitskil

notebooklm

Browser automation skill for controlling Google's NotebookLM. Handles reading and querying notebooks, adding sources (URLs, text, files, YouTube links, synthesized content), generating Studio outputs (Audio Overview, infographics, slide decks, study guides, briefing docs, mind maps, timelines, FAQs), and creating new notebooks. Triggers on any phrase involving NotebookLM — 'open NotebookLM', 'check my [name] notebook', 'pull info from NotebookLM', 'ask my notebook about X', 'add [source] to NotebookLM', 'create an infographic in NotebookLM', 'use NotebookLM Studio', 'generate a slide deck from my notebook', or any variation where the goal involves NotebookLM. Requires browser automation environment — fails gracefully when unavailable.

★ 0
msm47
msm47/Gitskil

litreview

Academic literature orientation skill that searches papers via Consensus, builds a strategic search plan using PICO (default) or SPIDER / Decomposition / hybrid as fallbacks, and synthesizes findings into a professionally formatted Word document (.docx) research guide. Grill-me intake (research question specificity + framework hint + tentative depth) before the recon search; a second forcing checkpoint after Phase 2 confirms framework + sub-areas + depth before searches consume budget. Configurable depth (5/10/20 queries) controls coverage vs. speed. Output is a 'launching pad' — not a finished review, but an orientation guide that lets a researcher dive in confidently. Triggers: 'litreview on [topic]', 'literature review on [topic]', 'I'm starting a literature review on X', 'I'm writing a paper on X', 'help me research X', 'I'm doing research on X', 'can you help me research X'. Do NOT trigger for single one-off paper searches where the user just wants a quick list — that's a plain Consensus search.

★ 0