Incluye más pistas en todo Discourse que enlacen a documentos relevantes en Meta

Contexto

El equipo de Discourse ha mencionado en varios lugares que buscan mejorar la experiencia del administrador.

Problema

Hay muchas configuraciones en Discourse y mucha documentación. Pero es poco probable que encuentres la documentación correcta en el momento adecuado.

Característica

Podría haber muchos más lugares en la configuración y los menús de Discourse donde se vincule la documentación correspondiente en https://meta.discourse.org/docs.

Por ejemplo, está la publicación del blog Understanding Discourse Trust Levels que está vinculada en las instalaciones de Discourse.

Pero hay muchas más que no lo están.

Por ejemplo, hay un tutorial sobre cómo eliminar una categoría.

Parece que sería relevante/útil incluir esto en el modal donde puedes ver el botón para eliminar categorías.

Podría ser un enlace, pero no tiene por qué ser solo un enlace en cada caso: podría ser un botón de signo de interrogación que enlace al documento, o podría ser “Leer más…”, etc.

El equipo de Discourse podría revisar la documentación, comenzando por las más importantes, y determinar dónde en el software sería el lugar más relevante para enlazar esa documentación.

(También conocido como “justo a tiempo”)

Otros ejemplos de software

Ghost (un software de blogs de código abierto) tiene un par de lugares donde sus documentos están vinculados, justo cuando los necesitas.

Por ejemplo, este botón “Más información” enlaza al documento relevante:

Lo mismo ocurre aquí:

No estaba seguro de si esto encajaba en Feature o UX, siéntete libre de moverlo.

5 Me gusta

Discreparé ligeramente con eso. Hay diferentes alcances de contenido de ayuda que puedes crear. Si seguimos el modelo Diátaxis, son tutoriales, guías prácticas, referencias y explicaciones.

Los tutoriales probablemente tengan un lugar para ser enlazados en la propia aplicación, de modo que si entras en una página con la intención de “quiero aprender cómo funciona esto”, puedas aprenderlo, incluso si la página no es autoexplicativa. Quizás incluso un centro de tutoriales que te permita completar un curso sobre el software si lo deseas.

Las otras 3 categorías me causan algunos problemas.

Si voy a la página de configuración de categorías, podría haber 20 cosas diferentes que quiera hacer. Poner una guía práctica allí resultaría en una lista que tendría que buscar, y debido a que tengo la expectativa de que lo que busco no tendrá necesariamente un artículo dedicado, probablemente escribiré esa pregunta en Google en lugar de buscar en la lista.

Las referencias externas son una plaga con la que tengo que lidiar a diario. Tenemos un “manual de referencia” que te dirá qué hace cada control deslizante y botón, hasta:

Botón Cancelar: Cierra el cuadro de diálogo sin aplicar los cambios
Botón Aceptar: Cierra el cuadro de diálogo, aplicando los cambios

Usar esta referencia significa que tienes que desplazarte por mucha información técnica antes de llegar a tu sección, cuando lo que realmente necesitabas era una descripción emergente que reformulara una opción con algunas palabras más.

Si intento eliminar una categoría, el comportamiento actual es casi deseable. Veo el botón, generalmente atenuado pero con un signo de interrogación, y si hago clic en él, dice:

No se puede eliminar esta categoría porque tiene subcategorías.

o:

No se puede eliminar esta categoría porque tiene 25852 temas. El tema más antiguo es…

El comportamiento es bueno, sé qué está mal y cuál es mi siguiente paso: eliminar un montón de publicaciones y subcategorías. No mejoraría enlazando a la guía práctica de “eliminar una categoría” en su lugar.

Por supuesto, sigue siendo una solución temporal al problema real: ¿Por qué no me deja eliminar una categoría con publicaciones dentro? Puedo eliminar carpetas con subcarpetas y archivos en mi sistema, ¿por qué no puedo eliminar categorías con subcategorías y publicaciones? Si no tuviera estas extrañas restricciones, no habría necesidad de una guía práctica en la aplicación en primer lugar.

