Überspringen zu Hauptinhalt

TEKOM #001 – Doppelfolge Teil 1 Allgemeines und IEC 82079 Version 2

TEKOM #001 – Doppelfolge Teil 1 Allgemeines Und IEC 82079 Version 2

Ein herzliches Willkommen an alle Zuhörerinnen und Zuhörer zu einer neuen Folge unseres Podcasts zur Technischen Dokumentation. Mein Name ist Florian Schmider und ich bin bei der GFT AKADEMIE verantwortlich für den Bereich der Technischen Dokumentation.

Aktuelles aus der Branche, Edition 2 der IEC 82079-1 Teil 1

Wie letzte Woche angekündigt, starten wir heute mit einer neuen Themenreihe. Sie wird ähnlich wie die Themenreihe „US-Produkthaftung“, vorerst ein paar wenige Folgen umfassen, wird jedoch öfters noch erweitert und ergänzt werden. Wie einige Zuhörer wissen, war vergangene Woche die tekom-Tagung, mit vielen Vorträgen und Workshops zu aktuellen Themen und Entwicklungen im Bereich der Dokumentation. Diese Reihe soll sich daher um aktuelle Informationen und Entwicklungen in diesem Bereich drehen. Diese Folge ist der erste Teil einer Doppelfolge, da es sehr viele Informationen zur zweiten Edition der IEC 82079-1 gibt.

Die Folgen dieser Reihe bauen grundsätzlich nicht aufeinander auf. Ich versuche, dass jede Folge in sich geschlossen ist und ein Thema beendet wird. Sollten Themen zu umfangreich sein, mache ich eine Doppelfolge daraus und kündige es zu Beginn der Folge entsprechend an.

Da sich die „tekom-Reihe“ jedoch um aktuelle Entwicklungen und Informationen dreht, ist es wichtig, dass Sie sich bereits mit den einzelnen Themen auseinander gesetzt haben, um diese vollständig zu verstehen. Ich kann beispielsweise bei Änderung oder Weiterentwicklung von Normen nicht zuerst die alte Norm komplett erklären, um im Anschluss die Änderungen zu besprechen. Dies würde den zeitlichen Rahmen sprengen.

Die tekom

Wie Anfangs erwähnt, war letzte Woche die tekom-Tagung. Für diejenigen von Ihnen, die nichts mit tekom anfangen können, möchte ich es kurz erklären. Die tekom ist der deutsche Fachverband zur technischen Kommunikation. Sie veranstaltet zwei Tagungen im Jahr, eine im Frühjahr und eine im Herbst. Die Frühjahrstagung ist die kleinere der beiden Tagungen und ihr Ort wechselt jedes Jahr. Die Herbsttagung findet seit einigen Jahren auf dem Messegelände in Stuttgart statt.

Tekom ist die Abkürzung für „Technische Kommunikation“. Darunter versteht man den Prozess zur Definition, Erstellung und Bereitstellung von Informationsprodukten für die sichere, effiziente und effektive Verwendung von Produkten. Die Technische Dokumentation und die Anleitungen sind entsprechend wichtige Teile dieses Prozesses.

Die tekom veranstaltet jedoch nicht nur diese Tagungen. Sie wirkt beispielsweise auch aktiv in der Entstehung von Normen und Richtlinien mit oder kürt jedes Jahr die Sieger des Dokupreises. Dies ist der Preis für die beste, eingereichte Dokumentation. Durch die Mitarbeit an Normen und Richtlinien können aktuelle Informationen und Entwicklungen durch Vorträge und Workshops während der Tagung an die Mitglieder und Fachbesucher weitergegeben und vermittelt werden.

Daneben gibt es eine Vielzahl an Aussteller, die ihre Produkte wie Software oder Dienstleistungen dem Fachpuplikum während der Pausen auf dem Messegelände präsentieren. Auch wir sind seit vielen Jahren einer dieser Aussteller, besuchen aber ebenfalls die Vorträge um auf dem Laufenden zu bleiben. Dieses Jahr konnte ich sogar einige der Zuhörer dieses Podcasts persönlich, während der Messe kennenlernen.

Die neue Podcast-Reihe

So viel zur tekom und der Herbsttagung selbst. Diese Podcastreihe soll sich mit den aktuellen Entwicklungen, neuen Normen und Richtlinien beschäftigen, die in den Vorträgen vorgestellt und präsentiert wurden. Da die Tagungen jedes Jahr stattfinden, kann die Reihe immer wieder erweitert werden. Voraussichtlich immer nach den jeweiligen Tagungen.

