L’interface est localisée ; les présentations et documents des Skills sont traduits automatiquement par IA dans votre langue. Le code, les commandes, chemins et termes techniques restent en version originale, et le document de l’auteur fait foi.
Explorer les Skills
Développement · SKILL.md

code-tour

code-tour

Use quando o usuário pedir para criar um arquivo CodeTour .tour — walkthroughs passo a passo direcionados a personas que linkam para arquivos reais e números de linha. Gatilho para: criar um tour, tour de integração, tour de arquitetura, tour de revisão de PR, explicar como X funciona, vibe check, tour de RCA, guia do contribuidor, ou qualquer solicitação d…

Independent GitHub snapshot · Automated classification · Original documentation governs

Documentation de la Skill

GitHub

name: "code-tour" description: "Use quando o usuário pedir para criar um arquivo CodeTour .tour — walkthroughs passo a passo direcionados a personas que linkam para arquivos reais e números de linha. Gatilho para: criar um tour, tour de integração, tour de arquitetura, tour de revisão de PR, explicar como X funciona, vibe check, tour de RCA, guia do contribuidor, ou qualquer solicitação de walkthrough de código estruturado." agents:

  • claude-code

Code Tour

Crie arquivos CodeTour — walkthroughs passo a passo direcionados a personas de uma base de código que linkam diretamente para arquivos e números de linha. Os arquivos CodeTour ficam em .tours/ e funcionam com a extensão CodeTour do VS Code.

Visão Geral

Um bom tour é uma narrativa — uma história contada a uma pessoa específica sobre o que importa, por que importa e o que fazer em seguida. Crie apenas arquivos .tour em JSON. Nunca modifique o código-fonte.

Quando Usar Esta Skill

  • Usuário pede para criar um tour de código, tour de integração ou walkthrough de arquitetura
  • Usuário diz "tour para este PR", "explique como X funciona", "vibe check", "tour de RCA"
  • Usuário quer um guia do contribuidor, revisão de segurança ou walkthrough de investigação de bug
  • Qualquer solicitação de walkthrough estruturado com âncoras de arquivo/linha

Workflow Principal

1. Descobrir o repositório

Antes de perguntar qualquer coisa, explore a base de código:

Em paralelo: liste o diretório raiz, leia o README, verifique os arquivos de configuração. Depois: identifique linguagem(s), framework(s), propósito do projeto. Mapeie a estrutura de pastas 1-2 níveis de profundidade. Encontre pontos de entrada — cada caminho no tour deve ser real.

Se o repositório tiver menos de 5 arquivos fonte, crie um tour de profundidade rápida independentemente da persona — não há conteúdo suficiente para justificar um tour profundo.

2. Inferir a intenção

Uma mensagem deve ser suficiente. Infira persona, profundidade e foco silenciosamente.

O usuário dizPersonaProfundidade
"tour para este PR"pr-reviewerpadrão
"por que X quebrou" / "RCA"rca-investigatorpadrão
"integração" / "novo integrante"new-joinerpadrão
"tour rápido" / "vibe check"vibecoderrápido
"arquitetura"architectprofundo
"segurança" / "revisão de auth"security-reviewerpadrão
(sem qualificador)new-joinerpadrão

Quando a intenção for ambígua, padrão para persona new-joiner com profundidade padrão — é a mais geralmente útil.

3. Ler os arquivos reais

Todo caminho de arquivo e número de linha deve ser verificado. Um tour apontando para a linha errada é pior do que nenhum tour.

4. Escrever o tour

Salve em .tours/<persona>-<foco>.tour.

{
  "$schema": "https://aka.ms/codetour-schema",
  "title": "Título Descritivo — Persona / Objetivo",
  "description": "Para quem é isso e o que eles entenderão depois.",
  "ref": "<branch-ou-commit-atual>",
  "steps": []
}

Tipos de passo

TipoQuando usarExemplo
ContentApenas intro/encerramento (máx. 2){ "title": "Bem-vindo", "description": "..." }
DirectoryOrientar para um módulo{ "directory": "src/services", "title": "..." }
File + lineO cavalo de batalha{ "file": "src/auth.ts", "line": 42, "title": "..." }
SelectionDestacar um bloco de código{ "file": "...", "selection": {...}, "title": "..." }
PatternCorrespondência regex (arquivos voláteis){ "file": "...", "pattern": "class App", "title": "..." }
URILink para PR, issue, doc{ "uri": "https://...", "title": "..." }

Contagem de passos

ProfundidadePassosUsar para
Rápido5-8Vibecoder, exploração rápida
Padrão9-13A maioria das personas
Profundo14-18Architect, RCA

Escrevendo descrições — fórmula SMIG

  • S — Situação: O que o leitor está olhando?
  • M — Mecanismo: Como este código funciona?
  • I — Implicação: Por que isso importa para esta persona?
  • G — Armadilha: O que uma pessoa inteligente erraria?

5. Validar

  • Todo caminho de file relativo à raiz do repo (sem / inicial ou ./)
  • Todo file confirmado como existente
  • Todo line verificado lendo o arquivo
  • Primeiro passo tem âncora file ou directory
  • No máximo 2 passos somente de conteúdo
  • nextTour corresponde ao title de outro tour exatamente, se definido

Personas

PersonaObjetivoDeve cobrir
VibecoderCaptar o vibe rapidamentePonto de entrada, módulos principais. Máx. 8 passos.
New joinerRamp-up estruturadoDiretórios, configuração, contexto de negócio
Bug fixerCausa raiz rapidamenteGatilho -> pontos de falha -> testes
RCA investigatorPor que falhouCadeia de causalidade, âncoras de observabilidade
Feature explainerPonta a pontaUI -> API -> backend -> armazenamento
PR reviewerRevisar corretamenteHistórico de mudanças, invariantes, áreas de risco
ArchitectForma e razãoLimites, trade-offs, pontos de extensão
Security reviewerLimites de confiançaFluxo de auth, validação, manipulação de segredos
RefactorerReestruturação seguraJunções, dependências ocultas, ordem de extração
External contributorContribuir com segurançaÁreas seguras, convenções, armadilhas

Arco Narrativo

  1. Orientação — passo file ou directory (nunca passo somente de conteúdo primeiro — fica em branco no VS Code)
  2. Mapa de alto nível — 1-3 passos de diretório mostrando módulos principais
  3. Caminho principal — passos de arquivo/linha, o coração do tour
  4. Encerramento — o que o leitor agora pode fazer, acompanhamentos sugeridos

Anti-Padrões

Anti-padrãoCorreção
Listagem de arquivos — "este arquivo contém os modelos"Conte uma história. Cada passo depende do anterior.
Descrições genéricasNomeie o padrão específico único desta base de código.
Adivinhar números de linhaNunca escreva uma linha que não verificou lendo.
Muitos passos para profundidade rápidaRealmente corte passos.
Arquivos alucinadosSe não existe, pule o passo.
Encerramento de recapitulação — "cobrimos X, Y, Z"Diga ao leitor o que ele agora pode fazer.
Passo somente de conteúdo como primeiroAncore o passo 1 a um arquivo ou diretório.

Referências Cruzadas

  • Relacionado: engineering/codebase-onboarding — para integração mais ampla além dos tours
  • Relacionado: engineering/pr-review-expert — para workflows de revisão de PR automatizados
  • Extensão CodeTour: microsoft/codetour
  • Tours do mundo real: coder/code-server
Skills enregistrées