Was ist eine Tech­ni­sche Doku­men­ta­ti­on?

Der Begriff Tech­ni­sche Doku­men­ta­ti­on fasst alle Infor­ma­tio­nen und Doku­men­te zusam­men, die ein Pro­dukt (wie Gerät, Maschi­ne, Anla­ge, Soft­ware) beschrei­ben und sei­ne Ver­wen­dung und Funk­ti­ons­wei­se erläu­tern. Die Tech­ni­sche Doku­men­ta­ti­on wird als ein essen­zi­el­ler Bestand­teil des Pro­dukts ver­stan­den. Des­halb wird sie auch häu­fig als Pro­dukt­do­ku­men­ta­ti­on bezeich­net. Sie ent­hält sowohl die Antei­le, die für den Kun­den oder ande­re Dienst­leis­ter ein­seh­bar sind (Exter­ne Tech­ni­sche Doku­men­ta­ti­on), als auch eine Viel­zahl wei­te­rer Bestand­tei­le, die inner­halb des pro­du­zie­ren­den Unter­neh­mens ver­blei­ben (Inter­ne Tech­ni­sche Doku­men­ta­ti­on).

Mit der exter­nen Doku­men­ta­ti­on gewähr­leis­ten Sie, dass Ihr Pro­dukt bestim­mungs­ge­mäß und sicher ver­wen­det wird. Die Inhal­te set­zen sich unter ande­rem aus den fol­gen­den Teil­be­rei­chen zusam­men: Betriebs­an­lei­tung, Bedie­nungs­an­lei­tung, War­tungs­an­lei­tung, Trans­port­an­lei­tung, Sicher­heit, Mon­ta­ge­an­lei­tung, Kon­for­mi­täts­er­klä­rung, Demon­ta­ge und Ent­sor­gung.

In die­sem Arti­kel erfah­ren Sie, was Sie zum Erstel­len einer ver­ständ­li­chen Pro­dukt­do­ku­men­ta­ti­on wis­sen müs­sen und wie Sie mit Ihren Inhal­ten den größ­ten Nut­zen für Ihr Unter­neh­men und Ihre Kun­den erzie­len kön­nen.

Wo liegt der Unter­schied zwi­schen Exter­ner und Inter­ner Tech­ni­scher Doku­men­ta­ti­on?

Die Inter­ne Tech­ni­sche Doku­men­ta­ti­on dient dazu, das Pro­dukt über sei­nen Lebens­zy­klus hin­weg zu doku­men­tie­ren. Der Her­stel­ler kommt damit sei­nen Nach­weis­pflich­ten gegen­über Orga­ni­sa­tio­nen und gesetz­li­chen Anfor­de­run­gen nach. Sie bil­det die Grund­la­ge für die Exter­ne Tech­ni­schen Doku­men­ta­ti­on und beinhal­tet dar­über hin­aus Infor­ma­tio­nen zu einer Viel­zahl ver­schie­de­ner The­men­be­rei­che. Die Inter­ne Doku­men­ta­ti­on bie­tet das Poten­zi­al, Wis­sen und Know-how eines Unter­neh­mens zu sam­meln, zu ver­tei­len und zu spei­chern. Sie ist also mehr als eine rei­ne Pflicht­übung.

Technische Dokumentation Intern und Extern

Die Exter­ne Tech­ni­sche Doku­men­ta­ti­on (auch Anwen­der­do­ku­men­ta­ti­on oder Nut­zer­in­for­ma­ti­on) ist ein Aus­schnitt der Inter­nen Doku­men­ta­ti­on und rich­tet sich an den Anwen­der bzw. End­be­nut­zer, Repa­ra­tur­dienst­leis­ter oder an Trans­port­un­ter­neh­men. Sie ent­hält die Infor­ma­tio­nen, die für den Umgang mit dem Pro­dukt rele­vant sind. Geset­ze und Richt­li­ni­en defi­nie­ren den Umfang der bereit­zu­stel­len­den Infor­ma­tio­nen näher. Die exter­ne Pro­dukt­do­ku­men­ta­ti­on soll in ers­ter Linie gewähr­leis­ten, dass der Nut­zer das Pro­dukt gemäß sei­ner Bestim­mungs­ge­mä­ßen Ver­wen­dung benutzt. Alle Anwen­der wie Instal­la­teu­re, Repa­ra­tur­dienst­leis­ter und Trans­port­un­ter­neh­men kön­nen ihre Arbei­ten mit­hil­fe die­ser Infor­ma­tio­nen sicher und mit dem gewünsch­ten Ergeb­nis durch­füh­ren.

Wel­che Zie­le ver­fol­gen Her­stel­ler mit der Tech­ni­schen Doku­men­ta­ti­on?

Haf­tungs­ri­si­ko mini­mie­ren

Ver­wen­det ein Nut­zer das Pro­dukt falsch oder führt durch sein Han­deln eine Fehl­funk­ti­on her­bei, kön­nen Per­so­nen und Sach­gü­ter zu Scha­den kom­men. Der Her­stel­ler muss die­ses Risi­ko durch ent­spre­chen­de kon­struk­ti­ve Maß­nah­men auf ein ver­tret­ba­res Maß redu­zie­ren. Oft las­sen sich dadurch jedoch nicht alle Risi­ken besei­ti­gen und es bleibt ein Rest­ri­si­ko für den Nut­zer bestehen. Die Exter­ne Doku­men­ta­ti­on muss dazu geeig­net sein, etwai­ge Rest­ri­si­ken für den Nut­zer ersicht­lich zu machen und ihm den siche­ren Umgang mit dem Pro­dukt zu erläu­tern. Die Betriebs­an­lei­tung zeigt dem Anwen­der bei­spiels­wei­se über Sicher­heits- und Warn­hin­wei­se Situa­tio­nen auf, die eine Gefähr­dung dar­stel­len. Wei­ter soll die Doku­men­ta­ti­on Maß­nah­men beschrei­ben, die dazu die­nen, eine Gefähr­dungs­si­tua­ti­on sicher zu bewäl­ti­gen. Die Infor­ma­tio­nen in der Betriebs­an­lei­tung sowie der inter­ne Nach­weis zu den Pro­duk­t­ei­gen­schaf­ten mini­mie­ren die Gefahr für den Her­stel­ler, für Schä­den an Per­so­nen oder Sach­gü­tern haf­ten zu müs­sen.

