Dicas sobre como não escrever manuais inúteis

04/07/2003 0:00

Por: Karyn Nassif

O destino dos manuais de software muitas vezes é o lixo, quando são incompreensíveis e herméticos. Porém é possível torná–los atrativos, agradáveis de ler e até usá–los como aliados.

Antigamente os materiais de referência dos sistemas eram somente manuais impressos. Eram escritos pelo profissional mais júnior da equipe de desenvolvimento, no fim do projeto e às pressas. Como resultado, os manuais não eram compatíveis com a realidade do sistema e eram difíceis de entender.



A internet invadiu as empresas e nossas vidas. O manual online facilita a disseminação da informação, é mais cuidadoso no design e no conteúdo, mas o manual impresso sempre terá o seu espaço nos armários.



Vivemos numa sociedade onde muitas pessoas não possuem computadores ou acesso à internet, onde é normal faltar energia elétrica, o telefone ficar mudo e o provedor de banda larga sair do ar. Pois é, acontece. Por estes e outros motivos, os manuais impressos continuarão existindo por muito tempo.



Este tipo de manual também demonstra o respeito da empresa para com o cliente ou usuário. Afinal ela expõe a outra pessoa detalhadamente como o produto que acabou de comprar funciona, os possíveis problemas, o que deve ser feito ou não. O usuário estabelecerá uma relação de confiança com empresa, que além de oferecer algo que ele queria ou precisava ainda o ajudou a superar dificuldades e forneceu informações. Provavelmente, no futuro, esta pessoa adquirirá outros produtos desta mesma empresa ou influenciará outras na compra.



O caso de manuais de software não é diferente. Eles devem transmitir confiança, guiar o usuário na utilização do sistema, explicar as ferramentas, a instalação (quando necessário), as tarefas típicas e as mais avançadas. E tudo isso de maneira natural, procurando despertar o interesse do usuário e evitar o destino de muitos: o lixo.



Mas como evitar este destino? Para isso existem algumas técnicas.



Defina a forma de apresentação



O objetivo do manual e seu público–alvo definem a forma de apresentação e não ao contrário. Se o necessário é um manual de referência completo, um tutorial introdutório, um cartão de referência rápida ou simplesmente um guia para iniciantes (conhecidos como “getting–started”) só será possível descobrir após definir o perfil do leitor e os resultados esperados após a leitura.



Após feita escolha do formato lembre–se que o manual deve ser ao mesmo tempo fácil de manusear e resistente . O próximo passo é definir a apresentação, que deve ser clara, sem cores fortes que agridam ou dificultem a leitura. Deve passar confiança e seriedade, mas ao mesmo tempo inovação e criatividade.



Desenvolva a organização e estilo



O autor deve saber o conteúdo técnico, ter testado o software, estar ciente dos conhecimentos que o usuário tem e a “língua” que ele fala, assim como ter habilidade para manter uma escrita lúcida e compatível com a realidade do sistema. Este é o maior desafio.



Facilitadores destas tarefas são a definição da organização e do estilo de escrita. A organização deve ser guiada pelas tarefas que usuário pode realizar, formatando a seqüência de aprendizado. O conceito das tarefas deve ser apresentado antes das ferramentas do sistema e das ações que o usuário deve tomar.



O estilo de escrita deve ser baseado no perfil do leitor, menos ou mais técnico, mas deve ser sempre claro, simples e didático. Escrever difícil não valoriza o texto e utilizar gírias ou excesso de palavras estrangeiras também não acrescenta informações.



Utilize exemplos



Apresente inúmeros exemplos sempre. Permita que o usuário veja o que acontecerá se ele realizar tal operação ou o resultado que obterá se executar determinada tarefa. Ele se sentirá mais seguro.



Forneça diagramas e ilustrações que sejam condizentes com a realidade do sistema. Não utilize imagens de telas se não tiver certeza de que o usuário poderá se deparar com elas.



Forneça meios de localização



Permita que o usuário encontre o que ele precisa. Forneça índices, tabelas de conteúdo, glossários e sumários. Uma lista de erros também é muito bem–vinda. Ele perceberá que não há nada escondido e não se sentirá obrigado a seguir uma regra de leitura.



Outro item importante: forneça sempre a opção de um contato em caso de dúvidas em relação ao conteúdo do manual ou forma de utilização e de criticas e sugestões. O feedback é essencial em todas as relações.



Tenha profissionais especializados



A maioria dos técnicos não gosta de escrever manuais; pelo contrário, acham que estão perdendo seu precioso tempo, afinal poderiam estar escrevendo código.



Porém, é possível sim encontrar profissionais que não só gostem de escrever como tem o dom para isso. Que precisam só de um estimulo, ferramentas adequadas e um pouco de treinamento. Estes profissionais se preocupam com o lado humano da tecnologia e produzem ótimos manuais.



…………………………………………………………….



Lembre–se: aprender algo sempre é um desafio. Este desafio pode ser prazeroso e satisfatório, mas quando se fala sobre aprender a utilizar sistema, muitas pessoas experimentam ansiedade, frustração e desapontamento. Muitas dificuldades nascem de designs de tela pobres ou instruções que conduzem ao erro, ou ainda a simples falta de habilidade dos usuários em saber o próximo passo a tomar.



Para facilitar essa tarefa existem os manuais e eles devem ser capazes de fornecer as informações necessárias para que o usuário utilize produtivamente o seu sistema. [Webinsider]