itl Institut fürtechnische Literatur

Ausgabe 11 12/12

[ i ]m FokusDas Kundenmagazin von itl

Doku-Norm ISO/IEC 82079Die Weltnorm für die Technische Dokumentation

[ i ]m Fokus: News 2

Ausgabe 11 12/12

Grußwort des Vorstands

Sehr geehrte Kunden!

Im August 2012 ist die Doku-Norm ISO/IEC 82079 als Nachfolgerin der „Mutteraller Normen zur Technischen Dokumenta-tion“, der DIN EN 62079, auf Englischund Französisch erschienen.Die ISO/IEC 82079 ist nun weltweit dieeinzig gültige Norm, die die Erstellung vonAnwenderdokumentation regelt und dieRahmenbedingungen definiert. Sie istdamit die wichtigste Norm zur TechnischenDokumentation.

Als Ihr Redaktionspartner sehen wir esauch als unsere Aufgabe, Sie über die Aus-wirkungen der in der neuen Doku-Normfestgelegten Forderungen auf Ihre Techni-sche Dokumentation zu informieren.Erfahren Sie deshalb in dieser Ausgabemehr über die wichtigsten Forderungen derISO/IEC 82079 und lesen Sie eine kritischeStellungnahme von Dieter Gust, LeiterForschung & Entwicklung bei der itl AG.Oder rufen Sie uns bei weiteren Fragen zudiesem Thema einfach an.

Viel Freude beim Lesen wünscht Ihnen Ihre Christine Wallin-Felkner

itl gewinnt den tekom-Dokupreis 201230 Jahre Erfahrung imBereich TechnischeDokumentation wur-den im Jubiläumsjahrvon itl prämiert.Gleich zweimal er-hielt itl den tekom-Dokupreis 2012, mitdem die tekom, Euro-

pas größter Fachverband für TechnischeKommunikation und internationale Infor-mationsentwicklung, besonders gute An-leitungen auszeichnet:Den einen Preis gab es für das Handbuchzum „MRL_DocuGuide.word“ zusam-

men mit unserem Partner SYSTEC, denanderen für die Erstellung der Parkplatz-schranken-Betriebsanleitung der FirmaSOMMER. Diese Auszeichnungen warenmöglich dank einer ausgezeichneten Zu-sammenarbeit einmal mit unserem Part-ner und das andere Mal mit unseremKunden.

Gratis, aber nicht umsonst – Aktuelles zu denitl-AbendveranstaltungenMit dem Vortrag im Oktober Cloud-basier-tes Übersetzungsmanagement in der Praxis.Automatisierte weltweite Übersetzungspro-zesse mit Portaltechnologie hat itl den Pulsder Zeit getroffen.Denn nun kann Schluss sein mit zeitinten-siven Prozessen bei der Auftragsabwick-lung, der unternehmensweiten Terminolo-giebereitstellung und den Reviewläufen.Peter Kreitmeier, Leiter Übersetzung beider itl AG, stellte dazu die itl-Lösungenzur Optimierung dieser Prozesse vor:• [i]-gate: Das Portal für eine standardi-

sierte Auftragsabwicklung.• [i]-match: Die intelligente Autorenun-

terstützung für webbasiertes Termino-logiemanagement.

• [i]-correct: Das Web-Lektoratsportalfür effiziente Lektoratsprozesse.

Im November und Dezember geht es ge-nauso spannend weiter. In dem VortragUsability in der Technischen Dokumentation.„Eins für alle“ oder mediengerechtes Informa-tionsdesign? zeigt Beatrix Buck, Techni-sche Redakteurin bei der itl AG, die we-sentlichen Unterschiede bei derGestaltung von Print- und Onlinedoku-mentation auf und stellt sich der Heraus-forderung einer mediengerechten Gestal-tung von Technischer Dokumentation imZeitalter von Smartphones und Tablet-PCs.Möchten auch Sie sich dieser Herausfor-derung stellen? Dann melden Sie sich zudieser kostenlosen Abendveranstaltungan! Mehr Informationen finden Sie unter:www.itl.eu/de/termine/abendveranstal-tungen.html

[i]-match-Anwendertag 2012 – Ein RückblickAm 20. September veranstaltete itl denersten [i]-match-Anwendertag im Herzenvon München. Diese Tagung bot reichlichInformationen, Beratung und interessanteGespräche rund um die Autorenunter-stützung und Terminologielösung[i]-match. Unsere Partner gds AG, FischerComputertechnik GmbH, CCS SOLU-TIONS GmbH, Expert CommunicationSystems GmbH, SYSTEC und SCHEMAGmbH präsentierten dort ihre Ansätze fürdie Integration von [i]-match in beste-hende Unternehmenssysteme. Außerdem

