协作头脑风暴
brainstorming
在实现前澄清需求、探索设计选择,并形成清晰的开发方向。
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 solici…
独立 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:
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.
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.
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.
Uma mensagem deve ser suficiente. Infira persona, profundidade e foco silenciosamente.
| O usuário diz | Persona | Profundidade |
|---|---|---|
| "tour para este PR" | pr-reviewer | padrão |
| "por que X quebrou" / "RCA" | rca-investigator | padrão |
| "integração" / "novo integrante" | new-joiner | padrão |
| "tour rápido" / "vibe check" | vibecoder | rápido |
| "arquitetura" | architect | profundo |
| "segurança" / "revisão de auth" | security-reviewer | padrão |
| (sem qualificador) | new-joiner | padrão |
Quando a intenção for ambígua, padrão para persona new-joiner com profundidade padrão — é a mais geralmente útil.
Todo caminho de arquivo e número de linha deve ser verificado. Um tour apontando para a linha errada é pior do que nenhum 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": []
}
| Tipo | Quando usar | Exemplo |
|---|---|---|
| Content | Apenas intro/encerramento (máx. 2) | { "title": "Bem-vindo", "description": "..." } |
| Directory | Orientar para um módulo | { "directory": "src/services", "title": "..." } |
| File + line | O cavalo de batalha | { "file": "src/auth.ts", "line": 42, "title": "..." } |
| Selection | Destacar um bloco de código | { "file": "...", "selection": {...}, "title": "..." } |
| Pattern | Correspondência regex (arquivos voláteis) | { "file": "...", "pattern": "class App", "title": "..." } |
| URI | Link para PR, issue, doc | { "uri": "https://...", "title": "..." } |
| Profundidade | Passos | Usar para |
|---|---|---|
| Rápido | 5-8 | Vibecoder, exploração rápida |
| Padrão | 9-13 | A maioria das personas |
| Profundo | 14-18 | Architect, RCA |
file relativo à raiz do repo (sem / inicial ou ./)file confirmado como existenteline verificado lendo o arquivofile ou directorynextTour corresponde ao title de outro tour exatamente, se definido| Persona | Objetivo | Deve cobrir |
|---|---|---|
| Vibecoder | Captar o vibe rapidamente | Ponto de entrada, módulos principais. Máx. 8 passos. |
| New joiner | Ramp-up estruturado | Diretórios, configuração, contexto de negócio |
| Bug fixer | Causa raiz rapidamente | Gatilho -> pontos de falha -> testes |
| RCA investigator | Por que falhou | Cadeia de causalidade, âncoras de observabilidade |
| Feature explainer | Ponta a ponta | UI -> API -> backend -> armazenamento |
| PR reviewer | Revisar corretamente | Histórico de mudanças, invariantes, áreas de risco |
| Architect | Forma e razão | Limites, trade-offs, pontos de extensão |
| Security reviewer | Limites de confiança | Fluxo de auth, validação, manipulação de segredos |
| Refactorer | Reestruturação segura | Junções, dependências ocultas, ordem de extração |
| External contributor | Contribuir com segurança | Áreas seguras, convenções, armadilhas |
file ou directory (nunca passo somente de conteúdo primeiro — fica em branco no VS Code)| Anti-padrão | Correção |
|---|---|
| Listagem de arquivos — "este arquivo contém os modelos" | Conte uma história. Cada passo depende do anterior. |
| Descrições genéricas | Nomeie o padrão específico único desta base de código. |
| Adivinhar números de linha | Nunca escreva uma linha que não verificou lendo. |
| Muitos passos para profundidade rápida | Realmente corte passos. |
| Arquivos alucinados | Se 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 primeiro | Ancore o passo 1 a um arquivo ou diretório. |
engineering/codebase-onboarding — para integração mais ampla além dos toursengineering/pr-review-expert — para workflows de revisão de PR automatizados