Entenda os sites de documentação
Os sites de documentação transformam seus artigos do Clevera em uma central de ajuda hospedada com pesquisa, um assistente de IA, feedback dos leitores e idiomas. Veja aqui o que os leitores recebem, quem pode fazer o quê e o que consome créditos.
Um site de documentação é uma central de ajuda hospedada, criada a partir dos artigos no seu workspace do Clevera. Você escreve e edita artigos onde eles já estão, adiciona-os a um site como páginas e publica. Os leitores recebem um site público rápido com pesquisa, um assistente de IA que cita suas páginas e uma maneira de informar o que não foi útil. Os sites de documentação estão incluídos em todos os planos, inclusive no Gratuito.
Como funciona um site de documentação
- Seus artigos são as páginas. Uma página em um site de documentação exibe um artigo da sua biblioteca. Edite o artigo e a página será alterada na próxima publicação. O artigo permanece em Conteúdo; remover a página do site nunca o exclui.
- Você publica versões. As alterações são acumuladas até entrarem no ar como uma nova versão. Cada versão é mantida em Publicando, para que você possa ver o que mudou e reverter.
- Ele tem seu próprio endereço. Cada site recebe um endereço gratuito,
your-site.clevera.help. No plano Starter em diante, você pode disponibilizá-lo a partir do seu próprio domínio, comohelp.example.com. - Os leitores nunca veem seu workspace. Eles veem apenas o site. As pessoas no seu workspace gerenciam o site a partir de Sites de documentação na barra lateral.
Cada site possui estas telas, agrupadas em sua barra lateral:
| Grupo | Telas | O que você faz lá |
|---|---|---|
| Visão geral | Visão geral | Checklist de configuração, tráfego e próximos passos |
| Conteúdo | Páginas, Registro de alterações, Redirecionamentos | Seções, páginas e sua ordem; notas de lançamento; endereços antigos |
| Insights | Análise de dados, Pesquisar, Assistente, Feedback | Visualizações, o que os leitores pesquisaram e perguntaram, avaliações de página |
| Site | Aparência, Navegação, Domínio, Configurações, Publicando | Visual, menus, seu próprio domínio, acesso e o assistente, versões |
O que os leitores recebem
| Recurso | O que os leitores veem |
|---|---|
| Página inicial | Um título, uma caixa de pesquisa, suas seções como cartões de tópicos e as páginas que você destaca |
| Pesquisar | Pesquisar… no cabeçalho, ou ⌘ K / Ctrl K a partir de qualquer página. Os resultados são atualizados conforme digitam e lembram pesquisas recentes. |
| Assistente de IA | Perguntar à IA responde a perguntas a partir de suas páginas publicadas e lista as fontes que utilizou. Você o ativa em Configurações → Assistente de IA. |
| Feedback da página | "Esta página foi útil?" ao final de cada página, com motivos opcionais e um comentário |
| Idiomas | Um seletor de idioma no cabeçalho quando o site possui mais de um idioma. Uma página sem tradução exibe o idioma padrão com um breve aviso. |
| Claro e escuro | Um seletor de tema no cabeçalho. Você define o padrão. |
| Ações da página | Copiar uma página como Markdown, visualizá-la como texto simples ou abri-la em um aplicativo de chat de IA para fazer perguntas sobre ela |
| Cópias legíveis por máquina | llms.txt e cópias em Markdown de páginas públicas para ferramentas de IA, além de um sitemap para mecanismos de busca |
| Registro de alterações | Uma página de notas de lançamento com categorias (Novo, Melhorado, Corrigido, Segurança, Obsoleto) e um feed RSS |
| Formulário de contato | Contatar suporte envia uma mensagem para um endereço de e-mail que você confirmar (Starter em diante) |
Sites no plano Gratuito exibem um pequeno selo "Powered by". Planos Starter em diante podem removê-lo.
Quem pode fazer o quê
Os sites de documentação usam as funções do seu workspace. Todos no workspace podem abrir todos os sites de documentação.
| Tarefa | Proprietário | Administrador | Editor | Criador de conteúdo |
|---|---|---|---|---|
| Abrir sites, páginas e insights | Sim | Sim | Sim | Sim |
| Editar páginas, seções e entradas do registro de alterações | Sim | Sim | Sim | Sim |
| Adicionar novos artigos, páginas de site e entradas do registro de alterações | Sim | Sim | Não | Sim |
| Publicar, reverter, alterar visual, navegação, domínio e configurações | Sim | Sim | Sim | Não |
| Criar um site de documentação | Sim | Sim | Não | Não |
| Excluir um site de documentação | Sim | Sim | Não | Não |
| Importar e exportar conteúdo | Sim | Apenas visualização | Não | Não |
Editores melhoram o que existe e publicam; eles não criam novo conteúdo. Criadores de conteúdo escrevem e editam, e um proprietário, administrador ou editor publica. Onde um controle está desativado para sua função, a dica de ferramenta explica o motivo, por exemplo: "Apenas proprietários e administradores do workspace podem criar sites de documentação."
O que consome créditos
Hospedar um site de documentação é gratuito. A maior parte do que acontece nele não consome créditos.
| Ação | Créditos |
|---|---|
| Hospedagem, visualizações de página, visitantes e largura de banda | Nenhum |
| Pesquisa do leitor | Nenhum |
| Respostas do assistente aos leitores | Nenhum. Cada plano inclui um número mensal de respostas. |
| Traduzir títulos de página, nomes de seção, rótulos de menu | Nenhum |
| Publicar, reverter, redirecionamentos, análise de dados | Nenhum |
| Importar de outra plataforma, exportar um site | Nenhum |
| Gerar ou traduzir uma página de site com IA | Créditos de IA de artigo. A caixa de diálogo mostra "Até N créditos" antes de você começar. |
| Traduzir entradas do registro de alterações | Créditos de IA de artigo |
| Escrever um artigo com IA (no Redigir ou no editor de artigos) | Os créditos de artigo usuais |
Veja Entenda os créditos para saber como os créditos funcionam, e Planos e limites dos sites de documentação para ver o que cada plano inclui.