Os guias “como fazer” são um dos formatos de conteúdo mais úteis e mais procurados na web. Com a Trupeer, pode poupar horas na escrita de guias “como fazer” começando com um modelo de guia “como fazer” gratuito, personalizando-o com as suas diretrizes de marca e transformando cada guia num vídeo tutorial envolvente.

Escrever passos individuais é a parte fácil de um guia. A parte difícil é decidir o que deve incluir, por que ordem e onde termina.

Se errar estas três coisas, produz a falha comum: um documento com quarenta páginas que abrange tudo, mas que ninguém lê, substituído no espaço de um mês por alguém que pede a um colega.

Descarregar o modelo de guia “como fazer”

Gratuito, editável, sem marca de água. O ficheiro Excel vale a pena usar primeiro, porque a definição do âmbito é a parte que determina se o guia funciona.

Como personalizar este modelo na Trupeer

Passo 1: Abrir a secção de Modelos

Vá à secção de Modelos no menu principal.

Passo 2: Selecionar e abrir um modelo

Clique em qualquer modelo com que queira trabalhar para o abrir.

Passo 3: Expandir a visualização do modelo

Se necessário, expanda a visualização do modelo para ver o layout completo e os detalhes com clareza.

Passo 4: Editar o modelo

Clique em Editar para começar a modificar o modelo selecionado.

No editor, pode:

• Adicionar novas secções

• Definir ou atualizar regras de formatação

• Adicionar um logótipo e ajustar a sua posição e definições relacionadas

Passo 5: Guardar o seu modelo personalizado

Depois de fazer todas as alterações necessárias, clique em Guardar para guardar o modelo atualizado como seu.

Passo 6: Pré-visualizar e afinar o modelo

Quando quiser ver como fica o seu modelo personalizado, abra a Pré-visualização.

A partir do ecrã de pré-visualização, pode continuar a fazer ajustes diretamente, se necessário, garantindo que o modelo aparece exatamente como o pretende.

Com um modelo de guia “como fazer” pode:

• Poupar horas na escrita: Evite a página em branco com uma estrutura criada para conteúdos “como fazer”.

• Melhorar o SEO: Os guias “como fazer” bem estruturados têm melhor desempenho nos resultados de pesquisa.

• Manter-se alinhado com a marca: Aplique o seu logótipo, fontes e cores usando o brand kit da Trupeer.

• Reduzir pedidos de suporte: Guias “como fazer” claros ajudam os utilizadores a resolverem-se sozinhos.

• Adicionar walkthroughs em vídeo: Incorpore vídeo para passos difíceis de explicar por texto.

• Atingir leitores globais: Traduza guias “como fazer” para 65+ idiomas com um clique.

Guia ou artigo?

Dois documentos diferentes, e escolher mal desperdiça o esforço.

Se alguém que procura uma única tarefa chega ao seu guia, tem de encontrar a sua parte dentro dele, o que é uma experiência pior do que a que um artigo lhe daria.

A abordagem prática para a maioria das equipas é ter as duas: um guia para integrar alguém numa área e artigos separados para cada tarefa, com ligações cruzadas. Use o modelo de artigo “como fazer” para as peças individuais.

Defina o estado inicial e o estado final

Antes de escrever qualquer coisa, responda com precisão a duas perguntas.

Por onde começa o leitor? O que já sabe, que acesso já tem e o que já fez? Um guia escrito para alguém com mais contexto do que o leitor real falha nas duas primeiras páginas.

Onde termina? Não “entende o sistema”, mas algo observável. “Consegue processar um reembolso do início ao fim, incluindo as exceções” é um estado final. “Está familiarizado com o módulo de reembolsos” não é.

Tudo o que está no guia faz com que o leitor avance do primeiro para o segundo ponto ou desaparece. Este teste único elimina cerca de um terço do conteúdo da maioria dos primeiros rascunhos.

Definir o âmbito do guia

O inventário de tarefas no ficheiro Excel existe para isso. Liste todas as tarefas da área e, depois, decida para cada uma.

Três resultados por tarefa: incluí-la, criar uma ligação para ela ou deixá-la de fora. Escrever o motivo é o que impede que o âmbito volte a crescer mais tarde, porque alguém vai perguntar.

O erro de âmbito mais comum é incluir tudo o que alguém possa alguma vez precisar, o que produz um guia demasiado longo para ler e, por isso, pior nas tarefas essenciais do que um guia mais curto.

Sequenciação

A ordem importa mais num guia do que em qualquer outro tipo de documento, porque o leitor o percorre de forma linear.

• Pré-requisitos e acesso primeiro. Ninguém consegue seguir nada até conseguir iniciar sessão.

• A tarefa completa mais simples, a seguir. Fazer uma coisa do início ao fim cedo cria confiança e contexto para tudo o que vem depois.