konnten die Teilnehmer jeweils aus dreiVorträgen den für sie interessantestenauswählen. Bei Kaffee und Snacks fand imAnschluss ein fachlicher Dialog statt, be-vor sich Ulrich Schmidt, Leiter Produktebei der itl Technologiezentrum GmbH,und Martin Wunderlich, Team-LeiterSoftwareentwicklung bei der itl AG, allennoch offenen Fragen stellten. Die ange-nehme Atmosphäre und der anregendeAustausch mit Kollegen aus der Branchemachten den [i]-match-Anwendertag zueinem besonderen Ereignis.

[ i ]m Fokus: Titelthema 3

Ausgabe 11 12/12

Doku-Norm ISO/IEC 82079: Die Weltnorm für die Technische DokumentationBislang war die DIN EN 62079 eine der wichtigsten Normen für die Technische Dokumentation. Im August 2012 wurde die Nachfolgenorm ISO/IEC 82079 herausgegeben, der durch Einbeziehung der ISO noch mehr Gewicht verliehen wird. Allerdings ist die ISO/IEC 82079 in manchen Aspekten zu sehr eine „vorsichtige“ Fortsetzung der DIN EN 62079.

Schon lange wirdTechnische Doku-mentation als „in-tegrierter Bestand-teil“ des techni-schen Produktsangesehen, das inder Dokumenta-

tion behandelt wird. Die Globalisierungder Märkte erfordert zunehmend sowohlnationale als auch internationale Maß-stäbe zur Beurteilung von Produktmerk-malen hinsichtlich bestimmter formalerAusprägungen und qualitativer Eigen-schaften. Dabei wird auch der Ruf nachNormen für die Gestaltung und Bewer-tung von Technischer Dokumentation im-mer lauter.

Schaut man sich Normen im Umfeld derProduktdokumentation an, so fällt auf,dass diese zum Teil schon lange existie-ren. Der Dokumentationsprofi stellt je-doch fest, dass die Normen kaum inhaltli-che, sondern vor allem organisatorischeGesichtspunkte thematisieren.

Die bisherige DIN EN 62079 (Erstellenvon Anleitungen – Gliederung, Inhalt undDarstellung) war der erste Versuch, ver-schiedene „Ur-Normen“ in einer Normzusammenzuführen. Da ihr Entstehen bisin die 90er Jahre des letzten Jahrhundertszurückreicht, ist eine Überarbeitung drin-gend erforderlich gewesen.

ISO/IEC 82079 als Nachfolge-norm von DIN EN 62079

Über die Weltnormungsorganisation ISOist nun die Nachfolgenorm 82079 entstan-den. Diese Norm war auch auf der tekom-Jahrestagung 2012 Gesprächsthema Num-mer eins und das gut besuchte „82079 Fo-rum“ der tekom-Tagung hat das große In-teresse an der Norm zusätzlich bestätigt.Natürlich stellt sich nun jeder Dokumen-tationsverantwortliche die Frage, ob die

neue Norm etwas normiert, von dem ernoch nichts weiß.

ISO/IEC 82079 als Weltnorm

Die Beurteilung der Norm fällt naturge-mäß unterschiedlich aus, je nachdem obman sie als Dokumentationsexperte be-trachtet oder als Praktiker, der dringendnach einer Weltnorm sucht, um Diskussi-onen über die Dokumentationsgestaltungzu minimieren. So zeigt die Norm in man-chen Punkten ausgefeilte Regeln bis insDetail, etwa bei der Frage nach der Wahlvon Schriftgrößen, der 3-fach Gliederungder Warnhinweise und vielen weiterenEinzelheiten. Auch die konkrete Forde-rung nach Expertenfähigkeiten für die Er-stellung und Übersetzung der Dokumen-tation macht deutlich, dass die ISO/IEC82079 Technische Dokumentation nichtals nebensächliches Zufallsprodukt be-trachtet. Als Weltnorm für Technische Do-kumentation wird es selbstverständlichwerden, dass jeder Dokumentationsver-antwortliche sie genau kennt.

ISO/IEC 82079 als „vorsichtige“ Fortsetzung von DIN EN 62079

