Como escrever um manual de usuário para um programa

Escrito por carol finch Google | Traduzido por randhal wendel
  • Compartilhar
  • Tweetar
  • Compartilhar
  • Pin
  • E-mail
Como escrever um manual de usuário para um programa
Software (cyber-world.it)

O manual do usuário de um software é quase tão importante quanto o software em si. Ele é vital para a aprendizagem tanto das técnicas básicas quanto das mais avançadas de um programa ou aplicativo. Normalmente os manuais são curtos, mas se são necessários mais detalhes, eles podem ser maiores. O comprimento do manual irá depender unicamente do tipo de software e do nível de detalhes que devem ser incluídos. Os usuários apreciam manuais com informações concisas e fáceis de encontrar, com detalhes suficientes para evitar confusões.

Nível de dificuldade:
Fácil

Outras pessoas estão lendo

Instruções

  1. 1

    Escreva um esboço para o manual. Isso lhe dará um plano para seguir. Você pode incluir no esboço o procedimento de instalação, a finalidade do software, descrições dos menus, tarefas comuns, funções avançadas e uma seção de solução de problemas. Inclua também sub-seções em seu esboço sobre tarefas específicas, como a criação de um novo arquivo, salvar arquivos e impressão de arquivos.

  2. 2

    Detalhe o processo de instalação, incluindo os requisitos mínimos do computador. Forneça os requisitos antes do procedimento principal de instalação para que os usuários possam preparar seus computadores. Inclua até mesmo os passos mais básicos para iniciantes de computador. Essas medidas podem incluir "Clique duas vezes no arquivo de instalação" ou "Insira o CD na unidade de CD-ROM." Passos típicos de instalações envolvem explicações sobre as opções de instalação, como instalação típica e opções de instalação avançada, guiando o usuário passo a passo através de cada tela exibida, como a do registro do software, adicionando códigos ou números de série, e como acessar o programa depois de instalado para verificar se a instalação foi concluída corretamente.

  3. 3

    Forneça uma descrição detalhada da finalidade do software. Inclua para que o usuário precisa do software e como ele pode se beneficiar. Por exemplo, se o software lida com contabilidade, explique tarefas de contabilidade comuns que o software faz de forma mais fácil. Explique quais funções são mais importantes para o utilizador final. Isso dará ao usuário uma ideia de quais funções tentar aprender primeiro. Por exemplo, em um software de criação musical, informe ao usuário sobre quantas faixas podem ser gravadas de uma só vez, todos os sons e ritmos incluídos, e os formatos dos arquivos que podem ser salvos. Inclua uma breve descrição de características avançadas que tornam esse software diferente dos outros no mercado. Por exemplo, o software pode ser capaz de gerar mais relatórios ou suporta mais tipos de arquivos que qualquer outro programa disponível atualmente.

  4. 4

    Explique como navegar nos menus. Explique cada item dos menus. Todos os itens que não podem ser explicados em uma ou duas frases devem ser incluídos na seção Tarefas comuns do manual. Essas tarefas podem incluir a mudança de fontes e cores, impressão em diferentes formatos e tipos de arquivos, e organização de arquivos e informações.

  5. 5

    Escreva uma seção separada para as funções avançadas e os recursos extras. Esse é o lugar para entrar em detalhes. Por exemplo, um manual do usuário para o Microsoft Excel pode incluir informações sobre a criação de relatórios, links e macros.

    Os recursos extras incluem funções que o usuário final não espera. Por exemplo, o software de criação de música pode vir junto com um leitor de música. Aproveite para explicar os extras que podem vir com o software, ou usos exclusivos dele.

  6. 6

    Forneça dicas de solução de problemas. Explique os significados de todos os erros que o usuário pode encontrar, como resolver a questão, e como evitá-los no futuro. Este também é o lugar para incluir informações de contato e de ajuda.

Dicas & Advertências

  • Se o software é multiplataforma, forneça instruções para cada sistema operacional, se necessário.

Não perca

Filtro:
  • Geral
  • Artigos
  • Slides
  • Vídeos
Mostrar:
  • Mais relevantes
  • Mais lidos
  • Mais recentes

Nenhum artigo disponível

Nenhum slide disponível

Nenhum vídeo disponível