• Depois as variações comuns, construindo sobre o que já sabem.

• As exceções e casos-limite por último. Só fazem sentido depois de compreender o caminho normal.

• Material de referência no fim, e não espalhado.

O impulso de explicar tudo antes de deixar alguém fazer qualquer coisa é o erro de sequenciação mais comum. Os leitores retêm mais quando já fizeram algo primeiro.

A estrutura do guia

A página de conteúdos não é opcional num guia. É como um leitor que já o leu uma vez volta para encontrar uma coisa.

Anatomia da secção

Cada secção do guia segue a mesma forma, o que torna o documento todo navegável.

Título da secção. A tarefa, como o leitor a descreveria.

Quando é que faria isto. Uma linha de contexto. Os guias diferem dos artigos aqui: o leitor está a aprender, por isso um pouco de enquadramento ajuda.

Passos. Numerados, uma ação por passo, primeiro o verbo, rótulos exatos da interface.

O que deve ver. O resultado esperado.

Atenção a. Qualquer coisa específica desta tarefa que normalmente dá errado.

A consistência entre secções importa mais do que a estrutura perfeita para qualquer uma em particular. Um leitor que aprende o padrão na secção um navega a secção sete mais depressa.

Um esquema com exemplo

Guia: Processar reembolsos. Para: Novos agentes de suporte, nas duas primeiras semanas. Estado final: Consegue processar qualquer reembolso padrão ou parcial sem ajuda e sabe quando é preciso escalar.

Nota a secção 3. Cobre apenas o que difere da secção 2, em vez de repetir todo o fluxo. Os guias que repetem todos os passos para cada variação ficam longos, e o comprimento é a principal razão pela qual não são lidos.

Escrever os passos

As mesmas regras de qualquer texto instrucional, abordadas com mais profundidade no modelo de artigo “como fazer”.

Uma ação por passo. Primeiro o verbo. Rótulos exatos da interface com capitalização exata. Diga onde antes do quê. Numere-os. Indique o resultado esperado no fim.

A única diferença num guia: pode assumir que o leitor já leu as secções anteriores. A secção 6 não precisa de explicar como abrir o ecrã de reembolsos se a secção 2 já o cobriu. Esta suposição é o que mantém um guia mais curto do que a soma dos seus artigos, e é também por isso que um guia funciona bem para leitores que o percorrem de forma linear e mal para leitores que procuram.

Capturas de ecrã e elementos visuais

• Mais num guia do que num artigo, porque o leitor está a aprender em vez de executar e tem mais atenção disponível.

• Corte com precisão e anote de forma leve, uma caixa ou uma seta.

• Mostre o resultado, não apenas o botão, para tudo o que o resultado não seja óbvio.

• Um diagrama do fluxo geral, uma vez, perto do início. Os guias beneficiam de uma imagem do todo de uma forma que os artigos individuais não fazem.

• Considere a manutenção. Cada captura de ecrã é uma atualização futura. Um guia com quarenta capturas é um compromisso recorrente significativo, e capturas desatualizadas enfraquecem todo o documento.

Onde um guia deve terminar

Três limites naturais.

No limite da função. Se a próxima tarefa for de outra pessoa, pare e diga quem a faz.

No limite da frequência. Qualquer coisa feita menos do que algumas vezes por ano deve estar num artigo separado em vez do guia, porque de qualquer forma não será retida e aumenta o tamanho.

No limite da referência. Listas de valores, códigos, limites e opções são consultas, não aprendizagem. Coloque-as no fim ou num documento de referência separado.

Um guia que continua para além destes três limites torna-se um manual, que é um documento legítimo, mas diferente, com um tipo de leitor diferente.

Guia, manual, SOP ou instrução de trabalho

A sobreposição entre um guia e um manual é real, e a diferença prática é se foi concebido para ser lido do princípio ao fim. Um guia é. Um manual é uma referência que se consulta. Se o seu documento tiver as duas funções, divida-o, porque a estrutura que serve uma não serve a outra.

Para os outros: modelo de manual de formação, modelo de SOP, modelos de instruções de trabalho.

Formatos

Word para escrever e rever, já que um guia passa por mais revisões do que um artigo e os comentários importam.

PDF para distribuição, especialmente quando o guia é entregue a alguém na integração ou usado fora de um ecrã.

PowerPoint quando o guia também é entregue como formação. Uma secção por grupo de slides e o documento do guia torna-se o material para levar.

A sua central de ajuda se precisar de ser encontrada por pesquisa, embora um guia longo numa central de ajuda seja normalmente melhor dividido em artigos com uma página de conteúdos que os ligue.

Excel para o inventário de tarefas, antes de escrever.

Testar o guia

O passo que as pessoas saltam e o único que o melhora de forma fiável.

