Hyperlinks hinzufügen

Hyperlinks sind eines der leistungsstärksten Werkzeuge in der technischen Dokumentation. Gut gemacht, verringern sie die Reibung für die Leser, halten Ihre Inhalte miteinander verbunden und verbessern, wie Ihre Knowledge base in der Suche funktioniert. Schlecht gemacht, schaffen sie Sackgassen, kaputte Erfahrungen und frustrierte Nutzer.

In Document360 können Sie Hyperlinks zu Texten, Bildern und Dateien innerhalb Ihrer Artikel oder Kategorieseite hinzufügen, die auf verwandte Inhalte, externe Ressourcen oder bestimmte Abschnitte desselben Artikels verlinken. Wenn Sie zum Beispiel eine Software-Installationsanleitung schreiben, erspart ein Hyperlink zur Download-Seite Ihren Lesern die Suche selbst vor der Suche.

Dieser Artikel behandelt alles, was Sie über das Hinzufügen, Verwalten und Optimieren von Hyperlinks in Document360 wissen müssen – sowohl im Markdown - als auch im Advanced WYSIWYG editor.

Warum Hyperlinks in einer Wissensdatenbank wichtig sind

Bevor wir auf das Wie eingehen, lohnt es sich, das Warum zu verstehen.

Für Leser bedeuten Hyperlinks, dass sie nie mitten in einer Aufgabe aufhören müssen, um nach relevanten Informationen zu suchen. Wenn ein Nutzer Ihren "Getting Started"-Leitfaden liest und API-Authentifizierung verstehen muss, führt ein Hyperlink ihn sofort dorthin, ohne Suchen, ohne Kontextwechsel.

Für Ihre Wissensdatenbank signalisiert eine gut verknüpfte Struktur Suchmaschinen (und KI-Systemen), dass Ihre Inhalte autoritativ, organisiert und umfassend sind. Das wirkt sich direkt auf SEO aus (wie gut Ihre Artikel bei Google ranken), AEO (Answer Engine Optimization, wie oft KI-Assistenten Ihre Inhalte zitieren) und GEO (Generative Engine Optimization, egal ob Tools wie ChatGPT, Perplexity oder Claude Ihre Inhalte als Quelle nutzen).

Für Ihr Support-Team reduzieren Hyperlinks zwischen verwandten Artikeln wiederholende Fragen. Anstatt dieselbe Erklärung über fünf Artikel hinweg neu zu schreiben, schreibst du sie einmal und verlinkst überall darauf.

Für Content Maintainer bedeuten Ankerlinks und persistente Überschrifts-IDs, dass man Artikel umstrukturieren kann, ohne jeden Link, der darauf verweist, zu zerstören.

Arten von Hyperlinks, die Sie in Document360 erstellen können

Document360 unterstützt vier Haupttypen von Hyperlinks, die jeweils einen anderen Zweck erfüllen:

Hinzufügen von Hyperlinks zu einem Artikel

Verlinkung zu spezifischen Überschriften

Bei langen Artikeln oder Kategorieseiten ermöglichen Ankerlinks (auch bookmark links oder Fragment-Links genannt) es den Lesern auf einen bestimmten Abschnitt innerhalb eines Artikels zu verweisen, nicht nur auf den oberen Seitenrand.

Warum das wichtig ist

Lange Artikel sind in technischer Dokumentation üblich. Ein Leser, der an die Spitze eines 3.000-Wörter-Artikels kommt und nach dem Abschnitt Deinstallieren sucht, muss alles andere überwinden, um ihn zu finden. Eine Ankerverbindung führt sie direkt dorthin.

Das ist besonders wertvoll, wenn:

• Verlinkung aus FAQs – "Wie setze ich mein Passwort zurück?" führt direkt zum Abschnitt "Passwort zurücksetzen" in einem längeren Artikel zur Kontoverwaltung

• Verlinkung aus Fehlermeldungen – Ihre App zeigt einen Fehler mit einem Link "Mehr erfahren" an, der direkt zum entsprechenden Fehlersuchschritt führt

• Erstellung eines Inhaltsverzeichnisses – Ein langer Artikel beginnt mit einer Liste von Abschnitten, von denen jeder mit seiner untenstehenden Überschrift verlinkt ist

• Teilen von Support-Tickets – Support-Agenten fügen einen Link ein, der Kunden direkt zum relevanten Schritt führt, nicht zum Anfang einer Seite

Hinzufügen eines Lesezeichen-Links

Im erweiterten WYSIWYG-Editor folgen Sie diesen Schritten, um Links innerhalb von Artikeln oder Seitenkategorien als Lesezeichen zu speichern:

1. Wählen Sie den gewünschten Text aus und drücken Ctrl + KSie . Der Dialog "Link hinzufügen " erscheint.

2. Wählen Sie die Artikel-Funktaste . Das Textfeld wird automatisch mit deinem ausgewählten Text ausgefüllt. Das Dropdown-Menü Arbeitsbereich & Sprache zeigt Ihren aktuellen Arbeitsbereich und Ihre Sprache an. Das Feld "Artikel suchen " zeigt standardmäßig den aktuellen Artikel.

3. Wählen Sie eine Überschrift im Artikel über den Link zu einer Überschrift aus. Das erstellt einen Link direkt zu dieser Überschrift.

4. Wählen Sie das Kästchen Open in a new tab " aus, wenn Sie den Link in einem neuen Tab öffnen möchten.

5. Klicken Sie auf Hinzufügen.

HINWEIS

