Skip to content

Latest commit

 

History

History
674 lines (427 loc) · 36.1 KB

front.md

File metadata and controls

674 lines (427 loc) · 36.1 KB

Checklist para front-end

Essa é uma lista exaustiva de todos elementos que você precisa ter / testar antes de lançar seu site / página HTML em produção. Baseado no https://frontendchecklist.io.

Índice

  1. Head
  2. HTML
  3. Webfonts
  4. CSS
  5. Imagens
  6. JavaScript
  7. Segurança
  8. Performance
  9. Acessibilidade
  10. SEO

Como usar?

Todos itens na Front-End Checklist são necessários na maioria dos projetos, mas alguns elementos podem ser omitidos ou não são tão essenciais (no caso da administração de um aplicativo web, você pode não precisar de um feed RSS por exemplo). Nós escolhemos três níveis de flexibilidade:

  • ![Baixa][low_img] significa que o item é recomendado mas pode ser omitido em algumas situações em particular.
  • ![Média][medium_img] significa que o item é altamente recomendado e pode eventualmente ser omitido em alguns casos realmente particulares. Alguns elementos, se omitidos, podem ter más repercussões em termos de performance ou SEO.
  • ![Alta][high_img] significa que o item não pode ser omitido por qualquer razão. Você pode causar uma disfunção na sua página ou ter problemas com acessibilidade ou SEO. A prioridade dos testes precisa estar nestes elementos primeiro.

Alguns recursos possuem um emoticon para ajudar você a entender qual tipo de conteúdo / ajuda você pode encontrar na checklist:

  • 📖: documentação ou artigo
  • 🛠: ferramenta online / ferramenta de teste
  • 📹: mídia ou conteúdo em vídeo

You can contribute to the Front-End Checklist App reading the README_APP file which explain everything about the project.

Head

Notas: Você pode acessar uma lista com tudo que poderia ser encontrado na <head> de um document HTML.

Meta tag

  • Doctype: ![Alta][high_img] O Doctype é HTML5 e está no topo de todas as suas páginas HTML.
<!doctype html> <!-- HTML5 -->

As próximas 3 meta tags (Charset, X-UA Compatible e Viewport) precisam vir primeiro no head.

  • Charset: ![Alta][high_img] O charset declarado (UTF-8) é corretamente declarado.
<!-- Determine o encoding de caracteres para o document -->
<meta charset="utf-8">
  • X-UA-Compatible: ![Média][medium_img] A meta tag X-UA-Compatible está presente.
<!-- Instrua o Internet Explorer a usar seu mais recente engine de renderização -->
<meta http-equiv="x-ua-compatible" content="ie=edge">
  • Viewport: ![Alta][high_img] A viewport é corretamente declarada.
<!-- Viewport para web design responsivo -->
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
  • Title: ![Alta][high_img] Um título é usado em todas páginas (SEO: Google calcula a largura em píxel dos caracteres usados no título, cortados entre 472 e 482 píxels. O limite médio de caracteres seria em torno de 55-caracteres).
<!-- Título do Document -->
<title>Título de Página menor que 55 caracteres</title>
  • Descrição: ![Alta][high_img] Uma meta decrição é providenciada, é única e não possui mais de 150 caracteres.
<!-- Meta Descrição -->
<meta name="description" content="Descrição da página com menos de 150 caracteres">
  • Favicons: ![Média][medium_img] Cada favicon foi criado e é exibido corretamente. Se você tem apenas um favicon.ico, ponha-o na raiz do seu site. Normalmente você não precisa usar nenhum markup. Entretanto, ainda é uma boa prática linkar ele usando o exemplo abaixo. Atualmente, o formato PNG é recomendado ao invés do formato .ico (dimensões: 32x32px).
<!-- Favicon padrão -->
<link rel="icon" type="image/x-icon" href="https://exemplo.com/favicon.ico">
<!-- Formato favicon recomendado -->
<link rel="icon" type="image/png" href="https://exemplo.com/favicon.png">
  • Apple Web App Meta: ![Baixa][low_img] Meta-tags da Apple estão presentes.
