Guias de Estilo

Local: en-US

Caso de uso: Produto SaaS B2B – Centro de Assistência e UI

# Guia de Estilo: EN-US – Artigos do Centro de Assistência

## 1. Propósito e Escopo

Este guia de estilo define os padrões de escrita para toda a **documentação do Centro de Assistência** em **inglês (Estados Unidos)**.

Aplica-se a:

- Artigos de como fazer  
- Explicações de recursos  
- Guias de solução de problemas  
- Entradas de FAQ  

**Público-alvo:** usuários profissionais de SaaS em funções técnicas e de negócios  
**Objetivo:** ajudar os usuários a concluir tarefas de forma rápida, confiante e sem confusão.

---

## 2. Voz e Tom

O conteúdo do Centro de Assistência deve soar:

- **Claro e profissional**
- **Apoiado e focado em soluções**
- **Confiante, não promocional**

Escrevemos como um guia ajudando os usuários a ter sucesso — não como uma cópia de marketing.

### Princípios de Tom

| Fazer | Não Fazer |
|---|------|
| Seja calmo e direto | Não seja excessivamente casual ou falador |
| Foque nos próximos passos | Foque apenas no que deu errado |
| Use linguagem neutra | Use sarcasmo ou humor |

**Exemplos**

- ✅ “Se a conexão falhar, verifique seu token da API e tente novamente.”  
- ❌ “Seu token está errado. Corrija-o.” ## 3.

---

## 3. ### 3.1 Dirija-se diretamente ao leitor

Use **você** para tornar as instruções claras.

- ✅ “Você pode gerenciar usuários a partir da página de admin.”

- ❌ “Usuários podem ser gerenciados a partir da página de admin.”  
### 3.2 Prefira a voz ativa

---

A voz ativa é mais curta e mais fácil de seguir.

- ✅ “Selecione **Salvar alterações**.”

- ❌ “Salvar alterações deve ser selecionado.”  
### 3.3 Mantenha as frases concisas

---

- Busque por **25 palavras ou menos**

- Uma ideia principal por frase

- Divida explicações longas em etapas ou tópicos

---

### 3.4 Use linguagem simples

Evite complexidade desnecessária.

- ✅ “Inicie um novo projeto.”  
- ❌ “Inicie a criação de um novo projeto.”

---

## 4. Terminologia e Consistência

### 4.1 Use termos aprovados

Use nomes de produtos e recursos exatamente como definidos.

- Mantenha a capitalização consistente  
- Não invente sinônimos para conceitos-chave  

**Exemplo**

- ✅ “espaço de trabalho”  
- ❌ “espaço,” “área de projeto,” “ambiente”

---

### 4.2 Defina siglas incomuns

Termos comuns (API, URL) não precisam de definição.  
Siglas internas ou incomuns devem ser explicadas na primeira utilização.

- ✅ “Logon Único (SSO)”  
- ❌ “SSO” sem contexto

---

### 4.3 Convenções do inglês dos EUA

Sempre use **grafia em inglês dos EUA**.

- ✅ “customize,” “behavior”  
- ❌ “personalise,” “comportamento”

---

## 5. Padrões de Formatação & Markdown

### 5.1 Títulos

Use títulos claros e baseados em tarefas.

- ✅ “Redefina sua senha”  
- ❌ “Visão geral do processo de redefinição de senha”

Hierarquia de títulos:

- `#` Título do artigo  
- `##` Seções principais  
- `###` Subseções apenas quando necessário  

---

### 5.2 Listas

Use listas numeradas para sequências:

1. Abra **Configurações**  
2. Selecione **Cobrança**  
3. Escolha **Alterar plano**  

Use marcadores para opções:

- Administradores podem gerenciar usuários  
- Editores podem atualizar conteúdo  

---

### 5.3 Elementos da UI

Formate os rótulos da UI de forma consistente:

- Botões: **negrito**
- Caminhos de navegação: use setas

Exemplo:

Vá para **Configurações → Faturamento → Alterar plano**.

---

### 5.4 Links

Os links devem descrever o destino.

- ✅ “Veja o guia de faturamento”  
- ❌ “Clique aqui”

---

## 6. Estrutura Padrão do Artigo

Todo artigo do Centro de Assistência deve seguir esta estrutura:

### 1. Sumário

Comece com 1–2 frases explicando o resultado.

> Este artigo explica como alterar seu plano de assinatura.

---

### 2. Pré-requisitos (opcional)

Liste os requisitos de forma clara.

- Permissões de admin  
- Assinatura ativa  

---

### 3. Instruções passo a passo

As etapas devem ser:

- Orientadas para ação  
- Uma ação por etapa  
- Escritas como comandos  

Exemplo:

1. Vá para **Configurações**.  
2. Selecione **Cobrança**.  
3. Escolha **Alterar plano**.  

---

### 4. Resultado esperado

Diga ao usuário o que deve acontecer.

> Seu novo plano entra em vigor imediatamente após a confirmação.

---

### 5. Próximas etapas (opcional)

Forneça ações ou links relacionados.

- Gerenciar faturas  
- Atualizar método de pagamento  

---

## 7. Solução de problemas e erros

### 7.1 Seja tranquilizador

- ✅ "Não conseguimos conectar." Por favor, tente novamente.  
- ❌ "Conexão falhou." Erro crítico.

---

### 7.2 Foque em soluções

Sempre inclua o que o usuário deve fazer a seguir.

- Verifique as credenciais  
- Confirme as permissões  
- Contate o suporte se necessário  

---

### 7.3 Nunca culpe o usuário

Evite linguagem como:

- "Você fez algo errado"  
- "Entrada inválida" (sem explicação)

Preferencial:

> "O token pode estar expirado." Gere um novo e tente novamente.

---

## 8. Resumo de Faça / Não Faça

### Faça

- Escreva conteúdo focado em tarefas e baseado em etapas  
- Use terminologia consistente  
- Mantenha as frases curtas e diretas  
- Use títulos e links descritivos  
- Mantenha um tom calmo e de apoio  

### Não faça

- Adicione linguagem de marketing  
- Use expressões idiomáticas ou gírias  
- Misture termos para o mesmo conceito  
- Culpe o usuário na solução de problemas  
- Escreva parágrafos longos sem estrutura  

---

## Exemplo (Preferido)

Para alterar seu plano:

1. Vá para **Configurações → Faturamento**  
2. Selecione **Alterar plano**  
3. Escolha uma opção e selecione **Confirmar**