Explica como e por que algo funciona: um arquivo, uma função, um algoritmo ou um fluxo inteiro do sistema. A explicação é didática, não uma leitura de referência.
Uso
/ww:talk:explain src/auth/jwt.ts
/ww:talk:explain src/auth/jwt.ts --level advanced
/ww:talk:explain "como funciona o fluxo de processamento de pagamento?"
Argumentos
| Argumento | Obrigatório? | Descrição |
|---|
<target> | Sim | O que explicar: um arquivo, uma função, um algoritmo, um conceito — ou uma pergunta sobre o comportamento do sistema. |
--level basic|intermediate|advanced | Opcional | A profundidade da explicação: basic, intermediate ou advanced. Calibre pelo público. |
Notas
Toda explicação de código vem com uma analogia, um diagrama, a passagem pelo código e a armadilha comum daquele trecho.
Ao pegar um trecho de código que você não escreveu, ao estudar um fluxo antes de mexer nele, ou ao preparar uma explicação para outra pessoa do time.
- Um arquivo —
src/auth/jwt.ts.
- Uma função, um algoritmo ou um conceito.
- Um comportamento do sistema, em forma de pergunta — “How does the payment processing flow work?”.
Use --level com basic, intermediate ou advanced para calibrar a explicação ao seu público. Sem isso, ele usa o nível padrão.
Toda explicação de código vem com quatro partes, nesta ordem:
- Uma analogia com algo do dia a dia.
- Um diagrama em texto, mostrando o fluxo, a estrutura ou as relações.
- A passagem pelo código, passo a passo.
- Uma armadilha — o erro ou o mal-entendido comum naquele trecho.
O tom é de conversa. Para conceitos difíceis, ele usa mais de uma analogia.
- /ww:talk:ask — para perguntas de “o quê” e “onde”, sem entrar no código
