O grande problema de uma documentação criada por uma comunidade é que nem sempre essa documentação é detalhada ou explicada o suficiente para que usuários de vários níveis possam entender. Não fiz muitos tutoriais na vida, mas já li milhares deles para conseguir realizar tarefas, e já vi coisas absurdas, que simplesmente mandam-nos seguir uma série de instruções sem dizer para que elas servem, o que vão fazer em nossas máquinas. Se a pessoa foi parar neste tutorial, é porque ela já procurou na web, e espera encontrar a informação lá.
Na maioria das vezes, o autor do tutorial o fez de boa intenção, querendo contribuir com a comunidade da qual participa e é fiel entusiasta, mas não soube transmitir a mensagem de forma clara. Esse autor bem que poderia dar uma lidinha neste tutorial que segue abaixo. Nada definitivo, talvez incompleto, mas uma dica para quem quer dar dicas para os outros.
1. O título deve ser claro
O usuário precisa ver o título de seu artigo e pensar: "É disso que eu preciso!" Seu título não precisa dar explicações detalhadas, deixe isso para mais tarde. Apenas escreva, por exemplo, "Configurar [nome do dispositivo] no [nome do sistema operacional]", ou então "Como fazer [tarefa a ser realizada]". Simples e objetivo.
2. Escreva um texto introdutório
Nem sempre o título é suficiente, ou pode o ser apenas para usuários mais experimentados. De três a cinco linhas, ou mais, depende do assunto, com algumas palavrinhas explicativas a respeito, para que o usuário saiba se é disso mesmo que ele precisa. Às vezes acontece de terminar o procedimento e descobrir que não era bem aquilo, ou mesmo outros problemas surgirem por falta dessa uma informação.3. Divida a ação em tópicos
Por mais que um filme pareça uma coisa só, o roteiro é dividido em cenas. Assim também deve ser um tutorial. Dependendo do grau de complexidade, acrescente subtópicos, e evite colocar muitas ações no mesmo tópico. Você pode achar que vai "mastigar" demais a informação para o usuário, mas o importante é que ele entenda e realize o proposto de maneira satisfatória, e quanto mais claro, melhor. Dividir em tópicos também garante que o usuário não se perca frente àquela série de instruções que ele deve seguir.
4. Ilustre
A maioria das pessoas não lê, e concentram seus esforços apenas em "ver as figuras". Isso não é à toa; seres humanos são visuais, e aprendem melhor com imagens. Às vezes elas são desnecessárias, como quando se vai fazer alguma coisa pelo modo texto - mesmo assim, dê um jeito de destacar essa informação de alguma maneira. Se for um tutorial sobre criar determinado efeito do Photoshop, por exemplo, é bom usar um screenshot em cada tópico. Outra saída seria fazer uso de programas de screencast, que captam imagens da tela do computador e transformam em vídeo, geralmente pronto para ser divulgado na web. Mas use esse recurso com moderação: não é todo mundo que gosta, ou tem banda suficiente para isso. Para fazer screencasts no Windows e no Linux, há o Wink, e para Mac OS X existe o iShowU.
5. Ajude pedindo ajuda
Quando terminar a parte do passo-a-passo, o tutorial em si, feche seu texto com pedidos para que os usuários mandem dúvidas caso hajam problemas e sugestões para futuros artigos. Assim, se houver uma nova forma de abordar o problema que você se propôs a ajudar a resolver, você pode complementar o tutorial e enriquecer a documentação existente.
Seja para arrumar alguma configuração de sistema, instalar e realizar tarefas específicas em softwares, tutoriais são uma maneira rápida de se livrar de algum problema simplesmente seguindo um passo-a-passo sem precisar, necessariamente, aprender a fazer alguma coisa. Além disso, tutoriais possuem um efeito multiplicador: por serem sempre úteis, sempre vai ter gente precisando deles, e demoram muito mais para ficarem desatualizados que um artigo comum.
