# Regra de escrita técnica Mintlify
## Contexto do projeto
- Este é um projeto de documentação na plataforma Mintlify
- Usamos arquivos MDX com frontmatter YAML
- A navegação é configurada em `docs.json`
- Seguimos as melhores práticas de escrita técnica
## Padrões de escrita
- Use segunda pessoa ("você") para instruções
- Escreva em voz ativa e tempo presente
- Comece procedimentos com pré-requisitos
- Inclua resultados esperados para etapas principais
- Use cabeçalhos descritivos e ricos em palavras-chave
- Mantenha frases concisas mas informativas
## Estrutura de página obrigatória
Toda página deve começar com frontmatter:
```yaml
---
title: "Título claro e específico"
description: "Descrição concisa para SEO e navegação"
---
```
## Componentes Mintlify
### Callouts
- `<Note>` para informações suplementares úteis
- `<Warning>` para avisos importantes e mudanças que quebram compatibilidade
- `<Tip>` para melhores práticas e conselhos de especialistas
- `<Info>` para informações contextuais neutras
- `<Check>` para confirmações de sucesso
### Exemplos de código
- Quando apropriado, inclua exemplos completos e executáveis
- Use `<CodeGroup>` para exemplos de múltiplas linguagens
- Especifique tags de idioma em todos os blocos de código
- Inclua dados realistas, não espaços reservados
- Use `<RequestExample>` e `<ResponseExample>` para documentação de API
### Procedimentos
- Use o componente `<Steps>` para instruções sequenciais
- Inclua etapas de verificação com componentes `<Check>` quando relevante
- Divida procedimentos complexos em etapas menores
### Organização de conteúdo
- Use `<Tabs>` para conteúdo específico de plataforma
- Use `<Accordion>` para divulgação progressiva
- Use `<Card>` e `<CardGroup>` para destacar conteúdo
- Envolva imagens em componentes `<Frame>` com texto alternativo descritivo
## Requisitos de documentação da API
- Documente todos os parâmetros com `<ParamField>`
- Mostre estrutura de resposta com `<ResponseField>`
- Inclua exemplos de sucesso e erro
- Use `<Expandable>` para propriedades de objeto aninhadas
- Sempre inclua exemplos de autenticação
## Padrões de qualidade
- Teste todos os exemplos de código antes de publicar
- Use caminhos relativos para links internos
- Inclua texto alternativo para todas as imagens
- Garanta hierarquia adequada de cabeçalhos (comece com h2)
- Verifique padrões existentes para consistência
