Wenn ich allei­ne die Bedie­nungs­an­lei­tung von mei­nem Toas­ter sehe: die schmei­ße ich unge­öff­net in den Müll!“. Ehr­lich gesagt: ich auch. Und das, obwohl ich weiß, wie­viel Arbeit dahin­ter steckt, eine Doku­men­ta­ti­on zu erstel­len, wie­viel Über­zeu­gungs­ar­beit und Über­re­dung, wie­viel Schmerz­to­le­ranz und Igno­ranz einem Tech­ni­schen Redak­teur abver­langt wer­den. Am Ende zählt nur das Ergeb­nis. Und das soll mög­lichst bil­lig, mög­lichst schnell und mög­lichst rechts­si­cher sein. Das gilt natür­lich bei „gro­ßen“ Doku­men­ta­tio­nen wie im Anla­gen­bau noch mehr als bei einem Toas­ter. Es geht aber.

Die hier vor­ge­stell­te Vor­ge­hens­wei­se ent­stammt mei­ner lang­jäh­ri­gen Erfah­rung im Anla­gen­bau. Sie hat sich als die für mich effi­zi­en­tes­te Her­an­ge­hens­wei­se her­aus­ge­stellt, die auch dem Pro­dukt­lei­ter und Auf­trag­ge­ber ein Höchst­maß an Trans­pa­renz ver­mit­telt. Alle Betei­lig­ten wis­sen damit schon recht früh, was sie erhal­ten wer­den – und was sie lie­fern müs­sen.

Aber Ach­tung! Wenn Sie nicht durch Pro­duk­ti­vi­tät und Effi­zi­enz auf­fal­len möch­ten oder dür­fen: Machen Sie immer den zwei­ten Schritt vor dem Ers­ten. Dann sind lan­ge Arbeits­zei­ten mit viel Frust garan­tiert …

Auch wenn es natür­lich die Ansprech­part­ner und Auf­trag­ge­ber einer Anla­gen­do­ku­men­ta­ti­on nicht so ger­ne hören, weil es ihren Stolz ver­letzt: Eine Doku­men­ta­ti­on ist eine Doku­men­ta­ti­on. Ob für einen Toas­ter oder eine Pro­duk­ti­ons­stra­ße. Es sind immer Maschi­nen, die von Men­schen trans­por­tiert, mon­tiert, bedient, gewar­tet und repa­riert wer­den. Zuge­ge­be­ner­ma­ßen sind die Toas­ter-Bedie­nungs­an­lei­tun­gen weni­ger umfang­reich, das liegt schon in der Natur der Sache, aber in ihrem Anspruch sind sie gleich: sie müs­sen von Men­schen mit mehr oder weni­ger tech­ni­schem Ver­ständ­nis in kur­zer Zeit ver­stan­den wer­den kön­nen.

Exkurs

Wäh­rend frü­her die Maschi­nen­be­schrei­bun­gen (und manch­mal auch die dar­aus ent­ste­hen­den Hand­lun­gen) von Tech­ni­kern für Tech­ni­ker geschrie­ben wur­den, und dem­entspre­chend ein ähn­li­cher Ver­ständ­nis­hin­ter­grund vor­aus­ge­setzt wer­den konn­te, ist seit eini­gen Jah­ren immer mehr die Anwen­der­ori­en­tie­rung gefragt, die Anlei­tung statt einer Beschrei­bung. Das hat tief grei­fen­de Kon­se­quen­zen: Wo man sich als Redak­teur frü­her dar­auf ver­las­sen konn­te, dass der Leser mit einer tech­ni­schen Zeich­nung zurecht­kam, ist das heu­te nicht mehr der Fall. Nicht, weil der Leser düm­mer gewor­den ist, son­dern weil er einen ande­ren Aus­bil­dungs­hin­ter­grund, einen ande­ren gesell­schaft­li­chen Hin­ter­grund und ein ande­res Ver­ständ­nis von Tech­nik besitzt. Der schnell ange­lern­te paki­sta­ni­sche Arbei­ter ist ja des­we­gen so bil­lig, weil er eben kei­nen Meis­ter­brief hat oder jah­re­lang an der Maschi­ne geschult wur­de. Aber auch der muss unfall­frei und zuver­läs­sig mit der Maschi­ne umge­hen kön­nen.

Planungsvorbereitung

Glie­de­rungs­an­sicht in Word 2010 (TM) (c) Micro­soft Inc.
An ande­rer Stel­le wur­de schon auf die geis­ti­ge Vor­weg­nah­me der Anwen­dungs­si­tua­ti­on ein­ge­gan­gen (sie­he hier), jetzt geht es dar­um, wie man als Redak­teur mit der Situa­ti­on umgeht, eine etwas umfang­rei­che­re Doku­men­ta­ti­on für eine Anla­ge erstel­len zu müs­sen. Dazu gehört nicht viel, aber dafür Wich­ti­ges:
  • Kei­ne Panik! Eine Doku­men­ta­ti­on ist eine Doku­men­ta­ti­on ist eine Doku­men­ta­ti­on.
  • Man lernt nur dazu: Beson­ders wäh­rend der Pla­nung ist es wich­tig, dass man Raum für Ver­bes­se­rung lässt.
  • Man muss das Rad nicht neu erfin­den: Wir ste­hen alle auf den Schul­tern von Rie­sen.
  • Erst pla­nen, dann arbei­ten: Immer einen Schritt nach dem ande­ren machen ohne das Ziel aus den Augen zu ver­lie­ren.

Planungsdurchführung

