# Referência

## Propósito

Uma página de referência é material de consulta. O leitor a consulta para encontrar um valor, um campo ou um limite, e depois sai.

## Quando usar

Escreva uma página de referência quando:

- O leitor precisa consultar um campo, uma configuração, um limite ou uma flag.
- A informação é enumerável e cabe em uma tabela.

Não escreva uma página de referência quando:

- O leitor precisa de passos para uma tarefa. Escreva um [guia how-to](/pt-br/documentacao/guia-de-estilo/conteudo/guias-how-to/).
- O leitor precisa do raciocínio por trás de um design. Escreva uma [página de conceito](/pt-br/documentacao/guia-de-estilo/conteudo/conceito/).

## Registro

Descritivo: 25 palavras por frase, voz ativa, passiva apenas quando o agente é desconhecido. Tom: claro, neutro, exaustivo. [Estrutura de frases](/pt-br/documentacao/guia-de-estilo/escrita/estrutura-de-frases/) tem as regras.

## Estrutura

**Componentes obrigatórios**

- **Título**: uma expressão nominal que nomeia a coisa: `Object Storage`, `Configurações de cache`, `azion create bucket`.
- **Abertura**: uma a três frases definicionais sobre o artefato, e depois direto para os dados. Sem enquadramento de procedimento.
- **Seções**: `##`s como expressões nominais que nomeiam o objeto, o grupo de campos ou o nível real. As tabelas carregam a informação — campos, valores, padrões, limites — com fraseado consistente em cada coluna e unidade em cada número. A prosa entre as tabelas é uma ou duas frases de orientação.
- **Limites**: uma seção `## Limites` quando o produto os tem, **dimensionada por plano**. Use `| Escopo | Plano | Limite |` quando um escopo se repete entre planos, ou uma coluna por plano quando o conjunto é curto o bastante para ler na horizontal. Cada linha carrega sua unidade e diz se o limite é rígido ou ajustável.
- **Fechamento**: `## Recursos relacionados`, uma lista de `DocItem` cobrindo a página de conceito e os principais how-tos, cada linha com seu motivo.

**Componentes opcionais**

- **Asides**: uma dica acima da tabela de limites quando o suporte pode aumentar os limites, e um aviso de atenção para uma mudança de versão ou de migração. Não use outros asides.

As seções mantêm essa ordem.

Quando o conjunto de limites cresce o bastante para ser consultado sozinho, ele vai para o slot Limites da seção de produto. Estas regras não mudam: só o lugar muda. [Arquitetura de informação](/pt-br/documentacao/guia-de-estilo/conteudo/arquitetura-de-informacao/) tem a lista de slots.

## Template

Copie o template e substitua cada `<placeholder>`:

```mdx
import FrameBox from '@aziontech/webkit/frame-box'
import ItemList from '@aziontech/webkit/item-list'
import DocItem from '@aziontech/webkit/doc-item'

**<Produto ou recurso>** é <uma a três frases definicionais sobre o artefato>.

## <Objeto, grupo de campos ou nível, como expressão nominal>

<Uma ou duas frases de orientação.>

| Campo | Descrição |
| --- | --- |
| <Nome do campo> | <O que ele contém, com o valor padrão> |

## <Objeto, grupo de campos ou nível, como expressão nominal>

<...>

---

## Limites

:::tip[dica]
O suporte pode aumentar os limites marcados como ajustáveis. Entre em contato com o <link do suporte>.
:::

| Escopo | Plano | Limite | Ajustável |
| --- | --- | --- | --- |
| <Escopo> | <Nome do plano> | <Valor com a unidade> | Sim / Não |

---

## Recursos relacionados

<FrameBox>
<ItemList>
  <DocItem title="<A página de conceito>" href="<url>"><por que o leitor seguiria o link></DocItem>
  <DocItem title="<Um how-to principal>" href="<url>"><por que o leitor seguiria o link></DocItem>
</ItemList>
</FrameBox>
```

## Regras

