Crie um guia prático eficaz que envolva seu público

Com que frequência os colegas de trabalho o interrompem para pedir ajuda?

Você sabia que 46% dos trabalhadores são interrompidos mais de seis vezes ao dia? No nosso estudo sobre flexibilidade no local de trabalho, estes funcionários relataram diminuição da produtividade ou maior estresse.

Melhore a qualidade de vida de todos com um pouco de documentação. Aqui está tudo o que você precisa para criar instruções passo a passo com conforto e confiança.

As oportunidades para compartilhar procedimentos, explicações e métodos estão por toda parte.

• Você treina os membros da equipe em um novo processo?
• Integrar clientes ao seu produto ou serviço comercial?
• Facilitar a inscrição aberta no novo software de RH?
• Instruir como esvaziar a borra de café?
• Contribuir para a base de conhecimento do cliente?

Vamos aprender como fazer um guia prático.

Pare de repetir perguntas

Crie vídeos e guias claros com o Snagit para que você só precise explicar as tarefas uma vez.

Experimente grátis

Instruções passo a passo fazem parte de uma base de conhecimento interna

Um tutorial rápido é um guia passo a passo para concluir uma tarefa específica.

• Claro – os leitores devem ser capazes de seguir as etapas. Freqüentemente, isso significa combinar texto com imagens ou vídeos.
• Envolvente – Organize o guia para prender a atenção dos leitores e ajudá-los a economizar tempo.
• Informações relevantes – Forneça contexto e casos de uso que ajudem o leitor a entender por que isso é valioso para ele.

Outras partes importantes de uma base de conhecimento diferem

• Manual de treinamento – Não tente substituir um treinamento aprofundado ou um curso de certificação.
• Guia de referência – Concentre-se em um objetivo específico que seu público pode alcançar.
• Manual do usuário – Inclua algumas dicas, advertências ou informações úteis, nem todos os cenários extremos.
• Postagens de blog – simplifique o conteúdo para estratégias de marketing e campanhas de marketing voltadas para o cliente. Ou substitua por estudos de caso ou listas com marcadores para ajudar nas decisões de compra.

Etapa 1: entenda os pontos fracos do seu público-alvo

“Meça duas vezes, corte uma vez.” O tempo extra inicial vale a pena para garantir a experiência do cliente.

Identifique seus pontos problemáticos

Antes de começar, identifique seu público-alvo, seus objetivos e seus pontos fracos ou lacunas de conhecimento a serem abordadas com seu guia. Pode ser útil:

• Realizar pesquisas
• Leia fóruns online
• Solicite feedback do cliente

Adapte seu guia ao nível de habilidade e ponto de vista do seu público

Você também vai querer saber o conforto dos seus leitores com o assunto. Públicos diferentes têm níveis de habilidade diferentes. Um excelente guia prático adequado às habilidades técnicas do público-alvo, sejam iniciantes ou especialistas.

Revise os termos de pesquisa e feedback sobre treinamentos ou materiais educacionais existentes. Fale com sua equipe de suporte ao cliente para obter informações sobre a experiência do cliente. Entenda as palavras-chave que seu público usa – por exemplo, em pesquisas na Internet. Que linguagem eles usam para descrever o assunto, seus problemas ou pontos de confusão?

Etapa 2: estruture seu guia

“Fácil como 1-2-3” – Crie listas numeradas e marcadores passo a passo

Não é novidade que listas numeradas são mais fáceis de seguir do que uma densa parede de texto. Divida seu guia em etapas discretas ou partes gerenciáveis.

Lembre-se de que o seu público pode alternar entre o seu guia e a tarefa enquanto lê. Numerar ou rotular as etapas ajuda o público a acompanhar.

Parede de texto? Próximo!

O Snagit facilita a comunicação mais eficaz com recursos visuais.

Saber mais

Siga um modelo de guia

Se sua organização criar vários guias ou uma série, considere usar um modelo de guia. Guias consistentes criados a partir do mesmo modelo ajudam seus leitores a saber o que esperar. Também torna a redação de instruções e a criação de guias muito mais rápida e fácil para outras pessoas em sua organização!

