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

Prioritäten in der Technischen Dokumentation: Von Hasen und Igeln

03.08.201201.02.2022

Natür­lich sind zunächst ein­mal alle Pro­jek­te in der Tech­ni­schen Doku­men­ta­ti­on drin­gend. Ganz drin­gend. So zumin­dest nach Kun­den­aus­sa­ge. Und falls sie nicht sehr drin­gend sind, dann lie­gen sie durch Ver­schlep­pung und man­gels Berück­sich­ti­gung so lan­ge her­um, bis sie ganz drin­gend wer­den. Das ist das Schick­sal aller selbst­stän­di­gen Redak­teu­re: Sie haben kei­nen Ein­fluss auf die Ter­min­pla­nung der Kun­den. Ande­rer­seits ist das auch meist gar nicht nötig. Denn in der Tech­ni­schen Doku­men­ta­ti­on soll­te nach Wich­tig­keit und nicht nach Dring­lich­keit prio­ri­siert werden.Dringlichkeit ist eine Rei­hen­fol­ge nach Ter­mi­nen. Und je näher ein Ter­min rückt, des­to dring­li­cher wer­den die Auf­ga­ben, die bis zu die­sem Zeit­punkt erle­digt wer­den müs­sen. Aber nicht alle Auf­ga­ben sind gleich wich­tig, denn man­che Auf­ga­ben erle­di­gen sich von selbst, ande­re sind Vor­aus­set­zun­gen für nach­fol­gen­de Schrit­te. So kann bei­spiels­wei­se die Abga­be einer Doku­men­ta­ti­on auf Eng­lisch nicht vor der Frei­ga­be der Doku­men­ta­ti­on auf Deutsch erfol­gen – außer der Über­set­zer arbei­tet ger­ne dop­pelt.

Was aber ist wich­tig? Wel­che Tätig­kei­ten müs­sen unbe­dingt erfol­gen, um ande­re Tätig­kei­ten über­haupt erst aus­zu­lö­sen? Wel­che Tätig­kei­ten kön­nen zu einem belie­bi­gen Zeit­punkt erfol­gen, weil sie kei­ne Schrit­te vor­aus­set­zen oder kei­ne bedin­gen?

