Acessibilidade
Este breve guia aborda vários aspectos de acessibilidade que devem ser levados em conta ao escrever ou editar publicações na rede Codidact. Há muitas deficiências diferentes por aí, e essas dicas abrangem a acessibilidade para muitas delas, como pessoas que usam leitores de tela, usuários de teclado, usuários daltônicos e pessoas com deficiências cognitivas.
Tabela de conteúdo
Formatação
Headings
Os títulos são usados para separar seções de informações. Cada título deve fornecer uma indicação decente do que pode ser esperado naquela seção. (Por exemplo, o título "cabeçalhos" antes desta seção é uma boa dica de que esta seção é sobre cabeçalhos.)
-
Siga uma ordem de cabeçalho intuitiva.
Não pule de um
<h2>para um<h5>; siga uma ordem consistente e intuitiva para os cabeçalhos, em que as seções de nível superior têm um cabeçalho de nível superior e as subseções têm um cabeçalho de nível inferior. Você não deve pular níveis de cabeçalhos (por exemplo, passar de um<h2>para um<h4>sem um<h3>no meio)
No entanto, ao encerrar uma subseção e voltar para uma seção de nível superior, é possível passar de um cabeçalho de nível baixo (como<h4>) de volta para um cabeçalho de nível superior (como<h2>) sem incluir um cabeçalho de nível médio. -
Em geral, deve haver apenas um cabeçalho de nível superior (que pode ser formatado usando
<h1>ou#) por página.Os posts na rede Codidact têm um cabeçalho de nível superior como a pergunta ou o título do artigo.
A conveniência ou não de usar outro cabeçalho de nível superior depende do tipo de publicação que você está escrevendo e de como a pergunta e as respostas estão estruturadas. As postagens que abrangem um grande número de tópicos ou que são divididas em várias seções totalmente distintas às vezes podem precisar incluir mais de um cabeçalho de nível superior, mas considere cuidadosamente se isso é realmente necessário. -
Só use títulos para títulos reais e não use títulos para conteúdo que não seja de cabeçalho.
Se algo funciona como um título, deve ser marcado adequadamente como um título, usando as tags Markdown ou HTML apropriadas. O oposto também é verdadeiro: se algo não estiver funcionando como um título, não deve ser formatado como um título. Se você quiser enfatizar algo, não use títulos para fazer isso.
Os leitores de tela e similares podem pular de um título para outro (inclusive descrevendo o nível do título), portanto, tenha isso em mente ao escolher os títulos para suas postagens.
Exemplos
Uma boa ordem de títulos segue o layout lógico da página, sem pular níveis, usa consistentemente os títulos do mesmo nível para seções do mesmo nível e usa apenas títulos para o conteúdo real do título.
// Exemplo de uma boa ordem de títulos <h1>Título da pergunta (fornecido automaticamente)<h1> <h2>Seção de resposta 1</h2> <h3>Resposta subseção 1a</h3> <h3>Responda a subseção 1b</h3> <h2>Responda a seção 2</h2> <h3>Responda à subseção 2a</h3> <h3>Responda a subseção 2b</h3> <h4>Responda à subseção 2b.1</h4> <h4>Responda à subseção 2b.2</h4> <h2>Responda à seção 3</h2>
A ordem do cabeçalho acima mostra uma resposta que não usa um cabeçalho de nível superior (<h1>), pois já existe um na página - o título da pergunta. Ele usa <h2> para diferenciar suas seções de alto nível. Em seguida, usa <h3> para as subseções e, quando é necessário ter uma sub-subseção, usa <h4>.
Uma ordem de cabeçalho ruim pularia níveis, usaria cabeçalhos para conteúdo que não fosse de cabeçalho ou usaria desnecessariamente cabeçalhos de nível superior em excesso.
// Exemplo de uma ordem de cabeçalho ruim <h1>Título da pergunta (fornecido automaticamente)</h1> <h1>Resumo da resposta (conteúdo real)</h1> <h3>Seção de resposta 1</h3> <h5>Responda à subseção 1a</h5> <h4>Responda a subseção 1b</h4> <h2>Responda a seção 2</h2> <h4>Notas</h4> <h1>Obrigado pela leitura!/h1>
Este exemplo ruim usa <h1> duas vezes na resposta, apesar de já haver um cabeçalho de nível superior como título da pergunta. Ele usa um título <h1> para o resumo da resposta, usando um título para conteúdo sem título. Em seguida, ele usa níveis de título extremamente inconsistentes para suas diferentes seções e subseções e pula níveis de títulos (como passar diretamente de <h3> para <h5>).
Texto enfatizado
O texto enfatizado, como negrito ou itálico, é bom para chamar a atenção para palavras-chave ou frases. No entanto, se for usado em excesso, ele acaba anulando seu próprio objetivo e tornando a postagem mais difícil de ler em vez de mais clara.
-
O texto em negrito deve ser usado com moderação.
Só use-o para destacar palavras ou frases que realmente precisam de atenção especial.
-
Os itálicos devem ser usados somente quando for apropriado usá-los.
O itálico é usado para enfatizar a ênfase em uma determinada palavra, colocar em itálico os nomes de obras, indicar palavras em idiomas estrangeiros e outros usos padrão do itálico. Não use itálico em excesso em um texto que não precisa ser itálico; lembre-se de que o itálico pode dificultar a leitura do texto para determinadas pessoas, inclusive para algumas pessoas com dislexia.
-
Evite colocar negrito ou itálico em parágrafos inteiros.
Marcação de código
-
A marcação de código deve ser usada para código, incluindo nomes de variáveis e outros elementos de código que podem ser encontrados em linhas que não sejam de código.
Isso permite que o realce de código funcione e deixa claro quando um elemento de código está sendo referido.
-
A marcação de código não deve ser usada para nenhum elemento que não seja de código.
Isso inclui usá-lo para dar ênfase, para tabelas ou outro uso que não seja de código. Em vez disso, use a formatação dedicada para esses elementos. O uso incorreto da marcação de código pode causar problemas para a tecnologia de assistência, como leitores de tela.
Tamanho do texto
-
Não empilhe subscritos ou superscritos para tornar seu texto pequeno.
Usar o sobrescrito ou o subscrito uma vez é suficiente e somente quando necessário. Os leitores de tela podem não diferenciar entre subscrito ou sobrescrito e texto normal, portanto, tenha isso em mente.
O Codidact tem notas de rodapé integradas disponíveis, portanto você deve evitar o uso de sub e superscript para notas de rodapé; em vez disso, use o Markdown dedicado.
Tabelas
-
Se possível, evite colocar dados ambíguos em tabelas - ou seja, ter dados aos quais você não pode dizer a qual coluna da tabela eles estariam associados sem verificar, como ter duas colunas contendo números simples.
-
Evite linhas de cabeçalho em branco nas tabelas e não use formatação de tabela para dados que não pertençam de fato a uma tabela.
Imagens
Texto alternativo (alt)
-
Sempre que incluir uma imagem em uma publicação, você deve incluir um texto alternativo (comumente chamado de "texto alternativo") que tenha a mesma finalidade que a imagem.
Isso substitui o texto padrão de "Image_alt_text". Isso é usado por leitores de tela, mecanismos de pesquisa e quando as imagens não podem ser exibidas (como imagens bloqueadas em determinados países ou por redes de escolas/empresas).
-
O texto alternativo deve ser curto, sucinto e servir exatamente ao mesmo propósito da imagem - ele não deve conter mais ou menos informações do que a própria imagem.
Como forma geral de garantir que seu texto alternativo seja apropriado, considere se as informações presentes na postagem seriam alteradas se a imagem fosse substituída inteiramente pelo texto alternativo. Se as informações permanecerem as mesmas, você está pronto para ir.
Imagens decorativas
- Uma imagem decorativa, que não serve a nenhum outro propósito além do visual, deve ter seu texto alternativo totalmente em branco.
Observe que isso é em branco, não ausente. Do ponto de vista da codificação, isso significa definir seu atributo alt como ="", e não deixar de fora o atributo alt.
Em geral, você deve evitar incluir imagens que não sirvam a nenhum propósito específico ou que sejam apenas decorativas em sua postagem.
Se você incluir uma imagem decorativa, certifique-se de que ela não esteja formatada como um link, deixando apenas a imagem incorporada, e defina o texto alternativo como em branco.
Recurso estável (imagens locais)
Para evitar a possibilidade de imagens mortas e garantir que essa postagem permaneça estável pelo maior tempo possível, você deve evitar o uso de um serviço externo de hospedagem de imagens. Em vez disso, use o carregador de imagens interno da Rede Codidact. Isso significa que a imagem é armazenada em nossos próprios servidores, em vez de depender de outra pessoa.
Exemplos
Vamos usar o seguinte trecho de uma publicação como exemplo:
Quando você for editar uma publicação, agora terá a opção de marcar o botão "redigir":
(Fonte: "O que devo fazer quando me deparo com PII em uma publicação?" por Mithical no Codidact Meta, licenciado sob CC BY-SA-NC 4.0)
Neste exemplo, a imagem está sendo usada para ilustrar o novo botão e o que ele faz. Essas informações também precisam ser apresentadas no texto alternativo, o que o texto alternativo atual faz:
Isso é curto e direto ao ponto. Ele informa a qualquer pessoa que não possa ver a imagem quais informações são mostradas com a caixa de seleção, e é por isso que a captura de tela foi incluída.
Um exemplo ruim seria deixar de fora o texto alternativo, ter um texto alternativo muito longo ou depender de um serviço externo de hospedagem de imagens:
.
No primeiro exemplo ruim, não há texto alternativo e ele depende de um serviço de imagem externo. Não há nenhuma informação apresentada para quem não pode ver a imagem, e há o risco de que a imagem morra mesmo para as pessoas que podem vê-la.
No segundo exemplo ruim, o texto alternativo é muito longo. Ele contém informações que não estão presentes na imagem em si, como informações sobre o comentário de edição que aparece no histórico de revisões, e descreve informações que não são relevantes para o objetivo da captura de tela, que é simplesmente mostrar o que é apresentado quando você vai redigir uma postagem.
Não confie apenas na cor
Quando sua imagem usar cores para indicar uma diferença entre as coisas - como em um gráfico ou tabela - você também deverá usar um método diferente de diferenciação, como um ícone ou uma forma diferente. Evite também usar cores que são conhecidas por serem um problema para usuários daltônicos (como vermelho/verde).
Contraste
Evite cores muito próximas umas das outras, especialmente para texto em uma cor de fundo. Como uma maneira simples de testar, dê uma olhada na imagem sob a luz do sol - você ainda consegue vê-la?
Animações
No momento, não oferecemos suporte a nenhuma forma de desativar ou pausar animações em publicações, portanto, evite usar animações sempre que possível. Em particular, evite conteúdo intermitente (especialmente qualquer coisa que pisque mais de três vezes por segundo - não faça isso!). O conteúdo intermitente pode causar convulsões, e as animações em loop podem distrair a todos, mas especialmente as pessoas com alguma deficiência cognitiva.
Imagens de texto
-
Evite imagens de texto.
As imagens de texto não podem ter o texto selecionado, ser lidas por leitores de tela, indexadas por mecanismos de pesquisa, ter o texto ajustado em um design responsivo ou ter a fonte alterada. Isso inclui imagens de código; em vez disso, coloque o código real em sua postagem e formate-o usando a formatação de código dedicada Markdown.
Citações
-
Se estiver fazendo uma citação de algum lugar, não forneça uma imagem do texto; use o texto, formatado como uma citação em bloco (o que pode ser feito colocando um
>no início de um parágrafo) e cite sua fonte.Isso se aplica tanto a recursos on-line quanto off-line, como a Wikipedia ou um livro físico.
-
Não use formatação de código para citações.
Links
Texto do link
-
Evite textos de links como "Aqui" ou "Leia mais".
O link deve explicar sua finalidade por meio do próprio texto. Lembre-se de que os leitores de tela e ferramentas semelhantes podem pular para links específicos, mas se eles tiverem um nome como "isto", será muito mais difícil navegar até o link correto.
No entanto, não vá muito longe na outra direção; não há necessidade de transformar uma frase inteira em um link, desde que o texto do link seja descritivo e distinto. -
Em geral, o texto do link deve ser exclusivo - não use o mesmo texto de link duas vezes em uma publicação se esses links forem para lugares diferentes.
Recurso estável (Arquivo da Web)
Embora não seja exigido por nenhum padrão que eu conheça, eu o encorajaria a tomar medidas para garantir que qualquer recurso para o qual você crie um link permaneça estável, arquivando-o no Web Archive quando você criar um link para ele. (Isso é semelhante ao que a Wikipedia faz; as fontes usadas nos artigos quase sempre são arquivadas para que haja um backup.)
Tornar suas postagens compreensíveis
Vocabulário
-
Em geral, tente manter seu vocabulário simples.
Isso não significa evitar todos os termos técnicos ou não usar os termos corretos para as coisas, mas não use jargões ou palavras sofisticadas quando não for necessário. Isso facilita a compreensão de sua postagem por pessoas que não têm o inglês como primeiro idioma ou por pessoas com deficiências cognitivas.
No entanto, isso não deve ser feito às custas da precisão ou da exatidão; tenha em mente seu público-alvo. Se você estiver escrevendo para um público altamente especializado ou técnico, não deve deixar de usar a terminologia relevante; mas se estiver escrevendo para todos, usar termos relativamente simples geralmente é uma boa ideia.
Definir acrônimos e termos especializados
-
Na primeira vez em que usar um acrônimo, você deve explicitar completamente a que está se referindo.
Um exemplo comum encontrado no Codidact (CD) é exatamente isso: o acrônimo CD. No entanto, esse acrônimo também pode se referir ao comando de terminal
cd, ou à mídia física dos Compact Discs, além de outros significados. Depois de definir o que significa CD em sua postagem específica, você poderá continuar a usar o acrônimo.
Isso também se aplica a termos especializados, jargões e palavras em outros idiomas. Na primeira vez que você usar um termo especializado, defina o que ele significa ou traduza-o.
Parágrafos e quebras de frases
-
Evite paredes de texto.
Certifique-se de dividir suas publicações em seções, parágrafos e frases. Quando algo se estende por muito tempo ou é muito denso, pode ser muito difícil para as pessoas entenderem, especialmente as pessoas que não falam bem o idioma ou as pessoas com certas deficiências cognitivas.
E essas são as principais dicas para tornar sua postagem acessível! Lembre-se de que a acessibilidade é um processo contínuo, portanto, não se sinta mal se nem todas as suas publicações atenderem a essas diretrizes. Elas sempre poderão ser editadas posteriormente, e o importante é manter a acessibilidade em mente à medida que você for escrevendo e editando as publicações.