Por exemplo, considere incluir no seu modelo uma introdução para identificar:

• O público-alvo do guia.
• O objetivo do guia ou o que o leitor pode esperar realizar.
• Software, ferramentas ou recursos necessários para concluir o processo.
• Informações de contato ou recursos de ajuda caso o leitor tenha problemas.

Considere uma conclusão em seu modelo:

• Para recapitular o propósito ou objetivo do guia, o que o leitor deverá ser capaz de fazer agora?
• Próximas etapas ou guias de acompanhamento da série
• Informações de contato ou recursos de ajuda

Não deixe de conferir os modelos prontos e projetados profissionalmente do Snagit. Temos até uma categoria de modelos de “Etapas” projetadas para acomodar de 2 a 6 etapas em uma única página. Esses modelos também podem ser modificados para adicionar etapas adicionais em mais páginas conforme necessário!

Etapa 3: escreva instruções passo a passo

Crie etapas claras e concisas

Agora é hora de escrever!

Em vez de confiar na minha memória (reconhecidamente fraca), primeiro eu mesmo executo a tarefa, anotando cada passo à medida que avança. Especialmente para tarefas familiares que realizo regularmente, é importante observar possíveis obstáculos para novos usuários.

Certifique-se de que a linguagem e os termos usados ​​em seu guia sejam consistentes com o que o usuário vê na tela.

Atenção! Pergunte a si mesmo se há pontos em que o que você vê pode ser diferente do que o seu público vê ou onde as etapas podem variar. Por exemplo, é possível que o seu leitor esteja usando uma versão de software, sistema operacional ou navegador diferente?

Adicionar imagens

Eu tiro capturas de tela ou fotos em tempo real enquanto percorro a tarefa.

As imagens ajudam a ilustrar uma etapa ou fornecer contexto. Eles ajudam a garantir que seu guia seja fácil de entender e que seu público possa segui-lo, independentemente do nível de habilidade.

Anote as imagens com setas, comentários ou rótulos. Esses tipos de recursos visuais garantem que o leitor conecte o texto e a imagem.

Certifique-se de remover detalhes estranhos das imagens que possam confundir ou distrair o leitor do ponto focal.

Lembra-se do público que você identificou na Etapa 1 e de seu nível de familiaridade? Você precisa explicar onde pode encontrar cada item na tela?

Por exemplo, pode ser útil quando você diz a alguém para clicar no botão “Configurações” para explicar que se parece com uma engrenagem. Você também pode precisar enfatizar a localização de ícones facilmente perdidos ou elementos duplicados na tela.

Etapa 4: adicione informações e recursos adicionais

Inclua links e recursos relevantes

Se a tarefa documentada em seu guia exigir ou puder ser complementada com recursos adicionais, inclua-os. Podem ser arquivos de origem do projeto ou links para tutoriais relacionados ou mais aprofundados.

Isso pode incluir links para download de outros produtos. Seu guia prático não deve ser uma página de vendas ou marketing disfarçada. Se outro software atender melhor às necessidades do seu público, ofereça orientação, especialmente se existirem opções gratuitas.

Forneça contexto e histórico

Ajude seus leitores a entender por que seu guia é útil para eles. Inclua exemplos relevantes ou o que eles deverão ser capazes de fazer depois de seguirem o guia.

Num processo complexo, fornecer informações básicas no guia pode justificar a necessidade de etapas específicas. Esse contexto extra pode ajudar os usuários a compreender o motivo do processo, especialmente se ele não estiver familiarizado.

Anote e edite capturas de tela com o Snagit

Ferramentas profissionais de marcação e recursos poderosos facilitam a criação de imagens úteis.

Experimente grátis

Etapa 5: teste seu guia prático

Garanta precisão e usabilidade

Depois que a lista escrita de etapas com recursos visuais de apoio for montada, revise seu guia para ver se há precisão:

• Você perdeu alguma etapa?
• A linguagem é consistente com o que os leitores verão?
• Para guias de software, certifique-se de que as instruções sejam precisas para todas as versões que seus leitores possam estar usando. Alternativamente, especifique a versão específica coberta e forneça informações sobre onde obter ajuda para outras versões.

