Funcionalidades do editor da Central de Ajuda
Quando usar
- Você está criando ou editando um artigo na Central de Ajuda e quer conhecer todos os recursos do editor
- Você quer aprender atalhos e formatação avançada (callouts, tabelas, blocos de código)
- Você está copiando conteúdo de outras ferramentas (Google Docs, Notion) e quer saber como o editor reconhece o
formato
Pré-requisitos
- Ter permissão para criar/editar artigos na Central de Ajuda
Sobre este artigo
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 em B ou pressione Ctrl+B (Cmd+B no Mac). Ideal para destacar termos importantes.
Itálico
Selecione o texto e clique em I ou pressione 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 Ctrl+U (Cmd+U no Mac). Use com moderação para não poluir o artigo
visualmente.
Tachado
Selecione o texto e clique em ~~S~~. Útil para indicar informações desatualizadas ou substituídas.
Código inline
Selecione o texto e clique em <>. Aparece com fundo destacado, ideal para nomes de variáveis, campos de API ou valores
exatos como contact_id.
Títulos e estrutura
Use títulos para organizar o artigo. Disponíveis 3 níveis:
- H1 — Título principal (use apenas uma vez por artigo, se necessário)
- H2 — Seções principais
- H3 — Subseções dentro de uma seção
:::info Dica: uma boa estrutura de títulos ajuda o leitor a encontrar rapidamente o que procura, especialmente em
artigos longos.
:::
Listas
Com marcadores
Clique no ícone de lista para criar bullets:
- Primeiro item
- Segundo item
- Terceiro item
Numerada
Use lista ordenada quando a sequência importa:
1. Acesse o menu de configurações
2. Clique em Central de Ajuda
3. Selecione o portal desejado
Links
Selecione o texto que será o link e clique no ícone de corrente. Cole a URL no campo. O link fica clicável na FAQ
publicada.
O link fica assim (esse leva ao site da Cloud Humans).
Imagens
Clique no ícone de imagem para fazer upload do seu computador. Imagens são úteis para ilustrar passo a passo, prints e
diagramas.
:::warning Evite imagens muito pesadas. Prefira prints recortados e otimizados para que o artigo carregue rápido.
:::
Citação (blockquote)
Clique no ícone de aspas para transformar um parágrafo em citação. Aparecem com barra lateral e fundo diferenciado.
Clique novamente no ícone para remover.
Útil para destacar uma frase de um documento oficial ou política interna:
Esse é um exemplo de citação.
Bloco de código
Clique em </>. Diferente do código inline, o bloco ocupa espaço próprio e preserva a formatação. Ideal para:
- Trechos de código de integração
- Exemplos de chamadas de API
- Configurações em JSON ou YAML
O resultado fica assim
Linha horizontal
Clique no ícone — para inserir um separador entre seções. Útil para dividir temas distintos em um artigo ou criar pausas
visuais em conteúdo longo.
Blocos de destaque (callouts)
São caixas coloridas que chamam atenção para informações especiais. Clique no ícone de callout e escolha um dos 4 tipos:
:::info Informação — para dicas, contexto adicional ou referências úteis. Exemplo: "Essa configuração também pode ser
feita via API."
:::
:::warning Aviso — para cuidados importantes antes de uma ação. Exemplo: "Essa alteração afeta todos os agentes da
conta."
:::
:::success Sucesso — para confirmar resultados esperados ou boas práticas. Exemplo: "Pronto! A integração foi ativada
com sucesso."
:::
:::error 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.
:::info Regra importante: não é possível colocar um callout dentro de outro, 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 cabeçalho).
Editar a tabela
Após inserir, clique em qualquer célula para editar. Use Tab para avançar e Shift+Tab para voltar.
Gerenciar linhas e colunas
Clique no botão EDITAR acima da tabela:
| Ação | O que faz | | --- | --- | | Adicionar linha acima | Insere nova linha acima da atual | | Adicionar linha abaixo
| Insere nova linha abaixo da atual | | Adicionar coluna à esquerda | Insere nova coluna à esquerda | | Adicionar coluna
à direita | Insere 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 |
Redimensionar colunas
Passe o mouse sobre a borda entre duas colunas no cabeçalho. O cursor muda para uma seta dupla. Clique e arraste para
ajustar a largura.
:::warning Tabelas largas exibem scroll horizontal na FAQ publicada para manter a legibilidade em telas menores.
:::
Copiar e colar de outras ferramentas
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 |
:::success 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 |
Publicar o artigo
Quando o artigo estiver pronto:
1. Revise usando o botão Pré-visualizar
2. Na barra lateral, selecione a Categoria correta
3. Preencha Meta título e Meta descrição para SEO
4. Clique em Publicar
:::success Após a publicação, o artigo fica disponível imediatamente na Central de Ajuda pública. Você pode editar a
qualquer momento sem precisar despublicar.
:::
Observações
- Para publicar um artigo do zero (passo a passo): Como publicar um novo artigo numa Central de Ajuda já existente
- Para embedar vídeos nos artigos: Como embedar vídeos nos artigos da Central de Ajuda
- Para traduzir uma FAQ para outros idiomas: Como traduzir uma FAQ na Central de Ajuda
- Para criar/atualizar artigos via API em vez do editor: Como criar, atualizar ou deletar artigos na Central de Ajuda
via API