<!-- Apple Touch Icon (at least 200x200px) -->
<link rel="apple-touch-icon" href="/custom-icon.png">

<!-- To run web application in full-screen -->
<meta name="apple-mobile-web-app-capable" content="yes">

<!-- Status Bar Style (see Supported Meta Tags below for available values) -->
<!-- Has no effect unless you have the previous meta tag -->
<meta name="apple-mobile-web-app-status-bar-style" content="black">
  • Windows Tiles:![Baixa][low_img] Windows tiles estão presentes e linkadas.
<!-- Microsoft Tiles -->
<meta name="msapplication-config" content="browserconfig.xml" />

O markup xml mínimo necessário para o arquivo browserconfig.xml é como segue:

<?xml version="1.0" encoding="utf-8"?>
<browserconfig>
   <msapplication>
     <tile>
        <square70x70logo src="pequeno.png"/>
        <square150x150logo src="medio.png"/>
        <wide310x150logo src="largo.png"/>
        <square310x310logo src="grande.png"/>
     </tile>
   </msapplication>
</browserconfig>
  • Canonical: ![Média][medium_img] Use rel="canonical" para evitar conteúdo duplicado.
<!-- Ajuda a evitar problemas com conteúdo duplicado -->
<link rel="canonical" href="http://exemplo.com/2017/09/um-novo-artigo-para-ler.html">

Tags HTML

  • Atributo de linguagem: ![Alta][high_img] A tag de idioma do seu website é especificada e relacionada ao idioma atual da página.
<!-- Indicamos o idioma definido para a página atual -->
<html lang="pt-br">
  • Atributo de direção: ![Média][medium_img] A direção de leitura é especificada na tag <html> (Pode ser usada em outra tag HTML).
<!-- Indicamos a direção de leitura (rtl é sigla para right to left, isto é, da direita para a esquerda) -->
<html dir="rtl">
  • Idioma alternativo: ![Baixa][low_img] A tag de idioma alternativo do seu website é especificada e relacionada ao idioma atual da página.
<!-- Indicamos o idioma alternativo definido para a página atual -->
<link rel="alternate" href="https://es.exemplo.com/" hreflang="es">
  • Comentários condicionais: ![Baixa][low_img] Comentários condicionais são presentes para o IE se necessário.

  • RSS feed: ![Baixa][low_img] Se seu projeto é um blog ou possui artigos, foi providenciado o link do RSS.

  • CSS Crítico: ![Média][medium_img] O CSS crítico (ou "above the fold") coleta todo o CSS usado para renderizar a porção visível da página. Ele é embutido antes da chamada CSS principal e entre <style></style> numa linha única (minificado).

  • Ordem CSS: ![Alta][high_img] Todos os arquivos CSS são carregados antes de quaisquer arquivos JavaScript no <head> (Exceto no caso onde, algumas vezes, arquivos JS são carregados assíncronamente no topo da página).

Social meta

Facebook OG e Twitter Cards são, para qualquer website, altamente recomendados. As outras tags de mídia social podem ser consideradas se seu público-alvo tem uma presença em particular nelas, e você quer se assegurar de exibí-las.

  • Facebook Open Graph: ![Baixa][low_img] Todos os Facebook Open Graph (OG) estão testados e nenhum está faltando ou com informações falsas. Imagens precisam ter no mínimo 600 x 315 píxels, porém é recomendado 1200 x 630 píxels.

Notas: Usar og:image:width e og:image:height vai especificar as dimensões da imagens para o crawler para que ele renderize a imagem imediatamente sem ter que baixá-la e processá-la assíncronamente.

<meta property="og:type" content="website">
<meta property="og:url" content="https://exemplo.com/pagina.html">
<meta property="og:title" content="Título do Conteúdo">
<meta property="og:image" content="https://exemplo.com/imagem.jpg">
<meta property="og:description" content="Descrição Aqui">
<meta property="og:site_name" content="Nome do Site">
<meta property="og:locale" content="pt_BR">
<!-- As próximas tags são opcionais mas recomendadas -->
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
  • Twitter Card: ![Baixa][low_img]
