Contente

• Dar um passo
• Parte 1 de 4: Planejando seu manual do proprietário
• Parte 2 de 4: incorporar informações essenciais
• Parte 3 de 4: Descrevendo a manutenção do produto
• Parte 4 de 4: Escreva um manual legível
• Pontas

Software, computadores, jogos e dispositivos requerem manuais do usuário; guias explicando como usar o produto (e como não). Um manual do usuário é um documento formal com uma estrutura específica e deve ser escrito por alguém que conheça o produto de dentro para fora, como um redator técnico ou o designer do produto. Escrever um manual do usuário eficaz requer que você saiba quem usará o produto e que o escreva tendo esses usuários em mente. Mantenha sua escrita clara, precisa e simples para garantir uma experiência de usuário descomplicada.

Dar um passo

Parte 1 de 4: Planejando seu manual do proprietário

1. Faça uma análise do usuário. O manual do usuário deve ser escrito para os usuários - aqueles que comprarão seu produto ou serviço e lerão o manual do usuário. Uma análise do usuário dirá quem será o seu público-alvo principal ou alvo e o guiará durante a redação do texto.
   • Fale com as pessoas que usarão seu dispositivo. Ofereça aos usuários de teste protótipos do dispositivo e faça um esboço do manual do usuário sob condições controladas. Peça a esses usuários de teste feedback sobre coisas que não estão claras ou confusas no guia do usuário e faça alterações em seu guia do usuário com base neste feedback.
   • Você nunca pode satisfazer todo o seu público; escrever o manual sob medida para o público-alvo ou o maior público.
   • Considere a idade, a saúde (eles têm alguma doença, deficiência de aprendizado ou deficiência?) E o nível de educação do público para determinar a melhor abordagem para escrever o manual do usuário.
2. Coordene o design do manual do usuário. Se você fez parte da equipe que ajudou a projetar e desenvolver o dispositivo ou produto, pode ser difícil dar uma olhada objetiva no produto para explicar como ele funciona. Portanto, você deve procurar o conselho de um escritor (de preferência alguém com experiência em escrever instruções) e de um designer gráfico para ajudá-lo a preparar o manual do usuário. Você pode escolher essas pessoas por meio de uma consultoria externa ou de sua própria empresa ou organização.
3. Faça uma análise da tarefa. A análise do trabalho é o processo de identificação e organização das etapas necessárias para usar o dispositivo. Uma análise de trabalho completa identifica os materiais e equipamentos (como baterias, medicamentos ou outros produtos fornecidos pelo usuário) necessários para cada etapa, bem como as ações, erros e conselhos de solução de problemas que cada etapa pode exigir.
   • Se você tiver um produto que pode executar muitas tarefas ou subtarefas diferentes, deverá executar uma análise de tarefa para cada tarefa. Por exemplo: em um carro você pode buzinar, apertar o cinto e ligar ou desligar os faróis. Faça uma análise de trabalho para cada um deles, se necessário.
4. Certifique-se de que seu produto atenda aos requisitos de rotulagem e autorização de comercialização. Esses requisitos garantem que os produtos sejam fabricados com a segurança do usuário em mente e que a exposição do usuário a condições perigosas, como radiação e eletrocussão, seja limitada. Os anúncios devem declarar claramente a finalidade e as diretrizes básicas de operação de um produto, e você deve usar esses recursos ao escrever o manual do proprietário.
   • Para que o manual do usuário de um produto seja eficaz, ele deve ser escrito de acordo com as etiquetas afixadas diretamente no produto.
   • Certifique-se de que seu dispositivo está oficialmente licenciado para venda antes de escrever o manual do usuário.
5. Decida o layout do seu manual. Existem várias maneiras importantes de simplificar seu manual. Você deve colocar um título em negrito no início de cada seção com cada palavra em letras maiúsculas. Por exemplo, "Configurar seu dispositivo", "Operar seu dispositivo" e "Solucionar problemas" podem ser cabeçalhos de seção em negrito.
   • Outra forma de simplificar seu guia é usar duas colunas, uma à direita com texto e outra logo à esquerda do texto, com marcadores, números ou ícones pequenos, como marcas de aviso ou pontos de exclamação vermelhos.
   • O manual pode consistir principalmente de imagens com algum texto abaixo de cada imagem para explicar o dispositivo, ou pode ser principalmente um texto com apenas algumas imagens acompanhantes. Você também pode usar um fluxograma para orientar o usuário. Pense em seu produto e como cada método pode ajudá-lo a escrever seu manual. No entanto, evite misturar layouts diferentes em um manual. Escolha um e fique com ele.