Funk­ti­ons­wei­se erklä­ren

Der wich­tigs­te Aspekt für den Nut­zer der exter­nen Doku­men­ta­ti­on besteht dar­in, alle Infor­ma­tio­nen zu erhal­ten, die er für das Ver­wen­den eines Pro­dukts benö­tigt. Ins­be­son­de­re bei kom­ple­xen Pro­duk­ten, deren Funk­ti­ons­wei­se sich nicht auf den ers­ten Blick erschließt, ist es von ent­schei­den­der Bedeu­tung, dass die bereit­ge­stell­ten Infor­ma­tio­nen umfas­send und voll­stän­dig sind. Dadurch stel­len Sie sicher, dass der Anwen­der zu jeder Zeit in der Lage ist, sicher und zweck­be­stimmt mit dem Gerät, der Soft­ware oder der Maschine/Anlage umzu­ge­hen.

Cus­to­mer Expe­ri­ence

Die Nut­zer­er­fah­rung ist bei der Kun­den­bin­dung an ein Pro­dukt oder eine Mar­ke von hohem Inter­es­se für den Her­stel­ler. Nach dem Kauf eines Pro­dukts ist die exter­ne Doku­men­ta­ti­on häu­fig das ers­te Instru­ment, das der Nut­zer her­an­zie­hen wird, um Unter­stüt­zung bei der Bedie­nung und Hand­ha­bung zu erhal­ten. Unkla­re Instruk­tio­nen und unvoll­stän­di­ge Infor­ma­tio­nen zer­stö­ren das Ver­trau­en beim Kun­den. Eine struk­tu­rier­te und voll­stän­di­ge Pro­dukt­do­ku­men­ta­ti­on hin­ge­gen ver­schafft Sicher­heit und spielt eine wich­ti­ge Rol­le bei der Bewer­tung der eige­nen Kauf­ent­schei­dung. Lei­ten Sie den Nut­zer in der Betriebs­an­lei­tung ziel­füh­rend an und ach­ten dar­auf, dass Sie sei­ne Bedürf­nis­se durch die Infor­ma­tio­nen erfül­len, schafft das die Basis für eine hohe Kun­den­zu­frie­den­heit und somit den lang­fris­ti­gen Erfolg Ihres Unter­neh­mens.

Wel­che for­ma­len Anfor­de­run­gen muss eine Tech­ni­sche Doku­men­ta­ti­on erfül­len?

Gesetz­li­che Anfor­de­run­gen

Für die Inter­ne und Exter­ne Doku­men­ta­ti­on sind ver­schie­dens­te Richt­li­ni­en und Geset­ze rele­vant, die Sie beim Erstel­len und Bereit­stel­len der Infor­ma­tio­nen ein­hal­ten müs­sen.

Pro­dukt­si­cher­heits­ge­setz (ProdSG)

Das in Deutsch­land wich­tigs­te Regel­werk für das Bereit­stel­len von Pro­duk­ten ist das Pro­dukt­si­cher­heits­ge­setz. Als Umset­zung der Euro­päi­schen Richt­li­nie 2001/95/EG in natio­na­les Recht dient das Pro­dukt­si­cher­heits­ge­setz dazu, die Anfor­de­run­gen für das Inver­kehr­brin­gen und Bereit­stel­len von Gerä­ten, Maschinen/Analgen und Soft­ware in Deutsch­land grund­le­gend zu defi­nie­ren.

Geset­ze und Richt­li­ni­en für bestimm­te Pro­dukt­grup­pen

Die wei­te­ren gesetz­li­chen Anfor­de­run­gen rich­ten sich maß­geb­lich danach, unter wel­cher Grup­pe das Pro­dukt ein­zu­ord­nen ist und wel­che Merk­ma­le es auf­weist. Als typi­sche Rechts­quel­len sind hier bei­spiels­wei­se das Medi­zin­pro­duk­te­ge­setz (MPG), die Nie­der­span­nungs­richt­li­nie (2006/95/EG) und die Maschi­nen­richt­linie (2006/42/EG) zu nen­nen.

Nor­ma­ti­ve Anfor­de­run­gen

Nor­men die­nen dazu, ein­heit­li­che Regeln und Emp­feh­lun­gen für Abläu­fe und Pro­zes­se zu defi­nie­ren. Im Gegen­satz zu gesetz­li­chen Anfor­de­run­gen, sind die­se in der Regel nicht bin­dend, kön­nen jedoch einen recht­lich bin­den­den Cha­rak­ter erlan­gen, indem gel­ten­de Richt­li­ni­en und Geset­ze dies vor­schrei­ben.

Für das Erstel­len von Gebrauchs­an­lei­tun­gen ist die Euro­päi­sche Norm EN 82079–1 zu nen­nen, die wich­ti­ge Grund­la­gen zu Glie­de­rung, Inhalt und Dar­stel­lung von Anlei­tun­gen lie­fert. Beim Erstel­len von Doku­men­ta­tio­nen müs­sen zum Teil vie­le Nor­men auf ihre Rele­vanz geprüft und umge­setzt wer­den.

Füh­ren Sie hier­zu vor­ab eine aus­führ­li­che Nor­men­re­cher­che durch, um sich über den Umfang der not­wen­di­gen Infor­ma­tio­nen im Kla­ren zu sein.

