Hiperlinks são uma das ferramentas mais poderosas em documentação técnica. Bem feitos, eles reduzem o atrito para os leitores, mantêm seu conteúdo interconectado e melhoram o desempenho da sua Knowledge base nas buscas. Se mal feitos, criam becos sem saída, experiências quebradas e usuários frustrados.
No Document360, você pode adicionar hiperlinks para texto, imagens e arquivos dentro dos seus artigos ou páginas de categoria, linkando para conteúdo relacionado, recursos externos ou seções específicas dentro do mesmo artigo. Por exemplo, se você está escrevendo um guia de instalação de software, um hiperlink para a página de download poupa seus leitores de terem que procurá-lo por conta própria.
Este artigo cobre tudo o que você precisa saber sobre adicionar, gerenciar e otimizar hiperlinks no Document360, tanto no Markdown quanto Advanced WYSIWYG editor.
Por que os hiperlinks importam em uma base de conhecimento
Antes de entrar no como, vale a pena entender o porquê.
Para os leitores, hiperlinks significam que eles nunca precisam sair no meio da tarefa para buscar informações relacionadas. Se um usuário está lendo seu guia "Como Começar" e precisa entender autenticação de API, um hiperlink o leva até lá instantaneamente, sem busca ou troca de contexto.
Para sua base de conhecimento, uma estrutura bem conectada sinaliza aos mecanismos de busca (e sistemas de IA) que seu conteúdo é autoritativo, organizado e abrangente. Isso impacta diretamente SEO (quão bem seus artigos se posicionam no Google), AEO (Otimização para Motores de Resposta, com que frequência assistentes de IA citam seu conteúdo) e GEO (Otimização para Motores Generativos, seja ChatGPT, Perplexity ou Claude que usam seu conteúdo como fonte).
Para sua equipe de suporte, os hiperlinks entre artigos relacionados reduzem perguntas repetitivas. Em vez de reescrever a mesma explicação em cinco artigos, você escreve uma vez e linka para ela em todos os lugares.
Para os mantenedores de conteúdo, links âncora e IDs persistentes de títulos significam que você pode reestruturar artigos sem quebrar todos os links que apontam para eles.
Tipos de hiperlinks que você pode criar no Document360
O Document360 suporta quatro tipos principais de hiperlinks, cada um servindo a um propósito diferente:
Tipo de ligação | Melhor usado para |
|---|---|
Link interno do artigo | Conectando tópicos relacionados em toda a sua base de conhecimento |
Link de cabeçalho/âncora | Fazer deep link para uma seção específica dentro de um artigo |
Link de URL externo | Apontando para ferramentas, documentos ou recursos de terceiros |
Link para e-mail ( | Facilitando para os leitores contatarem o suporte ou uma equipe |
Adicionar hiperlinks a um artigo
Para adicionar um hiperlink no editor Markdown, siga estes passos:
Selecione o texto desejado e clique no ícone Inserir link () no topo do editor. O diálogo Link vai aparecer.
Escolha uma das seguintes opções de linking:
Link para um artigo existente: Comece a digitar o nome do artigo no campo Buscar & linke para o artigo existente . Uma lista de artigos correspondentes será apresentada.
Link para um título específico no artigo atual: Use o menu suspenso do link para o título atual para selecionar um título H2, H3 ou H4. O slug URL apropriado será gerado automaticamente.
Link para uma URL externa: Cole a URL de destino desejada no campo URL.
Opcionalmente, selecione a Abrir em uma nova guia se o link levar para fora da sua base de conhecimento. Isso geralmente é uma boa prática para links externos para que os leitores não percam o lugar.
NOTA
A configuração Abrir em uma nova aba se aplica apenas ao site da Base de Conhecimento e não afeta o widget da Base de Conhecimento. No widget:
Links internos dentro do mesmo domínio sempre se abrem dentro do widget.
Os links da documentação da API sempre abrem em uma nova aba do navegador.
Links externos sempre abrem em uma nova aba do navegador.
Clique em Ok para adicionar o hiperlink ao seu conteúdo.
No editor avançado WYSIWYG , você pode inserir um link de três maneiras:
Menu de inserção rápida : Selecione o texto desejado no editor WYSIWYG Avançado e o menu Inserção Rápida aparecerá. Depois, clique no ícone Link () no menu Quick Insert .
Comando de barra: Digite
/Linkpara usar o comando.Ctrl + K: Selecione o texto desejado e pressione
Ctrl + K.
A janela Adicionar link vai aparecer.
Existem duas opções no diálogo Adicionar link :
Artigo: Selecione o botão de opção Artigo para adicionar um link a um artigo existente ou a um título de qualquer artigo na sua base de conhecimento.
Link externo: Selecione o botão de opção Link externo para adicionar um hiperlink a uma URL específica.
Link para um artigo
Para adicionar um link para um artigo na sua base de conhecimento,
Selecione o botão de opção Artigo no diálogo de Adicionar link .
No campo Texto , atualize o texto do hiperlink se necessário.
Selecione o espaço de trabalho e o idioma do artigo que você tem destino no menu suspenso Workspace & Language . Isso importa em bases de conhecimento multilíngues ou multiversões.
Para adicionar um link para um artigo específico, comece a digitar o nome do artigo no campo Pesquisar artigo . Selecione o artigo desejado da lista de artigos correspondentes.
NOTA
Assim que você seleciona um artigo, aparece a opção Redefinir para o artigo atual . Isso é útil quando você começou com um fluxo de trabalho de links de favoritos e quer voltar a linkar dentro do artigo que está editando atualmente.
Opcionalmente, selecione um título específico do link para um menu suspenso de títulos .
Selecione a caixa Abrir em uma nova guia se quiser abrir o hiperlink em uma nova aba.
NOTA
A configuração Abrir em uma nova aba se aplica apenas ao site da Base de Conhecimento e não afeta o widget da Base de Conhecimento. No widget:
Links internos dentro do mesmo domínio sempre se abrem dentro do widget.
Os links da documentação da API sempre abrem em uma nova aba do navegador.
Links externos sempre abrem em uma nova aba do navegador.
Clique em Adicionar.
Link para uma URL externa
Para adicionar um link a uma URL,
Selecione o botão de acesso Externo no diálogo Adicionar link .
Insira o texto de exibição no campo Texto .
Cole a URL de destino no campo URL .
Selecione a caixa Abrir em uma nova guia se quiser abrir o hiperlink em uma nova aba.
Clique em Adicionar.
Vinculação a títulos específicos
Ao lidar com artigos longos ou páginas de categoria, links âncora (também chamados bookmark links ou links de fragmentos) permitem que você indique aos leitores uma seção específica dentro de um artigo, não apenas o topo da página.
Por que isso importa
Artigos longos são comuns em documentação técnica. Um leitor que chega ao topo de um artigo de 3.000 palavras procurando a seção Desinstalar precisa rolar o tempo além de todo o resto para encontrá-la. Um elo de âncora os leva direto até lá.
Isso é especialmente valioso quando:
Vinculação a partir de FAQs - "Como faço para redefinir minha senha?" liga diretamente à seção Redefinir Senha de um artigo mais longo sobre gerenciamento de conta
Vinculação a partir de mensagens de erro - Seu app mostra um erro com um link "Saiba mais" que vai direto para a etapa de solução de problemas relevante
Criação de um sumário - Um artigo longo começa com uma lista de seções, cada uma vinculada ao seu título abaixo
Compartilhamento em chamados de suporte - Os agentes de suporte colam um link que leva os clientes diretamente para a etapa relevante, não para o início de uma página
Adicionando um Link de Favorito
No editor avançado WYSIWYG, siga estes passos para marcar links dentro de artigos ou categorias de páginas:
Selecione o texto desejado e pressione
Ctrl + K. A janela de diálogo de adicionar link vai aparecer.Selecione o botão de opção Artigo . O campo Texto será preenchido automaticamente com o texto selecionado. O menu suspenso Workspace & Language mostrará seu espaço de trabalho atual e o idioma. O campo de Pesquisa no artigo será automaticamente para o artigo atual.
Selecione um título no artigo do link para um menu suspenso de títulos. Isso criará um link direto para esse título.
Selecione a caixa Abrir em uma nova guia se quiser abrir o hiperlink em uma nova aba.
Clique em Adicionar.
NOTA
Os títulos H3 e H4 só estarão disponíveis no menu suspenso se ativados nas configurações. Para habilitá-los, navegue até Configurações () > Site da base de conhecimento > Configurações de artigo e SEO > Configurações do artigo de artigo > Artigo direito e certifique-se de que H3 e H4 estejam selecionados.
Copiar links de títulos do site da Knowledge Base
No site publicado da Knowledge Base, um ícone de link de Copiar () aparece ao lado de cada cabeçalho H2, H3 e H4 quando você passa o mouse sobre ele. Clicar nela copia a URL direta para essa seção.
Esse recurso é útil para:
Equipes de suporte - Rapidamente pegue e cole um link de seção direta em uma resposta de suporte
Documentação interna - Vincule sua wiki interna ou mensagens do Slack diretamente para uma seção específica
Revisores de conteúdo - Compartilhem feedback que aponte exatamente para a parte do artigo em discussão
Como o Document360 lida com IDs de Cabeçalhos
Cada título (H2 a H6) no editor Advanced WYSIWYG recebe automaticamente um ID único e persistente. O ID é gerado com base no conteúdo padrão do idioma assim que você clica Enter após digitar um título, e permanece inalterado, mesmo que você renomeie o título depois.
Você pode editar livremente o texto do título sem quebrar links existentes, seja apontando para títulos dentro do mesmo artigo ou em outro.
Se dois títulos tiverem títulos idênticos, o Document360 adiciona sufixos (
_1,_2, etc.) para manter os IDs únicos.IDs são consistentes entre as traduções. O mesmo ID é preservado em todas as versões linguísticas de um artigo, então os links permanecem funcionais independentemente do idioma visualizado.
Adicionando um link de e-mail
Um link de e-mail abre o cliente de e-mail padrão do leitor com o endereço pré-preenchido. Isso reduz o atrito de copiar e colar um endereço.
Usos comuns na documentação incluem:
"Perguntas sobre este artigo? Envie um e-mail para nossos redatores técnicos"
"Para consultas de faturamento, entre em contato com nossa equipe financeira"
"Reporte uma imprecisão neste artigo, nos avise"
Para adicionar um link de e-mail a um artigo no editor Markdown, siga os passos abaixo:
Selecione o texto que você quer linkar e clique no ícone Link ().
No campo Link para uma URL , use o seguinte formato Markdown para criar um link de e-mail:
[Email](mailto:support@yourcompany.com)
Por exemplo, se você quiser adicionar um hiperlink de e-mail com
test@gmail.como link "Suporte a e-mail", digite:
[Email support](mailto:test@gmail.com).Resultado: Suporte por e-mail
Para adicionar um link de e-mail para um artigo no editor Advanced WYSIWYG, siga os passos abaixo:
Selecione o texto desejado e pressione
Ctrl + K(ou use/link). O diálogo Adicionar Link vai aparecer.Selecione o botão de acesso ao link externo .
No campo URL , insira o e-mail no seguinte formato:
mailto:email@example.comClique em Adicionar.
Vinculação para arquivos (PDFs, imagens, documentos do Word)
Às vezes, você quer que os leitores cliquem em um link e abram um arquivo diretamente, um PDF para download, uma ficha técnica, um modelo de configuração.
O Document360 torna isso possível através do Drive:
Faça o upload do arquivo para o Document360 Drive.
Clique no arquivo carregado para abrir o painel de detalhes do arquivo .
Em Localização, clique no ícone Copiar ao lado do caminho do arquivo. A URL ficará algo assim:
https://cdn.document360.io/abc123/filename.pdf
Vá até seu artigo e selecione o texto que deseja colocar no link.
Pressiona
Ctrl + Kpara abrir o diálogo de Adicionar link .Selecione o botão de opção Link externo , cole a URL copiada e clique em Adicionar.
Agora os leitores podem clicar no link para abrir ou baixar o arquivo diretamente do site da Knowledge Base.
Editar ou desvincular um hiperlink
No editor avançado WYSIWYG, clicar em qualquer texto hiperlinkado revela uma pequena barra de ferramentas com quatro opções; siga estes passos para gerenciar um hiperlink:
Clique no texto com hiperlink. O diálogo Link vai aparecer.
Para gerenciar o link:
Abra o link: Clique no link para visitar a URL.
Edite o link: Clique no ícone Editar () para modificar o hiperlink.
Desvincule o texto: Clique no ícone Desvincular () para remover o hiperlink.
Copie o link: Clique no ícone Copiar () para copiar o hiperlink.
NOTA
No editor Markdown, os links são editados manualmente modificando diretamente a sintaxe do Markdown.
Como o Document360 lida com URLs de links internos
Quando você cria um link interno de artigo, a URL gerada pode parecer um pouco diferente dependendo da sua configuração. Por exemplo:
https://docs.yourcompany.com/v1/docs/article-name(domínio personalizado com versão workspace)https://yourproject.document360.io/docs/article-name(domínio padrão Document360)
Essas variações são esperadas e tratadas automaticamente. O /v1/ segmento representa a versão do workspace. O formato do domínio depende se você usa um domínio personalizado.
Um erro 404 só ocorre quando:
O artigo-alvo foi deletado, não publicado ou ocultado
O rumo alvo não existe mais
O link foi inserido manualmente com uma URL incorreta
FAQ
Posso vincular artigos ocultos ou não publicados?
Sim, tecnicamente você pode adicionar o link. No entanto, artigos ocultos retornam um erro 404 quando os leitores tentam visitá-los no site da base de conhecimento. Vincular a um rascunho ou artigo oculto não o torna visível publicamente, ele só ficará acessível quando o Workflow status for definido como Publicado.
Isso pode ser intencional em alguns fluxos de trabalho: você pode redigir um artigo, adicionar links internos de outros artigos e publicar tudo de uma vez só. Só fique ciente de que, até ser publicado, qualquer leitor clicar nesse link receberá um erro 404.
Meus links de título vão quebrar se eu renomear ou editar um título?
Não. O Document360 usa um ID único e persistente para cada cabeçalho, e não o texto do título, para gerar links âncora. Esse ID é atribuído quando o título é criado pela primeira vez e nunca muda, independentemente de quantas vezes você edite o texto do título depois.
Se dois títulos compartilharem o mesmo título, o Document360 automaticamente adiciona sufixos ( _1, _2, etc.) para manter cada ID único.
Posso linkar imagens ou PDFs hospedados no Document360 Drive?
Sim. Envie o arquivo para o Document360 Drive, copie a URL do caminho do arquivo a partir do painel de detalhes do arquivo e use-o como link externo em qualquer artigo. Leitores que clicarem no link serão levados diretamente ao arquivo.
Qual é a diferença entre um link de favorito e um link âncora de cabeçalho?
Elas são a mesma coisa no Document360. Ambos se referem a um link que aponta para um título específico (H2, H3 ou H4) dentro de um artigo, em vez do topo da página. Os termos são usados de forma intercambiável.
Posso linkar para um artigo replicado?
Não. Artigos criados usando o recurso Replicar não podem ser adicionados como links internos em outros artigos. Você ainda pode linkar para o artigo original. Se você precisar de uma cópia linkável, considere criar um novo artigo do zero em vez de usar o recurso de replicar.
Links internos devem abrir em uma nova aba?
Não existe uma única resposta certa, mas uma convenção comum é:
Links internos de artigos — Abram na mesma aba (mantém o leitor dentro do fluxo da sua base de conhecimento)
Links externos — Abrir em uma nova aba (mantém sua base de conhecimento aberta em segundo plano)
Download de arquivos — Abrir em uma nova aba (evita sair do artigo)
O Document360 oferece a opção em cada link — use seu julgamento baseado em onde o link leva e qual experiência você deseja para o leitor.