Parte 2 de 4: incorporar informações essenciais

1. Organize o manual de forma lógica. O manual deve ser estruturado de forma que o usuário tire o máximo proveito dele. Divida o manual em capítulos ou seções que façam sentido para o uso do produto e inclua um índice no início do manual para que cada seção possa ser encontrada rapidamente.
   • Um índice é especialmente necessário para manuais mais longos.
   • Um glossário ou índice é necessário se houver muitos termos para explicar que seu público pode não estar familiarizado. No entanto, um glossário não é recomendado; a melhor opção é explicar os termos confusos no texto do próprio manual. Se você optar por incluir um glossário, coloque-o no início do manual, logo após o índice.
   • Uma lista de tabelas ou figuras só é necessária se houver mais do que algumas tabelas ou figuras no manual.
   • Um apêndice é necessário para coisas que precisam ser explicadas, mas não podem ser explicadas em outra parte do manual, pois isso interromperia o fluxo e o foco.
2. Inclua avisos necessários. Os avisos gerais ou informações de precaução devem fornecer informações sobre os riscos potenciais causados ​​pelo uso impróprio do produto, incluindo morte ou ferimentos graves. Esses avisos devem ser colocados no início do manual, após a página inicial, para que o usuário os veja primeiro. Avisos específicos também devem ser incluídos no texto do manual logo após ou antes de uma etapa potencialmente perigosa ser sugerida.
   • Por exemplo, um aviso geral para um aparelho elétrico pode ser não usá-lo quando estiver chovendo.
   • Uma instrução específica pode ser certificar-se de que suas mãos e o dispositivo estejam secos antes de conectá-lo à tomada.
   • Forneça imagens (como uma caveira e ossos cruzados) ou texto de uma cor diferente (como texto em vermelho) para distinguir o aviso do restante das instruções no IFU e chamar a atenção dos usuários para ele.
3. Descreva o dispositivo. Sua descrição deve incluir uma explicação por escrito da finalidade do dispositivo e uma pequena representação gráfica da aparência do dispositivo. A figura deve rotular e nomear todos os interruptores, botões e peças anexáveis ​​contidos no dispositivo.
4. Fornece instruções de instalação. A seção de instalação deve conter informações básicas sobre como se preparar para usar o produto ou dispositivo. Se o aparelho não puder ser construído ou configurado por um usuário doméstico, indique isso claramente em negrito no topo da seção de instalação. Você também deve incluir o seguinte:
   • Uma lista de peças
   • Instruções para desembalar
   • Avisos de instalação
   • Consequências da instalação incorreta
   • Quem ligar em caso de dificuldades durante a instalação
5. Forneça informações sobre a operação. Esta seção é a parte mais importante do manual do usuário e deve fornecer informações concretas e detalhadas sobre como usar o dispositivo. Comece com a preparação básica para usar a unidade, como conectar o cabo de alimentação ou lavar as mãos. Continue com as etapas lógicas numeradas que descrevem como usar o dispositivo, bem como qualquer feedback (por exemplo, "Você ouvirá um clique ...") que o usuário pode esperar ao usar o dispositivo corretamente.
   • No final deste capítulo, os usuários devem consultar o capítulo de solução de problemas para resolver os problemas que não podem ser explicados rapidamente.
   • Coloque imagens onde necessário. Algumas etapas são melhor explicadas com imagens e palavras. Considere o uso de fotos ou ilustrações em seu manual.
   • Nesta seção, como em qualquer seção, você deve incluir avisos de segurança relevantes sobre uso ou operação inadequada. Por exemplo, você pode alertar os usuários de motosserra para não beberem álcool ou usarem a motosserra enquanto estiverem tomando certos medicamentos.
   • Se você acha que os usuários se beneficiarão, considere a inclusão de links para vídeos online que demonstrem o uso e a operação adequados do dispositivo. Você pode gravar esses vídeos no início desta seção ou (no caso de vídeos que ilustram apenas uma etapa) no final de cada etapa.
