Terminologia da documentação

Use os nomes de produto da documentação

Todo produto tem um nome de documentação, e toda página usa esse nome. Busque o nome atual na página de visão geral do produto, a raiz da seção. Este guia não repete os nomes, porque uma cópia fica errada no dia em que um nome muda.

Quando um nome de marketing difere do nome da documentação, escreva o nome de marketing uma vez, entre parênteses, na primeira menção. Depois disso, o nome da documentação aparece sozinho.

A Azion renomeou seus produtos e recursos de plataforma ao longo do tempo. Os nomes antigos ainda aparecem em páginas antigas, URLs e nomes de diretórios, e por isso parecem atuais. Trate esses nomes como história, não como sinônimos.

Nomeie o recurso em que o leitor trabalha

A Azion descreve o que oferece com quatro termos (Platform, Product, Platform Resource e Feature). Eles são conceitos relacionados, não quatro níveis de uma hierarquia: um recurso pode ou não ser um produto, e uma feature pode pertencer à plataforma ou a um recurso.

Um produto é uma decisão de go-to-market, não um teste de cobrança: ele não precisa ser vendido nem medido sozinho. Uma feature sempre tem escopo, então diga se ela vale para a plataforma ou para um recurso.

A documentação escreve na nomenclatura de recurso da plataforma: ela nomeia o que o leitor cria ou gerencia, e liga esse recurso ao produto com um verbo. O nome do produto, em Title Case, aparece onde a página fala da oferta: o título da seção, a primeira menção e o bloco de definição de uma visão geral.

Applications, Firewall, Connectors, Workloads, Custom Pages e Certificate Manager são tipos de recurso da plataforma, não produtos. A coisa que o leitor cria é uma instância, em minúscula: uma aplicação, um firewall, um connector.

• Correto: Configure um firewall para proteger a aplicação.
• Correto: Web Application Firewall (WAF) inspeciona as requisições que chegam a um firewall. Aplique um conjunto de regras WAF ao firewall.
• Incorreto: Firewall é um produto que inclui o WAF.
• Incorreto: WAF é um módulo do Firewall.
• Correto: a linha da sidebar que abre o WAF dentro de Firewall diz WAF, nunca Firewall WAF nem Web Application Firewall, porque um rótulo nunca repete o pai.

As palavras módulo e add-on estão aposentadas. O que uma página chamava de módulo é um produto habilitado em um recurso, como Application Accelerator, Image Processor, WAF ou Network Shield. Também pode ser uma feature de um recurso, como Tiered Cache, ou uma função instanciada em uma aplicação ou em um firewall. A aposentadoria cobre a classificação de uma oferta da Azion, e nada mais. Modules continua onde o Console mostra, dentro de um caminho de cliques: Na seção **Modules**, ative o Application Accelerator. Um módulo JavaScript, um módulo ES e um campo de API como modules.application_accelerator mantêm seus nomes.

Azion Console, a API, a CLI e o Terraform Provider são as interfaces da plataforma, não recursos. Um campo ou uma opção de um recurso é uma configuração, não uma feature.

Use verbo no singular com um nome de forma plural

Um nome de produto ou de tipo de recurso nomeia uma coisa só, qualquer que seja a forma. Applications, Functions e Connectors levam verbo no singular: Applications armazena conteúdo em cache, Functions executa seu código — nunca Applications armazenam. O inglês concorda da mesma forma: Applications caches content, nunca Applications cache.

Escreva em minúscula a coisa que o cliente constrói

O nome do produto e o nome do tipo de recurso levam maiúscula. A coisa que o cliente cria com eles é um substantivo comum, e fica em minúscula.

• Correto: Use **Applications** para construir suas próprias aplicações.
• Correto: **Functions** executa suas funções na infraestrutura distribuída da Azion.
• Incorreto: Faça o deploy da sua primeira Application.

A distinção mantém o nome do tipo com significado. Uma página que escreve os dois em maiúscula deixa o leitor sem saber o que é o tipo e o que é a instância.

Mantenha nomes históricos em documentos históricos

Changelogs, release notes e contratos datados registram o que era verdade no dia da publicação. Esses documentos mantêm os nomes de produto da época da publicação. Um Termos de Serviço de 2020 mantém os nomes que eram corretos em 2020.

Não renomeie produtos em um documento histórico. Um nome atualizado reescreve o registro e separa o texto da sua data.

Deixe estes termos em inglês

Estes termos são vocabulário técnico genérico, não nomes de produto. Eles ficam em inglês nos dois idiomas:

data center · serverless · on-premise · template · compliance · e-commerce · e-mail · keywords · meta description

Uma tradução cria um segundo nome para um conceito que o leitor já conhece em inglês. A documentação usa um termo para cada conceito, em todas as páginas.