Hier kann sich ein Tech­ni­scher Redak­teur das Leben erstaun­lich ein­fach machen: Tech­ni­sche Doku­men­ta­tio­nen haben näm­lich eine inne­re, eine qua­si sys­tem­im­ma­nen­te Abfol­ge aus Hand­lungs­blö­cken, die in einer bestimm­ten Rei­hen­fol­ge auf­ein­an­der fol­gen müs­sen:

  1. Auf­wands­ab­schät­zung. Ange­nom­men, die Akqui­se ist erfolg­reich gewe­sen oder es han­delt sich um einen Fol­ge­auf­trag, muss zuerst für die Zeit­pla­nung eine Auf­wands­ab­schät­zung erfol­gen, die man dem Kun­den auch mit­teilt. Nicht nur, weil sich dar­aus der Preis der Doku­men­ta­ti­on ermit­teln lässt, son­dern auch der unge­fäh­re Zeit­ho­ri­zont der Fer­tig­stel­lung.
    Für eine Auf­wands­ab­schät­zung, die in der Tech­ni­schen Doku­men­ta­ti­on nicht beson­ders ein­fach ist, weil meist viel zu vie­le Unsi­cher­hei­ten bestehen, zer­legt man am Bes­ten den Doku­men­ta­ti­ons­pro­zess in klei­ne­re Schrit­te. Bei­spiels­wei­se nach Kapi­teln, zusätz­li­cher Recher­che, Orts­ter­mi­ne, Vor­la­gen­er­stel­lung und was sonst noch zum Pro­jekt gehört. Die­se Schrit­te wer­den dann mit einem unge­fäh­ren Stun­den­auf­wand ver­se­hen und addiert.
  2. Bestel­lung. Jetzt kommt es zum Schwur: akzep­tiert der Kun­de die Auf­wands­ab­schät­zung, kann dar­aus eine Bestel­lung wer­den. Die­se soll­te so detail­liert sein, dass wie in einem Pflich­ten­heft eine Fest­le­gung des Umfangs mög­lich ist, auf den man sich im Zwei­fels­fall immer zurück­zie­hen kann („Das war nicht bestellt. Da müs­sen wir noch ein paar Stun­den drauf­pa­cken …“), um nicht bei Rech­nungs­stel­lung böse Über­ra­schun­gen zu erle­ben. Und auch, weil dar­in der vor­aus­sicht­li­che Lie­fer­ter­min erkenn­bar ist, der von bei­den Sei­ten ange­nom­men wird.
    Nun gibt es immer wie­der Pro­jek­te, die so drin­gend sind, dass das kun­den­sei­ti­ge Bestell­we­sen nicht nach­kommt, weil es zwar beim Pro­jekt­lei­ter brennt, die Buch­hal­tung aber nach einem ande­ren Zeit­plan arbei­tet. Da ist Abwä­gung gefragt: bei gro­ßen Unter­neh­men soll­te man bis zur Bestel­lung kei­ne wei­te­re Zeit inves­tie­ren, ohne Gefahr zu lau­fen, dass man sei­nem Geld hin­ter­her­läuft. Bei mit­tel­stän­di­schen Unter­neh­men lässt sich über eine Zusa­ge per E‑Mail schon reden.
  3. Recher­che und Erstel­lung. Der Tech­ni­sche Redak­teur ist kein Mär­chen­on­kel, der sich die Inhal­te einer Doku­men­ta­ti­on bei Ker­zen­schein aus den Fin­gern saugt. Er braucht kom­pe­ten­te und ver­läss­li­che Ansprech­part­ner beim Kun­den. Ein Pro­gram­mie­rer, der aus rei­ner Hilfs­be­reit­schaft schon mal 80 Screen­shots schickt, ohne dass die­se so über­haupt im Pro­gramm ver­wen­det wer­den, ist genau­so unsin­nig wie die kom­men­tar­lo­se Über­las­sung von CAD-Model­len oder Bau­teil­zeich­nun­gen. Der Redak­teur ist nicht der Kon­struk­teur, selbst wenn er Inge­nieur sein soll­te. Der Redak­teur kennt das Pro­dukt nicht – das ist sein Stär­ke, nicht sein Man­ko. Er muss fra­gen. Und er muss sich dar­auf ver­las­sen kön­nen, dass die Ant­wor­ten kor­rekt sind.
    Manch­mal fragt er sogar mehr­mals das Glei­che, weil es dazu in einem ande­ren Zusam­men­hang Gesichts­punk­te gibt, die für die Doku­men­ta­ti­on an ande­rer Stel­le wich­tig sein kön­nen. Das ist kei­ne Dumm­heit, das ist sein Job.
  4. Kor­rek­tur­läu­fe. Ger­ne ver­nach­läs­sigt, aber immens wich­tig. Selbst wenn wäh­rend der Erstel­lung eigent­lich schon alles gesagt wur­de, dient die Kor­rek­tur­fas­sung der bei­der­sei­ti­gen Kon­trol­le, ob alles so ver­stan­den wie kom­mu­ni­ziert wur­de. Auch ist die Kor­rek­tur­fas­sung eine Über­sicht der kom­plet­ten Doku­men­ta­ti­on. Eine Kon­trol­le, ob die „inne­re Logik“ schlüs­sig ist, ob der Benut­zer der Doku­men­ta­ti­on auch die Infor­ma­tio­nen fin­den kann. Nichts ist schlim­mer, als wenn wenn sich bei­spiels­wei­se wich­ti­ge Infor­ma­tio­nen zu Anzieh­dreh­mo­men­ten an drei Stel­len in der Doku­men­ta­ti­on wie­der­fin­den – und dann noch ein­an­der wider­spre­chen.
  5. Frei­ga­be. Ohne Frei­ga­be kei­ne Über­set­zung und kei­ne Rech­nung. Jetzt kann es natür­lich sein, dass der Kun­de bereits mit der letz­ten Kor­rek­tur­fas­sung zufrie­den ist und sie qua­si impli­zit frei­gibt, indem er sich nicht wei­ter mel­det. So ehren­voll das sein mag, für den Redak­teur bedeu­tet das, dass er auf einer unvoll­stän­di­gen Lie­fe­rung sit­zen bleibt, weil er sich nicht auf eine Fer­tig­stel­lung beru­fen kann. Um dem Auf­trag­ge­ber die Angst zu neh­men, er müs­se bei spä­te­ren klei­nen Ände­run­gen noch­mals tief in die Tasche grei­fen, bleibt auch für den Redak­teur die Gewähr­leis­tungs­pflicht: Er hat sich ver­pflich­tet, nach bes­tem Wis­sen und Gewis­sen eine Doku­men­ta­ti­on zu erstel­len, die den aktu­el­len Nor­men ent­spricht. Wenn dabei Feh­ler ent­ste­hen (und das ist nur mensch­lich), dann kann er in gerin­gem Umfang zur Nach­bes­se­rung ver­don­nert wer­den – ohne dies in Rech­nung stel­len zu kön­nen. Selbst wenn also die Doku­men­ta­ti­on frei­ge­ge­ben und die Rech­nung gestellt (und hof­fent­lich) auch bezahlt wur­de, ist der Redak­teur als Dienst­leis­ter noch nicht aus dem Schnei­der.

