Os guias de utilizador são essenciais na prestação de serviços digitais¶

Os clientes digitais esperam acesso ao autoatendimento, exigindo informação imediata. Uma explicação por telefone já não é suficiente; horas gastas a explicar o que pode ser melhor ilustrado em guias de documentação para utilizadores.

Na Docsie, defendemos que todas as empresas criem uma biblioteca de guias informativos para os clientes. Isto permitirá o autoatendimento, reduzirá a carga de trabalho do suporte e proporcionará acesso 24/7 às informações que os clientes precisam para utilizar e trabalhar com o seu produto ou serviço.

10 Dicas Principais para Guias de Utilizador e Documentação na Docsie

Antes de começarmos, já tem uma forma de armazenar, escrever e alojar documentação?

Visite a página de Integração da Docsie para colaboração centrada no cliente, integração extensiva, traduções personalizadas e publicação poderosa ao seu alcance.

Agora que se juntou ao clube, vamos explorar as nossas 10 melhores dicas!

1 - Enriqueça os Seus Guias com Conteúdo Multimédia

Texto, palavras, letras – usamo-los todos os dias. Infelizmente, a palavra escrita não consegue igualar o impacto do vídeo ou a inspiração das imagens.

Ao criar guias de documentação, leia-os na perspetiva do utilizador. Esta secção poderia ser melhor explicada com um GIF, vídeo incorporado ou imagem com anotações? Se sim, adicione!

Pode adicionar imagens, incorporar vídeos e integrar conteúdo iFrame na Docsie. Experimente!

2 - Crie uma Ordem, Não do Tipo Jedi!

As instruções passo a passo são o pilar dos livros de culinária! Ao seguir uma receita, mistura os ovos com a farinha? É isso que deve fazer, e sabe-o porque segue os passos!

Sem brincadeiras, certifique-se de que verifica os guias com instruções passo a passo. Se seguir esses passos, consegue realmente obter o resultado pretendido? Instruções imprecisas que não alcançam o resultado desejado são um grande sinal de alerta para os clientes. Por outro lado, instruções precisas geram confiança e oferecem valor aos clientes e à empresa através da partilha de informação.

Crie uma ordem usando as listas numeradas na Docsie, ou com os Artigos de Livro Docsie para segmentar a sua documentação.

3 - Adapte-se a Todos os Níveis de Leitura

Assume que os clientes saberão distinguir JavaScript das suas dicas principais? O uso de jargão e terminologia complexa é geralmente recomendado no contexto de guias técnicos. Para leigos, no entanto, quanto mais simples a linguagem, melhor!

A maioria dos leitores apenas quer saber como fazer algo e repetir esse processo. Uma abordagem é apresentar um conceito complexo de alto nível - e depois repetir com uma versão simplificada para leigos. Isto atende tanto a utilizadores técnicos como a leigos, atingindo dois públicos de uma só vez.

"A inteligência artificial envolve a emulação algorítmica da inteligência humana em busca de produtividade; a inteligência artificial visa realizar trabalho igualando a inteligência humana usando código informático." - ambas significam o mesmo, mas direcionam-se a públicos diferentes.

Use a Docsie para criar Prateleiras para leigos e Prateleiras para utilizadores técnicos. Assim, pode ter Livros para ajudar ambos os públicos, com alojamento completo disponível através do Portal Docsie.

4 - Use Modelos e Deixe de Trabalhar até Tarde!

Reescreve cada guia de utilizador do zero? Em vez disso, crie modelos com estruturação básica e mensagens da marca, e desenvolva o conteúdo a partir daí.

Escrever do zero leva tempo, esforço e arrisca inconsistências se vários redatores estiverem a trabalhar no mesmo projeto. Os modelos são uma ótima forma de poupar tempo ao escrever e promover maior consistência entre as páginas. A confiança é construída sobre mensagens consistentes e geração de valor, algo que os modelos promovem.

Clique em ...Mais e selecione Modelos na Docsie. Aqui, pode armazenar modelos e iniciar novos Livros usando o modelo como fonte!

5 - Escreva Rápido, Itere Frequentemente

No desenvolvimento ágil de software, o mantra é falhar rápido e iterar frequentemente. Aplicando isso aos guias de documentação, a sua equipa deve tentar escrever rápido e iterar frequentemente.

Isto não significa sacrificar qualidade por velocidade. Em vez disso, permite obter feedback dos clientes com menos esforço inicial. Este feedback pode ser aproveitado em iterações futuras, ajudando a empresa a tornar-se mais centrada no cliente.

O Docsie Vocally recolhe feedback dos leitores, com classificações e gravações de ecrã para identificar exatamente o conteúdo que leram. Experimente enquanto escreve rápido e itera frequentemente!

6 - Conhecimento Interligado com Backlinks Internos

A sua documentação está interligada com outras páginas? Ao adicionar links para secções relevantes da documentação, ajuda os leitores a compreender melhor o seu produto ou serviço a nível conceptual.

