Eine der schlimms­ten Vor­stel­lun­gen des Tech­ni­schen Redak­teurs ist die „Brainstorming“-artige Infor­ma­ti­ons­ver­mitt­lung des Pro­gram­mie­rers oder Kon­struk­teurs. Die Per­son, die sich am bes­ten mit den Eigen­hei­ten der zu beschrei­ben­den Anla­ge, Maschi­ne oder Soft­ware aus­kennt, ist froh, einen Zuhö­rer gefun­den zu haben, dem er sein geball­tes Wis­sen um die Mate­rie zu Füßen legen kann.

Schlimm des­we­gen, weil es in halb­schrift­li­cher Form ohne Rück­sicht auf inne­re Logik und Kon­sis­tenz aus­ge­brei­tet wird und die meis­te Zeit damit ver­bringt, die­sen Dschun­gel mit inqui­si­to­ri­scher Uner­bitt­lich­keit zu durch­fors­ten auf der Suche nach den wirk­lich brauch­ba­ren Infor­ma­tio­nen, sol­chen, die auch für den Benut­zer rele­vant sein kön­nen. Dem Infor­ma­ti­ons­lie­fe­rant einer­seits dar­zu­stel­len, dass man die Mole­ku­lar­struk­tur des Werk­stoffs als Leser der Doku­men­ta­ti­on nicht wis­sen muss, um die Maschi­ne ein­zu­schal­ten, oder auch kei­ne Ahnung von rekur­siv ablau­fen­den Shell-Scripts haben muss, um eine Daten­si­che­rung durch­zu­füh­ren, ist nicht immer einfach.

Hat man aber nun erfolg­reich die Infor­ma­ti­ons­flut bewäl­tigt, die Untie­fen erkannt, die logi­schen Hand­lungs­schrit­te anein­an­der gereiht, beginnt das nächs­te Übel: Wie soll sich der Leser zurecht fin­den? Hand­lungs­fol­gen sind nicht immer line­ar, son­dern häu­fig auch mit Sprün­gen und Rück­ver­wei­sen ver­se­hen („Falls A nicht zutrifft, lesen Sie wei­ter bei C.“ oder „Wenn Sie Schritt 12 bis 32 durch­ge­führt haben, drü­cken Sie „X“ und wie­der­ho­len Sie die Schrit­te 7 bis 12, um die Soft­ware zu konfigurieren.“)

Das kann man nur mit Blei­stift – oder bes­ser mit meh­re­ren Bunt­stif­ten – lesen, indem man sich Mar­kie­run­gen an den Rand macht. Da hel­fen auch kei­ne gut gemein­ten Quer­ver­wei­se mit Sei­ten­zah­len. Was also tun? Immer­hin han­delt es sich ja um kom­ple­xe und mit­un­ter lang­wie­ri­ge Vor­gän­ge und Aktio­nen. Man kann ja nicht ein­fach jeden zwei­ten Satz strei­chen, um das Gan­ze abzu­kür­zen, oder meh­re­re Sät­ze inein­an­der flech­ten, in der Hoff­nung, dass der Benut­zer, der mög­li­cher­wei­se wäh­rend des Betriebs oder der Inbe­trieb­nah­me des Geräts unter erheb­li­chem Stress steht, dies auch ver­steht. So in die­sem Stil.

Ein anschau­li­ches Bei­spiel der abschre­cken­den Wir­kung lan­ger Tex­te kommt aus der Online-Redak­ti­on, die immer schon das Pro­blem hat, dass das Lesen lan­ger Tex­te am Bild­schirm leich­ter ermü­det als auf dem Papier: Tho­mas Wirth, Autor von „Mis­sing Links /​/​ Über gutes Web­de­sign“ nennt es den „Eis­berg-Effekt“, der dar­aus ent­steht, dass lan­ge Sei­ten im Inter­net unter der Bild­schirm­un­ter­kan­te ver­schwin­den wie ein Eis­berg unter der Was­ser­ober­flä­che. Was dem Web­de­si­gner die Bild­schirm­un­ter­kan­te ist, ist dem Tech­ni­schen Redak­teur das Sei­ten­en­de (oder eben tat­säch­lich die Bild­schirm­un­ter­kan­te bei einer schlech­ten Online-Hil­fe, wie sie uns ein bekann­ter Soft­ware-Her­stel­ler aus Red­mond erzeugt: Ohne Roll­rad kom­men Sie nicht weit).

Auch viel Text ist mit Mar­gi­na­li­en übersichtlicher
Das ist kei­ne wirk­li­che Gebrauchs­tüch­tig­keit, neu­deutsch „Usa­bi­li­ty“. Hier kommt der Redak­teur ins Spiel: Die Infor­ma­tio­nen in den Lis­ten (letzt­end­lich sind ja auch Hand­lungs­schrit­te eine beson­de­re Art von Lis­te) müs­sen in mund­ge­rech­ten Hap­pen zer­legt wer­den. Zwi­schen­über­schrif­ten müs­sen her. Selbst wenn es inhalt­lich nicht rasend viel Sinn macht, las­sen sich durch Zwi­schen­über­schrif­ten (bei­spiels­wei­se in Mar­gi­na­li­en) sehr gut Lese-Etap­pen mar­kie­ren, die sug­ge­rie­ren, man habe es bereits so weit geschafft. Da darf man auch ruhig groß­zü­gig sein: zwei bis fünf Mar­gi­na­li­en pro Sei­te sind durch­aus angebracht.

Wie an den Spros­sen einer Lei­ter han­gelt sich der Leser damit durch den Text, kann immer wie­der auf die letz­te Stu­fe zurück sprin­gen und fin­det auch schnel­ler wie­der den Ein­stieg, wenn er einen Block überspringt.

Zielgerichtetes Lesen

Ver­su­chen Sie den Text unter dem Gesichts­punkt des ziel­ge­rich­te­ten Lesens zu ver­fas­sen: Sie wol­len bei­spiels­wei­se wis­sen, wie man ein Bau­teil aus­tauscht. Da bie­ten sich min­des­tens zwei Mar­gi­na­li­en an: Aus­bau des defek­ten Bau­teils und Ein­bau des neu­en Bau­teils. Das funk­tio­niert selbst bei kleins­ten Ven­ti­len, und auch wenn Sie beim Ein­bau nur hin­schrei­ben, dass er in umge­kehr­ter Rei­hen­fol­ge zum Aus­bau durch­ge­führt wer­den muss (was natür­lich nur bei kur­zen Hand­lungs­fol­gen Sinn macht). Auto­ma­tisch kann der Leser dadurch den Ablauf in zwei seri­el­le Sequen­zen unterscheiden.

Bei par­al­le­len Sequen­zen (einer „falls – andernfalls“-Verzweigung) kön­nen Sie dar­über hin­aus die Mar­gi­na­li­en (oder Zwi­schen­über­schrif­ten) auch als Zie­le der Quer­ver­wei­se nut­zen: „Falls Sie einen Index erstel­len wol­len, wäh­len Sie A (->), falls Sie ein Inhalts­ver­zeich­nis erstel­len wol­len, wäh­len Sie B (->)“. (Und bei Online­hil­fen soll­ten die bei­den topics auch auf ver­schie­de­nen Sei­te stehen.)

Geben Sie dem Leser die Hil­fe­stel­lung, er dankt es Ihnen.