Die­se fünf Eck­punk­te legen die Prio­ri­sie­rung der dahin­ter ste­hen­den Tätig­kei­ten fest. Aus ihnen ergibt sich dann auch die Ter­mi­nie­rung der Auf­ga­ben – und damit die Dring­lich­keit.

Für ein Pro­jekt mag sich das noch banal anhö­ren, wirk­lich kom­plex wird es bei 10 – 15 gleich­zei­ti­gen Pro­jek­ten, die natür­lich alle drin­gend sind. Hier ent­steht noch ein zusätz­li­cher Punkt: Wo und wie bedin­gen sich die­se Pro­jek­te gegen­sei­tig? Gibt es Pro­jek­te, die ab einem gewis­sen Sta­di­um (bei­spiels­wei­se den Kor­rek­tur­läu­fen) schon das nächs­te mög­lich machen? Oder ver­dop­pelt eine sol­che Über­lap­pung den Kor­rek­tur­auf­wand? Las­sen sich Tätig­kei­ten zusam­men­fas­sen, die für alle Pro­jek­te wich­tig sind, wie bei­spiels­wei­se die Erstel­lung eines Impres­sums oder die Fest­le­gung der Kapi­tel­rei­hen­fol­ge?

Zusam­men­ge­fasst

Bei allen Über­le­gun­gen soll­te man nicht über­se­hen, dass wir Redak­teu­re Men­schen sind, kei­ne Maschi­nen. Wir sind selbst bei hoch­gra­di­ger Effi­zi­enz nur von beschränk­ter Ein­sicht in die Pro­duk­te des Auf­trag­ge­bers. Und wir sind mehr oder weni­ger anfäl­lig für Über­las­tung und Irr­tü­mer. Das soll­ten wir uns ein­ge­ste­hen und – wie es ein guter Pro­jekt­pla­ner auch macht – Puf­fer ein­pla­nen. Ent­we­der, indem wir Zeit­fens­ter öff­nen, oder indem wir unse­re Kapa­zi­tä­ten nach unten rech­nen (75% ist da ein annehm­ba­rer Wert). Von jeder Stun­de, die wir ver­pla­nen, sind 15 Minu­ten nicht unmit­tel­bar auf das Pro­jekt anre­chen­bar. Das ist die Zeit, die wir brau­chen, um eine Tele­fon­num­mer zu suchen, einen Kaf­fee zu holen, eine neu ein­tref­fen­de Mail zu lesen und abzu­le­gen, die nächs­ten Tätig­kei­ten zu pla­nen oder ein­fach nur mal das Geta­ne zu revi­die­ren.

Dies muss in die Prio­ri­sie­rung mit ein­flie­ßen, denn es sind wich­ti­ge Schrit­te. Sonst wer­den sie näm­lich drin­gend.

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 …
redaktion

Beitrags-Navigation

Previous post
Next post

Related Posts

redaktion brown grass field under the cloudy sky

Der Technische Redakteur: »Survival of the Fittest«?

01.04.200823.01.2022

(Der Titel ist absicht­lich in der eng­li­schen Ori­gi­nal­fas­sung, da die deut­sche Über­set­zung mit »Über­le­ben des…

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
redaktion

Zeitplanung in der Technischen Dokumentation: Laokoon und das Kalenderblatt

29.09.201107.04.2018

Ein unter Dienst­leis­tern in der tech­ni­schen Doku­men­ta­ti­on sehr häu­fig anzu­tref­fen­des Pro­blem ist der stän­di­ge Kampf…

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
redaktion yellow geometric staircase in contemporary apartment

Das magische Dreieck der Redaktion: Was braucht der Kunde?

26.02.201101.02.2022

In der Tech­ni­schen Doku­men­ta­ti­on ist es ganz ein­fach: Der Chef kommt zum Redak­teur und spricht…

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:

  • Kinomap richtig einstellen
  • Kritzeln auf Tafeln, Teil 7: Richtiges konstruieren mit Shapr3D
  • Silbentrennung korrigieren und Sprache anpassen in InDesign
  • Kinomap: Die Auspower-App für Ausdauersportler
  • Fritzchens Ode an den Mai
  • Rennradtouren planen
  • Wladimir Putin: Vera Putinas verlorener Sohn | ZEIT ONLINE
  • EPS QuickLook in macOS 12 aktivieren
  • Radtour: Normandie in heiß und trocken
  • Screenshots in der Dokumentation: Leichter mit SVG

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