Die inhalt­li­chen Anfor­de­run­gen an eine Betriebs­an­lei­tung sind unter ande­rem in der Norm DIN EN 82079–1 gere­gelt. Im Spe­zi­el­len sind hier grund­le­gen­de Regeln und Prin­zi­pi­en für eine voll­stän­di­ge und benut­zer­freund­li­che Doku­men­ta­ti­on defi­niert. Die­se Regeln gel­ten jedoch nicht nur für rei­ne Betriebs­an­lei­tun­gen, son­dern kön­nen auf alle Anlei­tun­gen im Bereich der Tech­ni­schen Doku­men­ta­ti­on ange­wen­det wer­den. Die Ein­hal­tung der Nor­men und Richt­li­ni­en ist not­wen­dig für eine erfolg­rei­che Kon­for­mi­täts­be­wer­tung und die damit ver­bun­de­ne Ver­ga­be der CE-Kenn­zeich­nung.

Wei­te­re Nor­men und Richt­li­ni­en, die bei der Erstel­lung von Betriebs­an­lei­tun­gen eine Rol­le spie­len, sind abhän­gig von der Art des Pro­dukts. Daher müs­sen die nor­ma­ti­ven Anfor­de­run­gen bei jeder Anlei­tung neu bestimmt wer­den. Bei­spie­le für zu beach­ten­de Richt­li­ni­en und Nor­men sind:

  • Maschi­nen­richt­linie
  • Nie­der­span­nungs­richt­li­nie
  • IEC/IEEE 82079–1 (Erstel­len von Nut­zer­in­for­ma­tio­nen)
  • ISO 17644 (Her­stel­ler­an­ga­ben für Medi­zin­pro­duk­ten)
  • ISO 26511 (Soft­ware und Sys­tem-Engi­nee­ring)

Im Fol­gen­den wer­den nun wich­ti­ge Prin­zi­pi­en für das Erstel­len von Betriebs­an­lei­tun­gen beschrie­ben:

 

Die Ziel­grup­pen berück­sich­ti­gen

Beim Erstel­len einer Anlei­tung jeg­li­cher Art ist es sehr wich­tig, die Ziel­grup­pe und deren Eigen­schaf­ten, Gewohn­hei­ten und Erwar­tun­gen zu berück­sich­ti­gen. Hier­für kann eine Ziel­grup­pen­ana­ly­se durch­ge­führt wer­den, bei der fol­gen­de Fra­gen geklärt wer­den:

  • Wel­che Alters­grup­pe wird ange­spro­chen? Muss die Anlei­tung beson­ders kind- oder senio­ren­ge­recht gestal­tet und geschrie­ben wer­den?
  • Müs­sen kul­tu­rel­le oder sozia­le Beson­der­hei­ten beach­tet wer­den?
  • Sind bestimm­te Kennt­nis­se / Fähig­kei­ten vor­han­den? Dem ent­spre­chend kön­nen Fach­be­grif­fe oder Hand­lungs­schrit­te ohne zusätz­li­che Erklä­rung ver­wen­det und beschrie­ben wer­den.
  • Wie ist das sprach­li­che Niveau? Eine Anlei­tung für Kin­der / Jugend­li­che soll­te anders geschrie­ben wer­den als eine Anlei­tung für Maschi­nen­bau Inge­nieu­re
  • Wird das Pro­dukt unter beson­de­ren Bedin­gun­gen genutzt und ver­wen­det?
  • Wie wird die Ziel­grup­pe die­se Anlei­tung nut­zen? Dient sie eher als Nach­schla­ge­werk, Schu­lungs­grund­la­ge, Hand­buch oder Lern­grund­la­ge?
  • Wel­che Erwar­tun­gen hat die Ziel­grup­pe an die Anlei­tung?
  • Wel­che Erwar­tun­gen hat die Ziel­grup­pe an das Pro­dukt? Hier­aus lässt sich das erwar­tungs­ge­mä­ße Nut­zer­ver­hal­ten ablei­ten.

Auf Basis der Ziel­grup­pen­ana­ly­se muss die Betriebs­an­lei­tung kon­zi­piert wer­den. Dabei gilt es Fol­gen­des zu beach­ten:

  • Eine ziel­grup­pen­ge­rech­te und ein­heit­li­che Ter­mi­no­lo­gie-Lis­te anle­gen und ver­wen­den.
  • Einen sprach­li­chen For­mu­lie­rungs­stil fest­le­gen, der mög­lichst ein­fa­che Satz­kon­struk­te ver­wen­det. Hier­bei hel­fen Sty­legui­des und Tech­ni­cal Wri­ting She­ets.
  • Gra­fi­ken und Illus­tra­tio­nen erstel­len und im Doku­ment plat­zie­ren.
  • Eine über­sicht­li­che Doku­men­ta­ti­ons­struk­tur fest­le­gen, bei der mög­li­cher­wei­se unter­schied­li­che Doku­men­te für unter­schied­li­che Ziel­grup­pen erstellt wer­den. (Der Instal­la­teur bekommt eine ande­re Anlei­tung als der Bedie­ner)
  • Eine inhalt­li­che Glie­de­rung für das Doku­ment fest­le­gen. Hier kann man sich zum Bei­spiel am Lebens­zy­klus der Maschi­ne oder des Geräts ori­en­tie­ren.
  • Fest­le­gen, wie die Qua­li­tät des Doku­ments gesi­chert wer­den kann. Hier­bei kön­nen Kor­rek­tur-Pro­gram­me und Review­pro­zes­se ange­wen­det wer­den.