Wir unter­stüt­zen Sie bei der Recher­che ein­schlä­gi­ger Nor­men. Kon­tak­tie­ren Sie uns.

Usa­bi­li­ty

Die Usa­bi­li­ty oder auch Gebrauchs­taug­lich­keit ist in der DIN EN ISO 9241 als „(…) Eig­nung eines Pro­duk­tes bei der Nut­zung durch bestimm­te Benut­zer in einem bestimm­ten Benut­zungs­kon­text die vor­ge­ge­be­nen Zie­le effek­tiv, effi­zi­ent und zufrie­den­stel­lend zu errei­chen.“ defi­niert. Die Nut­zer­in­for­ma­tio­nen neh­men in die­sem Zusam­men­hang, ins­be­son­de­re bei kom­ple­xe­ren und sicher­heits­tech­nisch bedenk­li­chen Pro­duk­ten (zum Bei­spiel Laser­ge­rä­te), eine zen­tra­le Rol­le ein.

In der Tech­ni­schen Doku­men­ta­ti­on gewinnt die Usa­bi­li­ty seit eini­ger Zeit stark an Bedeu­tung, was nicht zuletzt durch die Neue­run­gen im Bereich der regu­la­to­ri­schen Anfor­de­run­gen an Medi­zin­pro­duk­te in Form der EU‑­­Me­­di­­zin­­pro­­du­k­­te-Ver­­or­d­­nung zum Aus­druck kommt.

Die Usa­bi­li­ty Ihrer Nut­zer­in­for­ma­tio­nen soll­te hin­sicht­lich Schreib­stil, Ter­mi­no­lo­gie, Ziel­grup­pe und Form der Bereit­stel­lung in einem mehr­stu­fi­gen Pro­zess von erfah­re­nen Redak­teu­ren geprüft und opti­miert wer­den, um Schä­den durch Bedien­feh­ler auf ein Mini­mum zu redu­zie­ren.

Wel­che inhalt­li­chen Anfor­de­run­gen gibt es in der Tech­ni­schen Doku­men­ta­ti­on?

Die Tech­ni­sche Doku­men­ta­ti­on besteht aus einer Viel­zahl eigen­stän­di­ger oder sich gegen­sei­tig ergän­zen­der Infor­ma­tio­nen, die in ihrer Gesamt­heit das Pro­dukt voll­stän­dig abbil­den und beschrei­ben sol­len.

Die Anfor­de­run­gen an den Inhalt der Doku­men­ta­ti­on sind abhän­gig davon, wel­che Geset­ze, Richt­li­ni­en und Nor­men für die ent­spre­chen­de Pro­dukt­grup­pe anzu­wen­den sind. Nach­fol­gend wer­den die zen­tra­len Richt­li­ni­en für die jewei­li­gen Pro­dukt­ar­ten umris­sen.

Maschi­nen und Anla­gen

Für Maschi­nen und Anla­gen, die unter den Anwen­dungs­be­reich der Maschi­nen­richt­linie (2006/42/EG) fal­len, sind die all­ge­mei­nen Grund­sät­ze und die Min­dest­an­for­de­run­gen an den Inhalt der Betriebs­an­lei­tung dort defi­niert. Sie for­dert bei­spiels­wei­se eine kla­re Fest­le­gung, in wel­cher Spra­che die Ori­gi­nal­be­triebs­an­lei­tung zu erstel­len ist und was Sie bei der Defi­ni­ti­on der Bestim­mungs­ge­mä­ßen Ver­wen­dung beach­ten müs­sen.

Wei­ter lis­tet die Maschi­nen­richt­linie detail­liert auf, wel­che inhalt­li­chen Bestand­tei­le in der Betriebs­an­lei­tung auf­zu­füh­ren sind und wie die­se zu ermit­teln sind.

Erfah­ren Sie mehr über die Maschi­nen­richt­linie

Elek­tro­ge­rä­te

Für vie­le Gerä­te und Betriebs­mit­tel aus dem Bereich Elek­tro­nik ist die Nie­der­span­nungs­richt­li­nie (2014/35/EU) recht­lich bin­dend. Sie greift bei einem bestimm­ten Span­nungs­be­reich (50 – 1000 V AC / 75 – 1500 V DC) und legt die grund­le­gen­den Anfor­de­run­gen an die Sicher­heit von elek­trisch betrie­be­nen Gerä­ten fest.

Erfah­ren Sie mehr über die Nie­der­span­nungs­richt­li­nie

Medi­zin­tech­nik

Die regu­la­to­ri­schen Anfor­de­run­gen im Bereich der Medi­zin­tech­nik unter­lie­gen aktu­ell einem Über­gang zwi­schen zwei Regel­wer­ken. Maß­geb­lich ist bis­lang die seit 1993 bestehen­de Richt­li­nie 93/42/EWG über Medi­zin­pro­duk­te (Medi­cal Device Direc­ti­ve – MDD), die durch die Ver­ord­nung (EU) 2017/745 (Medi­cal Device Regu­la­ti­on – MDR) abge­löst wird. Her­stel­ler von Medi­zin­pro­duk­ten müs­sen bis zum end­gül­ti­gen Gel­tungs­be­ginn der MDR (vor­aus­sicht­lich 26. Mai 2021) ihre Tech­ni­sche Doku­men­ta­ti­on auf die Anfor­de­run­gen der MDR anhe­ben, um ihre Pro­duk­te ab die­sem Zeit­punkt in Ver­kehr brin­gen zu dür­fen.

Bei­den Regel­wer­ken ist gemein, dass sie die Inhal­te der Benut­zer­in­for­ma­tio­nen defi­nie­ren, die MDR kon­kre­ti­siert und ergänzt jedoch an vie­len Stel­len die Anfor­de­run­gen, die es zu erfül­len gilt. Zusätz­lich stellt die MDR wei­te­re Anfor­de­run­gen an for­ma­le Kri­te­ri­en wie Medi­um, For­mat, Inhalt und Les­bar­keit sowie Anpas­sung der Infor­ma­tio­nen für die adressierte(n) Zielgruppe(n).

