Blog

Eine Tasse auf Reisen #5 - die Auflösung

In welchem Land wurde die parson-Tasse fotografiert, haben wir Anfang Dezember gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: Kuba. mehr ...

RDF is not XML – RDF serialization and iiRDS metadata

The world of technical writing loves XML. Its document type definitions are the foundation of structured authoring. XML and the underlying schemas structure the content of our information products. The benefits are twofold. Content is consistently structured and easy to read. Authors have an easier time writing the content. The structure provides guidelines for authoring. mehr ...

Gewinnspiel: Eine Tasse auf Reisen #5

Brrr…in Hamburg ist der Winter eingekehrt und Weihnachten steht vor der Tür. Die parson-Tasse lässt sich währenddessen die Sonne auf den roten Bauch scheinen. mehr ...

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. mehr ...

tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung. mehr ...

Bericht vom Doku+Medien-Forum 2017

Zum 20. Mal fand am 23. Februar das Doku+Medien-Forum in Hamburg statt, ein Jubiläum also. Drei Teilnehmerinnen von parson berichten.

DMF2017Ulrike Parson, CEO

Zum Jubiläum haben wir ein neues Konzept ausprobiert: zwölf Vorträge statt acht, sodass wir mehr Themen unterbringen konnten. Das brachte eine tolle Vielfalt, wenn auch etwas Stress bei einigen Vorträgen. Weil im Anschluss gleich der nächste Vortrag stattfand, blieb keine Luft nach hinten zum Diskutieren.

Verantwortung im Redaktionsprozess. Was kann die Technische Redaktion für eine verbesserte Zusammenarbeit mit der Entwicklungsabteilung tun? Isabelle Fleury. Fleury & Fleury Consultants

Mir hat der Vortrag von Frau Fleury sehr gut gefallen – sie hat einen wunderbar kompakten Überblick über die Grundlagen des Projektmanagements für Technische Redakteure gegeben. Das ist gerade für uns als Dienstleister immer wieder wichtig. Wir müssen noch klarer als angestellte Redakteure die Aufgaben, Rollen, Verantwortlichkeiten und Kompetenzen mit dem Kunden kommunizieren, damit die Erwartungen auf beiden Seiten klar sind. Auch die Risikoanalyse, nicht die zum Produkt, sondern zum Projekt selbst, ist für uns sehr wichtig: Was passiert, wenn kein Input kommt und der vertraglich vereinbarte Liefertermin dadurch in Gefahr gerät? Oder wie decken wir einen hohen Krankenstand ab? Aus dem Vortrag konnte ich viele gute Handlungsempfehlungen mitnehmen, die unseren Stand im Unternehmen oder beim Kunden verbessern und Überraschungen im Projektverlauf vermeiden.

Esther Strauch, Technical Communicator

Warnhinweise: normenkonform oder verständlich? Mit der richtigen Anwendung von Normen wirksam warnen. Karsten Voß, ZINDEL AG

Der Vortrag begann mit einer Diskussion über die Definition von Sicherheit. Herr Voß sieht diese als Freiheit von Gefährdungen. Ein Zuhörer verwies auf die Definition „Abwesenheit von unzumutbaren Risiken“. Sicherheit als Freiheit von Gefährdungen heißt, dass für einen Warnhinweis die Gefahrenquelle definiert werden muss.

Das Thema Sicherheit wird u.a. von der Maschinenrichtlinie, der Niederspannungsrichtlinie oder DIN EN 82079-1 aufgegriffen. Als wichtigsten Punkt nennen alle die körperliche Unversehrtheit und Gesundheit von Personen.

Die Benutzerinformation ist also eine Schutzmaßnahme. Sie dient nicht der rechtlichen Absicherung, sondern soll das Leben und die Gesundheit von Personen schützen. Eine Haftungsbeschränkung in der Anleitung entlässt ein Unternehmen nicht aus der Haftung, wenn ein Produkt nicht funktioniert und ein Anwender sich verletzt.

Herr Voß stellte den 3-Stufen-Verlauf zur Risikominderung vor (DIN EN ISO 12100):

1. Zuerst inhärent sichere Konstruktion

2. Für durch 1. noch nicht abgedeckte Risiken technische und/oder ergänzende Schutzmaßnahmen