Dê o rascunho a alguém que corresponda ao estado inicial, ou seja, genuinamente novo na área, em vez de um colega experiente. Peça-lhes que o percorram sem ajuda. Fique com eles e não diga nada.

Todas as perguntas que fizerem são um defeito. Todas as hesitações assinalam um passo pouco claro. Todos os momentos em que voltam atrás ao ecrã são um problema de sequenciação. Registe-os todos em vez de responder.

Um teste com uma pessoa genuinamente nova vai melhorar um guia mais do que três rondas de revisão por pessoas que já conhecem o material, porque os revisores que conhecem a tarefa não conseguem ver o que está em falta.

Manter o guia

Os guias degradam-se mais depressa do que parecem, porque cobrem várias tarefas e qualquer alteração numa delas torna parte do guia incorreta.

Indique um responsável. Registe a versão do produto. Revise após qualquer lançamento que afete a área e, caso contrário, num ciclo fixo.

Versão por secção, sempre que possível, para que uma alteração a uma tarefa não exija republicar o documento inteiro. E mantenha uma nota de alterações no início, porque alguém que o leu há três meses precisa de saber o que mudou.

O sinal de que um guia ficou desatualizado é as pessoas fazerem perguntas que ele cobre. Acompanhe isso, porque significa ou que o conteúdo está errado ou que o guia não está a ser entregue às pessoas que precisam dele.

Boas práticas

• Defina os estados inicial e final antes de escrever.

• Defina o âmbito com um inventário de tarefas, registando por que razão cada tarefa está incluída ou excluída.

• A tarefa completa mais simples, cedo; exceções, tarde.

• As variações cobrem apenas o que difere do caminho principal.

• Página de conteúdos, sempre.

• Estrutura consistente entre secções.

• Material de referência no fim, sem dispersão.

• Termine nos limites da função, frequência e referência.

• Teste com alguém que corresponda genuinamente ao estado inicial.

• Um responsável, um ciclo de revisão, versão registada.

Erros comuns

• Sem estado final definido, pelo que o guia não tem um ponto natural de paragem.

• Tudo incluído, produzindo um documento que ninguém lê.

• A teoria toda antes de qualquer ação.

• Todas as variações escritas na íntegra, triplicando o tamanho.

• Sem página de conteúdos, pelo que não pode ser usado como referência depois.

• Tabelas de referência espalhadas pelas secções.

• Escrito para alguém com mais contexto do que o leitor real.

• Testado apenas por pessoas que já conhecem a tarefa.

• Capturas de ecrã em todo o lado e, depois, nunca atualizadas.

• Um guia usado onde era necessário um artigo, pelo que quem pesquisa chega a um documento com quarenta páginas.

• Sem responsável identificado, pelo que fica desatualizado em silêncio.

Registe o trabalho uma vez e obtenha o guia a partir disso

Abra o modelo na Trupeer AI, aplique o seu brand kit para que os guias correspondam à sua outra documentação e edite qualquer secção diretamente. A configuração está no guia do modelo.

As duas partes mais “caras” de um guia são as capturas de ecrã e o facto de ter sido escrito a partir da memória. Escrever a partir da memória ignora os passos que o autor executa automaticamente, que são exatamente onde um novo leitor se fica. E um guia que cobre seis tarefas precisa de capturas de ecrã suficientes para que atualizar depois de uma alteração de interface se torne um projeto.

Registe cada tarefa uma vez e a Trupeer AI gera os passos escritos com capturas de ecrã capturadas automaticamente, além de um walkthrough em vídeo narrado a partir da mesma passagem. Isso dá-lhe o material bruto para cada secção, na ordem em que o trabalho acontece de facto, e voltar a gravar após uma alteração é mais rápido do que voltar a tirar capturas.

Traduza-o para 65+ idiomas e mantenha o conjunto na sua base de conhecimento, para que o guia e os walkthroughs individuais vivam juntos. Útil para integração e formação, que é onde a maioria dos guias é usada.

Registe. Dê marca. Traduza. Trupeer.

Perguntas Frequentes

Existe um modelo de guia “como fazer” gratuito no Word?

Sim. O Word é o formato principal, com a página de conteúdos, a estrutura das secções e a formatação dos passos já configuradas. Descarregamento gratuito, sem registo, sem marca de água.

Existe um modelo gratuito de guia passo a passo no Word?

Sim, é o mesmo modelo. Inclui o formato de passos numerados com espaço para capturas de ecrã, resultados esperados e uma nota de “atenção a” por secção.

Existe um modelo gratuito de guia passo a passo?

Sim, no Word, PDF, PowerPoint e Excel. Se só precisar de uma tarefa em vez de um guia completo, o modelo de artigo “como fazer” é a opção mais curta.

Existe um modelo gratuito de guia de utilizador passo a passo no Word?

