O editor de artigos permite criar conteúdos ricos e bem formatados para a Central de Ajuda. Este guia abrange todos os recursos disponíveis na barra de ferramentas.
Formatação de Texto
Negrito
Selecione o texto e clique no ícone B ou pressione o atalho Ctrl+B (Cmd+B no Mac). Ideal para destacar termos importantes.
Itálico
Selecione o texto e clique no ícone I ou pressione o atalho Ctrl+I (Cmd+I no Mac). Útil para nomes de campos, menus ou termos técnicos.
Sublinhado
Selecione o texto e clique no ícone U ou pressione o atalho Ctrl+U (Cmd+U no Mac). Use com moderação para não poluir visualmente o artigo.
Tachado
Selecione o texto e clique no ícone ~~S~~ na barra de ferramentas. Útil para indicar informações desatualizadas ou substituídas.
Código inline
Selecione o texto e clique no ícone de código (<>). O texto aparecerá com fundo destacado, ideal para nomes de variáveis, campos de API ou valores exatos como contact_id que o usuário precisa digitar.
Títulos e Estrutura
Use títulos para organizar o artigo em seções. Estão disponíveis 3 níveis:
-
H1 — Título principal (use apenas uma vez por artigo, se necessário)
-
H2 — Seções principais do artigo
-
H3 — Subseções dentro de uma seção
Dica: Uma boa estrutura de títulos ajuda o leitor a encontrar rapidamente o que procura, especialmente em artigos longos.
Listas
Lista com marcadores
Clique no ícone de lista na barra de ferramentas para criar itens com bullet points:
-
Primeiro item
-
Segundo item
-
Terceiro item
Lista numerada
Use a lista ordenada quando a sequência dos passos importa:
-
Acesse o menu de configurações
-
Clique em "Central de Ajuda"
-
Selecione o portal desejado
Links
Selecione o texto que será o link e clique no ícone de corrente na barra de ferramentas. Cole a URL de destino no campo que aparece. O link ficará clicável na FAQ publicada.
O link fica assim (esse específico te leva pro site da Cloud Humans).
Imagens
Clique no ícone de imagem na barra de ferramentas para fazer upload de uma imagem do seu computador. As imagens são úteis para ilustrar passo a passo, prints de tela e diagramas.
Atenção: Evite imagens muito pesadas. Prefira prints recortados e otimizados para que o artigo carregue rapidamente.
Citação (Blockquote)
Clique no ícone de aspas para transformar um parágrafo em citação. Citações aparecem com uma barra lateral e um fundo diferenciado. Clique novamente no ícone para remover a citação.
Exemplo de uso: destacar uma frase importante de um documento oficial ou de uma política interna.
Esse é um exemplo
Bloco de código
Clique no ícone de código com barra (</>) para inserir um bloco de código. Diferentemente do código inline, o bloco de código ocupa um espaço próprio e preserva a formatação original. Ideal para:
-
Trechos de código de integração
-
Exemplos de chamadas de API
-
Configurações em formato JSON ou YAML
O resultado fica assim
Linha Horizontal
Clique no ícone de linha (—) para inserir um separador visual entre seções. Útil para dividir temas distintos em um mesmo artigo ou para criar pausas visuais em conteúdos longos.
Blocos de Destaque (Callouts)
Os callouts são caixas coloridas que chamam a atenção para informações especiais. Clique no ícone de callout e escolha um dos 4 tipos:
Informação: Para dicas, contexto adicional ou referências úteis. Exemplo: "Essa configuração também pode ser feita via API."
Aviso: Para cuidados importantes antes de uma ação. Exemplo: "Essa alteração afeta todos os agentes da conta."
Sucesso: Para confirmar resultados esperados ou boas práticas. Exemplo: "Pronto! A integração foi ativada com sucesso."
Erro: Para alertar sobre erros comuns ou ações irreversíveis. Exemplo: "Não delete este campo, pois ele é utilizado pelas automações."
Para remover um callout, posicione o cursor dentro dele e clique novamente no ícone de callout.
Regra importante: Não é possível colocar um callout dentro de outro callout, nem dentro de uma citação (e vice-versa). Cada bloco funciona de forma independente.
Tabelas
Clique no ícone de tabela para inserir uma tabela com 3 colunas e 3 linhas (incluindo o cabeçalho).
Editando a tabela
Após inserir, clique em qualquer célula para editar o conteúdo. Use a tecla Tab para avançar para a próxima célula e a tecla Shift+Tab para voltar.
Gerenciando linhas e colunas
Clique no botão EDITAR que aparece acima da tabela para acessar as opções:
| Ação | O que faz |
|---|---|
| Adicionar linha acima | Insere uma nova linha acima da atual |
| Adicionar linha abaixo | Insere uma nova linha abaixo da atual |
| Adicionar coluna à esquerda | Insere uma nova coluna à esquerda |
| Adicionar coluna à direita | Insere uma nova coluna à direita |
| Remover linha | Remove a linha onde o cursor está |
| Remover coluna | Remove a coluna onde o cursor está |
| Excluir tabela | Remove a tabela inteira |
Redimensionando colunas
Passe o mouse sobre a borda entre duas colunas no cabeçalho. O cursor mudará para uma seta dupla. Clique e arraste para ajustar a largura.
Tabelas largas: Se a tabela tiver muitas colunas, ela exibirá scroll horizontal na FAQ publicada para manter a legibilidade em telas menores.
Copiar e colar de outros editores
O editor reconhece automaticamente conteúdo colado de outras fontes:
| Fonte | O que acontece |
|---|---|
| Google Docs | Formatação é preservada (negrito, itálico, links, listas) |
| Notion | Estrutura de blocos é convertida automaticamente |
| GitHub / README | Markdown é interpretado e formatado |
| Páginas web | HTML é convertido em formatação do editor |
Você não precisa reformatar manualmente — basta copiar e colar.
Atalhos de Teclado
| Atalho | Ação |
|---|---|
| Ctrl+B / Cmd+B | Negrito |
| Ctrl+I / Cmd+I | Itálico |
| Ctrl+U / Cmd+U | Sublinhado |
| Ctrl+Z / Cmd+Z | Desfazer |
| Ctrl+Shift+Z / Cmd+Shift+Z | Refazer |
| Tab (dentro de tabela) | Próxima célula |
| Shift+Tab (dentro de tabela) | Célula anterior |
Publicando o artigo
Quando o artigo estiver pronto:
-
Revise o conteúdo usando o botão Pré-visualizar
-
Na barra lateral, selecione a Categoria correta
-
Preencha o Meta título e a Meta descrição para melhorar o SEO
-
Clique em Publicar
Pronto! Após a publicação, o artigo ficará disponível imediatamente na Central de Ajuda pública. Você pode editar a qualquer momento sem precisar despublicar.