[Importante!] - Guia de boas práticas para perguntas inteligentes

[santiagocyl]

Tenho percebido um grande número de tópicos e posts mal elaborados aqui no fórum. Entendo que algumas vezes os mesmos estão assim por falta de experiência dos autores, mas outras vezes percebo uma certa "preguiça" de quem faz a pergunta. Uma pergunta bem elaborada aumenta exponencialmente as suas chances de resposta, e também refinam enormemente o entendimento de outros usuários acerca do seu problema.

Por isso resolvi criar este pequeno guia. Inicialmente tinha pensado em reproduzir aqui o famoso guia Como fazer perguntas inteligentes, mas resolvi apenas linkar, pois o mesmo é ao mesmo muito grande e muito polêmico. Acredito que um tópico mais conciso aumenta as probabilidades de que o mesmo seja lido.

Indo direto ao assunto, se você está usando o back|track, a grande probabilidade é de que a maioria de suas ações são realizadas numa interface de texto. Sendo assim, procure sempre mostrar o que você fez, e o resultado de suas ações usando as tags de código (é o símbolo com o "jogo da velha" ou o "jogo do galo" na tela de edição dos posts). Não usem imagens para isso, elas fazem com que o post demore a carregar e desestimulam a resposta. Além disso, caso alguém queira reproduzir os seus passos para verificar o que está acontecendo, as imagens o impedem de copiar e colar algum texto de interesse, o que só diminui as suas probabilidades de uma resposta. Tão importante quanto utilizar as tags de código, é utilizá-las da forma correta. Observe:

Exemplo do que NÃO fazer:

1º Passo) Muitos guias incluem comentários longos antes de cada trecho de código e comandos a serem executados; é importante que você não envolva estes comentários com as tags de código, pois como estas possuem uma largura fixa, e não iniciam uma nova linha automaticamente, ficarão difícil de ler dentro de uma tag de código.
# echo "Ola mundo!"
# exit

2º Passo) Caso o trecho em questão contenha comentários e trechos de código alternados, não seja preguiçoso, e insira as tags ao redor (somente) dos trechos de código.
# ls -la / | less
# halt

Exemplo do que fazer:
1º Passo) Muitos guias incluem comentários longos antes de cada trecho de código e comandos a serem executados; é importante que você não envolva estes comentários com as tags de código, pois como estas possuem uma largura fixa, e não iniciam uma nova linha automaticamente, ficarão difícil de ler dentro de uma tag de código.

# echo "Ola mundo!"
# exit

2º Passo) Caso o trecho em questão contenha comentários e trechos de código alternados, não seja preguiçoso, e insira as tags ao redor (somente) dos trechos de código.

# ls -la / | less
# halt

As imagens, porém, são úteis em algumas ocasiões especiais, ou quando usar programas com interface gráfica (neste caso não seja preguiçoso e edite a imagem para destacar o aspecto de interesse, com uma seta ou círculo vermelho por exemplo).

Lembre-se de descrever detalhadamente os passos executados por você, os comandos executados e as respostas obtidas (as tags de código são suas amigas) em cada um destes passos. Não se limite a dizer que tem um problema X ou Y, nos mostre o problema. Quanto mais específica for a sua pergunta, mais específica será a resposta.

Descreva com riqueza o ambiente com o qual está trabalhando, pois o mesmo é extremamente importante para que se obtenha uma resposta adequada. Por exemplo, se a sua dúvida está relacionada a algum hardware que não funciona, é muito importante que você diga a versão do driver utilizado, do kernel sendo executado, o modelo da sua placa mãe, como o BIOS está configurado, e como ele pode estar afetando o hardware, etc. Um outro exemplo, se o seu problema envolve uma falha de comunicação através de uma rede, deve dizer como as suas interfaces estão configuradas, como está configurado o subsistema de rede dos seus sistemas, quais são as rotas estabelecidas, como é a topologia da rede que está utilizando, com quais computadores o seu sistema está tentando se comunicar, e qual a configuração dos nós entre o seu sistema e estes computadores, etc.

Pode parecer desanimador ter que escrever tanto para esclarecer um problema que você acredita ser simples; mas se você não é capaz de encontrar a resposta por si mesmo, talvez o problema não seja tão simples assim. Eu mesmo deixo de responder a algumas perguntas porque os usuários não as formulam bem; é muito mais útil, proveitoso e justo que o autor da pergunta tenha o trabalho de enriquecer o post para minimizar o trabalho de quem responde, do que quem responde ter o trabalho de tentar ficar imaginando situações não esclarecidas pelo autor da pergunta, afim de adequar a sua resposta.

Por fim, com o intuito de tornar o fórum cada vez melhor, precisamos da ajuda de todos aqueles que dedicam o seu precioso tempo para responder as dúvidas dos outros usuários. Sejam justos e recíprocos na qualidade de suas respostas: procurem dar ótimas respostas a ótimas perguntas, e lembrem-se que perguntas medíocres merecem respostas medíocres. Vamos recompensar quem fez o dever de casa, e tentar ensinar quem se recusa a fazer.