Skip to content
readit
readit

leben, technik und kommunikation

  • werkstatt
    • appseits
    • dokumentation
    • software
    • praxistipps
    • referenzen
  • thinkware
    • Gesellschaft
    • public
    • Reisebilder
    • Lyrik
  • Nach­richt an mich
    • Datenschutz
    • Impres­sum
readit
readit

leben, technik und kommunikation

Hyperlinks und Querverweise in der technischen Dokumentation

06.10.201618.05.2021

Für den technischen Redakteur ist es täglich‘ Brot, Informationen miteinander zu verknüpfen ohne sie ständig zu wiederholen. Dadurch erhält der Querverweis seine Existenzberechtigung.

Querverweise sind im Grund genommen die altertümliche Variante der Hyperlinks: beide ermöglichen dem Rezipienten, nicht nur die unmittelbar vorliegende Information zu erfassen, sondern ermächtigen ihn, sich weitere Informationen anzueignen, die nicht unmittelbar zum Inhalt gehören, aber thematisch mit ihm verwandt sind. Bei zunehmender Komplexität der Produkte und mitunter weit auseinander driftendem Vorwissen der Rezipienten werden Verweise und Verknüpfungen immer wichtiger. Es genügt nicht mehr zu sagen: „Dann ruft der halt an!“, oder: „Das weiß der doch!“.

Tut er nicht.

Soweit klingt das alles ziemlich theoretisch. Was bedeutet das in der Praxis und worin unterscheidet sich der Hyperlink von seinem älteren Bruder, dem Querverweis?

Querverweis

Der klassische Querverweis ist ein Kind des Papiermediums: Er leitet den Rezipienten auf eine andere Seite und verlangt dadurch, dass der aktuelle Informationsprozess unterbrochen wird. Das mindeste, was man von einem Querverweis daher verlangen kann, ist die Information darüber, wohin der Leser geführt wird (also eine Seitenzahl), und was ihn dort erwartet (zum Beispiel das Thema — erkennbar an der Überschrift). ((Nur zu schreiben „siehe Seite 123“ hat in etwa die gleiche Bedeutungstiefe wie der Ruf „Achtung!“ — kein Leser weiß, was ihn auf der angegebenen Seite erwartet oder worauf er achten soll. In beiden Fällen wird diese Aufforderung normalerweise ignoriert. Die Mühe hätte man sich auch sparen können.))

Bereits an dieser Stelle unterscheidet der Technische Redakteur die Qualität der Werkzeuge: Kann as Programm Querverweise setzen (möglichst konsistent) und auch verwalten? Handelsübliche Office-Utensilien scheiden hier aus, denn so viele Features ein Word (beispielsweise) hat — es kann keine vernünftigen Querverweise. ((Daher verzichten dann viele Kollegen auf das Setzen der in Word recht aufwändigen Querverweise, worunter natürlich die eingangs erwähnte Qualität der Informationsverknüpfung leidet.))

Hyperlink

Im Gegensatz zum Querverweis ist der Hyperlink ein Kind des Internetzeitalters: der Hyperlink benötigt kein Papier mehr, er ist noch nicht einmal auf Seiten angewiesen, sondern verweist auf vorher definierte Sprungziele. Dies können Überschriften sein wie beim Querverweis (sind es meist auch), es können aber auch einfache „Anker“ sein, also beliebige Stellen, die der Redakteur vorher definiert.

Der Hyperlink hat allerdings auch einen Nachteil: als „Sprungquelle“ ((Die Stelle, an der der Hyperlink eingefügt wird.)) kann jeder beliebige Text oder auch ein Bild dienen. Wir haben uns daran gewöhnt, dass auf einer Internetseite der Klick auf das Logo zur Startseite führt, oder der Klick auf ein Bild auf der Startseite zu dem dazugehörigen Artikel führt. Aber wenn im Text ein beliebiges Wort als Hyperlink markiert ist, wissen wir auf den ersten Blick nicht, wohin uns der Link führt. ((Dies machen sich beispielsweise Programmierer von so genannten „Phishing-Mail“ zunutze: sie suggerieren ein Sprungziel, das nicht existiert, sondern zu einer anderen Seite führt oder bösartige Software auf dem Rechner installiert.))