Vorerst wird sich die Reihe daher mit den diesjährigen Themen beschäftigen. Die ersten beiden Folgen sind eine Doppelfolge zur zweiten Edition der IEC 82079-1. In den weiteren Folgen wird es um rechtliche Entwicklungen, die Marktaufsicht, verschiedene Normen und andere Fachvorträge gehen.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Edition 1 im Überblick

Die Edition 1 der Norm, in meinen Podcast meist als 82079 oder DIN EN 82079-1 bezeichnet, gibt es seit 2012 bzw. in Deutsch seit Juni 2013. Sie stellt die wichtigste Norm für Anleitungen dar und trägt den Untertitel „Erstellen von Gebrauchsanleitungen“ bzw. „Preparation of instructions for use“. Sie gilt für alle Arten von Anleitungen, für alle Arten von Produkten. Von der Farbdose bis zur hallenfüllenden Industrieanlage.

Inhaltlich beschäftigt sich die erste Edition mit Begriffsdefinitionen, Prinzipien, dem Inhalt von Anleitungen, deren Gestaltung, einzelnen Anforderungen an den Erstellungsprozess von Anleitungen und die dafür erforderlichen Qualifikationen. Die Konformitätsprüfung von Anleitungen, Informationen zum Erstellungsprozess und Testmethoden waren ebenfalls enthalten, aber meist nur in geringen Auszügen. Diese Norm wird nun aktuell weiterentwickelt und nächstes Jahr veröffentlicht. In der Reihe „Betriebsanleitung erstellen“ habe ich bereits öfters auf die erste Version verwiesen.

Seit Veröffentlichung der Norm sind bereits 6 beinahe 7 Jahre vergangen und daher wird sie als zweite Edition weiterentwickelt.

Die Beteiligten an der Weiterentwicklung

Die zweite Edition wird dabei mit einer guten, internationalen Beteiligung weiterentwickelt. Für uns als technische Redakteure bedeutet dies, dass die Norm auch außerhalb von Europa bzw. der EU wichtiger wird und entsprechend angewendet werden kann und muss.

Die zweite Edition wird von vielen Staaten kommentiert und erarbeitet. Kommentiert wurden diese von Italien, den Niederlanden, Norwegen, Tschechien und China. Erarbeitet wird sie von Deutschland, Großbritannien, Finnland, Dänemark, Schweden, Japan und Überraschung von den USA. Somit wird sie auch in den USA eine Relevanz bekommen.

Durch diese weltweite Beteiligung wird aus der ursprünglichen DIN EN bzw. IEC-Norm eine
ISO IEC IEEE-Norm, wo noch die entsprechenden Kürzel der europäischen und nationalen Normungsorganisationen hinzukommen. Sollten Sie mit IEEE nicht anfangen können:
IEEE ist das „Institute of Electrical and Electronics Engineers“, einer der weltgrößten Berufsfachverbände auf internationaler Ebene und entsprechend wichtig in den USA.

Aus „Instruction“ wird „Information“

Die wichtigste Änderung der Norm zeigt sich bereits im Namen. Aus „Instructions for use“ wird „Information for use“. Sprich wir verlagern uns weg von Anleitungen im Allgemeinen und betrachten die Informationen als solches, egal in welcher Form sie vorhanden sind. Eine aus meiner Sicht wichtige und richtige Entscheidung, da wir Informationen an den Nutzer in vielen Arten weitergeben. Sei dies durch Anleitungen, durch Videos, Websiten oder Marketingunterlagen wie Flyer und Prospekte.

Aus Sicht des Nutzers ist es wichtig, dass all diese Informationen einheitlich und konsistent sind. Daher ist dies ein wichtiger Punkt in der Norm. Es muss darauf geachtet werden, dass es keine Widersprüche in den einzelnen Informationen und Informationsquellen gibt. Auch aus Haftungssicht ist dies wichtig, damit keine falschen Informationen durch Prospekte an mögliche Kunden gehen, diesen vom Kauf des Produktes überzeugen und das Produkt dann die geschürten Erwartungen nicht einhalten kann. Die daraus folgenden Regressansprüche und -Folgen können dadurch vermieden werden.

Um dies zu gewährleisten, dreht sich in der neuen Norm vieles darum, wie Informationen erstellt, gepflegt, weiterverarbeitet und verwaltet werden. Single-Source-Puplishing, die Trennung von Erfassung und Publikation von Informationen und die Unterscheidung der einzelnen Informationsarten sind daher wichtige Inhalte der Norm.

