technische dokumentation konkret...technische dokumentation konkretnachdem der „leitfaden für die...

4
Technische Dokumentation konkret NEWSLETTER | AUSGABE IV | NOVEMBER 2012 www.weka.de/produktsicherheit Liebe Leserin, lieber Leser, unser Newsletter in- formiert Sie regel- mäßig über aktuelle Entwicklungen und Trends, neue Fachbeiträge und interessante Ver- anstaltungen. Sie erhalten nützliche Linktipps und sind bei wichtigen gesetzlichen und normativen Änderungen stets up to date. Kürzlich wurde die Überset- zung des Leitfadens zur Maschinen- richtlinie 2006/42/EG veröffentlicht. Informieren Sie sich jetzt über die- se erstmals vollständige Version in deutscher Sprache. In unserem TechDok-Praxis-Teil fin- den Sie einen interessanten Beitrag zum Thema „Aus- und Weiterbildung: Welche Möglichkeiten gibt es?“. Es freut mich, Sie auch in dieser Form mit anregenden und wissens- werten Neuigkeiten rund um das Thema technische Dokumentation versorgen zu können. Herzlich, Ihre Claudia Strohmayer PS: Möchten Sie uns Anregungen oder Kritik zu Ihrer Praxislösung weiterleiten? Senden Sie einfach eine E-Mail an: [email protected] Auf einen Blick Neuer Ausschuss für Produktsicherheit . . . . . . . 1 Leitfaden Maschinenrichtlinie – vollständig auf Deutsch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Anleitungen zielgerichtet finden. . . . . . . . . . . . . . 2 Aus- und Weiterbildung: Welche Möglichkeiten gibt es? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Redaktionsleitfäden richtig einsetzen . . . . . . . . . 3 Grundwissen CE-Kennzeichnung . . . . . . . . . . . . 4 CE-Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Betriebsanleitung & Co. . . . . . . . . . . . . . . . . . . . 4 Impressum 4 95080-5013 Produkttipp 4 Aktuell 1 Neuer Ausschuss für Produktsicherheit Der neue Ausschuss für Produkt- sicherheit hat sich konstituiert. Der vormalige Ausschuss für technische Arbeitsmittel und Verbraucherpro- dukte hatte mit der Ablösung des Geräte- und Produktsicherheitsge- setzes (GPSG) durch das Produkt- sicherheitsgesetz (ProdSG) zum 01.12.2011 seine Rechtsgrundlage verloren. Der Ausschuss für Produktsicherheit berät die Bundesregierung in Fragen der Produktsicherheit. Er ist beim Bundesministerium für Arbeit und Soziales (BMAS) eingesetzt. Dem Ausschuss gehören sachverständige Personen aus dem Kreis der Markt- überwachungsbehörden, der Konfor- mitätsbewertungsstellen, der Träger der gesetzlichen Unfallversicherung, des Deutschen Instituts für Normung Editorial Aktuell TechDok-Praxis 2 Linktipp 4 e.V., der Kommission Arbeitsschutz und Normung, der Arbeitgeberverei- nigungen, der Gewerkschaften und der beteiligten Verbände, insbeson- dere der Hersteller, der Händler und der Verbraucher, an. Die Geschäfte des Ausschusses führt die Bundesan- stalt für Arbeitsschutz und Arbeits- medizin (BAuA). Neue Aufgaben Eine wichtige neue Aufgabe des Ausschusses besteht darin, die Spe- zifikationen zu ermitteln, die bei der Zuerkennung des GS-Zeichens neben den Produktanforderungen angewendet werden müssen. Hier- mit wurde ein neues Instrument ge- schaffen, um im Rahmen des GS-Zei- chens schnell und wirksam auf neue Erkenntnisse hinsichtlich Sicherheit und Gesundheitsschutz von Produk- ten reagieren zu können. Mehr dazu unter: www.baua.de Gesetze, Verordnungen, Richtlinien Leitfaden Maschinen- richtlinie – vollständig auf Deutsch Das BMAS hat die vollständige deutsche Übersetzung des „Leit- fadens für die Anwendung der Maschinenrichtlinie 2006/42/EG“ freigegeben. Am 24.07.2012 wurde die mit Österreich und der Schweiz abgestimmte Fassung an die Euro- päische Kommission zur Veröffent- lichung weitergeleitet. Damit liegt erstmals eine vollständige deutsche Version des Leitfadens vor. Gesetze, Verordnungen, Richtlinien 1 Veranstaltungen & Termine 4

