Eigent­lich hat­te ich schon beschlos­sen, es mit dem doch recht lan­gen Trak­tat zu Redak­ti­ons­sys­te­men in der Tech­ni­schen Doku­men­ta­ti­on bewen­den zu las­sen. Immer­hin ist der Text sehr theo­rie­las­tig, da es sich ja in ers­ter Linie um Über­le­gun­gen und Gedan­ken­spie­le zur Ein­füh­rung eines Redak­ti­ons­sys­tems han­delt. Und natür­lich den mög­li­chen Hür­den, die es zu bewäl­ti­gen gilt. Mit ande­ren Wor­ten: bis­lang ging es um die Pla­nungs­pha­se. Im Anschluss dar­an folgt die Ent­schei­dung: Ob über­haupt ein Redak­ti­ons­sys­tem Sinn macht und wenn ja, wel­ches. Die­se Fra­gen las­sen sich nicht pau­schal beant­wor­ten, denn sie hän­gen von einer Viel­zahl sehr unter­schied­li­cher Fak­to­ren ab.

Den­noch kann auch die Redak­ti­on selbst unab­hän­gig davon Vor­be­rei­tun­gen tref­fen, die sogar dann Sinn machen, wenn denn noch kei­ne Ent­schei­dung für ein Redak­ti­ons­sys­tem gefal­len ist. Denn – und das kann man nicht oft genug wie­der­ho­len: Auch ein Redak­ti­ons­sys­tem ist ein Sys­tem und erfor­dert von allen Betei­lig­ten eine sys­te­ma­tisch Vor­ge­hens­wei­se. Das Den­ken kön­nen die Maschi­nen nicht über­neh­men.

Die fol­gen­den Tipps mögen zwar banal klin­gen, aber im redak­tio­nel­len All­tag und unter dem Druck des All­tags fal­len so man­che Hand­grif­fe gern mal aus – und kön­nen bei der Ein­füh­rung eines Sys­tems dem Benut­zer auf die Füße fal­len. Die fol­gen­den Schrit­te kön­nen natür­lich des­halb auch ange­wen­det wer­den, wenn man kein Redak­ti­ons­sys­tem ein­setzt. Das Redak­ti­ons­sys­tem aber ist jedoch viel uner­bitt­li­cher als ein Mensch und straft „Groß­zü­gig­kei­ten“ mit teil­wei­se erheb­li­chem Mehr­auf­wand.

Umdenken

Bereits aus den bis­lang ange­stell­ten Über­le­gun­gen zu Redak­ti­ons­sys­te­men wird deut­lich, dass eine sys­te­ma­ti­sche Vor­ge­hens­wei­se ein teil­wei­se erheb­li­ches Umden­ken erfor­dert. Dies gilt erst recht für Redak­ti­ons­sys­te­me, denn die­se tren­nen uner­bitt­lich den Inhalt von der Form. Wo vor­her jeder Text, der bei­spiels­wei­se mit „Standard+Arial+16pt+fett“ und „18 Punkt Zei­len­ab­stand unten“ for­ma­tiert war, als Über­schrift durch­ging – selbst wenn er nur 17 Punkt Zei­len­ab­stand unten hat­te, erkennt das Sys­tem nur Über­schrif­ten, kei­ne Schrift­schnit­te oder Zei­len­schal­tun­gen an. For­mat­an­ga­ben wer­den uner­bitt­lich gelöscht. Das führt dazu, dass bei der Daten­mi­gra­ti­on (oder dem Über­schrei­ben der Doku­ment­vor­la­ge) das Sys­tem unwei­ger­lich eine Zuord­nung trifft und die vor­han­de­nen For­mat­an­ga­ben einem Ele­ment zuord­net. Alle Abwei­chun­gen, also bei­spiels­wei­se ein geän­der­ter Zei­len­ab­stand, wer­den nicht als Über­schrift aner­kannt. Und der Redak­teur ver­bringt zahl­lo­se Stun­den damit, jeden Text­bau­stein nach die­sen „Aus­rei­ßern“ zu durch­su­chen.

