Difícil encontrar o botão de ajuda do Markdown

Certo dia, eu estava neste BBS e procurei em todo lugar,
20230315T135552

mas não consegui encontrar nenhum botão de Ajuda Markdown para explicar as regras de formatação.

Não, não estou perguntando quais são as regras.
Nem estou pedindo um link.
Estou dizendo que você precisa fornecer um link para as pessoas que estão fazendo uma postagem,
bem ao lado da caixa de texto, quando elas a estiverem editando.

Bem, ok, talvez a documentação ainda não esteja pronta para usuários comuns,

2 curtidas

A barra de ferramentas do compositor tem as opções que formatariam o texto para você e mostrariam como funcionaria se você quisesse adicionar o Markdown [1] manualmente. Isso não é mais útil do que um link que o levaria para alguma documentação fora da mensagem que você está escrevendo?


  1. e alguns BBCode dependendo do que você está adicionando ↩︎

2 curtidas

Sim. Pegue o usuário que quer dizer “

não


Bem, eventualmente ele descobre a maneira correta de fazer com que pareça “
https://www.openstreetmap.org/, não
https://www.openstreetmap.org/edit
”.
Mas não há absolutamente nenhuma maneira de ele ter descoberto isso se não tivesse que descobrir por conta própria, porque, lá no editor, é um grande mistério, com documentação zero. Zero.

2 curtidas

Estou dizendo que você precisa de um link como este azul no GitHub,

2 curtidas

Você tem uma maneira bem interessante de usar o pronome “você”, onde sempre que você quer dizer “eu”. Só dizendo.

Lá na web existem três tipos diferentes de editores ao criar conteúdo dentro de um serviço:

  • Estilo CMS como WordPress, Drupal etc., onde há um monte de botões (bem, o WordPress está fazendo tudo o que pode para quebrar o editor deles, mas essa é outra história)
  • Redes sociais minimalistas, como Facebook, Twitter etc., onde não há botões ou há apenas alguns
  • O mundo antigo do desenvolvimento, que são principalmente geradores de sites estáticos etc., e o Discourse

O primeiro grupo tenta usar a mesma lógica que os pacotes de escritório nos ensinaram antes mesmo da web. Não há um botão de ajuda real, porque todos deveriam saber o que um botão faz. Ou quais são os atalhos. E se um usuário não sabe, ele/ela/isso tem que encontrar essa informação.

As mídias sociais entenderam que o Zé Ninguém médio não precisa desses botões, porque eles não os usam — e em celulares simplesmente não há espaço. E não há botão de ajuda, porque não há necessidade para ele.

Os baseados em desenvolvimento oferecem serviço para aqueles que sabem como marcar coisas sem precisar ver acontecer, lembrar de um monte de código e não querem tirar as mãos do teclado. E não há botão de ajuda, porque todos devem ler a documentação e memorizar como fazer tabelas, por exemplo.

Mas existem usuários diferentes. No meu fórum, pessoas comuns falam sobre assuntos comuns e elas têm, na maioria, baixas habilidades tecnológicas. Aqui no Dev ou no GitHub são necessidades totalmente diferentes, e a suposição é que todos têm habilidades muito altas. Além disso, o conteúdo criado é totalmente diferente. Sou membro de um site onde a escrita em si está em destaque. Lá, novamente, são necessidades totalmente diferentes.

A questão da UX não é um botão de ajuda na caixa de ferramentas. Ninguém o usa, porque é impossível de criar e usar. E até mesmo um link no estilo GitHub é demais. É um componente totalmente irrelevante que raramente é usado e todos sabem que lá fora existem a documentação e os manuais.

A verdadeira solução de UX/UI é dar a capacidade de

  • administradores criarem padrões para usuários
  • permitir que usuários alterem os padrões

E o que a grande maioria dos usuários realmente precisa, e o que está faltando agora, é uma maneira de ocultar essa barra de ferramentas. Isso seria mais importante do que a capacidade de editá-la.

A questão do editor é quase um tópico de FAQ aqui, e um botão de ajuda é apenas parte disso. E sejamos diretos novamente. Dan tem sua agenda e o botão de ajuda é apenas mais um sinal disso, não o objetivo. Espero que Dan esteja realmente querendo dizer que ele não sabia como fazer algo e não encontrou ajuda para isso. Isso deveria ser um problema desse site, não do Discourse como plataforma em si.

2 curtidas

Sim, eu estava falando do caso da vida real onde eu estava postando

e as duas prévias de link eram as mesmas, fazendo minha postagem parecer boba.
Então eu estava lutando com a interface (Discourse), tentando descobrir uma maneira de desativar
toda essa mágica — sem documentação sobre como fazer isso.

Então tudo teve que ser tentativa e erro…

Então eu experimentei com

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

Isso dá a combinação estranha de

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

que, sim, tem sua lógica, mas esse não é o meu ponto.
Ainda não é o que eu queria que minha postagem parecesse para os outros.

Nessa altura eu pensei “Vou apenas olhar a documentação oficial em vez de horas de tentativa e erro.”
Ok, então eu procurei e procurei e encontrei Formatting posts using markdown, BBCode, and HTML .

Ok, isso mencionou o formato
[url]http://bettercallsaul.com[/url], mas com

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

algo não está funcionando:
https://www.openstreetmap.org/
https://www.openstreetmap.org/edit
Portanto, Formatting posts using markdown, BBCode, and HTML provavelmente está desatualizado, etc.

Então, como eu finalmente resolvi meu problema, usando

[https://www.openstreetmap.org/](https://www.openstreetmap.org/), não
[https://www.openstreetmap.org/edit](https://www.openstreetmap.org/edit)

para obter
https://www.openstreetmap.org/, não
https://www.openstreetmap.org/edit
Bem, eu me lembrei que vocês usam “Markdown”, e eu me lembrei que Markdown tinha essa sintaxe,
e funcionou.

Tudo
o
que
estou
dizendo
é
que
deve
haver
um
documento
oficial
em
algum
lugar
que
diga
aos
usuários
o
que
acontecerá
quando
eles
digitarem
isto
e
aquilo
caractere.
Eles
não
deveriam
precisar
ler
o
código
fonte
para
descobrir.
Obrigado.

Tudo bem, coloque em um FAQ, então vincule o FAQ à interface em algum lugar.

Ok, vamos dizer que você colocou o futuro FAQ de formatação no site do Discourse. Problema resolvido…
exceto que o usuário sequer sabe que está usando Discourse? Sim, estou falando de usuários, não de administradores. Obrigado novamente.

2 curtidas

Apenas para sua informação, existe este botão no editor que pode ajudar:

Se você colocar o URL na caixa superior e o texto de exibição na inferior, ele formatará para você em markdown. :+1:

5 curtidas

Isso é um espantalho. Talvez existam alguns desenvolvedores hardcore prestativos que memorizaram as regras de formatação e não precisam de documentação, mas nem todos os não iniciantes memorizaram todas as regras de formatação.

Com os diferentes tipos de markdown, BBCode e html suportados por diferentes instâncias do Discourse, não há um manual na documentação.

Se alguém construir um manual para o conjunto específico de códigos de marcação válidos em um site e quiser colocar um link de ajuda no estilo do github na página do compositor, como abaixo, como isso seria feito?

Vejo que isso existe:

2 curtidas

Fechado em favor de Do we need a help button on the composer?