Tipos de categorias

No Document360, cada categoria tem um tipo que determina como ela aparece e se comporta tanto no portal da base de conhecimento quanto no site da base de conhecimento. Selecionar o tipo certo ajuda a construir uma estrutura clara e navegável para seus leitores. Existem quatro tipos de categoria: Pasta, Índice, Página e GitHub.

Tipos de categorias em resumo

Pasta

O tipo de Pasta é o padrão e o tipo de categoria mais comumente usado. Ele atua como um contêiner puro, agrupando artigos e subcategorias sob um tema comum sem gerar sua própria URL ou página de conteúdo no site da base de conhecimento.

Use a Pasta quando:

• Você precisa de um agrupamento de nível superior para uma área temática ampla.
• A categoria não precisa de um link compartilhável.
• Você quer que os leitores naveguem por subcategorias ou artigos, em vez de parar em uma página de categoria.

Características principais:

• Nenhuma URL é gerada para esse tipo de categoria.
• Suporta operações em massa: Ocultar (), Desocultar (), Excluir (), Mover () e Estrelar () para artigos dentro da categoria.
• O ícone da categoria pode ser personalizado com um emoji.

Índice

O tipo Índice gera sua própria URL e exibe uma visão estruturada de todos os artigos dentro da categoria. Quando os leitores clicam em uma categoria de Índice no site da base de conhecimento, eles veem uma lista de artigos, incluindo título, colaboradores, data de última atualização, status e tags, antes de abrir uma específica.

Use o Índice quando:

• Você quer que os leitores tenham uma visão geral do conteúdo de uma categoria antes de entrar nela.
• A categoria precisa de uma URL compartilhável e vinculável.
• Você precisa de um ponto de entrada estruturado para uma grande parte da sua base de conhecimento.

Características principais:

• Um slug único é gerado. Você pode compartilhar links de categorias de índice e aplicar regras de redirecionamento a eles.
• Suporta as mesmas operações em massa que a Pasta: Esconder, Mostrar, Deletar, Mover e Estrelar.
• Suporta configurações de SEO (meta título, slug, descrição) via o ícone More () > SEO.

Vista do portal:

Visualização do site da base de conhecimento:

Quando os leitores clicam em uma categoria do Índice, eles veem o título da categoria e o número de artigos e subcategorias que ela contém.

Page

O tipo de página se comporta como um artigo comum. Você pode escrever, formatar e publicar conteúdo nele usando o editor Markdown, WYSIWYG ou Advanced WYSIWYG. Ainda pode conter subcategorias e artigos abaixo, tornando-o adequado para páginas de destino de seção que também funcionam como pais de navegação.

Use a página quando:

• Você quer uma categoria que tenha seu próprio conteúdo escrito, como uma visão geral de seção ou uma introdução.
• Você precisa de funcionalidade completa do artigo (configurações de SEO, slug, status, histórico de revisões) no nível da categoria.
• A categoria precisa tanto conter conteúdo quanto atuar como pai para subcategorias.

Características principais:

• Comporta-se exatamente como um artigo comum. Você pode mudar o título, slug e realizar todas as mesmas ações em nível de artigo.
• Suporta configurações de SEO via o ícone More () > SEO.
• Diferente de um artigo comum, uma categoria de Página pode conter subcategorias e artigos adicionais abaixo dela.

Vista do portal:

Visualização do site da base de conhecimento:

GitHub

O tipo GitHub sincroniza o conteúdo documental diretamente de um repositório conectado do GitHub para sua base de conhecimento. Cada branch no repositório aparece como um artigo dentro da categoria, identificado por um ícone de branch. Sempre que um commit é enviado para o repositório conectado, o Document360 automaticamente puxa os arquivos Markdown atualizados e os publica.

Use o GitHub quando:

• Sua documentação fica junto com seu código em um repositório do GitHub e é mantida no GitHub.
• Você quer documentos controlados por versão que permaneçam sincronizados com as liberações de código automaticamente.
• Sua equipe prefere escrever o Markdown em um editor local do que no editor do Document360.

Características principais:

• O conteúdo sincronizado do GitHub é somente leitura no Document360. Todas as edições devem ser feitas no repositório fonte do GitHub.
• Apenas o ramo principal é suportado para sincronização.
• Cada branch no repositório conectado aparece como um artigo com um ícone de branch no portal.
• Usuários não podem editar ou publicar artigos em uma categoria do GitHub. Todas as alterações devem ter origem no repositório do GitHub.
• O ícone do GitHub é exibido apenas para categorias públicas .
• Novos artigos não podem ser criados dentro do Document360 para categorias sincronizadas no GitHub.

Comparando tipos de categorias

Altere o tipo de categoria

Você pode mudar o tipo de categoria a qualquer momento sem perder conteúdo.

1. Navegue até Documentação () na barra de navegação da esquerda.
2. Passe o mouse sobre a categoria no painel de Categorias & Artigos .
3. Clique no ícone Mais () e selecione Alterar tipo.
4. Selecione o novo tipo de categoria e clique em Atualizar.

Melhores práticas

• Use a Pasta para categorias de nível superior que existem puramente para navegação. É o tipo mais simples e não gera URLs desnecessárias.
• Use o Índice para grandes seções onde os leitores se beneficiam ao ver uma visão geral do artigo antes de navegar, por exemplo, por uma referência de API ou um longo guia de solução de problemas.
• Use páginas de destino de seção que precisam de conteúdo introdutório junto com artigos filhos, por exemplo, uma página "Como começar" que explica a seção e links para artigos filhos.
• Use o GitHub apenas quando sua documentação estiver mantida ativamente em um repositório e precisar de sincronização automática, não para importações pontuais.
• Evite mudanças frequentes de tipo em categorias de alto tráfego. Converter para Página deixa a categoria em estado de rascunho, o que pode causar links quebrados até ser publicada.

FAQ