Erfah­ren Sie mehr über Medi­zin­pro­duk­te

Soft­ware

Bei einer Pro­dukt­do­ku­men­ta­ti­on in dem Bereich Soft­ware ist eine Abgren­zung der ein­schlä­gi­gen Richt­li­ni­en im ent­schei­den­den Maße davon abhän­gig, zu wel­chem Ver­wen­dungs­zweck sie zum Ein­satz kommt. Aus recht­li­cher Sicht ist Soft­ware ein eigen­stän­di­ges Pro­dukt und unter­liegt dem­entspre­chend der Pro­­­duk­t­haf­­tungs- und Pro­dukt­si­cher­heits­richt­li­nie.

Neben den all­ge­mei­nen daten­schutz­recht­li­chen Vor­ga­ben auf natio­na­ler Ebe­ne in Form des Bun­des­da­ten­schutz­ge­set­zes (BDSG) kom­men hier auch wei­te­re Anfor­de­run­gen in Fra­ge, die sich auf das Sys­tem, mit dem die Soft­ware inter­agiert, bezie­hen. Die­se müs­sen dann gege­be­nen­falls auch bei der Tech­ni­schen Doku­men­ta­ti­on der Soft­ware berück­sich­tigt wer­den.

Wel­che Anfor­de­run­gen soll­te der Erstel­ler einer Tech­ni­schen Doku­men­ta­ti­on erfül­len?

Tech­ni­sche Redak­teu­re sind in der Regel dafür zustän­dig, die Tech­ni­sche Doku­men­ta­ti­on zu erstel­len. Sie müs­sen in der Lage sein, kom­ple­xe Sach­ver­hal­te und Funk­ti­ons­wei­sen ein­fach und in ziel­grup­pen­ge­rech­ter Form zu erklä­ren. Hier­für müs­sen sie alle benö­tig­ten Inhal­te zusam­men­tra­gen und für den Leser auf­be­rei­ten.

Wel­che Aus­bil­dungs­mög­lich­kei­ten gibt es?

Der Weg zum Beruf als Tech­ni­scher Redak­teur kann auf unter­schied­li­chen Wegen erfol­gen. In der Regel ist ein abge­schlos­se­nes Hoch­schul­stu­di­um Vor­aus­set­zung.

  • Hoch­schul­stu­di­um der Tech­ni­schen Kom­mu­ni­ka­ti­on oder fach­ver­wand­ten Berei­chen
  • Quer­ein­stieg mit einem abge­schlos­se­nen Stu­di­um in einem tech­ni­schen oder geis­tes­wis­sen­schaft­li­chen Bereich
  • Wei­ter­bil­dung in Voll­zeit oder berufs­be­glei­tend zum Bei­spiel über die tekom

Kom­pe­ten­zen eines Tech­ni­schen Redak­teurs

Tech­ni­schen Redak­teu­re benö­ti­gen die fol­gen­den Kern­kom­pe­ten­zen:

  • Sehr gute Kennt­nis­se in der Erstel­lungs­spra­che
  • Aus­ge­präg­te Kom­mu­ni­ka­ti­ons­fä­hig­keit
  • Eigen­ver­ant­wort­li­che und sehr sorg­fäl­ti­ge Arbeits­wei­se
  • Tech­ni­sches Ver­ständ­nis
  • Orga­ni­sa­ti­ons­fä­hig­keit

Wie erfolgt die Infor­ma­ti­ons­be­schaf­fung?

Die Infor­ma­ti­ons­be­schaf­fung und der Aus­tausch von Infor­ma­tio­nen bil­den die Grund­la­ge für eine effi­zi­en­te Zusam­men­ar­beit zwi­schen Her­stel­ler und dem Tech­ni­schen Redak­teur bzw. Dienst­leis­ter. Idea­ler­wei­se defi­nie­ren Sie den Pro­zess der Infor­ma­ti­ons­be­schaf­fung bereits in einer frü­hen Pha­se der Pro­jekt­pla­nung. Wich­ti­ge Fra­gen, die Sie hier­bei klä­ren soll­ten, sind zum Bei­spiel:

  • Wel­che Infor­ma­tio­nen kann der Her­stel­ler als Grund­la­ge für das Erstel­len der Tech­ni­schen Doku­men­ta­ti­on bereit­stel­len?
  • Wel­che Ansprech­part­ner ste­hen auf Sei­ten des Her­stel­lers und des Dienst­leis­ters für den Infor­ma­ti­ons­aus­tausch zur Ver­fü­gung?
  • Über wel­che Kanä­le fin­det der Daten­aus­tausch statt?
  • Wel­che Sicher­heits­stan­dards müs­sen die Betei­lig­ten beim Daten­aus­tausch ein­hal­ten?
  • Wel­che Fris­ten sind gege­be­nen­falls bei Anfra­gen ein­zu­hal­ten?
  • Wie kön­nen kurz­fris­ti­ge Ände­rungs­an­for­de­run­gen und Review­pro­zes­se opti­mal gestal­tet wer­den?
  • Wie kann der Dienst­leis­ter Vor-Ort-Besu­che, bei­spiels­wei­se zur Anfer­ti­gung von Pro­dukt­fo­tos, so durch­füh­ren, dass er den lau­fen­den Betrieb nicht oder nur in gerin­gem Umfang stört?
  • Wel­che Anfor­de­run­gen bestehen beim Daten­aus­tausch an Ein­­gangs- und Aus­gangs­for­ma­te?

Was sind Kon­for­mi­täts­er­klä­rung und CE-Ken­n­­zeich­­nung?

Kon­for­mi­täts­er­klä­rung

