Planos de apoio à criação de novos projetos
| Profissional | Negócio | Empresa |
|---|---|---|
Um projeto no Document360 serve como um contêiner abrangente para todas as suas necessidades de documentação. Ele encapsula seus artigos, categorias e subcategorias, a página inicial, contas de equipe, leitores e grupos (para projetos privados e mistos) e 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 dados de conhecimento no Document360?
Os projetos no Document360 são projetados para simplificar seu processo de documentação, oferecendo uma maneira estruturada e eficiente de gerenciar suas informações. Esteja você criando manuais do usuário, documentos de processo interno ou documentação API , um projeto do Document360 fornece a estrutura para armazenar, gerenciar e distribuir conteúdo com eficiência. Siga estas etapas para criar seu projeto de base de conhecimento.
Acessando o painel
Faça logon no portal do Document360 com sua conta para acessar o Painel.
Se você estiver conectado e estiver no portal da base de conhecimento de um projeto diferente, clique no ícone Document360 no canto superior esquerdo para ser redirecionado para o arquivo Painel.Clique no botão +Projetono canto superior direito para criar um novo projeto.
Escolha seu caso de uso
Selecione seu caso de uso principal para o Document360 clicando em Introdução.
Caso de uso | Descrição |
Plataforma de base de conhecimento | Você pode criar um hub centralizado onde todo o conhecimento e recursos de sua equipe são armazenados. Ele ajuda sua equipe a encontrar respostas rapidamente e aprimora o autoatendimento do cliente, fornecendo acesso fácil às informações de que precisam. |
Documentação de software/documentação técnica | Você pode organizar e manter com eficiência todo o seu software ou documentação técnica. Ele ajuda sua equipe a documentar recursos de produtos, APIs, notas de versão e muito mais, garantindo que desenvolvedores e usuários tenham informações claras e atualizadas. |
Documentação do SOP | Você pode criar SOPs detalhados que sua equipe pode seguir de forma consistente. Ele garante que todos sigam os mesmos processos, reduz erros e ajuda na integração de novos funcionários, fornecendo-lhes diretrizes processuais claras. |
Manual do usuário | Você pode desenvolver manuais de usuário abrangentes que orientam seus clientes ou membros da equipe sobre os recursos e o uso do seu produto. Ele ajuda a reduzir as consultas de suporte, oferecendo instruções passo a passo e dicas de solução de problemas. |
Documentação da API | Documente informações detalhadas sobre endpoints de API, formatos de solicitação e resposta, métodos de autenticação e exemplos. Isso garante que os desenvolvedores tenham uma compreensão clara de como se integrar às suas APIs. Selecionar essa opção redirecionará você para o fluxo de configuração da API. |
Outros | Escolha essa opção se o seu caso de uso não se enquadrar nas categorias predefinidas. Você pode personalizar sua base de dados de conhecimento com base em necessidades organizacionais ou de projeto específicas. |
Selecione um modelo
Selecione o tipo de conteúdo que você criará em seu projeto do Document360. Você pode escolher até dois modelos que atendam às suas necessidades.
NOTA
Com base na sua seleção, esses modelos serão incorporados ao seu projeto durante a criação. No entanto, sua seleção não o limita de usar outros recursos ou criar diferentes tipos de conteúdo.
Se você selecionou a Documentação da API como seu caso de uso, pulará esta etapa e será redirecionado para a configuração da API .
Modelos de plataforma da base de conhecimento
Se você selecionou a plataforma da base de conhecimento na etapa 3, poderá escolher dois modelos na lista abaixo.
Modelo | Propósito |
Guias de introdução | Ajude os 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 de instruções | Forneça instruções detalhadas para tarefas específicas, permitindo que os usuários utilizem e explorem totalmente os recursos do seu produto com eficiência. |
Perguntas frequentes | Responda a perguntas comuns em qualquer estágio da jornada do usuário, ajudando-os a encontrar respostas rápidas e reduzindo as consultas de suporte. |
Política e procedimentos | Descreva os protocolos organizacionais essenciais, ajudando os usuários a entender e aderir às diretrizes da empresa de forma eficaz. |
Modelos de documentação técnica/de software
Se você selecionou Software/Documentação técnica na etapa 3, poderá escolher quaisquer dois modelos na lista abaixo.
Modelo | Propósito |
Notas de versão | Mantenha os usuários informados sobre atualizações, novos recursos, correções de bugs e melhorias a cada versão do software. |
Documentação de design de software (SDD) | Esboçar a arquitetura e o design do software, incluindo diagramas e especificações para orientação de desenvolvimento. |
Documentação de requisitos de software | Descreva a finalidade, as funcionalidades e o ambiente do software para garantir que o desenvolvimento esteja alinhado com os objetivos do projeto. |
Documentação de requisitos do produto (PRD) | Defina a finalidade, o valor e as funcionalidades do produto para atender às necessidades do usuário e aos objetivos de negócios. |
Documentação do processo | Etapas e procedimentos detalhados envolvidos no desenvolvimento de software para padronizar fluxos de trabalho e aumentar a eficiência. |
Guia do usuário | Dê instruções abrangentes sobre como usar seu produto, abrangendo todos os recursos e funcionalidades. |
Modelos de documentação SOP
Se você selecionou a documentação do SOP na etapa 3, poderá escolher modelos na lista abaixo.
Modelo | Propósito |
Políticas e procedimentos de conformidade | Certifique-se de que sua organização atenda aos requisitos regulatórios documentando políticas que impõem a conformidade. |
Operação SOP | Aumente a eficiência e a produtividade padronizando os procedimentos operacionais em toda a sua organização. |
Modelos de manual do usuário
Se você selecionou o manual do usuário na etapa 3, poderá escolher quaisquer dois modelos da lista abaixo.
Modelo | Propósito |
Manual de instalação | Fornece todas as informações de configuração necessárias, 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 | Oferece instruções passo a passo de montagem e uso com diagramas e avisos de segurança, ideais para configuração precisa e avisos de segurança para uso adequado. |
Manual de manutenção | Forneça instruções detalhadas para procedimentos regulares de manutenção, solução de problemas e reparo para garantir o desempenho ideal. |
Manual de treinamento | Fornece diretrizes abrangentes sobre instalação, operação e solução de problemas e 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 o gerenciamento contínuo e eficaz da plataforma da Base de Conhecimento. |
Personalize sua base de conhecimento
Insira o URL da sua empresa. O Document360 analisará seu site e usará IA para gerar conteúdo relevante, elementos de marca e documentação estruturada.
Se você quiser pular esta etapa, o domínio será padronizado para aquele vinculado ao seu e-mail de registro.
Diretrizes da marca
O nome do projeto, o idioma padrão, o logotipo da marca e as cores da marca serão definidos automaticamente com base no URL fornecido. 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 do Brasil como idioma padrão; o idioma do portal será definido como espanhol ou português do Brasil. Caso contrário, o inglês será o idioma padrão.
O logotipo da marca e as cores primárias/secundárias são extraídos do seu site. Se você optar por Ignorar esta etapa, o nome do projeto será derivado do seu e-mail de registro e o logotipo e as cores padrão do Document360 serão aplicados.
Você pode visualizar seu site da base de conhecimento no lado direito da tela.
Definir a privacidade da documentação
Escolha as configurações de privacidade desejadas para o seu site:
Privado: Restrinja o acesso à base de conhecimento para que apenas contas de equipe possam visualizar e interagir com o conteúdo, mantendo-o seguro e interno.
Público: Torne a base de conhecimento acessível a todos, incluindo usuários externos, permitindo acesso aberto a todo o conteúdo.
Misto: combine o acesso privado e público, permitindo que algumas seções da base de conhecimento fiquem visíveis ao público, mantendo outras seções restritas apenas às contas da equipe.
Clique em Avançar para continuar.
Acessar o portal da base de conhecimento do Document360
Depois de concluir a configuração, entre no portal da base de conhecimento do Document360.
Para usuários que selecionaram a plataforma da base de conhecimento, a documentação técnica/documentação do software, a documentação do SOP ou o 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 compatível com o Eddy AI, sua documentação será gerada nesse idioma. Caso contrário, o padrão será o inglês. Se nenhum conteúdo relevante for encontrado no URL fornecido, você verá artigos pré-carregados com base no caso de uso e nos modelos selecionados, dando a você uma vantagem inicial na criação de seu conteúdo.
NOTA
Os artigos gerados pelo Eddy AI serão publicados e, em seguida, configurados para o modo de rascunho. Você pode atualizar os artigos conforme necessário.
Para usuários que selecionaram o caso de uso da documentação da API: Você será redirecionado para o espaço de trabalho da documentação da API, onde:
Você verá a referência da API da especificação da API fornecida durante a integração.
Se você não forneceu uma especificação de API, uma referência de API de amostra (API de loja de animais) estará disponível.
Alternando entre projetos do Document360
Depois de criar seus projetos no Document360, talvez seja necessário trabalhar em vários projetos ou alternar entre eles para várias tarefas. O Document360 fornece um alternador de projeto intuitivo para ajudá-lo a gerenciar isso perfeitamente.
Há duas maneiras de alternar projetos no portal da base de conhecimento:
Usando o menu suspenso Projetos
No painel Projetos
Alternando projetos usando o menu suspenso Projetos
Em qualquer módulo no portal da Base de Dados de Conhecimento, clique no menu suspenso do projeto no canto superior esquerdo da tela.
Você pode exibir 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 deseja visualizar na lista.
Alternando projetos no painel Projetos
Clique no logotipo do Document360 no canto superior esquerdo.
Você será redirecionado para a página "Meus projetos".
A lista de todos os projetos pertencentes ou associados à sua conta será exibida.
Clique no projeto para o qual deseja navegar.
Perguntas frequentes
O Document360 oferece suporte a idiomas diferentes no fluxo de integração?
Sim, o Document360 oferece suporte multilíngue no fluxo de integração, incluindo idiomas como inglês, espanhol, português do Brasil, alemão e sueco. No entanto, no portal do Document360, o suporte a idiomas está atualmente limitado a inglês, espanhol e português do Brasil.
Posso personalizar a aparência e a estrutura do meu projeto do Document360?
Sim, os projetos do Document360 oferecem amplas opções de personalização. Você pode personalizar a aparência de sua base de conhecimento projetando sua página inicial, temas, adicionando a marca de sua organização, orientada ao editor e organizando artigos em uma estrutura hierárquica (categorias) que atenda às suas necessidades de documentação.
É possível controlar o acesso e as permissões nos projetos do Document360?
Absolutamente. O Document360 oferece controle de acesso robusto e configurações de permissão. Você pode atribuir funções e permissões a contas de equipe, restringindo ou concedendo acesso a recursos e conteúdos específicos com base em suas responsabilidades e requisitos.
Como o Document360 ajuda no controle de versão e no histórico da documentação?
Os projetos da Document360 mantêm um sistema abrangente de controle de versão de artigos, conhecido como "revisões de artigos". Ele salva e rastreia automaticamente as alterações feitas nos artigos, permitindo que você reverta para versões anteriores, se necessário. Isso garante a integridade de sua documentação e simplifica a colaboração em atualizações de conteúdo.
Como posso saber em qual projeto estou trabalhando atualmente?
Você pode verificar o nome do projeto exibido no canto superior esquerdo da tela no portal da Base de Dados de Conhecimento.
O que acontece se eu não vir o projeto para o qual desejo 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 é diferente de outros projetos?
Um projeto de sandbox é um ambiente de teste onde você pode experimentar sem afetar seus projetos ativos. Ele terá um rótulo "Sandbox" no menu suspenso do projeto.
O que significa "Acesso ao site" no menu suspenso do projeto?
"Acesso ao site" 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 ao qual não estou associado no momento?
Entre em contato com o administrador da equipe ou com o proprietário do projeto para solicitar acesso ao projeto desejado.
O que acontece se o Eddy AI não puder gerar conteúdo do meu site para os artigos padrão?
Se o Eddy AI não conseguir extrair conteúdo suficiente do seu site, o sistema usará modelos padrão com base no caso de uso selecionado.