Upload: others

Post on 19-Jan-2021

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Technische Dokumentation konkret...Technische Dokumentation konkretNachdem der „Leitfaden für die Anwendung der Maschinenrichtli-nie 2006/42/EG“ in Teilen bereits in deutscher

Technische Dokumentation konkretN E W S L E T T E R | A U S G A B E I V | N O V E M B E R 2 0 1 2

www.weka.de/produktsicherheit

Liebe Leserin,lieber Leser,

unser Newsletter in-formiert Sie regel-mäßig über aktuelle

Entwicklungen und Trends, neue Fachbeiträge und interessante Ver-anstaltungen.

Sie erhalten nützliche Linktipps und sind bei wichtigen gesetzlichen und normativen Änderungen stets up to date. Kürzlich wurde die Überset-zung des Leitfadens zur Maschinen-richtlinie 2006/42/EG veröffentlicht. Informieren Sie sich jetzt über die-se erstmals vollständige Version in deutscher Sprache.

In unserem TechDok-Praxis-Teil fi n-den Sie einen interessanten Beitrag zum Thema „Aus- und Weiterbildung: Welche Möglichkeiten gibt es?“.

Es freut mich, Sie auch in dieser Form mit anregenden und wissens-werten Neuigkeiten rund um das Thema technische Dokumentation versorgen zu können.

Herzlich, Ihre

Claudia Strohmayer

PS: Möchten Sie uns Anregungen oder Kritik zu Ihrer Praxislösung weiterleiten? Senden Sie einfacheine E-Mail an:[email protected]

Auf einen Blick

Neuer Ausschuss für Produktsicherheit . . . . . . . 1

Leitfaden Maschinenrichtlinie – vollständig auf Deutsch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Anleitungen zielgerichtet fi nden. . . . . . . . . . . . . . 2Aus- und Weiterbildung: Welche Möglichkeiten gibt es? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Redaktionsleitfäden richtig einsetzen . . . . . . . . . 3

Grundwissen CE-Kennzeichnung . . . . . . . . . . . . 4

CE-Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Betriebsanleitung & Co. . . . . . . . . . . . . . . . . . . . 4

Impressum 4

9508

0-50

13

Produkttipp 4

Aktuell 1

Neuer Ausschuss für Produktsicherheit

Der neue Ausschuss für Produkt-sicherheit hat sich konstituiert. Der vormalige Ausschuss für technische Arbeitsmittel und Verbraucherpro-dukte hatte mit der Ablösung des Geräte- und Produktsicherheitsge-setzes (GPSG) durch das Produkt-sicherheitsgesetz (ProdSG) zum 01.12.2011 seine Rechtsgrundlage verloren.

Der Ausschuss für Produktsicherheit berät die Bundesregierung in Fragen der Produktsicherheit. Er ist beim Bundesministerium für Arbeit und Soziales (BMAS) eingesetzt. Dem Ausschuss gehören sachverständige Personen aus dem Kreis der Markt-überwachungsbehörden, der Konfor-mitätsbewertungsstellen, der Träger der gesetzlichen Unfallversicherung, des Deutschen Instituts für Normung

Editorial

Aktuell

TechDok-Praxis 2

Linktipp 4

e.V., der Kommission Arbeitsschutz und Normung, der Arbeitgeberverei-nigungen, der Gewerkschaften und der beteiligten Verbände, insbeson-dere der Hersteller, der Händler und der Verbraucher, an. Die Geschäfte des Ausschusses führt die Bundesan-stalt für Arbeitsschutz und Arbeits-medizin (BAuA).