<meta name="twitter:card" content="sumário">
<meta name="twitter:site" content="@conta_do_site">
<meta name="twitter:creator" content="@conta_individual">
<meta name="twitter:url" content="https://exemplo.com/pagina.html">
<meta name="twitter:title" content="Título do Conteúdo">
<meta name="twitter:description" content="Descrição de conteúdo com menos de caracteres">
<meta name="twitter:image" content="https://exemplo.com/imagem.jpg">

⬆ voltar ao topo

HTML

Melhores práticas

  • Elementos Semânticos do HTML5: ![Alta][high_img] Elementos Semânticos do HTML5 são usados apropriadamente (header, section, footer, main...).

  • Páginas de erro: ![Alta][high_img] Páginas para Erro 404 e 5xx existem. Lembre-se de que páginas de erro 5xx precisam ter seu CSS integrado (sem chamadas externas no servidor atual).

  • Noopener: ![Média][medium_img] Caso você esteja usando links externos com target="_blank", seu link deveria ter um atributo rel="noopener" para prevenir tab nabbing. Se você precisa suportar versões mais antigas do Firefox, use rel="noopener noreferrer".

  • Retirando comentários: ![Baixa][low_img] Código desnecessário precisa ser removido antes de enviar a página para produção.

Testando HTML

  • W3C compliant: ![Alta][high_img] Todas as páginas precisam ser testadas com o validador W3C para identificar possíveis problemas no código HTML.
  • HTML Lint: ![Alta][high_img] Eu uso ferramentas para me ajudar a analisar quaisquer problemas que eu poderia ter com meu código HTML.
  • Verificador de Link: ![Alta][high_img] Não há links quebrados na minha página, verifique que você não tem nenhum erro 404.
  • Teste Bloqueadores de Publicidade: ![Média][medium_img] Seu website mostra o conteúdo corretamente com adblockers habilitados (Você pode providenciar uma mensagem encorajando os usuários a desabilitar o adblocker).

⬆ voltar ao topo

Webfonts

Notas: Usar webfonts pode causar um flash de texto invisível ou sem estilização - cogite ter fontes reserva e/ou utilizar webfont loaders para controlar esse comportamento.

  • Formato de webfont: ![Alta][high_img] WOFF, WOFF2 e TTF são suportados por todos os navegadores modernos.

  • Tamanho de webfont: ![Alta][high_img] Tamanhos de webfont não excedem 2 MB (todas variantes inclusas).

  • Webfont loader: ![Low][low_img] Controle o comportamento de carregamento com um webfont loader

⬆ voltar ao topo

CSS

Notas: Dê uma olhada em Guidelines CSS e Guidelines Sass seguidas pela maioria dos desenvolvedores Front-End. Se você tem alguma dúvida sobre propriedades CSS, você pode visitar a CSS Reference. Existe também um pequeno Guia de Código para consistência.

  • Web Design Responsivo: ![Alta][high_img] O website está usando web design responsivo.
  • CSS Print: ![Média][medium_img] Uma stylesheet de impressão correta é providenciada em cada página.
  • Pré-processadores: ![Média][medium_img] Sua página está usando um pré-processador CSS (e.g. Sass).
  • ID Único: ![Alta][high_img] Se IDs são usados, eles são únicos à página.
  • Reset CSS: ![Alta][high_img] Um CSS reset (reset, normalize ou reboot) está em uso e atualizado. (Se você está usando um Framework CSS como Bootstrap ou Foundation, o Normalize já está incluído.)
  • JS prefix: ![Baixa][low_img] Todas as classes (ou id- usados em arquivos) começam com js- e não estão estilizadas nos arquivos CSS.
<div id="js-slider" class="meu-slider">
<!-- ou -->
<div id="id-usado-pelo-cms" class="js-slider meu-slider">
  • CSS embutido ou inline: ![Alta][high_img] Evite a todo custo o uso de CSS embutido em tags <style> ou inline: apenas utilizado por razões válidas (ex: background-image para slider, CSS critical).
  • Vendor prefixes: ![Alta][high_img] Prefixos CSS de vendor são usados e gerados de acordo com sua compatibilidade e suporte a navegadores.