Und wenn Sie nun gedacht haben, jetzt packt er eine kom­ple­xe Pro­jekt­pla­nungs­soft­ware aus, die ich auch ger­ne mal aus­pro­bie­ren möch­te, die ich aber nie wer­de bestel­len dür­fen: Haha! So ein­fach und bequem dür­fen Sie es sich nie machen. Es unter­schei­det uns Tech­ni­sche Redak­teu­re ja vor allem von den Kol­le­gen, dass wir die all­täg­li­che Ver­wal­tung des Man­gels beherr­schen. Es man­gelt immer an Zeit, an Geld, an Res­sour­cen, an Infor­ma­ti­on. Das ist nor­mal. Die Tugend besteht dar­in, aus den vor­han­de­nen Res­sour­cen das Opti­ma­le her­aus­zu­ho­len. Effi­zi­enz also.

Wie aber geht man das Pro­blem an?

Neh­men Sie eine belie­bi­ge Text­ver­ar­bei­tung wie MS Word oder Open­Of­fice oder Ähn­li­ches und schal­ten Sie in den Glie­de­rungs­mo­dus (den soll­ten Sie haben, sonst geht es nicht).

Im Glie­de­rungs­mo­dus geben Sie ein­fach die Über­schrif­ten der Kapi­tel und Unter­ka­pi­tel ein. Selbst wenn die Doku­men­ta­ti­on der Anla­ge – was ich hof­fe – nicht in einem Office-Pro­gramm geschrie­ben wird, kön­nen Sie die­se Vor­ge­hens­wei­se nut­zen. Jetzt ent­steht unab­hän­gig von der Anla­ge oder Maschi­ne eine Art Inhalts­ver­zeich­nis, das Sie mit Kom­men­ta­ren und Anmer­kun­gen ver­se­hen kön­nen.

Ver­fei­nern Sie die­se Glie­de­rung bis auf die maxi­ma­le Tie­fe, fei­len Sie an den For­mu­lie­run­gen der Über­schrif­ten, denn die­se sind Ihre Infor­ma­ti­ons­kno­ten, die spä­ter so in der Doku­men­ta­ti­on auf­tau­chen wer­den.

Die­se Vor­ge­hens­wei­se hat den Vor­teil, dass Sie einen Über­blick gewin­nen über den Umfang und die logi­sche Rei­hen­fol­ge der Infor­ma­tio­nen. Sie erfas­sen damit die Doku­men­ta­ti­on auch im Hin­blick auf ihre Voll­stän­dig­keit und die schon vor­han­de­nen Bau­stei­ne. Vor­han­de­ne Infor­ma­tio­nen (bei­spiels­wei­se das Impres­sum) kön­nen sie näm­lich dann schon als „fer­tig“ kenn­zeich­nen. Und Sie sehen auf einen Blick, wel­che Infor­ma­tio­nen feh­len.

Und dann kommt der wich­tigs­te Schritt. Las­sen Sie die­se Glie­de­rung abseg­nen: bespre­chen Sie sich mit den Kol­le­gen, mit den Pro­dukt­ver­ant­wort­li­chen und ergän­zen Sie die Glie­de­rung. Erst wenn Sie die­se Tätig­keit abge­schlos­sen haben, dür­fen sie mit der eigent­li­chen Doku­ment­pro­duk­ti­on anfan­gen.

Hinein ins Gewühl

Im zwei­ten Schritt – und das muss wirk­lich immer erst der zwei­te Schritt sein – arbei­ten wir nach dem „Top-Down“-Prinzip. Mit der abge­nom­me­nen Glie­de­rung in der Hand star­ten wir unser Doku­men­ta­ti­ons­werk­zeug, also das Redak­ti­ons­sys­tem oder Frame­Ma­ker (etwas Ande­res wür­de ich zu die­sem Zweck nicht benut­zen) und erstel­len uns lee­re Infor­ma­ti­ons­kno­ten anhand der Über­schrif­ten. Bei Frame­Ma­ker wären es Text­ein­schü­be: für jede Über­schrift einen eige­nen Text­ein­schub. Die Rei­hen­fol­ge ist belie­big.

Mit dem geeig­ne­ten Tem­pla­te (mit oder ohne Struk­tur) for­ma­tie­ren Sie die Über­schrif­ten, die Sie per Copy & Pas­te aus der Glie­de­rung ein­ge­fügt haben) ent­spre­chend der in der Glie­de­rung vor­ge­se­he­nen Ebe­ne.

Halt! Immer noch nichts schrei­ben!

Nun stel­len sie die Text­ein­schü­be oder Infor­ma­ti­ons­kno­ten zu Kapi­teln und dann zu einem gan­zen Buch zusam­men. Rich­tig: ana­log zur Glie­de­rung. Sie erhal­ten nun eine kom­plet­te Betriebs­an­lei­tung, die nur aus Über­schrif­ten besteht. Und jetzt dür­fen Sie auch ein Inhalts­ver­zeich­nis gene­rie­ren. Denn dies ver­glei­chen Sie mit der Glie­de­rung.

Endlich

End­lich dür­fen Sie damit begin­nen, die noch lee­ren Infor­ma­ti­ons­kno­ten zu fül­len. Ver­ges­sen Sie dabei aber nicht, die Glie­de­rung mit­lau­fen zu las­sen: Löschen Sie die nicht mehr benö­ti­gen Kom­men­ta­re. Und wenn der Chef fragt, wie weit Sie sind, kön­nen Sie ihm in der Glie­de­rung sofort zei­gen, wie der Sta­tus Quo aus­sieht.

Ist doch ein­fach, oder?