Lançar seu primeiro centro de ajuda

Um site de docs é um centro de ajuda hospedado, criado a partir dos artigos no seu espaço de trabalho, com pesquisa, um assistente Perguntar à IA e feedback dos leitores. Este artigo leva você desde seus primeiros artigos até um site ativo em seu próprio endereço. Cada etapa contém um link para o artigo com os detalhes.

Antes de começar#

• Sua função: proprietários e administradores do espaço de trabalho criam e configuram sites de docs. Criadores de conteúdo podem adicionar páginas, e Editores podem publicar. Veja quem pode fazer o quê.
• Seu plano: sites de docs estão disponíveis em todos os planos, incluindo o Gratuito. Os planos Gratuito e Starter incluem 1 site; o Pro inclui de 2 a 5, dependendo das licenças. Veja Planos e limites de sites de docs.
• Plano Gratuito: a publicação requer um endereço de e-mail verificado.

Crie passo a passo#

1. Escreva seus primeiros artigos#

   Um site exibe artigos, então comece com alguns. Clique em Criar, abra a aba Artigo e escolha um tipo: Artigo de como fazer, Solução de problemas, POP, Postagem de blog ou Atualização de produto. Adicione uma gravação, a partir do aplicativo para desktop, da extensão do Chrome, de um upload, da sua biblioteca ou de Gravar com IA, e clique em Gerar artigo. Um artigo geralmente custa de 5 a 15 créditos. Veja Transforme uma gravação em um artigo.

   Já tem um centro de ajuda em outro lugar? Você pode importá-lo ao criar o site (próxima etapa).

2. Criar o site de docs#

   Clique em Sites de documentação na barra lateral e, em seguida, em Novo site de docs. O assistente possui três etapas:

   1. Nomeie seu site: digite um Nome do site e verifique o Endereço gratuito, que termina em .clevera.help. Escolha o Idioma do site.
   2. O que incluir?: escolha De uma coleção (cada pasta se torna uma seção), Escolher conteúdo, Começar vazio ou Importar de outra ferramenta.
   3. Personalize: adicione um Logotipo, uma Cor da marca, uma Fonte e a Aparência padrão.

   Clique em Criar site. Ao começar a partir de conteúdo, o site é publicado imediatamente no endereço gratuito e abre na Visão geral, com uma lista de verificação para Começar. Veja Criar um site de docs.

3. Adicionar e organizar páginas#

   Abra Páginas na barra lateral do site para adicionar seções, adicionar artigos da sua biblioteca, escrever novas páginas e definir a ordem delas. A lista de verificação solicita pelo menos 5 páginas. Veja Adicionar e organizar páginas.

4. Definir o visual#

   Abra Aparência para alterar o logotipo, a cor da marca, o estilo do site, as fontes e o cabeçalho da sua página inicial. Uma prévia ao vivo mostra cada alteração. Configure os menus de cabeçalho e rodapé em Navegação. Veja Personalizar a aparência de um site de docs e Configurar o cabeçalho e o rodapé de um site de docs.

5. Ativar o Perguntar à IA#

   O assistente fica desativado em um novo site. Vá para Configurações → Assistente de IA, ative Mostrar o assistente, escolha o que acontece Quando não for possível responder e clique em Salvar. Ele responde apenas com base nas suas páginas publicadas e lista suas fontes. As respostas não custam créditos; seu plano inclui um número mensal de respostas (300 no plano Gratuito). Veja Configurar o assistente do site de docs.

6. Escolher quem pode ler#

   Todo site é público por padrão. Para torná-lo privado, vá para Configurações → Acesso e escolha Senha ou Login no espaço de trabalho. Sites privados exigem o plano Pro ou superior. Veja Controlar quem pode ler um site de docs.

7. Publicar#

   Clique em Publicar no cabeçalho do site, verifique a lista de alterações e confirme (o botão diz, por exemplo, Publicar 3 alterações). Os leitores veem a nova versão em segundos, e cada versão é mantida em Publicando para que você possa reverter. Publicar automaticamente está ativado para novos sites: assim que o site estiver ativo, as alterações salvas entram no ar após cerca de dois minutos sem edições. Veja Publicar um site de docs.

8. Conectar seu próprio domínio#

   Domínios personalizados exigem o plano Starter ou superior. Abra Domínio, insira um subdomínio como help.example.com e clique em Conectar. Adicione o registro CNAME que a Clevera mostra no seu provedor de domínio e clique em Verificar agora. O certificado geralmente leva de 5 a 30 minutos; quando o status estiver Ativo, o endereço gratuito redireciona para o seu domínio. Domínios raiz como example.com não podem ser conectados. Veja Conectar um domínio personalizado a um site de docs.

Deixe o Autopilot criar para você#

No plano Pro e superior, o Piloto automático pode criar e manter a central de ajuda para você. Clique em Piloto automático na barra lateral para começar; veja Obtenha acesso ao Piloto automático. Apenas o proprietário do workspace ou um administrador pode usar a receita de criação.

Criar um centro de ajuda a partir do seu aplicativo#

Em Autopilot, clique na receita Criar um centro de ajuda a partir do meu aplicativo ou digite "Crie um centro de ajuda para mim" em O que o Autopilot deve fazer?. O agente da Clevera exibe um cartão de configuração. Clique em Preencher os detalhes, adicione seu Site e Endereço do aplicativo, escolha um login e selecione os idiomas do site.

Em Centro de ajuda existente, escolha Começar do zero ou Importá-lo e selecione Intercom, Zendesk, Help Scout, GitBook, ReadMe, Mintlify, Document360, Docusaurus ou Outro site de docs. A importação lê apenas páginas públicas e é gratuita. Notion e Confluence são importados das configurações do site assim que ele existir.

A tarefa é executada em quatro etapas: Marca, Site e vídeos, Artigos e Revisar e publicar. O planejamento é gratuito. Você vê o plano de cada etapa e seus créditos, e nada é executado até que você clique em Executar. Uma criação típica custa de 240 a 560 créditos e leva de 1 a 3 horas. A Clevera nunca publica o site para você: na última etapa, você escolhe os artigos e clica em Publicar. Veja Criar um centro de ajuda a partir do seu aplicativo com o Autopilot.

Mantenha-o atualizado ao lançar novidades#

Assim que o site existir, a receita Manter meu centro de ajuda atualizado quando lançarmos novidades monitora as versões ou alterações mescladas de um repositório, uma página de changelog ou uma alteração que você descrever. Cada vez que algo muda, a Clevera verifica os vídeos e artigos afetados e planeja as correções. Cada execução aguarda sua revisão; uma execução típica custa de 10 a 150 créditos. Veja Manter seu centro de ajuda atualizado ao lançar novidades.

Relacionado#