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

leben, technik und kommunikation

Konzeptionelles Arbeiten in der Technischen Dokumentation: Wider die Linearität

03.03.201108.01.2022

Die Tech­ni­sche Doku­men­ta­ti­on ver­langt Papier. Sie schreit nach Papier, wenn es um die „Unter­la­gen“ geht, sie spuckt Papier aus, wenn es um die Aus­ga­be geht. Wir Tech­ni­schen Redak­teu­re begin­nen eine Tech­ni­sche Doku­men­ta­ti­on immer mit einem tat­säch­li­chen lee­ren Blatt Papier oder einem Bild­schirm, auf dem ein lee­res Blatt Papier dar­ge­stellt wird. Dann fan­gen wir an zu schrei­ben.

Web­links

  • Schreib­kom­pe­tenz
  • Seman­ti­sches Netz

Zunächst schrei­ben wir alles auf, was wir von unse­ren Infor­man­ten erfah­ren. Wir lachen mit Ihnen über die dum­men Anwen­der, schüt­teln den Kopf über die Bedie­ner, die es auch nach der drit­ten Erklä­rung immer noch nicht begrei­fen, in wel­che Rich­tung der Schal­ter zei­gen soll. Und wir füh­len uns genö­tigt, allen Anwe­sen­den zu demons­trie­ren, dass wir nicht so sind wie die Benut­zer, dass wir mit den geis­ti­gen Urhe­bern des Pro­dukts auf Augen­hö­he ste­hen, das Pro­dukt begrei­fen und unse­re Arbeit wert­voll ist. Vor allem für den Auf­trag­ge­ber.

Wir stöh­nen über Auf­trag­ge­ber, die uns erklä­ren, dass sie eine Anlei­tung sowie­so nicht lesen. Sie ken­nen ja schließ­lich das Pro­dukt. Sie haben es seit sei­ner Ent­ste­hung in den Köp­fen und auf dem Reiß­brett beglei­tet. Sie sind sei­ne Väter und ent­spre­chend stolz dar­auf.

Die Doku­men­ta­ti­on als Roman

Die­sen Stand­punkt und die­se Sicht­wei­se machen wir uns zu eigen: Wir leben mit dem Pro­dukt, wir voll­zie­hen jeden Ent­wick­lungs­schritt geis­tig nach, wir kau­en die Eigen­schaf­ten des Pro­dukts durch und ent­de­cken es für uns selbst. Und das sieht man den Doku­men­ta­tio­nen dann an. Unse­re Tex­te und Bil­der spie­geln jenes musea­le Inter­es­se wider, das man auch den Wer­ken gro­ßer Meis­ter ent­ge­gen bringt: „Toll! Wie haben die das nur gemacht? Und hier, sieh mal das Detail dort in der Ecke. Toll!“ …

Wir schrei­ben unse­re Doku­men­ta­ti­on über die Lebens­dau­er des Pro­dukts, so wie man einen Roman über die Wan­der­jah­re des Lehr­bur­schen schreibt, bis er zum Meis­ter wird (oder das Pro­dukt an den Kun­den gelie­fert wird). Und eben­so wie ein Roman­schrei­ber wol­len wir den Leser mit­neh­men auf eine Rei­se durch das Pro­dukt, wol­len ihn begeis­tern und ani­mie­ren zum Ent­de­cken. Sehr lobens­wert. – Und so ziem­lich an der Rea­li­tät vor­bei.

Der Benut­zer des Pro­dukts legt sich die Doku­men­ta­ti­on näm­lich gewöhn­lich nicht auf den Nacht­tisch, um vor dem Schla­fen­ge­hen noch mal schnell die nächs­ten Sei­ten zu lesen. Das macht er bei einem Roman, der ist line­ar auf­ge­baut und Jeder, der ein paar Sei­ten über­springt, läuft Gefahr, die Schlüs­sel­stel­le zu ver­pas­sen. Bei einer Tech­ni­schen Doku­men­ta­ti­on macht er das nicht. Eine Tech­ni­sche Doku­men­ta­ti­on besteht nicht aus line­ar ange­ord­ne­ten Infor­ma­tio­nen (das ist nur bei ein­zel­nen Hand­lungs­fol­gen der Fall), sie besteht aus asso­zia­ti­ven Infor­ma­ti­ons­kno­ten.

Selbst­be­ob­ach­tung als Aus­gangs­punkt

Beob­ach­ten wir uns doch ein­mal selbst: Wann lesen wir eine Doku­men­ta­ti­on? Sogar in unse­rer eige­nen Doku­men­ta­ti­on sprin­gen wir gezielt zu den Stel­len, die geän­dert wer­den sol­len oder die wir benö­ti­gen. Dazu benut­zen wir ein Inhalts­ver­zeich­nis. (In Roma­nen gibt es das häu­fig gar nicht, was auch ein Zei­chen für den linea­ren Auf­bau ist, denn ein Roman braucht kei­ne Kapi­tel­über­sicht.) Oder wir benut­zen Quer­ver­wei­se. (Das ist in Roma­nen eben­so sel­ten, denn er ist ja line­ar: Die fol­gen­de Sei­te baut immer auf den Inhalt der vor­he­ri­gen Sei­ten auf.)

