Personalizando FAQs e diretrizes

:bookmark: Este é um guia para administradores sobre como personalizar as páginas de Perguntas Frequentes (FAQ) e Diretrizes em um site Discourse.

:person_raising_hand: Nível de usuário necessário: Administrador

A personalização das páginas de FAQ e Diretrizes no Discourse permite que você adapte o conteúdo às necessidades e regras específicas da sua comunidade. Essas páginas são frequentemente o primeiro ponto de referência para novos usuários entenderem o que é esperado deles e também podem servir como um recurso para membros existentes.

Páginas de FAQ e Diretrizes

Por padrão, o Discourse inclui apenas uma página de FAQ.

No entanto, você também pode criar uma página de Diretrizes. Isso permite um conteúdo mais focado em cada página, com o FAQ tratando de perguntas comuns e as Diretrizes delineando as regras da comunidade.

Para adicionar uma página de Diretrizes ao seu site, você precisará adicionar uma URL de tópico ou uma URL externa à configuração administrativa faq url. Você também pode usar uma URL de página publicada aqui.

Isso criará uma página de Diretrizes (acessível em .../guidelines) junto com a guia FAQ existente.

Renomear FAQ para Diretrizes (Mudança Futura)

O Discourse está implementando uma mudança futura (rename_faq_to_guidelines) que renomeia a página de FAQ para “Diretrizes” na navegação. Quando essa mudança for ativada:

  • A guia de navegação mostrará Diretrizes em vez de FAQ
  • /faq, /rules e /conduct serão redirecionados para /guidelines (quando faq_url não estiver definido)
  • O link na barra lateral mudará de “FAQ” para “Diretrizes”
  • Se faq_url estiver definido, as guias “Diretrizes” e “FAQ” ainda aparecerão (igual ao antes)

O conteúdo da página de FAQ permanece inalterado — apenas o rótulo e o roteamento mudam. Você pode gerenciar essa mudança futura na página Admin → Mudanças Futuras.

Conteúdo de FAQs e Diretrizes

A página de FAQ no Discourse vem com conteúdo padrão que serve como modelo para as diretrizes do fórum e perguntas frequentes. Para editar esse conteúdo:

  1. Navegue até o tópico FAQ/Diretrizes no seu fórum, que geralmente é criado por padrão quando sua instância do Discourse é configurada. Esse tópico geralmente está fixado na categoria da equipe, mas pode ser encontrado em outras categorias se movido.
  2. Edite a postagem como faria com qualquer outro tópico no fórum. Como administrador ou moderador, você pode revisar o texto para adequá-lo às regras e expectativas da sua comunidade.
  3. Após fazer as alterações necessárias, salve as edições para atualizar o conteúdo da página de FAQ.

Se você deseja linkar para uma página de FAQ externa, pode alterar a configuração de site faq_url para apontar para a URL da sua página de FAQ externa.

Se você adicionou uma página de Diretrizes, essa página usará o tópico FAQ/Diretrizes para seu conteúdo, e você pode personalizar o conteúdo da página de Diretrizes seguindo um processo semelhante ao descrito acima.

Nomes dos Rótulos de Navegação

Você pode personalizar os rótulos de texto usados nos menus de navegação para FAQs e Diretrizes na página Admin → Personalizar → Textos (.../admin/customize/site_texts/).

Pesquise por js.guidelines e js.faq para encontrar o conteúdo de texto que corresponde aos rótulos de navegação e altere-os para os termos desejados.

Você também pode atualizar o rótulo de navegação usado na barra lateral para FAQ editando js.sidebar.sections.community.links.faq.content. Se a mudança futura rename_faq_to_guidelines estiver ativada, edite js.sidebar.sections.community.links.guidelines.content em vez disso.

Veja Customize text in Discourse para detalhes adicionais sobre esse processo.

Rotas de URL

Se um site não incluir uma página de Diretrizes, você pode acessar a página de FAQs pelos seguintes slugs de URL:

  • /faq
  • /guidelines
  • /rules
  • /conduct

Se um site incluir uma página de Diretrizes, as seguintes URLs podem ser usadas para acessar a página de Diretrizes:

  • /guidelines
  • /rules
  • /conduct

Quando uma página de Diretrizes estiver presente, a página de FAQ só pode ser acessada por /faq ou pela SiteSetting.faq_url.

:bulb: Quando a mudança futura rename_faq_to_guidelines estiver ativada e faq_url não estiver definido, /faq, /rules e /conduct serão todos redirecionados para /guidelines.

:person_raising_hand: Existe alguma maneira de alterar as rotas de URL como /faq e /guidelines?

Não. O Discourse não possui recursos principais para alterar essas rotas, embora seja possível com um plugin.

Ocultar Rótulos de Navegação

Dependendo de como você deseja estruturar seu site, talvez queira ocultar os links de navegação para as páginas de FAQ e Diretrizes. Isso pode ser feito por meio de alterações de CSS no seu site.

Especificamente, você pode ocultar os nomes dos rótulos de navegação de FAQ e Diretrizes com o seguinte CSS:

Ocultar Rótulo de Navegação de FAQ

.nav-pills .nav-item-faq {
    display: none;
}

Ocultar Rótulo de Navegação de Diretrizes

.nav-pills .nav-item-guidelines {
    display: none;
}

Além disso, você pode ocultar o botão de FAQ do menu lateral / hambúrguer usando:

li[data-list-item-name="faq"]{
    display: none;
}

Se a mudança futura rename_faq_to_guidelines estiver ativada, o nome do item da barra lateral muda para “guidelines”, então use:

li[data-list-item-name="guidelines"]{
    display: none;
}

Adicionar Diretrizes à Barra Lateral

Você pode usar o componente de tema Links Personalizados do Menu Hambúrguer para adicionar um link à página de Diretrizes ao seu menu hambúrguer ou barra lateral. Veja Instalar um tema ou componente de tema para detalhes sobre como instalar esse componente.

Depois que o componente de tema for instalado, você pode usar a seguinte entrada para adicionar um link à página de Diretrizes.

Diretrizes,/guidelines,g

Dicas de Gerenciamento da Comunidade

Personalizar suas FAQs e Diretrizes no Discourse é importante para moldar a identidade e a cultura únicas da sua comunidade, juntamente com as expectativas do seu espaço. Isso não apenas ajuda a fomentar um senso de comunidade, mas também fornece clareza sobre o que deve e não deve ser feito, o que pode reduzir significativamente a carga de trabalho de moderação e melhorar a experiência do usuário.

Uma seção de FAQ bem estruturada é inestimável para integrar novos membros de forma eficiente, pois pode responder preventivamente a consultas comuns, permitindo discussões mais profundas e envolventes.

É benéfico elaborar esses documentos com um tom positivo, destacando comportamentos incentivados com exemplos claros. Manter o conteúdo conciso e bem organizado com tópicos e cabeçalhos também pode ajudar a tornar as informações mais digeríveis.

9 curtidas