Como documentadora eu ouço muito a célebre frase “Pra quê? Ninguém lê o que vocês escrevem mesmo…”. Levo na brincadeira, dou risada junto. Mas é claro que eu sei que a realidade é essa mesmo – quase ninguém lê manual… até a hora que precisamos resolver um problema. E, nesse momento, eu faço questão de fazer a diferença para o meu cliente.
Nesse sentido, tento sempre não documentar o óbvio, fugir do “romanceamento” e ir direto ao ponto, onde a ferida dói. É muito mais difícil documentar os processos complexos, e é justamente por isso que a maioria dos manuais se mantém no “arroz com feijão”.
Ao invés disso, faz-se do manual técnico uma seqüência de informações óbvias, sem objetivo de negócios e extremamente cansativas de se ler. Literalmente chamam o usuário de imbecil e, na hora que ele mais precisa, o deixam na mão. Quantas vezes você precisou saber algo numa ferramenta, entrou no help, fez sua busca, mas só achou aquilo que você já sabia, que estava “na cara”?
Pessoas lindas do meu Brasil varonil, aprendam: não documentem o óbvio! Não digam ao usuário aquilo que ele já está vendo na interface gráfica do seu produto. A célebre frase “Clique no botão X. A janela XYZ abre.” é a coisa mais esdrúxula possível e, no entanto, 9 em cada 10 manuais seguem este padrão.
Lembrem-se que, geralmente, seu usuário consulta o manual ou o help quando ele está usando a ferramenta. Então, quando ele clicar no botão X, a janela estará lá! Ou seja, são 4, 5 ou 10 palavras a mais que você poderia ter poupado seu usuário de ler. E mais – se você implementar e traduzir para 10 línguas, serão 40, 50 ou 100 palavras a menos no seu custo de produção. E se você multiplicar isso por todas as vezes que essa frase foi incluída na sua documentação… bom, vocês entenderam onde tudo isso vai dar.
Então a dica aqui é: parem de documentar o óbvio! Antes disso, analisem o conteúdo daquilo que será aresentado ao usuário. As célebres perguntinhas “who – what – when – how – why?” devem estar presentes no seu planejamento de documentação:
Quem é o seu usuário? É o programador, o administrador de banco de dados, o digitador? Qual o nível de experiência e de intimidade desse usuário com o mundo tecnológico?
Do que ele precisa? Ele precisa que você o ensine como ligar o computador? Precisa que você o diga como e onde entrar com usuário e senha no sistema? Ou precisa que você lhe dê opções de parâmetros que o ajudem a melhorar seu trabalho e performance?
Quando e como ele precisa dessa informação? Ele fica online e poderá buscá-la na internet? Você deverá fornecê-la em arquivo para que ele possa acessá-la offline? Ele vai precisar dela antes da instalação ou mesmo durante o processo, quando não poderá acessá-la na tela, e portanto deverá fornecê-la em PDF?
Porque ele precisa dessa informação? É uma questão de negócios? É puramente técnico, para melhoria de performance ou debugging? Ele precisa resolver um erro que já aconteceu? Ou ele está tentando prevenir uma situação antes que ela ocorra?
Se o seu time de documentação mantiver essas questões em mente, tenha certeza, seu usuário vai continuar não lendo seus manuais. Mas, quando ele precisar deles, terá uma grata surpresa!
Leave a Comment