Use este modelo
Um excelente guia de utilizador de software é mais curto, mais direto e mais focado nas tarefas do que um manual completo — e, muitas vezes, é mais útil. Com a Trupeer, pode poupar horas na criação de guias de utilizador começando com um modelo gratuito de guia de utilizador de software, personalizando-o com as suas diretrizes de marca e usando o nosso criador de manuais com IA para transformar walkthroughs do produto em guias de vídeo envolventes.
O que é um modelo gratuito de guia de utilizador de software?
Um modelo gratuito de guia de utilizador de software é uma estrutura reutilizável para a documentação que os seus utilizadores finais leem: como fazer as coisas para as quais o software serve, escrita para a pessoa que o utiliza, e não para a pessoa que o constrói ou opera.
É apenas um membro de uma família maior. A documentação de referência, os registos de arquitetura, os runbooks operacionais e as notas de versão servem leitores diferentes, e a página de documentação de software explica como é que essa divisão funciona. Esta página é sobre a que os seus clientes abrem de facto.
O modelo não é o guia. A lista de secções demora vinte minutos a escrever. O que determina se um guia de utilizador funciona é uma suposição estrutural que a maioria dos modelos herda sem dar por isso — e está errada.
A forma segue a utilização. Um ficheiro Word de modelo gratuito de guia de utilizador de software serve um guia entregue como documento, que hoje é a minoria, mas ainda é comum em software on premise e em produtos regulados; e um ficheiro Word de modelo de manual de utilizador segue a mesma tradição com um nome mais antigo. Um layout gratuito de modelo de guia de utilizador passo a passo em Word é o ponto de partida comum mais próximo. Um layout PPT de modelo gratuito de guia de utilizador de software serve material de formação derivado do guia, e não o próprio guia; e um ficheiro Excel de modelo gratuito de guia de utilizador de software serve o inventário do conteúdo, e não o guia. A maioria dos guias de utilizador de software vive agora num site de ajuda, e isso altera consideravelmente a estrutura, pelo motivo abaixo.
Ninguém lê um guia de utilizador do início
Veja as análises de qualquer site de ajuda online e um número resolve a discussão.
A proporção de visitas que começam na página inicial ou na página de conteúdos é pequena. A maioria dos utilizadores chega diretamente a uma página profunda, a partir de uma pesquisa na web ou de uma ligação de ajuda dentro do produto, com uma única pergunta específica.
Não leram a introdução. Não sabem em que capítulo estão. Não viram a secção de terminologia, as instruções de configuração, nem a nota no capítulo dois a explicar que tudo o que vem depois assume uma conta configurada.
Ainda assim, quase todos os guias de utilizador são estruturados como um livro: uma página de conteúdos, capítulos numa ordem lógica e páginas que assumem que o leitor percorreu as anteriores. Essa estrutura é herdada dos manuais impressos, onde fazia sentido, e sobrevive na ajuda online onde já não faz.
O resultado é um documento coerente para o autor e quebrado para o leitor real. Uma página que começa com “seguindo a partir da secção anterior” é um beco sem saída para os setenta por cento de pessoas que não vieram da secção anterior.
Como personalizar este modelo na Trupeer
Passo 1: Abra a secção de Modelos
Vá à secção de Modelos no menu de navegação principal.
Passo 2: Selecione e abra um modelo
Clique em qualquer modelo com que queira trabalhar para o abrir.
Passo 3: Expanda a visualização do modelo
Se necessário, expanda a visualização do modelo para ver o layout completo e os detalhes de forma clara.
Passo 4: Edite 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: Guarde 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é-visualize e ajuste 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 quer.
Com um modelo de guia de utilizador de software pode:
Poupar horas na escrita: Ignore a página em branco com uma estrutura criada para guias de utilizador.
Reduzir pedidos de suporte: Guias claros ajudam os utilizadores a resolverem-se sozinhos.
Manter-se fiel à marca: Aplique o seu logótipo, fontes e cores usando o kit de marca da Trupeer.
Melhorar a adoção: Guias focados nas tarefas ajudam os utilizadores a obter valor mais rapidamente.
Adicionar walkthroughs em vídeo: Incorpore vídeo para passos difíceis de explicar apenas com texto.
Atingir utilizadores globais: Traduza guias de utilizador para 65+ idiomas com um clique.
Cada página é a página um
A regra de design segue diretamente. Escreva cada página como se fosse a única página que o leitor alguma vez vai ver, porque para a maioria é.
Seis consequências, e todas são baratas.
Diga o que a página assume, na própria página. Não numa introdução. Se a tarefa exigir uma função de administrador, uma integração configurada ou um passo de configuração concluído, diga-o nas duas primeiras linhas, onde alguém consegue descobrir que está no sítio errado antes de gastar cinco minutos a tentar perceber.
Repita em vez de fazer referência cruzada. Três linhas de pré-requisitos repetidos são mais económicas do que uma ligação que o leitor tem de seguir, ler e voltar de novo. A repetição ofende os autores e ajuda os leitores, e o leitor é quem você está a escrever.
Remova todas as referências de posição. Como descrito acima, na secção anterior, usando o método da 5.2. Cada uma destas assume uma ordem de leitura que a maioria dos leitores não seguiu. Substitua por uma instrução real ou por uma ligação com nome.
Dê à página o título como a pergunta, e não como a funcionalidade. Abordado mais abaixo, porque é a diferença entre ser encontrado e não ser.
Termine com um ou dois próximos passos escolhidos. Não uma árvore de navegação. O leitor terminou algo e, normalmente, há uma próxima coisa óbvia, por isso dê-lhe um nome.
Una qualquer página que não consiga estar sozinha. Se uma página não fizer sentido genuinamente sem outra, então são uma única página que foi dividida por conveniência do autor.
Assim, o melhor modelo gratuito de guia de utilizador de software é aquele que lhe permite escrever desta forma. O teste demora segundos. Abra qualquer página do seu guia “a frio”, como se tivesse chegado a partir de uma pesquisa, e pergunte se conseguiria concluir a tarefa. A maioria dos guias falha isso na maioria das suas páginas, e as falhas concentram-se nos capítulos do meio, onde os autores tinham mais contexto na cabeça.
O que uma página de guia de utilizador de software tem de conter
Componentes para uma única página, já que a página e não o livro é a unidade.
Componente | O que faz |
|---|---|
Título como a pergunta do utilizador | O que ele escreveria ou perguntaria, e não como a funcionalidade é chamada internamente. |
Para que serve esta página | Uma linha. O que terá conseguido no final. |
O que assume | Função, permissões, configuração prévia, estado anterior. Declarado, não ligado. |
Passos numerados | Uma ação por passo, na ordem em que é executada. |
O que deve ver | Por passo, quando o resultado não é óbvio, para que o leitor saiba se deve continuar. |
Captura de ecrã ou vídeo curto onde o reconhecimento supera a descrição | Apenas quando vale o seu lugar, pelos motivos explicados abaixo. |
Problemas comuns | Dois ou três, retirados de pedidos de suporte, e não imaginados. |
Próximos passos | Um ou dois, escolhidos deliberadamente. |
Data e versão da última verificação | Quando alguém executou estes passos pela última vez e qual a versão do produto. |
No conjunto, também precisa de uma pesquisa que funcione, de uma forma de os leitores indicarem que uma página está errada e de um responsável. A ligação para reportar é o mecanismo de qualidade mais barato disponível e quase ninguém tem uma.
Modelo gratuito de guia de utilizador de software: a estrutura a copiar
Preenchido com um exemplo real em vez de placeholders. O software é de gestão de clínicas veterinárias.
Copie daqui.
Título. Como reembolsar um cliente. Não: processamento de anulação de nota de crédito.
Para que serve esta página. Devolver dinheiro a um cliente por uma fatura que já pagou e registá-lo corretamente nas contas da clínica.
O que assume. Tem a permissão de faturação. As clínicas no plano Standard têm-na por predefinição apenas para gestores de clínica. A fatura foi paga e reconciliada. Se não tiver sido paga, está à procura de cancelar uma fatura, que é uma página diferente e está ligada no fim.
Passos.
Abra o registo do cliente e selecione o separador Faturação. Deve ver uma lista de faturas com um estado associado a cada uma.
Encontre a fatura paga. As faturas pagas mostram uma marca verde. Se mostrar um relógio âmbar, ainda não foi reconciliada e tem de esperar pela reconciliação antes de reembolsar.
Selecione a fatura e, em seguida, Reembolso. Abre-se um painel de reembolso com o valor total.
Introduza o valor do reembolso. Reembolsos parciais são permitidos. O valor não pode exceder o total pago.
Selecione um motivo na lista. Isto aparece no extrato do cliente, por isso escolha o que está disposto a que ele leia.
Selecione Processar reembolso. Deve ver uma confirmação com uma referência de reembolso que começa por REF.
O que deve ver depois. O estado da fatura muda para Reembolsado ou Reembolsado parcialmente. O reembolso aparece no livro do dia no espaço de quinze minutos.
Problemas comuns.
O botão Reembolso está esbatido, o que normalmente significa que a fatura não foi reconciliada. Aguarde e atualize.
O reembolso não aparece no livro do dia, o que normalmente significa que foi processado depois do fecho do livro do dia e aparecerá amanhã.
Não consegue ver o separador Faturação, o que significa que não tem a permissão de faturação. O seu gestor de clínica pode concedê-la.
Próximos passos. Apenas dois. Cancelar uma fatura não paga. Gerar um extrato do cliente.
Última verificação. 7 de maio, na versão 14.2, por um membro da equipa de suporte seguindo estes passos desde o início.
Copie para aqui.
Note que a secção de suposições duplica informação que também existe na página de permissões. Essa duplicação é deliberada e é o ponto.
Exemplo de guia de utilizador: cento e doze páginas que precisavam de outra página
A Marlbury Systems fornece software de gestão de clínicas a cerca de quatro mil e quinhentas clínicas veterinárias. O seu guia de utilizador tinha cento e oitenta páginas, publicado online, estruturado como um manual: começar, clientes e pacientes, marcações, clínico, faturação, relatórios, administração.
Era completo, preciso e bem escrito. Tinha sido produzido por um redator técnico que conhecia o produto corretamente.
Dois números das análises deram início à investigação. Setenta e oito por cento das visitas chegavam diretamente a uma página profunda, a partir de uma engine de pesquisa ou da ligação de ajuda dentro do produto. E o tempo médio na página era de catorze segundos.
Catorze segundos não é leitura. É chegar, fazer uma triagem e sair.
A equipa de suporte forneceu a outra metade do quadro. As cinco páginas de ajuda mais visitadas geraram mais pedidos do que quaisquer outras, o que é o oposto do que uma página de ajuda deve fazer.
Alguém auditou o guia com uma única pergunta: um leitor que chega “a frio” a esta página consegue concluir a tarefa?
Cento e doze das cento e oitenta páginas continham pelo menos uma referência que exigia outra página. Como descrito acima. Seguindo a partir da secção anterior. Usando o método da 5.2. Assim que tiver concluído a configuração no capítulo um.
A página de reembolso, uma das mais visitadas em todo o guia, começava com uma frase que remetia o leitor para a secção anterior sobre como localizar uma fatura. A maioria das pessoas que a lia nunca tinha visto a secção anterior e não tinha razão para saber que existia.
A reescrita não alterou nenhum facto. Os pré-requisitos foram repetidos em cada página em vez de serem ligados. As referências de posição foram substituídas por instruções reais. Os títulos das páginas foram reescritos com base no registo de pesquisa do site, que mostrava utilizadores a pesquisar por reembolso enquanto a página tinha o título de anulação de nota de crédito. Cada página ganhou um bloco curto de suposições e dois próximos passos escolhidos.
Quatro meses depois, o tempo na página passou de catorze segundos para setenta e um. Os pedidos que referenciavam os vinte tópicos principais desceram cerca de quarenta e um por cento. A proporção de utilizadores que abriram a ajuda dentro do produto e não contactaram posteriormente o suporte passou de trinta e quatro por cento para cinquenta e oito.
O guia ficou maior, porque os pré-requisitos repetidos ocupam espaço. Também passou a ser mais usado.
Como escrever um guia de utilizador de software em seis passos
Obtenha a lista de páginas a partir de dados de suporte e de pesquisa, e não da estrutura do menu do produto. Os pedidos dizem-lhe o que as pessoas não conseguem fazer e o registo de pesquisa diz-lhe as palavras que usam.
Escreva uma página por tarefa, com o título como a pergunta. Se um título contiver um nome de funcionalidade que os seus utilizadores não diriam em voz alta, altere-o.
Escreva primeiro o bloco de suposições, antes dos passos. É a secção que impede alguém de desperdiçar cinco minutos na página errada.
Escreva os passos executando-os, e não a partir da memória. Qualquer coisa que faça automaticamente, caso contrário, ficará em falta.
Retire problemas comuns da fila de pedidos. Três reais superam dez imaginados.
Teste chegando “a frio”. Abra a página como se fosse um estranho e tente concluir a tarefa sem abrir mais nada.
O passo um é o que separa um guia organizado em torno dos utilizadores de um organizado em torno do software. A estrutura do menu do produto é um mapa de como o software foi construído. Não é um mapa do que as pessoas estão a tentar fazer.
Dar nomes às páginas para que as pessoas as encontrem
Os títulos importam mais num guia de utilizador do que em quase qualquer outro documento, porque a pesquisa é o ponto de entrada principal e o título carrega a maior parte do peso da correspondência.
Três regras.
Use a palavra do utilizador, não a sua. Se o seu registo de pesquisa mostrar que as pessoas escrevem “reembolso” e a sua página diz “anulação de nota de crédito”, a página fica invisível para elas. Verifique o registo. É a pesquisa mais barata disponível e a maioria das equipas nunca a abre.
Comece pelo verbo. Como reembolsar um cliente. Não: reembolsos de clientes, visão geral de. O verbo em primeiro lugar corresponde melhor à forma como as pessoas perguntam e é mais rápido de ler numa lista de resultados.
Uma tarefa por título. Uma página com o título “gestão de faturação” abrange tudo e não corresponde a nada. Divida-a.
Quando um termo interno for mesmo o correto, porque aparece na interface, coloque a palavra do utilizador na primeira linha da página para continuar a ser encontrável. Está a otimizar para dois públicos ao mesmo tempo: o motor de pesquisa e a pessoa que faz uma triagem dos resultados.
Capturas de ecrã e o problema da manutenção
As capturas de ecrã ajudam mais quando o reconhecimento supera a descrição: identificar um controlo entre muitos, mostrar um ecrã desconhecido, confirmar como é um resultado bem-sucedido.
Também são, no entanto, a maior responsabilidade de manutenção num guia. Um guia com duzentas capturas de ecrã é um guia com duzentas coisas que se partem silenciosamente na próxima vez que a interface muda, e as interfaces mudam de poucas em poucas semanas.
Três regras mantêm o custo proporcional.
Use-as onde a nomeação é difícil e ignore-as onde a instrução é clara por si só. Uma captura de ecrã de um botão com a etiqueta “Guardar” não acrescenta nada.
Anote diretamente em vez de descrever onde procurar no texto. Uma captura de ecrã sem marcações de um ecrã movimentado é um puzzle.
Dê-lhes data e saiba que versão do produto mostram, para que um leitor consiga perceber se o que está a ver ainda existe.
A posição honesta é que a maioria das equipas começa com boas intenções sobre documentação visual e acaba com texto, porque o custo de recuperar depois de cada release excede o tempo disponível. Esse é um problema de produção, e não de vontade, e é abordado mais abaixo.
Guia de utilizador, manual de utilizador ou guia “como fazer”?
Três termos sobrepostos, e as diferenças são úteis ao escolher uma estrutura.
Um guia de utilizador cobre um produto de software nas tarefas que os seus utilizadores executam. Várias páginas, acedidas a qualquer momento, mantidas continuamente.
Um manual de utilizador é a mesma coisa na tradição mais antiga, em formato de documento, e o termo continua a ser padrão para produtos físicos e para software entregue on premise. Quando um manual acompanha equipamento físico, o conteúdo de segurança e a colocação de avisos implicam obrigações que os guias de software não têm, e a tradição do manual de instruções cobre essa área.
Um guia “como fazer” é uma única tarefa, autónoma, e é essencialmente uma página de um guia de utilizador publicada por si só.
A implicação prática é que, se escrever cada página para estar sozinha, como defendido acima, o seu guia de utilizador já é uma coleção de guias “como fazer”, com navegação por cima — que é a arquitetura correta para ajuda online.
Um guia de referência rápida é diferente novamente: uma folha de consulta para alguém que já foi treinado, coberta na página de referência rápida.
O que um modelo gratuito de guia de utilizador de software não consegue corrigir
Um guia estruturado em torno do produto. Nenhum modelo converte um guia organizado por funcionalidades num guia organizado por tarefas. Para isso, precisa de dados de suporte e de pesquisa.
Páginas que ninguém consegue encontrar. Uma página bem escrita com o título errado fica invisível. Os títulos são a coisa mais barata para corrigir e a menos vezes revista.
Capturas de ecrã que ninguém mantém. Nenhum download gratuito de modelo de guia de utilizador de software e nenhum download gratuito de modelo de manual de utilizador vai recuperar duzentas imagens depois de uma reformulação.
Um produto que exige tanta orientação. Se uma tarefa precisa mesmo de catorze passos e três avisos, então a documentação está a fazer o trabalho que a interface deveria estar a fazer. Escreva-a na mesma e passe a observação a quem é responsável pelo produto.
Mostre a tarefa em vez de a descrever
Um guia de utilizador é o tipo de documento com maior exigência de imagens e com maior custo de manutenção das imagens, e esses dois factos juntos explicam porque tantos guias são piores do que os seus autores pretendiam.
A matemática é implacável. Um guia de cem páginas com três imagens por página são trezentas capturas, recortes, anotações e colocações. Depois de uma reformulação, são novamente trezentas. Ninguém tem esse tempo numa semana de release, por isso as imagens ficam desatualizadas, e imagens desatualizadas são piores do que nenhuma porque os leitores confiam nelas.
A Trupeer AI altera a base de custos. Alguém executa a tarefa uma vez enquanto grava, e o resultado é uma página escrita passo a passo com capturas de ecrã já capturadas, anotadas e colocadas, juntamente com um vídeo curto, na sua própria marca. Uma página que demoraria uma tarde passa a demorar minutos, e recuperar depois de uma reformulação significa voltar a gravar em vez de voltar a filmar.
Grave. Dê marca. Traduza. Trupeer.
Dois pontos adicionais importam especificamente para guias de utilizador. O vídeo fica na página ao lado dos passos escritos, o que serve tanto o leitor que quer fazer uma triagem como o leitor que quer ver, e essas são mesmo pessoas diferentes, e não a mesma pessoa em momentos diferentes. E quando os seus utilizadores abrangem várias línguas, a mesma gravação produz a mesma página em cada uma, pelo que um guia traduzido uma vez não se desvia do produto enquanto a versão em inglês se mantém atualizada.
O material fica na sua base de conhecimento e funciona também como formação para a equipa de suporte, que é frequentemente a utilização mais pesada de um guia de utilizador. A consistência entre os seus documentos é uma questão de definir o kit de marca uma vez, e a configuração é abordada no guia de configuração do modelo de documento.
Perguntas Frequentes
Existe uma versão Word gratuita de um modelo de guia de utilizador de software?
O Word serve um guia entregue como documento, o que se aplica a software on premise, a produtos regulados onde é necessário um manual com versão e a qualquer coisa entregue contratualmente. Um ficheiro Word de modelo de guia de utilizador de software funciona bem para esses casos.
Para software com site de ajuda, funciona mal. Os utilizadores chegam por pesquisa, precisam de cada página ser acessível, e um documento Word produz um ficheiro longo sem ponto de entrada por página. Se estiver a publicar online, use um sistema de documentação e mantenha o Word para o entregável com versão.
Existe uma versão gratuita Word de um modelo de guia de utilizador passo a passo?
Sim, e a estrutura acima é colada diretamente. Construa o layout gratuito do modelo Word de guia de utilizador passo a passo com uma tarefa por secção, passos numerados com uma ação por passo e uma linha de suposições no topo de cada secção.
Mantenha as secções curtas o suficiente para estarem sozinhas. A falha mais comum num guia baseado em Word é uma secção que só faz sentido depois da anterior, o que é invisível num documento e fatal quando o mesmo conteúdo é publicado online.
Existe uma versão PPT gratuita de um modelo de guia de utilizador de software?
Os slides servem formação derivada de um guia, e não o próprio guia. Um deck PPT de modelo gratuito de guia de utilizador de software é um formato razoável para uma sessão de walkthrough ou um webinar de onboarding.
Não o use como referência. Os slides não são pesquisáveis do modo que os utilizadores precisam, não podem ser ligados a partir do interior do produto e, quando lidos sozinhos, um deck perde a narração que carrega grande parte do seu significado.
Existe uma versão Excel gratuita de um modelo de guia de utilizador de software?
O Excel não é um formato de guia e é genuinamente útil ao lado de um. Um ficheiro Excel de modelo gratuito de guia de utilizador de software funciona bem como inventário de conteúdo: uma linha por página, com o seu título, responsável, data da última verificação, versão do produto, visualizações mensais e volume de pedidos associado.
Esse inventário é o que lhe diz quais as páginas corrigir primeiro. As páginas com muito tráfego e muito volume de pedidos associado são as que estão a falhar, e sem o inventário vai corrigir a página de que alguém reclamou mais recentemente.
Existe um download gratuito de um modelo de guia de utilizador de software que valha a pena usar?
A estrutura da página demora vinte minutos a construir, por isso um download gratuito de modelo de guia de utilizador de software poupa pouco, e a maioria dos modelos publicados tem a forma de livros, com uma página de conteúdos e capítulos numerados.
Adotar essa forma é o erro contra o qual esta página argumenta. Se usar um, remova a numeração dos capítulos e torne cada página autónoma — uma mudança na forma como escreve, e não no ficheiro.
Um ficheiro Word de modelo de manual de utilizador é a mesma coisa?
Em termos gerais, sim, com uma diferença na tradição e não no conteúdo. Um ficheiro Word de modelo de manual de utilizador vem da linhagem do manual impresso, por isso assume leitura sequencial, uma página de conteúdos e números de página.
Isso funciona para um documento que será mesmo lido como documento, incluindo entregáveis regulados e manuais que acompanham equipamento físico. Para ajuda online de software, as suposições por trás disso são a origem do problema descrito nesta página.
Onde posso obter um download gratuito de modelo de manual de utilizador?
Disponível de forma ampla e, na maior parte, intercambiável, porque uma lista numerada de tarefas não é um layout difícil. Um download gratuito de modelo de manual de utilizador vai dar-lhe uma página de conteúdos, títulos de capítulos e uma estrutura de página.
As duas alterações que vale a pena fazer em qualquer um deles são um bloco de suposições no topo de cada secção e a remoção de todas as referências cruzadas de posição. Essas duas edições levam uma hora num guia existente e valem mais do que mudar o modelo.
Qual é o melhor modelo gratuito de guia de utilizador de software?
O melhor modelo gratuito de guia de utilizador de software é aquele que trata a página e não o livro como a unidade — e quase nenhum faz isso.
Se estiver a comparar opções, verifique uma coisa: o modelo tem um lugar em cada página para registar o que se assume que o leitor já fez? Esse campo é o que faz com que uma página sobreviva ao facto de ser acedida a partir de uma pesquisa, que é como a grande maioria dos seus leitores vai chegar a ela.
