Os guias do utilizador são uma parte importante da prestação de serviços digitais. Os clientes digitais esperam acesso ao auto-serviço, exigindo acesso imediato à informação. Uma simples passagem pelo telefone já não o corta; horas de tempo gastas a explicar coisas que podem ser melhor ilustradas nos guias de documentação do utilizador.
Na Docsie, defendemos que todas as empresas criem uma biblioteca de guias informativos para os clientes. Isto permitirá o auto-serviço, reduzirá a sua carga de trabalho de apoio, e fornecerá acesso 24 horas por dia, 7 dias por semana, em tempo real, à informação de que os seus clientes necessitam para desfrutar e trabalhar dentro do seu produto ou serviço.
10 Top Tips for User Guides and Documentation in Docsie
Antes de começarmos, tem uma forma de armazenar, escrever e hospedar documentação?
Dirija-se à página Docsie Onboarding para colaboração centrada no cliente, extensa incorporação, traduções à medida, e poderosa publicação na ponta dos seus dedos.
Agora que entrou para o clube, vamos saltar para as nossas 10 melhores dicas!
1 - Enriqueça os seus Guias do Utilizador com Meios de Comunicação Social
Texto, palavras, cartas - utilizamo-las todos os dias. Infelizmente, a palavra escrita não se pode comparar à veracidade do vídeo ou à inspiração das imagens.
Ao criar guias de documentação do utilizador, leia-o do ponto de vista do utilizador. Poderá esta secção ser melhor explicada num GIF, num vídeo incorporado ou numa imagem anotada? Em caso afirmativo, adicione uma!
Pode adicionar imagens, incorporar vídeos e integrar conteúdo iFrame em Docsie. Experimente-o!
2 - Criar uma Ordem, Não a Tipo Jedi!
As instruções passo-a-passo são o pilar dos livros de cozinha em todo o lado! Quando segue uma receita, mistura os seus ovos com a sua farinha? É isso que deve fazer, e sabe disso porque segue os passos!
Todas as piadas à parte, assegure-se de que passa por qualquer guia do utilizador com instruções passo a passo. Se seguir esses passos, obterá realmente o resultado pretendido? Instruções imprecisas que não alcançam o resultado pretendido é uma enorme bandeira vermelha para os clientes. Instruções precisas, por outro lado, incutem confiança, e fornecem valor aos clientes e ao negócio através da partilha de informação.
Crie uma encomenda utilizando as listas numeradas em Docsie, ou com Docsie Book Articles para segmentar a sua documentação.
Artigos, Prateleiras e Espaços de Trabalho em Docsie
3 - Alojamento para todos os níveis de leitura
Presume que os clientes saberão o seu JavaScript a partir das suas melhores dicas? O uso de jargão e terminologia complexa é tipicamente recomendado no contexto dos guias técnicos do utilizador. Para leigos, porém, quanto mais simples for a linguagem - melhor!
A maioria dos leitores só quer saber como fazer a coisa, e repetir a coisa. Uma abordagem consiste em entregar um conceito complexo e de alto nível no papel - depois repetir de novo com uma versão simplificada para leigos. Isto serve para os utilizadores técnicos e leigos de uma só vez, imprimindo duas páginas com uma caneta.
"A inteligência artificial envolve a emulação algorítmica da inteligência humana em busca de produtividade; a inteligência artificial visa obter trabalho através da correspondência da inteligência humana usando código informático". - ambas significam a mesma coisa, mas visam audiências diferentes.
Use Docsie para criar Prateleiras para leigos, e Prateleiras para utilizadores técnicos. Dessa forma, pode ter Livros para ajudar ambos os públicos, com alojamento completo disponível através do Portal Docsie.
Código Complexo Simplificado para Leigos no Exemplo Docsie](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)
4 - Use Modelos e Pare de Ficar Atrasado!
Reescreve todos os guias de utilizador a partir do zero? Em vez disso, deve criar modelos com estruturação básica e mensagens de marca, e construir em torno deste conteúdo.
Escrever do zero leva tempo, esforço e corre o risco de incoerência se vários escritores estiverem a trabalhar dentro do mesmo projecto. Os modelos são uma óptima forma de poupar tempo ao escrever, e conduzem a uma maior consistência entre páginas. A confiança é construída sobre mensagens consistentes e geração de valor, que os modelos promovem.
Clique ...Mais e seleccione Templates em Docsie. Aqui, pode guardar os modelos e iniciar novos Livros usando o modelo como fonte!
5 - Escrever rápido, Iterate Frequentemente
No desenvolvimento de software Agile, o mantra deve falhar rapidamente e iterar frequentemente. Aplicando isto aos guias de documentação do utilizador, o seu pessoal deve procurar escrever rapidamente e iterar com frequência.
Isto não significa sacrificar a qualidade pela velocidade. Em vez disso, isto permite um feedback e respostas do cliente com menos esforço inicial. Este feedback pode ser aproveitado em mais iterações de documentação do utilizador, e ajuda a empresa a tornar-se mais centrada no cliente.
Docsie Vocally elucida o feedback do leitor, com classificações e gravações de ecrã para identificar o conteúdo exacto que lêem. Experimente à medida que escreve rapidamente e itera com frequência!
6 - Conhecimento Aninhado Com Backlinks Internos
A documentação do seu guia do utilizador está ligada a outras páginas? Ao adicionar ligações a secções relevantes da documentação, ajuda os leitores a dar corpo e a compreender o seu produto ou serviço a um nível conceptual.
Quando se refere a uma característica ou função específica, acrescente sempre uma ligação. Permita ao leitor aceder rapidamente a essa informação, em vez de o forçar a pesquisar e carregar a página por si próprio. A falar de logins de conta? Adicione um URL de início de sessão ao texto "iniciar 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 de texto, em vez de uma biblioteca interminável a pesquisar.
Docsie permite aos escritores de guias do utilizador criar ligações internas em atraso. Basta destacar algum texto e clicar no botão 🖇️ na barra de ferramentas do Editor Docsie. Além disso, pode fazer ligações linguísticas e de versão-agnósticas com ligações de objectos relativos .
Backlinking in Docsie With Object Reference Links
7 - Escovar as Cobwebs e Actualizar o Conteúdo Antigo
Tem guias de utilizador antigos e documentação visível online? Se tiver a documentação da versão 1.2 publicada enquanto o seu produto estiver na versão 1.3, a sua documentação já não é relevante. Em vez de publicar nova documentação para cada versão, utilize o Docsie Versioning.
Docsie Versioning permite aos utilizadores acederem a versões históricas e actuais da documentação. À medida que novas versões são lançadas, as versões antigas são arquivadas para fins de redundância, ao mesmo tempo que são acessíveis a partir de um menu drop-down. Tudo isto está na mesma página web, facilitando aos utilizadores a navegação e a procura de informação relevante.
Da mesma forma, se o seu guia de dicas para 2021 ainda estiver publicado em 2022, actualize-o! Altere o nome, actualize quaisquer citações e fontes com pesquisa actualizada, e verifique se a informação ainda é relevante. Tire as teias de aranha e mantenha as coisas sempre verdes; o conteúdo pode sempre ser reposto.
8 - Miniaturizar Tarefas, Completo em Lotes
Ao escrever, escreve a página inteira de uma só vez com zero de pré-planejamento? Algumas delas resumem-se à preferência pessoal pelos escritores. No entanto, ao miniaturizar tarefas, o trabalho pode ser concluído mais rapidamente e com mais foco.
Criar uma estrutura simples com etiquetas H1 e H2 e breves descrições para cada secção. Utilizar isto ao escrever, e tratar de secções individuais em vez de se preocupar com toda a página. Isto é referido como um esboço na indústria da escrita. O esboço oferece a oportunidade de feedback com os editores antes de se começar a escrever, e funciona como um quadro orientador à medida que o escritor escreve.
Criar um novo Livro em Docsie e adicionar alguns cabeçalhos básicos e texto para um esboço. Pode também adicionar Tarefas usando o menu do lado direito, dividindo o trabalho em lotes mais pequenos à medida que vários membros da equipa colaboram no conteúdo. A história da versão significa que pode voltar atrás se um escritor acrescentar conteúdo menos que estelar - perfeito para escrever rapidamente e com iterações frequentes!
9 - Um Índice para Mais Leitores de Conteúdo
Com documentação complexa e diversificada de guias de utilizador, uma parede de texto pode ser intimidante para os leitores. Isto pode ser resolvido com um Índice abrangente. Comummente utilizado em enciclopédias, ajuda os utilizadores a identificar e a saltar para informações relevantes, ao mesmo tempo que fornece estrutura a um ambiente de portal de conhecimento.
Docsie Articles, Shelves and Workspaces trabalham para criar um Índice. Este mostrará automaticamente no lado esquerdo do seu portal de conhecimentos - proporcionando uma forma fácil de navegar através da sua base de conhecimentos. Com esta dica de topo, Docsie fá-lo por si!
10 - Domine o seu assunto
O seu escritor é um especialista no assunto? Do mesmo modo, o seu escritor é engenhoso e bom a pesquisar temas com os quais pode não estar familiarizado? Em última análise, apesar de todas as nossas dicas, o escritor dita a qualidade dos seus guias de documentação do utilizador.
Quanto mais compreenderem o seu produto, mais exacto será o seu trabalho. Permita aos escritores a flexibilidade de testar e quebrar o seu produto, uma vez que os utilizadores poderão encontrar problemas semelhantes. Melhor ainda, passe o seu escritor por uma demonstração do produto com a sua equipa de vendas, e dê-lhes experiência prática com o canal de vendas e o envio de mensagens que contém. Isto mais uma vez conduz à consistência, ao mesmo tempo que transforma os seus escritores em utilizadores. Nem todos os escritores se tornam utilizadores, mas todos os utilizadores podem tornar-se bons escritores com conhecimentos práticos.
Põe estas dicas em prática em Docsie!
Obrigado por ler as nossas 10 melhores dicas para melhores guias de utilizador. Convidamo-lo a aplicar estas dicas aos seus docs Docsie!
Docsie é uma plataforma de gestão de documentação de ponta-a-ponta que as empresas utilizam para criar perguntas frequentes baseadas na web, documentos de produtos, guias de utilizador, help-docs e manuais de utilizador. A plataforma apresenta colaboração centrada no cliente, extensa incorporação, traduções à medida, e poderosa publicação na ponta dos dedos.
Faça a sua jogada a bordo com Docsie hoje, e entregue documentação encantadora aos seus clientes!