Pular para o conteúdo principal

Guia de Estilo

Este guia estabelece os padrões de estilo e formatação para manter consistência na documentação n8n Brasil.

Tom de Voz​

Princípios Gerais​

  • Técnico e preciso: Use linguagem clara e técnica
  • Inclusivo: Evite jargões desnecessários e seja acessível
  • Profissional: Mantenha um tom institucional mas amigável
  • Contextualizado: Adapte exemplos para o contexto brasileiro

Linguagem Inclusiva​

  • Use "pessoas desenvolvedoras" em vez de "desenvolvedores"
  • Prefira "usuários" ou "pessoas usuárias"
  • Evite gêneros específicos quando possível
  • Use "você" para criar proximidade

Formatação​

Títulos e Subtítulos​

# <ion-icon name="document-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Título Principal (H1)
## <ion-icon name="chevron-forward-outline" style={{ fontSize: '24px', color: '#ea4b71' }}></ion-icon> Seção Principal (H2)
### Subseção (H3)
#### Tópico Específico (H4)

Destaques e Alertas​

:::tip[**Dica Importante**]
Conteúdo útil para o usuário
:::

:::warning[**Atenção**]
Aviso sobre algo importante
:::

:::danger[**Cuidado**]
Informação crítica ou perigosa
:::

:::info[**Informação**]
Dados adicionais ou contexto
:::

Listas​

- Item simples
- **Item em negrito**
- Item com [link](./exemplo)

1. Item numerado
2. **Item numerado em negrito**
3. Item com `código inline`

Código e Exemplos​

Blocos de Código​

```json
{
  "exemplo": "de configuração JSON"
}

// Exemplo de código JavaScript
function exemplo() {
  return "código bem formatado";
}


### **Código Inline**
```markdown
Use `comando` para executar no terminal
Configure a variável `N8N_BASIC_AUTH_ACTIVE`

Tabelas​

Estrutura Padrão​

| Campo | Tipo | Descrição | Obrigatório |
|-------|------|-----------|-------------|
| `url` | string | URL do webhook | Sim |
| `method` | string | Método HTTP | Não |
| `headers` | object | Cabeçalhos customizados | Não |

Tabelas de Integração​

Para integrações, use sempre:

  • Campo: Nome do campo/parâmetro
  • Tipo: Tipo de dado esperado
  • Descrição: Explicação clara do propósito
  • Obrigatório: Sim/Não

Imagens e Screenshots​

Padrões de Nomenclatura​

interface-n8n.png
workflow-exemplo.png
configuracao-webhook.png

Formatação​

![Descrição da imagem](./caminho/para/imagem.png)

**Figura 1:** Interface principal do n8n

Requisitos​

  • Use formato PNG ou JPG
  • Mantenha resolução adequada (mínimo 800px de largura)
  • Inclua descrição acessível
  • Otimize o tamanho do arquivo

Links e Referências​

[Guia de Instalação](./guia-instalacao)
[Configuração de Webhooks](../integracoes/webhook)

[Documentação Oficial n8n](https://docs.n8n.io)
[GitHub do Projeto](https://github.com/n8n-io/n8n)

[API de Pagamentos](https://api.mercadopago.com/docs)

Componentes Customizados​

IonicIcon​

<ion-icon name="checkmark-outline" style={{ fontSize: '24px', color: '#10b981' }}></ion-icon>

HighlightCard​

<HighlightCard 
  title="Destaque Importante"
  description="Informação relevante para o usuário"
  type="success"
/>

CardGrid​

<CardGrid>
  <ArticleCard 
    title="Título do Card"
    description="Descrição do conteúdo"
    link="./caminho"
  />
</CardGrid>

Checklist de Qualidade​

Antes de submeter uma contribuição, verifique:

  • Tom de voz adequado e inclusivo
  • Formatação consistente com o guia
  • Links funcionando e atualizados
  • Código bem formatado e testado
  • Imagens com descrição acessível
  • Tabelas seguindo o padrão estabelecido
  • Componentes usando a sintaxe correta
  • Contextualização para o Brasil quando aplicável

Seguir estes padrões garante uma documentação consistente e profissional para toda a comunidade!