Imagens
Adicione um screenshot só quando ele merece o lugar, mantenha dados sensíveis fora dele e dê a cada imagem seu alt text.
Use um screenshot somente quando as palavras falharam
Todo screenshot é um custo de manutenção. A interface muda sem aviso, a página fica desatualizada em silêncio e um screenshot desatualizado engana com total confiança. Adicione um somente quando as palavras sozinhas não carregaram a instrução.
O teste: se a frase nomeia o controle e a ação com clareza, o screenshot a repete. Apague o screenshot, mantenha a frase.
Mantenha informações sensíveis fora
Um screenshot nunca mostra dados reais de conta: nomes, e-mails, tokens, domínios ou identificadores. Capture uma conta de teste, ou mascare os valores antes de publicar. Um valor vazado em uma imagem é tão público quanto um valor vazado em texto, e mais difícil de encontrar depois.
Recorte para a área relevante
Capture a parte da interface que a instrução aponta, não a tela inteira. Elementos voláteis da interface — menus, avatares, banners de versão — datam a imagem e desviam a atenção do controle que importa.
Escreva alt text para cada imagem
O alt text declara o que a imagem transmite, em uma frase. As regras estão em Acessibilidade.
Formate o caminho do asset
Caminhos de asset são absolutos a partir da raiz, sem prefixo de idioma, porque uma imagem serve as duas versões de idioma:
- Correto:
/assets/docs/images/uploads/diagram.png
Registros históricos são isentos
Screenshots em changelogs e release notes registram como a interface era naquela data. Eles são registros de um momento: não os atualize quando a interface mudar.