Reestructuración de la documentación para mejorar la claridad

[hugh (Hugh Lashbrooke)]

Actualización (4 de junio de 2024): Se ha completado el trabajo inicial de reestructuración de los temas de documentación, y las nuevas categorías ya están activas con nuevos índices que muestran lo que encontrarás en ellas. Puedes consultarlas aquí: Documentation - Discourse Meta - ¡si notas algo incorrecto, por favor publícalo abajo!

Tras una revisión exhaustiva de nuestra estructura de documentación actual, nos complace compartir que estamos mejorando la categorización de nuestra documentación para organizar mejor los temas y centrarlos en los objetivos que nuestra comunidad se propone alcanzar. Nuestro objetivo es mejorar la claridad y la usabilidad de nuestra documentación, facilitando que todo el mundo encuentre la información que necesita.

Qué esperar

Nuevas categorías

De ahora en adelante, nuestra documentación se categorizará y etiquetará según la acción o funcionalidad que describe. Los agrupamientos actuales basados en el rol del usuario desaparecerán, y actualizaremos todos los temas de documentación para indicar qué rol de usuario es necesario para realizar las actividades que describen.

Cambios visuales temporales

Durante esta reestructuración, es posible que notes que algunas secciones de nuestra documentación parecen un poco fuera de lugar o desorganizadas. ¡No te preocupes! Esto es solo temporal mientras trabajamos para finalizar la nueva estructura.

Actualizaciones exhaustivas

Una vez completada la reestructuración, nuestro siguiente paso será actualizar todos los temas de documentación para alinearnos con una nueva guía de estilo común. También corregiremos cualquier imprecisión que pueda existir. Este será un proyecto continuo, con la mayor parte del trabajo llevándose a cabo en las próximas semanas.

Cómo puedes ayudar

Tu opinión, como siempre, es invaluable para nosotros. Si encuentras algún problema o tienes sugerencias sobre cómo podemos mejorar aún más nuestra documentación, no dudes en compartir tus ideas en Contribute > Site feedback o como una publicación en este tema.

¡Gracias por tu paciencia mientras hacemos estos cambios!

[Moin]

Los temas sobre moderación como Discourse Moderation Guide forman parte de Documentation > Site Management. Quizás eso debería añadirse a la descripción porque, como moderador, no buscaría temas en una categoría para “propietarios y administradores del sitio”.

Site Management

[mcwumbly (Dave McClure)]

Hice un pequeño ajuste al texto “acerca de” para indicar que también es útil para los moderadores.

@JammyDodger y/o @hugh pueden tener pensamientos adicionales cuando vean esto más tarde también.

[JammyDodger]

Le di un ajuste adicional:

Site Management

[hugh (Hugh Lashbrooke)]

¡Gracias por resaltarlo @Moin!

@JammyDodger Tu actualización me parece bien.

[hugh (Hugh Lashbrooke)]

El trabajo inicial de reestructuración de los temas de documentación se ha completado, y las nuevas categorías ya están activas con nuevos índices que muestran lo que encontrarás en ellas.

Puedes consultarlas aquí: Documentation - Discourse Meta - si notas algo incorrecto, ¡publica a continuación!

[Moin]

¿Planeas añadir las nuevas categorías al plugin de documentación?

[JammyDodger]

Estamos divididos entre probar la vida sin el plugin de documentación o no. Por ahora, he añadido las nuevas categorías a la mezcla.

[NateDhaliwal]

¿Puedo saber cómo se crea el texto de los enlaces a temas en la barra lateral cuando se está en una subcategoría? ¿IA?

[hugh (Hugh Lashbrooke)]

Cada subcategoría tiene un tema de índice, por ejemplo: Using Discourse Index (estos están vinculados desde la descripción en el encabezado de cada subcategoría).

La barra lateral toma los títulos acortados de allí para usarlos en lugar de los títulos completos de los artículos.