Anti-padrões em blogs de software: o que faz leitores desistirem

Tese e o problema do começo

Michael Lynch, autor do blog Refactoring English e de um livro sobre escrita para desenvolvedores, sustenta que blogs de software perdem leitores por padrões de erro recorrentes. Ele os reúne como anti-padrões, no sentido usado em engenharia de software. O mais comum, segundo ele, é a introdução que divaga. O leitor de software tem muitos outros textos disponíveis e quer saber, já no título e nas três primeiras frases, se o artigo foi escrito para alguém como ele e que benefício terá. Lynch dá como exemplo um artigo sobre um padrão de testes em Go que promete ensinar a técnica em 30 segundos. Elementos como subtítulo, biografia, imagem ou citação famosa também consomem a atenção do leitor e devem ser usados com moderação.

Pressupor conhecimento e depender de links

Outro erro é supor que o leitor conhece o que o autor conhece. Lynch cita um texto sobre Docker que trata cgroups e jails do *BSD como termos familiares. Para corrigir isso, ele sugere imaginar uma pessoa real, listar os termos que ela reconheceria e revisar o texto a partir dessa lista. Relacionado a isso está o uso excessivo de links. Colocar um link em um termo desconhecido não resolve o problema, porque o leitor não quer abandonar o texto para ler outra página, às vezes muito longa. A alternativa é dar, no próprio texto, a explicação mínima necessária. Os links continuam úteis, mas como complemento, não como pré-requisito.

Continuações e formalidade

Lynch critica textos que começam como continuação de uma série e pressupõem que o leitor leu a parte anterior. Ele admite que algumas séries são necessárias, por exemplo em um projeto grande, mas afirma que a maioria poderia ser artigos independentes com cerca de 3% de esforço a mais, resumindo o que é relevante do texto anterior.

Sobre o tom, ele aponta a formalidade excessiva como equívoco comum entre iniciantes, que escrevem como se estivessem redigindo um documento jurídico. Para o autor, o público de software é pouco pretensioso, e a escrita deve soar como fala. Ele cita um trecho de Joel Spolsky como exemplo de estilo casual e menciona também Kathy Sierra, Terence Eden e Raymond Chen. Lynch observa que, com muitos desenvolvedores delegando a escrita à IA, o blog técnico tende a ficar homogêneo, e os leitores buscam personalidade.

Renderização, celular e legibilidade

Na parte técnica, Lynch aponta o estouro de layout em celulares, causado por imagens ou trechos de código com tamanho de desktop, o que obriga o leitor a rolar a tela para os dois lados. Recomenda testar o texto no modo de visualização mobile do Firefox ou do Chrome antes de publicar. Segundo os dados de analytics do autor, 25% dos leitores dessa página a acessam pelo celular, e no seu blog pessoal a proporção é de 35%.

Sobre fonte e cor, ele critica o texto cinza escuro sobre fundo cinza claro e indica as ferramentas de contraste desses navegadores. Também sugere a fonte Atkinson Hyperlegible, gratuita e desenvolvida pelo Braille Institute, que o autor considera confortável para leitura, inclusive por pessoas com baixa visão.

Conclusão

O resumo final reúne as recomendações: dar um motivo claro para continuar lendo logo no início, questionar o que o leitor já sabe, não depender de links nem de textos anteriores, escrever como se fala e testar o artigo no celular e quanto ao contraste.