Em documentações, quando uma abreviação não for comum ao público, escreva-a na primeira menção e coloque-a entre parênteses logo em seguida.

Correto ✅	Incorreto ❌
O Sistema de Gerenciamento de Conteúdo (CMS) é uma funcionalidade voltada para o gerenciamento de conteúdo de forma prática e constante.	CMS (Content Management System, em português, Sistema de Gerenciamento de Conteúdo) é uma funcionalidade voltada para o gerenciamento de conteúdo de forma prática e constante.

As seguintes abreviações raramente precisam ser explicitadas:

• API
• Formatos de arquivos (PDF, XML)
• HTML
• RAM
• REST
• MB, GB
• URL

Evite usar "i.e." e "e.g.". Essas abreviações não boas para localização e acessibilidade. Prefira escrever de forma clara e direta.

Correto ✅	Incorreto ❌
Nesta função, crie um objeto de evento especificando o tipo desejado (por exemplo, ‘purchase’) e chame sendAnalyticsEvent.	Nesta função, crie um objeto de evento especificando o tipo desejado (e.g., ‘purchase’) e chame sendAnalyticsEvent.

Embora seja comum usar “Nº”, “nº” ou “no.” como abreviação de “número” em português, a abreviação correta e recomendada é “N.º” (ou “n.º” se estiver no meio da frase), com ponto. Outras abreviações aceitas são “núm.” ou “n.”. Ao abreviar “número” em português, é fundamental incluir o ponto após a letra “N” para manter a precisão e a consistência. Essa abordagem obedece às convenções tipográficas estabelecidas na escrita portuguesa.

Correto ✅	Incorreto ❌
N.º da nota fiscal Pedido n.º XXX	Nº. da nota fiscal Pedido nº XXX

Use letras maiúsculas para os acrônimos.

Correto ✅	Incorreto ❌
ID do lojista Copiar URL para a área de transferência	id do lojista Copiar url para a área de transferência

Não crie acrônimos para nome de produtos e funcionalidades.

Correto ✅	Incorreto ❌
Delivery Promise (Beta) é ideal para todos os tipos de operações.	DP (Beta) é ideal para todos os tipos de operações.

Ao colocar acrônimos e abreviações no plural, trate-os como palavras normais.

Correto ✅	Incorreto ❌
O mapeamento de URL é usado para redirecionar URLs específicas para outras URLs. Este tipo de aplicativo permite que você crie integrações entre serviços usando APIs REST ou crie APIs GraphQL para usar dados em componentes React personalizados.	O mapeamento de URL é usado para redirecionar URL específicas para outras URL. Este tipo de aplicativo permite que você crie integrações entre serviços usando API REST ou crie API GraphQL para usar dados em componentes React personalizados.

Prefira usar formatos de arquivo em letras maiúsculas. Ao especificar extensões de arquivo, use letras minúsculas (exemplo: ‘faststore.config.js’).

Correto ✅	Incorreto ❌
Você pode configurar sinônimos individualmente ou importando uma planilha no formato CSV. package.json: arquivo JSON que descreve as dependências, comandos de script para build e detalhes da versão.	Você pode configurar sinônimos individualmente ou importando uma planilha no formato .csv. package.JSON: arquivo json que descreve as dependências, comandos de script para build e detalhes da versão.