Instruções gratuitas passo a passo 
Se você tiver um produto que pode executar muitas tarefas ou subtarefas diferentes, será necessário executar uma análise de tarefa para cada tarefa. Por exemplo: em um carro, você pode buzinar, prender o cinto e ligar ou desligar os faróis. Crie uma análise de trabalho para cada um deles, se necessá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. Antes de escrever o manual do usuário, certifique-se de que seu dispositivo tenha licenças oficiais para venda. 
Outra forma de agilizar seu manual é usar duas colunas, uma à direita com texto e outra logo à esquerda do texto, com marcadores, números ou pequenos ícones, como sinais de alerta ou pontos de exclamação vermelhos. O manual pode consistir principalmente em imagens com algum texto abaixo de cada imagem para explicar o dispositivo, ou pode ser principalmente texto com apenas algumas imagens de acompanhamento. 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. 
Por exemplo, um aviso geral para um aparelho elétrico pode ser não usá-lo durante a chuva. Uma dica específica pode ser certificar-se de que suas mãos e o dispositivo estão secos antes de conectá-lo. Forneça imagens (como uma caveira e ossos cruzados) ou texto em uma cor diferente (como texto vermelho) para distinguir o aviso do restante das instruções do manual e chamar a atenção dos usuários para ele. 
Uma lista de peças Instruções de desembalagem Avisos de instalação Consequências de uma instalação incorreta A quem chamar em caso de dificuldades de instalação 
No final deste capítulo, os usuários devem ser encaminhados para o capítulo de solução de problemas, para resolver problemas que não podem ser explicados rapidamente. Poste imagens quando necessário. Alguns passos são melhor explicados com imagens e palavras. Pense em usar fotos ou ilustrações em seu manual. Nesta parte, como em qualquer parte, você deve incluir avisos de segurança relevantes sobre uso ou operação inadequada. Por exemplo, você pode alertar os usuários de motosserras para não beber álcool ou usar a motosserra enquanto estiver tomando certos medicamentos. Se você acha que isso beneficiaria os usuários, considere incluir links para vídeos on-line que demonstrem o uso e a operação adequados do dispositivo. Você pode incluir 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. 
Se você espera que o usuário remova a folha de resumo ou precise consultá-la com frequência, pode imprimi-la em um cartão laminado removível ou papelão grosso para facilitar o transporte e a consulta do usuário. Alternativamente, você pode colocar um resumo diretamente no produto para referência rápida e fácil para o usuário. 
Se houver determinadas tarefas de manutenção que só podem ser realizadas por um técnico certificado, divida a seção de manutenção do manual em duas partes. 
`Guarde o produto em local fresco e seco. O armazenamento inadequado pode encurtar a vida útil do seu produto devido ao acúmulo de umidade.` `Não exponha o produto ao calor e não o armazene em temperaturas acima de 50 graus Celsius. Se você fizer isso, pode levar à ignição.` 
Por exemplo, se houver vários problemas com o computador mostrando uma tela azul, agrupe-os em um subtítulo, como "Problemas de tela comuns". Você também deve incluir um número de telefone de atendimento ao cliente e/ou e-mail nesta seção. 
Por exemplo, em vez de usar "chave liga/desliga" e "botão liga/desliga" em seu manual, escolha um dos dois termos e fique com ele. 
Experimente o aplicativo Hemingway (www.aplicativo de bainha.com) para reconhecer passagens passivas em sua escrita. Estude estas duas frases de exemplo - 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. 
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.` 
Em geral, tente 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. 
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 outras palavras no idioma de destino para termos específicos que não sejam traduções palavra por palavra. 
Se uma etapa começar a ficar muito longa, divida-a em etapas menores. Isso não reduzirá a contagem de palavras, mas as quebras de linha facilitarão a leitura. 
Voz passiva Linguagem pouco clara ou confusa estrutura de frase embrulhada Parágrafos excessivamente longos
Escrevendo um guia do usuário
Contente
Software, computadores, jogos e dispositivos requerem manuais do usuário; guias explicando como usar o produto (e como não usar). Um manual do usuário é um documento formal com uma estrutura específica e deve ser escrito por alguém que conhece o produto por completo, como um redator técnico ou o designer de produto. Escrever um manual de usuário eficaz requer que você saiba quem usará o produto e que você escreva o manual com esses usuários em mente. Mantenha sua escrita clara, precisa e simples para garantir uma experiência de usuário sem complicações.
Degraus
Parte 1 de 4: Planejando seu guia do usuário
1. Faça uma análise do usuário. O guia do usuário deve ser escrito para os usuários - aqueles que comprarão seu produto ou serviço e lerão o guia do usuário. Uma análise do usuário lhe dirá quem será seu público principal ou alvo e o guiará na redação do texto.
- Fale com as pessoas que usarão seu dispositivo. Fornecer aos usuários de teste protótipos do dispositivo e um rascunho do manual do usuário sob condições controladas. Peça feedback a esses usuários de teste sobre coisas que não estão claras ou confusas no guia do usuário e faça alterações no guia do usuário com base nesse feedback.
- Você nunca pode agradar todo o seu público; escrever o manual adaptado ao público-alvo ou ao maior público.
- Pense na idade, na saúde (eles têm alguma doença, dificuldades de aprendizagem ou deficiências?) e o nível de educação do público, para determinar a melhor abordagem para escrever o manual do usuário.
2. Coordenar 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 olhar objetivamente para o produto para explicar como ele funciona. Você deve, portanto, procurar o conselho de um escritor (de preferência alguém com experiência em escrever instruções) e um designer gráfico para ajudá-lo a preparar o manual do usuário. Você pode escolher essas pessoas através de uma consultoria externa ou de sua própria empresa ou organização.
3. Faça uma análise de trabalho. Uma análise de trabalho é o processo de identificar e organizar as etapas necessárias para usar o dispositivo. Uma análise completa do trabalho 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.
4. Certifique-se de que seu produto atende 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 indicar claramente a finalidade e as diretrizes operacionais básicas de um produto, e você deve usar esses recursos ao escrever seu guia 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", "Controlar seu dispositivo" e "Solucionar problemas" podem ser títulos de seção em negrito.
Parte 2 de 4: Incorporando informações essenciais
1. Organize o manual logicamente. O manual deve ser estruturado de tal forma que o usuário obtenha o máximo benefício dele. Divida o manual em capítulos ou seções que façam sentido para o uso do produto e inclua um índice na frente do manual para que cada seção possa ser encontrada rapidamente.
- Um índice é especialmente necessário para guias mais longos.
- Um glossário ou índice é necessário se houver muitos termos para explicar que seu público pode não conhecer. No entanto, um glossário não é recomendado; a melhor escolha é explicar termos confusos no próprio texto do manual. Se você optar por incluir um glossário, coloque-o na frente 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 outras partes do manual, pois interromperia o fluxo e o foco.
2. Inclua os avisos necessários. Os avisos gerais ou informações de precaução devem fornecer informações sobre os riscos potenciais que podem surgir do uso indevido do produto, incluindo morte ou ferimentos graves. Esses avisos devem ser colocados bem no início do manual, após a primeira página, 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 imediatamente antes de uma etapa potencialmente perigosa ser sugerida.
3. Descreva o dispositivo. Sua descrição deve incluir uma explicação escrita da finalidade do dispositivo e uma pequena representação gráfica da aparência do dispositivo. A ilustração deve rotular e nomear todos os interruptores, botões e peças conectáveis contidas no dispositivo.
4. Fornecer 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 dispositivo não puder ser construído ou configurado por um usuário doméstico, indique isso claramente em um título em negrito na parte superior da seção de instalação. Você também deve incluir o seguinte:
5. Fornecer informações de 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 antes de usar o aparelho, como conectar o plugue ou lavar as mãos. Prossiga com etapas lógicas e numeradas que descrevem como usar o dispositivo, bem como feedback (por exemplo, "Você ouve um clique...`) que o usuário pode esperar ao usar o dispositivo corretamente.
6. Adicione um resumo do produto no final. O resumo deve vir no final do manual, logo antes do índice, para dar os passos básicos de operação. Esta deve ser uma versão simplificada e simplificada das informações operacionais e não deve exceder uma página. Resuma como usar o dispositivo ou produto. Inclua avisos 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.
Parte 3 de 4: Descrevendo a manutenção do produto
1. Explicar como limpar o dispositivo. Se o seu dispositivo ou produto precisar ser limpo, explique como fazê-lo. Liste os agentes de limpeza necessários. Diga ao leitor com que frequência limpar. Em seguida, como em qualquer outra parte do manual, inclua instruções passo a passo numeradas sobre como limpar.
- Se a limpeza exigir a desmontagem do produto ou a remoção de uma ou mais peças, indique como desmontar o produto.
- Forneça 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. Contar o 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 pelo 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 usadas e como inserir as novas baterias.
3. Discutir opções de armazenamento. O manual deve explicar, se necessário, como armazenar o produto ou dispositivo corretamente. você também deve incluir informações sobre por que o armazenamento é necessário e quais são as consequências do armazenamento incorreto. Por exemplo, você poderia escrever:
4. Fornecer informações de 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. Desta forma, os usuários podem encontrar rapidamente problemas específicos.
Parte 4 de 4: Escrevendo um guia legível
1. Leia outros guias do usuário. Antes de escrever um manual para seu próprio produto, consulte outros manuais de usuário eficazes. Preste atenção à estrutura, escolha de palavras e estrutura da frase. Grandes marcas como Apple, Google e Microsoft produzem guias de usuário fortes e eficazes que podem ajudá-lo a produzir um guia de usuário cuidadosamente escrito.
- Não basta ler tudo manuais do usuário. Leia os manuais de produtos similares 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 guia do usuário mais fácil de usar. 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.
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.
4. Escreva instruções numeradas. As 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 detalhado 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 passo 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 suas etapas com um comando como "Conectar", "Confirmar" ou "Slide". No entanto, não comece suas etapas com uma resposta do sistema.
6. Decida qual vocabulário você usará. Se você escrever um manual de usuário para um ioiô, seu público consistirá principalmente de crianças pequenas. Use palavras e vocabulário simples para explicar como o ioiô funciona. Quando você escreve um manual para um microscópio eletrônico de varredura, seu público é formado por cientistas altamente treinados que podem entender informações muito detalhadas, portanto, não deixe de usar vocabulário especializado ou explicações sutis.
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ê envia seu produto. Você também pode usar uma ferramenta de tradução online, mas peça a um falante nativo para ler a tradução e verificar se há erros.
8. Escreva em frases curtas. Em vez de alguns parágrafos longos, use muitos parágrafos curtos. Procure quebras lógicas em cada seção e digira 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 detalhadas.
9. Verifique o manual quanto a erros. Um manual pode perder credibilidade devido a erros gramaticais e ortográficos. Peça a um colega ou redator técnico que também edite e revise o manual. Além da ortografia e gramática, um revisor deve prestar atenção ao seguinte:
Pontas
- As pessoas aprendem de maneiras diferentes; Se possível e apropriado, inclua recursos visuais ou links para vídeos on-line no manual para acomodar leitores com orientação visual.
Artigos sobre o tópico "Escrevendo um guia do usuário"
Оцените, пожалуйста статью
Similar
Popular
