La documentación de Discourse es el lugar principal donde los administradores, moderadores, usuarios y sysadmins pueden encontrar ayuda para usar Discourse y gestionar sus sitios.
Aunque esta documentación es robusta y abarca muchos aspectos, hay algunas áreas que aún no están documentadas. Esta es una gran oportunidad para que la comunidad se involucre y ayude a refinar esta parte importante del proyecto Discourse.
Nos encantaría ver a más personas involucradas en la creación de contenido de documentación para Discourse, y queremos hacer que sea lo más fácil posible para cualquiera hacerlo. Para ello, a continuación se presenta una lista de características o casos de uso de Discourse que hemos identificado como necesitados de nueva o mejorada documentación.
Ubicaciones de la documentación
Cualquier persona con un nivel de confianza 2 o superior puede crear nuevos temas de documentación en Wiki; este es el hogar de todo el contenido de documentación contribuido por la comunidad. Si un tema en la wiki de la comunidad se considera relevante o importante, puede ser movido a Documentation, el hogar de toda la documentación oficial de Discourse. Puedes leer la política de documentación para más detalles al respecto.
Insignias para colaboradores de la documentación
Cualquier persona que cree un nuevo tema en la categoría Wiki recibirá automáticamente la insignia de bronce Scribe:
Si el tema se considera lo suficientemente valioso como para ser movido a la categoría oficial Documentation, alguien del equipo de Discourse lo hará manualmente, acreditará al autor original en el contenido del tema y le asignará la insignia de plata Ghostwriter:
Documentación que necesita ser escrita
Aunque en última instancia queremos ver cada parte de Discourse documentada exhaustivamente, estas son las áreas que hemos identificado con la necesidad más urgente (los elementos tachados indican temas que han sido escritos desde que este primer post fue publicado):
- Un tutorial general de inicio para administradores
- Redirecciones de temas personalizadas
- Explicación de lo que pueden hacer los diferentes niveles de usuario
- Opciones de inicio de sesión social
- Avisos de publicación (documentación oficial)
- Más documentación sobre cómo funcionan los niveles de confianza
- Cómo escribir una buena solicitud de función para Discourse (tema wiki)
- Una referencia de cómo se ven las características de markdown y formato de Discourse cuando se incluyen en correos electrónicos
- Estados de usuario (tema wiki)
- Explicación del modo oscuro, cómo seleccionarlo y cómo habilitar el cambio (tema wiki)
- Documentación general que cubre la gestión de preferencias de usuario (tema wiki)
- Documentos que explican cómo funcionan las categorías y la jerarquía en Discourse
- Una guía general sobre la configuración de temas
- Una guía general sobre complementos: qué son, cómo funcionan y cómo usarlos
- Páginas de inicio personalizadas
- Cambio de categorías y temas predeterminados
- Uso de cuadrículas de imágenes en publicaciones (tema wiki)
- Configuración de aprobación de publicaciones (tema wiki)
Algunos de estos pueden requerir múltiples temas para ser documentados efectivamente.
Cómo escribir documentación
Para garantizar que la documentación de Discourse sea lo más efectiva posible, tenemos una guía de estilo sobre cómo escribir este contenido. Aunque sería útil que todos siguieran la guía, si estás contribuyendo a Wiki, no es un problema si no la sigues completamente. Cualquier tema que se mueva a Documentation será actualizado por el personal de Discourse para que coincida con la guía de estilo según sea necesario.
¿Interesado?
Únete a Wiki y comienza a documentar hoy. Si quieres discutir algo de esto, no dudes en responder a este tema para hablar sobre ello.