Sim. Um guia de utilizador é um guia “como fazer” direcionado ao utilizador final de um produto, pelo que se aplica a mesma estrutura. Adicione uma secção de visão geral do produto perto do início e mantenha o material de referência, ou seja, definições, limites e opções, no fim em vez de misturar com as tarefas.

Existe um modelo gratuito de guia “como fazer” no PDF?

Sim, tanto como formato de distribuição como um exemplo completo, para poder ver um guia final antes de escrever o seu.

Existe um modelo gratuito de guia “como fazer” no PPT ou PowerPoint?

Sim. A versão PowerPoint é para entregar o guia como formação, com um grupo de slides por secção. A maioria das equipas precisa da versão Word ao lado, porque um deck é um material de referência fraco depois.

Existe um modelo gratuito de guia “como fazer” no Excel?

Sim, embora o Excel mantenha o inventário de tarefas em vez do guia. Lista todas as tarefas da área, marca cada uma como incluir, ligar ou excluir e regista o porquê. A definição do âmbito é a parte que determina se o guia funciona, e fazer isso numa folha de cálculo antes de escrever poupa a reescrita mais tarde.

Posso descarregar um modelo gratuito de guia “como fazer”?

Sim, todos os formatos são descarregamentos gratuitos sem necessidade de conta e sem atribuição.

O que é um guia “como fazer”?

Um documento que leva um leitor de não saber como fazer algo até conseguir fazê-lo, cobrindo várias tarefas relacionadas em sequência. Distingue-se de um artigo, que cobre uma tarefa para alguém que já está a meio do trabalho, e de um manual, que é material de referência em vez de algo lido do princípio ao fim.

O que deve incluir um guia “como fazer”?

Um título que indique o que o leitor vai conseguir fazer, para quem é e que conhecimento é assumido, o estado final descrito como capacidades, pré-requisitos, uma página de conteúdos, secções que cobrem uma tarefa cada, resolução de problemas consolidada, material de referência no fim, uma fonte de ajuda identificada e detalhes de versão e responsável.

Como se escreve um guia passo a passo?

Defina por onde o leitor começa e termina, crie um inventário de tarefas e decida o que entra ou fica de fora, sequencie da tarefa completa mais simples para as exceções, escreva uma ação por passo com rótulos exatos da interface, adicione resultados esperados e, por fim, teste com alguém que corresponda genuinamente ao estado inicial e corrija tudo o que essa pessoa não conseguir.

Quanto tempo deve ter um guia “como fazer”?

Tanto quanto for necessário para chegar ao estado final e não mais. A disciplina é a definição do âmbito, não a contagem de palavras: cada secção deve levar o leitor para a capacidade de finalização definida, e tudo o que não o fizer deve ser removido. A maioria dos primeiros rascunhos perde cerca de um terço com este teste.

Qual é a diferença entre um guia e um manual?

Um guia foi concebido para ser lido do princípio ao fim e torna alguém competente. Um manual é material de referência que cobre tudo sobre um produto, consultado em vez de lido. Se o seu documento estiver a tentar fazer as duas coisas, divida-o, porque a estrutura que serve para leitura do princípio ao fim é inadequada para procurar informações.

Qual é a diferença entre um guia “como fazer” e uma SOP?

Um guia ensina alguém uma área de trabalho e inclui algum raciocínio. Uma SOP padroniza como um procedimento específico é executado, é seguida em vez de aprendida e, normalmente, tem responsáveis, aprovação e um ciclo de revisão. Um guia pode referenciar várias SOPs.

Como se testa um guia “como fazer”?

Dê-o a alguém que corresponda genuinamente ao conhecimento inicial assumido, peça-lhe que o percorra sem ajuda e observe sem intervir. Todas as perguntas são um defeito e todas as hesitações assinalam um passo pouco claro. Os revisores que já conhecem a tarefa não conseguem ver o que está em falta, por isso um teste com alguém novo supera várias rondas de revisão por especialistas.

Com que frequência deve ser atualizado um guia “como fazer”?

Após qualquer alteração que afete as tarefas que cobre e, caso contrário, num ciclo fixo; normalmente de seis a doze meses. Versão por secção, sempre que possível, para que uma tarefa que mude não exija republicar o guia inteiro.

Posso personalizar este modelo de guia “como fazer”?

Sim, cada versão é totalmente editável. Vale a pena manter a estrutura das secções consistente mesmo que altere o que está incluído, porque uma forma previsível é o que torna um guia com várias secções navegável.

Modelos relacionados

• Modelo de artigo “como fazer”

• Modelo de manual de formação

• Modelo de SOP

• Modelos de instruções de trabalho

• Modelo de job aid

• Modelo de documentação técnica

• Modelo de base de conhecimento

• Modelo de documentação de processos

• Modelo de guia de integração de novos colaboradores