Das muss aber nicht sein. Sie kön­nen dem Pro­blem auch im Redak­ti­ons­all­tag mit ein­fa­chen Mit­teln begeg­nen:

  • Nut­zen Sie die im Pro­gramm (Word, Frame­Ma­ker et al.) vor­han­de­nen Mög­lich­kei­ten, die „irre­gu­lä­ren“ For­ma­te in regu­lä­re For­ma­te (also sol­che, die laut Vor­la­ge zuge­wie­sen sein soll­ten) zu über­füh­ren.
  • Löschen Sie alle Zei­len­schal­tun­gen ohne Inhalt (Leer­zei­len) bei­spiels­wei­se per Suchen und Erset­zen. Abstän­de zwi­schen Zei­len müs­sen grund­sätz­lich und immer über die For­mat­an­ga­ben gesteu­ert wer­den.
  • Pas­sen Sie die ver­wen­de­ten Bil­der und Gra­fi­ken an. Die weit ver­brei­te­te Ange­wohn­heit, ein Bild oder eine Gra­fik nach­träg­lich im Text­ver­ar­bei­tungs­pro­gramm noch mit Num­mern und Pfei­len zu ver­se­hen, führt oft schon in „nor­ma­len“ Doku­men­ten zu Pro­ble­men. In einem Redak­ti­ons­sys­tem geht das gar nicht. Alle Objek­te in einer Dar­stel­lung müs­sen auch in der Dar­stel­lung abge­legt sein. Das bedeu­tet, dass hier ein Bild­be­ar­bei­tungs- oder Illus­tra­ti­ons­pro­gramm zum Ein­satz kom­men muss. Wie man das recht unkom­pli­ziert lösen kann, habe ich an ande­rer Stel­le beschrie­ben.

Vorbauen

Auch ein Redak­ti­ons­sys­tem ver­fügt über eine Art Abla­ge­struk­tur: Ord­ner für Text­bau­stei­ne und Ord­ner für Bil­der und Gra­fi­ken. Selbst wenn sich die­se Ord­ner viel­leicht nicht ganz so bedie­nen las­sen, wie Sie es vom Ihrem Betriebs­sys­tem her gewohnt sind, so erfül­len sie doch einen ähn­li­chen Zweck: Sie schaf­fen Ord­nung. Dies umso mehr, als sie auch einer ein­heit­li­chen Benen­nung bedür­fen, um die Über­sicht­lich­keit und Kon­sis­tenz zu gewähr­leis­ten. Sie benö­ti­gen Ord­ner für Pro­dukt­va­ri­an­ten, für Kapi­tel, für pro­dukt­un­ab­hän­gi­ge Text­bau­stei­ne und für Vor­la­gen. Die­se kön­nen dann wie­der­um Ord­ner ent­hal­ten, die das Pro­dukt oder die Vari­an­ten bes­ser klas­si­fi­zie­ren.

  • Legen Sie eine Abla­ge­struk­tur fest, bevor Sie das Redak­ti­ons­sys­tem zum ers­ten Mal star­ten. Beim Import der ers­ten Daten in das Redak­ti­ons­sys­tem haben Sie bereits die Mög­lich­keit, den Abla­ge­ort der Text­bau­stei­ne und Bil­der anzu­ge­ben.
  • Geben Sie den Gra­fi­ken ein­deu­ti­ge Namen, damit sie wie­der­ge­fun­den und zuge­ord­net wer­den kön­nen.

Das Redak­ti­ons­sys­tem wird die Tex­te und Bil­der in Ihrem impor­tier­ten Doku­ment tren­nen und in die ange­leg­ten und zuge­wie­se­nen Ord­ner ver­schie­ben – nur um sie dann beim Öff­nen des Text­bau­steins wie­der zusam­men­zu­füh­ren. Sobald näm­lich erst ein­mal 500 Text­bau­stei­ne und 400 Bil­der impor­tiert sind, wird es zuneh­mend müh­sa­mer, die Bestand­tei­le der Text­bau­stei­ne nach­träg­lich kor­rekt zuzu­ord­nen.

Das gilt übri­gens auch für ein Abla­ge­sys­tem auf Datei­ebe­ne.