Die Prinzipien – Prinzipien des Zwecks

Die Basis dazu bildet die Norm über verschiedene Prinzipien ab, die den Ersteller der Informationen dabei unterstützen sollen, die Informationen richtig und sinnvoll zu erstellen. Dazu werden alle Prinzipien in 3 Kategorien einsortiert, um die Prinzipien übersichtlich zu halten. Die erste Kategorie dreht sich um den Zweck der Informationen.

Das erste Prinzip dort ordnet die Informationen den Informationstypen zu. Sind es Informationen zur Wartung oder Informationen für Prospekte? Wo werden sie verwendet bzw. wo können sie verwendet werden?

Das nächste Prinzip ist die Unterscheidung, ob die Informationen Teil eines Produktes sind oder nicht. Auch muss hierbei beachtet werden, dass Informationen Teil des Produktes selbst sind (also aus dem rechtlichen Blick) und entsprechend dadurch mit dem Produkt übereinstimmen müssen.

Das dritte Prinzip betrifft die Zielgruppe. Die Informationen müssen sich nach den Zielgruppen richten, für die sie erstellt werden. Anleitungen von Produkten für Endnutzer müssen entsprechend einfacher geschrieben werden, als Anleitungen für speziell geschulte Fachkräfte.

Das vierte Prinzip soll hingegen sicherstellen, dass die Informationen den sicheren Gebrauch des Produktes unterstützen. Dies ist beispielsweise im Zusammenhang mit Anleitungen wichtig. Rechtliche oder werbliche Texte haben nichts in Anleitungen zu suchen, da sie nichts mit dem Gebrauch des Produktes zu tun haben.

Das letzte Prinzip in der Kategorie des Zwecks betrifft die Konformität. Informationen sollen konform zu den entsprechenden Normen, Richtlinien und Gesetzen sein und diese berücksichtigen.

Die zweite Kategorie – Qualität von Informationen

Die zweite Kategorie ist umfangreicher und beschäftigt sich mit der Qualität der Informationen. Informationen müssen für die Zielgruppe verständlich formuliert werden, den Informationsbedarf der Gruppe erfüllen und für diese auch zugänglich sein. Dies sind die ersten drei Prinzipien.

Um Informationen möglichst aus einer Quelle (Stichwort: Single Source) verwenden zu können, muss der Inhalt, also die Information selbst, losgelöst vom Layout sein. Sprich Inhalt und Layout müssen voneinander getrennt werden. Dies ist das vierte Prinzip.

Die nächsten Prinzipien betreffen Konsistenz und Form. Die Konsistenz der Inhalte und der Formen bzw. des Layouts müssen Informationsübergreifend gewährleistet werden. Hier dreht es sich darum, dass es ein CI, eine Corporate Identity, gibt und diese verwendet wird. Beispielsweise sollen Anleitungen dadurch immer gleich aussehen. Auch die Informationen selbst müssen konsistent sein und dürfen sich nicht widersprechen.

Die wichtigsten Prinzipien in der Kategorie Qualität hängen jedoch stark zusammen. Dies sind die Prinzipien der Vollständigkeit, der Korrektheit, des Minimalismus und der Prägnanz. Gerade die Prinzipien der Vollständigkeit und des Minimalismus haben hierbei eine interessante Wechselwirkung. Anleitungen haben Vollständig zu sein, müssen aber auf das wesentliche begrenzt werden.

Was sich hier vielleicht etwas widersprüchlich anhört, ist eigentlich einfach. Es hat stark mit der Zielgruppe zu tun. Es müssen alle Informationen bereitgestellt werden, damit die Zielgruppe eine Handlung oder Tätigkeit erfolgreich und sicher durchführen kann.

Dabei können die Informationen weggelassen bzw. nicht angegeben werden, die der Zielgruppe bekannt sind. Das Prinzip des Minimalismus hat auch noch eine andere interessante Auswirkung: Wird eine Anleitung hauptsächlich von ausgebildetem Fachpersonal genutzt, ist jedoch für die Zielgruppe „alle“ geschrieben, ist sie nicht Normkonform, da das Prinzip des Minimalismus nicht eingehalten wurde.

Kategorie 3 – Der Prozess

Kommen wir nun zu der letzten Kategorie und den dazugehörigen Prinzipien: Den Prozess. Hierunter sind alle Prinzipien gegliedert, die mit dem Prozess der Informationserstellung und –verwaltung zu tun haben. Die ersten drei Prinzipien sind, dass der Erstellungsprozess von Informationen definiert, geplant und wiederholbar sein muss. Es müssen in den Unternehmen Arbeitsschritte definiert und eingehalten werden, damit alle für das Produkt notwendigen Informationen zusammengetragen werden können.

