Como Escrever um Tutorial

Descreva cada passo cuidadosamente. Os detalhes são importantes. Descreva exatamente como executar cada passo. Salvo algumas exceções, os tutoriais mais detalhados são os melhores.

Compreenda a diferença entre um tutorial e uma obra para referência.Referências também são muito úteis, mas são bem diferentes dos tutoriais. Infelizmente, a maioria dos tutoriais acaba se tornando uma, pois obras de referência são mais fáceis de escrever.

• Ao descrever o objeto em si, em vez de descrever como usá-lo, você está escrevendo uma obra de referência. Um exemplo seria fazer uma lista exaustiva de todos os botões de um programa de computador e seus funcionamentos. Isso seria descrever o programa.
• Quando você assume que o usuário quer aprender a instalar o programa, criar um arquivo e depois salvá-lo, as instruções serão completamente diferentes. Quando você fornece detalhes do processo, alerta contra erros comuns, responde perguntas e explica algumas teorias essenciais, está a caminho de escrever um ótimo tutorial.

Escreva as instruções com profissionalismo. Use um tom amigável e profissional. Há muitas maneiras de minar o profissionalismo da sua escrita. Cuidado para não fugir do assunto. Atenha-se ao tema discutido e evite escrever sobre sua vida pessoal. Isso não quer dizer que você precisa abrir mão de colocar personalidade no seu texto, apenas que deve levar o profissionalismo em conta ao fazer isso.

Cite suas fontes. Ao escrever um tutorial, é muito importante levar em conta os direitos autorais. A menos que você esteja usando suas próprias informações, e tenha tirado suas próprias fotos, você precisa citar suas fontes.

Obtenha alguma prática no tema do seu tutorial. Crie cada passo com base na sua experiência. Uma boa abordagem é criar seu projeto e registar cada passo que você segue até conclui-lo.

Crie screenshots ou faça vídeos. A forma mais simples de tirar um screenshot é usar as ferramentas e atalhos do seu computador. Pressione Ctrl + Print screen para fotografar o conteúdo da sua tela e use um programa de imagem (como o Photoshop) para editar as imagens, caso seja necessário. Você também pode fazer um vídeo para acompanhar seu tutorial. Use programas como o Camtasia, ou um programa de código aberto, como o Camstudio. Escolha um e aprenda a usá-lo.

Revise seu tutorial. Tenha seu público em mente. Para que tipo de pessoas você está fazendo este tutorial? Iniciantes ou usuários avançados? Ao responder estas perguntas, você pode refinar seu tutorial e resolver vários tipos de problemas.

Edite e aperfeiçoe seu tutorial. Procure por problemas de lógica ou erros gramaticais. Certifique-se de que o tutorial tenha uma estrutura sequencial e compreensível. Escreva com o máximo de clareza possível.