Mit der EU- / EG-Kon­­for­­mi­­täts­er­­klä­­rung (abhän­gig vom Ver­öf­fent­li­chungs­da­tum der ein­schlä­gi­gen Richt­li­nie) erklärt der Her­stel­ler oder der­je­ni­ge, der das Pro­dukt in Ver­kehr bringt, dass es allen sicher­heits- und gesund­heits­tech­ni­schen Anfor­de­run­gen ent­spricht.

Die Kon­for­mi­täts­er­klä­rung stellt eine Vor­aus­set­zung für die CE‑Kennzeichnung dar. Der Her­stel­ler muss die Kon­for­mi­täts­er­klä­rung je nach anzu­wen­den­der Richt­li­nie zusam­men mit dem Pro­dukt bereit­stel­len oder zumin­dest zur Vor­la­ge bereit­hal­ten. Er gibt dar­in alle ver­bind­li­chen Richt­li­ni­en und har­mo­ni­sier­ten Nor­men an, denen das Pro­dukt genü­gen muss und bestä­tigt deren Ein­hal­tung in allei­ni­ger Ver­ant­wor­tung.

Das Kon­for­mi­täts­be­wer­tungs­ver­fah­ren, in dem das Pro­dukt auf die Ein­hal­tung der ein­schlä­gi­gen Richt­li­ni­en und Nor­men geprüft wird, geht dem Erstel­len einer gül­ti­gen Kon­for­mi­täts­er­klä­rung vor­aus. Der Her­stel­ler führt die Kon­for­mi­täts­be­wer­tung, je nach vor­lie­gen­der Pro­dukt­art, eigen­ver­ant­wort­lich durch oder schal­tet eine zuge­las­se­ne Benann­te Stel­le ein.

Für den Fall, dass meh­re­re Kon­for­mi­täts­er­klä­run­gen aus­zu­stel­len sind, kann der Aus­stel­ler die Anga­ben in Über­ein­stim­mung mit dem New Legis­la­ti­ve Frame­work (NLF) in einer Erklä­rung zusam­men­fas­sen.

Erfah­ren Sie mehr über Kon­for­mi­täts­er­klä­rung und CE-Ken­n­­zeich­­nung

EG-Konformitätserklärung Muster

CE-Ken­n­­zeich­­nung

Die CE-Ken­n­­zeich­­nung ist für vie­le Pro­duk­te zwin­gend not­wen­dig, die auf dem euro­päi­schen Markt in Ver­kehr gebracht wer­den sol­len. Mit der CE-Ken­n­­zeich­­nung erklärt der Her­stel­ler des Pro­dukts, dass es den ein­schlä­gi­gen euro­päi­schen Vor­schrif­ten genügt und die erfor­der­li­che Kon­for­mi­täts­be­wer­tung erfolgt ist.

Die Kenn­zeich­nung muss der Her­stel­ler gut sicht­bar und dau­er­haft auf der Ober­flä­che des Pro­dukts selbst oder, falls die Pro­duk­t­ei­gen­schaf­ten dies nicht zulas­sen, auf der Ver­pa­ckung oder den Begleit­in­for­ma­tio­nen anbrin­gen.

Erfah­ren Sie mehr über Kon­for­mi­täts­er­klä­rung und CE-Ken­n­­zeich­­nung

CE-Kennzeichnung

Was muss der Redak­teur bei der Über­set­zung beach­ten?

Für mul­ti­na­tio­na­le Unter­neh­men spielt die Anfer­ti­gung von qua­li­ta­tiv hoch­wer­ti­gen fach­ge­rech­ten Über­set­zun­gen der Doku­men­te eine gro­ße Rol­le. Die Über­set­zungs­ar­beit beginnt aller­dings nicht erst, wenn alle Inhal­te in der Aus­gangs­spra­che erstellt wor­den sind, son­dern in der Pla­nungs­pha­se des Pro­jekts. Für eine Über­füh­rung der Inhal­te in die Ziel­spra­che müs­sen Sie schon im Vor­feld eini­ges beach­ten, um ein opti­ma­les Ergeb­nis zu erhal­ten.

Legen Sie beson­de­res Augen­merk auf:

Datei­for­ma­te und Struk­tur der Aus­gangs­do­ku­men­te

Pro­gram­me zur com­pu­ter­ge­stütz­ten Über­set­zung (CAT-Tools) kön­nen nahe­zu alle Datei­for­ma­te ver­ar­bei­ten. Die jewei­li­gen Aus­gangs­for­ma­te brin­gen jedoch ihre indi­vi­du­el­len Stär­ken und Schwä­chen mit in den Über­set­zungs­work­flow ein, die Sie berück­sich­ti­gen müs­sen.

Ter­mi­no­lo­gie

Am Anfang der Inhalts­er­stel­lung soll­ten Sie die ver­wen­de­te Ter­mi­no­lo­gie (Fach­aus­drü­cke, Pro­dukt­be­zeich­nung, Schreib­stil) so klar wie mög­lich defi­nie­ren, um ein hohes Maß an Kon­sis­tenz in der Doku­men­ta­ti­on zu errei­chen. Die fest­ge­leg­te Ter­mi­no­lo­gie kön­nen Sie dann bei­spiels­wei­se in tabel­la­ri­scher Form an den Über­set­zungs­dienst­leis­ter über­ge­ben und damit für gleich­blei­bend hohe Qua­li­tät der Ergeb­nis­se sor­gen.

For­ma­tie­rung inner­halb der Aus­gangs­do­ku­men­te

Lee­re Absät­ze, erzwun­ge­ne Umbrü­che und manu­el­le For­ma­tie­run­gen sor­gen für Pro­ble­me bei der Ver­ar­bei­tung der Daten durch ein CAT-Tool. Berei­ni­gen Sie die zu über­set­zen­den Tex­te vor der Über­ga­be und gestal­ten Sie sie idea­ler­wei­se mit ein­deu­ti­gen For­mat­vor­la­gen.