• Die Überschriften H3 und H4 sind nur im Dropdown-Menü verfügbar, wenn sie in den Einstellungen aktiviert sind. Um sie zu aktivieren, navigieren Sie zu () > Knowledge base site > Article settings & SEO > Article settings > Artikel rechts und stellen Sie sicher, dass H3 und H4 ausgewählt sind.

Kopieren von Überschriften-Links von der Knowledge Base-Website

Auf der veröffentlichten Knowledge Base-Seite erscheint neben jeder Überschrift H2, H3 und H4 ein Symbol "Link kopieren" (), wenn man darüber fährt. Wenn du darauf klickst, kopierst du die direkte URL in diesen Bereich.

Diese Funktion ist nützlich für:

• Support-Teams – Holen Sie sich schnell einen direkten Abschnittslink und fügen Sie ihn in eine Support-Antwort ein.

• Interne Dokumentation – Verknüpfe dein internes Wiki oder deine Slack-Nachrichten direkt mit einem bestimmten Abschnitt

• Content Reviewer – Teilen Sie Feedback, das auf den genauen Teil eines Artikels hinweist, der diskutiert wird.

Wie Document360 Überschriften-IDs handhabt

Jede Überschrift (H2 bis H6) im Advanced WYSIWYG-Editor erhält automatisch eine eindeutige, persistente ID. Die ID wird basierend auf dem Standardsprachinhalt generiert, sobald du nach dem Tippen einer Überschrift drückst Enter , und sie bleibt unverändert, selbst wenn du die Überschrift später umbenennest.

• Sie können den Überschriftentext frei bearbeiten, ohne bestehende Links zu brechen, egal ob sie auf Überschriften im selben Artikel oder in einem anderen Artikel verweisen.

• Wenn zwei Überschriften identische Titel haben, fügt Document360 Suffixe (_1, _2, usw.) hinzu, um IDs eindeutig zu halten.

• IDs sind über Übersetzungen hinweg konsistent. Die gleiche ID bleibt in jeder Sprachversion eines Artikels erhalten, sodass Links unabhängig von der angezeigten Sprache funktional bleiben.

Hinzufügen eines E-Mail-Links

Ein E-Mail-Link öffnet den Standard-E-Mail-Client des Lesers mit der vorausgefüllten Adresse. Dies verringert die Reibung beim Kopieren und Einfügen einer Adresse.

Häufige Verwendungen in der Dokumentation sind:

• "Fragen zu diesem Artikel? Schreiben Sie unseren technischen Redakteuren eine E-Mail."

• "Für Abrechnungsanfragen kontaktieren Sie unser Finanzteam"

• "Melde eine Ungenauigkeit in diesem Artikel, lass es uns wissen"

Verlinkung zu Dateien (PDFs, Bilder, Word-Dokumente)

Manchmal möchte man, dass die Leser auf einen Link klicken und direkt eine Datei öffnen, ein herunterladbares PDF, ein Spezifikationsblatt, eine Konfigurationsvorlage.

Document360 macht dies über das Laufwerk möglich:

1. Lade die Datei auf Document360 Drive hoch.

2. Klicken Sie auf die hochgeladene Datei, um den Dateiinformationsbereich zu öffnen.

3. Unter Standort klickst du auf das Kopieren-Symbol neben dem Dateipfad. Die URL sieht ungefähr so aus: https://cdn.document360.io/abc123/filename.pdf

   

4. Gehe zu deinem Artikel und wähle den Text aus, den du verlinken möchtest.

5. Drücken Sie, Ctrl + K um den Dialog "Link hinzufügen" zu öffnen.

6. Wählen Sie den Funkknopf "Externer Link ", fügen Sie die kopierte URL ein und klicken Sie auf Hinzufügen.

Leser können nun auf den Link klicken, um die Datei direkt von der Knowledge Base-Seite zu öffnen oder herunterzuladen.

Bearbeiten oder Entlinken eines Hyperlinks

Im Erweiterten WYSIWYG-Editor zeigt ein Klick auf einen beliebigen verlinkten Text eine kleine Symbolleiste mit vier Optionen; folgen Sie diesen Schritten, um einen Hyperlink zu verwalten:

1. Klicken Sie auf den verlinkten Text. Der Link erscheint.

2. Um den Link zu verwalten:

   • Öffnen Sie den Link: Klicken Sie auf den Link, um die URL zu besuchen.

   • Bearbeite den Link: Klicken Sie auf das Edit ()-Symbol, um den Hyperlink zu ändern.

   • Entbinde den Text: Klicken Sie auf das Unlink-Symbol (), um den Hyperlink zu entfernen.

   • Link kopieren: Klicken Sie auf das Copy ()-Symbol, um den Hyperlink zu kopieren.

HINWEIS

Im Markdown-Editor werden Links manuell bearbeitet, indem die Markdown-Syntax direkt angepasst wird.

Wie Document360 interne Link-URLs handhabt

Wenn du einen internen Artikellink erstellst, kann die generierte URL je nach Setup leicht unterschiedlich aussehen. Zum Beispiel:

• https://docs.yourcompany.com/v1/docs/article-name (benutzerdefinierte Domain mit Workspace-Version)

• https://yourproject.document360.io/docs/article-name (Standard-Document360-Domain)

Diese Variationen werden erwartet und automatisch gehandhabt. Das Segment /v1/ repräsentiert die Workspace-Version. Das Domain-Format hängt davon ab, ob du eine benutzerdefinierte Domain verwendest.

Ein 404-Fehler tritt nur dann auf, wenn:

• Der Zielartikel wurde gelöscht, unveröffentlicht oder versteckt

• Die Zielüberschrift existiert nicht mehr

• Der Link wurde manuell mit einer falschen URL eingegeben

FAQ