Difícil encontrar el botón de ayuda de Markdown

Justo el otro día estaba en este BBS, y busqué por todas partes,
20230315T135552

pero no pude encontrar ningún botón de Ayuda de Markdown para explicar las reglas de formato.

No, no estoy preguntando cuáles son las reglas.
Tampoco estoy pidiendo un enlace.
Estoy diciendo que necesitas proporcionar un enlace a las personas que hacen una publicación,
justo al lado del cuadro de texto, cuando la están editando.

Bueno, está bien, tal vez la documentación aún no esté lista para los usuarios promedio,

2 Me gusta

La barra de herramientas del compositor tiene las opciones que formatearían el texto por ti y te mostrarían cómo funcionaría si quisieras añadir Markdown [1] manualmente. ¿No es esto más útil que un enlace que te llevaría a alguna documentación fuera del mensaje que estás escribiendo?


  1. y algo de BBCode dependiendo de lo que estés añadiendo ↩︎

2 Me gusta

Sí. Toma al usuario que quiere decir «

no

»
Bueno, eventualmente descubre la forma correcta de hacerlo parecer «
https://www.openstreetmap.org/, no
https://www.openstreetmap.org/edit
».
Pero no hay absolutamente ninguna manera de que pudiera haberlo descubierto si no hubiera tenido que descubrirlo por sí mismo, porque, allí en el editor, es un gran misterio, con cero documentación. Cero.

2 Me gusta

Estoy diciendo que necesitas un enlace como este azul en GitHub,

2 Me gusta

Tienes una forma bastante interesante de usar un usuario, él o tú cada vez que te refieres a mí. Solo digo.

Ahí fuera en la Web hay tres tipos diferentes de editores al crear contenido dentro de un servicio:

  • Estilo CMS como WordPress, Drupal, etc., donde hay toneladas de botones (bueno, WordPress está haciendo todo lo posible para romper su editor, pero esa es otra historia)
  • SoMe minimalista, como Facebook, Twitter, etc., donde no hay botones o solo hay unos pocos
  • El antiguo mundo del desarrollo, que son en su mayoría generadores de sitios estáticos, etc., y Discourse

El primer grupo intenta usar la misma lógica que los paquetes de oficina nos enseñaron incluso antes de la web. No hay un botón de ayuda real, porque todos deberían saber qué hace un botón. O cuáles son los atajos. Y si un usuario no lo sabe, tiene que encontrar esa información.

Las redes sociales han entendido que el ciudadano medio no necesita esos botones, porque no los usa, y en los móviles simplemente no hay espacio. Y no hay botón de ayuda, porque no hay necesidad de él.

Los basados en el desarrollo ofrecen servicio a quienes saben cómo marcar cosas sin necesidad de verlo suceder, recuerdan un montón de código y no quieren quitar las manos del teclado. Y no hay botón de ayuda, porque todos deben leer la documentación y memorizar cómo hacer tablas, por ejemplo.

Pero hay usuarios diferentes. En mi foro, la gente común habla de asuntos comunes y en su mayoría tienen habilidades tecnológicas de bajo nivel. Aquí en Dev o en GitHub hay necesidades totalmente diferentes, y se asume que todos tienen habilidades muy altas. Además, el contenido creado es totalmente diferente. Soy miembro de un sitio donde la escritura en sí misma es el foco. Allí, de nuevo, hay necesidades totalmente diferentes.

La pregunta de la experiencia de usuario no es un botón de ayuda en la caja de herramientas. Nadie lo usa, porque es imposible de crear y usar. E incluso un enlace al estilo de GitHub es demasiado. Es un componente totalmente irrelevante que rara vez se usa y todos saben que ahí fuera están la documentación y los manuales.

La solución real de UX/UI es dar la capacidad a

  • los administradores de crear valores predeterminados para los usuarios
  • permitir a los usuarios cambiar los valores predeterminados

Y lo que la gran mayoría de los usuarios realmente necesita, y lo que falta ahora, es una forma de ocultar esa barra de herramientas. Eso sería más importante que la capacidad de editarla.

