(Bild­quel­le sie­he unten)
Alle wol­len weg vom Papier. Auch in der Tech­ni­schen Doku­men­ta­ti­on ste­hen Doku­men­ta­ti­ons­ver­ant­wort­li­che und Redak­teu­re oft vor der Ent­schei­dung: soll ich einer ver­meint­li­chen Geset­zes­la­ge fol­gen und für den Anwalt doku­men­tie­ren oder für den Benut­zer und das Pro­dukt?1
Nun ist es natür­lich so, dass der Her­stel­ler und Inver­kehr­brin­ger dafür zustän­dig ist, dass der Benut­zer das Pro­di­ukt auch sicher und zuver­läs­sig benut­zen kann. Die Benut­zung muss also doku­men­tiert wer­den. Aber wie?

No print, please!

Papier ist gedul­dig und Papier ist teu­er, lang­sam und schlecht zu durch­su­chen. Kurz: Papier wider­spricht allen ergo­no­mi­schen Anfor­de­run­gen an eine Tech­ni­sche Doku­men­ta­ti­on. Papier ist eine Krü­cke, ein kleins­ter gemein­sa­mer Nen­ner aus einer Zeit, als die Indus­tria­li­sie­rung noch Werk­tä­ti­ge bevor­zug­te, die “ihre” Maschi­ne noch selbst repa­rie­ren konn­ten. Papier ist Indus­trie 2.0.
Seit eini­gen Jah­ren aber bewe­gen wir uns mit hoher Geschwin­dig­keit auf Indus­trie 4.0 zu: alle Gerä­te sol­len mit­ein­an­der kom­mu­ni­zie­ren kön­nen. Auch wenn es dem einen oder ande­ren Tech­nik­skep­ti­ker kal­te Schau­er über den Rücken jagt: wenn das nicht gin­ge, könn­te er nicht mal tele­fo­nie­ren. Getrie­ben von der rasan­ten Ent­wick­lung der Tele­kom­mu­ni­ka­ti­ons­mög­lich­kei­ten und der Ver­brei­tung digi­ta­ler Lese­ge­rä­te und mobi­ler Com­pu­ter (vor allem Smart­pho­nes) steht nun auch die Tech­ni­sche Doku­men­ta­ti­on vor einer gro­ßen Her­aus­for­de­rung: Weg von Gutenberg.
Nicht mehr nur die Let­tern sind beweg­lich, die Infor­ma­ti­on ist es auch.
Ange­sichts der Tat­sa­che, dass welt­weit über 1500 Mil­lio­nen Smart­pho­nes im Umlauf sind2, kann man eigent­lich von einer ech­ten Wahl nicht mehr spre­chen: Tech­ni­sche Doku­men­ta­ti­on muss online. Punkt.3

Wie kommt man aus der Nummer raus?

Gar nicht.
Sofern der Inhalt topic-ori­en­tiert geschrie­ben ist4, kommt in der Redak­ti­on ein The­ma auf, über dass sich die Betei­lig­ten die Köp­fe heiß reden kön­nen: Neh­men wir eine Online­hil­fe oder neh­men wir ein Wiki?
Bei­des ergibt Sinn, wenn klar ist, wie sich die Anwen­dung- und Erstel­lungs­pro­zess unter­schei­den. Denn eigent­lich unter­schei­den sich die Inhal­te ja nicht. Statt einer Plus-Minus-Lis­te stel­le ich nun ein paar Über­le­gun­gen gegen­über, die eine Ent­schei­dung erleich­tern können.

Wiki

Online­hil­fe“

Erfor­dert Ser­ver oder Online-Zugang

Kann off­line ver­wen­det wer­den als ver­link­te Dokumentensammlung

Brow­se­r­un­ab­hän­gig

Benö­tigt ggf. Plug-ins

Durch­such­bar

Durch­such­bar

Nutzt Hyper­links

Nutzt Hyper­links

HTML/​CSS

HTML/​CSS/​JavaScript (HTML-Ver­si­on einstellbar)

Jeder­zeit direkt aktua­li­sier­bar, kann von allen berech­tig­ten Benut­zern geän­dert werden

Muss nach der Aktua­li­sie­rung neu aus­ge­ge­ben (kom­pi­liert) wer­den, benö­tigt daher einen defi­nier­ten Redaktionsprozess

Über­setz­bar

