[Mini-TUTO] Como fazer um bom tutorial

"Embora pareça, eu não quero criticar nada ou ninguém. Eu gostaria apenas de passar umas dicas pequenas com o intuito de melhorar a edição de alguns tutoriais.

É bem simples e acho que isso melhoraria muito a qualidade dos tutoriais, se fosse 'seguido'."

Dicas de como fazer um bom tutorial.
Por Mr.Rafael
-
• Introdução:

Embora eu não entre com muita frequência, estou sempre por aqui, de visitante, observando o fórum. Até que me deparo com a sessão de tutoriais e... bem, eu acho algo ótimo ver pessoas dedicando seu tempo para nos ensinar coisas novas e ajudar os novatos na criação de jogos.

No entanto, temos toneladas de tutoriais ensinando a criar um "primeiro jogo", ou "uma plataforma". Existem tutoriais que explicam quase a mesma coisa de outro que está a algumas simples colunas atrás. Alguns também não possuem uma boa formatação, fazendo com que não venhamos a entender com clareza o que está escrito. Esse é meu ponto.

#1 - Assunto do tutorial:

Eu sei que vários usuários daqui do fórum gostam de ajudar outras pessoas. Isso é bom, mas antes de ajudarmos em alguma coisa, vamos ver se mais alguém já não havia explicado antes.

Mesmo que não seja proibido, é bom não ter tantos tutoriais repetidos. Assim, a sessão fica mais limpa e consequentemente deixa outras lições mais visíveis. Não quero desmotivar ninguém a criar um tutorial, mas que possa "inovar" um pouco no conteúdo. (existem milhões de tutoriais de "como fazer um primeiro jogo". Você não necessariamente precisaria fazê-lo outra vez)

#2 - Parágrafos e tópicos:

Um tutorial bem organizado requer uma boa separação de linhas e tópicos (como o texto acima). Isso facilita a procura pelo procedimento desejado e o torna mais legível.

Você também pode usar o negrito e o itálico para destacar algumas partes. Pode não parecer muito útil, mas se usado corretamente, permite maior compreensão do texto, destacando palavras-chaves importantes. No caso deste tutorial, eu estou dando espaços em cada parágrafo, para separar melhor os textos. Com essa simples adição, você estará melhorando e muito a sua explicação.

#3 - Imagens:

Imagens são ótimas para ilustrar procedimentos avançados, e às vezes resume o que poderia ser dito com palavras. Isso não é uma coisa que se possa "ensinar a fazer", mesmo porque as imagens são feitas à escolha do usuário. Mas eu gostaria de dar umas pequenas dicas...

Imagens geralmente são mostradas afim de se representar o progresso do conteúdo envolvido. Então, às vezes, não é preciso colocar "sprites-exemplo", ou "um projeto vazio" para ilustrar. Eu recomendo usar imagens quando se estiver em um estado razoável do projeto.

Cheque também o tamanho das imagens e o lugar onde elas vão estar. Quanto melhor for visualizada pela página, mais limpo o seu tutorial fica.

#4 - Linhas de código e DnD:

Isso puxa mais para as dicas #2 e #3, então não há muito o que dizer a respeito. Basta usar a tag

Código:

"[i]Código aqui[/i]"

e para o DnD, imagens com comentários (o símbolo de exclamação) para separar os procedimentos.

O DnD muitas vezes não é tão bem compreendido por meio de imagens, então é uma boa explicar a lógica das funções e a organização delas. Quanto aos códigos, linhas de comentário para facilitar a função delas ajudam, embora eu ainda não veja total necessidade.

• Considerações finais:

Novamente, eu quero deixar claro que não pretendi criticar o ato de postar tutoriais, considero isso até bom para o fórum, pois mostra que temos bons usuários tentando explicar sobre como fazer diversas coisas. Quis apenas dar uns toques sobre como poder melhorar o conteúdo e organizá-lo para facilitar a compreensão.

Esse é um mini-tutorial, então não possui explicações tão bem detalhadas e coisas do tipo. Espero ter sido bem compreendido e ajudado em algum ponto.

o/

Bom o tutorial, isso vai ajudar com que mais tutoriais sejam aprovados!