Executando verificação de segurança...
Respondendo a "Concordo com a ideia geral, principalmente sobr..." dentro da publicação Boas Práticas pra Documentos em Markdown
3
kevinmarquesp

Poxa, então não consegui transmitir o que penso dessas "regras". No primeiro parágrafo mensionei que essa lista são convensões minhas, e no último tentei reforçar a ideia. Mas valeu ai pelo comentário e por compartilhar sua visão! E outra, também enxergo boas práticas desse jeito, porque se fossem regras se chamariam "regras". 😜

Sobre a questão das tabelas, eu tirei direto do repositório com os styleguides que me basiei, tive que listar aqui porque lidar com tabela – principalmente quando o editor não ajuda – é uma parada que me irrita bastante, então prefiro seguir o que disseram de usar listas no lugar. Mas assim, listas legíveis, só escrever os dados um do lado do outro é simplesmente pior que a tabela numa tela de celular, eu faria sua tabela assim:

  1. United States Hartsfield–Jackson Atlanta International Airport

    • Location: Atlanta, Georgia (United States)
    • Code (IATA/ICAO): ATL/KATL
    • Total passengers: 104,653,451
    • Rank change: 0
    • % change: ↑ 11.7%

  2. United Arab Emirates Dubai International Airport

    • Location: Garhoud, Dubai, Dubai AUnited Arab Emirates
    • Code (IATA/ICAO): DXB/OMDB
    • Total passengers: 86,994,365
    • Rank change: ↑ 3
    • % change: ↑ 31.7%

  3. United States Dallas Fort Worth International Airport

    • Location: Dallas–Fort Worth, Texas (United States)
    • Code (IATA/ICAO): DFW/KDFW
    • Total passengers: 81,755,538
    • Rank change: ↓ 1
    • % change: ↑ 11.4%

E sobre o limite de caracteres por linha, eu prefiro sempre limitar a 80 ou um pouco mais porque eu nunca sei que será a próxima pessoa que vai ler o que estou escrevendo, então meio 80 caracteres é meio que universalmente legível. Além disso, mesmo usando um monitor com resolução 1920x1080 – e com a DPI baixa, gosto de letrinha – ainda me beneficio com linhas curtas, porque quando eu abro uma janela com o terminal pra escrever e outras duas com o Firefox o texto continua legível, sem quebras de linhas estranhas, ou sem ele desaparecer na direita.

Eu sei que dá pra ativar/desativar o line wrap em todos os editores, em Vim isso é ainda mais conveniente, mas eu ainda prefiro respeitar esse limite pra caber o maximo de informação possível na tela.

Carregando publicação patrocinada...
2
kht

É, essa lista não ficou tão ruim quanto a minha. Tabela não ficou bom aqui, mas é por causa da forma como o site gerou o HTML. Se tivesse um scroll lateral sem truncar tanto as colunas, ficaria melhor.

Ainda sim, pra esse caso específico prefiro a tabela. Primeiro porque não preciso repetir "Location", "Code", etc pra cada item, e pelo menos pra mim, fica mais fácil achar as informações e comparar uns com os outros, já que os mesmos dados ficam na mesma coluna. Por exemplo, consigo ver o total de passageiros de todos em uma única "escaneada" pela respectiva coluna, o que é mais difícil com a lista.

Enfim, cai no que eu falei: dá pra achar soluções com listas e tabelas, e ambos possuem vantagens e desvantagens. Eu prefiro sugerir que se analise e pense sobre isso em vez de seguir regras rígidas do tipo "não use X".

2
kevinmarquesp
Autor
Autor

Sim, sim. Já até mudei algumas dessas palavrinhas nas minhas notas – acho não vou editar essa publicação porque você levantou uns tópicos super importantes, ai teus comentários não fariam muito sentido.

Essa é só a primeira parte de um artigo que vou fazer no futuro algum dia, só escrevi o material sobre a sintaxe de Markdown e afins. Na conclusão terá um tópico dedicado só pra invalidar tudo o que eu disse, pra dizer que cada caso é um caso e tudo tem vantagens e desvantagens como tu disse.

Valeu ai pela força!