Performance

  • Concatenação: ![Alta][high_img] Arquivos CSS são concatenados num arquivo único. (Não para HTTP/2).
  • Minificação: ![Alta][high_img] Todos arquivos CSS são minificados.
  • Non-blocking: ![Média][medium_img] Arquivos CSS precisam ser non-blocking para prevenir o DOM de tirar tempo para carregar.
  • CSS Inutilizado: ![Baixa][low_img] Remover CSS inutilizado.

Validação CSS

  • Stylelint: ![Alta][high_img] Todos arquivos CSS ou SCSS estão sem nenhum erros.

  • Web design responsivo: ![Alta][high_img] Todas as páginas foram testatas nos seguintes breakpoints: 320px, 768px, 1024px (podem ser mais / diferentes de acordo com seu analytics).

  • Validador CSS: ![Média][medium_img] O CSS foi testado e erros pertinentes foram corrigidos.

  • Navegadores Desktop: ![High][high_img] Todas as páginas foram testadas em todos os navegadores desktop atuais (Safari, Firefox, Chrome, Internet Explorer, EDGE...).
  • Navegadores Mobile: ![High][high_img] Todas as páginas foram testadas em todos os navegadores mobile atuais (Browser nativo, Chrome, Safari...).
  • SO: ![High][high_img] Todas as páginas foram testadas em todos os Sistemas Operacionais atuais (Windows, Android, iOS, Mac...).
  • Fidelidade de design: ![High][high_img] Dependendo do projeto e da qualidade dos profissionais da área criativa, pode ser requisitado que você se mantenha próximo ao que foi desenhado. Você pode usar algumas ferramentas para comparar as criações com sua implementação de código e assegurar consistência.

Pixel Perfect - Extensão Chrome

  • Direção de leitura: ![High][high_img] Todas as páginas precisam ser testadas para idiomas LTR e RTL se elas precisarem dar esse suporte.

⬆ voltar ao topo

Imagens

Notas: Para um entendimento completo de otimização de imagem, veja o ebook grátis Essential Image Optimization, do Addy Osmani.

Melhores práticas

  • Otimização: ![Alta][high_img] Todas as imagens são otimizadas para renderização no navegador. Formato WebP poderia ser usado para páginas críticas (como a Homepage).
  • 🛠 Imagemin
  • 🛠 Use ImageOptim para otimizar suas imagens gratuitamente.
  • 🛠 Use Kraken.io como uma alternativa incrível para otimização tanto png quanto jpg. Até 1MB por arquivo no plano gratuito.
  • 🛠 TinyPNG otimize sem perdas imagens png, apng (png animado) e jpg. Versões gratuita e paga estão disponíveis.
  • 🛠 ZorroSVG compressão similar à do jpg para imagens transparentes usando mascaramento de svg.
  • 🛠 SVGO uma ferramenta baseada em Nodejs para otimização de arquivos de gráficos vetoriais SVG.
  • 🛠 SVGOMG uma versão GUI web do SVGO para otimização dos seus svgs online.
  • Picture/Srcset: ![Medium][medium_img] Você usa picture/srcset para providenciar a imagem mais apropriada para o viewport atual do usuário.
  • Retina: ![Baixa][low_img] Você providencia imagens em layout x2 ou 3x, e suporta retina display.
  • Sprite: ![Média][medium_img] Imagens pequenas estão num arquivo sprite (no caso de ícones, eles podem estar num sprite SVG).
  • Altura e Largura: ![Alta][high_img] Determine os atributos width e height em <img> se a imagem final renderizada é conhecida (pode ser omitido para CSS sizing).
  • Texto alternativo: ![High][high_img] Todas as tags <img> têm um texto alternativo que descreve a imagem visualmente.
  • Lazy loading: ![Média][medium_img] Imagens são carregadas de modo lazy, ou seja, por demanda (Um fallback para noscript é sempre providenciado).

⬆ voltar ao topo

