agentkitco/agentkit-dev-skills

Cria um mapa de onboarding de um repositório desconhecido, cobrindo propósito, pontos de entrada, como executá-lo, módulos principais, fluxo de dados e áreas arriscadas, com referências a arquivos. Use quando for solicitado a explicar, mapear ou fazer onboarding de uma base de código.

O que é agentkit-dev-skills?

Esta skill permite que um agente de IA (como Claude Code, Cursor, Codex) analise sistematicamente um repositório de código desconhecido e produza um mapa detalhado e confiável para um novo desenvolvedor. Ela guia o agente por uma ordem de exploração lógica: entender o propósito e os usuários, descobrir como executar e testar o projeto, mapear a estrutura de diretórios, identificar pontos de entrada, traçar um fluxo real do começo ao fim, documentar dados, configurações e serviços externos, e avaliar a qualidade do código (testes, linters, áreas com TODO, arquivos grandes e alterações recentes). O resultado final é um relatório conciso e acionável, no formato especificado, que cita arquivos e linhas para cada afirmação. É útil sempre que um desenvolvedor precisa de uma visão geral rápida e confiável de um código-fonte desconhecido, seja para onboarding, revisão de arquitetura ou auditoria.

Funciona com~Claude Code~Codex CLI~Cursor

npx skills add https://github.com/agentkitco/agentkit-dev-skills/tree/HEAD/skills/explain-codebase

Documentação

Explicar uma base de código desconhecida

Objetivo: fornecer a um recém-chegado um mapa confiável, com referências a arquivos, em algumas páginas. Cada afirmação deve apontar para um arquivo que você leu.

Explorar nesta ordem

Propósito e usuários: README, descrição do pacote, índice da documentação. Que problema isso resolve e para quem?
Executar: comandos de instalação, execução e teste a partir de manifestos, Makefile e configuração de CI. Execute os comandos baratos (testes, lint) para confirmar que funcionam; diga quais você não executou.
Estrutura: árvore de diretórios com dois níveis de profundidade (ignore node_modules, saída de build, .git). Anote linguagem(ns), framework(s), layout de monorepo.
Pontos de entrada: main, arquivo de inicialização do servidor, entrada de CLI, definições de rota, tarefas agendadas, manipuladores de eventos, entradas bin e scripts.
Rastrear um fluxo real do início ao fim: escolha a requisição, comando ou evento mais central e siga-o desde a entrada até o armazenamento ou saída, listando cada arquivo e função em ordem.
Dados: esquemas, modelos, migrações, arquivos de configuração, variáveis de ambiente que o código lê (apenas nomes, nunca valores).
Pontos de contato externos: bancos de dados, filas, APIs de terceiros, provedores de autenticação.
Sinais de qualidade: onde os testes vivem e o que cobrem, verificações de CI, regras de lint, áreas com TODOs, arquivos muito grandes, alterações recentes (git log --since="3 meses atrás" --name-only --pretty=format: | sort | uniq -c | sort -rn | head).

Saída

# <repositório> em uma página
Propósito: ...
Como executar: <comandos, verificados ou não>
Mapa: <diretório -> responsabilidade, uma linha cada>
Um fluxo, passo a passo: <arquivo:função ...>
Dados e configuração: ...
Serviços externos: ...
Por onde começar a ler: <3 arquivos em ordem, com o motivo>
Áreas arriscadas ou confusas: <arquivo, motivo>
Perguntas em aberto: <o que você não conseguiu determinar>

Regras

Cite caminho:linha ou pelo menos caminho para cada afirmação. Se você inferiu algo, rotule como "inferido".
Não descreva código que você não abriu. Não adivinhe o contexto de negócios; coloque isso em perguntas em aberto.
Nunca imprima valores secretos de arquivos .env ou configuração; liste apenas nomes de variáveis.
Mantenha curto: um mapa, não um tour por cada arquivo.