Ter outra pessoa revisando seu guia – especialmente alguém não familiarizado com o processo – é sempre uma boa ideia. Essa pessoa pode testá-lo para você como um novo usuário faria. Se houver áreas que você não tem certeza se estão claras, destaque-as para receber atenção especial do seu revisor.

Essa pessoa pode ajudar a garantir que sua documentação não seja apenas precisa, mas fácil de seguir:

• A linguagem é clara e fácil de seguir?
• Existem etapas excessivamente complexas que deveriam ser mais detalhadas?
• As imagens certas estão incluídas para fornecer clareza e contexto?

Saber que alguém pode encontrar erros ou sugerir melhorias em sua documentação pode ser desconfortável. No entanto, é mais provável que seus leitores tenham sucesso se você aproveitar totalmente sua equipe para detectar possíveis problemas.

Se ninguém mais puder revisar o guia, leia-o você mesmo para verificar a precisão e a usabilidade. Espere um ou dois dias a partir de quando terminar de escrever um guia prático antes de revisá-lo, supondo que não esteja dentro do prazo. Isso o ajudará a abordar o guia com uma nova perspectiva, como se você fosse um novo usuário.

Faça revisões com base no feedback

E, claro, revise o guia conforme necessário com base nas avaliações. Esteja preparado para receber feedback do seu público e esteja aberto para iterar seu guia conforme necessário.

Etapa 6: publique e distribua seu guia

Escolha a plataforma certa

Quando chegar a hora de publicar seu guia, considere o melhor local e método de distribuição. Algumas coisas a considerar:

• Se esta documentação for interna, torná-la facilmente localizável pode melhorar significativamente a produtividade.
• Se for voltado ao público, seu guia precisa ser distribuído? Por exemplo, enviado por e-mail por equipes de vendas ou gerentes de sucesso do cliente para novos clientes?
• Ou, se colocado em seu site, como o público-alvo o encontrará?
• Se você planeja compartilhar seu guia amplamente, é melhor enviar links on-line em vez de usar PDFs ou postar em vários lugares. Gerencie guias em um único local para facilitar atualizações e evitar a circulação de versões desatualizadas.
• Alguns de seus leitores terão perguntas, comentários ou dicas que serão úteis para outras pessoas? Considere postar seu guia em uma plataforma com conversas integradas, como o Screencast.

Otimize para SEO

Se postado publicamente, como o público-alvo encontrará seu guia?

Certifique-se de que suas instruções correspondam ao conteúdo da tela. As seções descritivas do seu guia devem refletir a linguagem dos seus leitores sempre que possível.

Pesquisar seu público na Etapa 1 lhe dará uma visão sobre sua linguagem. Incorpore isso em seu guia para ajudar as pessoas a encontrá-lo.

Considere usar ferramentas de otimização de SEO, como SEMrush ou o plugin Yoast para WordPress. Melhorar o SEO melhora a capacidade de encontrar seu conteúdo quando necessário.

Recapitulação: práticas recomendadas para escrever um guia prático de como fazer

Use uma linguagem simples e direta

A parte mais importante da avaliação de um guia prático é determinar se ele é fácil de seguir. Use uma linguagem simples e direta que seus usuários possam seguir, independentemente do nível de habilidade.

Inclua imagens para esclarecer cada etapa

Ajude a evitar confusão para seus leitores. Mostre o que você quer dizer com uma captura de tela ou foto anotada para cada etapa.

Atualize seu guia regularmente

Certifique-se de que seu guia permaneça preciso, revisando-o e atualizando-o regularmente. Se disponíveis online, as atualizações também ajudam a melhorar o SEO e a classificação.

A parte importante: facilite para você

Não deixe que a criação de um guia prático demore mais do que o treinamento em si!

Use o Snagit, líder de mercado em software de captura de tela. Você vai adorar usar uma solução completa para captura de tela, criação de GIFs, anotações, modelos e opções flexíveis de exportação.

Pare de repetir perguntas

Crie vídeos e guias claros com o Snagit para que você só precise explicar as tarefas uma vez.

Experimente grátis