Hyperlinks und Querverweise in der technischen Dokumentation

Für den tech­ni­schen Redak­teur ist es täg­lich‘ Brot, Infor­ma­tio­nen mit­ein­an­der zu ver­knüp­fen ohne sie stän­dig zu wie­der­ho­len. Dadurch erhält der Quer­ver­weis sei­ne Exis­tenz­be­rech­ti­gung.

Quer­ver­wei­se sind im Grund genom­men die alter­tüm­li­che Vari­an­te der Hyper­links: bei­de ermög­li­chen dem Rezi­pi­en­ten, nicht nur die unmit­tel­bar vor­lie­gen­de Infor­ma­ti­on zu erfas­sen, son­dern ermäch­ti­gen ihn, sich wei­te­re Infor­ma­tio­nen anzu­eig­nen, die nicht unmit­tel­bar zum Inhalt gehö­ren, aber the­ma­tisch mit ihm ver­wandt sind. Bei zuneh­men­der Kom­ple­xi­tät der Pro­duk­te und mit­un­ter weit aus­ein­an­der drif­ten­dem Vor­wis­sen der Rezi­pi­en­ten wer­den Ver­wei­se und Ver­knüp­fun­gen immer wich­ti­ger. Es genügt nicht mehr zu sagen: „Dann ruft der halt an!“, oder: „Das weiß der doch!“.

Tut er nicht.

Soweit klingt das alles ziem­lich theo­re­tisch. Was bedeu­tet das in der Pra­xis und wor­in unter­schei­det sich der Hyper­link von sei­nem älte­ren Bru­der, dem Quer­ver­weis?

Quer­ver­weis

Der klas­si­sche Quer­ver­weis ist ein Kind des Papier­me­di­ums: Er lei­tet den Rezi­pi­en­ten auf eine ande­re Sei­te und ver­langt dadurch, dass der aktu­el­le Infor­ma­ti­ons­pro­zess unter­bro­chen wird. Das min­des­te, was man von einem Quer­ver­weis daher ver­lan­gen kann, ist die Infor­ma­ti­on dar­über, wohin der Leser geführt wird (also eine Sei­ten­zahl), und was ihn dort erwar­tet (zum Bei­spiel das The­ma – erkenn­bar an der Über­schrift).¹

Bereits an die­ser Stel­le unter­schei­det der Tech­ni­sche Redak­teur die Qua­li­tät der Werk­zeu­ge: Kann as Pro­gramm Quer­ver­wei­se set­zen (mög­lichst kon­sis­tent) und auch ver­wal­ten? Han­dels­üb­li­che Office-Uten­si­li­en schei­den hier aus, denn so vie­le Fea­tures ein Word (bei­spiels­wei­se) hat — es kann kei­ne ver­nünf­ti­gen Quer­ver­wei­se.²

Hyper­link

Im Gegen­satz zum Quer­ver­weis ist der Hyper­link ein Kind des Inter­net­zeit­al­ters: der Hyper­link benö­tigt kein Papier mehr, er ist noch nicht ein­mal auf Sei­ten ange­wie­sen, son­dern ver­weist auf vor­her defi­nier­te Sprung­zie­le. Dies kön­nen Über­schrif­ten sein wie beim Quer­ver­weis (sind es meist auch), es kön­nen aber auch ein­fa­che „Anker“ sein, also belie­bi­ge Stel­len, die der Redak­teur vor­her defi­niert.

Der Hyper­link hat aller­dings auch einen Nach­teil: als „Sprung­quel­le“³ kann jeder belie­bi­ge Text oder auch ein Bild die­nen. Wir haben uns dar­an gewöhnt, dass auf einer Inter­net­sei­te der Klick auf das Logo zur Start­sei­te führt, oder der Klick auf ein Bild auf der Start­sei­te zu dem dazu­ge­hö­ri­gen Arti­kel führt. Aber wenn im Text ein belie­bi­ges Wort als Hyper­link mar­kiert ist, wis­sen wir auf den ers­ten Blick nicht, wohin uns der Link führt.⁴

In der harm­lo­se­ren Ver­si­on einer tech­ni­schen Doku­men­ta­ti­on klickt der Benut­zer erst auf den Link, stellt dann fest, dass dies doch nicht zum gewünsch­ten Ziel führt, und ver­sucht zurück zu navi­gie­ren, nur um fest­zu­stel­len, dass er jetzt den „Faden ver­lo­ren“ hat. Das soll und darf nicht sein. Außer­dem kön­nen Hyper­links natur­ge­mäß kei­ne Sei­ten­zah­len. Da das Inter­net nicht wie ein Hand­buch hier­ar­chisch und line­ar auf­ge­baut ist, ist das nicht wei­ter schlimm. Die Gefahr, sich in der Navi­ga­ti­on der Hyper­links (und nicht nur ihrer Pfle­ge) zu ver­hed­dern, nimmt expo­nen­ti­ell zu: beim Ver­schie­ben der Infor­ma­ti­on muss der Anker ja „mit­wan­dern“. Ab 50 Hyper­links wird dies wäh­rend für den Redak­teur zu einer Her­ku­les­auf­ga­be — und 50 Hyper­links (wie auch Quer­ver­wei­se) sind eher tri­vi­al. In der gedruck­ten Doku­men­ta­ti­on geht das gar nicht.

So ein­fach Hyper­links zu set­zen sind, so umständ­lich sind sie in der Ver­wal­tung und so wenig hilf­reich sind sie bei der Aneig­nung von Infor­ma­tio­nen.

Was tun?

Wäre es nicht schön, man könn­te die Vor­tei­le bei­der Ver­knüp­fungs­ty­pen kom­bi­nie­ren — und viel­leicht sogar sinn­voll ver­wal­ten? Kann man. Mit Mad­cap Fla­re. Wie das geht, steht in einem kom­men­den Bei­trag.

1. Nur zu schrei­ben „sie­he Sei­te 123“ hat in etwa die glei­che Bedeu­tungs­tie­fe wie der Ruf „Ach­tung!“ – kein Leser weiß, was ihn auf der ange­ge­be­nen Sei­te erwar­tet oder wor­auf er ach­ten soll. In bei­den Fäl­len wird die­se Auf­for­de­rung nor­ma­ler­wei­se igno­riert. Die Mühe hät­te man sich auch spa­ren kön­nen. ↩

2. Daher ver­zich­ten dann vie­le Kol­le­gen auf das Set­zen der in Word recht auf­wän­di­gen Quer­ver­wei­se, wor­un­ter natür­lich die ein­gangs erwähn­te Qua­li­tät der Infor­ma­ti­ons­ver­knüp­fung lei­det. ↩

3. Die Stel­le, an der der Hyper­link ein­ge­fügt wird. ↩

4. Dies machen sich bei­spiels­wei­se Pro­gram­mie­rer von so genann­ten „Phis­hing-Mail“ zunut­ze: sie sug­ge­rie­ren ein Sprung­ziel, das nicht exis­tiert, son­dern zu einer ande­ren Sei­te führt oder bös­ar­ti­ge Soft­ware auf dem Rech­ner instal­liert. ↩