Im Gesamtkonzept bietet die Norm demDokumentationsexperten jedoch keinerleiÜberraschungen. Dafür ist sie viel zu sehreine „vorsichtige“ Fortsetzung der 62079und normiert weitgehend nur, was so-wieso selbstverständlich erscheint.Leider reflektiert die Norm noch nicht densich nun abzeichnenden Paradigmen-wechsel, wonach Papier nur noch„2. Wahl“ werden wird.Auch die folgende in der Norm verwen-dete Formulierung ist sehr fragwürdig:„In den meisten Fällen, wie z. B. bei Ver-braucherprodukten, ist eine gedruckteVersion der Anleitung notwendig. Eineausschließliche Auslieferung der Anlei-tung in elektronischer Form ist in vielenFällen, wie zur Einhaltung gesetzlicher

Anforderungen, nicht erlaubt.“Damit stellt die Norm die Sichtweise desletzten Jahrhunderts dar. Die mobilen Me-dien werden als Massenprodukte für je-dermann gedruckte Anleitungen weitge-hend überflüssig machen und es werdendie Anwender selbst sein, die die Online-Anleitung auf dem Smartphone fordern,sobald sie wissen, welche enormen Vor-teile das Online-Medium bietet.

Im Detail sind auch einige Formulierun-gen und Ausgestaltungen der Normweit hinter dem geblieben, was hätte he-rauskommen müssen, wenn die Normdie eigenen dokumentierten Regeln aufsich selbst angewandt hätte. Dann wärenbeispielsweise die zum Teil unmöglichenSatzungetüme und sonderbaren Formu-lierungsvarianten, wie etwa die seltsamanmutenden „Du-Formulierungen“, si-cher nicht enthalten.

Auch die Verbreitung als personenge-bundene Norm – nicht einmal Arbeits-kopien zur Verwendung innerhalb einesUnternehmens sind offiziell erlaubt –und die Beschränkung des Online-PDFsauf einzelne Geräte, all das sind völligpraxisferne Forderungen, die die eigent-lich wichtige und gute Idee von Normenregelrecht konterkarieren.

Insgesamt sind die erfolgte Veröffentli-chung der ISO/IEC 82079 auf Englischund die viel zu späte Veröffentlichungals deutsche DIN-Norm voraussichtlichim Juni 2013 dennoch wichtige Ereig-nisse, die dazu beitragen werden, die be-deutende Rolle von Technischer Doku-mentation als Produktbestandteil zustärken. Aber die Norm formuliert es be-reits selbst: Eine Reduktion der Norm-überprüfung auf die alleinige Anwen-dung der Norm als Checkliste amSchreibtisch durch den Dokumentati-onsersteller selbst ist nicht erlaubt (vgl.Anhang A der ISO/IEC 82079).

[ i ]m Fokus: Titelthema 4

Ausgabe 11 12/12

Anhang B und C umfassen folgende Checklisten zur Überprüfung einer Dokumentation mit den Zielsetzungen der Norm:

• Checkliste zur Effektivität der Kommunikation (Verständlichkeit und Gestaltung)

• Checkliste für Konformität (inhaltliche Abdeckung)Die wichtigsten operationalisierten Forderungen in der Norm 82079 sind in beiden Checklisten detailliert dargestellt. Das betrifft ins-besondere die inhaltlichen Mindestangaben, bei denen zu prüfen ist, ob diese mit der Maschinenrichtlinie „harmonisiert“ sind. Die folgende Tabelle spiegelt die wichtigsten Neuerungen und Grundüberlegungen der ISO/IEC 82079 wider:

Merkmal Operationalisierung (Konkretisierung,ggf. Umsetzung in messbare Kriterien)

Bemerkung von Dieter Gust, itl AG

Qualifikation der Dokumentersteller „Verantwortlichkeit von erfahrenenSchreibern oder Spezialisten“ mit fort-geschrittenen „Kommunikationskom-petenzen, speziell in der technischenKommunikation“

Betonung liegt auf Experten in der tech-nischen Kommunikation

Forderung nach Ausarbeitung einerGestaltungsrichtlinie (Styleguide)

Qualifikation der Übersetzer Fachübersetzer oder Spezialisten für dieÜbersetzung, „vorzugsweise Mutter-sprachler in der Zielsprache“

Anleitungen müssen von anderen Per-sonen Korrektur gelesen werden alsvom Autor oder Übersetzer, „vorzugs-weise von einem Muttersprachler, derKenntnisse über das in Frage kom-mende Produkt hat“

Zielgruppenorientierung Explizite Forderung nach Berücksichti-gung der Bedürfnisse von Zielgruppen

