Disclaimer: Dit artikel is gegenereerd door automatische vertaling.

Hyperlinks toevoegen

Prev Next

Hyperlinks zijn een van de krachtigste hulpmiddelen in technische documentatie. Goed uitgevoerd, verminderen ze wrijving voor lezers, houden je content verbonden en verbeteren ze hoe je Knowledge base presteert in zoekopdrachten. Als het slecht wordt gedaan, zorgen ze voor doodlopende wegen, kapotte ervaringen en gefrustreerde gebruikers.

In Document360 kun je hyperlinks toevoegen naar tekst, afbeeldingen en bestanden binnen je artikelen of categoriepagina's, met links naar gerelateerde inhoud, externe bronnen of specifieke secties binnen hetzelfde artikel. Als je bijvoorbeeld een software-installatiehandleiding schrijft, bespaart een hyperlink naar de downloadpagina je lezers het zelf moeten zoeken.

Dit artikel behandelt alles wat je moet weten over het toevoegen, beheren en optimaliseren van hyperlinks in Document360, zowel in de Markdown - als Advanced WYSIWYG editor.


Voordat we ingaan op het hoe, is het de moeite waard om het waarom te begrijpen.

Voor lezers betekenen hyperlinks dat ze nooit halverwege een taak hoeven te vertrekken om op zoek te gaan naar gerelateerde informatie. Als een gebruiker je "Getting Started"-gids leest en API-authenticatie moet begrijpen, brengt een hyperlink hem direct daarheen, zonder zoeken, zonder contextwisseling.

Voor je kennisbasis geeft een goed gekoppelde structuur aan zoekmachines (en AI-systemen) het signaal dat je content gezaghebbend, georganiseerd en uitgebreid is. Dit heeft direct invloed op SEO (hoe goed je artikelen scoren in Google), AEO (Answer Engine Optimization, hoe vaak AI-assistenten je content citeren) en GEO (Generative Engine Optimization, of tools zoals ChatGPT, Perplexity of Claude nu jouw content als bron gebruiken).

Voor je supportteam verminderen hyperlinks tussen gerelateerde artikelen de repetitieve vragen. In plaats van dezelfde uitleg over vijf artikelen te herschrijven, schrijf je het één keer en link je overal naar.

Voor contentbeheerders betekenen ankerlinks en persistente kop-ID's dat je artikelen kunt herstructureren zonder elke link die ernaar verwijst te breken.


Document360 ondersteunt vier hoofdtypen hyperlinks, elk met een ander doel:

Linktype

Het beste gebruik voor

Link naar het interne artikel

Gerelateerde onderwerpen verbinden binnen je kennisbasis

Koers/ankerlink

Diepe linken naar een specifieke sectie binnen een artikel

Externe URL link

Wijzen naar tools van derden, documentatie of bronnen

E-mail (mailto:) link

Het maakt het gemakkelijk voor lezers om contact op te nemen met support of een team


Hyperlinks toevoegen aan een artikel

Om een hyperlink toe te voegen aan de Markdown-editor, volg je deze stappen:

  1. Selecteer de gewenste tekst en klik op het pictogram Insert link () bovenaan de editor. De Link zal verschijnen.

  2. Kies een van de volgende linkopties:

    • Link naar een bestaand artikel: Begin met het typen van de artikelnaam in het veld Zoeken & link naar bestaand artikel . Er verschijnt een lijst met bijpassende artikelen.

    • Link naar een specifieke kop in het huidige artikel: Gebruik de Link naar de huidige artikelkop dropdown om een H2-, H3- of H4-kop te selecteren. De juiste URL-slug wordt automatisch gegenereerd.

    • Link naar een externe URL: Plak de gewenste bestemmings-URL in het URL-veld.

  3. Selecteer optioneel het vakje Open in a new tab als de link buiten je kennisbank valt. Dit is over het algemeen een goede gewoonte voor externe links zodat lezers hun plek niet verliezen.

 OPMERKING

De instelling 'Openen in een nieuw tabblad' geldt alleen voor de Kennisbanksite en heeft geen invloed op de Kennisbank-widget. In de widget:

  • Interne links binnen hetzelfde domein openen altijd binnen de widget.

  • API-documentatielinks openen altijd in een nieuw browsertabblad.

  • Externe links openen altijd in een nieuw browsertabblad.

  1. Klik op Oké om de hyperlink aan je content toe te voegen.

