O Document360 usa uma hierarquia de cinco níveis para estruturar toda a sua documentação. Compreender essa estrutura ajuda você a planejar e manter uma base de conhecimento fácil de navegar
A hierarquia
Tudo no Document360 segue essa estrutura, desde o contêiner mais externo até o conteúdo individual:
Cada nível tem um propósito distinto. Juntos, eles te dão controle detalhado sobre como seu conteúdo é organizado, quem pode acessá-lo e em que idioma é apresentado.
Projetos
Um projeto é seu contêiner de nível superior. Ele guarda tudo – espaços de trabalho, conteúdo, usuários, configurações e configurações. Quando você faz login no Document360, o painel de projetos é a primeira coisa que você vê. Cada projeto é independente, com sua própria assinatura, configurações e membros da equipe.
Espaços de trabalho
Dentro de um projeto, você pode criar um ou mais espaços de trabalho. Pense em um espaço de trabalho como uma base de conhecimento separada e autônoma. Cada espaço de trabalho tem sua própria árvore de conteúdo, sua própria URL, e pode ser definido para diferentes níveis de visibilidade — público, beta ou obsoleto.
Espaços de trabalho são úteis quando você tem diferentes públicos ou linhas de produtos que precisam de documentação distinta. Quando você cria um novo projeto, um workspace padrão chamado v1 é criado automaticamente.
Idiomas
Cada espaço de trabalho suporta múltiplos idiomas, para que você possa entregar documentação localizada aos leitores no idioma preferido. Você define um idioma padrão por workspace e adiciona mais conforme seu público cresce.
Categorias
Categorias organizam seu conteúdo dentro de cada idioma. Elas funcionam como pastas, agrupando artigos relacionados e definindo a estrutura de navegação que seus leitores veem. O Document360 suporta quatro tipos de categoria: categorias de Pasta, Índice e Página. Você pode encaixar categorias em subcategorias para adicionar tanta profundidade quanto seu conteúdo precisar.
Artigos
Artigos são o conteúdo que seus leitores buscam. Eles vivem dentro de categorias e são os blocos fundamentais da sua base de conhecimento. Você pode criar um artigo do zero, a partir de um modelo ou usando o Eddy AI. Cada artigo segue um fluxo de trabalho do rascunho para a publicação.
Como isso se manifesta na prática
Aqui está um exemplo simples. Imagine uma empresa chamada Acme que desenvolve softwares de gerenciamento de projetos. Eles têm dois públicos – usuários comuns e desenvolvedores, que precisam de documentação completamente diferente.
Aqui está como a Acme estruturaria seu projeto Document360:
Ambos os espaços de trabalho ficam dentro do mesmo projeto, então a Acme os gerencia em um único lugar. Mesma assinatura, mesma equipe, mesmas configurações. Mas para o leitor, eles parecem dois sites completamente diferentes.
Espaço de trabalho ou categoria - qual delas você precisa?
Essa é a pergunta na qual a maioria dos novos usuários fica travada. Aqui está uma regra simples:
✅ Use um novo espaço de trabalho quando...
O público é completamente diferente e você nunca gostaria que os dois grupos pesquisassem o mesmo conteúdo. Um desenvolvedor e um atendente de suporte ao cliente não têm nada em comum para procurar, então, espaços de trabalho separados mantêm a experiência limpa para cada um.
✅ Use uma nova categoria quando...
É o mesmo público, só que um tema diferente. "Faturamento" e "Solução de Problemas" são tópicos diferentes, mas ambos são para o mesmo usuário. Portanto, eles pertencem como categorias dentro do mesmo espaço de trabalho, não como espaços separados.
Melhores práticas
Essas dicas vão manter sua base de conhecimento limpa à medida que cresce:
-
Comece com 3 a 5 categorias de nível superior. Você sempre pode reorganizar depois. O Document360 permite arrastar e soltar categorias e artigos a qualquer momento sem quebrar URLs existentes.
-
Nomeie as categorias com base no que seus leitores estão tentando alcançar, não na terminologia da sua equipe interna. "Comece" é melhor do que "Onboarding flow."
-
Mantenha uma ideia por artigo. Artigos focados são mais fáceis de encontrar pela busca e mais simples de manter atualizados.
-
Use espaços de trabalho separados para públicos realmente diferentes. Se seus usuários finais e seus desenvolvedores têm necessidades muito diferentes, espaços de trabalho separados mantêm a experiência limpa para cada grupo.
-
Evite ir além de dois níveis de subcategorias. Quanto mais profundo o aninhinho, mais difícil é para os leitores encontrarem seu caminho – e para você mantê-lo.