Datei­ver­wal­tung und ‑aus­tausch

Ins­be­son­de­re bei modu­lar auf­ge­bau­ten Tech­ni­schen Doku­men­ta­tio­nen bil­det eine gut durch­dach­te Datei- und Abla­ge­struk­tur die Basis für einen rei­bungs­lo­sen und feh­ler­frei­en Ablauf bei der Über­set­zung von Doku­men­ten und deren Inhal­ten.

Sie möch­ten Ihre Tech­ni­sche Doku­men­ta­ti­on über­set­zen las­sen und brau­chen einen ver­läss­li­chen Part­ner? Kon­tak­tie­ren Sie uns.

Wozu dient eine Risi­ko­be­ur­tei­lung und wel­che Bedeu­tung hat sie für die Tech­ni­sche Doku­men­ta­ti­on?

Der Begriff der Risi­ko­be­ur­tei­lung wird nach der Norm EN ISO 12100 als „Gesamt­heit des Ver­fah­rens, das eine Risi­ko­ana­ly­se und Risi­ko­be­wer­tung umfasst“ defi­niert. Die Risi­ko­be­ur­tei­lung selbst ist Bestand­teil der Inter­nen Doku­men­ta­ti­on und muss im Nor­mal­fall nicht an den Kun­den oder Anwen­der her­aus­ge­ge­ben wer­den. Sie ist ein ent­schei­den­der Fak­tor bei der Fra­ge, ob ein Pro­dukt für eine Zulas­sung geeig­net ist und bil­det die Grund­la­ge für die sicher­heits­be­zo­ge­nen Infor­ma­tio­nen, die der Her­stel­ler in einer Exter­nen Doku­men­ta­ti­on an den Nut­zer wei­ter­ge­ben muss.

Die Risi­ko­be­ur­tei­lung lie­fert anhand ver­schie­de­ner Kri­te­ri­en wie Ein­tritts­wahr­schein­lich­keit, Schwe­re der beim Ein­tre­ten zu erwar­ten­den Schä­di­gun­gen und Mög­lich­kei­ten zur Ver­mei­dung der Gefähr­dung sicher­heits­re­le­van­te Infor­ma­tio­nen für den Her­stel­ler und Nut­zer.

Rest­ri­si­ken, die der Her­stel­ler weder kon­struk­tiv noch durch zusätz­li­che Sicher­heits­ein­rich­tun­gen besei­ti­gen kann, flie­ßen in Form von Sicher­heits- und Warn­hin­wei­sen in die Tech­ni­sche Doku­men­ta­ti­on mit ein.

Wel­che Vor­tei­le bie­ten Illus­tra­tio­nen in der Tech­ni­schen Doku­men­ta­ti­on?

Gra­fi­ken und Abbil­dun­gen kön­nen in der Tech­ni­schen Doku­men­ta­ti­on ein sehr mäch­ti­ges Mit­tel sein, um Infor­ma­tio­nen zu ver­mit­teln. Auch unter Beach­tung didak­ti­scher Gesichts­punk­te ist es sinn­voll, infor­ma­ti­ve Inhal­te auf unter­schied­li­chen Kanä­len für Nut­zer und Kun­den bereit­zu­stel­len.

Illus­tra­tio­nen ergän­zen Tex­te um ein sprach­neu­tra­les Mit­tel, das rich­tig plat­ziert ein sehr hohes Poten­zi­al beim Erstel­len einer Tech­ni­schen Doku­men­ta­ti­on ent­fal­ten kann. Ach­ten Sie beim Anfer­ti­gen von Illus­tra­tio­nen dar­auf, dass Sie den Fokus des Nut­zers mit geeig­ne­ten Mit­teln (zum Bei­spiel farb­li­chen Her­vor­he­bun­gen oder geschickt gewähl­ten Aus­schnit­ten) auf die wesent­li­chen Merk­ma­le len­ken. Tren­nen Sie die Tex­te inner­halb einer Illus­tra­ti­on von den rein gra­fi­schen Ele­men­ten, um eine ein­fa­che Bear­bei­tung zu gewähr­leis­ten.

Wozu die­nen Sicher­heits- und Warn­hin­wei­se und was gibt es hier zu beach­ten?

Sicher­heits- und Warn­hin­wei­se die­nen dazu, den Nut­zer vor einer poten­zi­ell gefähr­li­chen Situa­ti­on für Leib und Leben oder vor Schä­den an Sach­ge­gen­stän­den zu war­nen. Außer­dem zei­gen sie dem Anwen­der Mög­lich­kei­ten auf, wie er die­se Gefähr­dun­gen sicher bewäl­ti­gen kann. Auch wenn die bei­den Begrif­fe oft­mals syn­onym ver­wen­det wer­den, besteht ein kla­rer Unter­schied:

Sicher­heits­hin­wei­se

die­nen dazu, das Bewusst­sein für eine Gefähr­dungs­si­tua­ti­on zu erzeu­gen oder zu stär­ken, und sind die Basis für Sicher­heits­un­ter­wei­sun­gen im Unter­neh­mens­kon­text. Sie ste­hen häu­fig ohne Signal­wort oder ‑far­be in einem geson­der­ten Kapi­tel und sind didak­tisch auf­ge­baut und auf­be­rei­tet. Auch Bei­spie­le und Erläu­te­run­gen zu Hin­ter­grund­wis­sen sind hier geeig­ne­te Mit­tel, um dem Nut­zer den siche­ren Umgang mit dem Pro­dukt zu erklä­ren.

Warn­hin­wei­se

