Com base nos documentos fornecidos — “Guidelines for Drafting Knowledge Base for Improved Answer Retrieval by Answer Bot” e “Formatting Knowledge Base Articles Using WYSIWYG Editor” — segue um artigo consolidado sobre como formatar a base de conhecimento, respeitando as diretrizes para melhorar a recuperação de respostas por bots e garantir clareza para os leitores humanos.
A base de conhecimento é um dos principais recursos de autoatendimento disponíveis para clientes e usuários. Uma boa formatação, aliada a uma estrutura clara e objetiva, não apenas melhora a experiência do usuário, mas também potencializa a eficácia de ferramentas automatizadas como Answer Bots. Este artigo reúne as principais diretrizes para redigir e formatar artigos da base de conhecimento utilizando o editor WYSIWYG, garantindo consistência e alto desempenho nas buscas.
a) Comece com um título claro e direto
Use frases que indiquem claramente o propósito do artigo, preferencialmente no formato de perguntas ou comandos, como:
“Como redefinir minha senha?”
“Adicionar novo usuário ao sistema”
b) Parágrafo introdutório
O primeiro parágrafo deve fornecer um resumo objetivo do que o artigo cobre. Evite jargões e vá direto ao ponto. Isso ajuda o bot a capturar a essência da resposta.
c) Divisão por seções
Use subtítulos (Heading 2 ou Heading 3) para separar etapas ou áreas temáticas. Isso facilita a leitura e a indexação pelas ferramentas de busca.
a) Linguagem simples e objetiva
Evite frases longas, palavras complexas ou termos técnicos desnecessários. Prefira frases curtas e diretas.
b) Palavras-chave relevantes
Inclua termos que o usuário provavelmente usaria ao buscar uma solução, e repita-os naturalmente ao longo do texto.
c) Use o formato de pergunta e resposta
Sempre que possível, escreva no formato Q&A (Pergunta e Resposta), que melhora a recuperação por bots.
a) Cabeçalhos e hierarquia
Use Heading 1 apenas para o título do artigo (geralmente automático).
Use Heading 2 para seções principais.
Use Heading 3 para sub-seções dentro de uma etapa ou tema.
b) Listas
Utilize listas numeradas para procedimentos passo a passo.
Use listas com marcadores para itens não sequenciais.
c) Destaques
Use negrito para destacar ações importantes ou palavras-chave.
Evite o uso excessivo de itálico ou sublinhado, pois podem confundir o leitor.
Prefira blocos de citação ou caixas de alerta para observações ou avisos.
d) Tabelas e imagens
Use tabelas para organizar informações comparativas e capturas de tela sempre que necessário, com legendas descritivas.
a) Artigos independentes
Evite criar dependência entre artigos. Cada artigo deve fornecer a solução completa para o problema específico.
b) Consistência terminológica
Mantenha consistência no uso de nomes de botões, menus e ações do sistema.
c) Atualização contínua
Revisite artigos periodicamente para garantir que ainda estejam corretos e atualizados com novas versões do sistema.
Evite blocos grandes de texto sem quebras.
Não misture diferentes estilos de formatação no mesmo parágrafo.
Não use links quebrados ou imagens desatualizadas.
Não utilize instruções ambíguas como “clique ali” ou “vá até a opção”.
Formatar corretamente os artigos da base de conhecimento é essencial para proporcionar um autoatendimento eficaz e inteligente. Ao seguir essas diretrizes, você garante não apenas uma leitura mais fluida para os usuários, mas também melhora substancialmente o desempenho dos bots de resposta automática. Um bom conteúdo é aquele que resolve o problema de forma clara, rápida e acessível — tanto para humanos quanto para máquinas.