Die Anlei­tung als einen Teil des Pro­dukts betrach­ten

Die Anleitung(en) eines Pro­dukts haben einen genau­so hohen Stel­len­wert wie das Pro­dukt selbst. Das heißt, wenn die Anlei­tung fehlt, ist das Pro­dukt unvoll­stän­dig und wenn die Anlei­tung feh­ler­haft ist, ist auch das Pro­dukt feh­ler­haft. An die­sem Ansatz wird deut­lich, wel­che Wich­tig­keit der Doku­men­ta­ti­on zuzu­schrei­ben ist.

Die Anlei­tung als Teil des Pro­dukts dient dazu, des­sen Bestim­mungs­ge­mä­ßen Gebrauch zu gewähr­leis­ten. Somit muss der Bestim­mungs­ge­mä­ße Gebrauch defi­niert und beschrie­ben wer­den. Dar­über hin­aus muss zusätz­lich vor abseh­ba­rem Nicht-Bestim­mungs­ge­mä­ßen (zweck­ent­frem­de­ten) Gebrauch gewarnt wer­den.

Um dem Nut­zer die Instal­la­ti­on, Bedie­nung, War­tung, Rei­ni­gung und sons­ti­ge Anwen­dun­gen mög­lichst leicht ver­ständ­lich zu ver­mit­teln, ist es sinn­voll, gera­de bei kom­pli­zier­te­ren Anla­gen und Maschi­nen, das Doku­ment in meh­re­re Teil­do­ku­men­te zu glie­dern. Die­ser Ansatz wur­de auch schon im Zusam­men­hang mit der ziel­grup­pen­ge­rech­ten Doku­men­ta­ti­on erwähnt.

Meh­re­re Doku­men­ta­tio­nen sind eben­falls vor­teil­haft, wenn das Pro­dukt in ver­schie­de­nen Pro­dukt­va­ri­an­ten exis­tiert. Hier ist es nut­zer­freund­li­cher, genau die pas­sen­de Doku­men­ta­ti­on zu lie­fern, anstatt einem gro­ßen Doku­ment, indem der Nut­zer vor­ab die pas­sen­de Vari­an­te iden­ti­fi­zie­ren muss.

Zuletzt sei erwähnt, dass eine blei­ben­de Ver­füg­bar­keit sowie die Mög­lich­keit zur Aktua­li­sie­rung gege­ben sein muss. Dies lässt sich bei­spiels­wei­se über eine Inter­net­prä­senz rea­li­sie­ren, bei der die Nut­zer immer die aktu­ells­te Ver­si­on der Doku­men­ta­ti­on her­un­ter­la­den kön­nen.

i

Die Anlei­tung in geeig­ne­ter Wei­se bereit­stel­len

Die erstell­ten Betriebs­an­lei­tun­gen müs­sen dem Nut­zer so leicht wie mög­lich zur Ver­fü­gung gestellt wer­den. Hier­bei ist auch wie­der die Ziel­grup­pe zu berück­sich­ti­gen, da älte­re Men­schen even­tu­ell schwe­rer Zugang zu z.B. mobi­len End­ge­rä­ten haben als Jün­ge­re. Bei der Bereit­stel­lung ste­hen dem Her­stel­ler unter­schied­li­che Medi­en zur Ver­fü­gung:

Anbrin­gung auf dem Pro­dukt

Je nach Grö­ße und Beschaf­fen­heit des Pro­dukts kön­nen Sym­bo­le, Hin­wei­se, kur­ze Erklä­run­gen und Hand­lungs­an­wei­sun­gen auf der Pro­duk­t­o­ber­flä­che ange­bracht wer­den. Dies bie­tet sich bei klei­nen Hand­lungs­schrit­ten oder wich­ti­gen Sicher­heits­hin­wei­sen an. Wich­tig zu beach­ten ist hier­bei, dass die­se Infor­ma­tio­nen nicht die eigent­li­che Betriebs­an­lei­tung erset­zen, son­dern ledig­lich als Ergän­zung zu sehen sind.

Anbrin­gung auf der Ver­pa­ckung