In de Advanced WYSIWYG-editor kun je een link op drie manieren invoegen:

  • Snel invoegmenu : Selecteer de gewenste tekst in de Advanced WYSIWYG-editor en het menu voor snel invoegen verschijnt. Klik vervolgens op het Link () icoon in het menu voor snelle invoeg .

  • Slash-commando: Typ /Link om het commando te gebruiken.

  • Ctrl + K: Selecteer de gewenste tekst en druk Ctrl + Kop .

De Add link ' verschijnt.

Er zijn twee opties in het Add link :

  • Artikel: Selecteer de knop ' Artikel ' om een link toe te voegen naar een bestaand artikel, of naar een kop uit een artikel in je kennisbank.

  • Externe link: Selecteer de knop Externe link om een hyperlink naar een specifieke URL toe te voegen.

Link naar een artikel

Om een link naar een artikel toe te voegen aan je kennisbank,

  1. Selecteer de Article-radioknop in het venster Link toevoegen .

  2. Werk indien nodig de hyperlinktekst bij in het tekstveld .

  3. Selecteer de werkruimte en taal van je doelartikel in het dropdown Werkruimte & Taal . Dit is van belang in meertalige of meervoudige versie-kennisbanken.

  4. Om een link naar een specifiek artikel toe te voegen, begin je met het typen van de artikelnaam in het veld 'Artikel zoeken '. Selecteer het gewenste artikel uit de lijst met bijpassende artikelen.

 OPMERKING

Zodra je een artikel selecteert, verschijnt er een optie 'Reset naar huidig artikel '. Dit is handig als je bent begonnen met een bookmarklink-workflow en terug wilt naar het linken binnen het artikel dat je momenteel bewerkt.

  1. Selecteer optioneel een specifieke kop van de Link naar een kop-dropdown .

  2. Selecteer het vakje Open in a new tab ' als je de hyperlink in een nieuw tabblad wilt openen.

 OPMERKING

De instelling 'Openen in een nieuw tabblad' geldt alleen voor de Kennisbanksite en heeft geen invloed op de Kennisbank-widget. In de widget:

  • Interne links binnen hetzelfde domein openen altijd binnen de widget.

  • API-documentatielinks openen altijd in een nieuw browsertabblad.

  • Externe links openen altijd in een nieuw browsertabblad.

  1. Klik op Toevoegen.

Link naar een externe URL

Om een link naar een URL toe te voegen,

  1. Selecteer de radioknop Externe link in het venster Link toevoegen .

  2. Voer de weergavetekst in het tekstveld.

  3. Plak de bestemmings-URL in het URL-veld .

  4. Selecteer het vakje Open in a new tab ' als je de hyperlink in een nieuw tabblad wilt openen.

  5. Klik op Toevoegen.


Linken naar specifieke koppen

Bij het werken met lange artikelen of categoriepagina's kun je ankerlinks (ook wel bookmark links of fragmentlinks genoemd) lezers naar een specifieke sectie binnen een artikel verwijzen, niet alleen naar de bovenkant van de pagina.

Waarom dit belangrijk is

Lange artikelen komen vaak voor in technische documentatie. Een lezer die bovenaan een artikel van 3.000 woorden komt op zoek naar de sectie Deïnstalleren, moet overal voorbij scrollen om het te vinden. Een ankerlink brengt ze er direct naartoe.

Dit is vooral waardevol wanneer:

  • Linken uit FAQ's - "Hoe reset ik mijn wachtwoord?" linkt direct naar het gedeelte Wachtwoord resetten van een langer accountbeheerartikel

  • Linking vanuit foutmeldingen - Je app toont een foutmelding met een "Meer informatie"-link die direct naar de relevante probleemoplossingsstap gaat

  • Een inhoudsopgave maken - Een lang artikel begint met een lijst van secties, elk gekoppeld aan de kop hieronder

  • Delen in supporttickets - Supportmedewerkers plakken een link die klanten direct naar de relevante stap leidt, niet naar het begin van een pagina