sind hin­ge­gen dafür vor­ge­se­hen, vor ein­zel­nen Gefähr­dungs­si­tua­tio­nen zu war­nen und ste­hen im direk­ten Bezug zu den nach­ge­la­ger­ten Infor­ma­tio­nen. Die zu ver­wen­den­den Warn­stu­fen (Signal­wort und Signal­far­be) kor­re­lie­ren mit der Risi­ko­be­ur­tei­lung. Ihr grund­le­gen­der Auf­bau und die Art der Gestal­tung sind in diver­sen Emp­feh­lun­gen und Nor­men kon­kre­ti­siert. Für den euro­päi­schen Raum zeigt hier­zu die Norm EN 82079–1 Mög­lich­kei­ten auf, wie Warn­hin­wei­se in die Tech­ni­sche Doku­men­ta­ti­on ein­ge­bun­den wer­den kön­nen. Für Unter­neh­men, die auch außer­halb des Euro­päi­schen Wirt­schafts­raums agie­ren, ist ins­be­son­de­re die ANSI Z535 von hoher Rele­vanz.

Sie wol­len auf Num­mer sicher gehen? Kon­tak­tie­ren Sie uns.

Sicherheitshinweise

Wie sieht eine gute Infor­ma­ti­ons­ver­wal­tung aus?

Die Doku­ment­ver­wal­tung stellt gera­de bei kom­ple­xen Pro­duk­ten (wie Maschi­nen, Anla­gen und Soft­ware) mit unter Umstän­den einer Viel­zahl ver­schie­de­ner Vari­an­ten und Aus­füh­run­gen eine Her­aus­for­de­rung dar. Der Erstel­lungs­pro­zess einer Tech­ni­schen Doku­men­ta­ti­on muss so gestal­tet sein, dass er die­se Her­aus­for­de­run­gen zu bewäl­ti­gen ver­mag.

Viel­fach orga­ni­sie­ren ins­be­son­de­re klei­ne­re Unter­neh­men, deren Vari­an­ten­reich­tum an Pro­duk­ten in kei­nem Fall den Schwer­ge­wich­ten auf dem Markt nach­ste­hen muss, die Doku­ment­ver­wal­tung noch ohne den Ein­satz von Mana­ge­­ment-Sys­­te­­men. Ent­schei­dend hier­bei ist eine eiser­ne Dis­zi­plin bei der Ver­wal­tung von Pro­dukt­do­ku­men­ta­tio­nen sowie deren Vari­an­ten, Ver­sio­nen und unter­schied­li­chen Arbeits­stän­den. Auch soll­te die Kol­la­bo­ra­ti­on und der Kon­takt inner­halb des Unter­neh­mens dar­auf aus­ge­legt sein, bei meh­re­ren Bear­bei­tern ein und des­sel­ben Doku­ments Daten­ver­lus­te oder Datei­über­schrei­bun­gen aus­zu­schlie­ßen.

Auf­grund der stei­gen­den Nach­fra­ge nach indi­vi­dua­li­sier­ten Pro­duk­ten nimmt der Ein­satz von Con­tent Manage­ment Sys­te­men seit lan­ger Zeit ste­tig zu. Sie erleich­tern bei fach­ge­rech­tem Ein­satz und einer sorg­fäl­ti­gen Abwä­gung der erfor­der­li­chen Auf­wän­de das Erstel­len, Pfle­gen und Publi­zie­ren von Tech­ni­schen Doku­men­ta­tio­nen in die ver­schie­dens­ten Ziel­for­ma­te.

Wel­che Platt­for­men eig­nen sich für das Erstel­len einer Tech­ni­schen Doku­men­ta­ti­on?

Die Fra­ge nach der bes­ten Platt­form für das Erstel­len Tech­ni­scher Doku­men­ta­tio­nen ist sehr kom­plex und rich­tet sich maß­geb­lich nach den unter­neh­mens­in­ter­nen Anfor­de­run­gen an Benut­zer­freund­lich­keit, Ska­lier­bar­keit und Publi­ka­ti­ons­ka­nä­le.

Nach­fol­gend ein Über­blick gän­gi­ger Platt­for­men:

Word

Der Klas­si­ker: Micro­soft Word

Das Text­ver­ar­bei­tungs­pro­gram des Office-Pakets stellt noch immer eines der am häu­figs­ten ver­wen­de­ten Tools zum Erstel­len von Doku­men­ten aller Art dar.

Inte­grier­te Designs und Vor­la­gen ermög­li­chen einen schnel­len und effi­zi­en­ten Ein­satz. Gera­de für klei­ne­re Redak­tio­nen mit weni­gen und nicht all­zu vari­an­ten­rei­chen Pro­duk­ten ist Micro­soft Word ein kos­ten­güns­ti­ges Tool zum Erstel­len von Tech­ni­schen Doku­men­ta­tio­nen.

Indesign

Der Ästhet: Ado­be InDe­sign

Der Des­k­­top-Publis­her von Ado­be ist ein belieb­tes Tool zum Erstel­len optisch anspre­chen­der Doku­men­te, das vor allem im Bereich von Mar­ke­ting­ab­tei­lun­gen und Wer­be­agen­tu­ren weit ver­brei­tet ist.

Mit einem gro­ßen Umfang von Werk­zeu­gen und Text­be­ar­bei­tungs­op­tio­nen eig­net es sich in ers­ter Linie für Doku­men­te mit einem hohen Indi­vi­dua­li­sie­rungs­grad und ermög­licht vor allem in Kom­bi­na­ti­on mit wei­te­ren Redak­ti­ons­pro­gram­men ein pro­fes­sio­nel­les Erstel­len von Maga­zi­nen, Bro­schü­ren und Fly­ern.

FrameMaker

Der Pro­fi: Ado­be Frame­Ma­ker

Das Autoren­werk­zeug von Ado­be ist stark auf die Anfor­de­run­gen von Tech­ni­schen Redak­teu­ren aus­ge­rich­tet und kann pro­blem­los auch meh­re­re hun­dert oder tau­send Sei­ten Doku­ment­in­halt han­deln.

