As categorias de documentação foram projetadas para um tipo específico de conteúdo: material de referência ao qual os leitores retornam, escaneiam rapidamente e frequentemente vinculam. Para apoiar isso, estamos introduzindo um novo modo simples para o plugin Discourse Doc Categories, que oferece à documentação uma experiência focada na leitura, mantendo o tópico completo acessível com um clique.
Uma visualização de tópico focada na leitura
Quando o modo simples está ativado, abrir um tópico de documentação coloca o próprio documento em destaque. As respostas permanecem a um clique de distância, atrás de um alternador na OP:
Mostrar 12 comentários / Ocultar comentários
Clique nele e a discussão completa aparecerá em seu local habitual, ordenada e renderizada exatamente como sempre foi. Clique novamente para recolhê-la.
Alguns detalhes que valem a pena destacar:
- Vincular diretamente a uma resposta (
/t/slug/id/4) expande automaticamente o tópico, de modo que qualquer pessoa que chegue por meio de um link compartilhado ou notificação seja direcionada à postagem para a qual foi enviada. - Novas respostas que chegam enquanto o tópico está recolhido são contabilizadas no rótulo do alternador, permitindo que você veja rapidamente quando algo novo foi adicionado.
Uma lista de tópicos no formato de documentação
Dentro de uma categoria de documentação, a lista de tópicos também é simplificada: as colunas focam no título e na data da última atualização, com a coluna Activity exibindo como Atualizado. Os leitores podem escanear os títulos e identificar rapidamente o que há de novo.
O resultado se assemelha mais a uma base de conhecimento: uma lista limpa de artigos, cada um acessível com um clique.
Ative-o em seu site
O modo simples está sendo lançado como uma mudança futura experimental. Acesse a página de mudanças futuras na sua área administrativa (/admin/config/upcoming-changes) e procure por Modo simples de categorias de documentação para participar.
A alteração aplica-se apenas a tópicos dentro de categorias configuradas como categorias de documentação, de modo que o restante do seu site permanece inalterado.
Adoraríamos receber seu feedback
O modo simples está em fase inicial, e esperamos continuar aprimorando-o. Se você ativá-lo para sua documentação, compartilhe o que está funcionando, o que parece faltar e quaisquer problemas que encontrar. Seu feedback ajudará a definir os próximos passos.