Este post foi escrito a partir de uma ideia/sugestão de Ingrid Amorim.


A ideia de escrever um tutorial sobre como escrever tutoriais pode parecer um pouco reduntante e estúpida (talvez seja mesmo), mas em um panorama geral pode ser útil para algumas pessoas.

Tema

Antes de tudo, você precisa saber o que vai escrever. Se o tutorial for sobre Ubuntu, por exemplo, você precisa ter experiência com o sistema, ter testado a solução apresentada, saber que ela funciona independente de variáveis que você não deixar explícitas no seu texto.

Se você for escrever um tutorial que vai abordar vários temas, talvez seja melhor separar o texto em vários textos menores que juntos formam um guia.

Ainda nesse tópico, se o tema de seu tutorial já tiver sido abordado por outra pessoa e seu texto não for acrescentar nada de novo ou não trouxer uma solução melhor, não é melhor criar um link para o artigo original ao invés de escrever tudo de novo?

Métodos de escrita

Pegue um livro de receitas qualquer. Lá estarão os melhores exemplos de tutorial que você pode achar.

Na maioria das vezes as informação são dadas de forma clara, em sentença curtas, com exemplos e imagens. Todos os ingredientes são listados no começo do texto.

Tente aplicar o mesmo modelo: liste tudo que será necessário no começo e dê as informações de como proceder ao longo do texto, na sequência adequada. Sempre que possível forneça imagens e exemplos práticos.

Também é importante que você deixe claro no título e no primeiro parágrafo o que você irá tratar no seu tutorial. Assim o leitor não corre o risco de ler um texto desnecessário, nem de deixar de ler o seu tutorial porque ele não notou que este podia ajudá-lo.

Plataforma

A maioria das pessoas diria que esse é um item de vital importância, mas no geral isso não é tão relevante. Não importa se seu texto seja para um blog, fórum ou documentação de um produto. O importante é escrever o texto e divulgá-lo na plataforma mais prática e simples que estiver ao seu alcance.

Não perca tempo planejando qual será a sua plataforma de blogging, formatando o texto e em outras coisas menores, enquanto o principal é escrever.

Revisão

Não importa quão bom que seu tutorial tenha ficado. Após uma leitura atenciosa você verá que existe algo que pode ser melhorado, acrescentado ou retirado.

Prese sempre pela ortografia e gramática. É extremamente irritante ler um texto com erros de português. Cuide também da pontução. Não se esqueça de dividir o texto em parágrafos e organizar esses parágrafos em subtítulos.

Finalizando

Acredito que seguindo alguns destes princípios, é possível escrever tutoriais melhores e mais úteis. E você, tem alguma sugestão sobre como escrever um tutorial?