Reestruturação da documentação para melhor clareza

[hugh (Hugh Lashbrooke)]

Atualização (4 de junho de 2024): O trabalho inicial de reestruturação dos tópicos de documentação foi concluído, e as novas categorias já estão no ar, com novos índices mostrando o que você encontrará nelas. Você pode conferi-las aqui: Documentation - Discourse Meta — se notar algo incorreto, por favor, deixe um comentário abaixo!

Após uma revisão minuciosa da estrutura atual da nossa documentação, temos o prazer de compartilhar que estamos em processo de melhorar a categorização do nosso material para tornar os tópicos mais organizados e focados nos objetivos que nossa comunidade deseja alcançar. Nosso objetivo é aprimorar a clareza e a usabilidade da nossa documentação, facilitando para todos encontrarem as informações de que precisam.

O que esperar

Novas categorias

A partir de agora, nossa documentação será categorizada e marcada com tags com base na ação ou funcionalidade que descreve. Os agrupamentos atuais baseados em função do usuário serão descontinuados, e atualizaremos todos os tópicos de documentação para indicar qual função do usuário é necessária para realizar as atividades descritas.

Alterações visuais temporárias

Durante essa reestruturação, você pode notar que algumas seções da nossa documentação parecem um pouco fora de lugar ou desorganizadas. Não se preocupe! Isso é apenas temporário enquanto trabalhamos para finalizar a nova estrutura.

Atualizações abrangentes

Quando a reestruturação estiver concluída, nosso próximo passo será atualizar todos os tópicos de documentação para alinhá-los a um novo guia de estilo comum. Também corrigiremos quaisquer imprecisões que possam existir. Este será um projeto contínuo, com a maior parte do trabalho sendo realizada nas próximas semanas.

Como você pode ajudar

Seu feedback, como sempre, é inestimável para nós. Se você encontrar algum problema ou tiver sugestões sobre como podemos melhorar ainda mais nossa documentação, não hesite em compartilhar suas ideias em Contribute > Site feedback ou como uma publicação neste tópico.

Obrigado por sua paciência enquanto fazemos essas mudanças!

[Moin]

Tópicos sobre moderação como Discourse Moderation Guide fazem parte de Documentation > Site Management. Talvez isso devesse ser adicionado à descrição porque, como moderador, eu não procuraria tópicos em uma categoria para “proprietários e administradores do site”.

Site Management

[mcwumbly (Dave McClure)]

Fiz um pequeno ajuste no texto “sobre” para indicar que ele também é útil para moderadores.

@JammyDodger e/ou @hugh podem ter pensamentos adicionais quando virem isso mais tarde também.

[JammyDodger]

Eu dei um ajuste extra:

Site Management

[hugh (Hugh Lashbrooke)]

Obrigado por destacar isso, @Moin!

@JammyDodger Sua atualização parece boa para mim.

[hugh (Hugh Lashbrooke)]

O trabalho inicial de reestruturação dos tópicos de documentação foi concluído, e as novas categorias já estão no ar com novos índices mostrando o que você encontrará nelas.

Você pode conferi-las aqui: Documentation - Discourse Meta - se notar algo incorreto, por favor, poste abaixo!

[Moin]

Você planeja adicionar as novas categorias ao plugin de documentação?

[JammyDodger]

Estamos divididos entre tentar a vida sem o plugin de documentação ou não. Por enquanto, adicionei as novas categorias à mistura.

[NateDhaliwal]

Posso saber como o texto dos links para tópicos na barra lateral, quando em uma subcategoria, é criado? IA?

[hugh (Hugh Lashbrooke)]

Cada subcategoria tem um tópico de índice, por exemplo: Using Discourse Index (estes são vinculados a partir da descrição no cabeçalho de cada subcategoria).

A barra lateral usa os títulos abreviados de lá para usá-los em vez dos títulos completos dos artigos.