Qual é o meu plano?
Suite Team, Growth, Professional, Enterprise ou Enterprise Plus
  • Introdução: elementos de um canal de autoatendimento
  • Parte 1: planejamento do projeto de conteúdo de autoatendimento
  • Parte 2: planejamento da estrutura de conteúdo de autoatendimento
  • Parte 3: definição de quais artigos precisam ser criados
  • Parte 4: redação de artigos da base de conhecimento
  • Parte 5: lançamento de sua central de ajuda
  • Parte 6: monitoramento de métricas essenciais do autoatendimento
  • Parte 7: manutenção e aprimoramento de sua base de conhecimento

Os artigos anteriores nesta série descreveram as etapas envolvidas na criação até chegar a esta etapa: a redação de artigos da base de conhecimento. Este artigo descreve os processos e as ferramentas que você pode usar para escrever seus artigos da base de conhecimento e prepará-los para publicação quando lançar sua central de ajuda.

Você tem muitas opções de ferramentas para escrever os artigos. Se você já tem processos esquematizados para criar, compartilhar e revisar a documentação, usando o Google Docs ou o Microsoft Office, por exemplo, pode criar seu conteúdo em outra ferramenta e depois publicá-lo na central de ajuda. Ou então, pode redigir os artigos diretamente na sua central de ajuda.

Este artigo abrange os seguintes tópicos:

  • Uso de ferramentas de autoria externas
  • Criação dos artigos no Guide
  • Definição do processo de revisão e publicação de artigos
  • Uso do Conhecimento para criar artigos

Uso de ferramentas de autoria externas

Se você está criando seu conteúdo em uma ferramenta de autoria externa, precisa inseri-lo em um novo artigo em branco criado para esse conteúdo no Guide quando estiver com a versão pronta para a publicação.

O editor oferece suporte total a HTML e, em todos os planos, exceto no Suite Team, você pode modificar o arquivo style.css da sua central de ajuda e criar estilos e formatações personalizados para o conteúdo adicionado a um artigo. Você pode colar o código HTML de um artigo que foi redigido em outra ferramenta editando o código-fonte no editor.

Observação: o processo usado pela equipe de documentação de produtos Zendesk é descrito em Como as documentações de produto são desenvolvidas na Zendesk. Esse artigo também descreve como importamos nossos artigos para nossa central de ajuda usando a API da Zendesk. Ele também contém links para o código que desenvolvemos, disponível no Github.

Criação dos artigos no Guide

Se você escolhe criar seus artigos da base de conhecimento diretamente no Guide, pode usar os estilos de formatação fornecidos no Editor, sem se preocupar com o HTML. Ou você pode combinar WYSIWYG e escrita HTML para conseguir a formatação desejada.

Para criar artigos no Guide, é preciso ser um agente em sua conta do Zendesk Support e ter a permissão apropriada para a criação de artigos. Por padrão, o Guide permite que agentes com a permissão de Gerente do Guide criem e publiquem artigos, mas é possível estender isso para outros agentes também.

Para saber como as funções e permissões do usuário são definidas e usadas no Guide, consulte Noções básicas sobre funções e privilégios do Guide, Definição de permissões de edição e publicação de agentes em artigos da base de conhecimento e Criação de gerenciamento de permissões para definir direitos de edição e publicação dos agentes.

Quando todos os seus redatores tiverem as permissões necessárias, eles poderão criar e publicar artigos assim que estiverem prontos ou seguindo qualquer processo de revisão e publicação ou programação que você definir.

Para obter mais informações, consulte Criação e edição de artigos na base de conhecimento.

Dica:
  • Você pode criar seus artigos diretamente no Guide ou em uma ferramenta de autoria externa.
  • Você pode copiar arquivos do Google Docs para novos artigos ou trazer conteúdo de origem externa como texto ou HTML.
  • Você precisa refletir sobre a formatação e a consistência, especialmente quando usa HTML de origem externa.
  • Para criar artigos no Guide, é preciso ser um agente em sua conta do Zendesk Support e ter a permissão apropriada para a criação de artigos.

Definição do processo de revisão e publicação de artigos

À medida que os artigos forem concluídos e colocados em fila, é preciso ter um processo simples para a revisão e a publicação deles. Digamos que esteja criando seus artigos diretamente no Zendesk Guide. Você pode revisá-los nele e publicá-los em datas específicas escolhidas para o lançamento.

Os novos artigos que você cria permanecem em modo de rascunho até serem publicados. Isso significa que só você e outros membros da equipe que têm acesso ao Guide podem vê-los. Como rascunhos, eles podem ser analisados e revisados conforme a necessidade antes serem publicados para os clientes.

Observação: nos planos Enterprise, você pode marcar um artigo como pronto para revisão e, opcionalmente, atribuir um membro da equipe como revisor. Esse é um recurso da Publicação em equipe e você pode ler mais sobre isso em Criação de conteúdo novo para revisão. Nos planos Enterprise, também é possível estabelecer um prazo específico para a publicação do artigo. Consulte Programação de artigos para publicação e cancelamento.

Se você está usando uma ferramenta de autoria externa, como o Google Docs, revise e conclua o conteúdo antes de levá-lo para o Guide como um novo artigo.

É importante lembrar que você deve incluir um período de revisão em suas programações, e é sempre recomendável estipular uma data limite para seus revisores, pois ajudará você a garantir que as revisões sejam concluídas no prazo.

Dica:
  • Revise seus artigos antes de publicá-los. Esse passo é importante para garantir a precisão e a consistência.
  • Adicione data e hora em suas programações para a revisão do conteúdo.
  • É possível criar rascunhos de artigos que podem ser revisados antes da publicação.
  • Se você está usando uma ferramenta de autoria externa, como o Google Docs, crie um processo de compartilhamento e revisão do conteúdo antes de criar um artigo novo.
  • No Enterprise, é possível atribuir pessoas específicas para a revisão de artigos e também definir a data e a hora para a publicação automática dos artigos.

Uso do Conhecimento para criar artigos

Uma outra abordagem para a criação de artigos é usar a seção Conhecimento do painel de contexto, especialmente quando membros da equipe de suporte são encarregados de criar artigos. Dependendo das configurações, os agentes podem criar artigos da central de ajuda a partir de um artigo em branco ou dos modelos predefinidos disponíveis. Consulte Criação e solicitação de artigos no Conhecimento.

Powered by Zendesk