Wenn in einem Dokument unterschied-liche Zielgruppen angesprochen wer-den, müssen die Texte für die jeweiligeZielgruppe entsprechend gekennzeich-net sein

Darstellungskonventionen Explizite Erläuterung der Darstellungs-konventionen

Terminologie, Satzbau, Formulierungen Konsistent, so einfach und so kurz wiemöglichKeine Mischung mit Werbebotschaften

Schriftgröße Umfassende tabellarische Darstellungfür besondere Situationen

Grundregel für Handbücher:

• Fließtext 10 Punkt

• Überschriften 12 Punkt

Grundregel für Faltblätter:

• Fließtext 9 Punkt

• Überschriften 10 Punkt

Minimal erlaubte Größen:

• Fließtext 6 Punkt

• Überschriften 8 Punkt

Kleinere Schriftgröße als 10 Punkt inSonderfällen erlaubt

Größer gedruckte Version muss auf An-frage kostenlos geliefert werden

[ i ]m Fokus: Titelthema 5

Ausgabe 11 12/12

Zeilenabstand Mindestens 120 % der Schriftgröße

Zeilenlänge Ca. 70 Zeichen pro Zeile Erfordert Änderungen für viele Hand-buchlayouts

Seitennummerierung Vorzugsweise „n“ von „m“Beispiel: Seite 3 von 158

n ist die aktuelle Seitenzahl; m ist dieGesamtzahl der Seiten im Dokument

Inhaltsverzeichnis Gefordert bei Dokumenten mit mehr als4 Seiten

Stichwortverzeichnis (Index) Für „lange und komplexe Anleitungen“ Unglückliche, unklare Formulierung

Funktionales Design für Textelemente Formulierungen sollten der Strukturentsprechen, welche die verschiedenenTextfunktionen unterstützt

ISO/IEC 82079 gibt keine Hinweise zufunktionalem Design, sondern benenntlediglich mögliche unterschiedlicheTextelemente mit jeweils möglichem ei-genen Strukturierungsmuster

Überschriften Vorzugsweise kurz und nummeriert

Abbildungen Abbildungen mit nummerierten Bild-unterschriften versehen

Warn-/Sicherheitshinweise Eigener Abschnitt am Anfang der Anlei-tung

Signalwörter gemäßISO 3864-2: Gefahr, Warnung,Vorsicht

Warnsymbol sollte zusätzlich verwen-det werden

ISO/IEC 82079 nimmt keinen Bezug aufANSI Z535. Allerdings ist ANSI nach ei-genem Verständnis mit ISO 3864 harmo-nisiert. Die folgenden ANSI-Symbolesollten daher alternativ genutzt werdenkönnen:

Keine Erklärung zur Gestaltung vonHinweisen bei Sachschäden

Elektronische Auslieferung(Online-Dokumentation)

Rein elektronische Auslieferung vonAnleitungen muss am Verkaufsort oderauf der Verpackung angegeben werden

Anforderungen der Norm ISO 9241müssen erfüllt sein

Forderung nach gedruckter Anleitung„in den meisten Fällen“ ist eine sehr ver-unglückte, unklare Formulierung

Struktur der Anleitungen Anleitungen, die übermäßig lang oderkompliziert sind, müssen eindeutig ingeeignete Teile unterteilt werden.Hierzu wird eine „einheitliche Struktur-methode“ gefordert

Die Norm fordert, dass die Strukturie-rung funktional sein soll, erklärt jedochnicht, was „funktional“ ist. Dabei hilftauch der Hinweis „zuerst Grundfunkti-onen“, „andere Funktionen später“nicht

Merkmal Operationalisierung (Konkretisierung,ggf. Umsetzung in messbare Kriterien)

Bemerkung von Dieter Gust, itl AG

Tabelle:Merkmal, Operationalisierung und Bemerkung – Eine kritische Analyse der wichtigsten Neuerungen der ISO/IEC 82079 von Dieter Gust, Leiter F&E bei der itl AG

[ i ]m Fokus: Einblick & Ausblick 6

Ausgabe 11 12/12

Berichte aus den Niederlassungen

itl ist 30 mit über 100 Mitarbeitern aus 20 Nationen

Kurz nach dem 30-jährigen Firmenjubi-läum im August baute itl im Septemberseine Präsenz in Österreich aus und grün-dete eine neue Niederlassung in Linz. Wirfreuen uns, alle neuen Mitarbeiter in Linz

