Escreva artigos e organize coleções

Shayan TaslimAtualizado

Sua Central de Ajuda organiza artigos em coleções e oferece à sua equipe um editor de rich text com links internos, histórico de revisões e controles de visibilidade.

Organizar coleções

Abra Central de Ajuda → Artigos na barra lateral do painel para gerenciar a árvore de navegação.

  • Crie uma coleção. Clique em Nova coleção na barra superior, digite um Nome (até 255 caracteres; o UserJot sugere automaticamente um ícone enquanto você digita, até que escolha um manualmente), escolha um Ícone e clique em Criar. As novas coleções aparecem no fim do nível superior.

  • Edite uma coleção. Clique com o botão direito em uma coleção e selecione Editar… para atualizar o ícone, o nome ou a Descrição (até 500 caracteres).

  • Aninhe e reordene. Arraste e solte coleções e artigos na árvore para reordená-los ou aninhá-los, ou clique com o botão direito e escolha Mover para. As coleções podem ser aninhadas em até três níveis.

  • Artigos no nível superior e não posicionados. Os artigos posicionados no Nível superior aparecem fora de qualquer coleção e podem ter um ícone personalizado (clique com o botão direito → Alterar ícone…). Clicar em Novo artigo na barra superior cria um rascunho não posicionado em Sem coleção. Os artigos não posicionados não aparecem nas listas nem nos resultados de busca até que sejam colocados no Nível superior ou dentro de uma coleção.

  • Exclua uma coleção. Clique com o botão direito em uma coleção e selecione Excluir…. As coleções são excluídas permanentemente, sem passar pela lixeira. Se a coleção contiver artigos, escolha Mover os artigos para outra coleção, Nível superior ou Sem coleção (ao movê-los para outra coleção, os URLs antigos da coleção excluída redirecionam para ela).

Escreva com o editor

Cada artigo tem um Título obrigatório (até 255 caracteres), uma Descrição opcional (até 500 caracteres, usada nos cartões e como meta descrição) e um editor de conteúdo.

Pressione / em uma nova linha para inserir blocos:

  • Texto, Título (H2) e Subtítulo (H3). Os títulos geram automaticamente âncoras de seção estáveis.

  • Lista com marcadores, Lista numerada, Citação, Bloco de código (com seletor de linguagem) e Divisor.

  • Imagem (envie arquivos do seu computador; clique em uma imagem para adicionar um Texto alternativo ou uma Legenda, com até 500 caracteres cada).

  • Tabela (começa como uma tabela 3x3 com uma linha de cabeçalho e controles flutuantes para linhas e colunas).

  • Chamadas de Nota, Dica e Aviso, além de blocos expansíveis de Sanfonado (títulos de 1 a 200 caracteres). No editor do painel, chamadas e blocos sanfonados não podem ser aninhados uns nos outros (pela API ou na importação de HTML, uma chamada pode aparecer dentro de um bloco sanfonado; chamadas dentro de chamadas, blocos sanfonados dentro de chamadas e blocos sanfonados dentro de blocos sanfonados não são permitidos).

  • Vídeos incorporados do YouTube, Loom ou Vimeo (ou cole um link direto desses provedores em uma linha separada).

Selecione o texto para aplicar Negrito, Itálico, Tachado, Código, Tecla (estilo de atalho de teclado) ou links. Código e Tecla não podem ser combinados com outras marcações de formatação em linha, e o texto em Tecla não pode conter < nem >. Os documentos aceitam até 1 MB de JSON, 512 KB de Markdown, 5.000 nós e 32 níveis de aninhamento de blocos.

Os rascunhos são salvos automaticamente enquanto você digita. Pressione ⌘S / Ctrl+S para salvar manualmente; pressione ⌘⇧\ / Ctrl+Shift+\ para mostrar ou ocultar a barra lateral da lista de artigos; ative ou desative Pré-visualização no canto inferior direito para conferir a visualização do leitor; ou clique no controle Som de digitação, no canto inferior esquerdo, para escolher sons mecânicos opcionais de teclas (Alpaca, Cream, Mint, Mochi, Frost ou Desativado) e ajustar o volume.

