O que é a criação de ajuda?
A criação de ajuda refere-se ao processo de design, publicação e manutenção de documentação de ajuda de software. O texto resultante é usado em guias de explicação, FAQs, manuais e arquivos de ajuda.
Apesar de ser realizada por redatores técnicos especializados, a criação de ajuda é frequentemente considerada um processo de desenvolvimento. As equipes de desenvolvimento empregam a criação de ajuda para criar e manter a documentação de ajuda para seus produtos de software existentes e quaisquer novos recursos que possam ser adicionados. As principais ferramentas de software usadas para esse processo são ferramentas de criação de ajuda (HAT) e software de base de conhecimento. As HATs ajudam os redatores técnicos a reduzir o tempo e o esforço necessários ao criar materiais de assistência para funcionários e usuários finais. O software de base de conhecimento permite que os redatores técnicos mantenham e atualizem uma base de conhecimento central contendo todo o texto de ajuda de software que criaram sobre seu produto. Esta base de conhecimento, que geralmente é uma página da web ou documento acessível ao usuário, pode ser atualizada assim que os redatores técnicos adicionam novo texto ou imagens.
Tipos de criação de ajuda
Dependendo do que a criação de ajuda está sendo usada ou da indústria em que uma empresa está, um ou mais tipos de criação de ajuda serão utilizados.
- Escrita de FAQ: Seções de FAQ (perguntas frequentes) são recursos importantes para os clientes que os ajudam a resolver problemas comuns de software. Isso ajuda as empresas a mitigar a quantidade de tráfego que passa por seus canais de atendimento ao cliente.
- Escrita de tutoriais: Tutoriais e guias de explicação são escritos para suavizar a curva de aprendizado para novos usuários de software. Este tipo de escrita é talvez o exemplo mais clássico da interseção entre desenvolvimento de software e redação técnica que a criação de ajuda representa. Os tutoriais devem ser claros e concisos, e também devem ser apresentados de forma clara enquanto um usuário navega no aplicativo de uma empresa pela primeira vez.
- Documentos voltados para funcionários: Além dos materiais de ajuda voltados para o cliente, as empresas também empregam a criação de ajuda para criar documentação interna. Os funcionários podem usar essa documentação como um recurso de treinamento, um ponto de referência ou ambos.
Benefícios do uso da criação de ajuda
- Filtragem de tráfego: A criação de ajuda permite que as empresas forneçam aos seus clientes documentação de ajuda clara e facilmente acessível. Isso aumenta as chances de que um usuário que esteja enfrentando um problema possa resolvê-lo sozinho sem precisar entrar na fila de atendimento ao cliente.
- Gestão do conhecimento: A criação de ajuda para uso interno garante que os funcionários tenham acesso a tantas informações relevantes quanto possível. Isso permite que os funcionários façam seu melhor trabalho e evita que as informações fiquem isoladas.
- Integração de clientes: A criação de ajuda ajuda as empresas a guiar seus novos usuários através dos recursos e uso de seu software. Isso promove uma experiência de integração positiva para novos clientes.
- Retenção de clientes: Ao empregar a criação de ajuda para fornecer aos clientes recursos de solução de problemas, as empresas retêm mais clientes que, de outra forma, poderiam ter interrompido o serviço por frustração.
Melhores práticas de criação de ajuda
A criação de ajuda deve ser realizada com minúcia, clareza e tom em mente. Para que a documentação de ajuda de qualquer tipo seja eficaz, os leitores devem ser capazes de encontrar ajuda para perguntas e problemas comuns e compreender o conteúdo facilmente. O tom deve ser direto e informativo ou corresponder à identidade de marca desejada por uma empresa.
Para fazer a criação de ajuda funcionar, os usuários podem seguir estas melhores práticas:
- Aborde perguntas e problemas comuns: Ao escrever documentação de ajuda, os redatores devem abordar o maior número possível de perguntas e problemas comuns. Isso aumenta a probabilidade de os usuários encontrarem o que precisam por meio da documentação e evita frustrações.
- Escreva claramente: Ao empregar a criação de ajuda, o produto final deve ser o mais claro possível e organizado de forma que os usuários possam navegar facilmente até o tópico desejado.
- Use ferramentas de software: As HATs e o software de base de conhecimento podem ajudar as empresas a organizar e gerenciar sua documentação de ajuda. Outros benefícios incluem escalabilidade e redução do tempo gasto na escrita.
Criação de ajuda vs. gestão do conhecimento
A criação de ajuda está intimamente relacionada à gestão do conhecimento. De fato, muitas HATs possuem capacidades de gestão de base de conhecimento. Para distinguir entre os dois conceitos, é melhor pensar na criação de ajuda como a criação real de FAQs, manuais, arquivos de ajuda e outra documentação para armazenar informações úteis. Em contraste, a gestão do conhecimento é uma abordagem integrada para identificar, capturar, recuperar e compartilhar esses ativos de informação.
Adam Crivello
Adam is a research analyst focused on dev software. He started at G2 in July 2019 and leverages his background in comedy writing and coding to provide engaging, informative research content while building his software expertise. In his free time he enjoys cooking, playing video games, writing and performing comedy, and avoiding sports talk.
