Os guias do usuário são uma parte importante da prestação de serviços digitais. Os clientes digitais esperam ter acesso ao autoatendimento, exigindo acesso imediato às informações. Um passo a passo por telefone simplesmente não é mais suficiente; horas de tempo são gastas explicando coisas que podem ser melhor ilustradas em guias de documentação do usuário.
Na Docsie, defendemos que todas as empresas criem uma biblioteca de guias de usuário informativos para os clientes. Isso permitirá o autoatendimento, reduzirá suas cargas de trabalho de suporte e fornecerá acesso em tempo real, 24 horas por dia, 7 dias por semana, às informações de que seus clientes precisam para aproveitar e trabalhar com seu produto ou serviço.
10 dicas importantes para guias de usuário e documentação no Docsie
Antes de começarmos, você tem uma maneira de armazenar, escrever e hospedar a documentação?
Acesse a página Docsie Onboarding para obter colaboração centrada no cliente, incorporação extensiva, traduções personalizadas e publicação avançada na ponta dos dedos.
Agora que você se juntou ao clube, vamos às nossas 10 principais dicas!
1 - Enriqueça seus guias do usuário com mídia
Texto, palavras, letras - nós os usamos todos os dias. Infelizmente, a palavra escrita não se compara à veracidade do vídeo ou à inspiração das imagens.
Ao criar guias de documentação do usuário, leia-os do ponto de vista do usuário. Essa seção poderia ser melhor explicada em um GIF, vídeo incorporado ou imagem anotada? Se sim, adicione um!
Você pode adicionar imagens, incorporar vídeos e integrar conteúdo iFrame no Docsie. Experimente!
2 - Criar um pedido, mas não do tipo Jedi!
As instruções passo a passo são o pilar dos livros de receitas em todos os lugares! Ao seguir uma receita, você mistura os ovos com a farinha? É isso que você deve fazer, e você sabe disso porque segue as etapas!
Brincadeiras à parte, certifique-se de ler todos os guias de usuário com instruções passo a passo. Se você seguir essas etapas, você realmente obterá o resultado pretendido? Instruções imprecisas que não alcançam o resultado pretendido são um grande sinal de alerta para os clientes. Instruções precisas, por outro lado, inspiram confiança e agregam valor aos clientes e à empresa por meio do compartilhamento de informações.
Crie uma ordem usando as listas numeradas no Docsie ou com o Docsie Book Articles para segmentar sua documentação.
3 - Acomodação para todos os níveis de leitura
Você supõe que os clientes conhecerão o JavaScript a partir de suas principais dicas? O uso de jargões e de terminologia complexa é normalmente recomendado no contexto de guias técnicos do usuário. No entanto, para os leigos, quanto mais simples for a linguagem, melhor!
A maioria dos leitores só quer saber como fazer a coisa e repetir a coisa. Uma abordagem é fornecer um conceito complexo e de alto nível no papel e, em seguida, repeti-lo novamente com uma versão simplificada para leigos. Isso atende a usuários técnicos e leigos de uma só vez, pintando 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 tem o objetivo de realizar o trabalho ao igualar a inteligência humana usando código de computador." - ambos significam a mesma coisa, mas visam públicos diferentes.
Use o Docsie para criar prateleiras para leigos e prateleiras para usuários técnicos. Dessa forma, você pode ter livros para atender a ambos os públicos, com hospedagem completa disponível por meio do Docsie Portal.
Código complexo simplificado para leigos no exemplo do 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 acordado até tarde!
Você reescreve cada guia do usuário do zero? Em vez disso, você deve criar modelos com estruturação básica e mensagens de marca e desenvolver esse conteúdo.
Escrever do zero leva tempo, exige esforço e pode causar inconsistência se vários redatores estiverem trabalhando no mesmo projeto. Os modelos são uma ótima maneira de economizar tempo ao escrever e promover maior consistência entre as páginas. A confiança é construída com base em mensagens consistentes e geração de valor, que os modelos promovem.
Clique em ...More e selecione Templates no Docsie. Aqui, você pode armazenar modelos e iniciar novos livros usando o modelo como fonte!
Modelo ao vivo no Docsie Editor](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_jdf9iWL3NXlFFePHx/boo_dqsfhc7ObadQ3xWmV/2bfcea18-df94-30ff-4931-799345e4ae74Templates2inDocsie.png)
5 - Escreva rápido, alterne com frequência
No desenvolvimento ágil de software, o mantra é falhar rapidamente e iterar com frequência. Aplicando isso aos guias de documentação do usuário, sua equipe deve ter como objetivo escrever rápido e iterar com frequência.
Isso não significa sacrificar a qualidade pela velocidade. Em vez disso, isso permite obter feedback e respostas dos clientes com menos esforço inicial. Esse feedback pode ser aproveitado em outras iterações do guia de documentação do usuário e ajuda a empresa a se tornar mais centrada no cliente.
O Docsie Vocally elucida o feedback dos leitores, com classificações e gravações de tela para identificar o conteúdo exato que eles leram. Experimente enquanto você escreve rápido e repete com frequência!
Visualização do feedback do Docsie Vocally](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_8uO5DnYSHSsLteI2X/boo_dqsfhc7ObadQ3xWmV/b9f841c9-1dde-5eee-c723-809f13df3255DocsieVocallyLivePreview.png)
6 - Conhecimento aninhado com backlinks internos
A documentação do seu guia do usuário tem backlinks para outras páginas? Ao adicionar links para seções relevantes da documentação, você ajuda os leitores a desenvolver e entender seu produto ou serviço em um nível conceitual.
Quando você se referir a um recurso ou função específica, sempre adicione um link. Permita que o leitor acesse rapidamente essas informações, em vez de forçá-lo a pesquisar e carregar a página por conta própria. Está falando de logins de contas? Adicione um URL de login ao texto "faça login em sua conta" em sua página e em todas as outras páginas. Torne sua documentação conveniente e navegável dentro do corpo do texto, em vez de uma biblioteca interminável a ser vasculhada.
O Docsie permite que os redatores de guias do usuário criem backlinks internos. Basta destacar algum texto e clicar no botão 🖇️ na barra de ferramentas do Docsie Editor. Além disso, você pode criar links independentes de idioma e versão com os Relative object links .
7 - Remova as teias de aranha e atualize o conteúdo antigo
Você tem guias de usuário e documentação antigos visíveis on-line? Se você tiver uma documentação da versão 1.2 publicada enquanto seu produto estiver na versão 1.3, ela não será mais relevante. Em vez de publicar uma nova documentação para cada versão, use o Docsie Versioning.
O Docsie Versioning permite que os usuários acessem versões históricas e atuais da documentação. À medida que novas versões são lançadas, as versões antigas são arquivadas para fins de redundância e ficam acessíveis em um menu suspenso. Tudo isso está na mesma página da Web, o que facilita a navegação e a localização de informações relevantes pelos usuários.
Da mesma forma, se o seu guia de principais dicas para 2021 ainda estiver publicado em 2022, atualize-o! Mude o nome, atualize todas as citações e fontes com pesquisas atualizadas e verifique novamente se as informações ainda são relevantes. Tire as teias de aranha e mantenha as coisas sempre verdes; o conteúdo sempre pode ser reaproveitado.
8 - Miniaturize as tarefas, conclua em lotes
Ao escrever, você escreve a página inteira de uma só vez, sem nenhum planejamento prévio? Parte disso se resume à preferência pessoal dos escritores. No entanto, ao miniaturizar as 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 seção. Use isso ao escrever e aborde seções individuais em vez de se preocupar com a página inteira. Isso é chamado de esboço no setor de redação. O esboço oferece oportunidade de feedback com os editores antes do início da redação e atua como uma estrutura de orientação à medida que o escritor escreve.
Crie um novo livro no Docsie e adicione alguns cabeçalhos e textos básicos para um esboço. Também é possível adicionar tarefas usando o menu do lado direito, dividindo o trabalho em lotes menores à medida que vários membros da equipe colaboram no conteúdo. O histórico de versões significa que você pode voltar atrás se um redator adicionar conteúdo de qualidade inferior, o que é perfeito para escrever rapidamente e repetir com frequência!
9 - Um índice para mais leitores de conteúdo
Com uma documentação de guia do usuário complexa e diversificada, uma parede de texto pode ser intimidadora para os leitores. Isso pode ser resolvido com um Índice abrangente. Comumente usado em enciclopédias, ele ajuda os usuários a identificar e saltar para informações relevantes, além de fornecer estrutura para um ambiente de portal de conhecimento.
Os artigos, as prateleiras e os espaços de trabalho do Docsie funcionam para criar um índice. Ele será exibido automaticamente no lado esquerdo do seu portal de conhecimento, proporcionando uma maneira fácil de navegar pela sua base de conhecimento. Com essa dica, o Docsie faz isso por você!
10 - Domine seu assunto
Seu redator é um especialista no assunto? Da mesma forma, seu redator tem recursos e é bom em pesquisar tópicos com os quais talvez não esteja familiarizado? Em última análise, apesar de todas as nossas dicas, o redator determina a qualidade dos seus guias de documentação do usuário.
Quanto mais ele entender o seu produto, mais preciso será o seu trabalho. Permita que os redatores tenham a flexibilidade de testar e testar seu produto, pois os usuários podem encontrar problemas semelhantes. Melhor ainda, acompanhe o redator em uma demonstração do produto com sua equipe de vendas e dê a ele experiência prática com o pipeline de vendas e as mensagens contidas nele. Isso também promove a consistência e transforma os redatores em usuários. Nem todos os redatores se tornam usuários, mas todos os usuários podem se tornar bons redatores com conhecimento prático.
Coloque essas dicas em prática no Docsie!
Obrigado por ler nossas 10 principais dicas para melhorar os guias do usuário. Convidamos você a aplicar essas dicas aos seus documentos do Docsie!
A Docsie é uma plataforma de gerenciamento de documentação de ponta a ponta que as empresas usam para criar FAQs baseadas na Web, documentos de produtos, guias de usuário, documentos de ajuda e manuais de usuário. A plataforma apresenta colaboração centrada no cliente, incorporação extensiva, traduções personalizadas e publicação avançada na ponta de seus dedos.
Faça sua mudança onboarding com a Docsie hoje mesmo e ofereça uma documentação deliciosa para seus clientes!