Muitas vezes, cheios de jargão, acrônimos e instruções que exigem um Ph.D para entender, manuais de usuário de software são às vezes escritos do ponto de vista de um desenvolvedor em vez de um usuário. Como resultado, o guia pode fazer suposições sobre o nível de habilidade do leitor, muitas vezes incorreto. O primeiro passo para escrever um bom manual do usuário é obter o processo de escrita real o mais longe possível dos engenheiros.
O desenvolvedor de software sabe mais do que qualquer pessoa o que faz o software funcionar, mas isso não significa que o desenvolvedor deva escrever o guia. Pelo contrário, é uma desvantagem distinta. Mais importante do que uma compreensão profunda do funcionamento interno do software é uma compreensão de quem será o usuário final, qual será seu nível educacional e como esse usuário final estará usando o software. Na maioria dos casos, os usuários finais não precisam conhecer os melhores pontos de programação e o funcionamento de back-end do software - eles só precisam saber como usá-lo para facilitar seu trabalho.
Teste de usuário
O manual do usuário deve ser amplamente orientado por tarefas, em vez de ser altamente descritivo. Como o manual foi escrito para ajudar os usuários a entender como executar tarefas específicas, o redator também precisa entender essas tarefas e, como resultado, passar por cada etapa discreta de cada recurso é absolutamente essencial. Não é necessário que o escritor necessariamente saiba como o programa foi criado a partir de um ponto de vista de design ou desenvolvimento, mas é essencial ter um forte conhecimento prático de todos os seus recursos. Durante a execução de cada tarefa, reserve um tempo para escrever todas as etapas, incluindo cliques, menus suspensos e outras ações.
O processo de entrevista
Embora o desenvolvedor não deva ser o único a escrever o manual, ela ainda será um recurso valioso para o escritor e, antes de começar a escrever, planeje uma reunião inicial entre o redatora, desenvolvedor e engenheiros e possíveis usuários finais para ajudar a informar o manual. trabalho do escritor desde o início. Entrevistas com especialistas no assunto e engenheiros devem ser gravadas, com transcrições feitas para referência posterior.
Imagens
Um manual do usuário não deve ser muito pesado em texto. Em vez disso, incorpore o uso liberal de gráficos e clipes de tela. A descrição de uma ação é muito mais clara com instruções baseadas em texto acompanhadas por um clipe de tela que ilustra claramente essa direção. Inclua visualizações antes e depois, para mostrar como é a tela antes de realizar cada ação e o que acontece depois que a ação é executada. Um utilitário simples de captura de tela, como a ferramenta de recorte incluída no Microsoft Windows, funciona bem para capturar essas imagens. Certifique-se de numerar cada imagem e inclua uma legenda que a descreva resumidamente. Centralize-o imediatamente abaixo do parágrafo que primeiro introduz o conceito representado na imagem.
Formatação
Comunicar claramente em um documento técnico requer planejamento e aderência cuidadosa aos padrões em todo o guia. Padrões em apresentação, linguagem e nomenclatura ajudam a evitar confusão. Modelos estão disponíveis e podem ser um bom ponto de partida para a uniformidade, embora estes possam certamente ser adaptados para cada situação. O uso de uma margem de uma polegada com uma única coluna melhor se adapta à necessidade de adicionar gráficos; uma configuração de duas colunas pode parecer muito cheia e pode tornar confusa a colocação de imagens.
Controle de versão e rastreamento
Mais do que qualquer outro tipo de documento, um guia de usuário de software provavelmente passará por várias iterações antes de ser concluído, e provavelmente passará por um processo de revisão por várias partes interessadas. Usar o recurso Controlar alterações no Microsoft Word é uma maneira fácil de acompanhar os comentários e as alterações de cada indivíduo. Criar várias versões após cada ciclo de revisão, cada uma com um nome de arquivo diferente, também ajuda o processo e garante que todas as partes interessadas estejam satisfeitas com o resultado final.
