FAQ - Documentos

Boas-vindas à seção de perguntas frequentes (FAQ) dedicada à feature de Documentos na Weduka. Aqui, você encontra respostas abrangentes e esclarecedoras para as principais dúvidas relacionadas ao uso dos Documentos em nossa plataforma. Explore as perguntas para obter insights valiosos sobre como tirar o máximo proveito dessa poderosa e colaborativa base de conhecimento. Dica: conheça, também, as melhores práticas de uso de documentos, reunidas aqui. 

Ela faz uma varredura usando o termo digitado e atibui pesos aos termos compatíveis, encontrados em diferentes locais do documento durante uma busca, e as importâncias ficam na seguinte ordenação: ID, título, palavras-chave, descrição e conteúdo (em documentos de texto ou construtor de páginas). 

Conforme o resultado da varredura, ela cria um ranking de pontos para os documentos. O documento que possuir maior pontuação, aparece em primeiro na lista de resultados.

Quanto maior a exatidão do resultado do termo pesquisado, maior a quantidade de pontos que o documento recebe no ranking. Se você pesquisar um termo de duas palavras e a busca encontrar mais de um documento como resultado, os pontos são distribuídos em cada um dos resultados descritos no item 1.

Exemplo: se o título do documento 1 for feito de 4 palavras e as 2 que você pesquisou estiverem nele, ele recebe uma quantidade de pontos maior em comparação a outro documento que tenha o título formado por 10 palavras e contenha as 2 que você pesquisou. Traduzindo para uma regra matemática, o documento 1 tem uma proporção de acerto de 50% (2 de 4) e o documento 2 tem uma proporção de 20% (2 de 10). Este exemplo leva em consideração somente o título, mas esta razão se aplica também para palavra-chave, descrição e conteúdo.

Além da busca exata ou parcial por termos isolados atribuírem pontos aos documentos, a importância de um resultado aumenta muito quando um termo composto é encontrado no título, nas palavras-chave ou na descrição. Essas expressões ganham um grande peso no rankeamento dos resultados.

Nosso método ignora diferenças de letras maiúsculas ou minúsculas, ou acentuação entre termos buscados e encontrados. Com essa redução da sensibilidade, a pontuação aumenta muito, ainda que hajam essas diferenças, favorecendo uma boa posição no rankeamento.

Sim, existe uma regra que delimita um máximo de 50 documentos e ela foi implementada para preservar a estabilidade do servidor. Se não houvesse um limite para essa apresentação, haveria a possibilidade de certas pesquisas sobrecarregaram demais o servidor. Esta é a oportunidade que podemos colocar na mesa para encontrar alguma solução na qual seja possível contornar, neste sentido, o time de desenvolvimento iniciará um processo de estudo.

Para que você possa utilizar o mecanismo da busca inteligente e extrair resultados ainda melhores da busca, indicamos o uso dos filtros avançados na busca de documentos como, por exemplo, o de repositório. Quando você filtrar um repositório, estará direcionando a busca para os documentos somente dele, com isto a quantidade de resultados (50) poderá ser suficiente para sua busca. Além disso, utilizar outros filtros combinados tornam a busca ainda mais direcionada e com resultados mais assertivos.

Além do bom uso dos filtros avançados, existem outros elementos de facilitação no uso da ferramenta de documentos, como favoritar os documentos que a pessoa mais usa e utilizar a aba de mais acessados por mim. Estas abas podem ser acessadas na tela 'Meus documentos', sem necessidade de nenhuma pesquisa.

Outra dica valiosa é que você evite a a busca por termos curtos ou pouco específicos, por exemplo: ar, dona, caso e etc. O que ocorre nestes exemplos é a presença de poucas sílabas fazendo com que o resultado seja muito amplo, pois a busca elástica utiliza um encontro de valores, e calcula as distâncias de match entre termos da busca e resultados de ID, título, palavras-chave, descrição e conteúdo (quando estamos falando de texto ou construtor de páginas). Ou seja, termos pequenos podem ser encontrados em documentos mesmo que não estejam presentes por inteiro. Exemplo: é possível que a busca pelo termo "caso" traga o documento que tem uma palavra-chave "casa", pois ambas tem o match "ca" ou até "cas", ainda que existam distâncias importantes para um match perfeito. O rankeamento entrega aquilo que consegue classificar e pontuar, na ordem da maior pontuação para a menor. Em cases de uso real da feature de busca, é importante entender e perceber se os documentos encontrados estão de fato bem classificados no ranking. Isso é o que mais importa. Caso não estejam, verifique e ajuste os campos que geram pontuação.