Quando se referir a uma funcionalidade ou função específica, adicione sempre um link. Permita que o leitor aceda rapidamente a essa informação, em vez de o obrigar a pesquisar e carregar a página sozinho. Está a falar sobre logins de conta? Adicione um URL de login ao texto "inicie sessão na sua conta" na sua página, e em todas as outras páginas. Torne a sua documentação conveniente e navegável dentro do corpo do texto, em vez de uma biblioteca interminável para explorar.

A Docsie permite que os escritores criem backlinks internos. Basta destacar algum texto e clicar no botão 🖇️ na barra de ferramentas do Editor Docsie. Além disso, pode criar links independentes de idioma e versão com links de objeto relativos.

7 - Remova o Pó e Atualize Conteúdo Antigo

Tem guias de utilizador e documentação antiga visíveis online? Se tem documentação da versão 1.2 publicada enquanto o seu produto está na versão 1.3, a sua documentação já não é relevante. Em vez de publicar nova documentação para cada versão, use o Versionamento Docsie.

O Versionamento Docsie permite aos utilizadores aceder a versões históricas e atuais da documentação. À medida que novas versões são lançadas, as antigas são arquivadas para fins de redundância, mantendo-se acessíveis a partir de um menu suspenso. Tudo na mesma página web, facilitando a navegação e a procura de informações relevantes.

Da mesma forma, se o seu guia de dicas para 2021 ainda estiver publicado em 2022, atualize-o! Mude o nome, atualize citações e fontes com pesquisas recentes, e verifique se a informação ainda é relevante. Remova o pó e mantenha tudo atualizado; o conteúdo pode sempre ser reutilizado.

8 - Divida Tarefas, Complete por Lotes

Ao escrever, redige a página inteira de uma só vez sem planeamento prévio? Parte disto depende da preferência pessoal dos redatores. No entanto, ao dividir tarefas, o trabalho pode ser concluído mais rapidamente e com mais foco.

Crie uma estrutura simples com tags H1 e H2 e breves descrições para cada secção. Use isto ao escrever e aborde secções individuais em vez de se preocupar com a página inteira. Isto é conhecido como esquema na indústria da escrita. O esquema oferece oportunidade para feedback com editores antes de começar a escrever e funciona como uma estrutura orientadora durante o processo.

Crie um novo Livro na Docsie e adicione alguns cabeçalhos básicos e texto para um esquema. Também pode adicionar Tarefas usando o menu do lado direito, dividindo o trabalho em lotes menores enquanto vários membros da equipa colaboram no conteúdo. O histórico de versões permite voltar atrás se um redator adicionar conteúdo menos adequado – perfeito para escrever rápido e iterar frequentemente!

9 - Um Índice para Mais Leitores de Conteúdo

Com documentação complexa e diversificada, um muro de texto pode ser intimidante para os leitores. Isto pode ser resolvido com um Índice abrangente. Comummente usado em enciclopédias, ajuda os utilizadores a identificar e saltar para informações relevantes, fornecendo estrutura a um ambiente de portal de conhecimento.

Os Artigos, Prateleiras e Espaços de Trabalho da Docsie funcionam para criar um Índice. Este aparecerá automaticamente no lado esquerdo do seu portal de conhecimento – proporcionando uma forma fácil de navegar pela sua base de conhecimento. Com esta dica, a Docsie faz isso por si!

10 - Domine o Seu Assunto

O seu redator é um especialista no assunto? Da mesma forma, é hábil a pesquisar tópicos com os quais pode não estar familiarizado? Em última análise, apesar de todas as nossas dicas, o redator determina a qualidade dos seus guias de documentação.

Quanto mais compreender o seu produto, mais preciso será o seu trabalho. Permita aos redatores a flexibilidade para testar e experimentar o seu produto, pois os utilizadores podem encontrar problemas semelhantes. Melhor ainda, acompanhe o seu redator numa demonstração do produto com a sua equipa de vendas, e dê-lhes experiência prática com o processo de vendas e as mensagens nele contidas. Isto promove a consistência, transformando os seus redatores em utilizadores. Nem todos os redatores se tornam utilizadores, mas todos os utilizadores podem tornar-se bons redatores com conhecimento prático.

Ponha Estas Dicas em Prática na Docsie!

Obrigado por ler as nossas 10 melhores dicas para melhores guias de utilizador. Convidamo-lo a aplicar estas dicas nos seus documentos Docsie!

A Docsie é uma plataforma completa de gestão de documentação que as empresas usam para criar FAQs online, documentação de produtos, guias de utilizador, documentos de ajuda e manuais de utilizador. A plataforma oferece colaboração centrada no cliente, integração extensiva, traduções personalizadas e publicação poderosa ao seu alcance.

Dê o próximo passo integrando-se com a Docsie hoje, e proporcione uma experiência de documentação excelente aos seus clientes!