In der harmloseren Version einer technischen Dokumentation klickt der Benutzer erst auf den Link, stellt dann fest, dass dies doch nicht zum gewünschten Ziel führt, und versucht zurück zu navigieren, nur um festzustellen, dass er jetzt den „Faden verloren“ hat. Das soll und darf nicht sein. Außerdem können Hyperlinks naturgemäß keine Seitenzahlen. Da das Internet nicht wie ein Handbuch hierarchisch und linear aufgebaut ist, ist das nicht weiter schlimm. Die Gefahr, sich in der Navigation der Hyperlinks (und nicht nur ihrer Pflege) zu verheddern, nimmt exponentiell zu: beim Verschieben der Information muss der Anker ja „mitwandern“. Ab 50 Hyperlinks wird dies während für den Redakteur zu einer Herkulesaufgabe — und 50 Hyperlinks (wie auch Querverweise) sind eher trivial. In der gedruckten Dokumentation geht das gar nicht.

So einfach Hyperlinks zu setzen sind, so umständlich sind sie in der Verwaltung und so wenig hilfreich sind sie bei der Aneignung von Informationen.

Was tun?

Wäre es nicht schön, man könnte die Vorteile beider Verknüpfungstypen kombinieren — und vielleicht sogar sinnvoll verwalten? Kann man. Mit Madcap Flare. Wie das geht, steht in einem kommenden Beitrag.

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
technische dokumentation BenutzerfreundlichkeitInformationsprozesseRedaktion

Beitragsnavigation

Previous post
Next post

Related Posts

dokumentation

Techno-Lyrik

28.04.201705.05.2017

Kaum etwas liegt dem Technischen Redakteur beruflich ferner als gebundene Sprache und kunstvoll gedrechselte Phrasen, die vom Leser verlangen, den Text zu interpretieren und nicht…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
Selbstständigkeit

Selbstständigkeit: To be or not to be

23.05.201629.01.2019

Heute brachte mich ein Gespräch mit einem Dienstleister auf einen Gedanken, der mich eigentlich schon lange umtreibt: Ist Selbstständigkeit die Zukunft der Arbeit in einer…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
praxistipps yellow jigsaw puzzle piece

MadCap Flare und die Variablen

05.02.202310.02.2023

Dieser Beitrag ist eigentlich nur was für Techies und User der Software „Flare“ von MadCap. Und vielleicht auch für Technikredakteur:innen, die sich mit dem Gedanken…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More

Sonst noch was:

  • Produktiver als jeder Montag: Aufgabenverwaltung mit monday.com
  • Aufgabenverwaltung: Work smarter, not harder
  • SVG zähmen leicht gemacht
  • Giro D'Etruria: Toskana und die Emilia Romagna 2025
  • MadCap Flare und Atlassian Confluence: das Powercouple
  • JIRA: Das Monster der Aufgabenverwaltung
  • Radfahren im Bayerischen Wald: Unterwegs am 49. Breitengrad
  • Tools for fools
  • Kommunikation kanalisieren
  • Onlinehilfen: Form follows function
  • Taskworld, der Kopfschmerzvermeider
  • Japan parforce

Beliebt:

  • Impressum
  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • Lästig
  • Ein Engel.
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Referenzen
  • Sesselfurzer, Episode 1

Klima und Umwelt

  • Klima vor Acht Das Ziel von KLIMA° vor acht ist es, Fernsehsender zu überzeugen, wissenschaftlich fundierte Klimaberichterstattung zu produzieren, die täglich zur besten Sendezeit ausgestrahlt wird und so viele Zuschauer wie möglich erreicht.

Blog via E-Mail abonnieren

Gib deine E-Mail-Adresse an, um diesen Blog zu abonnieren und Benachrichtigungen über neue Beiträge via E-Mail zu erhalten.

Gern gelesen

  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • Lästig
  • Ein Engel.
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Sesselfurzer, Episode 1
  • Internetnutzung: Wir glotzen auf Waschmaschinen

Hinweis

Es bestehen zu keinen der in diesem Blog genannten Unternehmen und Personen geschäftliche Beziehungen in der Form, dass ich für Werbung oder Vermarktung Geld oder geldwerte Zuwendungen erhalte.

Rechtliches

  • Datenschutz
  • Impressum
Datenschutz und Cookies: Diese Website verwendet Cookies. Wenn du die Website weiterhin nutzt, stimmst du der Verwendung von Cookies zu.

Weitere Informationen, beispielsweise zur Kontrolle von Cookies, findest du hier: Cookie-Richtlinie
©2026 readit | WordPress Theme by SuperbThemes
%d