JavaScript

Melhores práticas

  • JavaScript Inline: ![Alta][high_img] Você não tem nenhum código JavaSScript inline (misturado com seu código HTML, por exemplo).
  • Concatenação: ![Alta][high_img] Arquivos JavaScript são concatenados.
  • Minificação: ![Alta][high_img] Arquivos JavaScript são minificados (você pode adicionar o sufixo .min).
  • Segurança JavaScript: ![High][high_img]
  • Tag noscript: ![Medium][medium_img] Use a tag <noscript> no body do HTML se um tipo de script na página não for suportado ou se scripting em geral está atualmente desabilitado no navegador. Isto ajudará em renderização client-side de aplicações pesadas como React.js, veja exemplos.
<noscript>
  Você precisa habilitar JavaScript para rodar esta aplicação.
</noscript>
  • Non-blocking: ![Média][medium_img] Arquivos JavaScript são carregados assíncronamente usando atributo async ou deferidos usando atributo defer.
  • Bibliotecas JS Otimizadas e atualizadas: ![Medium][medium_img] Todas as bibliotecas JavaScript usadas no projeto são necessárias (prefira Vanilla JavaScript (JS puro) para funcionalidades simples), atualizadas para sua versão mais atual e não sobrecarregam seu JavaScript com métodos desnecessários.
  • Modernizr: ![Baixa][low_img] Se você precisa visar features específicas, é possível usar um Modernizr custom para adicionar classes na sua tag <html>.

Validação JavaScript

  • ESLint: ![Alta][high_img] Nenhum erro é visível pelo ESLint (baseando-se nas sua configuração ou regras pré-estabelecidas).

⬆ voltar ao topo

Segurança

Scaneie e cheque seu website

Melhores práticas

  • HTTPS: ![Média][medium_img] HTTPS é usado em todas as páginas e para todo conteúdo externo (plugins, imagens...).
  • HTTP Strict Transport Security (HSTS): ![Média][medium_img] O header HTTP está configurado com 'Strict-Transport-Security'.
  • Cross Site Request Forgery (CSRF): ![Alta][high_img] Você certifica requests feitas pro seu server-side são legítimas e originadas do seu website / app para prevenir ataques CSRF.
  • Cross Site Scripting (XSS): ![Alta][high_img] Sua página ou website está livre de possíveis problemas com XSS.
  • Content Type Options ![Média][medium_img] Previne Google Chrome e Internet Explorer de tentar aplicar mime-sniff no content-type de uma response em relação ao que foi declarado no server.
  • X-Frame-Options (XFO) ![Média][medium_img] Protege seus visitantes contra ataques clickjacking.
  • Política de Segurança de Conteúdo ![Medium][medium_img] Define como o conteúdo é carregado no seu site e de onde é permitido que seja carregado. Pode também ser usada para se proteger contra ataques de clickjacking.

⬆ voltar ao topo

Performance

Melhores práticas

  • Peso por página: ![Alta][high_img] O peso de cada página está entre 0 e 500 KB.
  • Minificado: ![Média][medium_img] Seu HTML está minificado.

  • Lazy loading: ![Média][medium_img] Imagens, scripts e CSS precisam ser carregados de modo lazy para melhorar o tempo de resposta da página atual (Veja detalhes nas seções respectivas).

  • Tamanho dos Cookies: ![Medium][medium_img] Se você está usando cookies, certifique-se de que cada cookie não excede 4096 bytes e que seu domain name não tem mais de 20 cookies.

  • Componentes de terceiros: ![Medium][medium_img] Iframes ou componentes de terceiros que dependam em JavaScript externo (como botões de compartilhamento) são substituidos por componentes estáticos quando possível, assim limitando chamadas a APIs externas, e mantendo privadas as atividades de seus usuários.

Preparando requisições a caminho

  • Resolução DNS: ![Baixa][low_img] DNS de serviços de terceiros que podem ser necessários são adiantadamente preparados durante tempo ocioso, usando dns-prefetch.