Neue AufgabenEine wichtige neue Aufgabe des Ausschusses besteht darin, die Spe-zifi kationen zu ermitteln, die bei der Zuerkennung des GS-Zeichens neben den Produktanforderungen angewendet werden müssen. Hier-mit wurde ein neues Instrument ge-schaffen, um im Rahmen des GS-Zei-chens schnell und wirksam auf neue Erkenntnisse hinsichtlich Sicherheit und Gesundheitsschutz von Produk-ten reagieren zu können.

Mehr dazu unter: www.baua.de

Gesetze, Verordnungen, Richtlinien

Leitfaden Maschinen-richtlinie – vollständig auf Deutsch

Das BMAS hat die vollständige deutsche Übersetzung des „Leit-fadens für die Anwendung der Maschinenrichtlinie 2006/42/EG“ freigegeben. Am 24.07.2012 wurde die mit Österreich und der Schweiz abgestimmte Fassung an die Euro-päische Kommission zur Veröffent-lichung weitergeleitet. Damit liegt erstmals eine vollständige deutsche Version des Leitfadens vor.

Gesetze, Verordnungen, Richtlinien 1

Veranstaltungen & Termine 4

Page 2: Technische Dokumentation konkret...Technische Dokumentation konkretNachdem der „Leitfaden für die Anwendung der Maschinenrichtli-nie 2006/42/EG“ in Teilen bereits in deutscher

Technische Dokumentation konkret

Nachdem der „Leitfaden für die Anwendung der Maschinenrichtli-nie 2006/42/EG“ in Teilen bereits in deutscher Sprache veröffentlicht wurde, ist nun die inhaltliche Prü-fung und Korrektur des von der Eu-ropäischen Kommission vorgelegten deutschen Übersetzungsentwurfs durch das BMAS auch für die „An-hänge“ abgeschlossen.

Der Leitfaden soll Hilfestellung bei der europaweit einheitlichen Ausle-gung und Anwendung der Maschi-nenrichtlinie 2006/42/EG geben. Er ist an alle Kreise gerichtet, die mit der Anwendung der Richtlinie befasst sind, wie z.B. Hersteller, Händler, Importeure von Maschinen, Markt-überwachungsbehörden, Aufsichts-dienste der Berufsgenossenschaften oder Prüfstellen.

Mehr dazu unter: www.bmas.de

TechDok-Praxis

Anleitungen zielgerichtet fi nden

Häufi g möchte ein Kollege ganz spezifi sche Benutzerinformationen zu einem eigenen Produkt einsehen, die im Hause entstanden sind.

Zum Beispiel

• interessiert den Vertriebsmitarbei-ter, welche Maschinenabmessun-gen in der Betriebsanleitung als verbindlich angegeben werden.

• möchte die Marketingmitarbei-terin prüfen, ob das Titelfoto für die Anleitung auch in der freige-gebenen Version eingebunden wurde.

• will die Versandabteilung sicher-stellen, dass der in der Anleitung dargestellte Lieferumfang tat-sächlich eingehalten wird.

Aber auch auf Kunden- oder Betrei-berseite sind verschiedene Abteilun-gen an bestimmten Informationen aus der Betriebsanleitung interes-siert. Da ist für den Projektleiter und

das Installationspersonal bei der bauseitigen Vorbereitung der Werks-halle die Lage der Medienversorgung wichtig und für den Betreiber die vorzusehende persönliche Schutz-ausrüstung für das Bedienpersonal. Sicher, all diese Informationen lassen sich in einer sachgerechten Betriebs-anleitung fi nden. Aber wo?

Suchen … und fi ndenZunächst stellt sich die Frage nach dem Dokumententyp: Soll ich in der Installationsanleitung, der Bedie-nungsanleitung oder in der Wartungs-anleitung mit der Suche beginnen?

Bei rein gedruckt vorliegenden An-leitungen ist der Lagerort in der Re-gel für Kollegen kaum durchschau-bar – vielleicht liegt die Anleitung im Lager oder beim Versand oder bei der Technischen Redaktion oder beim Marketing?

Bestenfalls liegt die Benutzerinfor-mation als PDF-Datei irgendwo auf dem Server. Mit viel Glück sogar in einer transparenten Baumstruktur, nach Projekten, Bearbeitern oder Produkten sortiert.

