Como escrever o manual do usuário de um programa

Passo 1

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

Passo 2

Ele 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. Descreve até mesmo as etapas mais básicas para iniciantes em computadores. 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 explicar as opções de instalação, como uma instalação típica em oposição a uma instalação avançada, levando o usuário passo a passo através de cada tela de interface gráfica do usuário (IGU - Graphical User Interface) com a qual elas estão localizadas, registrando programa e digite qualquer código ou números de série, e como acessar o programa uma vez instalado para verificar se a instalação está correta.

Passo 3

Faça uma descrição detalhada das aplicações do programa. Inclui o que o programa é necessário e como você pode se beneficiar dele. Por exemplo, se o programa lida com contabilidade, ele explica como simplificar as tarefas contábeis normais. Esclarece quais são as funções mais importantes para o usuário final. Isso dará ao usuário uma ideia de quais funções eles tentarão 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 que 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 do que qualquer outro programa disponível no momento.

Passo 4

Explica como navegar nos 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 a alteração da fonte e das cores, como imprimir diferentes formatos e tipos de arquivos e como organizar arquivos e informações.

Passo 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 do Microsoft Excel incluiria informações sobre como criar relatórios, links e macros. Recursos adicionais incluirão funções que o usuário pode não esperar. Por exemplo, um programa de criação de músicas pode trazer um player de música integrado. Tire um tempo para explicar qualquer extra que venha com seu programa ou com os aplicativos exclusivos dele.

Passo 6

Inclui sugestões para resolver problemas. Explica 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 lugar onde você deve incluir informações de contato e informações de atendimento ao cliente.