Planos que suportam este recurso: Professional Business Enterprise
Um projeto no Document360 serve como um contêiner abrangente para todas as suas necessidades de documentação. Ele encapsula seus artigos, categorias, subcategorias, página inicial, contas de equipe, leitores e grupos (para projetos privados e mistos), além de configurações ou configurações personalizadas. Essa abordagem centralizada garante que sua base de conhecimento seja organizada, facilmente acessível e escalável.
Como criar um projeto de base de conhecimento no Document360?
Os projetos do Document360 são projetados para agilizar seu processo de documentação, oferecendo uma forma estruturada e eficiente de gerenciar suas informações. Seja criando manuais do usuário, documentos internos de processo ou documentação, um projeto Document360 fornece a estrutura para armazenar, gerenciar e distribuir conteúdo de forma eficaz. Siga estes passos para criar seu projeto de base de conhecimento.
Acessando o painel
Faça login no portal Document360 com sua conta para acessar o Painel
Se você estiver logado e no portal da base de conhecimento de outro projeto, clique no ícone Document360 na barra de navegação superior para ser redirecionado ao PainelClique no botão +Projeto no canto superior direito para criar um novo projeto.
Escolha seu caso de uso
Selecione seu caso de uso principal para o Document360 clicando em Começar.
Caso de uso | Descrição |
|---|---|
Plataforma de base de conhecimento | Você pode criar um hub centralizado onde todo o conhecimento e recursos da sua equipe são armazenados. Isso ajuda sua equipe a encontrar respostas rapidamente e aprimora o autoatendimento ao cliente, proporcionando acesso fácil às informações de que precisam. |
Documentação de software/Documentação técnica | Você pode organizar e manter todo o seu software ou documentação técnica de forma eficiente. Ele ajuda sua equipe a documentar recursos do produto, APIs, notas de lançamento e mais, garantindo que desenvolvedores e usuários tenham informações claras e atualizadas. |
Documentação SOP | Você pode criar SOPs detalhados que sua equipe pode seguir consistentemente. Garante que todos sigam os mesmos processos, reduz erros e facilita a integração de novos colaboradores, fornecendo diretrizes procedimentais claras. |
Manual do usuário | Você pode desenvolver manuais de usuário completos que orientem seus clientes ou membros da equipe sobre as funcionalidades e o uso do seu produto. Ele ajuda a reduzir dúvidas de suporte ao oferecer instruções passo a passo e dicas de solução de problemas. |
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. Isso garante que os desenvolvedores tenham uma compreensão clara de como integrar suas APIs. Selecionar essa opção vai redirecionar você para o fluxo de configuração da API. |
Outros | Escolha essa opção se seu caso de uso não se enquadrar nas categorias predefinidas. Você pode personalizar sua base de conhecimento com base nas necessidades organizacionais ou do projeto. |
Selecione um Modelo
Selecione o tipo de conteúdo que você vai criar no seu projeto Document360. Você pode escolher até dois modelos que atendam às suas necessidades.
NOTA
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, pulará essa etapa e será 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. Isso garante uma experiência de integração tranquila. |
Guias práticos | Forneça instruções detalhadas para tarefas específicas, permitindo que os usuários utilizem e explorem totalmente os recursos do seu produto de forma eficiente. |
Perguntas frequentes | Responda a perguntas comuns em qualquer etapa da jornada do usuário, ajudando os usuários a encontrar respostas rápidas e reduzindo dúvidas de suporte. |
Política e procedimentos | Descreva protocolos organizacionais essenciais, ajudando os usuários a entender e seguir as diretrizes da empresa de forma eficaz. |
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 | Passos e procedimentos detalhados envolvidos no desenvolvimento de software para padronizar fluxos de trabalho e aumentar a eficiência. |
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, garantindo um início tranquilo com a plataforma da base de conhecimento. |
Manual de instruções | Oferece instruções passo a passo de montagem e uso com diagramas e avisos de segurança, ideal para configuração precisa e avisos de segurança para uso adequado. |
Manual de manutenção | Forneça instruções detalhadas para manutenção regular, solução de problemas e procedimentos de reparo para garantir o desempenho ideal. |
Manual de treinamento | Fornece orientações abrangentes sobre instalação, operação e solução de problemas, além de suporte para treinamento de usuários e uso eficaz da plataforma. |
Manual de operações | Forneça instruções detalhadas para manutenção diária e solução de problemas, garantindo uma gestão contínua e eficaz da plataforma da Base de Conhecimento. |
Personalize sua base de conhecimento
Insira a URL da sua empresa. O Document360 analisará seu site e usará IA para gerar conteúdo relevante, elementos de branding e documentação estruturada.
Se você quiser pular essa etapa, o domínio será o padrão vinculado ao seu e-mail de registro.
Diretrizes de marca
O nome do seu projeto, idioma padrão, logotipo da marca e cores da marca serão definidos automaticamente com base na URL que você forneceu. No entanto, você pode editar os campos se necessário.
As configurações de idioma do seu navegador determinam o idioma padrão. O inglês será selecionado por padrão se outros idiomas não suportarem o idioma do seu navegador.
NOTA
Se você escolher espanhol ou português brasileiro como seu idioma padrão; o idioma do portal será definido para espanhol ou português brasileiro. Caso contrário, o inglês será o idioma padrão.
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 será derivado do seu e-mail de registro, e o logo padrão e as cores do Document360 serão aplicados.
Você pode pré-visualizar o site da sua base de conhecimento no lado direito da tela.
Definir privacidade documental
Escolha as configurações de privacidade desejadas para o seu site:
Privado: Restringa o acesso à base de conhecimento para que apenas as contas da equipe possam visualizar e interagir com o conteúdo, mantendo-o seguro e interno.
Público: Tornar a base de conhecimento acessível a todos, incluindo usuários externos, permitindo acesso aberto a todo o conteúdo.
Misto: Combine acesso privado e público permitindo que algumas seções da base de conhecimento sejam visíveis ao público, mantendo outras seções restritas apenas às contas da equipe.
Clique em Próximo para prosseguir.
Acesse o portal da base de conhecimento Document360
Depois de concluir a configuração, acesse o portal da base de conhecimento Document360.
Para usuários que selecionaram Plataforma de Base de Conhecimento, Documentação de Software/Documentação Técnica, Documentação SOP ou Manual do Usuário como caso de uso: o Document360 gerará automaticamente artigos e categorias relevantes com base nos casos de uso selecionados e no conteúdo do seu site. Cada categoria terá pelo menos 2-3 artigos gerados por IA, e subcategorias serão criadas se necessário. Se o idioma selecionado for suportado pela Eddy AI, sua documentação será gerada nesse idioma. Se não, o padrão será o inglês. Se nenhum conteúdo relevante for encontrado na URL fornecida, você verá artigos pré-carregados baseados no caso de uso e nos modelos selecionados, dando uma vantagem inicial na criação do seu conteúdo.
NOTA
Os artigos gerados pela Eddy AI serão publicados e então colocados no modo rascunho. Você pode atualizar os artigos conforme necessário.
Para usuários que selecionaram o caso de uso de documentação da API: Você será redirecionado para o espaço de trabalho de documentação da API, onde:
Você verá a referência da API da especificação que você forneceu durante a integração.
Se você não forneceu uma especificação de API, uma referência de API de exemplo (Pet Store API) estará disponível.
Alternando entre projetos do Document360
Depois de criar seus projetos no Document360, pode ser necessário trabalhar em vários projetos ou alternar entre eles para diferentes tarefas. O Document360 oferece um seletor de projetos intuitivo para ajudar você a gerenciar isso de forma fluida.
Existem duas maneiras de transferir projetos do portal da base de conhecimento:
Usando o menu suspenso Projetos
Do painel de Projetos
Trocando projetos usando o menu suspenso Projetos
De qualquer módulo no portal da Base de Conhecimento, clique no menu suspenso do projeto na barra de navegação superior.
Você pode visualizar o "Nome do Projeto", "Acesso ao Site" (Público - , Privado - , ou Misto ), e um rótulo "Sandbox" se for um projeto Sandbox.
Clique no projeto que você quer visualizar na lista.
Trocando projetos a partir do painel de Projetos
Clique no logo do Document360 na barra de navegação superior.
Você será redirecionado para a Seus projetos .
A lista de todos os projetos pertencentes ou associados à sua conta será exibida.
Clique no projeto que você quer acessar.
Perguntas Freqüentes
O Document360 suporta diferentes idiomas no processo de integração?
Sim, o Document360 oferece suporte multilíngue no processo de integração, incluindo idiomas como inglês, espanhol, português brasileiro, alemão e sueco. No entanto, dentro do portal Document360, o suporte a idiomas atualmente é limitado ao inglês, espanhol e português brasileiro.
Posso personalizar a aparência e a estrutura do meu projeto no Document360?
Sim, os projetos do Document360 oferecem amplas opções de personalização. Você pode personalizar a aparência e a sensação da sua base de conhecimento projetando sua página inicial, temas, adicionando a marca da sua organização, orientado para editores e organizando os artigos em uma estrutura hierárquica (categorias) que atenda às suas necessidades de documentação.
É possível controlar acesso e permissões dentro de projetos do Document360?
Com certeza. O Document360 oferece controle de acesso robusto e configurações de permissões. Você pode atribuir funções e permissões às contas das equipes, restringindo ou concedendo acesso a recursos e conteúdos específicos com base nas responsabilidades e requisitos deles.
Como o Document360 ajuda com controle de versões e histórico de documentação?
Os projetos Document360 mantêm um sistema abrangente de controle de versões de artigos chamado "Revisões de Artigos". Ele salva e acompanha automaticamente as alterações feitas nos artigos, permitindo que você volte a versões anteriores se necessário. Isso garante a integridade da sua documentação e simplifica a colaboração nas atualizações de conteúdo.
Como eu sei em qual projeto estou trabalhando atualmente?
Você pode conferir o nome do projeto exibido na barra de navegação superior do portal da Base de Conhecimento.
O que acontece se eu não ver o projeto para o qual quero mudar?
Certifique-se de ter as permissões de acesso necessárias para esse projeto. Se o projeto ainda não aparecer, entre em contato com o administrador do Document360 para obter assistência.
O que é um projeto "Sandbox" e como ele difere de outros projetos?
Um projeto Sandbox é um ambiente de teste onde você pode experimentar sem afetar seus projetos ao vivo. Ele terá uma etiqueta "Sandbox" no menu suspenso do projeto.
O que significa "Acesso ao Site" no menu suspenso do projeto?
"Acesso ao Local" indica se o projeto é Público, Privado ou Misto. Isso define o nível de acessibilidade do conteúdo do projeto.
Como posso solicitar acesso a um projeto com o qual atualmente não estou associado?
Entre em contato com o administrador da equipe ou o dono do projeto para solicitar acesso ao projeto desejado.
O que acontece se a Eddy AI não conseguir gerar conteúdo do meu site para os artigos padrão?
Se a Eddy AI não conseguir extrair conteúdo suficiente do seu site, o sistema usará modelos padrão baseados no caso de uso selecionado.
Quantos projetos posso criar no Document360?
Você pode criar quantos projetos quiser no Document360. Cada novo projeto vem com um teste gratuito de 14 dias, após o qual você precisará adquirir um plano de assinatura separado para esse projeto.
Por que não posso mudar a visibilidade do site para meu projeto de teste?
Por padrão, todos os projetos de teste no Document360 são configurados como Privado para proteger seu conteúdo durante a avaliação e evitar exposições não intencionais. Você vai notar que as opções de visibilidade Mista e Pública estão desativadas (desaparecidas) tanto na tela de onboarding quanto na página de configurações de acesso ao Site .
Se você quiser mudar a visibilidade do seu projeto experimental:
Clique no link de Contato com Vendas mostrado no banner de informações.
Isso acionará uma solicitação automática por e-mail para nossa equipe de vendas com os detalhes do seu projeto.
Assim que sua solicitação for validada, a equipe de vendas enviará um e-mail de confirmação.
Você pode então mudar a visibilidade do seu projeto para Mista ou Pública na página de configurações de acesso ao Site .
NOTA
Essa restrição garante que seu projeto permaneça seguro até que você esteja pronto para torná-lo acessível ao público.