Eine an der Technischen Hochschu-le Mittelhessen 2011 durchgeführte Umfrage bei kleinen und mittelstän-dischen Unternehmen der Region zum Umgang mit technischer Do-kumentation ergab, dass bei 36 % der Befragten die Suche nach elek-tronischen abgelegten Dokumenten im Durchschnitt zwischen fünf und zehn Minuten dauert. Meist wird dabei nicht effi zient mit Metadaten gesucht, sondern mit der langsamen

Dateisuche des Betriebssystems oder im Projektordner (siehe Abb. 1).

Hat der Suchende dann endlich die Anleitung aufgespürt, muss er sich auf der Suche nach der ihn inter-essierenden Information durch vie-le Kapitel – gegebenenfalls durch mehrere Hundert Seiten – kämpfen. Schnell vergeht die Lust und man sucht dann doch lieber nach dem Kollegen, der es weiß – oder zumin-dest ungefähr weiß.

Zwar bieten Dokumentenmanage-mentsysteme oft die Möglichkeit der Volltextsuche (auch Adobe Acrobat verfügt mit der Funktion Catalogue über eine rasante Suche in großen PDF-Clustern). Dennoch bleiben diese Methoden umständlich, weil man in der Regel zahllose Treffer angezeigt bekommt, die aussortiert werden wollen.

Intelligente LösungenEs gilt also, einerseits das Dokument ausfi ndig zu machen, das die ge-suchten Informationen enthält, und andererseits in diesem Dokument die Informationen möglichst schnell zu fi nden.

Ausführliche Informationen dazu er-halten Sie im Beitrag unserer beiden Autoren Rainer Bernd Voges und Ulrich Thiele.

Abb. 1: Wie suchen Sie?

Page 3: Technische Dokumentation konkret...Technische Dokumentation konkretNachdem der „Leitfaden für die Anwendung der Maschinenrichtli-nie 2006/42/EG“ in Teilen bereits in deutscher

www.weka.de/produktsicherheit

Aus- und Weiterbildung: Welche Möglichkeiten gibt es?

Die Aus- und Weiterbildungsmög-lichkeiten bilden die zentrale Säule in der Qualifi zierung Technischer Redakteure. Die Bildungsangebote stammen von staatlichen, öffentli-chen oder privaten akkreditierten Organisationen.

Daneben stehen Berufsinteressenten auch individuelle Aus- und Weiter-bildungsmöglichkeiten zur Verfü-gung, die nicht auf einen formalen Abschluss hinauslaufen. Beispielhaft seien hier erwähnt:

• Fachtagungen der Verbände • Vorträge und Workshops der Re-

gionalgruppen verschiedener Verbandsorganisationen

• Tagesseminare bei öffentlich-rechtlichen Bildungsinstituten

• Mailinglisten, Zeitschriften, On-line-Magazine und Newsletter

• einschlägige Literatur

Nachfolgend fi nden Sie die Beschrei-bung der Ausbildungsmatrix für Technische Redakteure mit der Viel-falt an Aus- und Weiterbildungsmög-lichkeiten. Die Matrix hilft Ihnen, die für Sie individuell passende Art der Weiterbildung zu fi nden.

Überblick über die Möglichkeiten im deutschsprachigen RaumDie Aus- und Weiterbildungsange-bote für den Technischen Redakteur lassen sich grob in drei „Säulen“ unterteilen, die weiter Tabelle 1 im Überblick zusammengefasst sind:

• Säule 1: akademische Ausbildung (1a Bachelor: grundständiges Stu-dium, 1b Master: Aufbaustudium, 1c Kontaktstudium)

• Säule 2: Weiterbildungsangebote privater und öffentlich-rechtlicher Institute sowie des Fachverbands tekom (2a Zertifi katslehrgänge, 2b tekom-Zertifi kat „Technischer Redakteur“)

• Säule 3: betriebliche Aus- und Weiterbildung (3a Volontariat, 3b unternehmenseigene Akademien)

Kriterien/Angebote 1a 1b 1c 2a 2b 3a 3b 4a

Vollzeitausbildung X X X X

berufsbegleitend X X X X X

Alter < 20 X