Im rea­len Leben machen wir das auch: wir suchen den Schlüs­sel für die Haus­tür und nicht den Bau­plan für das Haus. Für jede Infor­ma­ti­on set­zen wir still­schwei­gend vor­aus, dass sie exis­tiert, nicht dass wir sie lesen müs­sen. Wir ver­wen­den Infor­ma­tio­nen asso­zia­tiv: Wir benut­zen sie dann, wenn wir sie brau­chen und han­geln uns bei Bedarf von einem Kno­ten zum nächs­ten.

Wenn wir die gesuch­te Infor­ma­ti­on nicht fin­den, eska­lie­ren wir auf die nächs­te Stu­fe: Aus­ge­hend von den Infor­ma­tio­nen die wir gefun­den haben, ent­schei­den wir, wel­che Infor­ma­tio­nen noch feh­len oder ergänzt wer­den müs­sen. Dann benut­zen wir ein Glos­sar oder ver­su­chen anhand des Inhalts­ver­zeich­nis­ses (das ja auch nur eine Samm­lung von Quer­ver­wei­sen ist) oder von Quer­ver­wei­sen zu den wei­ter­füh­ren­den Infor­ma­tio­nen zu gelan­gen. Wir arbei­ten infor­ma­ti­ons-öko­no­misch.

Anwen­der­sicht

War­um aber tun wir so, als ob unse­re Leser Zeit haben, einen Roman zu lesen? War­um schrei­ben wir nicht asso­zia­tiv? War­um ver­knei­fen wir uns die struk­tu­rel­le Vor­ar­beit, die ver­füg­ba­ren Infor­ma­tio­nen in asso­zia­ti­ve Häpp­chen zu zer­le­gen und die­se mit­ein­an­der zu ver­bin­den (bei­spiels­wei­se mit Quer­ver­wei­sen)?

Der Schritt von der linea­ren zu einer asso­zia­ti­ven Doku­men­ta­ti­on ist nicht ein­fach, gewiss. Er setzt ein hohes Maß an Eigen­be­ob­ach­tung vor­aus und auch eine abs­tra­hie­ren­de und struk­tu­rie­ren­de Vor­ge­hens­wei­se. Statt ein­fach drauf­los zu tip­pen wie eine tech­nisch vor­ge­bil­de­te Schreib­kraft müs­sen wir erst sor­tie­ren, gewich­ten, ein­ord­nen, prio­ri­sie­ren, visua­li­sie­ren. Kurz: wir müs­sen unse­rem Beruf ange­mes­sen den­ken.

Wir müs­sen in der Lage sein, unse­re Sicht der Din­ge zu hin­ter­fra­gen, sie aber auch zu ver­tre­ten und umzu­set­zen. Wir müs­sen berech­tig­te Kri­tik ein­ar­bei­ten und unser Modell der Benut­zer­füh­rung zu erwei­tern. Wir müs­sen uns die Sicht des Anwen­ders zu eigen machen, den wir nicht ken­nen, statt die Sicht des Her­stel­lers, der uns gegen­über sitzt. Wir müs­sen bei­tra­gen, nicht unbe­se­hen wei­ter­ge­ben. Wir sind Tech­ni­sche Redak­teu­re und als sol­che Spe­zia­lis­ten für die Infor­ma­ti­ons­ver­mitt­lung.

Oder wir fin­den uns damit ab, ein­fach eine teu­re­re Schreib­kraft zu sein.

Tei­len mit:

  • Zum Tei­len auf Mast­o­don kli­cken (Wird in neu­em Fens­ter geöff­net) Mast­o­don
  • Kli­cken, um auf Whats­App zu tei­len (Wird in neu­em Fens­ter geöff­net) Whats­App
  • Kli­cken, um einem Freund einen Link per E‑Mail zu sen­den (Wird in neu­em Fens­ter geöff­net) E‑Mail
  • Kli­cken, um auf Blues­ky zu tei­len (Wird in neu­em Fens­ter geöff­net) Blues­ky
  • Mehr
  • Kli­cken zum Aus­dru­cken (Wird in neu­em Fens­ter geöff­net) Dru­cken
  • Klick, um auf Lin­ke­dIn zu tei­len (Wird in neu­em Fens­ter geöff­net) Lin­ke­dIn
  • Kli­cken, um auf Tele­gram zu tei­len (Wird in neu­em Fens­ter geöff­net) Tele­gram
  • Klick, um auf Pin­te­rest zu tei­len (Wird in neu­em Fens­ter geöff­net) Pin­te­rest

Gefällt mir:

Gefällt mir Wird gela­den …
dokumentation RedaktionstrukturtechdokTechnische Dokumentation

Beitrags-Navigation

