Um projeto Document360 é um espaço de trabalho autônomo que contém todo o conteúdo da sua base de conhecimento — artigos, categorias, subcategorias, página inicial, usuários, leitores, grupos (para projetos privados e mistos) e configurações personalizadas. Criar um projeto é o primeiro passo para construir qualquer base de conhecimento no Document360, seja você documentando softwares, SOPs, APIs ou manuais do usuário.
Como criar um projeto no Document360
Acesse o painel
- Faça login no portal Document360 com sua conta para acessar o Painel.
Se você já está dentro de um projeto, clique no logo do Document360 na barra de navegação superior para voltar ao Painel. - Clique no botão + Projeto no canto superior direito.
Escolha seu caso de uso
- Selecione seu caso de uso principal e clique em Começar.
| Caso de uso | Descrição |
|---|---|
| Plataforma de base de conhecimento | Crie um hub centralizado onde todo o conhecimento e recursos da sua equipe sejam armazenados. Isso ajuda sua equipe a encontrar respostas rapidamente e aprimora o autoatendimento do cliente. |
| Documentação de software/técnica | Organize e mantenha de forma eficiente todo o seu software ou documentação técnica — recursos do produto, APIs, notas de lançamento e muito mais. |
| Documentação SOP | Crie SOPs detalhados que sua equipe possa seguir consistentemente, reduzindo erros e facilitando a integração dos funcionários. |
| Manual do usuário | Desenvolva manuais de usuário abrangentes que orientem clientes ou membros da equipe sobre as funcionalidades e o uso do seu produto. |
| Documentação da API | Documente informações detalhadas sobre endpoints da API, formatos de requisição e resposta, métodos de autenticação e exemplos. Selecionar isso redireciona você para o fluxo de configuração da API. |
| Outros | Escolha isso se seu caso de uso não se enquadrar nas categorias predefinidas. |
Selecione um modelo
- Selecione até dois modelos de conteúdo que correspondam ao tipo de documentação que você pretende criar. Esses modelos são incorporados ao seu projeto durante a criação para te dar uma vantagem.
- Com base na sua escolha, esses modelos serão incorporados ao seu projeto durante a criação. No entanto, sua seleção não impede que você use outros recursos ou crie diferentes tipos de conteúdo.
- Se você selecionou Documentação da API como seu caso de uso, essa etapa é pulada e você é redirecionado para a configuração da API.
Modelos de plataforma de base de conhecimento
Se você selecionou a plataforma de base de conhecimento no passo 3, pode escolher quaisquer dois modelos da lista abaixo.
| Modelo | Propósito |
|---|---|
| Guias para começar | Ajude novos usuários a entender rapidamente e começar a usar seu produto com instruções claras e passo a passo. |
| Guias práticos | Forneça instruções detalhadas para tarefas específicas, permitindo que os usuários utilizem plenamente os recursos do seu produto. |
| Perguntas frequentes | Responda a perguntas comuns em qualquer etapa da jornada do usuário, reduzindo consultas de suporte. |
| Política e procedimentos | Descreva protocolos organizacionais essenciais para ajudar os usuários a entender e seguir as diretrizes da empresa. |
Modelos de documentação de software/técnica
Se você selecionou Documentação de Software/Técnica no passo 3, pode escolher qualquer dois modelos da lista abaixo.
| Modelo | Propósito |
|---|---|
| Notas de lançamento | Mantenha os usuários informados sobre atualizações, novos recursos, correções de bugs e melhorias a cada lançamento de software. |
| Documentação de Design de Software (SDD) | Descreva a arquitetura e o design de software, incluindo diagramas e especificações para orientação de desenvolvimento. |
| Documentação de Requisitos de Software | Descreva o propósito, as funcionalidades e o ambiente do software para garantir que o desenvolvimento esteja alinhado com os objetivos do projeto. |
| Documentação de Requisitos de Produto (PRD) | Defina o propósito, valor e funcionalidades do produto para atender às necessidades dos usuários e aos objetivos do negócio. |
| Documentação do processo | Documente etapas detalhadas e procedimentos envolvidos no desenvolvimento de software para padronizar fluxos de trabalho. |
| Guia do usuário | Forneça instruções completas sobre como usar seu produto, cobrindo todos os recursos e funcionalidades. |
Modelos de documentação SOP
Se você selecionou a documentação SOP no passo 3, pode escolher modelos da lista abaixo.
| Modelo | Propósito |
|---|---|
| Políticas e procedimentos de conformidade | Garanta que sua organização atenda aos requisitos regulatórios documentando políticas que garantem a conformidade. |
| Operação SOP | Aumente a eficiência e a produtividade padronizando os procedimentos operacionais em toda a sua organização. |
Modelos do manual do usuário
Se você selecionou o manual do usuário no passo 3, pode escolher qualquer dois modelos da lista abaixo.
| Modelo | Propósito |
|---|---|
| Manual de instalação | Fornece todas as informações necessárias de configuração, incluindo visão geral do produto, especificações e instruções de montagem. |
| Manual de instruções | Oferece instruções passo a passo para montagem e uso com diagramas e avisos de segurança. |
| Manual de manutenção | Fornece instruções detalhadas para manutenção regular, solução de problemas e procedimentos de reparo. |
| Manual de treinamento | Fornece orientações abrangentes sobre instalação, operação, solução de problemas e treinamento do usuário. |
| Manual de operações | Fornece instruções detalhadas para manutenção diária e solução de problemas para gerenciamento eficaz da plataforma. |
Personalize sua base de conhecimento
- Insira a URL do site da sua empresa. O Document360 analisa seu site e utiliza IA para gerar conteúdo relevante, elementos de branding e uma estrutura estruturada de documentação.
Se quiser pular essa etapa, o domínio será o padrão vinculado ao seu e-mail de registro.
Estabeleça diretrizes de marca
- Revise o nome do projeto preenchido automaticamente, o idioma padrão, o logo da marca e as cores da marca extraídas da URL do seu site. Edite quaisquer campos conforme necessário.
As configurações de idioma do seu navegador determinam o idioma padrão. O inglês é selecionado por padrão se o idioma do seu navegador não for suportado. - Visualize o site da sua base de conhecimento no painel direito.
- Se você escolher espanhol ou português brasileiro como idioma padrão, o idioma do portal é definido para espanhol ou português brasileiro. Caso contrário, o inglês é o idioma padrão do portal.
- O logo da marca e as cores primárias/secundárias são extraídos do seu site. Se você optar por pular essa etapa, o nome do projeto é derivado do seu e-mail de registro e o logo e as cores padrão do Document360 são aplicadas.
Definir privacidade documental
- Escolha a configuração de privacidade do seu site de base de conhecimento:
| Modo privacidade | O que isso significa |
|---|---|
| Privado | Restringa o acesso para que apenas usuários registrados possam visualizar e interagir com o conteúdo, mantendo-o seguro e interno. |
| Público | Torne a base de conhecimento acessível a todos, inclusive usuários externos, sem necessidade de login. |
| Misto | Combine acesso privado e público — algumas seções são visíveis ao público enquanto outras são restritas apenas a usuários registrados. |
- Clique em Próximo para prosseguir.
- Você pode atualizar as configurações de privacidade a qualquer momento após a criação do projeto a partir de Configurações > Usuários e permissões > acesso ao Leitor. Para mais informações, veja Acesso ao Site.
- Além da privacidade em nível de site, o Document360 também permite que você controle o acesso no nível do usuário. Você pode atribuir funções e permissões aos membros da equipe, restringindo ou concedendo acesso a recursos e conteúdos específicos com base nas responsabilidades deles. Para mais informações, veja Papéis e permissões.
Acesse o portal da base de conhecimento
Uma vez concluída a configuração, você é levado ao portal da base de conhecimento Document360.
- Para plataforma de base de conhecimento, documentação de software, documentação SOP ou casos de uso do manual do usuário: O Document360 gera automaticamente artigos e categorias relevantes com base no caso de uso selecionado e no conteúdo do site. Cada categoria inclui pelo menos 2–3 artigos gerados por IA, e subcategorias são criadas quando necessário. Se o idioma selecionado for suportado pelo Eddy AI, a documentação é gerada nesse idioma; caso contrário, o padrão é em inglês. Se nenhum conteúdo relevante for encontrado na URL fornecida, artigos pré-carregados baseados no seu caso de uso e modelos são mostrados.
- Os artigos gerados pela Eddy AI são publicados primeiro e depois automaticamente configurados para o modo rascunho. Você pode revisá-los e atualizá-los conforme necessário.
- Uma vez que seu projeto seja criado, você pode personalizar sua aparência e estrutura a partir das Configurações — incluindo a página inicial, temas, branding e hierarquia de categorias.
- Para o caso de uso da documentação da API: Você é redirecionado para o espaço de trabalho de documentação da API. Você verá a referência da API para a especificação que você forneceu durante o onboarding. Se nenhuma especificação foi fornecida, uma referência de exemplo da API da Pet Store está disponível.
Alternando entre projetos
Quando você tem vários projetos, pode alternar entre eles dentro do portal da base de conhecimento de duas maneiras.
- Usando o menu suspenso Projetos
- Do painel de Projetos
Alternando projetos usando o menu de seleção de projetos
- De qualquer módulo no portal da base de conhecimento, clique no menu de seleção de projetos na barra de navegação superior.
- Cada entrada de projeto mostra o Nome do Projeto, o tipo de acesso do Leitor — Público , Privado ou Misto — e um rótulo Sandbox se for um projeto Sandbox.
- Clique no projeto que você quer abrir.
Trocando de projeto usando o painel de projetos
- Clique no logo do Document360 na barra de navegação superior.
Alternativamente, clique no menu suspenso de seleção de projetos na barra de navegação superior e selecione Gerenciar projetos no rodapé inferior do menu suspenso.
Você é redirecionado para a página Seus projetos , onde todos os projetos que você possui ou com os quais está associado estão listados.
- Clique no bloco do projeto para onde você quer navegar.
Você pode identificar em qual projeto está trabalhando atualmente verificando o nome do projeto exibido na barra de navegação superior do portal da base de conhecimento.
Detalhes do projeto
| Item | Detalhes |
|---|---|
| Período de teste do projeto | Cada novo projeto inclui um período experimental gratuito de 14 dias. Uma assinatura separada é necessária após o término do teste. |
| Suporte à linguagem de onboarding | O fluxo de integração suporta inglês, espanhol, português brasileiro, alemão e sueco. O próprio portal suporta apenas inglês, espanhol e português brasileiro. |
Melhores práticas
- Diga claramente seu projeto antes de criá-lo. O nome do projeto influencia a URL padrão e a marca. Mudar após a configuração exige etapas adicionais de configuração.
- Use um projeto sandbox para testes. Antes de mudar de temas, fluxos de trabalho ou integrações em um projeto ao vivo, teste suas mudanças em um sandbox para evitar atrapalhar seus leitores. Veja Criando um projeto sandbox.
- Mantenha um projeto por base de conhecimento distinta. Evite misturar documentação não relacionada em um único projeto. Projetos separados garantem controle de acesso independente, branding e análises.
FAQ
O Document360 suporta diferentes idiomas no processo de integração?
Sim, o fluxo de integração suporta inglês, espanhol, português brasileiro, alemão e sueco. No entanto, o próprio portal Document360 atualmente suporta apenas inglês, espanhol e português brasileiro.
O que é um projeto "Sandbox" e como ele difere de um projeto comum?
Um projeto Sandbox é um ambiente de teste isolado onde você pode experimentar configurações, designs e fluxos de trabalho sem afetar sua base de conhecimento ao vivo. Ele aparece com um rótulo Sandbox no menu suspenso do projeto. Para mais informações, veja Criação de um projeto sandbox.
Como o Document360 lida com o controle de versões dos artigos?
O Document360 mantém um histórico abrangente de versões dos artigos chamado Revisões dos Artigos. Cada alteração em um artigo é automaticamente salva e rastreada, permitindo que você volte a qualquer versão anterior, se necessário.
Como posso solicitar acesso a um projeto com o qual não estou associado?
Entre em contato com o administrador da sua equipe ou com o dono do projeto e peça para adicioná-lo. Eles podem atribuir a você um papel apropriado no portal e acesso ao conteúdo a partir de Configurações > Usuários e permissões.