Escreva artigos e organize coleções

Shayan TaslimAtualizado

O seu Centro de ajuda organiza artigos em coleções e disponibiliza à sua equipa um editor de texto formatado com ligações internas, histórico de revisões e controlos de visibilidade.

Organizar coleções

Abra Centro de ajuda → Artigos na barra lateral do painel para gerir a árvore de navegação.

  • Crie uma coleção. Clique em Nova coleção na barra superior, introduza um Nome (até 255 caracteres; o UserJot sugere automaticamente um ícone enquanto escreve, até escolher 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 numa coleção e selecione Editar… para atualizar o ícone, o nome ou a Descrição (até 500 caracteres).

  • Aninhe e reordene. Arraste e largue coleções e artigos na árvore para os reordenar ou aninhar, ou clique com o botão direito e escolha Mover para. As coleções podem ter até três níveis de profundidade.

  • Artigos de nível superior e não colocados. Os artigos colocados 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 colocado em Sem coleção. Os artigos não colocados não são listados nem pesquisáveis até serem colocados no Nível superior ou numa coleção.

  • Elimine uma coleção. Clique com o botão direito numa coleção e selecione Eliminar…. As coleções são eliminadas permanentemente, sem passar pelo lixo. Se a coleção contiver artigos, escolha Mover os artigos para outra coleção, o Nível superior ou Sem coleção (ao movê-los para outra coleção, os URLs antigos da coleção eliminada são redirecionados para essa coleção).

Escrever com o editor

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

Prima / numa nova linha para inserir blocos:

  • Texto, Cabeçalho (H2) e Subtítulo (H3). Os cabeçalhos geram automaticamente âncoras de secção estáveis.

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

  • Imagem (carregue ficheiros do seu computador; clique numa imagem para adicionar Texto alternativo ou uma Legenda, até 500 caracteres cada).

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

  • Blocos de destaque Nota, Dica e Aviso, além de blocos Acordeão expansíveis (títulos de 1 a 200 caracteres). No editor do painel de controlo, os blocos de destaque e os acordeões não podem ser aninhados uns nos outros (através da API ou da importação de HTML, um bloco de destaque pode surgir dentro de um acordeão, mas não são permitidas as combinações bloco de destaque dentro de bloco de destaque, acordeão dentro de bloco de destaque e acordeão dentro de acordeão).

  • Vídeo incorporado do YouTube, Loom ou Vimeo (ou cole um link simples de um destes serviços numa linha própria).

Selecione texto para aplicar Negrito, Itálico, Rasurado, Código, Tecla (formatação de atalho de teclado) ou ligações. Código e Tecla não podem ser combinados com outras marcas de formatação em linha, e o texto Tecla não pode conter < nem >. Os documentos suportam 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 guardados automaticamente enquanto escreve. Prima ⌘S / Ctrl+S para guardar manualmente; prima ⌘⇧\ / Ctrl+Shift+\ para mostrar ou ocultar o painel lateral da lista de artigos; ative ou desative Pré-visualização no canto inferior direito para ver como o artigo será apresentado aos leitores; ou clique no controlo Som de escrita, no canto inferior esquerdo, para escolher sons mecânicos de teclas opcionais (Alpaca, Cream, Mint, Mochi, Frost ou Desativado) e ajustar o volume.

Dialeto Markdown do Centro de Ajuda

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

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

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

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

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

  • Ligações internas escritas como /articles/<slug> ou /collections/<slug> (com #heading opcional)

Clique no botão de ligação da barra de ferramentas de seleção para abrir Adicionar ligação. Pesquise no seu Centro de Ajuda artigos, coleções e títulos de artigos publicados (a pesquisa de títulos requer pelo menos 2 caracteres e apresenta até 8 resultados), ou cole um URL externo https://. Se colar o URL de um dos seus próprios artigos de ajuda, este transforma-se numa referência interna que continua a funcionar mesmo que o slug do artigo de destino mude.

Se um destino associado for posteriormente retirado de publicação, enviado para o lixo ou eliminado, o editor destaca essa ligação no texto para que a possa corrigir. A lista Com ligação a partir de, na barra lateral Artigo à direita, mostra até oito artigos publicados que têm uma ligação para o artigo atual.

Abra a barra lateral Artigo, à direita, para configurar a forma como os leitores encontram um artigo:

Definiçã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 através de uma ligação direta; oculto da navegação, da pesquisa e do Juno) ou Equipa (apenas administradores internos e proprietários com sessão iniciada).

Coleção

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

Ligação

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

Mostrar nos motores de pesquisa

Permita ou bloqueie a indexação deste artigo pelos motores de pesquisa. Para ser indexado, o artigo também tem de ser público, estar colocado numa coleção e o Centro de Ajuda tem de estar Publicado.

Palavras-chave

Adicione palavras-chave de pesquisa ocultas para o idioma atual (até 50 palavras-chave, com 64 caracteres cada). Prima Enter ou uma vírgula para adicionar cada termo.

Também pode atribuir um Autor (ou Sem autor) no cartão de estado na parte superior da barra lateral à direita.

Publicar, histórico e lixo

  • Publique. Clique em Publicar (ou Publicar alterações, atalho ⌘↵). Antes de publicar, a janela pop-up avisa sobre texto alternativo em falta nas imagens ou ligações internas quebradas. Ao atualizar um artigo publicado, desative Mostrar como atualizado para pequenas correções de gralhas, para que a data de atualização pública se mantenha inalterada.

  • Retire de publicação. Abra Mais ações (⋮) → Retirar de publicação para colocar offline o idioma atual, mantendo o respetivo rascunho e histórico de revisões.

  • Histórico de revisões. Selecione qualquer entrada em Histórico, no painel lateral direito, para a consultar em modo só de leitura (prima Esc para sair da pré-visualização); em seguida, clique em Restaurar esta versão para a copiar para o rascunho (continuará por publicar até clicar em Publicar alterações).

  • Compare traduções. Ao editar um artigo traduzido, ative Comparar na barra superior (em ecrãs largos) para ver lado a lado o original publicado, com os blocos alterados, adicionados e removidos realçados.

  • Enviar para o lixo e restaurar. Abra Mais ações (⋮) → Mover para o lixo para remover imediatamente um artigo. Os artigos no lixo podem ser restaurados durante 30 dias (com o respetivo slug e redirecionamentos reservados) antes de serem eliminados permanentemente. Ao abrir um artigo no lixo, é apresentado o botão Restaurar do lixo.

Próximos passos

Isto respondeu à sua pergunta?