Recientemente, nos hemos esforzado por mejorar nuestra documentación aquí en meta, con el objetivo de categorizar las cosas de tal manera que los diferentes usuarios puedan encontrar temas que les sean relevantes e ignorar los que no.
Nuestro objetivo es que toda la documentación se agrupe en una de las siguientes categorías:
- #documentation:users - uso general común
- #documentation:moderators - moderación de una comunidad
- #documentation:theme-developers - desarrollo de temas y componentes de temas
- #documentation:admins - administración de un sitio de Discourse
- #documentation:devs - desarrollo de características, plugins e integraciones de Discourse
- #documentation:sysadmin - administración de sistemas autoalojados
Planeamos eliminar #documentation:faq y #documentation:tips-and-tricks al final de este ciclo (pero hemos comenzado a etiquetar algunos temas en las nuevas categorías con #tips-and-tricks).
También pretendemos etiquetar la documentación con una de estas etiquetas clasificatorias tomadas de divio según esta publicación anterior:
Las cosas no siempre encajan perfectamente. En algunos casos, estamos dividiendo temas y, en otros, simplemente usamos la etiqueta o categoría que mejor se adapta a su estado actual.
Algunos cambios comunes que hemos estado haciendo en temas individuales hasta ahora (estamos aproximadamente al 50% de completar ahora).
- Mover cosas de #documentation:admins a #documentation:sysadmin cuando requieren acceso a la consola.
- Dividir los temas de #documentation:faq en temas para #documentation:admins y temas para #documentation:users.
- Mover temas de #documentation:devs a #documentation:theme-developers cuando son específicos para el desarrollo de temas o componentes de temas.
- Actualizar los títulos de los temas para que sean más consistentes
- Usar el tiempo imperativo para los títulos de los temas (y eliminar “cómo” del título).
- Usar mayúsculas normales en las oraciones.
- Formatear el contenido con encabezados a partir de H2
(Relacionado: también hemos habilitado la Tabla de Contenidos para todos los temas de documentación)
En algunos casos, estamos haciendo algunos cambios en el contenido en sí, pero profundizar no es nuestro objetivo inmediato. En una futura pasada, nos gustaría hacer cosas como:
- Incorporar contenido de las respuestas en la propia documentación
- Eliminar todas las respuestas
- Configurar temas para eliminar respuestas después de 1 o 2 meses
Luego, en el futuro, proporcionaremos orientación actualizada sobre cómo contribuir con nueva documentación y mantener la documentación existente, y actualizaremos los siguientes temas:
Es posible que queramos convertir más documentación en Wikis o encontrar nuevos propietarios para la documentación cuando está siendo mantenida por alguien que no es el autor original, por ejemplo.
También creemos que puede haber una oportunidad aquí para crear un espacio separado para que las personas hagan más “mostrar y contar” en la línea de parte del contenido que había sido #documentation:tips-and-tricks. Crear un espacio para temas como estos fuera de la documentación puede permitir más espacio para discutir sobre ellos entre pares. Pero, de manera similar a lo que estamos haciendo ahora con la documentación, quizás sería útil tener espacios separados para administradores de sistemas, administradores y desarrolladores para esas discusiones. ¿Qué opinas?