<link rel="dns-prefetch" href="https://exemplo.com">
  • Preconnection: ![Baixa][low_img] DNS lookup, TCP handshake e negociação TLS com serviços que serão necessários em breve, são ambos feitos adiantadamente durante tempo ocioso, usando preconnect.
<link rel="preconnect" href="https://exemplo.com">
  • Prefetching: ![Baixa][low_img] Recursos que serão necessários em breve (ex.: imagens em lazy loading) são requisitados adiantadamente durante tempo ocioso, usando prefetch.
<link rel="prefetch" href="image.png">
  • Preloading: ![Baixa][low_img] Recursos necessários na página atual (ex.: scripts colocados no fim do <body>) adiantadamente usando preload.
<link rel="preload" href="app.js">

Testes de Performance

  • Google PageSpeed: ![Alta][high_img] Todas suas páginas foram testadas (não só a homepage) e têm um score de pelo menos 90/100.

⬆ voltar ao topo

Acessibilidade

Notas: Você pode assistir a playlist A11ycasts com Rob Dodson 📹

Melhores práticas

  • Melhoramento progressivo: ![Média][medium_img] Funcionalidades extensivas como a navegação principal e busca deveriam funcionar sem JavaScript habilitado.
  • Contraste de cor: ![Média][medium_img] Contraste de cores deveria pelo menos passar WCAG AA (AAA para mobile).

Cabeçalhos

  • H1: ![Alta][high_img] Todas as páginas têm uma tag H1 que não é o título do website.
  • Cabeçalhos: ![Alta][high_img] Cabeçalhos deveriam ser usados apropriadamente, na ordem correta (H1 até H6).

Landmarks

  • Banner role: ![Alta][high_img] <header> tem role="banner".
  • Navigation role: ![Alta][high_img] <nav> tem role="navigation".
  • Main role: ![Alta][high_img] <main> tem role="main".

Semântica

  • Inputs HTML5 específicos são utilizados: ![Média][medium_img] Isto é especialmente importante para dispositivos mobile, que mostram keypads e widgets customizados para diferentes tipos de input.

Formulários

  • Label: ![Alta][high_img] Uma label é associada a cada input de um formulário. Caso uma label não possa ser exibida, use aria-label.

Testes de Acessibilidade

  • Testando padrões de Acessibilidade: ![Alta][high_img] Use a ferramenta WAVE para testar se sua página respeita os padrões de acessibilidade.
  • Navegação por Teclado: ![Alta][high_img] Teste seu website usando apenas seu teclado numa ordem previsível. Todos elementos interativos são alcançáveis e utilizáveis.
  • Screen-reader: ![Média][medium_img] Todas as páginas foram testadas num screen-reader (VoiceOver, ChromeVox, NVDA ou Lynx).
  • Estilo de Foco: ![Alta][high_img] Se o foco está desabilitado, ele é substituído por um estado visível em CSS.

⬆ voltar ao topo

SEO

  • Google Analytics: ![High][high_img] Google Analytics está instalado e corretamente configurado.
  • Lógica de cabeçalhos: ![Medium][medium_img] Os textos de cabeçalho ajudam a entender o conteúdo na página atual.
  • sitemap.xml: ![High][high_img] Um sitemap.xml existe e foi submetido ao Google Search Console (anteriormente Google Webmaster Tools).
  • robots.txt: ![High][high_img] O robots.txt não está bloqueando páginas da web.
  • Dados Estruturados: ![Alta][high_img] Páginas usando dados estruturados são testadas e não possuem erros. Dados estruturados ajudam crawlers a entender o conteúdo da página atual.
  • Sitemap HTML: ![Média][medium_img] Um sitemap HTML é providenciado e acessível via um link no rodapé do seu website.
  • Tags para links de Paginação: ![Medium][medium_img] Providencie rel="prev" e rel="next" para indicar conteúdo pagiado
<!-- Exemplo: Tags para links de paginação para a segunda página de uma lista paginada -->
<link rel="prev" href="https://exemplo.com/?page=1">
<link rel="next" href="https://exemplo.com/?page=3">

⬆ voltar ao topo

Saiba como contribuir