Alter 20–35 X X X X X X X

Alter > 35 X X X X

Berufserfahrung TD X X

Quereinsteiger X X X

Zusätzlich wird technische Doku-mentation in der Schul- und Berufs-bildung gelehrt, was zu staatlich ge-prüften Assistenten für technische Kommunikation führen kann (4a).

Detaillierte Informationen zu den einzelnen Möglichkeiten erhalten Sie in den zugehörigen Beiträgen unseres Herausgebers Ulrich Thiele.

Tab. 1: Ausbildungsmatrix

Redaktionsleitfäden richtig einsetzen

Was ist ein Redaktionsleitfaden? Ein Redaktionsleitfaden ist ein Do-kument, in dem die Redaktion Re-geln zur formalen und inhaltlichen Gestaltung und zur Erstellung pro-fessioneller technischer Dokumen-tation festlegt.

Die Redaktion defi niert hier Aspekte wie organisatorische und technische Regelungen, Formulierungsrichtli-nien sowie qualitative und formale Eigenschaften der Dokumentation.

Für den Leitfaden existieren unter-schiedliche Bezeichnungen wie

• Redaktionshandbuch, • Dokumentationsrichtlinie, • Gestaltungsrichtlinie usw.

Warum ein Redaktionsleitfaden?Mit einem Redaktionsleitfaden las-sen sich vielfältige Ziele erreichen. Jede Redaktion muss sich allerdings ihre eigenen Ziele setzen, da diese sehr unternehmensspezifi sch sind. Dabei ist zu beachten, dass der Re-daktionsleitfaden möglichst auf kon-

krete Bedürfnisse antworten soll und keine theoretische Abhandlung dar-stellt.

Häufi g diskutieren die Redakteure immer wieder die gleichen Fragen zur Gestaltung, Benennung oder Formulierung. Diese Diskussionen kosten Nerven und Zeit. Wenn der-artige und andere Fragen geregelt und im Leitfaden dokumentiert sind, werden die zeitraubenden Debatten überfl üssig und die Mitarbeiter pro-duktiver, eventuell sogar zufriede-ner. Außerdem sinkt der Aufwand für Korrekturen und Nacharbeiten, da die Anforderungen an die Doku-mentation im Leitfaden klar defi niert sind.

Redaktionsabläufe effi zienter gestaltenDie Steigerung der Effi zienz ist mit der Einsparung von Zeit und Kosten eng verknüpft. Durch Standardisie-rung sowie durch die Vereinheitli-chung von Textstruktur, Textinhalt, Terminologie und Abbildungen sind Effi zienzsteigerungen möglich. Dar-über hinaus steigt die Chance, Ter-mine einzuhalten, wenn der Ablauf der Dokumenterstellung klar und verbindlich defi niert ist.

Page 4: Technische Dokumentation konkret...Technische Dokumentation konkretNachdem der „Leitfaden für die Anwendung der Maschinenrichtli-nie 2006/42/EG“ in Teilen bereits in deutscher

Technische Dokumentation konkret

ImpressumWEKA MEDIA GmbH & Co. KGSitz in Kissing, Registergericht Augsburg, HRA 13940

Persönlich haftende Gesellschafterin WEKA MEDIA Beteiligungs-GmbH, Sitz in Kissing, Registergericht Augsburg, HRB 23695

Vertretungsberechtigte GeschäftsführerStephan Behrens, Michael Bruns, Werner Pehland

BezugWEKA MEDIA GmbH & Co. KGRömerstraße 4, D-86438 KissingFon 0 82 33.23-40 00Fax 0 82 33.23-74 00www.weka.de

V.i.S.d.P.Claudia Strohmayer, Anschrift siehe Bezug

RedaktionClaudia StrohmayerE-Mail: claudia [email protected]

SatzJudith Kerner, Anschrift siehe Bezug

DruckDruckerei Aldo Marzorati, Offset- und Digitaldruck,Angerstraße 10, D-86343 Königsbrunn

Vervielfältigungen jeder Art sind nur mit ausdrücklicher schriftlicher Genehmigung des Verlags gestattet.