Da die Ver­pa­ckung meis­tens direkt ent­sorgt wird, muss sich der Her­stel­ler genau über­le­gen, wel­che Infor­ma­tio­nen er hier anbrin­gen will. Im Regel­fall bie­tet es sich hier an, Trans­port- und Lager­an­wei­sun­gen sowie Tipps zum Ent­fer­nen der Ver­pa­ckung zu plat­zie­ren.

Doku­men­ta­ti­on in Papier­form

Dies ist bis­lang die geläu­figs­te Bereit­stel­lungs­me­tho­de. Der Nut­zer fin­det alle wich­ti­gen Infor­ma­tio­nen gebün­delt in einem Doku­ment (oder gege­be­nen­falls in meh­re­ren Teil­do­ku­men­ten). Wich­tig hier­bei ist es, gera­de bei gro­ßen Doku­men­ta­tio­nen, den Inhalt gut zu struk­tu­rie­ren und mit Inhalts­ver­zeich­nis und Index leicht auf­find­bar zu machen.

Doku­men­ta­ti­on auf einem Daten­trä­ger

Es ist wei­ter­hin mög­lich, die Doku­men­ta­ti­on bei­spiels­wei­se als PDF auf einem Daten­trä­ger (CD, USB-Stick) zu lie­fern. Hier­durch kann der Nut­zer mit­tels Such­funk­ti­on leich­ter nach bestimm­ten Inhal­ten suchen. Wei­ter­hin kön­nen zusätz­li­che Doku­men­ta­ti­ons­me­tho­den zur Anwen­dung kom­men. Zum Bei­spiel kön­nen Infor­ma­tio­nen mit­hil­fe von Vide­os, Uti­li­ty-Fil­men oder Ani­ma­tio­nen über­mit­telt wer­den. Durch die­se Medi­en las­sen sich bei­spiels­wei­se schwie­ri­ge Hand­lungs- oder Mon­ta­ge­schrit­te leicht und anschau­lich erklä­ren. Vor­aus­set­zung für die­se Art von Doku­men­ta­ti­on ist jedoch, dass der Nut­zer im Anwen­dungs­be­reich des Pro­dukts die Mög­lich­keit hat, auf einen PC, Lap­top oder Tablet zuzu­grei­fen.

Doku­men­ta­ti­on im Inter­net

Die­se Art der Bereit­stel­lung ähnelt der Doku­men­ta­ti­on auf einem Daten­trä­ger. Der Nut­zer hat Zugriff auf die Doku­men­ta­ti­on über die Inter­net­sei­te des Her­stel­lers. Vor­teil­haft ist hier­bei, dass der Her­stel­ler die Infor­ma­tio­nen immer aktu­ell hal­ten kann und der Nut­zer somit immer Zugriff auf den aktu­ells­ten Doku­men­ta­ti­ons­stand hat. Wenn die Doku­men­ta­ti­on nicht für jeder­mann ein­seh­bar sein soll, lässt sich der Zugriff steu­ern, z. B. über Benut­zer­kon­ten oder einem Zugriff­s­code.


Die Qua­li­tät der Anlei­tung sicher­stel­len

Wie oben erwähnt, ist die Tech­ni­sche Doku­men­ta­ti­on ein Teil des Pro­dukts und gewähr­leis­tet den Siche­ren und Bestim­mungs­ge­mä­ßen Gebrauch. Des Wei­te­ren ist sie not­wen­dig für eine erfolg­rei­che Kon­for­mi­täts­be­wer­tung und die Ver­ga­be der CE-Kenn­zeich­nung. Aus die­sem Grund ist es wich­tig, ein Qua­li­täts­si­che­rungs­kon­zept bei der Erstel­lung zu ver­fol­gen. Ein sol­ches Kon­zept kann unter ande­rem fol­gen­de Regeln ent­hal­ten:

  • Erstel­len einer Ter­mi­no­lo­gie-Lis­te und strik­tes Anwen­den die­ser Ter­mi­no­lo­gie. Das heißt man einigt sich auf eine fes­te Men­ge von Fach­be­grif­fen, die im gesam­ten Doku­ment ein­heit­lich ver­wen­det wer­den. So wird ver­mie­den, dass die glei­che Sache im Doku­ment ver­schie­de­ne Bezeich­nung bekommt (z.B.: Sechs­kant­schlüs­sel und Schrau­ben­schlüs­sel)
  • Kon­se­quen­te Stil­re­geln in den Tex­ten sowie im Lay­out
  • Erstel­len eines Gra­fik­kon­zepts (Soft­ware, Far­ben, Stil der Gra­fi­ken)
  • Inhal­te struk­tu­riert erfas­sen, ver­wal­ten und wie­der­ver­wend­bar gestal­ten (Dafür ist es rat­sam, mit einem Redak­ti­ons­sys­tem oder geeig­ne­ter Soft­ware zu arbei­ten)
  • Durch­füh­ren von redak­tio­nel­len Review­pro­zes­sen (Kon­trol­le von Lay­out, Inhalt, Recht­schrei­bung, Stil, Gra­fi­ken, usw.)