- **Nunca um passo a passo numerado.** No momento em que um aparece, a página é um [guia how-to](/pt-br/documentacao/guia-de-estilo/conteudo/guias-how-to/) arquivado no lugar errado. Aponte para o how-to.
- **Seja completo antes de ser interessante.** Uma referência sem três de doze campos está quebrada; uma com descrições sem graça dos doze cumpre o papel.
- **Coloque informação enumerável em tabelas.** Campos, limites, flags, padrões, códigos de status.
- **Mantenha o fraseado consistente na coluna.** O leitor escaneia; fraseado variado obriga a ler.
- **Declare as unidades e os valores padrão.** Um limite sem unidade não é um fato.
- **Dimensione todo limite por plano.** Um limite que muda entre planos não é um fato só. Um número publicado sem o plano a que pertence está errado para todo leitor que está em outro plano.
- **Separe limite de valor padrão.** Um valor padrão é um campo e fica na tabela de campos. Um limite é um teto e fica em `## Limites`.
- **Diga se cada limite é rígido ou ajustável.** A próxima ação do leitor depende disso: um limite ajustável é um chamado no suporte, um limite rígido é uma restrição de design.
- **Nunca invente um limite nem um nome de plano.** Tire os dois da página de pricing, do contrato de planos ou do time de produto. Um valor que você não consegue confirmar não é publicado: estreite a tabela até as dimensões que você consegue confirmar.
- **Nunca repita um preço.** Valores, cotas vendidas por unidade e métricas de cobrança vivem só na página de pricing. Aponte para ela; não copie.
- **Sem marketing.** Diga o que faz e onde para.
- **Uma página de comando da CLI tem sua própria forma.** Um resumo de uma linha, depois `## Uso` com o comando, depois `## Flags opcionais` com uma entrada por flag.

## Exemplos

Este exemplo, em inglês, mostra a abertura definicional, uma seção de objeto com sua tabela e o fechamento de uma referência de **Object Storage**:

```mdx
import FrameBox from '@aziontech/webkit/frame-box'
import ItemList from '@aziontech/webkit/item-list'
import DocItem from '@aziontech/webkit/doc-item'

**Object Storage** is a Store product that stores objects in buckets. A bucket is the container; an object is the stored item plus its metadata. Azion stores all buckets in the _us-east_ cloud region and bills storage per GB/hour, with no minimum retention.

## Buckets

Bucket names follow these rules:

| Rule | Value |
| --- | --- |
| Length | 6 to 63 characters |
| Characters | Alphanumeric characters and hyphen |
| Reserved prefix | Must not start with `azion` |
| Uniqueness | Exclusive across all Azion accounts |

You cannot rename a bucket. You can delete a bucket only when it is empty, 24 hours after the removal of the final object.

## Related resources

<FrameBox>
<ItemList>
  <DocItem title="Create an Object Storage bucket" href="/en/documentation/guides/application-development/data/create-and-modify-bucket/">create a bucket and set its `workloads_access` permission.</DocItem>
  <DocItem title="Use a bucket as origin" href="/en/documentation/guides/application-development/data/use-bucket-as-origin/">serve content from a bucket through Connectors.</DocItem>
</ItemList>
</FrameBox>
```

Este exemplo mostra uma tabela de limites em que a separação por plano não foi confirmada. A tabela carrega as colunas que foram confirmadas e nada mais:

```mdx
## Limits

:::tip
Support can raise the limits marked raisable. Contact the [technical support team](/en/documentation/support/).
:::

| Scope | Limit | Raisable |
| --- | --- | --- |
| Buckets | 100 per account | Yes |
| S3 credential access keys | 100,000 per account | Yes |
```

A coluna ausente é o ponto. A separação por plano desses números não foi confirmada, então a tabela não tem coluna de plano, em vez de uma coluna inventada.

## Relacionados

- [Escolher um tipo de conteúdo](/pt-br/documentacao/guia-de-estilo/conteudo/escolher-um-tipo-de-conteudo.md): O catálogo completo de tipos de página.
- [Tutoriais](/pt-br/documentacao/guia-de-estilo/conteudo/tutoriais.md): O tipo de conteúdo que ensina por meio de um primeiro projeto.
- [Guias how-to](/pt-br/documentacao/guia-de-estilo/conteudo/guias-how-to.md): O tipo de conteúdo que carrega os passos.
- [Conceito](/pt-br/documentacao/guia-de-estilo/conteudo/conceito.md): O tipo de página que carrega o raciocínio.
- [Voz da documentação](/pt-br/documentacao/guia-de-estilo/escrita/voz.md): O único registro que todas as páginas usam.