3. Benutzerinformation – die aber kein Ersatz für 1. und 2. sein darf!

Herr Voß stellte die wichtigsten Normen in Bezug auf Warn- und Sicherheitshinweise vor, die unterschiedliche Perspektiven auf Sicherheitsinformationen einnehmen:

  • IE IEC 82079-1:2012/DIN EN 82079-1:2013-06 zur Erstellung von Gebrauchsanleitungen
  • ANSI Z535.6-2011 zu “Product safety information in product manuals, instructions, and other collateral materials”

Auch erläuterte er Inhalt und Zweck von Warnhinweisen, Sicherheitshinweisen und “safety messages”. Warnhinweise sollen z. B. in dem Kontext auftauchen, in dem eine Gefährdung bereits vermieden werden kann, und nicht erst dann, wenn sie entsteht.

Die Schnittstelle zwischen Risikobeurteilung und funktionaler Sicherheit. Zusammenarbeit zwischen mechanischer und steuerungstechnischer Konstruktion optimieren. Matthias Schulz. Axelent GmbH; tekom-Forum Richtlinien und Normen

Herr Schulz war sich des Charmes seines trockenen Themas bewusst und gab uns zu Beginn des Vortrags scherzhaft die Gelegenheit, noch schnell zum Konkurrenzvortrag von Herrn Schiller zu wechseln. Und dann hat er das Thema unterhaltsam und mit Humor präsentiert, Beispiele aus seiner Praxis eingebunden und sich nicht in Rechtstexten und Normen verloren.

Sicherheit war auch hier der Einstieg. Die Präambeln der Maschinenrichtlinie 2006/42/EG weisen darauf hin, dass die Sicherheit von Maschinen systematisch und schon während der Konstruktion sichergestellt werden soll. Das wirft natürlich die Frage nach dem „Wie“ auf.

Das Verständnis von Sicherheit als Abwesenheit unzumutbaren Risikos führt uns zur Risikobeurteilung. Diese soll nicht erstellt werden, um der Bürokratie Genüge zu tun und ein „Papier“ zu haben. Vielmehr geht es darum, alle Risiken zu erkennen, die sich aus der Nutzung des Produkts ergeben können.

Die Risikobeurteilung ist eine Methode zur sicheren Entwicklung von Produkten. Viele Risikobeurteilungen in der Praxis sind Dokumentationen bereits gemachter Fehler. Die Risikobeurteilung dient aber der Risikominderung, d. h. sie sollte vorher geschehen, nicht erst am fertigen Produkt.

Sinnvoll ist eine aufgabenbezogene Risikobeurteilung, d. h. nicht nur die laut EN ISO 12100 Kap. 5.4 geforderte Gefährdungsliste abhaken oder abarbeiten, sondern Gefährdungssituationen erkennen. Dafür ist eine Strukturierung nach Lebensphasen des Produkts hilfreich (z. B. Transport, Aufstellen, Inbetriebnahme, Betrieb).

Die Aufgaben sollte man anhand der Lebensphasen festlegen. Das stellt den Menschen in Verbindung zur Gefährdungsquelle (Formel „Gefährdung + Mensch = Risiko“). So finden wir heraus, wo wir auf die Risiken hinweisen müssen.

Bei der aufgabenbezogenen Risikobeurteilung helfen Formulare. Dabei müssen wir beachten, dass der Technische Redakteur mehr Informationen aus der Risikobeurteilung benötigt als den „Warnhinweis“, nämlich die Beschreibung der Gefährdungssituation und der notwendigen Schutzmaßnahmen. Eine klare Beschreibung der Gefährdungssituation und Details machen die Risikoeinschätzung nachvollziehbar.

Sabine Stoye, Technical Communicator

Der Weg ist das Ziel! Intelligente Navigationskonzepte für die digitale Dokumentation. Wie man durch Navigation einen Mehrwert schafft. Veronika Eisele. FCT AG

Die Referentin, selbst UX-Designerin, machte deutlich, weshalb es so wichtig ist, dass sich die Technische Redaktion mit intelligenten Navigationskonzepten beschäftigt: Laut einer Statistik ist eine App zwölf Monate nach dem Herunterladen nur noch bei 4% der Nutzer aktiv bzw. installiert. Die Gründe liegen zum Großteil in der Usability der App, z.B. ihrer Navigierbarkeit und Handhabbarkeit.

