Documentação: Dicas e truques sobre como usar a busca?

Primeiro, alguns metadados gerais :wink:

No meu fórum, usei uma quantidade razoável de categorias. Principalmente porque eu tinha a mesma estrutura em outros sites e todo mundo faz o mesmo. Mas, como todo mundo sabe, ou deveria saber, muitas categorias e várias subcategorias, além de todas as sub-subcategorias, são quase impossíveis de gerenciar. E o ponto mais importante: as categorias não ajudam o usuário a encontrar conteúdo relevante.

Nada de novo, na verdade. Esse é um dos motivos pelos quais o Discourse suporta apenas categorias de dois níveis e o uso de tags é frequentemente recomendado.

No entanto, muitos são contra as tags. Imagino que isso leve ao mau uso generalizado de tags em outras plataformas, misturando-as com palavras-chave (parcialmente tags e palavras-chave são as mesmas) e o abuso de hashtags pelo Instagram, etc. Além disso… o ponto de vista comum é que, por causa dessa história, usuários comuns não sabem como usar tags.

Eles sabem. Para eles, o que veem na tela, tags são a mesma coisa que categorias — mas dão melhores resultados (SE usadas corretamente pelos administradores).

Mas as tags funcionam melhor com buscas. E isso também é um problema. Como as tags são amplamente mal utilizadas, o mesmo acontece com as buscas — porque simplesmente não funcionam. Os usuários aprenderam a não usar a busca, porque ela retorna muitos resultados. É uma luta sem fim entre as habilidades dos usuários, se todos os resultados devem ser mostrados a um usuário ou se podemos usar algum tipo de adivinhação como o Google faz.

Esse é um problema que os desenvolvedores precisam resolver. Mas essa é outra história.

De qualquer forma. Meu público são apenas pessoas comuns, nada de “tech-savvy”. Eles têm dificuldades para começar a usar o composer do Discourse e não conseguem mudar o tema. Claro, eles podem agora, na maioria das vezes, mas precisou de muita orientação.

Mas eles se adaptaram à falta de categorias e começaram a usar tags imediatamente. Para eles, foi um ato realmente intuitivo. Ou, como alguns usuários disseram: clicar em tags é como pesquisar, mas melhor. Tudo o que precisei fazer em termos de orientação foi dizer a eles para clicarem nas tags e descobrirem o que acontece, e dizer onde Tags no menu hambúrguer leva.

De volta ao assunto

O Discourse tem um dos melhores motores de busca no mundo da web gratuita. Não é perfeito, é claro, mas é muito superior à busca nativa do WordPress ou de outros CMSs (se você não conhece o plugin de busca do WordPress Relevantti, deveria conferir; é muito bom).

Estou ensinando agora meus usuários a melhorar os resultados de busca. Na verdade, até isso foi uma tarefa muito mais fácil do que eu esperava — e esses usuários quase nunca usam busca em lugar nenhum (não os culpo, porque as buscas são muito ruins com frequência).

Mas agora me faltam algumas referências. Sei que o Discourse pode usar muitos truques diretamente nos termos de busca — mas esses fragmentos e pedaços de conhecimento estão espalhados em… muitos posts e tópicos.

Eu sei — escrever documentação e dicas e truques exige mais trabalho do que codificar em si. Já fiz muita documentação. Não é apenas escrever uma, mas deve haver pelo menos três documentos diferentes dependendo das necessidades e habilidades dos usuários. Além disso, alguém deve mantê-los atualizados também.

É por isso que entendo totalmente que não consigo encontrar um guia abrangente para dominar as buscas no Discourse :wink: (ou eu simplesmente… não consigo buscar)

O que estou pedindo à comunidade é

  • uma lista simples de (ou de; às vezes eu odeio tanto o inglês) parâmetros de busca ou apenas exemplos/links
  • ensine seus usuários a usar a busca, a maioria deles simplesmente não consegue
  • abandone as categorias e comece a usar tags em vez disso (bem, isso exige algum planejamento para ser feito corretamente, embora)
6 curtidas

Concordo plenamente. Existem 2 plugins excelentes que também podem aprimorar a experiência do usuário com pesquisas.

  • Pesquisas Salvas
  • Docs

No entanto, sim, configurar guias de fórum é um requisito definitivo para ajudar os usuários a usar melhor um fórum e melhorar sua experiência. É aí que o plugin Docs pode definitivamente ser um trunfo. Há também um componente de tema que pode ser usado com o plugin Docs.

1 curtida

@hugh / @JammyDodger precisamos de algo assim no tópico da documentação?

3 curtidas

[quote=“Sam Saffron, post:3, topic:234507, username:sam”]Precisamos de algo assim no tópico da documentação?
[/quote]

Existe Searching for content effectively

4 curtidas

Legal, integrei tudo (usando o claude-3.5-sonnet) satisfeito com a edição, mas fique à vontade para revisar.

4 curtidas

Eu removi a maioria deles porque:

Gosto que o tópico destaque os filtros que não consigo descobrir usando a pesquisa avançada. Se você quiser alterar o escopo, basta reverter a edição.

Deixei as opções de ordenação porque elas não são mostradas no campo de entrada de pesquisa, então é mais difícil usá-las sem o menu suspenso.

1 curtida

Acho que é melhor mudar o escopo… essa regra parece muito arbitrária. Talvez possamos apenas remover "Este tópico tem como objetivo listar outros filtros que não estão disponíveis no formulário de pesquisa avançada" dela?

@JammyDodger o que você acha?

Entendo que você pode descobrir muita coisa clicando, mas a documentação te poupa disso. Além disso, essa edição piora a pesquisa.

Por exemplo:

pesquisa de rastreamento não encontrará mais este documento, o que é uma pena.

3 curtidas