Como escrever o manual do usuário de um programa

O manual do usuário de um programa é tão importante quanto o próprio programa. O manual do usuário é vital para aprender as técnicas básicas e avançadas de um programa ou aplicativo. Os manuais são geralmente curtos, mas se forem necessários mais detalhes, eles podem ser muito mais longos. O tamanho de um manual dependerá exclusivamente do tipo de programa e de quantos detalhes ele deve ter. Os usuários apreciarão um manual com informações que podem ser facilmente encontradas e concisas, com detalhes suficientes para evitar confusão.

Passo 1

Escreva um esboço do manual. Isso lhe dará um plano a seguir. Os pontos a serem incluídos no esquema seriam o processo de instalação, os aplicativos do programa, as descrições dos menus, as tarefas comuns, as funções avançadas e a seção de solução de problemas. Ele também inclui subseções em seu design para tarefas específicas, como criar um novo arquivo, salvar e imprimir arquivos.

Etapa 2

Detalha o processo de instalação, incluindo os requisitos do computador. Ele fornece os requisitos antes da instalação principal, para que os usuários possam preparar seu computador. Descreva até as etapas mais básicas para iniciantes em computador. Essas etapas podem ser “clique duas vezes no arquivo de instalação” ou “insira o CD na unidade de CD-ROM”. As etapas típicas de uma instalação envolvem a explicação das opções de instalação, como uma instalação típica e não uma instalação avançada, levando o usuário passo a passo através de cada tela IGU (Interface Gráfica do Usuário) com a qual ele é encontrado, registrando o programa e insira qualquer código ou número de série, e como acessar o programa depois de instalado para verificar se a instalação está correta.

Etapa 3

Faça uma descrição detalhada dos aplicativos do programa. Inclui o que o programa é necessário e como ele pode ser obtido. Por exemplo, se o programa lida com contabilidade, explique como facilita as tarefas normais de contabilidade. Esclarece quais são as funções mais importantes para o usuário final. Isso dará ao usuário uma idéia de quais funções ele tentará aprender primeiro. Por exemplo, em um programa de criação de música, diga ao usuário quantas faixas ele pode gravar ao mesmo tempo, todos os sons e ritmos que ele possui e em quais formatos ele pode salvar os arquivos. Ele inclui uma breve descrição dos recursos avançados, o que o torna um programa diferente dos outros no mercado. Por exemplo, seu programa pode gerar mais relatórios ou suportar mais tipos de arquivos,

Etapa 4

Explique como navegar pelos menus. Explique cada ponto dos menus disponíveis. Qualquer coisa que não possa ser explicada em uma ou duas frases deve ser incluída na seção Tarefas comuns do manual. Essas tarefas podem incluir alteração de letras e cores, como imprimir diferentes formatos e tipos de arquivos e como organizar arquivos e informações.

Etapa 5

Escreva uma seção separada para recursos avançados e recursos adicionais. É aqui que você deve entrar em detalhes. Por exemplo, um manual do usuário para o Microsoft Excel incluiria informações sobre como criar relatórios, links e macros. Recursos adicionais incluirão recursos que o usuário pode não esperar. Por exemplo, um programa de criação de música pode trazer um music player embutido. Reserve um tempo para explicar qualquer extra que vem com o seu programa ou as aplicações exclusivas dele.

Etapa 6

Inclui sugestões para solução de problemas. Explique o significado de cada erro que o usuário pode encontrar, como resolver o problema e como evitá-lo no futuro. Este também é o local em que você deve incluir informações de contato e informações de atendimento ao cliente.

 

Você pode estar interessado:

Deixe um comentário