Veronika Eisele führte in das Thema mit Grundlagen über Usability und mobile Navigation ein: Ein PDF auf einem Smartphone "macht nur wenig Spaß". Für diese Art Gerät sind andere Navigationsmethoden und Mittel sinnvoll.

Smartphone-Nutzer haben besondere Anforderungen und Erwartungen. Sie lesen Texte oft nur in Bruchstücken, bevorzugen Grafiken und wollen schnell relevante Informationen abrufen können. Sie interagieren mit Touch-Gesten, verwenden Kamera und GPS und beteiligen sich sogar an der Zusammenstellung von Informationen. All das müssen die UX-Designer und die Doku-Abteilung, die die Inhalte zur Verfügung stellt, beachten.

Und damit bricht Frau Eisele eine Lanze für modulare Inhalte - das ist Wasser auf unsere Mühlen hinsichtlich DITA und Wiederverwendung.

Was zeichnet gute Navigation aus?

Auf den ersten Blick sollte der Nutzer folgendes erkennen: (1) Wo bin ich? (2) Wie geht es weiter? (3) Wohin kann ich von hier aus gehen? Daraus leiten sich Gestaltungshinweise ab: Simplizität, logisch verknüpfte Navigationselemente, Suche und Filtermöglichkeiten.

Veronika Eisele zeigte uns Beispiele für solche Navigationselemente: das Hamburger-Menu, das Tab-Menu, eine Kombination aus beiden Ansätzen (Tab-Hybrid) und die Möglichkeit, über Gesten zu navigieren. Und sie stellte Sucharten und Inhaltsfilterung für mobile Anwendungen vor.

Wichtig ist auch, wie die Nutzer in die Navigation einsteigen. Dafür haben sie verschiedene Möglichkeiten: Scannen eines QR-Codes und damit Ansteuern einer Landing Page, Eingabe von z.B. Fehlercodes für Wartungsaufgaben an Maschinen, Icon zum Starten der App. Auch dieser Beitrag unterstrich die wachsende Bedeutung, Inhalte modular und mit Metadaten angereichert aufzubauen, um sie unterschiedlichen Nutzern und deren Anforderungen passend zur Verfügung stellen zu können.

Suchen doof finden. Informationen muss man finden können. Lars Schiller. ZINDEL AG

Herr Schiller identifizierte zunächst die unterschiedlichen Sucharten:

  • Sockensuche (übertragen auf Technische Doku: Suche nach einer unbekannten Information in einer bekannten und vorliegenden Anleitung)
  • Pflastersuche (Suche nach einer erwarteten Information in einer unbekannten, aber vorliegenden Anleitung)
  • Schraubensuche (Suche nach einer erhofften Information in unbekannten und nicht vorliegenden Anleitungen)

Er stellte auch mögliche Suchhilfen innerhalb von Technischer Dokumentation vor und betonte die Bedeutung von Terminologiearbeit und eines qualitativ hochwertigen Index.

Dann referierte Herr Schiller über unterschiedliche Arten von Suchen, die der Nutzer benötigt, um Information zu finden. Er unterschied zwischen Suchhilfen in Print-Anleitungen (Inhaltsverzeichnis, Index, Glossar, Deskriptoren, Anwendungsfallverzeichnis, Register) und solchen in mobiler Dokumentation: Volltextsuche, facettierte Suche (Kombination verschiedener Kategorien in einer Suchanfrage), unscharfe Suche (über Synonyme), elastische Suche (fehlertolerant bei abweichend geschriebener Sucheingabe) und semantische Suche.

Die von ihm vorgestellten Suchhilfen und -funktionen lassen sich auch mit Metadaten und semantischer Modellierung bzw. Auszeichnung von Inhalten unterstützen. Deshalb ist für mich persönlich der Einsatz von Ontologien, Taxonomien und das Auszeichnen von Text mit Metadaten ein wesentliches Merkmal von moderner Dokumentation.

Kommentar schreiben


  • facebook
  • linkedin
  • xing