A internet é hoje um local onde as pessoas recorrem para aprender como executar várias tarefas, processos, dar manutenção, usar um aplicativo, enfim é um local onde encontramos informação de como fazer “coisas”. Estas dicas de como escrever um tutorial, vão te auxiliar a criar bons tutoriais, para sua audiência.
Dicas para Escrever um Tutorial
1. Deixe claro o objetivo. Descreva de forma clara o
que o tutorial vai explicar sobre o assunto, o que a pessoa vai aprender, qual o
objetivo. Escreva um título que deixe claro sobre o que é o tutorial, e faça
uma descrição do que os leitores podem esperar, após finalizar a leitura.
2. Seja claro e conciso. O objetivo principal do
tutorial é ensinar o leitor a fazer alguma "coisa", por exemplo, usar um produto
ou aplicativo. Por esse motivo o tutorial deve ter um conteúdo simples e fácil
de entender. Antes de escrever verifique qual é o conhecimento do leitor. Deixe
claro quais são os pré-requisitos para entender o tutorial, por exemplo se o
leitor não tem conhecimento nenhum do assunto, liste alguns materiais recomendados,
que devem ser lidos antes de usar o tutorial. Se o leitor tem um conhecimento
básico, explique o que o tutorial assume que o leitor já
saiba sobre o assunto, para acompanhar o tutorial.
3. Use figuras. Existe um ditado que diz que uma "imagem vale mais do que mil palavras". Isso é bem verdade no caso de um tutorial.
Para deixar mais claro inclua figuras, detalhando as etapas a serem seguidas,
se for um tutorial sobre um aplicativo, inclua captura de telas com indicações,
como setas, dos locais a que se refere a explicação.
4. Use exemplos. Coloque exemplos para mostrar como
executar a tarefa ou processo que você está explicando. O exemplo facilita o
entendimento, porque ler a teoria de como executar uma tarefa é bem diferente
de executar a tarefa na prática. Com exemplos, o seu tutorial facilita o
entendimento do leitor, e apresenta uma forma prática de testar e aplicar os
conhecimentos obtidos.
5. Use uma estrutura organizada. Existem tutoriais curtos
que podem ser escritos em uma única página, ou em um post de blog, ou tutoriais
mais longos e elaborados que precisam de muitas páginas, e vários tópicos e
subtópicos. Procure sempre estruturar seu tutorial separando os assuntos por
tópicos e subtópicos de forma organizada, com vários passos e ordenados, para
facilitar a leitura e posterior busca por determinado assunto. Para um tutorial
mais longo coloque um índice de tópicos, para que o leitor veja todo o material
que o tutorial trata, e facilite a busca por tópico ou palavra-chave.
6. Inclua uma lista de perguntas frequentes.
Selecione as dúvidas mais frequentes sobre os assuntos do tutorial e monte uma
lista de perguntas frequentes, inclua também aquelas informações que não se
encaixam no fluxo normal do tutorial, a fim de evitar uma quebra nos passos do
tutorial. Assim quando o leitor tiver uma dúvida que é bem comum, ele localiza
com facilidade a resposta. Mantenha a lista de perguntas atualizadas, conforme
for recebendo feedback de outros leitores.
7. Mantenha seu tutorial atualizado. Um tutorial é um
documento que está em constante mudança. Cada vez que o produto ou aplicativo
sofre alguma atualização, o tutorial deve acompanhar as atualizações. Como a
maioria dos tutoriais estão na internet, ao invés de serem impressos, é bem
mais simples manter o documento sempre atualizado.
8. Teste seu tutorial. Após finalizar o tutorial, execute
os passos descritos, para verificar se está claro, e se não existem locais que
podem gerar dúvidas na execução dos passos descritos. Essa é uma forma prática
de verificar se o tutorial está completo. Se possível peça para outras pessoas verificarem
o seu tutorial também, isso ajuda a ver se existem pontos que não estão claros
ou se está faltando alguma informação.
Um tutorial bem escrito, organizado e objetivo facilita o aprendizado das pessoas, que estão à procura de informações, em locais que explicam como executar tarefas, processos, dar manutenção em algum aparelho, ou simplesmente aprender a usar um aplicativo. Espero que estas dicas de como escrever um tutorial ajudem no seu próximo tutorial.
