Títulos

Use maiúscula só na primeira palavra

Em um heading, apenas a primeira palavra e os nomes próprios começam com maiúscula.

• Incorreto: Configure Políticas De Cache
• Correto: Configure políticas de cache

A capitalização por palavra exige uma decisão a cada palavra, e essas decisões divergem entre as páginas. A maiúscula única remove as decisões, e os headings ficam consistentes nos dois idiomas.

Um nome de produto mantém as maiúsculas em qualquer posição, porque é um nome próprio.

Comece com um verbo no imperativo

Um heading que nomeia uma tarefa começa com o verbo no imperativo, nunca com gerúndio.

• Incorreto: Criando um bucket
• Correto: Crie um bucket

Três razões sustentam a regra:

• Gerúndios traduzem de forma inconsistente como primeira palavra de um heading. O guia de estilo para desenvolvedores do Google os proíbe por essa razão, e esta documentação publica cada página em dois idiomas.
• O heading fica no mesmo registro dos passos abaixo dele, que Estrutura de frases define como imperativo. O leitor percorre uma voz, não duas.

Em inglês, duas formas em -ing continuam corretas. Uma palavra em -ing que nomeia uma coisa é um substantivo, e por isso Getting started e Billing permanecem. Uma palavra em -ing mais adiante no heading também é válida: Introduction to request logging.

Comece o corpo em ##

O campo title do frontmatter renderiza o único H1 da página. O corpo começa em ##, e um # no corpo cria um segundo H1 e quebra a estrutura da página.

Não pule níveis

Os níveis de heading avançam um de cada vez: ### sob ##, e #### sob ###. Um salto de ## para #### sugere um nível que não existe, e leitores e ferramentas perdem a estrutura.

Nomeie a coisa, não a seção

Um heading rotula o conteúdo, não a posição na página. Limites diz o que a seção contém. Passo 1 diz apenas onde a seção está, e não diz nada quando a seção aparece sozinha.

Escreva headings que funcionam como buscas

Um sistema de busca retorna uma seção da página, não a página inteira. O heading diz ao sistema e ao leitor o que a seção responde. Configure o TTL de cache corresponde ao que uma pessoa com essa tarefa digita. Configuração corresponde a quase tudo e, por isso, não recupera nada em particular.

• Incorreto: Configuração
• Correto: Configure o TTL de cache

Use uma sigla em um título só quando a página a expande

Um título pode carregar uma sigla consagrada, desde que a primeira linha abaixo dele escreva o termo por extenso. Configure conjuntos de regras do WAF é um título válido quando o parágrafo abaixo escreve Web Application Firewall (WAF).

Escolha de palavras tem a regra de expansão para o resto da página.

Escreva código em um heading como texto simples

Um heading não carrega código inline. Uma mensagem de erro, um comando ou um identificador em um heading mantém a própria grafia e perde as crases: 403 Forbidden em requisições legítimas, não `403 Forbidden` em requisições legítimas. As crases renderizam um chip de código com controle de cópia, que quebra a linha do heading e o acompanha até o sumário. Um heading é um rótulo, não algo para copiar.

Duas mecânicas decorrem disso. Uma string que termina em ponto perde o ponto, porque um heading não tem pontuação final. Um <placeholder> solto em um heading é interpretado como uma tag e quebra o build, então nomeie o que ele representa.

Mantenha emojis fora dos títulos

Sem emojis em títulos, headings ou rótulos da barra lateral. Emojis quebram a indexação de busca, leem mal em leitores de tela e renderizam de forma inconsistente entre plataformas.