Betriebs­an­lei­tung erstellen

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 werden:

• 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 werden?
• Müs­sen kul­tu­rel­le oder sozia­le Beson­der­hei­ten beach­tet werden?
• 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 werden.
• 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 Ingenieure
• Wird das Pro­dukt unter beson­de­ren Bedin­gun­gen genutzt und verwendet?
• 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 Lerngrundlage?
• Wel­che Erwar­tun­gen hat die Ziel­grup­pe an die Anleitung?
• 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 ableiten.

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 beachten:

• Eine ziel­grup­pen­ge­rech­te und ein­heit­li­che Ter­­mi­­no­­lo­­gie-Lis­­te anle­gen und verwenden.
• 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­le­gui­des und Tech­ni­cal Wri­ting Sheets.
• Gra­fi­ken und Illus­tra­tio­nen erstel­len und im Doku­ment platzieren.
• 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 Bediener)
• 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 orientieren.
• 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 werden.

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 werden.

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.

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 Verfügung:

Anbrin­gung auf dem Produkt

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­tober­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 Verpackung

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, Tran­s­­port- und Lager­an­wei­sun­gen sowie Tipps zum Ent­fer­nen der Ver­pa­ckung zu platzieren.

Doku­men­ta­ti­on in Papierform

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 Datenträ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 Han­d­­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 zuzugreifen.

Doku­men­ta­ti­on im Internet

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 Zugriffscode.

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-Ken­n­­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 enthalten:

• 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 Schraubenschlüssel)
• Kon­se­quen­te Stil­re­geln in den Tex­ten sowie im Layout
• Erstel­len eines Gra­fik­kon­zepts (Soft­ware, Far­ben, Stil der Grafiken)
• 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 arbeiten)
• 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.)

Zu Beginn der Anlei­tung befin­det sich der Titel, das Impres­sum mit Kon­takt­da­ten vom Her­stel­ler und das Inhalts­ver­zeich­nis. Ein optio­na­les Vor­wort kann ein­lei­ten­de Infor­ma­tio­nen zum Pro­dukt lie­fern, die Ziel­grup­pe defi­nie­ren, die Lebens­zy­klen des Pro­dukts vor­stel­len und den Umgang mit der Betriebs­an­lei­tung erläutern.

Das Kapi­tel Sicher­heit ent­hält sämt­li­che Sicher­heits­hin­wei­se, die im Umgang mit dem Pro­dukt zu beach­ten sind. Der Nut­zer soll­te instru­iert wer­den, bevor er eine Hand­lung am Pro­dukt vor­nimmt, die­ses Kapi­tel aus­führ­lich zu lesen und zu ver­in­ner­li­chen. Das Kapi­tel Sicher­heit dient auch als Grund­la­ge für Schu­lun­gen und Sicher­heits­un­ter­wei­sun­gen im Unternehmen.

Das Kapi­tel zur Leis­tungs­be­schrei­bung ent­hält Infor­ma­tio­nen zum Bestim­mungs­ge­mä­ßen Gebrauch, den Anfor­de­run­gen an die Umwelt und den Tech­ni­schen Daten.

Die Gerä­te­be­schrei­bung beinhal­tet eine Lis­te aller im Lie­fer­um­fang ent­hal­te­nen Tei­le. Die­se Tei­le wer­den vor­ge­stellt und erklärt. Zusätz­lich kann das Kapi­tel Infor­ma­tio­nen zu Auf­stel­lung, Lage­rung, Trans­port, Ver­pa­ckung sowie Außer­be­trieb­nah­me und Ent­sor­gung enthalten.

Die Täti­g­keits- oder Bedien­be­schrei­bung nimmt meis­tens den größ­ten Teil der Doku­men­ta­ti­on ein. Hier wer­den die ein­zel­nen Bedien­ele­men­te vor­ge­stellt und deren Funk­tio­nen erläu­tert. Es kön­nen Use Cases beschrie­ben wer­den, die mit­hil­fe von Schritt für Schritt Anwei­sun­gen die wich­tigs­ten Bedien­pro­zes­se ver­deut­li­chen. Dar­über hin­aus ent­hält der Abschnitt Infor­ma­tio­nen zu War­tung, Feh­ler­su­che, Schnitt­stel­len und mög­li­chen Zusatzelementen.

Ein Kapi­tel zur Funk­ti­ons­wei­se kann erfor­der­lich sein, wenn der Nut­zer die Funk­ti­ons­wei­se ver­ste­hen muss, um die Maschi­ne / Anla­ge sicher bedie­nen zu können.

Auch tech­ni­sche Unter­la­gen wie Zulie­fer­er­do­ku­men­ta­ti­on, Kon­for­mi­täts­er­klä­rung, Ersatz­teil­lis­ten, Elek­­t­ro- und Pneu­ma­tik­plan müs­sen, wenn vor­han­den, Teil der Betriebs­an­lei­tung sein.

Abschlie­ßend dient ein Index zur bes­se­ren Suche nach Stich­wör­tern und ein Ände­rungs­ver­zeich­nis kenn­zeich­net alle durch­ge­führ­ten Ände­run­gen und Aktualisierungen.