Das nächste Prinzip ist, dass dieser ganze Vorgang qualitätsgesichert und auch in den jeweiligen unternehmerischen Prozessen abgebildet werden muss. Somit muss die Beschaffung, Erstellung und Verwendung von Informationen in Qualitätsprozessen und Vorgängen miteinfließen und entsprechend dokumentiert werden. Auch die Qualifikationen des Personals, das all diese Tätigkeiten durchführt müssen ermittelt, festgelegt und sichergestellt werden.

Das Prinzip der einzigen Quelle, der Single Source, habe ich bereits erwähnt. Informationen sollen zentral verwaltet und organisiert werden. Das letzte Prinzip betrifft die Produkte und deren Lebenszyklus. Die Informationen sollen alle Lebensphasen der Produkte abbilden und die Anwender entsprechend informieren.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Anforderungen an den Prozess als Beispiel

Anhand all dieser Prinzipien sollen Informationen erstellt, verwendet und verwaltet werden. Der Schwerpunkt legt die Norm dabei auf die Prinzipien des Prozesses. Die Einbettung und Anwendung der Prinzipien kann beispielsweise so aussehen:

Über die Zielgruppenanalyse soll die Zielgruppe und deren Kenntnisse ermittelt werden. Über das Risikomanagement bzw. die Risikobeurteilung müssen dann alle Aufgaben oder Anwendungsfälle ermittelt und betrachtet werden. Erkannte Risiken müssen behoben und verhindert werden. Dabei ist die Zielgruppenanalyse wichtig, um zu sehen, was die Zielgruppe erkennen kann und wie sie sich in Gefahrensituationen verhalten wird.

Eine verantwortliche Person sammelt die entsprechenden Informationen und stellt diese zusammen. Die verantwortliche Person bzw. deren Fähigkeiten und Kenntnisse, werden zuvor entsprechend definiert. Die verantwortliche Person stellt dabei außerdem sicher, dass die Rückverfolgbarkeit der Informationen zwischen unterschiedlichen Versionen, Produkten und Informationsformen gewährleistet ist. So soll sichergestellt werden, dass die während des Lebenszyklus des Produktes gültigen Informationen zu jedem Produkt, jederzeit vorhanden und zugeordnet werden können.

Anhand eines Redaktionsleitfadens werden Schreib- und Terminologieregeln sowie Regeln für die Informationsarten festgelegt und bei der Bereitstellung der Informationen an die Nutzer entsprechend berücksichtigt. An dieser Stelle haben wir quasi die fertige Anleitung erstellt und an die Nutzer des Produktes übergeben. Jedoch sind wir an dieser Stelle noch nicht fertig.

Zum Schluss des Prozesses benötigen wir Rückmeldungen von unseren Nutzern. Beispielsweise durch Usability-Tests. Mit dieser Rückmeldung werden dann die Informationen entsprechend angepasst, optimiert, bewertet oder vielleicht sogar zukünftig nicht mehr berücksichtigt, da sie überflüssig sind.

Hier muss ebenfalls eine Methode oder ein Prozess festgelegt und durchgeführt werden.

Diese Prinzipien und deren Anwendung waren bereits in einer gröberen Form in der ersten Version der Norm vorhanden. Sie wurden nun jedoch deutlich überarbeitet und erweitert, um auf alle Arten von Informationen angewendet werden zu können.

Mit dem Abschluss der Prinzipien sind wir nun auch am Ende unserer Folge. Wie bereits erwähnt, handelt es sich bei dieser Folge um den ersten Teil einer Doppelfolge. In der nächsten Folge werden wir mit der Zielgruppe weitermachen, die ich in den vergangen Minuten bereits wieder häufig genannt habe. Die zweite Version der Norm hat auch hier einiges erweitert und ergänzt, wodurch auch das Thema nun verständlicher ist.

Ich hoffe, Ihnen hat diese Folge gefallen. Nächste Woche geht es mit dem zweiten Teil der Doppelfolge weiter.

Sollten Sie Anregungen oder Fragen zu dem Thema haben, schreiben Sie diese bitte in die Kommentare oder lassen Sie uns diese per E-Mail zukommen. Ich freue mich schon auf nächste Woche und hoffe, Sie sind auch dort wieder dabei.

Herzlichen Dank fürs Zuhören, bis zur nächsten Woche.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen