Lição 5: Estudo de caso: construindo uma Skill de code review
Objetivos de aprendizado:
- Aprender a organizar um fluxo de trabalho com múltiplos passos
- Entender como o padrão de checklist se aplica
- Ganhar confiança no uso de arquivos de apoio
- Construir uma Skill complexa pronta para uso real
Pré-requisitos: << Lição 4 | Próxima: Lição 6 >>
Por que code review é um bom estudo de caso
Code review é um fluxo de trabalho estruturado de manual:1
- Os passos são fixos: checar convenções, procurar problemas, propor mudanças
- Os critérios são mensuráveis: cada item de checagem passa ou não passa
- Repete o tempo todo: todo PR precisa de um
- Combina com uma Skill: escreva os critérios de revisão do seu time em uma Skill e toda revisão mantém o mesmo padrão
Este estudo de caso mostra:
- Como quebrar um fluxo de trabalho complexo em passos claros
- Como organizar instruções em torno de um checklist
- Como lidar com várias dimensões de saída ao mesmo tempo
Passo 1: defina o escopo da revisão
Antes de escrever qualquer coisa, decida o que essa Skill fica responsável por checar.
Nossa Skill de code review cobre três dimensões:
- Convenções: nomenclatura, formatação, comentários
- Problemas potenciais: tratamento de erros, casos-limite, risco de segurança
- Manutenibilidade: código duplicado, tamanho das funções, complexidade lógica
O que ela deliberadamente não checa:
- Se a lógica de negócio está de fato correta (isso exige conhecimento real dos requisitos)
- Eficiência algorítmica (isso exige teste de performance)
- Design de UI/UX (fora do escopo de code review)
Passo 2: crie a estrutura de diretórios
Desta vez vamos usar arquivos de apoio para organizar as regras de revisão:2
Por que separar os arquivos:
- O SKILL.md fica curto e guarda só o fluxo principal
- As regras detalhadas de checagem ficam em arquivos separados, carregadas sob demanda2
- Seu time pode manter cada checklist de forma independente, sem tocar no arquivo principal
Passo 3: escreva o SKILL.md principal
Passo 4: escreva os arquivos de apoio
checklists/naming.md:
checklists/error-handling.md:
Passo 5: teste um caso bagunçado
Prepare um trecho com vários problemas dentro:
Invoque a Skill:
A saída deve incluir:
- ⚠️ Nomenclatura:
process, data, x e y são todos genéricos demais
- ⚠️ Usa
var em vez de const/let
- ⚠️ Usa
== em vez de ===
- ⚠️ Nunca checa se
data é null ou se não é um array
- ⚠️ Nunca checa se
item.value existe
- Sugestão: a função pode ser dividida em funções puras menores
Passo 6: itere
O que a primeira execução costuma revelar:
- Escapes (problemas reais que ela não pegou) → adicione regras de checagem
- Saída longa demais → aperte o formato de saída para reportar só o que importa
- Falsos positivos (código normal sinalizado como problema) → adicione uma categoria “precisa de confirmação”
Continue melhorando:
- Depois de cada revisão, anote quais problemas escaparam
- Atualize os checklists
- Teste de novo
- Em um mês, a Skill fica genuinamente precisa.3
Recapitulação
- Code review é um encaixe natural para uma Skill: passos fixos, critérios mensuráveis, alta repetição
- Organize o fluxo como um checklist: convenções, tratamento de erros, problemas potenciais, manutenibilidade
- Arquivos de apoio mantêm a Skill sustentável: o arquivo principal fica curto, as regras detalhadas ficam por conta própria
- Graduar a saída importa: aprovado, vale uma olhada, precisa corrigir — para quem revisa saber o que fazer primeiro
- Continue iterando: adicione as checagens que faltaram depois de cada revisão, e em um mês ela estará precisa
Na próxima lição passamos aos padrões avançados: skills pessoais versus de projeto, controle de versão e colaboração em time.
Lição 6 >>