Adicionando hiperlinks

Hyperlinks são uma das ferramentas mais poderosas na documentação técnica. Bem feitos, eles reduzem atritos 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 "Começo" e precisa entender autenticação de API, um hiperlink o leva até lá instantaneamente, sem busca, sem 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 o SEO (quão bem seus artigos são posicionados 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 ferramenta como ChatGPT, Perplexity ou Claude que usam seu conteúdo como fonte).

Para sua equipe de suporte, hiperlinks entre artigos relacionados reduzem perguntas repetitivas. Em vez de reescrever a mesma explicação em cinco artigos, você a 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:

Adicionar hiperlinks a um artigo

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 a tela por cima de todo o resto para encontrá-la. Um link âncora 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:

1. Selecione o texto desejado e pressione Ctrl + K. A janela de Adicionar link aparecerá.

2. Selecione o botão de opção Artigo . O campo Texto será preenchido automaticamente com o texto selecionado. O menu suspenso Workspace & Idioma mostrará seu espaço de trabalho atual e o idioma. O campo Pesquisar artigo será automaticamente direcionado para o artigo atual.

3. Selecione um título dentro do artigo do link para um menu suspenso de títulos. Isso criará um link diretamente para esse título.

4. Selecione a caixa Abrir em uma nova guia se quiser abrir o hiperlink em uma nova aba.

5. Clique em Adicionar.

NOTA

• Os títulos H3 e H4 só estarão disponíveis no menu suspenso se ativados nas configurações. Para ativá-los, navegue até Configurações () > Site da base de conhecimento > Configurações de artigo e SEO Configurações do artigo de artigo > Direita do artigo 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 Copiar link () aparece ao lado de cada título H2, H3 e H4 quando você passa o mouse sobre ele. Ao clicar, a URL direta para essa seção é copiada.

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 WYSIWYG Avançado recebe automaticamente um ID único e persistente. O ID é gerado com base no conteúdo padrão do idioma assim que você pressiona Enter após digitar um título, e permanece inalterado, mesmo que você renomeie o título posteriormente.

• 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"

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:

1. Faça o upload do arquivo para o Document360 Drive.

2. Clique no arquivo carregado para abrir o painel de detalhes do arquivo .

3. Em Localização, clique no ícone Copiar ao lado do caminho do arquivo. A URL ficará algo como:https://cdn.document360.io/abc123/filename.pdf

   

4. Vá até seu artigo e selecione o texto que deseja colocar no link.

5. Pressiona Ctrl + K para abrir o diálogo de Adicionar link .

6. 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:

1. Clique no texto hiperlinkado. O diálogo Link vai aparecer.

2. Para gerenciar o link:

   • Abra o link: Clique no link para acessar 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 segmento /v1/ 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