Skip to content

Guia para fazer boas perguntas e aumentar suas chances de ser lido e respondido

Notifications You must be signed in to change notification settings

marcelluscaio/como-fazer-boas-perguntas

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 

Repository files navigation

Como fazer uma pergunta boa

Nossa comunidade ama ajudar e apoiar pessoas desenvolvedoras de todos os tipos. Para aumentar as suas chances de receber uma boa resposta, aqui vão algumas dicas:

Resumo

  1. Pesquise e teste antes de perguntar;
  2. Certifique-se que está perguntando no canal correto;
  3. Pergunte de forma direta (não peça para perguntar);
  4. Forneça informações detalhadas sobre o seu problema;
  5. Ajude os outros a reproduzir o seu erro;
  6. Acompanhe as respostas

Procure e pesquise

Mantenha registro das suas descobertas. Mesmo que você não encontre uma resposta para o seu problema, incluir links para perguntas semelhantes que não resolveram completamente o seu caso pode ajudar as pessoas a entender como a sua dúvida é diferente das outras.

Tenha certeza de estar no lugar certo

Esse é o canal adequado para essa dúvida? Outras pessoas estão fazendo perguntas semelhantes?

Não peça para perguntar

Não pergunte "Alguém aqui sabe a linguagem 'X'?". Em vez disso, apenas exponha a dúvida que você tem.

Digamos que eu saiba alguma coisa de JavaScript. Quando eu leio a pergunta "Alguém aqui sabe JavaScript?" minha resposta mental é "Depende". Depende de qual problema é para resolver. Digamos ainda que eu não saiba muito bem PHP, mas vejo uma pergunta que por coincidência eu sei a resposta. Se essa pessoa tivesse perguntado "Quem aí sabe PHP?" eu jamais poderia ajudar.

Além disso, evite mandar "Oi", "Bom dia" sem o resto da pergunta. Você pode ser educado e conciso ao mesmo tempo.

Exemplo: "Oi, pessoal! Boa tarde. Eu estou tendo um problema com o meu componente etc..."

Resuma o problema

Comece sua pergunta com um resumo do seu problema. Essa é a primeira coisa que potenciais respondedores verão. Se o problema não for claro, eles não vão ler o resto. Então faça valer a pena, tenha zelo pelo tempo do outro. Na sua pergunta, comece desenvolvendo o seu problema. Explique como você o identificou, e quais dificuldades encontrou ao tentar resolver.

Finja que você está falando com um colega que está ocupado, e você precisa resumir toda sua dúvida em uma frase. Quais detalhes você pode incluir que irão ajudar alguém a identificar e resolver o seu problema? Inclua mensagens de erro, tecnologias utilizadas, ou circunstâncias atípicas que façam a sua pergunta ser diferente de outras perguntas já formuladas.

Atente para a organização, e evite erros de digitação, gramática e pontuação. Isso facilita a leitura e mostra que você respeita os seus interlocutores e está comprometido com a comunidade. Afinal, se você não gasta tempo revisando o que está escrevendo, por que os outros vão gastar tempo lendo o que você escreveu? Lembre-se: essa é a primeira parte da sua dúvida que os outros vão ver, e você quer causar uma boa impressão.

Exemplos

Ruim: Oi pessoal,

npm WARN deprecated [email protected]: CircularJSON is in maintenance only, flatted is its successor. npm WARN [email protected] requires a peer of ajv@^6.9.1 but none is installed. You must install peer dependencies yourself.npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents): npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})

Alguém pode me dizer como resolver esse problema?

Bom: Estou recebendo um erro [ERRO] quando tento instalar o npm package [VERSÃO].

Ruim: Problema com if else no JavaScript

Bom: Estou tentando executar o if else da seguinte maneira [EXEMPLO], eu gostaria que ele desse como resultado X, mas não retorna nada.

Ajude os outros a reproduzir o seu problema

Nem todos os problemas tem a ver com código, mas se seu problema é com um código que você escreveu, você deve compartilhá-lo. Mas não apenas copie e cole todo o código que você tem. Você não quer que a pessoa que está tentando te ajudar passe por linhas e linhas de código não relacionado ao seu problema. Algumas dicas:

Inclua a quantidade certa de código que permita aos outros reproduzirem o seu problema.

Se for possível, crie um exemplo do problema que seja executável (um fragmento do código no codepen, por exemplo).

Não mande fotos do código, mensagens de erro e etc. Copie ou digite o texto na sua pergunta. Apenas utilize imagens para casos em que não seja possíve reproduzir facilmente por texto (a estrutura de diretórios usada no seu projeto, por exemplo).

Após perguntar, acompanhe as respostas

Depois de perguntar, fique de olho nas respostas. Pode ser que você tenha esquecido alguma informação importante, e você pode perder a oportunidade de esclarecer algum ponto. Não envie sua pergunta e suma. Se alguém te responder, esteja pronto para testar e dar feedback. Não faça uma pergunta se você não puder implementar as sugestões naquele momento.

About

Guia para fazer boas perguntas e aumentar suas chances de ser lido e respondido

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published