In einem Leitfaden wird das Wissen dokumentiert, das ungleichmäßig in vielen Köpfen verteilt ist. Es entsteht ein frei zugänglicher Wissenspool. Dadurch wird das Unternehmen unabhängiger von der Personalent-wicklung und kann die Kontinuität der Dokumentation sichern, auch wenn Mitarbeiter die Abteilung ver-lassen.

Wenn sich Redakteure beim Erstel-len von Dokumenten an die Vor-gaben eines Redaktionsleitfadens halten, dann werden die erstellten Dokumente einheitlicher und in Be-zug auf Layout und Textqualität kon-sistenter. Die Einheitlichkeit führt zu einem Wiedererkennungseffekt bei den Anwendern und sie können ge-suchte Informationen leichter fi nden. Ein konsistentes Erscheinungsbild gepaart mit sprachlicher Konsistenz hilft dem Leser, neue Information aufzunehmen und in ein bereits vor-handenes Schema einzubauen.

Qualität messen und kontrollierenIn einem Redaktionsleitfaden wer-den die Qualitätsansprüche und -kriterien für die Dokumentation defi niert. Die Qualität wird durch festgelegte Kriterien überprüfbarer. Außerdem unterstützen die Festle-gungen das Redigieren und Korri-gieren von Texten. Die Bewertung eines Textes folgt den festgelegten Regeln und wird dadurch objektiver.

Der Redaktionsleitfaden hilft, neue Mitarbeiter in Begriffl ichkeiten ein-zuführen und Arbeitsabläufe offen-zulegen. Damit trägt er dazu bei, die Einarbeitungszeit nachhaltig zu verkürzen.

Im Beitrag „Redaktionsleitfaden – das Ende der Leiden mit dem Leit-faden“ unserer Autorin Britta Görs erhalten Sie darüber hinaus konkre-te Hinweise und Empfehlungen für die Erstellung eines Leitfadens und gewinnen, anhand von zwei Beispie-len, einen Einblick in die Praxis.

Produkttipp

Grundwissen CE-Kenn-zeichnung

Endlich Fakten ohne langwieriges Drumherum und komplizierte Erör-terungen!

Das neue Fachbuch „Grundwissen CE-Kennzeichnung“ hilft Ihnen dabei, sich effi zient und praxisnah in die CE-Thematik einzuarbeiten. Schrittweise führt es Sie durch den CE-Prozess und zeigt, worauf es ge-rade im Maschinenbau ankommt: von der Richtlinienrecherche über die Risikobeurteilung bis hin zur rechtskonformen Dokumentation.

Weitere Informationen, unter ande-rem zur Bestellung, erhalten Sie un-ter http://shop.weka.de.

Linktipp

CE-Forum

Erstes deutschsprachiges Forum zur CE-Kennzeichnung, unter anderem mit folgenden Themen: CE-Konfor-mitätsbewertungsverfahren, EU-Richtlinien, Gesetze und Normen, Grundwissen zur CE-Kennzeich-nung sowie zur Risikobeurteilung.

Mehr dazu unter: www.ce-forum.helpdesign.eu

Betriebsanleitung & Co. Am 12. und 13.03.2013 in Stuttgart

Wer eine anwenderfreundliche und rechtskonforme technische Dokumentation erstellen muss, braucht grundlegende Fachkennt-nisse über den vielfach normier-ten Dokumentationsprozess.

Fundierte Antworten auf alle Fra-gen rund um die Betriebsanleitung sowie Raum für Diskussionen und den Erfahrungsaustausch bietet Ihnen dieses Seminar. Sie erhal-ten Grundlagenwissen, geldwerte Umsetzungshilfen und Tipps zur Optimierung Ihrer Arbeitsabläufe. In Übungen und Dialogen über-tragen Sie das Gelernte bereits in verwertbare Erfahrungen. Bringen Sie eigene Anleitungen als Muster für Verbesserungsvorschläge mit!

So erstellen Sie Ihre technischen Do-kumentationen benutzerfreundlich, rechtskonform und wirtschaftlich!

Referent: Ulrich Thiele

Weitere Informationen unter:

www.weka-akademie.de,Web-Code: 6207

Verantaltungen & Termine