6. Inclua um resumo do produto no final. O resumo deve aparecer no final do manual, antes do índice, para fornecer as etapas operacionais básicas. Essa deve ser uma versão simplificada e reduzida das informações operacionais e não deve ter mais do que uma página. Resuma como o dispositivo ou produto deve ser usado. Inclua alertas básicos, etapas numeradas que explicam como usar o produto e números de telefone ou endereços de e-mail que direcionam os usuários para ajudar.
   • Se você espera que o usuário remova ou consulte a folha de resumo com frequência, pode imprimi-la em um cartão laminado removível ou papelão grosso para facilitar o transporte e a consulta pelo usuário.
   • Como alternativa, você pode aplicar um resumo diretamente ao produto para consulta rápida e fácil do usuário.

Parte 3 de 4: Descrevendo a manutenção do produto

1. Explique como limpar o dispositivo. Se o seu dispositivo ou produto precisar de limpeza, explique como fazer isso. Liste os agentes de limpeza necessários. Diga ao leitor com que freqüência deve limpar. Em seguida, como em qualquer outra parte do manual, inclua instruções passo a passo numeradas sobre como limpá-lo.
   • Se a limpeza exigir que o produto seja desmontado ou uma parte ou peças em particular sejam removidas, indique como o produto deve ser desmontado.
   • Fornece um aviso sobre os resultados da falha na limpeza do dispositivo. Por exemplo, você pode dizer: "Se o dispositivo não for limpo, o desempenho será inferior ao ideal."
2. Conte ao usuário como realizar a manutenção básica. Se o produto ou dispositivo puder ser reparado pelo usuário para corrigir problemas de desempenho, forneça instruções numeradas sobre como fazer isso para o usuário. Por exemplo, se as baterias precisarem ser substituídas a cada 300 horas de uso, forneça instruções sobre como verificar se as baterias precisam ser substituídas, como remover as baterias gastas e como instalar as novas.
   • Se houver certas tarefas de manutenção que só podem ser realizadas por um técnico certificado, divida a parte de manutenção do manual em duas partes.
3. Discuta as opções de armazenamento. Se necessário, o manual deve explicar como armazenar corretamente o produto ou dispositivo. você também deve incluir informações sobre por que o armazenamento é necessário e as consequências do armazenamento impróprio. Por exemplo: você pode escrever:
   • Armazene o produto em local fresco e seco. O armazenamento inadequado pode reduzir a vida útil do produto devido ao acúmulo de umidade. "
   • "Não exponha o produto ao calor nem o armazene em temperaturas acima de 50 graus Celsius.Se o fizer, pode levar à combustão. "
4. Fornece informações sobre solução de problemas. Você pode organizar esta seção como uma lista de problemas comuns e suas soluções. Agrupe problemas semelhantes sob um título lógico. Dessa forma, os usuários podem encontrar problemas específicos rapidamente.
   • Por exemplo, se houver vários problemas com o computador exibindo uma tela azul, agrupe-os em um subtítulo, como "Problemas comuns de tela".
   • Você também deve incluir um número de telefone e / ou e-mail para atendimento ao cliente nesta seção.

Parte 4 de 4: Escreva um manual legível

1. Leia outros guias do usuário. Antes de escrever um manual para seu próprio produto, verifique outros guias de usuário eficazes. Preste atenção à estrutura, escolha de palavras e estrutura das frases. Marcas importantes como Apple, Google e Microsoft produzem guias do usuário fortes e eficazes que podem ajudá-lo a produzir um guia do usuário escrito de maneira mais cuidadosa.
   • Não apenas leia tudo manuais do usuário. Leia os manuais de produtos semelhantes que você vende. Por exemplo, se você vende produtos para bebês, leia os manuais do bebê, não os técnicos.