Zusammennageln

Der drit­te und schwie­rigs­te Teil – und der Teil, der spä­ter das meis­te Kopf­zer­bre­chen berei­tet – ist die eigent­li­che Doku­ment­struk­tur, die eigent­li­che inhalt­li­che Glie­de­rung des Doku­ments. Aus Sicht des Sys­tems kön­nen Sie jeden Kno­ten an jede Stel­le schie­ben und auch mehr­fach ver­wen­den. Sie kön­nen pro­blem­los in Pro­dukt­va­ri­an­te 1 die Tech­ni­schen Daten direkt nach dem Inhalts­ver­zeich­nis anfüh­ren und in Vari­an­te 2 mit­ten im Kapi­tel zur Inbe­trieb­nah­me. Oder den sel­ben Abschnitt mehr­mals im Doku­ment unter­brin­gen. Da sind der Krea­ti­vi­tät da kei­ne Gren­zen gesetzt …

Hier ist der Tech­ni­sche Redak­teur gefragt. Die Redak­ti­on legt fest, wel­che Text­bau­stei­ne in wel­cher Rei­hen­fol­ge im fer­ti­gen Doku­ment erschei­nen wer­den und wie sich die­se Text­bau­stei­ne auf­ein­an­der inhalt­lich bezie­hen. Oft wer­den näm­lich schon  bei der Betrach­tung des Sta­tus Quo die Lücken und Inkon­sis­ten­zen in der Doku­men­ta­ti­on deut­lich, die Sie durch das Redak­ti­ons­sys­tem mit­un­ter wesent­lich leich­ter stop­fen kön­nen – sofern Sie denn die­se iden­ti­fi­ziert haben.

  • Stel­len Sie sich dazu einen „Struk­tur­baum“, eine inhalt­li­che Glie­de­rung zusam­men, anhand der Sie das fer­ti­ge Doku­ment spä­ter wie­der „zusam­men­na­geln“ kön­nen. Wie man das macht, kön­nen Sie hier nach­le­sen. Für die­se „Kar­te“ (Fach­lau­te wer­den eine Ähn­lich­keit zu einer DITA-Map erken­nen) kön­nen Sie jede Text­ver­ar­bei­tung oder jedes Glie­de­rungs-Pro­gramm benut­zen.
  • Legen Sie für jedes Pro­dukt eine Glie­de­rung an und ver­mer­ken Sie für jeden Abschnitt den Bear­bei­tungsszu­stand bzw. die zu bear­bei­ten­den Doku­ment­bau­stei­ne (Gra­fik, Tabel­le, Text etc.). Das hilft, die wich­tigs­ten Löcher zuerst zu stop­fen und erleich­tert es den Kol­le­gen, Ihnen gege­be­nen­falls unter die Arme zu grei­fen.
  • Tes­ten Sie Ihre Über­le­gun­gen an der Doku­men­ta­ti­on eines Pro­dukts, das nicht häu­fig nach­ge­fragt wird.
  • Ver­fei­nern Sie schritt­wei­se die Struk­tur und den Inhalt. Doku­men­ta­ti­on ist nie fer­tig.

Fazit

Eigent­lich soll­te der Umstieg auf ein Redak­ti­ons­sys­tem ein­fach sein, wenn vor­her bereits redak­tio­nell sys­te­ma­tisch gear­bei­tet wur­de. Lei­der ist dies aus den unter­schied­lichs­ten Grün­den oft nicht der Fall. Natür­lich kön­nen Sie sich dazu Hil­fe holen durch exter­ne Mit­ar­bei­ter. Aber auch die­se müs­sen ein­ge­wie­sen wer­den und benö­ti­gen Unter­stüt­zung bei der Ein­ar­bei­tung in Ihre Sys­te­ma­tik. Die­ser Teil der Arbeit bleibt glück­li­cher­wei­se immer an Ihnen hän­gen. Glück­li­cher­wei­se, weil das groß­ar­tigs­te Werk­zeug der Tech­ni­schen Redak­ti­on dabei zum Ein­satz kommt: das Gehirn.