Previous post
Next post

Related Posts

Punkt, Punkt, Contra Strich

28.10.200219.10.2023

Eine gera­de Linie ist eine Ver­bin­dung zwi­schen zwei Punk­ten. Um eine Kur­ve dar­zu­stel­len, benö­tigt man…

Tei­len mit:

  • Zum Tei­len auf Mast­o­don kli­cken (Wird in neu­em Fens­ter geöff­net) Mast­o­don
  • Kli­cken, um auf Whats­App zu tei­len (Wird in neu­em Fens­ter geöff­net) Whats­App
  • Kli­cken, um einem Freund einen Link per E‑Mail zu sen­den (Wird in neu­em Fens­ter geöff­net) E‑Mail
  • Kli­cken, um auf Blues­ky zu tei­len (Wird in neu­em Fens­ter geöff­net) Blues­ky
  • Mehr
  • Kli­cken zum Aus­dru­cken (Wird in neu­em Fens­ter geöff­net) Dru­cken
  • Klick, um auf Lin­ke­dIn zu tei­len (Wird in neu­em Fens­ter geöff­net) Lin­ke­dIn
  • Kli­cken, um auf Tele­gram zu tei­len (Wird in neu­em Fens­ter geöff­net) Tele­gram
  • Klick, um auf Pin­te­rest zu tei­len (Wird in neu­em Fens­ter geöff­net) Pin­te­rest

Gefällt mir:

Gefällt mir Wird gela­den …
Read More
dokumentation

Eine seltsame Lücke

04.05.201630.12.2023

Passt Frame­Ma­ker im Zeit­al­ter der mobi­len Doku­men­ta­ti­on nicht mehr zwi­schen Text­ver­ar­bei­tung und Redak­ti­ons­sys­tem?

Tei­len mit:

  • Zum Tei­len auf Mast­o­don kli­cken (Wird in neu­em Fens­ter geöff­net) Mast­o­don
  • Kli­cken, um auf Whats­App zu tei­len (Wird in neu­em Fens­ter geöff­net) Whats­App
  • Kli­cken, um einem Freund einen Link per E‑Mail zu sen­den (Wird in neu­em Fens­ter geöff­net) E‑Mail
  • Kli­cken, um auf Blues­ky zu tei­len (Wird in neu­em Fens­ter geöff­net) Blues­ky
  • Mehr
  • Kli­cken zum Aus­dru­cken (Wird in neu­em Fens­ter geöff­net) Dru­cken
  • Klick, um auf Lin­ke­dIn zu tei­len (Wird in neu­em Fens­ter geöff­net) Lin­ke­dIn
  • Kli­cken, um auf Tele­gram zu tei­len (Wird in neu­em Fens­ter geöff­net) Tele­gram
  • Klick, um auf Pin­te­rest zu tei­len (Wird in neu­em Fens­ter geöff­net) Pin­te­rest

Gefällt mir:

Gefällt mir Wird gela­den …
Read More
dokumentation

Redaktionssysteme: Leidensdruck oder Knopfdruck?

26.10.201212.11.2019

Dem Mit­tel­stand in Deutsch­land haf­tet der Geruch an, bie­der und klein­bür­ger­lich zu sein. Das gilt…

Tei­len mit:

  • Zum Tei­len auf Mast­o­don kli­cken (Wird in neu­em Fens­ter geöff­net) Mast­o­don
  • Kli­cken, um auf Whats­App zu tei­len (Wird in neu­em Fens­ter geöff­net) Whats­App
  • Kli­cken, um einem Freund einen Link per E‑Mail zu sen­den (Wird in neu­em Fens­ter geöff­net) E‑Mail
  • Kli­cken, um auf Blues­ky zu tei­len (Wird in neu­em Fens­ter geöff­net) Blues­ky
  • Mehr
  • Kli­cken zum Aus­dru­cken (Wird in neu­em Fens­ter geöff­net) Dru­cken
  • Klick, um auf Lin­ke­dIn zu tei­len (Wird in neu­em Fens­ter geöff­net) Lin­ke­dIn
  • Kli­cken, um auf Tele­gram zu tei­len (Wird in neu­em Fens­ter geöff­net) Tele­gram
  • Klick, um auf Pin­te­rest zu tei­len (Wird in neu­em Fens­ter geöff­net) Pin­te­rest

Gefällt mir:

Gefällt mir Wird gela­den …
Read More

Beliebt:

  • Schematische Darstellung: Die Prinzipien sehen
  • Silbentrennung korrigieren und Sprache anpassen in InDesign
  • Rennradtouren planen
  • Kinomap richtig einstellen
  • Die richtige Schrift für die technische Dokumentation
  • Mehrere Pfade in Illustrator auf einmal verbinden

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.

©2025 readit | WordPress Theme by SuperbThemes
%d
    Zum Ändern Ihrer Datenschutzeinstellung, z.B. Erteilung oder Widerruf von Einwilligungen, klicken Sie hier: Einstellungen