O formato de construção desses elementos no documento tem total influência no resultado da busca. Por exemplo: se você usar a palavra 'crédito' em todos os espaços de um documento, você atribui pontos a este documento. Sendo assim, é válido analisar se os documentos que são apresentados como resultado da busca, realmente "merecem" estar com tantos pontos em comparação a outros. Lembre-se de que isto acontece quando você dá protagonismo a estes termos ao usá-los na construção do documento. Uma sugestão para avaliação das buscas e seus resultados é o uso do relatório de buscas como aliado. Ele demonstra quais as buscas que as pessoas tem realizado e quais os documentos são resultados destas buscas.

2. Como saber quais grupos de acesso e de revisão estão associados a um documento?

Se você administra repositórios e configura grupos de controle, você tem um caminho para saber quais grupos de acesso e de revisão estão associados a um documento:


Acesse Documentos > Gerenciar documentos e, no menu de ações do documento desejado, clique em Definir acesso ou revisão. Nessa página você encontra a informação de quais grupos de controle (de acesso ou de revisão) estão associados ao documento.
Você também pode exportar esses grupos, para saber quais pessoas fazem parte deles. Para isso, selecione todos os grupos, clique no botão Ações > Exportar pessoas.

Dicas complementares:


3. Como saber quais repositórios estão associados a um grupo de acesso?

Ao acessar Documentos > Configurar grupos, na coluna ‘Repositórios’, você encontra os repositórios associados a cada grupo. A coluna exibe um link que, ao ser acessado, mostra a lista de repositórios.

4. Como associar ou desassociar repositórios de um grupo de acesso já criado?

Ao acessar Documentos > Configurar grupos, na coluna ‘Ações’, você encontra a opção de editar. No campo 'Repositório', você visualiza a lista de repositórios que você administra e pode editar a associação feita.

5. Não consigo encontrar um documento em Gerenciar documentos, apesar de ser uma das pessoas que administra o repositório em que ele foi criado. O que pode estar acontecendo?

Se você administra um repositório, pode localizar todos os documentos criados nele. Se um documento tiver sido criado por outra pessoa e ainda for um rascunho, ou seja, não tiver sido publicado, você consegue encontrá-lo, mas não tem permissão para editá-lo. Agora, se você não consegue encontrar um documento, use os filtros para buscar por documentos ativos e inativos, também. Além disso, confira se o repositório está ativo. Documentos de repositórios inativos não podem ser gerenciados. 

6. Após editar um documento e publicar uma nova versão, as pessoas que o acessarem vão poder registrar feedbacks de utilidade outra vez?

Sim, o comportamento de feedbacks funciona assim: a cada versão do documento, cada pessoa que tem acesso ao documento pode avaliar a utilidade dele. Para isso, é preciso clicar no botão 'Enviar feedback', além dos thumbs (útil, não útil). Uma vez enviado, os botões deixam de aparecer. Ao publicar uma nova versão, os botões voltam a ser exibidos para o envio de uma nova avaliação.

7. Ao copiar um texto html e colar no editor de texto da Weduka, o texto é colado em negrito. O que fazer?

O CK Editor, que é uma ferramenta integrada à Weduka para a edição de texto, ao trazer um texto html para o editor, o traz em negrito. Essa é uma característica do CK e estamos acompanhando as atualizações para encontrar soluções. Para contornar, neste momento, orientamos que ao invés de colar o texto usando Ctrl + v, seja usado Ctrl + Shift + v (colar sem formatação).

8. É possível editar um rascunho de documento criado por outra pessoa?

Não. Ainda que você seja uma pessoa que administra o repositório em que o rascunho foi criado, não consegue editar, pois um rascunho só pode ser continuado por quem o criou. Depois da publicação, quando o documento deixa de ser um rascunho, outras pessoas que tenham a permissão poderão editá-lo. 

9. É possível migrar pastas de um repositório para outro?

Na Weduka, não temos hoje uma estrutura que permita a migração de pastas de documentos de um repositório para o outro. Se for entendido que é uma demanda recorrente e que seja importante, pode se transformar em um projeto futuro. Por conta de todas as associações que envolvem a estrutura de um documento, o impacto pode ser muito grande. Nossa orientação aqui, então, é que esse processo seja feito manualmente. Tem um caminho que pode tornar mais fácil e rápida essa migração: clonar os documentos que vocês desejam transferir de um repositório para o outro. Ao clonar um documento, nas configurações avançadas, é possível alterar o repositório e todos os outros atributos, como assuntos, pastas, descrição, palavras-chave, etc.

