Pontuação
Pontue a documentação da Azion: vírgula em série, travessões e hifens, pontuação de títulos e listas, espaçamento e os símbolos a evitar.
Use a vírgula em série no inglês
Em uma lista de três ou mais itens em inglês, coloque uma vírgula antes da conjunção.
- Incorreto:
Applications, Firewall and Edge DNS - Correto:
Applications, Firewall, and Edge DNS
Essa vírgula final remove uma ambiguidade que o leitor teria de resolver sozinho. Em português a norma é o contrário: não use vírgula antes do e em uma enumeração simples.
- Correto:
Applications, Firewall e Edge DNS
Prefira um ponto ao travessão
O travessão substitui um ponto, dois-pontos ou uma vírgula, e um desses três quase sempre é mais claro. Recorra a eles primeiro.
- Antes:
O cache responde à requisição — a origem nunca a recebe. - Depois:
O cache responde à requisição. A origem nunca a recebe.
Em português, o travessão que separa uma oração leva espaço de cada lado. Em inglês não leva espaço nenhum.
Travessões usados para dar ênfase são o padrão a evitar, e Escolha de palavras cobre essa família. Esta é uma regra de escrita, não um defeito de revisão: ninguém sinaliza um travessão isolado.
Use o traço médio em um intervalo
O traço médio une as pontas de um intervalo de tempo ou de quantidade, sem espaço de nenhum lado.
- Incorreto:
50 - 70% - Correto:
50–70%
Escreva o intervalo com palavras quando uma preposição já o abriu: de 50% a 70%, nunca de 50–70%.
Hifenize um modificador composto em inglês
Em inglês, duas palavras que modificam um substantivo juntas levam hífen, sem espaços.
| Incorreto | Correto |
|---|---|
real time logging | real-time logging |
read only bucket | read-only bucket |
O hífen desaparece quando as palavras não modificam um substantivo: the bucket is read only.
Em português, o hífen segue o Acordo Ortográfico e não acompanha o inglês. Mantenha os termos técnicos em inglês na forma original.
Não use reticências nem ponto de exclamação
As reticências pedem que o leitor complete o raciocínio. A documentação completa o raciocínio.
O ponto de exclamação adiciona volume, não informação. Ele também soa promocional, o que Voz da documentação descarta.
A exceção é a saída citada. Quando Azion Console ou um comando imprime um desses sinais, cite exatamente.
Deixe títulos e URLs sem pontuação
- Sem pontuação final em um título, um cabeçalho ou um rótulo de menu lateral.
- Sem dois-pontos dentro de um título.
Configurações de cache: uma visão geralviraConfigurações de cache. - Sem ponto no fim de uma URL, porque o leitor copia o último caractere.
Pontue um item de lista pelo tamanho
- Um item com quatro palavras ou mais termina com ponto.
- Um item com três palavras ou menos não leva pontuação final.
- Todos os itens de uma lista seguem a mesma escolha, então listas mistas são reescritas.
Uma célula de tabela segue a mesma regra: uma célula que é uma frase termina com ponto, e uma célula que é um valor ou um fragmento não termina.
Use dois-pontos para introduzir, e evite o ponto e vírgula
Dois-pontos introduzem uma lista, um procedimento ou um bloco de código. Use maiúscula depois de dois-pontos apenas quando uma lista se segue; no texto corrido, mantenha minúscula.
- Correto:
Você precisa de três coisas: uma conta, um token e um domínio. - Correto:
Para criar o bucket:
Evite o ponto e vírgula. Um ponto e vírgula que une duas orações são duas frases, e um que liga um passo ao seu resultado é a frase de resultado que Procedimentos já exige.
Defina espaçamento e símbolos
| Regra | Exemplo |
|---|---|
| Um espaço depois de ponto, interrogação ou dois-pontos | Salve a regra. Faça o deploy da aplicação. |
| Sem espaço ao redor da barra | 100 km/h |
| O sinal de porcentagem gruda no número | 100% |
Escreva e, nunca & | Regras e comportamentos |