Volg in de Advanced WYSIWYG-editor deze stappen om links binnen artikelen of paginacategorieën te bookmarken:

  1. Selecteer de gewenste tekst en druk Ctrl + Kop . De dialoog 'Link toevoegen ' verschijnt.

  2. Selecteer de radioknop voor Artikel . Het tekstveld vult automatisch je geselecteerde tekst in. Het dropdown Workspace & Language toont je huidige werkruimte en taal. Het veld Zoeken artikel zal standaard het huidige artikel weergeven.

  3. Selecteer een kop in het artikel via de link naar een kopkeuzemenu. Dit maakt een link direct naar die kop.

  4. Selecteer het vakje Open in a new tab ' als je de hyperlink in een nieuw tabblad wilt openen.

  5. Klik op Toevoegen.

OPMERKING

  • De H3 - en H4-koppen zijn alleen beschikbaar in het dropdown als ze in de instellingen zijn ingeschakeld. Om deze in te schakelen, navigeer naar () > Knowledge base site > Article settings & SEO > Article settings > Artikel rechts en zorg dat H3 en H4 geselecteerd zijn.


Op de gepubliceerde Knowledge Base-site verschijnt er een Kopieer link ()-icoon naast elke kop van H2, H3 en H4 wanneer je eroverheen beweegt. Als je erop klikt, wordt de directe URL naar die sectie gekopieerd.

Deze functie is nuttig voor:

  • Supportteams - Pak snel een directe sectielink en plak ze in een supportantwoord

  • Interne documentatie - Koppel je interne wiki of Slack-berichten direct aan een specifieke sectie

  • Contentbeoordelaars - Deel feedback die wijst op het exacte deel van een artikel dat wordt besproken

Copy the link for headings in the articles in the Knowledge base site.

Hoe Document360 omgaat met kop-ID's

Elke koppen (H2 tot H6) in de Advanced WYSIWYG-editor krijgt automatisch een unieke, persistente ID toegewezen. De ID wordt gegenereerd op basis van de standaardtaalinhoud zodra je na het typen van een kop drukt Enter , en blijft ongewijzigd, zelfs als je de kop later hernoemt.

  • Je kunt vrij koptekst bewerken zonder bestaande links te breken, of ze nu verwijzen naar koppen binnen hetzelfde artikel of in een ander artikel.

  • Als twee koppen identieke titels hebben, voegt Document360 achtervoegsels toe (_1, _2, enz.) om ID's uniek te houden.

  • ID's zijn consistent tussen vertalingen. Dezelfde ID wordt in elke taalversie van een artikel behouden, dus links blijven functioneel ongeacht de gebruikte taal.


Een e-maillink opent de standaard e-mailclient van de lezer met het adres vooraf ingevuld. Dit vermindert de wrijving van het kopiëren en plakken van een adres.

Veelvoorkomende toepassingen in documentatie zijn onder andere:

Om een e-maillink aan een artikel toe te voegen in de Markdown-editor, volgt u de onderstaande stappen:

  1. Selecteer de tekst die je wilt linken en klik op het Link () icoon.

  2. Gebruik in het veld Link naar een URL het volgende Markdown-formaat om een e-maillink te maken:

    [Email](mailto:support@yourcompany.com)

Als je bijvoorbeeld een e-mailhyperlink test@gmail.com wilt toevoegen met de linktekst "E-mailondersteuning", typ:

[Email support](mailto:test@gmail.com).

Resultaat: E-mailondersteuning

Inserting a link in Markdown editor with highlighted email address and link button.

Om een e-maillink toe te voegen aan een artikel in de Advanced WYSIWYG-editor, volg je de onderstaande stappen:

  1. Selecteer de gewenste tekst en druk Ctrl + K (of gebruik /link). Het venster Link toevoegen verschijnt.

  2. Selecteer de radioknop Externe link .

  3. Voer in het URL-veld het e-mailadres in in het volgende formaat: mailto:email@example.com

  4. Klik op Toevoegen.

Adding an external link in Document360's WYSIWYG editor for user support.