10. Como saber se as pessoas estão acessando os documentos da base de conhecimento?

Acessando Documentos > Relatório de acessos, você encontra detalhes sobre o acesso aos documentos, como a origem, as datas, as quantidades e até a classificação de utilidade. Além disso, você visualiza gráficos que exibem os 5 documentos mais acessados e o pareto de origem do acesso.

11. Perdi meu acesso aos documentos. Como entender o que aconteceu e resolver?

Antes de mais nada, entenda o seguinte: uma pessoa só acessa um documento se ela fizer parte do grupo de acesso que está associado a ele. Ou seja, basta entender a associação do grupo e resolver a questão. Abaixo um caminho simples para fazer isso:

Pronto, problema de acesso resolvido! Todos os documentos associados ao grupo editado automaticamente ficarão disponíveis para as pessoas incluídas nele.

Dica importante: sempre que uma nova função ou novo negócio forem criados, e as pessoas da sua base forem movimentadas para eles, os grupos de acesso aos documentos precisam ser gerenciados e possivelmente ajustados para refletir tais mudanças. Normalmente são alterações como essas, na base de pessoas, que causam as perdas de acesso.

12. Como funciona o prazo de revisão de um documento?

A data de revisão é uma característica estática de cada documento. Uma vez configurada, ela só será alterada se o documento for editado e o campo específico de data do prazo de revisão for alterado. Configurar uma quantidade de dias de revisão diferente no repositório não vai alterar automaticamente todos os documentos com data de revisão ativada disponíveis dentro dele. Assim como, fazer uma edição de documento sem alterar seu prazo de revisão, não vai atualizar automaticamente a data baseando-se na data sugerida pelo repositório. Mais uma vez, cada documento carrega sua data estática de revisão, e ela pode ser editada a qualquer momento.

A data de revisão configurada no repositório é apenas uma recomendação que fica disponível quando é ativada no documento. Essa ativação fica disponível dentro das configurações avançadas de um documento e, ao ativar, as pessoas administradoras do repositório ou revisoras do documento passam a ser notificadas para fazer a revisão. Esta notificação é iniciada 30 dias antes da data cadastrada. Por padrão, a configuração nasce desativada, ou seja, a pessoa que está criando ou revisando um documento precisa ativar para liberar as notificações de revisão. Quando ativada a função, o campo calcula a quantidade de dias configurados no repositório e aplica uma data de revisão futura, começando a contagem na data atual. Entretanto, por se tratar de uma recomendação, o campo permanece aberto para edições. Isso significa que a pessoa que está criando ou revisando pode escolher livremente qualquer outra data de revisão específica para aquele documento.

Para voltar a consumir a data sugerida pelo repositório, durante a revisão de um documento, basta desligar e ligar novamente o botão de Notificar revisão, dentro das configurações avançadas, e depois salvar. Essa ação vai trazer novamente a sugestão de dias de prazo de revisão vinda do repositório. 

Uma boa prática é usar modelos de documentos e configurá-los com a data de revisão ativada. Assim, ao clonar tais modelos para a criação de novos documentos, esta característica pode ser mantida.

Dica: configure datas de revisão apenas para documentos que demandam esta ação. Evite poluir o sistema com notificações de revisão de documentos que não precisam ser revisados. Isso acaba atrapalhando a experiência de pessoas administradoras dos repositórios e também de pessoas revisoras de documentos.

13. Como posso consultar documentos com links para documentos inativos?

Você pode consultar esses documentos facilmente utilizando o relatório disponível em Relatórios > Registros de uso. Basta selecionar as operações e os negócios desejados, definir as datas de início e fim da consulta (pode ser o dia de hoje para ambas) e escolher 'Documentos com links para doc. inativos' na lista de relatórios disponíveis. O resultado mostrará 5 colunas: 'ID do documento de origem', 'Documento de origem', 'Repositório do documento de origem', 'ID do documento relacionado' e 'Documento relacionado'.

Como é a experiência das pessoas que acessam um link de um documento inativo? Quando alguém acessa um documento com link para um documento inativo e clica nesse link, a experiência é insatisfatória. A pessoa visualiza uma mensagem informando que o documento não existe ou que ela não possui acesso, o que pode dar a impressão de erro, e não é o caso. Editar ou remover esses links não apenas aprimora a precisão das informações, mas também melhora significativamente a experiência das pessoas que acessam documentos na Weduka, proporcionando uma navegação mais suave e consistente.