Dialeto Markdown da Central de Ajuda

A API REST, o servidor MCP, Copiar página e os endpoints .md usam Markdown no estilo GitHub, com as seguintes extensões:

  • Blocos de chamada <Note>, <Tip> e <Warning>

  • Seções expansíveis <Accordion title="...">

  • {#custom-id} no fim de um título para fixar uma âncora estável

  • <kbd>...</kbd> para teclas de atalho em linha

  • Links internos escritos como /articles/<slug> ou /collections/<slug> (com #heading opcional)

Clique no botão de link na barra de ferramentas de seleção para abrir Adicionar link. Pesquise artigos, coleções e títulos de artigos publicados na sua Central de Ajuda (a pesquisa por título exige pelo menos 2 caracteres e retorna até 8 resultados) ou cole uma URL externa https://. Ao colar a URL de um dos seus próprios artigos de ajuda, ela se transforma em uma referência interna que continua funcionando mesmo que o slug do artigo de destino mude.

Se um destino vinculado for despublicado, movido para a lixeira ou excluído, o editor destacará o link no texto para que você possa corrigi-lo. A lista Vinculado por no painel lateral Artigo mostra até oito artigos publicados que têm um link para o artigo atual.

Abra o painel lateral Artigo para configurar como os leitores encontram um artigo:

Configuração

O que faz

Visibilidade

Escolha Público (listado, pesquisável e incluído em llms.txt e no Juno), Não listado (acessível apenas por link direto; oculto da navegação, da busca e do Juno) ou Equipe (somente administradores internos e proprietários que estão conectados).

Coleção

Coloque o artigo no Nível superior, dentro de uma coleção ou deixe-o em Sem coleção.

Link

Clique em /help/articles/<slug> para abrir Alterar link (letras minúsculas, números e hífens, até 60 caracteres). Antes da primeira publicação, o slug acompanha o título até que você o edite manualmente. Após a publicação, alterar o slug cria um redirecionamento automático do URL antigo.

Mostrar nos mecanismos de busca

Permita ou bloqueie a indexação deste artigo por mecanismos de busca. Para que o artigo seja indexado, ele também precisa ser público, estar em uma coleção, e sua Central de Ajuda precisa estar Ativa.

Palavras-chave

Adicione palavras-chave ocultas para a busca no idioma atual (até 50 palavras-chave, com 64 caracteres cada). Pressione Enter ou vírgula para adicionar cada termo.

Você também pode atribuir um Autor (ou selecionar Sem autor) no cartão de status na parte superior do painel lateral.

Publicação, histórico e lixeira

  • Publique. Clique em Publicar (ou Publicar alterações, atalho ⌘↵). Antes de publicar, o pop-up avisa sobre texto alternativo ausente em imagens ou links internos inválidos. Ao atualizar um artigo publicado, desative Mostrar como atualizado para pequenas correções de digitação, assim a data de atualização exibida ao público não muda.

  • Despublique. Abra Mais ações (⋮) → Despublicar para tirar do ar o idioma atual, mantendo o rascunho e o histórico de revisões.

  • Histórico de revisões. Selecione qualquer item em Histórico, na barra lateral direita, para visualizá-lo no modo somente leitura (pressione Esc para sair da pré-visualização) e clique em Restaurar esta versão para copiá-lo de volta para o rascunho (ele permanecerá não publicado até que você clique em Publicar alterações).

  • Compare traduções. Ao editar um artigo traduzido, ative Comparar na barra superior (em telas largas) para ver o original publicado lado a lado, com blocos alterados, adicionados e removidos destacados.

  • Mova para a lixeira e restaure. Abra Mais ações (⋮) → Mover para a lixeira para remover um artigo imediatamente. Os artigos na lixeira podem ser restaurados por 30 dias (com o slug e os redirecionamentos reservados) antes de serem excluídos permanentemente. Ao abrir um artigo na lixeira, aparece o botão Restaurar da lixeira.

Próximas etapas

Isso respondeu à sua pergunta?