Use este modelo
Os artigos “como fazer” estão entre os formatos de conteúdo com maior tráfego na web. Com a Trupeer, pode poupar horas na criação de artigos “como fazer” começando com um modelo gratuito de artigo “como fazer”, personalizando-o com as suas diretrizes de marca e transformando cada artigo num vídeo tutorial envolvente que dá aos leitores uma segunda forma de aprender.
Um artigo “como fazer” coloca o leitor num estado muito específico. Ele está a meio de algo, não está a funcionar e já passou mais tempo do que queria. Não está a ler; está a procurar o trecho que o desbloqueia.
Quase todas as regras para escrever este tipo de conteúdo decorrem disso.
Descarregar o modelo de artigo “como fazer”
Formato | Melhor para |
|---|---|
Word (.docx) | Rascunhar e rever antes de o publicar no seu centro de ajuda |
Guias imprimíveis, packs de onboarding, referência offline | |
PowerPoint (.pptx) | Transformar um “como fazer” num deck de formação ou em slides de walkthrough |
Google Docs | Rascunhar com a pessoa que, de facto, executa a tarefa |
Excel (.xlsx) | O inventário do artigo: título, responsável, última revisão, origem |
Gratuito, editável, sem marca de água.
As três formas como um artigo “como fazer” falha
Todas as falhas são uma destas, e exigem correções diferentes.
Barreira | A pergunta do leitor | O que resolve |
|---|---|---|
Encontrar | Existe um artigo sobre isto? | O título e onde está indexado |
Confirmar | Este é o artigo certo para a minha situação? | O bloco de abertura e os pré-requisitos |
Concluir | Consigo mesmo chegar ao fim? | Qualidade dos passos, capturas de ecrã, resolução de problemas |
A maioria dos conselhos de escrita aborda a terceira barreira. A maioria dos artigos falha nas duas primeiras.
Barreira um: o título
Se o título não corresponde às palavras que o leitor usaria, o artigo não existe, pelo menos para ele.
Escreva a tarefa, não a funcionalidade. “Como exportar o seu relatório para CSV” é melhor do que “Usar o módulo de exportação”. As pessoas pesquisam o que estão a tentar fazer.
Use o vocabulário deles. O nome interno de uma funcionalidade não é o que os clientes lhe chamam. Recolha a formulação de tickets de suporte e da pesquisa no site.
Comece pelo verbo. “Como redefinir a sua palavra-passe” é mais rápido de pesquisar do que “Redefinições de palavra-passe: um guia”.
Seja específico o suficiente para ser exclusivo. “Como adicionar um utilizador” é ambíguo se tiver três tipos de utilizador. “Como adicionar um utilizador administrador a um workspace” não é.
Uma tarefa por título. Se o título contiver “and”, tem dois artigos.
Barreira dois: a abertura
O leitor chegou. Tem cerca de cinco segundos para decidir se esta é a página certa.
O bloco de abertura responde a três perguntas antes de começarem os passos.
O que este artigo faz. Uma frase. “Este artigo mostra-lhe como ligar o seu sistema de contabilidade para que as faturas sincronizem automaticamente.”
Para quem é. Qualquer função, requisito de permissão ou de plano. “Precisa de acesso de administrador para fazer isto.”
O que precisa primeiro. Pré-requisitos, declarados antes do primeiro passo em vez de serem descobertos no quarto passo.
Este último evita a frustração mais comum na documentação técnica: chegar a três passos e descobrir que precisa de algo que não tem. Os pré-requisitos devem estar no topo, sempre.
Indique o tempo previsto quando for mais do que alguns minutos. “Isto demora cerca de 15 minutos” permite a alguém decidir se deve começar agora ou voltar mais tarde.
Barreira três: os passos
Onde o leitor termina ou desiste.
Uma ação por passo. Se um passo contiver “and then”, divida-o.
Comece cada passo pelo verbo. “Clique em Definições” e não “Deve clicar em Definições”.
Diga onde antes do quê. “No canto superior direito, clique em Exportar” diz-lhes onde devem procurar primeiro.
Nomeie o que vão ver. Rótulos exatos dos botões, com a capitalização exata. Se o botão diz “Save & close”, escreva isso.
Numere-os. As listas com marcadores implicam que a ordem não importa.
Mantenha abaixo de dez passos sempre que possível. Tarefas mais longas devem ser divididas em fases com subtítulos.
Mostre o resultado. Após o último passo, diga o que deve ser verdade agora. “A sincronização é executada a cada hora. Vai ver a hora da última sincronização na página de integrações.”
Não explique o “porquê” a meio da tarefa. O leitor está a executar, não a aprender. Coloque a justificação numa nota ou num artigo de conceito separado.
Como personalizar este modelo na Trupeer
Passo 1: Abrir a secção Templates
Aceda à secção Templates no menu de navegação principal.
Passo 2: Selecionar e abrir um modelo
Clique em qualquer modelo com que pretenda trabalhar para o abrir.
Passo 3: Expandir a vista do modelo
Se necessário, expanda a vista do modelo para ver o layout completo e os detalhes com clareza.
Passo 4: Editar o modelo
Clique em Edit 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 Save 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.
No ecrã de pré-visualização, pode continuar a fazer ajustes diretamente, se necessário, garantindo que o modelo aparece exatamente como o quer.
Com um modelo de artigo “como fazer” pode:
Poupar horas na escrita: Ignore a página em branco com uma estrutura criada para conteúdos “como fazer”.
Posicionar na pesquisa: Os “como fazer” bem estruturados com schema HowTo têm bom desempenho no Google.
Manter-se alinhado com a marca: Aplique o seu logótipo, fontes e cores usando o kit de marca da Trupeer.
Reduzir a carga de suporte: Artigos “como fazer” claros ajudam os utilizadores a resolverem-se sozinhos.
Adicionar walkthroughs em vídeo: Incorporar tutoriais em vídeo para passos difíceis de explicar em texto.
Atingir leitores globais: Traduzir artigos “como fazer” para 65+ idiomas com um clique.
O modelo de artigo “como fazer”
Secção | Conteúdos |
|---|---|
Título | Baseado em tarefas, primeiro o verbo, uma tarefa |
Resumo | Uma frase sobre o que isto permite |
Para quem é | Função, permissão, plano |
Antes de começar | Pré-requisitos, acesso, informações necessárias |
Tempo necessário | Quando é mais do que alguns minutos |
Passos | Numerados, uma ação por cada, com capturas de ecrã |
Resultado | O que deve ser verdade agora |
Resolução de problemas | As três ou quatro coisas que normalmente correm mal |
Artigos relacionados | A próxima tarefa provável e o artigo de conceito, se existir |
Metadados | Responsável, última revisão, versão do produto |
Dez secções, das quais quatro são curtas. A maior parte são os passos e a resolução de problemas.
Capturas de ecrã
A diferença entre um artigo “como fazer” utilizável e uma parede de instruções.
Uma captura de ecrã por passo quando a interface não é óbvia. Não em todos os passos, ou o artigo deixa de ser fácil de consultar.
Corte para a área relevante. Uma captura em ecrã inteiro faz o leitor ter de procurar o que quis dizer.
Faça anotações de forma leve. Uma caixa ou uma seta. Várias anotações competem entre si.
Mostre o estado, não apenas a localização. Quando um passo altera algo, um antes e depois vale mais do que uma única imagem.
Evite dados pessoais ou de clientes. Use uma conta de demonstração e verifique as abas do browser e as notificações no canto da sua captura.
Registe o custo de manutenção. As capturas de ecrã ficam desatualizadas a cada alteração da interface, e as capturas desatualizadas minam a confiança no artigo inteiro. Este é o argumento mais forte para gravar em vez de capturar.
Resolução de problemas
A secção que separa um artigo competente de um artigo verdadeiramente útil — e a que mais frequentemente é omitida.
Liste as três ou quatro coisas que realmente correm mal, pelas palavras do leitor, com a respetiva correção.
Não aparece nada após o passo 4. Normalmente significa que a ligação ainda não terminou de autorizar. Espere um minuto e atualize. Se continuar vazio, a conta pode não ter a permissão necessária.
O botão está esbatido. Precisa de acesso de administrador para isto. Peça a quem configurou o seu workspace.
Funcionou, mas os dados parecem estar errados. Verifique o filtro do intervalo de datas, que por predefinição está no mês atual.
Recolha estas informações a partir de tickets de suporte, em vez de imaginação. Se quatro pessoas lhe contactarem com o mesmo problema depois de seguirem o artigo, então esse problema deve constar no artigo.
Fraco e melhor
Fraco: Os utilizadores podem configurar definições de exportação através do módulo de relatórios para obter dados em vários formatos, conforme necessário.
Melhor: Para exportar um relatório para CSV: 1. Abra o relatório. 2. No canto superior direito, clique em Export. 3. Escolha CSV e clique em Download. O ficheiro aparece na sua pasta de downloads e inclui todas as colunas atualmente visíveis no relatório.
Fraco: Passo 3: Configure as definições de integração de forma adequada e guarde as suas alterações.
Melhor: 3. Introduza a chave de API do seu sistema de contabilidade. 4. Defina a frequência de sincronização como Horária. 5. Clique em Save & test. Deve ver uma etiqueta verde “Connected”.
A primeira versão é um passo que faz três coisas, sem forma de saber se funcionou. A segunda são três passos com um resultado verificável.
Título fraco: Guia de configuração da integração
Título melhor: Como ligar o seu sistema de contabilidade
Abertura fraca: Este artigo fornece uma visão geral da funcionalidade de exportação disponível na plataforma.
Abertura melhor: Este artigo mostra-lhe como exportar um relatório para CSV, Excel ou PDF. Precisa de acesso de visualização ao relatório. Demora cerca de um minuto.
Tipos de artigo de documentação
Um “como fazer” é um de quatro tipos, e misturá-los é o erro estrutural mais comum na documentação.
Tipo | Responde | Estado do leitor | Formato |
|---|---|---|---|
Como fazer | Como faço esta tarefa específica? | Ficou preso, a meio da tarefa, impaciente | Passos numerados |
Conceito | O que é isto e porque funciona assim? | A aprender, tem tempo | Prosa com exemplos |
Referência | Quais são os valores e opções exatos? | Procura uma coisa | Tabelas e listas |
Tutorial | Ensine-me isto do zero | Novo, disposto a acompanhar | Sequência orientada com um exemplo resolvido |
O erro é explicar conceitos dentro de um “como fazer”. O leitor está a executar e não quer o contexto. Em vez disso, ligue ao artigo de conceito e mantenha os passos limpos.
O erro inverso é um artigo de conceito com três passos escondidos no meio, que ninguém vai encontrar quando precisar deles.
Tamanho do artigo
Mais curto do que o instinto sugere. Um artigo “como fazer” deve cobrir uma tarefa e parar.
Se passar de dez passos, procure uma divisão natural. “Como configurar X” é muitas vezes, na realidade, “Como criar X”, “Como configurar X” e “Como convidar pessoas para X”, que são três artigos que podem ser encontrados independentemente e ligados em sequência.
Artigos longos também falham na barreira um, porque um único artigo que cobre seis tarefas só pode ter um título, o que significa que cinco dessas tarefas não são encontráveis.
Formatos
Word para rascunhar e rever, porque as alterações controladas e os comentários tornam o ciclo de revisão mais gerível. É aqui que a maioria dos artigos deve ser escrita antes de chegar a qualquer sistema de publicação.
PDF para tudo o que é impresso, entregue em formação ou necessário offline. Também é o formato certo para um guia voltado para o cliente que anexa a um email.
PowerPoint quando um “como fazer” se torna formação. Um passo por slide, com uma captura de ecrã em cada, funciona bem para uma sessão de walkthrough.
O seu centro de ajuda ou base de conhecimento para tudo o que é voltado para o cliente e precisa de ser encontrável e pesquisável — o que é a maioria. Word e PDF são formatos de rascunho e distribuição, não de publicação.
Manter artigos
A documentação degrada-se silenciosamente, e a documentação desatualizada é pior do que nenhuma, porque as pessoas seguem-na e falha.
Atribua um responsável por artigo. Registe a versão do produto para a qual foi escrito. Revise após qualquer lançamento que afete a funcionalidade e, caso contrário, num ciclo fixo.
O sinal de manutenção mais fiável é um ticket de suporte sobre algo que o artigo cobre. Isso significa que ou o artigo está errado, ou está certo, mas não é encontrável. Ambos valem a pena corrigir e ambos são invisíveis a menos que alguém esteja atento.
As capturas de ecrã são o elemento que mais exige manutenção, por isso vale a pena considerar quantas usa e como as produz.
Medir se funciona
Visualizações, que lhe dizem se é encontrável.
Tickets de suporte sobre o mesmo tema após a publicação. Devem diminuir. Se não diminuírem, o artigo não está a funcionar ou não é encontrável.
Termos de pesquisa sem resultados, que mostram quais os artigos em falta.
Tempo na página, interpretado com cuidado. “Longo” pode significar completo ou confuso.
Feedback do artigo, se o seu centro de ajuda o disponibiliza, embora as taxas de resposta sejam normalmente baixas.
Desvio, ou seja, pessoas que viram o artigo e depois não contactaram o suporte.
O número único mais útil é o volume de suporte sobre o tema antes e depois da publicação. O resto é apenas um indicador indireto.
Como escrever um artigo “como fazer”
Descubra o que as pessoas perguntam mesmo, a partir de tickets de suporte e da pesquisa no site. Não adivinhe o tema.
Escreva primeiro o título, como uma tarefa nas palavras do leitor. Se não conseguir, o âmbito não está claro.
Faça a tarefa você mesmo enquanto escreve, ou veja alguém a fazê-la. Os artigos escritos a partir da memória falham passos.
Liste os pré-requisitos à medida que os encontra.
Escreva uma ação por passo, primeiro o verbo, com os rótulos exatos da interface.
Capture ou grave enquanto avança, e não depois a partir da memória.
Indique o resultado esperado.
Adicione resolução de problemas a partir de tickets reais.
Peça a alguém que não esteja familiarizado para o seguir sem ajuda. Cada pergunta que fizer é um defeito.
Publique e depois observe o volume de suporte nesse tema.
O passo nove é o único teste real. Um artigo revisto por alguém que já conhece a tarefa será sempre lido com qualidade.
Boas práticas
Títulos baseados em tarefas, no vocabulário do leitor.
Pré-requisitos antes do passo um, sempre.
Uma ação por passo, primeiro o verbo.
Rótulos exatos da interface, capitalização exata.
Capturas de ecrã recortadas e com anotações leves.
Resultado esperado indicado após o último passo.
Resolução de problemas baseada em tickets reais.
Uma tarefa por artigo, com menos de dez passos.
Conceitos ligados, não incorporados.
Testado por alguém que não fez a tarefa.
Erros comuns
Títulos nomeados a partir de funcionalidades, em vez de tarefas.
Pré-requisitos descobertos no passo quatro.
Passos com três ações cada.
Instruções vagas como “configure as definições de forma adequada”.
Rótulos da interface parafraseados em vez de citados.
Capturas de ecrã em ecrã inteiro, sem recorte.
Dados de clientes visíveis numa captura de ecrã.
Sem resultado esperado, por isso o leitor não consegue saber se funcionou.
Sem secção de resolução de problemas.
Conceitos explicados dentro dos passos.
Seis tarefas num só artigo, cinco delas não encontráveis.
Escrito a partir da memória, em vez de ser feito executando a tarefa.
Revisto apenas por pessoas que já sabem como se faz.
Capturas de ecrã nunca atualizadas após uma alteração da interface.
Registe a tarefa em vez de a escrever a partir da memória
Abra o modelo na Trupeer AI, aplique o seu kit de marca para que os artigos correspondam à sua documentação e edite qualquer secção diretamente. A configuração está no guia do modelo.
Duas coisas tornam os artigos “como fazer” caros. Escrever a partir da memória ignora os passos que executa automaticamente — exatamente onde os leitores ficam presos. E as capturas de ecrã são lentas de produzir e ficam desatualizadas a cada alteração da interface, razão pela qual tantos artigos mostram uma versão do produto que já não existe.
Registar resolve ambos os problemas. Execute a tarefa uma vez e a Trupeer AI produz o artigo escrito com os passos na ordem em que aconteceram de facto e com capturas de ecrã capturadas automaticamente, além de um video walkthrough narrado a partir da mesma sessão. Quando a interface mudar, volte a registar em vez de voltar a capturar.
Traduza-o para 65+ idiomas e mantenha o conjunto na sua base de conhecimento, onde os leitores o encontrarão.
Registe. Dê marca. Traduza. Trupeer.
Perguntas Frequentes
Existe um modelo gratuito de artigo “como fazer” em Word?
Sim. O Word é o formato principal e o local certo para rascunhar, uma vez que a revisão com alterações controladas é mais fácil do que num sistema de publicação. Inclui toda a estrutura com prompts em cada secção. Descarregamento gratuito, sem registo, sem marca de água.
Existe um modelo de artigo em Word, gratuito para descarregar?
Sim, e funciona para qualquer artigo instrucional, não apenas para os passo a passo. A estrutura mantém-se para artigos de conceito, referência e resolução de problemas, com um ajuste ligeiro.
Existe um modelo gratuito de artigo “como fazer” em PDF?
Sim, como formato de guia imprimível adequado para folhetos de formação, packs de onboarding e qualquer coisa que um cliente precise offline.
Existe um modelo de artigo em PDF?
Sim, tanto uma versão em branco como um exemplo completo, para poder ver um artigo “como fazer” finalizado antes de escrever o seu.
Existe um modelo gratuito de artigo “como fazer” em PPT ou PowerPoint?
Sim. A versão PowerPoint transforma um “como fazer” num walkthrough de formação, com um passo por slide e espaço para uma captura de ecrã em cada. Funciona bem para uma sessão ao vivo e menos bem como material de referência depois, por isso a maioria das equipas precisa também da versão Word.
Posso descarregar um modelo gratuito de artigo “como fazer”?
Sim, todos os formatos são descarregamentos gratuitos sem necessidade de conta e sem atribuição.
Qual é o melhor modelo gratuito de artigo “como fazer”?
O que inclui pré-requisitos e resolução de problemas. A maioria dos modelos dá-lhe um título e passos numerados, que é a parte fácil. Os leitores desistem porque descobrem um pré-requisito em falta no passo quatro ou encontram um problema que o artigo não menciona — e essas duas secções é o que o impede.
O que é um artigo “como fazer”?
Um artigo instrucional curto que cobre uma tarefa específica, escrito para alguém que está a tentar fazê-la agora mesmo. Diferencia-se de um tutorial, que ensina do zero, e de um artigo de conceito, que explica como algo funciona.
O que deve incluir um artigo “como fazer”?
Um título baseado em tarefas, um resumo de uma frase, para quem é incluindo quaisquer permissões necessárias, pré-requisitos antes do passo um, tempo necessário, passos numerados com uma ação por cada, o resultado esperado, resolução de problemas para os três ou quatro problemas comuns, artigos relacionados e metadados que indiquem o responsável e a data da última revisão.
Como se escreve um bom artigo “como fazer”?
Escreva o título como uma tarefa nas palavras do leitor, faça a tarefa você mesmo enquanto escreve em vez de trabalhar a partir da memória, liste os pré-requisitos à medida que os encontra, use uma ação por passo com rótulos exatos da interface, indique o que deve ser verdade no final e adicione resolução de problemas a partir de tickets de suporte reais. Depois, peça a alguém que não esteja familiarizado para o seguir sem ajuda.
Quanto tempo deve ter um artigo “como fazer”?
Uma tarefa, idealmente com menos de dez passos. Se for mais longo, normalmente são várias tarefas que poderiam ser encontradas com mais facilidade como artigos separados, ligados em sequência. Artigos longos também falham porque só podem ter um título, o que torna as outras tarefas dentro deles invisíveis para a pesquisa.
Qual é a diferença entre um “como fazer” e um tutorial?
Um “como fazer” serve alguém que já sabe o que quer e precisa dos passos específicos. Um tutorial ensina um iniciante, geralmente com um exemplo resolvido e mais explicação. O estado do leitor é a diferença: o leitor de “como fazer” está impaciente e a meio da tarefa; o leitor do tutorial reservou tempo para aprender.
Os artigos “como fazer” devem incluir capturas de ecrã?
Para tudo o que a interface não seja óbvia, sim, recortado para a área relevante com anotações leves. Não em todos os passos, ou o artigo deixa de ser fácil de consultar. Tenha em conta que as capturas de ecrã são o elemento com mais manutenção na documentação e ficam desatualizadas a cada alteração da interface — vale a pena ponderar antes de adicionar doze.
Com que frequência devem ser revistos os artigos “como fazer”?
Após qualquer lançamento que afete a funcionalidade e, caso contrário, num ciclo fixo, normalmente de seis a doze meses. O gatilho mais útil é um ticket de suporte sobre algo que o artigo já cobre, o que significa que ou está errado ou não é encontrável.
Posso personalizar este modelo de artigo “como fazer”?
Sim, todas as versões são totalmente editáveis. Ajuste as secções aos seus padrões de documentação, embora os pré-requisitos e a resolução de problemas sejam os dois que vale a pena manter independentemente, porque abordam os dois pontos em que os leitores mais frequentemente abandonam um artigo.