2. Selecione seus padrões. A padronização da ortografia, escolha de palavras e redação tornará o manual do usuário mais amigável. O Chicago Manual of Style e o Microsoft Manual of Style também podem ser guias de estilo úteis ao escrever o manual do proprietário; verifique ambos para ver se um é adequado para o seu manual.
   • Por exemplo, em vez de usar "botão liga / desliga" e "botão liga / desliga" em seu manual, escolha um dos dois termos e siga-o.
3. Use a voz ativa. A voz ativa é uma forma de escrever que explica as coisas da perspectiva do usuário. É mais fácil de entender do que a alternativa, a voz passiva, em que o sujeito é indefinido.
   • Experimente o App Hemingway (www.hemmingwayapp.com) para identificar passagens passivas em sua escrita.
   • Estude estes dois exemplos de frases - a primeira é ativa e a segunda é passiva:
     • Você tem que abrir o pacote devagar e com cuidado.
     • A embalagem deve ser aberta lenta e cuidadosamente.
4. Escreva instruções numeradas. Instruções ordenadas numericamente ajudam o leitor a se concentrar melhor no processo de uso, conexão ou construção do produto em questão. Em vez de escrever um parágrafo longo e prolixo, ou uma série de parágrafos não numerados, escreva seu guia do usuário com etapas simples e explícitas, cada uma claramente numerada.
5. Comece cada etapa com um imperativo. Um imperativo é um verbo orientado para a ação. Ao iniciar cada etapa com um verbo, você dá ao leitor uma dica sobre a ação necessária para concluir a etapa. Por exemplo, dependendo do produto sobre o qual você está escrevendo, você pode iniciar seus passos com um comando como "Conectar", "Confirmar" ou "Slide". No entanto, não comece seus passos com uma resposta do sistema.
   • Por exemplo, se a tela ficar azul e começar a piscar, não inicie a etapa com: "A tela piscará e ficará azul." Tente: "Pressione e segure a tecla Home. A tela piscará e ficará azul. "
6. Determine qual vocabulário você usará. Se você está escrevendo um manual de ioiô, seu público será formado principalmente por crianças. Use palavras e vocabulário simples para explicar como o ioiô funciona. Quando você está escrevendo um manual de microscópio eletrônico de varredura, seu público é formado por cientistas altamente qualificados que podem entender informações muito detalhadas, portanto, não se intimide em usar vocabulário especializado ou explicações diferenciadas.
   • Em geral, você tenta evitar jargões e linguagem técnica.
   • Para ser eficaz para a base de usuários mais ampla possível, tente escrever em um nível da sexta à sétima série do ensino fundamental.
7. Ao enviar um produto para o exterior, certifique-se de que suas traduções sejam precisas. Contrate um tradutor para traduzir seu manual do usuário para o idioma nativo do país para o qual você está enviando seu produto. Você também pode usar um programa de tradução online, mas peça a um falante nativo para ler a tradução e verificar se há erros.
   • Se vários grupos de idiomas estiverem representados em seu público, inclua traduções do manual do usuário em cada idioma relevante.
   • O tradutor deve estar familiarizado com o produto, pois pode haver palavras diferentes no idioma de destino para termos específicos que não são traduções palavra por palavra.
8. Escreva frases curtas. Em vez de alguns parágrafos longos, você usa muitos parágrafos curtos. Procure quebras lógicas em cada seção e faça um resumo das informações úteis em blocos de uma ou duas frases. O mesmo é verdade no nível da frase. Mantenha suas frases curtas e simples, em vez de longas e prolixas.
   • Se uma etapa está ficando muito longa, divida-a em etapas menores. Isso não reduzirá a contagem de palavras, mas as quebras de linha facilitarão a leitura.
9. Verifique se há erros no manual. Um manual pode perder credibilidade devido a erros gramaticais e ortográficos. Peça a um colega ou redator técnico para editar e revisar o manual também. Além de ortografia e gramática, um revisor deve prestar atenção ao seguinte:
   • Voz passiva
   • Linguagem pouco clara ou confusa
   • Estrutura da frase embrulhada
   • Parágrafos excessivamente longos

Pontas

• As pessoas aprendem de maneiras diferentes; Se possível e apropriado, inclua recursos visuais ou links para vídeos online no manual para acomodar leitores visualmente orientados.