Linken naar bestanden (PDF's, afbeeldingen, Word-documenten)

Soms wil je dat lezers op een link klikken en direct een bestand openen, een downloadbare PDF, een specificatieblad, een configuratiesjabloon.

Document360 maakt dit mogelijk via de Drive:

  1. Upload het bestand naar Document360 Drive.

  2. Klik op het geüploade bestand om het paneel met bestandsdetails te openen.

  3. Klik onder Locatie op het kopieer-icoon naast het bestandspad. De URL zal er ongeveer als volgt uitzien: https://cdn.document360.io/abc123/filename.pdf

    A person working on a computer with a robot companion nearby, focused on the screen.

  4. Ga naar je artikel en selecteer de tekst die je wilt linken.

  5. Druk Ctrl + K om het venster Link toevoegen te openen.

  6. Selecteer de radioknop Externe link , plak de gekopieerde URL en klik op Toevoegen.

Lezers kunnen nu op de link klikken om het bestand direct van de Knowledge Base-site te openen of downloaden.


In de Advanced WYSIWYG-editor verschijnt bij het klikken op een gehyperlinkte tekst een kleine werkbalk met vier opties; volg deze stappen om een hyperlink te beheren:

  1. Klik op de gehyperlinkte tekst. De Link zal verschijnen.

  2. Om de hyperlink te beheren:

    • Open de link: Klik op de link om de URL te bezoeken.

    • Bewerk de link: Klik op het pictogram Edit () om de hyperlink te wijzigen.

    • Ontkoppel de tekst: Klik op het Unlink-icoon () om de hyperlink te verwijderen.

    • Kopieer de link: Klik op het Copy () om de hyperlink te kopiëren.

OPMERKING

In de Markdown-editor worden links handmatig bewerkt door direct de Markdown-syntaxis aan te passen.


Wanneer je een interne artikellink maakt, kan de gegenereerde URL er iets anders uitzien afhankelijk van je setup. Bijvoorbeeld:

  • https://docs.yourcompany.com/v1/docs/article-name (aangepaste domein met werkruimteversie)

  • https://yourproject.document360.io/docs/article-name (standaard Document360-domein)

Deze variaties worden verwacht en automatisch afgehandeld. Het /v1/ segment vertegenwoordigt de werkruimteversie. Het domeinformaat hangt af van of je een aangepast domein gebruikt.

Een 404-fout doet zich alleen voor wanneer:

  • Het doelartikel is verwijderd, ongepubliceerd of verborgen

  • De doelkop bestaat niet meer

  • De link werd handmatig ingevoerd met een verkeerde URL


FAQ

Ja, technisch gezien kun je de link toevoegen. Verborgen artikelen geven echter een 404-fout wanneer lezers proberen ze te bezoeken op de Knowledge Base-site. Het linken naar een concept of verborgen artikel maakt het niet openbaar zichtbaar; het wordt pas toegankelijk zodra de Workflow status op Gepubliceerd staat.

Dit kan in sommige workflows bewust zijn: je kunt een artikel opstellen, interne links toevoegen van andere artikelen, en alles in één keer publiceren. Wees je er alleen van bewust dat totdat het gepubliceerd is, elke lezer die op die link klikt een 404-fout zal krijgen.

Nee. Document360 gebruikt een unieke, persistente ID voor elke kop, niet voor de koptekst, om ankerlinks te genereren. Deze ID wordt toegewezen wanneer de kop voor het eerst wordt aangemaakt en verandert nooit, ongeacht hoe vaak je de koptekst daarna bewerkt.

Als twee koppen dezelfde titel delen, voegt Document360 automatisch achtervoegsels toe ( _1, _2, enz.) om elke ID uniek te houden.

Ja. Upload het bestand naar Document360 Drive, kopieer de URL van het bestandspad uit het Bestandsdetailspaneel en gebruik het als externe link in elk artikel. Lezers die op de link klikken, worden direct naar het bestand geleid.

Ze zijn hetzelfde in Document360. Beide verwijzen naar een link die verwijst naar een specifieke kop (H2, H3 of H4) binnen een artikel, in plaats van bovenaan de pagina. De termen worden door elkaar gebruikt.

Mag ik een link naar een gerepliceerd artikel linken?

Nee. Artikelen die zijn aangemaakt met de Replicate-functie kunnen niet als interne links in andere artikelen worden toegevoegd. Je kunt nog steeds naar het originele artikel linken. Als je een linkbare kopie nodig hebt, overweeg dan om een nieuw artikel vanaf nul te maken in plaats van de replicate-functie te gebruiken.

Er is geen eenduidig juist antwoord, maar een veelvoorkomende conventie is:

  • Interne artikellinks — Open in hetzelfde tabblad (houdt de lezer binnen je kennisbankstroom)

  • Externe links — Open in een nieuw tabblad (houdt je kennisbank op de achtergrond open)

  • Bestanden downloaden — Openen in een nieuw tabblad (voorkomt dat je het artikel verlaat)

Document360 geeft je de optie bij elke link — gebruik je oordeel op basis van waar de link naartoe leidt en welke ervaring je voor de lezer wilt.