Über­setz­bar

Brow­ser für Ein- und Ausgabe

Edi­tor für die Ein­ga­be, Brow­ser für die Ausgabe

Inhalts­ver­zeich­nis nur für eine Seite

Inhalts­ver­zeich­nis über alle Seiten

Fest­ge­leg­te Benutzeroberfläche

Kon­fi­gu­rier­ba­re Benut­zer­ober­flä­che (im Editor)

Review nach der Publi­ka­ti­on (Ände­rung)

Review vor der Publikation

Inhal­te von allen Berech­tig­ten betreut

Inhal­te von Redak­teu­ren betreut

Es ist also nicht ganz tri­vi­al und hängt davon ab, wozu man die­se Doku­men­ta­ti­on ein­set­zen möchte.
Für ein inter­nes Doku­men­ta­ti­ons­sys­tem ist ein Wiki sicher die bes­se­re Wahl, da die Aktua­li­sie­rung nicht von ein­zel­nen Mit­ar­bei­tern abhängt. Aller­dings erfor­dert dies auch eine gewis­se Schu­lung der Berech­tig­ten, denn das Wiki ver­kommt schnell zu einem losen „Papier­sta­pel“, in dem nie­mand etwas wie­der­fin­det, wenn er nicht den rich­ti­gen Such­be­griff kennt.
Ande­rer­seits hat eine Online­hil­fe (auch wenn sie off­line ver­wen­det wer­den kann) in der Benut­zer­do­ku­men­ta­ti­on gera­de dort ihre Stär­ke, dass sie eben in einen Infor­ma­ti­ons­pro­zess ein­ge­bun­den ist und bei­spiels­wei­se nur aktua­li­siert wird, wenn es Pro­duk­tän­de­run­gen gibt. Auch ist der Doku­men­ta­ti­on- und Inhalts­ver­ant­wort­li­che (Redak­ti­on und Frei­ga­be) damit bes­ser greif­bar. Die Online­hil­fe benö­tigt dazu jedoch einen gut orga­ni­sier­ten Redaktionsprozess.
Letz­te­res ist für ein inter­nes Doku­men­ta­ti­ons­sys­tem meist zuviel des Guten.
Opti­mal aller­dings ist es, wenn bei der Kon­zep­ti­on bei­des gleich mit­ge­dacht wird, so dass sich die Publi­ka­ti­ons­ty­pen ergän­zen: Pro­dukt­neu­hei­ten kom­men ins Wiki, Kun­den­sup­port in die Online­hil­fe. Das geht zwar auch, führt aber an die­ser Stel­le zu weit.

Bild­quel­le: „Die Waf­fen der Wart­burg 319 Tafel 55“ von Alfons Die­ner-Schön­berg *19.08.1879 +16.11.1936. (pnd130137626) – Alfons Die­ner-Schön­berg: Die Waf­fen der Wart­burg (1912) Tafel 55. Lizen­ziert unter Gemein­frei über Wiki­me­dia Commons)


  1. Es ist eine weit ver­brei­te­te Miss­in­ter­pre­ta­ti­on, dass laut Maschi­nen­richt­li­nie Papier immer gefor­dert ist. Das steht da nicht. Der Absatz 1.7.4 in der MRL bezieht sich zwar auf alle mög­li­chen Aspek­te wie Sicher­heits­hin­wei­se und Her­stel­ler­an­ga­ben – von Papier ist da aber kei­ne Rede. Nir­gends. 

  2. laut Sta­tis­ta 

  3. Auch wenn sich vie­le Anbie­ter und Her­stel­ler noch immer auf den zuge­ge­be­ner­ma­ßen ein­fa­chen Pro­zess zurück­zie­hen, aus einer papier- und druck­ori­en­tier­ten Aus­ga­be eine PDF zu machen, ist PDF kein wirk­li­cher Fort­schritt. Wer schon mal ver­sucht hat, die Ergüs­se der Mar­ke­ting­ab­tei­lun­gen als PDF auf sei­nem Smart­pho­ne zu lesen, der weiß, dass das schlicht unmög­lich ist. Von tech­ni­schen Daten ganz zu schwei­gen. 

  4. Wie man das macht, steht an ande­rer Stel­le in die­sem Blog: Topics: Infor­ma­ti­ons­häpp­chen hirn­ge­recht ser­vie­ren