Pular para o conteúdo
Rizzygo Ako
Voltar para o tópico Inglês para ler documentação

Inglês para ler documentação

Para começar em TI você precisa ler inglês, não falar fluente. Esta lição mostra como ler documentação e mensagens de erro com estratégia, as palavras que mais aparecem e como usar o tradutor sem depender dele.

Cerca de 50 minutosNada para instalarMaterial gratuito em português

1. Ler é a primeira habilidade

A documentação oficial das ferramentas, as mensagens de erro, as respostas em fóruns e as notas de versão quase sempre saem primeiro em inglês. Às vezes, só existem em inglês. Ler bem já resolve a maior parte do que você vai precisar no começo da carreira.

Leitura técnica é mais fácil do que parece. O texto é direto, repete as mesmas estruturas e usa um vocabulário limitado. Com estratégia e um glossário pessoal, em poucas semanas você lê uma página de documentação sem traduzir tudo.

2. Você já sabe mais do que imagina

Cognatos são palavras parecidas nas duas línguas, com o mesmo sentido. Em textos técnicos, eles aparecem o tempo todo:

InglêsPortuguês
configurationconfiguração
installationinstalação
connectionconexão
permissionpermissão
variablevariável
functionfunção
processprocesso
automaticallyautomaticamente

Repare nos finais: -tion costuma virar -ção, -ly costuma virar -mente, -ble costuma virar -vel. Muitos termos técnicos, como software, backup, login e deploy, já são usados em inglês no dia a dia de TI no Brasil.

3. Falsos cognatos que confundem em TI

Algumas palavras parecem conhecidas, mas significam outra coisa. Estas aparecem muito em documentação:

PalavraPareceQuer dizer
actuallyatualmentena verdade
eventuallyeventualmenteno fim, mais cedo ou mais tarde
librarylivrariabiblioteca (de código)
datadatadados (data do calendário é date)
argumentargumento de discussãovalor passado para uma função ou comando
pushpuxarempurrar, enviar (no Git, mandar commits para o servidor). O contrário é pull, puxar: baixar commits
deprecateddepreciado, desvalorizadoobsoleto: ainda funciona, mas não é mais recomendado e pode ser removido
assignassinaratribuir (um valor a uma variável, uma tarefa a alguém)
supportsuportar, aguentardar suporte, ser compatível com

4. Ler em camadas: passar o olho, achar, aprofundar

Ninguém lê documentação de cima a baixo, palavra por palavra. Leia em três camadas:

  1. Passar o olho (skimming): leia só o título, os subtítulos, os blocos de código e o que estiver em destaque. Em um minuto, você sabe do que a página trata e se ela serve.
  2. Achar (scanning): procure a informação que você precisa. Use Ctrl+F (Cmd+F no Mac) com a palavra-chave: o nome do comando, da opção ou do erro.
  3. Aprofundar: leia com atenção só o trecho que importa. Aqui vale parar nas palavras novas e anotar.

Os blocos de código ajudam muito: eles mostram o que fazer mesmo quando o texto em volta parece difícil.

Faça agoraAbra a página An Informal Introduction to Python (documentação oficial). Em um minuto, só pelos subtítulos e exemplos, diga quais três assuntos ela cobre. Depois use Ctrl+F para achar a palavra string.

5. Como uma documentação é organizada

A maioria das documentações segue o mesmo desenho. Saber onde cada coisa fica economiza tempo:

SeçãoO que você encontra
Getting started, QuickstartO caminho mais curto para instalar e ver funcionando
TutorialUm passo a passo guiado, para aprender
How-to guidesReceitas para tarefas específicas
Reference, API referenceTodas as opções, comandos e funções, para consultar
Concepts, ExplanationComo e por que a ferramenta funciona assim
Troubleshooting, FAQProblemas comuns e como resolver
Release notes, ChangelogO que mudou em cada versão

Também repare nas caixas Note (observação), Tip (dica), Warning e Caution (cuidado) e Important. As de aviso costumam dizer o que pode quebrar algo.

Documentações usam muito o imperativo: Run (rode), Install (instale), Make sure (garanta que), Replace (substitua). Quando aparece algo como <your-name> ou YOUR_API_KEY, é um lugar para você trocar pelo seu valor.

6. Ler mensagens de erro

Mensagens de erro parecem assustadoras, mas costumam dizer exatamente o que aconteceu. Leia com calma, procurando três coisas: o que falhou, onde e por quê.

Exemplo no terminal:
cp: cannot stat 'relatorio.txt': No such file or directory

O programa cp não conseguiu ler (cannot stat) o arquivo relatorio.txt porque não existe arquivo ou pasta com esse nome (No such file or directory). Provavelmente você está na pasta errada ou digitou o nome errado.

Exemplo em Python:
Traceback (most recent call last):
  File "gastos.py", line 3, in <module>
    total = total + valor
NameError: name 'total' is not defined

Em Python, a linha mais importante é a última: NameError, o nome total não foi definido (is not defined). As linhas acima dizem onde: no arquivo gastos.py, linha 3. A variável foi usada antes de receber um valor.

Faça agoraNo terminal, rode um comando com um nome de arquivo que não existe, como cat naoexiste.txt. Leia a mensagem e explique o que ela diz, palavra por palavra.

7. As palavras que mais aparecem

Comece seu glossário com estas. Elas aparecem em erros, logs (os registros do que um programa fez) e documentação de quase toda ferramenta:

InglêsEm português
not foundnão encontrado
permission denied, forbiddenpermissão negada, proibido
failed, failurefalhou, falha
timeout, timed outtempo esgotado
invalid, missinginválido, faltando
expected ... but got ...esperava ... mas recebeu ...
unable to, cannotnão foi possível
already existsjá existe
warningaviso: algo pode dar errado, mas o programa seguiu
required, optionalobrigatório, opcional
defaultpadrão, o valor usado quando você não informa outro
run, executerodar, executar
buildconstruir, gerar a versão pronta para rodar
deploypublicar, colocar no ar
rollbackvoltar para a versão anterior
retrytentar de novo
upgrade, updateatualizar
issueproblema, ou um tópico aberto para discutir um problema
workaroundcontorno, solução provisória
out of memory, disk fullsem memória, disco cheio

Monte o seu num arquivo de texto ou num aplicativo de flashcards, com três colunas: a palavra, o sentido e a frase onde você a encontrou. A frase ajuda a lembrar.

8. Tradutor e IA: apoio, não muleta

9. Um hábito de 15 minutos por dia

Falar e ouvir vêm depois e também importam, principalmente para vagas em empresas de fora. Mas ler bem já abre muitas portas.

Para fixarPegue uma mensagem de erro real que apareceu para você e explique para alguém o que ela diz e o que fazer. Depois, marque no tópico que você ensinou alguém.

Lição escrita em português pela Iniciativa Ako, da Rizzygo. As estratégias de leitura seguem as técnicas de inglês instrumental ensinadas em cursos técnicos brasileiros, como no caderno Inglês Instrumental da Rede e-Tec Brasil, e a divisão da documentação segue o modelo Diátaxis (em inglês). O texto e os exemplos são próprios.

Conteúdo aberto sob a licença CC BY 4.0. Viu um erro? Abra uma issue.