La cuestión del editor es casi un tema de preguntas frecuentes aquí, y un botón de ayuda es solo una parte de él. Y seamos claros de nuevo. Dan tiene su agenda y el botón de ayuda es solo otra señal de ello, no el objetivo. Espero que Dan realmente esté tratando de decir que no sabía cómo hacer algo y no encontró ayuda para ello. Ese debería ser un problema de ese sitio, no de Discourse como plataforma en sí.

2 Me gusta

Sí, estaba hablando del caso de la vida real en el que estaba publicando

y las dos vistas previas de los enlaces eran las mismas, lo que hacía que mi publicación pareciera tonta.
Así que estuve luchando con la interfaz (de Discourse), tratando de encontrar una manera de deshabilitar
toda esa magia, sin documentación sobre cómo hacerlo.

Así que todo tuvo que ser prueba y error…

Luego experimenté con

https://www.openstreetmap.org/ .
https://www.openstreetmap.org/edit .

Esto da la extraña combinación de

https://www.openstreetmap.org/ .
OpenStreetMap .

que, sí, tiene su lógica, pero ese no es mi punto.
Todavía no es lo que quería que pareciera mi publicación para los demás.

Para entonces pensé: “Simplemente miraré la documentación oficial en lugar de pasar horas de prueba y error”.
OK, así que busqué y busqué y encontré Formatting posts using markdown, BBCode, and HTML .

OK, eso mencionó el
[url]http://bettercallsaul.com[/url]
formato, pero con

[url]https://www.openstreetmap.org/[/url]
[url]https://www.openstreetmap.org/edit[/url]

algo no funciona:
https://www.openstreetmap.org/
https://www.openstreetmap.org/edit
Por lo tanto, Formatting posts using markdown, BBCode, and HTML probablemente está desactualizado, etc.

Entonces, ¿cómo resolví finalmente mi problema, usando

[https://www.openstreetmap.org/](https://www.openstreetmap.org/), no
[https://www.openstreetmap.org/edit](https://www.openstreetmap.org/edit)

para obtener
https://www.openstreetmap.org/, no
https://www.openstreetmap.org/edit
Bueno, recordé que ustedes usan “Markdown”, y recordé que Markdown tenía esa sintaxis,
y funcionó.

Todo
lo
que
estoy
diciendo
es
que
debería
haber
un
documento
oficial
en
algún
lugar
que
diga
a
los
usuarios
qué
sucederá
cuando
escriban
este
y
aquel
carácter.
No
deberían
necesitar
leer
el
código
fuente
para
descubrirlo.
Gracias.

Bien, ponlo en una sección de preguntas frecuentes (FAQ), luego enlaza la FAQ a la interfaz en algún lugar.

OK, digamos que pones la futura FAQ de formato en el sitio web de Discourse. Problema resuelto…
excepto que, ¿cómo sabe el usuario que está usando Discourse? Sí, estoy hablando de usuarios, no de administradores. Gracias de nuevo.

2 Me gusta

Solo como información, pero hay un botón en el editor que puede ayudar:

Si pones la URL en el cuadro superior y el texto a mostrar en el inferior, te lo formateará en markdown. :+1:

5 Me gusta

Esto es un hombre de paja. Quizás haya algunos desarrolladores muy dedicados y serviciales que tengan las reglas de formato memorizadas y no necesiten documentación, pero no todos los que no son principiantes tienen todas las reglas de formato memorizadas.

Con los diferentes tipos de markdown, BBCode y html compatibles con las diferentes instancias de Discourse, no hay un manual en la documentación.

Si alguien crea un manual para el conjunto particular de códigos de marcado válidos en un sitio y quiere poner un enlace de ayuda al estilo de GitHub en la página del compositor, como se muestra a continuación, ¿cómo se podría lograr?

Veo que esto existe:

2 Me gusta

Cerrado en favor de Do we need a help button on the composer?