Categorias são a principal forma de organizar o conteúdo na sua base de conhecimento. Antes de começar a adicionar artigos, estabelecer uma estrutura clara por categorias ajuda os leitores a navegar pela sua documentação e ajuda sua equipe a gerenciar o conteúdo em escala.
Quando você precisa de uma nova categoria?
Crie uma nova categoria quando precisar:
- Agrupe artigos relacionados sob um tema comum, por exemplo, uma categoria "Como Começar" para conteúdo de integração.
- Separe o conteúdo por público: Crie categorias distintas para usuários finais, administradores e desenvolvedores.
- Reflita a estrutura do seu produto: Alinhe categorias com áreas de produto, recursos ou módulos para que os leitores encontrem o conteúdo onde esperam.
- Adicione uma subcategoria a uma categoria existente quando um tema cresce o suficiente para precisar de mais divisão.
Você pode criar até 1.000 categorias por espaço de trabalho. Nomes de categorias têm no máximo 300 caracteres , incluindo espaços.
Crie uma categoria
A forma mais comum de criar uma categoria é usando o botão Criar na barra de navegação superior.
- Navegue até Documentação () na barra de navegação da esquerda.
- Clique no menu suspenso Criar e selecione Categoria.
- No painel Criar nova categoria , preencha o seguinte:
| Campo | O que fazer |
|---|---|
| Nome | Insira um nome para a categoria (máximo 300 caracteres) |
| Localização | Escolha onde a categoria está, no nível raiz ou dentro de uma categoria existente. Clique em Reset para posicioná-lo na raiz |
| Tipo | Selecione um tipo de categoria: Pasta, Índice, Página ou GitHub |
- Clique em Criar. A nova categoria é adicionada imediatamente.
Para saber mais sobre tipos de categoria, leia Tipos de categoria.
Você também pode criar uma categoria usando o ícone do Volante de Inércia passando o mouse logo abaixo de qualquer categoria no painel Categorias & Artigos , no ícone Mais () ao lado de uma categoria existente, no menu suspenso Criar dentro de uma categoria do tipo Pasta ou Índice , ou diretamente no painel Criar novo artigo clicando em Criar categoria no menu suspenso Categoria.
Todos os pontos de entrada abrem o mesmo painel Criar nova categoria com os mesmos campos Nome, Localização e Tipo.
Níveis de subcategoria
Você pode aninhar categorias de até sete níveis de profundidade, uma categoria raiz mais seis níveis de subcategoria.
A opção de Nova categoria fica inativa assim que você atinge o sétimo nível.
Use até três níveis de subcategoria para navegação ideal. Dois níveis é ideal para a maioria das bases de conhecimento. Hierarquias mais profundas dificultam que os leitores encontrem conteúdo sem usar busca.
Mude o ícone da categoria
Quando você cria uma categoria, um ícone de pasta padrão é atribuído. Você pode mudar para um emoji para facilitar a identificação da categoria num instante.
- Navegue até Documentação () na barra de navegação da esquerda.
- No painel Categorias & Artigos , clique no ícone da pasta ou no emoji existente ao lado da categoria desejada.
- Um painel de emojis aparece. Procure um emoji usando a barra de busca, navegue por categoria ou filtre por tom de cor.
- Selecione o emoji desejado para aplicá-lo.
- Para voltar ao ícone padrão da pasta, clique no 🚫 ícone no painel de emojis.
- Os estilos dos emojis podem variar dependendo do navegador.
- Ícones de categoria só podem ser alterados para categorias de tipos de Pasta e Índice . Categorias de tipos de página não suportam ícones personalizados.
Melhores práticas
- Nomeie categorias do ponto de vista do leitor: Use uma linguagem que seus leitores usariam ao buscar conteúdo, não terminologia interna da equipe.
- Seja consistente na formatação: Decida o caso do título ou da frase e aplique-o uniformemente em todas as categorias.
- Comece de forma ampla, depois estreita: as categorias raiz devem abranger tópicos amplos; Subcategorias devem dividi-las em áreas específicas e focadas.
- Evite categorias de artigo único: Se uma categoria contém apenas um artigo, considere se ela pertence a uma categoria mais ampla.
- Use ícones de emoji intencionalmente: Emojis ajudam os leitores a identificar categorias rapidamente num instante. Escolha aqueles que representem claramente o tema.
FAQ
Que tipos de categorias posso criar?
Você pode criar quatro tipos: Pasta, Índice, Página e GitHub. Cada tipo tem comportamentos e casos de uso diferentes. Veja Tipos de categoria para mais detalhes.
Posso mudar o tipo de categoria depois de criá-lo?
Sim. Você pode mudar o tipo de categoria a qualquer momento após sua criação. Veja Tipos de categorias para detalhes.
Posso criar subcategorias sob uma categoria principal?
Sim. Você pode criar até sete níveis de categorias, uma categoria raiz e seis níveis de subcategoria. A opção Nova categoria fica inativa além do sétimo nível.
Posso mudar o ícone da categoria para um emoji?
Sim, mas apenas para categorias do tipo Pasta e Índice . Categorias de tipos de página não suportam ícones personalizados. Para voltar ao ícone padrão da pasta, clique no 🚫 ícone no painel de emojis.
Por que minha nova categoria não está visível no site da base de conhecimento?
Uma categoria não aparecerá no site da Knowledge base se não tiver artigos publicados, se estiver oculta ou se todos os artigos dentro dela forem ocultos ou não publicados. Publique pelo menos um artigo dentro da categoria para torná-lo visível.