Y por último, las explicaciones: eso es lo que es la publicación de blog “entendiendo los niveles de confianza”. Cuando la encontré por primera vez, fue bastante confusa: “¿es una publicación de blog aleatoria de hace 6 años realmente lo mejor que tienes como documentación?” - y enlaza a un artículo de referencia que enumera todas las cosas en una tabla, lo que estaba más en línea con lo que esperaba (aunque no ordenado de la manera que esperaba). Las explicaciones no me ayudan a resolver una tarea directamente, por lo que ponerlas en un lugar donde se completaría una tarea no funciona muy bien.


Creo que, en última instancia, si bien la documentación es importante en algunos lugares (por ejemplo, al incorporar usuarios o en casos en los que el diseño falla), es realmente el diseño el que debería ser el enfoque principal. Leer o ver un video en el que alguien te explica el sitio web rara vez es la experiencia deseada.

5 Me gusta

Sí, como antiguo estudiante de diseño de juegos, estoy totalmente de acuerdo contigo. (Recuerdo que eres diseñador de Audacity. Por cierto, uso Audacity mucho, ¡estoy muy agradecido por ello!)

Creo también que toda la experiencia podría replantearse desde cero (empezando por pensar: “¿qué le gustaría hacer a un administrador y cómo podemos ayudarle mejor a hacerlo?” para todos los casos de uso) para que los procesos se transmitan mucho mejor y también para que los procesos en sí sean lo más sencillos posible.

Para el ejemplo de no permitirte eliminar una categoría si hay temas en ella, una forma más elegante de que el software lo maneje podría ser la siguiente. Cuando intentas eliminar una categoría con temas en ella, primero podría sugerirte si te gustaría:

  • mover todos los temas existentes a otra categoría, o
  • poner todos los temas existentes en Sin categorizar, o
  • eliminar todos los temas de la categoría

y luego confirmar que deseas eliminar la categoría.

Supongo que, dado que el equipo de Discourse se decantaba por cambios más incrementales en esta etapa:

Estaba pidiendo algo más fácil de conseguir: añadir algunos enlaces a la documentación más popular/común/importante donde fuera más relevante.

(También podría crear un nuevo tema más tarde para los comentarios/sugerencias de los que hemos hablado aquí, sobre la mejora de la experiencia para eliminar categorías.)

Me gusta mucho esta sugerencia. ¡Gracias por destacarla, @bloomexperiment! Actualmente estamos trabajando en mejorar la estructura general y la categorización de nuestra documentación, y creo que este tipo de función valdría la pena considerarla como parte de ese proceso. La añadiré a la hoja de ruta de la documentación como algo a explorar, y veremos cuál sería la mejor manera de implementarla.

2 Me gusta

Lamento reabrir un tema antiguo y soy muy consciente del trabajo actual que se está realizando en torno a la búsqueda de administradores y la mejora de la experiencia general de administración. Muchas veces en las últimas semanas he pensado cuánto desearía que el nombre de cada configuración del sitio fuera un enlace al tema de documentación relevante en Meta. En los últimos años, la documentación de Meta ha mejorado enormemente y ahora es bastante completa, organizada e informativa.

Ejemplo:

En el ejemplo anterior, me gustaría que “Ubicación de copia de seguridad” enlazara a un tema de Meta como Configure automatic backups for Discourse

¿Podríamos acercarnos gradualmente a una etapa en la que cada uno de estos nombres de configuración del sitio se vincule al hilo de Meta correspondiente? Puedo ver que tal vez no quieras codificar URL en el código de Discourse, pero supongo que podría estar en los textos del sitio de alguna manera.

El trabajo de hacer todos estos enlaces es bastante grande, pero ¿quizás sería posible un esfuerzo de crowdsourcing entre varios autoalojadores?

3 Me gusta