und in den weiteren Niederlassungen be-grüßen zu dürfen. itl beschäftigt derzeitinsgesamt 104 festangestellte Mitarbeiteraus 20 Nationen an 6 Standorten inDeutschland, Österreich und der Schweizund ca. 2300 freie Mitarbeiter aus der gan-zen Welt. Diese Zahlen spiegeln das ste-tige und kontinuierliche Wachstum von itlwider. In den letzten 5 Jahren hat sich dieMitarbeiterzahl der itl AG sogar mehr alsverdoppelt.

itl-Termine

Gratis, aber nicht umsonst: die itl-Abendveranstaltungen

05.12.12 München: Usability in der Technischen Dokumentation. „Eins für alle“ oder mediengerechtes Informationsdesign?

Wer braucht schon mediengerechte Usability in der Technischen Dokumentation?Was gedruckt wird, kann auch ins Web! – Ist das wirklich so einfach?Wir zeigen Ihnen auf, mit welchen Herausforderungen die Technische Redaktion beider Gestaltung von Onlinedokumentation konfrontiert ist.

Anmeldung München: http://www.itl.eu/de/termine/abendveranstaltungen/abend-veranstaltung-am-05-12-12-in-muenchen/anmeldung-per-webformular.html

18.03.13 St. Margarethen an der Raab (A), 19.03.13 Wien (A): Technische Dokumentation auf mobilen Medien – alles Apps oder was?

Mehr Infos und Anmeldung St. Margarethen an der Raab (A): http://www.itl-gmbh.at/abendveranstaltungen/am-18-03-2013-in-stmargarethen.html

Mehr Infos und Anmeldung Wien (A): http://www.itl-gmbh.at/abendveranstaltun-gen/am-19-03-2013-in-wien.html

Im nächsten Jahr finden außerdem weitere itl-Abendveranstaltungen zum Thema Doku-Norm ISO/IEC 82079 statt: 27.02.13 München,28.02.13 Hamburg, 05.03.13 Stuttgart, 07.03.13 Winterthur (CH)

Seminare der itl-Akademie

Mit unseren Seminaren vermitteln wir sowohl Neulingen als auch Fortgeschrittenenunerlässliches Wissen für die Dokumentationspraxis.

Mehr Infos unter www.itl.eu/de/termine/seminare-tagungen.html und www.itl-gmbh.at/seminare.html

Webinare

13.12.12: Autorenunterstützung, Terminologielösung [i]-match

Lernen Sie die Autorenunterstützung und Terminologielösung [i]-match live kennen.

Mehr Infos unter http://www.itl.eu/de/termine/webinare.html

Wussten Sie schon …… dass itl am 17. August 1982 in Münchengegründet wurde und an diesem Tag inHannover gleichzeitig die ersten kom-merziellen Audio-CDs vom Band liefen?Somit haben itl und die glänzenden Schei-ben dieses Jahr am gleichen Tag ihren30. Geburtstag gefeiert.

… dass itl Kunden nach ihrer Einstellungzu Apps befragte und der Vergleich zwi-schen Anleitungen auf Papier und als Appüberraschenderweise mehr als eindeutigzugunsten der App ausfiel? Auch wenn inBezug auf die Haltbarkeit noch einige fürdas Papier stimmten, glauben mehr alsdoppelt so viele aller an der Umfrage Be-teiligten, dass auch in dieser Hinsicht dieApp klare Vorteile auszuspielen vermag.

itl – Ihr Full-Service-Dienstleister

Übersetzung

Technische Dokumentation

Service Engineering

Produkt- & Prozesslösungen

Schulung & Beratung

ImpressumHerausgeber

itl, Elsenheimerstraße 65, 80687 Münchenwww.itl.eu, info@itl.eu

Standorte

itl AG (Zentrale Deutschland)Elsenheimerstr. 65, D-80687 München+49 89 89 26 23-0

itl GmbH ÖsterreichLerchenfelder Gürtel 43, A-1160 Wien+43 1 4 02 05 23-0 www.itl-gmbh.at

itl GmbH (Niederlassung Linz)Ziegelweg 1, A-4481 Asten+43 7224 65729-0

itl AG SchweizHafenstrasse 50 B, CH-8280 Kreuzlingen+41 71 6 77 80 50 www.itl.ch

itl AG StuttgartSilberburgstraße 126, D-70176 Stuttgart+49 89 89 26 23-425

itl Technologiezentrum GmbHHubertstraße 24, D-03044 Cottbus+49 355 2 88 95 90

Nachdruck, auch auszugsweise, nur mit Genehmigung des Herausgebers. Copy-right 2012. Alle Rechte vorbehalten.