O portal da base de conhecimento é o centro de controle para criar, organizar e gerenciar todos os aspectos do seu projeto de documentação. Desde escrever artigos e estruturar categorias até configurar marcas, domínios e segurança, o portal oferece visibilidade e controle completos. Ele também conecta você a ferramentas avançadas, como árvores de decisão interativas, documentação de API, análise e gerenciamento de feedback, garantindo que sua base de conhecimento permaneça estruturada, acessível e eficaz.
Tudo o que você cria ou configura no portal molda diretamente o site da base de conhecimento, a versão com a qual seus usuários finais e leitores interagem.
No portal da base de conhecimento, você pode:
Criar Category, Articles e Templates
Gerenciar arquivos, contas de equipe e leitores
Configurar identidade visual, domínio, segurança e muito mais para o site da base de conhecimento
Aqui estão alguns elementos que você encontrará no portal da base de conhecimento:
Página Visão geral
Documentação
Árvores de decisão interativas
Documentação da API
Gerenciador de feedback
Analytics
Widgets
Dirigir
Configurações
Procurar
Site aberto
NOTA
Qualquer coisa criada e/ou configurada no Knowledge base portal afetará o que um usuário final ou leitor veria no Knowledge base site.
1. Overview page
A página Visão geral fornece uma exibição unificada do seu projeto do Document360. Ele exibe sua atividade de conteúdo, tarefas atribuídas, desempenho do artigo, comentários e métricas do projeto com base em sua seleção de função e espaço de trabalho, permitindo que você monitore e gerencie seu trabalho de documentação a partir de uma única página. Você pode passar o mouse sobre o ícone Página Inicial para acessar rapidamente as páginas Visão Geral, Tarefas, Recentes, Favoritos e Lixeira .
Na página Visão geral, você pode:
Acompanhe tarefas pendentes com base no status do fluxo de trabalho, lembretes de revisão, bem como comentários atribuídos a você no gerenciador de comentários.
Acesse e gerencie artigos atualizados recentemente, bem como artigos ou pastas marcados com estrela para referência rápida.
Monitore as métricas de desempenho do artigo , como visualizações, leituras, curtidas e não curtidas.
Responda a comentários embutidos ou @mentions em artigos para os quais você contribuiu.
Como administrador, visualize dados críticos do projeto, como contagens de usuários e leitores, uso de armazenamento, pesquisas com falha e o backup mais recente.
Cada seção é apresentada como um cartão separado e inclui ações de filtragem, pesquisa e acesso rápido. Isso fornece uma visão geral rápida de sua documentação e permite que você execute uma ação sem sair de casa.
NOTA
A visibilidade de determinados cartões e ações depende do portal e da função de conteúdo e dos recursos disponíveis como parte do plano de assinatura do Document360.
2. Documentação
A página Documentação é onde você criará e manterá a estrutura de pastas de exibição em árvore de categorias que manterão seus artigos organizados. Inicie uma base de dados de conhecimento criando um Category e preencha-os com Subcategory e Articles.
Arraste e solte categorias e artigos para reordenar, ocultar, renomear e excluí-los usando o menu Mais opções () que aparece quando você passa o mouse sobre qualquer item no .
a. All articles
A seção Todos os artigos permite que você execute operações em massa (publicar, ocultar, mover, excluir etc.) em vários artigos de uma só vez, economizando tempo em comparação com a execução dessas ações individualmente em cada artigo.
b. Recent
A página Recente ajuda você a retornar rapidamente aos artigos em que trabalhou recentemente. Ele rastreia automaticamente os artigos que você visualizou ou atualizou nos últimos 30 dias.
c. Starred
A seção Com estrela contém os artigos que você marcou como favoritos. Isso permite acesso rápido a artigos importantes.
d. Recycle bin
A seção Lixeira inclui uma lista de artigos e categorias excluídos nos últimos 30 dias. Você pode restaurar as categorias e artigos excluídos dentro desse período de tempo.
e. Site builder
Você pode personalizar a aparência do seu site de base de conhecimento na seção Construtor de sites .
Você pode escolher o logotipo e o ícone desejados para o seu site da base de conhecimento. Nesta seção, você também pode personalizar as cores, a fonte e o estilo da marca do site.
f. Content tools
As ferramentas de conteúdo, como o nome indica, contêm todas as ferramentas necessárias para gerenciar o conteúdo do seu artigo e projeto.
Você pode gerenciar os seguintes recursos neste menu.
Reutilização de conteúdo - Gerencie todas as variáveis, snippets, modelos e o glossário.
Importação e exportação - Gerencie todas as atividades de importação e exportação do projeto nesta seção. Nesta seção, você pode exportar seu conteúdo como PDF ou migrar conteúdo de outras ferramentas de gerenciamento de conhecimento.
Fundamentos de conteúdo - Gerencie a localização e substituição no nível do projeto, revise lembretes, tags e descrições de SEO no menu.
Gerenciador de comentários - Visualize e responda a artigos e nenhum feedback de pesquisa de um módulo unificado.
Designer de fluxo de trabalho - Crie seus status e sequência de fluxo de trabalho nesta seção.
g. Categories & Articles (Gerente de categoria)
Escrever e publicar artigos no Document360 é simples: escolha sua categoria, crie um artigo (título e slug), adicione SEO detalhes e publique em sua base de dados de conhecimento.
Quando você atualiza ou edit an article (Fork), o Document360 cria um novo Article revision sem afetar o espaço de trabalho ativo/público.
Você pode fazer as alterações necessárias e republicar quando estiver pronto. Você pode identificar os artigos atualizados no site da base de dados de conhecimento usando o Article status indicators. O Document360 mantém todos os espaços de trabalho para verificar as diferenças entre eles.
3. Interactive decision trees
As árvores de decisão interativas permitem que você oriente os leitores por meio de decisões passo a passo ou processos de solução de problemas usando lógica visual de ramificação. Cada etapa pode incluir texto, imagens, vídeos e entradas interativas para simplificar fluxos de trabalho complexos.
Você pode usar este módulo para criar orientações estruturadas para integração, solução de problemas, tutoriais ou processos internos. Depois de publicadas, as árvores de decisão aparecem como artigos interativos em seu site de base de conhecimento e funcionam perfeitamente em todos os tamanhos de tela.
Para acessar este módulo, clique em Árvore de decisão interativa no painel de navegação esquerdo do portal da base de conhecimento.
4. API documentation
O recurso de documentação da API no Document360 fornece uma solução completa para criar e gerenciar referências de API. Esse recurso permite que você crie documentação de API de alta qualidade que ajuda os usuários a entender e consumir suas APIs de forma eficaz.
Este módulo de API inclui o recurso Experimente! , que permite que os usuários testem os endpoints da API no site da base de conhecimento. Você pode criar versões dedicadas da documentação da API. O recurso fornece uma interface intuitiva para fazer upload de referências de API como URLs ou arquivos JSON/YAML. Depois de carregar a definição do OpenAPI, os artigos de endpoint de API interativos são criados no portal da base de dados de conhecimento. Agora, os usuários finais podem acessar a opção Experimente! com os endpoints, parâmetros e respostas disponíveis na documentação da API no site da base de conhecimento.
5. Feedback manager
O Gerenciador de Comentários ajuda você a rastrear e responder aos comentários do usuário coletados de artigos e consultas de pesquisa do Eddy AI.
Inclui:
Feedback do artigo: mostra curtidas, não curtidas e comentários de usuários em artigos ou categorias específicas. Use isso para melhorar a qualidade e a clareza de sua documentação.
Feedback do Eddy AI: captura feedback quando os usuários interagem com o Eddy AI, independentemente de terem achado os resultados úteis ou não terem recebido nenhum resultado. Use isso para identificar lacunas de conteúdo ou ajustar a relevância da pesquisa.
Você pode atribuir comentários aos membros da equipe, atualizar status, exibir discussões internas e exportar dados de comentários para análise. Para abrir o Gerenciador de comentários, selecione Gerenciador de comentários no painel de navegação esquerdo.
6. Analytics
O Document360 inclui um menu Analytics com ferramentas para ajudá-lo a entender o envolvimento do usuário final com sua base de dados de conhecimento.
Aqui está a lista de métricas e módulos que você pode acompanhar com a ferramenta Analytics:
Artigos
IA de redemoinho
Procurar
Contas de equipe
Realimentação
Status dos links
Página não encontrada
Defletor de bilhetes
7. Widget
O widget da base de conhecimento (anteriormente conhecido como assistente da base de conhecimento ou assistente no aplicativo) ajuda os leitores a encontrar suas respostas sem sair do site ou aplicativo.
Você pode atualizar as seguintes configurações do widget da base de conhecimento a partir deste menu.
Instalação e configuração
Custom CSS
JavaScript personalizado
Mapeamento de URL
8. Drive
Armazenamento centralizado e baseado em nuvem para projetos do Document360 que armazena e permite que os membros da equipe gerenciem todos os artefatos (arquivos) da base de dados de conhecimento. Se você já usou outros pesos pesados, como Google Drive ou OneDrive, acostumar-se com as funções do Document360 Drive deve ser relativamente fácil. Você pode acessar seu Drive clicando no ícone do Drive no menu à esquerda.
9. Settings
Você pode definir e configurar todos os aspectos do projeto e da base de dados de conhecimento nas configurações do Project , como convidar membros da equipe, editar configurações de notificação, configurar domínios, configurar redirecionamentos de artigos e muito mais.
Os diferentes recursos são mapeados sob as seguintes classificações no menu Configurações:
Portal da base de conhecimento
Site da base de conhecimento
Usuários e segurança
Recursos de IA
10. Search
Um espaço dedicado para pesquisar todo o conteúdo do projeto agora está disponível no portal da base de conhecimento. Realize uma pesquisa combinada em todos os espaços de trabalho e idiomas simultaneamente. A barra de pesquisa está disponível na parte superior de todos os módulos e páginas no portal da base de conhecimento.
O mecanismo de pesquisa funciona de forma semelhante às outras funcionalidades de pesquisa do portal. Digite a palavra-chave e restrinja os resultados usando filtros como espaço de trabalho, idioma, visibilidade, tags e intervalo de datas. Você pode visualizar a página do artigo/categoria e, em seguida, visualizar o artigo ou navegar até o artigo no Editor.
Como a pesquisa é realizada universalmente no projeto, ela abrange arquivos. Os usuários podem alternar entre o artigo e a pesquisa do Drive usando as guias abaixo da barra de pesquisa.
11. Site aberto
A ação Abrir site () é usada para navegar e exibir o site da base de conhecimento. Clicar no ícone levará você ao site da base de conhecimento do espaço de trabalho que está aberto no momento no portal da base de conhecimento. Se você estiver no espaço de trabalho de documentação da API, a ação Abrir site o levará para a home page da documentação da API. Se o site de documentação da API não tiver uma home page, você será direcionado para a página do primeiro artigo ou categoria na documentação da API.