Mit eige­nen Skrip­ten und Plugins kön­nen Tech­ni­sche Redak­teu­re nahe­zu jede Anfor­de­rung an den redak­tio­nel­len Pro­zess in Eigen­re­gie umset­zen, um die Soft­ware wei­ter an die indi­vi­du­el­len Bedürf­nis­se anzu­pas­sen und hoch­wer­ti­ge Druck­pro­duk­tio­nen zu erzeu­gen.

CMS

Die Alles­kön­ner: Con­tent Manage­ment Sys­te­me (CMS)

Con­tent Manage­ment Sys­te­me die­nen als Single‑Source Publi­shing Sys­te­me dazu, eine nahe­zu unbe­grenz­te Anzahl ein­zel­ner Modu­le auto­ma­ti­siert und nach eige­nen Vor­ga­ben zu einem Doku­ment zusam­men­zu­fü­gen. Sie bie­ten in der Regel On‑Board‑Funktionen zur Datei­ver­wal­tung, Ver­sio­nie­rung und gemein­sa­mer Doku­ment­be­ar­bei­tung.

Con­tent Manage­ment Sys­te­me kön­nen in die unter­schied­lichs­ten Ziel­for­ma­te publi­zie­ren und sind prä­de­sti­niert für das Erstel­len von hoch­pro­fes­sio­nel­len Tech­ni­schen Doku­men­ta­tio­nen in mit­tel­gro­ßen bis gro­ßen Unter­neh­men mit vie­len Pro­dukt­va­ri­an­ten und Publi­ka­ti­ons­ka­nä­len.

Wel­che neu­en Tech­no­lo­gien sind für die Tech­ni­sche Doku­men­ta­ti­on rele­vant?

Digi­ta­le Doku­men­ta­ti­on

Das Bereit­stel­len der Pro­dukt­do­ku­men­ta­ti­on in digi­ta­ler Form durch­bricht Gren­zen, an die die klas­si­sche Papier­form nach wie vor gebun­den ist. Die Inhal­te der Doku­men­ta­ti­on sind auf digi­ta­lem Weg schnel­ler und ein­fa­cher zugäng­lich und die Not­wen­dig­keit, die zum Teil sehr umfang­rei­chen Doku­men­te auf­wen­dig nach den benö­tig­ten Infor­ma­tio­nen zu durch­su­chen ent­fällt.

Laptop
Die Vor­tei­le der digi­ta­len Doku­men­ta­ti­on auf einen Blick:
  • Hohe Ver­füg­bar­keit über Smart­pho­ne, Tablet und PC
  • Ggf. direk­tes Bereit­stel­len der Pro­dukt­do­ku­men­ta­ti­on über das Nut­­zer-Inter­­face des Pro­dukts (z. B. auf der Maschi­nen­steue­rung)
  • Schnel­les Auf­fin­den der benö­tig­ten Infor­ma­tio­nen (durch Such­funk­ti­on, Links, etc.)
  • Ein­bin­den inter­ak­ti­ver Inhal­te (3D-Model­­le, Hover-Effe­k­­te und Ani­ma­tio­nen)
  • Agi­les Ände­rungs­ma­nage­ment

Aug­men­ted und Vir­tu­al Rea­li­ty

Auch vor der Tech­ni­schen Doku­men­ta­ti­on macht der Fort­schritt nicht halt. Wäh­rend kom­ple­xe und immer benut­zer­freund­li­cher wer­den­de Con­tent Manage­ment Sys­te­me und Aut­ho­ring Tools schon fast zum alten Eisen zäh­len, hat in den letz­ten Jah­ren das The­ma der erwei­ter­ten (Aug­men­ted Rea­li­ty) und vir­tu­el­len Rea­li­tät (Vir­tu­al Rea­li­ty) einen star­ken Ein­fluss auf die Bran­che genom­men. Mit Hoch­druck arbei­ten Tech­ni­sche Redak­teu­re in Zusam­men­ar­beit mit Sof­t­­wa­re-Ent­­­wick­­lern an der Umset­zung neu­er Tech­no­lo­gien für die immer­si­ve Ver­mitt­lung von Infor­ma­tio­nen.

Wäh­rend sich die Tech­nik immer wei­ter ver­bes­sert und die Anzei­ge­ge­rä­te leich­ter und leis­tungs­stär­ker wer­den, sind schon jetzt diver­se Ein­satz­sze­na­ri­en ent­stan­den, in denen die­se Mit­tel gewinn­brin­gend zum Ein­satz kom­men. Aug­men­ted und Vir­tu­al Rea­li­ty stim­men Infor­ma­tio­nen gezielt auf den Anwen­der ab (zum Bei­spiel Maschi­nen­be­die­ner, Ser­vice­tech­ni­ker, etc.) und stel­len sie direkt am Pro­dukt bereit. In Form von Schu­lun­gen trägt die Tech­no­lo­gie zu einer effi­zi­en­ten und lebens­na­hen Ein­wei­sung am Pro­dukt bei. Die Ent­wick­lun­gen wer­den hier in der nahen Zukunft vor­an­schrei­ten und die Ein­satz­mög­lich­kei­ten und den aktu­ell noch recht auf­wän­di­gen Erstel­lungs­pro­zess immer wei­ter ver­bes­sern.

YouTube

Mit dem Laden des Vide­os akzep­tie­ren Sie die Daten­schutz­er­klä­rung von You­Tube.
Mehr erfah­ren

Video laden

Sie haben noch Fra­gen?

HighDoc - Ihr Dienstleister für Technische Dokumentation

Dani­el Keil, Geschäfts­füh­rer

Unser Exper­ten­team steht Ihnen mit Rat und Tat zur Sei­te.

Tele­fon

+49 3677 8782–0

E‑Mail

info@highdoc.de