O site da base de conhecimento é o lado voltado para leitores do seu projeto Document360. É o site publicado onde seus leitores, clientes ou membros da equipe vão para encontrar e ler sua documentação.
Tudo o que você cria e configura no portal da Knowledge Base, como artigos, categorias, branding, navegação, configurações do site, é o que molda a experiência no site da Knowledge Base.
O site da Base de Conhecimento está acessível diretamente aos seus leitores através da URL da sua base de conhecimento. Dependendo de como seu projeto está configurado, ele pode ser:
- Público - acessível a qualquer pessoa sem login
- Privado - acessível apenas para leitores logados
- Misto - alguns conteúdos são públicos, outros requerem login
Os leitores podem buscar conteúdo, navegar por categorias, ler artigos, seguir temas que lhes interessam, fornecer feedback e interagir com a Eddy AI, tudo isso sem precisar nunca ter acesso ao portal.
Principais características
O site da base de conhecimento inclui uma série de recursos projetados para melhorar a acessibilidade do conteúdo, personalização e engajamento dos leitores.
| Característica | Descrição |
|---|---|
| Favoritos | Leitores logados podem salvar artigos, árvores de decisão, endpoints de API e categorias de página como favoritos usando o ícone de coração (❤️). Todos os itens salvos são acessíveis pela seção Favoritos no painel esquerdo ou pelo perfil. |
| Painel direito personalizável | Os administradores podem reordenar os módulos do painel direito como Arquivos, Tags, Artigos Relacionados e Neste artigo, usando arrastar e soltar, e mover Artigos Relacionados entre o painel direito e o rodapé do artigo. |
| Cabeçalho fixo na rolagem | Ícones principais de cabeçalho como Tema, Perfis, Seletor de idioma, Buscar, Compartilhar, Editar, Exportar PDF, Imprimir, Seguir e Favoritos permanecem visíveis enquanto se percorrem artigos longos. |
| Baixe artigos e categorias em PDF | Leitores logados podem baixar em massa artigos e categorias selecionados como arquivos PDF do site da base de conhecimento em projetos privados, facilitando o acesso offline. |
| Baixar PDF a partir de Notificações | PDFs exportados estão disponíveis para download direto na seção de Notificações. Não é necessário depender de e-mail. PDFs estão disponíveis por 30 dias a partir da data de geração. |
| Compartilhe links privados para artigos | Gere links compartilháveis e privados para permitir que usuários externos, como revisores, colaboradores ou partes interessadas, vejam artigos sem precisar acessar sua base de conhecimento. |
| Siga artigos e categorias | Os leitores podem assinar atualizações de artigos ou categorias específicas e receber notificações por e-mail sobre mudanças. Disponível para projetos públicos e privados. |
| Recibos de leitura aprimorados | Estabeleça regras dinâmicas para reconhecimentos de leitura baseados em espaço de trabalho, categoria ou papel do usuário. Realize operações em grande quantidade e gerencie a conformidade de forma eficiente. |
| Nomes de exibição localizados de espaços de trabalho | Personalize o nome do seu espaço de trabalho por idioma para sites de base de conhecimento multilíngues, proporcionando uma experiência nativa para os usuários baseada na escolha do idioma. |
| Suporte a IA e chatbots para Eddy Conversacional | A Eddy AI mantém o contexto da conversa , permitindo que os usuários façam perguntas de acompanhamento e obtenham respostas mais precisas em vários idiomas. Também disponível no chatbot Eddy AI. |
| Análises aprimoradas para Eddy AI | Obtenha insights mais profundos sobre as interações dos usuários com a Eddy AI. Filtre as conversas por tema, feedback ou status da resposta. |
| Blocos de conteúdo condicional | Controle a visibilidade do conteúdo com base em país, IP, data, tipo de dispositivo ou grupo de leitores, personalizando o conteúdo sem duplicar artigos. |
| Ouça artigos | Os leitores podem ouvir o conteúdo do artigo usando o recurso Ouvir (ler em voz alta), melhorando a acessibilidade e permitindo multitarefa. |
| Aprimoramento global de busca | Pesquise em todos os espaços de trabalho, incluindo os de API. Alterne entre visões globais e individuais de espaço de trabalho com filtros inteligentes e resultados unificados. |
| Personalização do site | Os administradores podem personalizar a aparência e o layout do site da base de conhecimento – incluindo temas, cores, tipografia, navegação e conteúdo da página inicial a partir da personalização do site. |
Layout do site da base de conhecimento
O site da base de conhecimento é organizado em seções distintas. A imagem abaixo mostra o layout de uma página de documentação.
1. Cabeçalho
O cabeçalho passa pelo topo de todas as páginas do site da base de conhecimento e está sempre visível.
.png)
| Elemento | O que ele faz | |
|---|---|---|
| a | Logotipo | Exibe o logotipo da sua organização. Clicar nele, navega para a página inicial da base de conhecimento. |
| b | Espaço de trabalho | Use o menu suspenso para navegar entre os espaços de trabalho. Clique no espaço de trabalho de documentação da API para ir à página inicial da documentação da API. |
| c | Navegação principal | Links configurados pelo seu administrador para ajudar os leitores a navegar para diferentes páginas a partir da página inicial ou do site da base de conhecimento. |
| d | Notificações ( ) | Exibe artigos publicados recentemente e notificações de PDFs exportados prontos para download. Um distintivo mostra a contagem não lida. |
| e | Obrigação necessária ( ) | Exibe artigos que exigem um reconhecimento de leitura por parte do leitor. |
| f | Tema | Alterne entre tema do Sistema, temas de Luz e Sombras. Tema de luz está definido como padrão. |
| g | Idioma | Selecione o idioma para ler os artigos, da lista disponível. |
| h | Navegação secundária | Links de navegação adicionais configurados pelo seu administrador, normalmente agrupados ou aninhados. |
Se apenas uma linguagem for configurada para um espaço de trabalho, o menu suspenso da linguagem não aparecerá no site da Base de Conhecimento.
2. Painel de navegação à esquerda
O painel de navegação à esquerda exibe a estrutura da sua base de conhecimento, permitindo que os leitores naveguem por categorias e artigos. A barra de busca no topo do painel permite que os leitores pesquisem artigos usando palavras-chave ou Eddy AI — use o atalho Ctrl + K (Comando + K no Mac). Para mais informações, veja o artigo de Busca .
.png)
| Elemento | O que ele faz | |
|---|---|---|
| A | Explorar artigos | Clique para filtrar a árvore de navegação por categoria ou nome do artigo. |
| B | Ocultar navegação | Clique para encolher o painel esquerdo e ver uma visão mais ampla do artigo. |
| C | Vista em árvore | Exibe categorias e artigos em uma estrutura hierárquica em árvore. |
| D | Favoritos | Quando ativados, usuários logados podem marcar artigos, árvores de decisão e endpoints como favoritos. Itens favoritos aparecem em uma seção dedicada aos Favoritos. |
| E | Distintivo de status | Um pequeno distintivo colorido em cada artigo indica seu status , como Novo, Atualizado ou Personalizado. |
| F | Mais opções | Para projetos privados e mistos, passe o mouse sobre um artigo para acessar a opção Adicionar aos favoritos. |
3. Seção de artigos
A seção de artigos é onde o conteúdo do artigo selecionado é exibido.
| Elemento | O que ele faz | |
|---|---|---|
| A | Migalhas de pão | Mostra o caminho de navegação de volta para a categoria e subcategoria pai. |
| B | Título do artigo | Exibe o título do artigo. |
| C | Copiar link | Copia a URL do artigo para a área de transferência. |
| D | Distintivo de status | Exibe o status do artigo como Novo, Atualizado ou personalizado. |
| E | Data do artigo | Mostra a data de publicação ou última atualização. |
| F | Tempo de leitura | Exibe um tempo estimado de leitura baseado na contagem de palavras. |
| G | Colaboradores | Lista os membros da equipe que trabalharam no artigo. Clicar no avatar de um colaborador abre a página do colaborador mostrando todos os artigos em que ele trabalhou. |
| H | Siga | Permite que os leitores assinem atualizações de artigos. Disponível para relatos de leitores. |
| I | Favoritos (❤️) | Adiciona ou remove o artigo dos favoritos do leitor. Disponível para usuários logados em projetos privados. |
| J | Compartilhe | Compartilhe o artigo pelo Twitter, LinkedIn, Facebook ou e-mail. |
| K | Exportar PDF | Baixa o artigo ou categoria em PDF quando ativado pelo administrador. |
| L | Mais opções ( ) | Acesse Print e outras opções. As opções disponíveis dependem das configurações do seu navegador. |
| M | Resumo do artigo | Veja um resumo gerado por IA do artigo, alimentado pela Eddy AI. |
4. Visualizador de imagens
Quando você clica em uma imagem no site da base de conhecimento, ela se abre em um visualizador de imagens.
| Controle | O que ele faz | |
|---|---|---|
| a | Texto do título | Exibe a legenda da imagem, se for fornecida. |
| b | Link aberto | Abre a URL da imagem em uma nova aba, se disponível. |
| c | Afaste ( ) | Minimiza a imagem. |
| d | Amplie ( ) | Amplia a imagem. |
| e | Baixar ( ) | Baixa a imagem para armazenamento local. |
| f | Fechar (X) | Fecha o visualizador de imagens. |
| g | Próximo ( ) | Passa para a próxima imagem do artigo. |
| h | Anterior ( ) | Passa para a imagem anterior. |
Você também pode segurar e arrastar a imagem para reposicioná-la na tela. Clicar em qualquer lugar fora da imagem fecha o visualizador.
5. Painel direito
O painel direito exibe informações suplementares ao lado do artigo. Por padrão, as seções aparecem nesta ordem: Arquivos > Tags > Artigos relacionados > Neste artigo.
Os administradores podem personalizar essa ordem usando arrastar e soltar, navegando até Configurações () > site da base de conhecimento > Configurações de artigos e SEO > seção direita do artigo > Seções de Reordenação.
| Seção | O que ela mostra | |
|---|---|---|
| a | Vidro de esconderijo | Colapsa o painel direito para uma visão mais ampla do artigo. |
| b | Arquivos | Anexos associados ao artigo. |
| c | Tags | Tags aplicadas ao artigo. Clicar em uma tag abre uma página listando todos os artigos associados a essa tag. |
| d | Neste artigo | Uma lista de títulos dentro do artigo (anteriormente chamada de "Sumário"). Expande automaticamente quando o artigo carrega. Tem um rolinho dedicado para listas de cabeçalhos longos. |
| — | Artigos relacionados | Artigos relacionados ao atual. Administradores podem mover essa seção para o rodapé do artigo, se preferir. |
Comportamento do módulo:
- Todos os módulos suportam expansão e colapso.
- Módulos com mais itens do que a altura visível inicial mostram um Mostrar mais controle.
- No tablet e no celular, o painel direito se encaixa em uma gaveta.
- O último módulo no painel direito permanece fixo no scroll.
6. Rodapé do artigo
O rodapé do artigo aparece no final de cada artigo.
| Elemento | O que ele faz | |
|---|---|---|
| a | Feedback | Os leitores podem clicar em Sim ou Não para avaliar se o artigo foi útil e, opcionalmente, deixar um comentário. |
| b | Artigo Anterior e Próximo | Links de navegação para mover entre artigos na mesma categoria. |
| c | Artigos relacionados | Artigos relacionados ao atual. Por padrão, essa seção aparece no rodapé. Os administradores podem mover para o painel direito ativando a opção Mostrar artigos relacionados em Configurações () > Base de conhecimento > Configurações de artigos e SEO > Artigo direito. |
Outras páginas no site da Base de Conhecimento
Além das páginas principais de documentação, o site da Base de Conhecimento inclui algumas páginas adicionais que os leitores podem encontrar.
Página de glossário - Se seu projeto usar termos do glossário, os leitores podem acessar uma página dedicada que lista todos os termos definidos em ordem alfabética. Esta página está disponível em https://yourdomain/docs/glossary-overview. Os administradores podem adicionar um link ao glossário a partir do cabeçalho, rodapé ou navegação secundária. Para mais informações, veja a página do artigo no glossário.
Página do colaborador - Clicar no avatar do colaborador em qualquer artigo abre a página do contribuidor, que lista todos os artigos em que essa pessoa trabalhou dentro do projeto. Para mais informações sobre como gerenciar colaboradores, confira o artigo sobre colaboradores.
Página de Tags - Clicar em uma tag em um artigo abre uma página dedicada a Tags listando todos os artigos e páginas de categorias associadas a essa tag. Cada tag tem sua própria URL única, o que também ajuda na descoberta do SEO. Para mais informações, consulte as tags de artigos.