Como escrever um ótimo guia do usuário para quase tudo

Índice:

Anonim

Era uma vez, manuais de usuário sólidos acompanhados de novos produtos de todos os tipos, fornecendo instruções detalhadas sobre como aprender todas as funções e maximizar o seu uso. Hoje em dia, no entanto, guias de usuário fornecidos pela fábrica são muito mais superficiais e muitas vezes em vários idiomas, o que complica sua curva de aprendizado. Ter um guia de usuário decente é um bem precioso e, se você sabe como escrever um, esse é um talento em grande demanda. É simplesmente uma questão de dominar alguns princípios-chave.

Itens que você precisará

  • Microsoft Word ou outro programa de processamento de texto

  • Coleção de clip art ou fotografias digitais

  • Software de criação de páginas da web simples

Decida o formato, seja documentos impressos, páginas da Web, e-mails ou alguma combinação. Depois de escrever em um formato, é fácil transferi-lo para outro. Algumas pessoas ficam mais confortáveis ​​lendo um documento impresso que podem conter e arquivar. Outros podem preferir um URL ou link para um documento em seu site.

Seja organizado, claro e conciso. Antecipe e explique não apenas o que os usuários do produto farão, mas também o que não fazer. Você deve escrever com um olho para ambos.

Comece no início, desdobrando apenas as informações necessárias de maneira lógica. Escreva em voz ativa, não passiva. Mantenha sua cópia enxuta, eliminando palavras estranhas. Mantenha-o simples e metódico.

Divida o texto com fotos, ilustrações ou diagramas o máximo possível. Fazer com que os leitores percorram textos sem fim com parágrafos monstruosos é uma maneira certa de perdê-los. Números e páginas longas e complexas são aceitáveis ​​para manuais técnicos, mas inadequados para guias de usuário simples. Mantê-lo curto e doce.

Alertar o leitor sobre o que não fazer em vários intervalos. Isso ajuda a minimizar a frustração ao aprender um novo produto ou aplicativo.

Forneça aos leitores outros recursos que eles possam usar para complementar seu guia.

Dicas

  • Escreva em termos muito simples. Não assuma nenhum nível de conhecimento. O que parece fácil e bem informado para você pode não ser assim para seus leitores. Use gráficos, clipart e fotos de alta qualidade para melhorar a aparência do documento e melhorar a legibilidade. Mantenha parágrafos e descrições resumidas.

Aviso

Nunca assuma que o leitor esteja familiarizado com o produto. Escreva cada guia como se nunca tivessem visto um antes.