In Zukunft noch bessere technische Dokumentationen schreiben

Technische Dokumentation ist die schriftliche Kommunikation mit dem ein Unternehmen seine Produkte beschreibt und die zwischen einem Unternehmen und dessen Interessenten, meist die Endverbraucher, stattfindet. Gebrauchsanweisungen, Bedienungsanleitungen, Handbücher und Datenblätter sind typische Beispiele für technische Dokumentation, und jedes einzelne dieser Kommunikationswerkzeuge hat seine ganz eigenen Merkmale. Häufig erstellen Unternehmen
jedoch Gebrauchsanweisungen, die die Funktionsweise eines Produkts beschreiben anstatt dem Leser zu erklären, wie er das Produkt anwenden soll.

Gute Dokumentation trägt zur Zufriedenheit der Kunden bei und vermittelt einen guten
Eindruck vom Hersteller als professioneller Lieferant. Schlechte Dokumentation, die vom Leser missverstanden werden kann, kann dazu führen, dass dem Produkt und dem Unternehmen ein anderes vorgezogen wird, und im schlimmsten Fall kann sie zu einem Rechtsstreit führen.
Berücksichtigen Sie diese vier Themen bei der Ausarbeitung Ihrer technischen Dokumentation, damit Sie keine bösen Überraschungen erleben:

 

DTP ist die Abkürzung für Desk Top Publishing, also dem Setzen und Publizieren von
Dokumenten vom Schreibtisch (englisch: desktop) aus, d.h. heutzutage vom Desktop-Computer.

Textverarbeitungsprogramme haben keine Probleme mit Fließtexten, kommen aber mit der
Positionierung von Bildern nicht besonders gut zurecht. Bildbearbeitungsprogramme dagegen handhaben die Positionierung von Bildern problemlos, haben aber häufig Schwierigkeiten mit der Bearbeitung von Texten in und um Bilder herum.
Verwenden Sie das richtige DTP-Programm für Ihre Dokumentationsarbeiten. So sparen Sie
eine Menge Zeit und vermeiden Frustrationen.

Sowohl Adobe FrameMaker als auch InDesign arbeiten mit sogenannten „Büchern“. Das heißt, dass ein Dokument aus kleineren, eigenständigen Kapiteln besteht, die dann schließlich in
einem Buch zusammengefasst werden.

Das vereinfacht z. B. Aktualisierungen, da man die einzelnen Kapitel aktualisieren kann ohne das gesamte Buch aktualisieren zu müssen.

 

Allgemeine Aufgaben:

Für kurze und einfachere Aufgaben empfiehlt sich ein StandardTextverarbeitungsprogramm wie zum Beispiel Microsoft Word. Textverarbeitungsprogramme können auch zum Erstellen von technischer Dokumentation verwendet werden. Voraussetzung ist allerdings, dass der
Anwender die Möglichkeiten des Programms genau kennt. Wenn Sie eine große Menge an
Dokumentation haben oder regelmässige Aktualisierungen benötigen, dann empfiehlt sich ein „richtiges“ DTP-Programm, wie z. B. Adobe InDesign oder Adobe FrameMaker.

Kleinere/Mittlere Aufgaben:

Adobe InDesign ist ein speziell für DTP entwickeltes Programm, das besonders für Dokumente mit vielen grafischen Elementen, wie zum Beispiel Verkaufsbroschüren, Marketingmaterialien, Quick Guides usw., geeignet ist.

Mittlere/Große Aufgaben:

Das DTP-Programm Adobe FrameMaker zeichnet sich besonders durch die problemlose
Handhabung großer Mengen an Texten und Illustrationen aus.

Andere Programme, wie z. B. CorelDraw, Microsoft Publisher oder CAD-Zeichenprogramme,
sind mit Vorsicht zu genießen, wenn es um Dokumentationsarbeit geht. Wenn Ihre
Dokumentation mit einem dieser Programme erstellt wurde, können Aktualisierungen
zusätzliche Kosten verursachen. Außerdem haben einige Übersetzungsprogramme Probleme mit diesen Programmen.

Die 80-zu-20-Regel, auch Pareto-Prinzip genannt, kann als persönliches Werkzeug, aber auch als Werkzeug in Unternehmen genutzt werden. Die 80-zu-20-Regel besagt, dass der kleinste Teil
aller Ursachen, Maßnahmen und Aktivitäten zum größten Teil aller Ergebnisse führt.

Mit anderen Worten stammen 80 % Ihrer Arbeitsergebnisse aus 20 % Ihrer Arbeitszeit*.

Mit der 80-zu-20-Regel lässt sich auch sehr einfach beschreiben, wie typische
Dokumentationsprojekte ablaufen. Über den Daumen gepeilt werden in Dokumentations-projekten 80 % der Zeit für die Planung benötigt. Nur in etwa 20 % der Zeit wird die eigentliche Dokumentation erstellt. Die Planung ist das Fundament für das gesamte Projekt.
Dies ist äußerst wichtig, aber leider nicht so sichtbar und messbar wie die Arbeit des Erstellens.

 

Informationssuche:

• Wählen Sie Ihre Informationsquellen sorgfältig aus. Fragen Sie Kunden, Experten,
  Entwickler etc.
• Erstellen Sie eine Checkliste über die Informationen, die Sie benötigen.
• Sorgen Sie dafür, die Informationen rechtzeitig zu erhalten.

Zielgruppe:

• Überprüfen Sie, wer die Dokumentation erhalten soll. Ihre Dokumentation soll die
  Zielgruppe auf Augenhöhe ansprechen.
• Erstellen Sie evtl. einen “Style Guide” – eine Sammlung von Richtilinien für das Verfassen und das Design der Unternehmensdokumentation..

Layout:

• Machen Sie die Anwendung Ihrer Dokumentation einfach, u. a. mit einem übersichtlichen Seitenlayout und einem guten Inhaltsverzeichnis.
• Sorgen Sie dafür, dass Ihr Dokument dieselbe Qualität wie die sonstige Dokumentation des Unternehmens aufweist.
• Verwenden Sie ggf. Illustrationen zur Verdeutlichung der Anweisungen.

Sprache:

• Denken Sie daran, dass Sie eine Anleitung schreiben – und keine Briefe oder Erzählungen.
• Vermeiden Sie Umgangssprache und Insider- Ausdrücke.
• Verwenden Sie für dieselben Dinge im gesamten Dokument immer dieselbe Bezeichnung.

Was kostet schlechte Dokumentation?

Die meisten von uns wissen, wie schwer es sein kann, die Anleitung eines Produkts zu verstehen. Die Freude über ein neues und interessantes Produkt wird vollkommen von den Problemen überschattet, die man dabei hat, es zum Laufen zu bringen. Einige geben auf. Andere probieren es einfach aus. Die Beharrlichen wenden sich an das Geschäft oder das Unternehmen, wo sie das Produkt gekauft haben. Doch auf jeden Fall haben derartige Probleme einen negativen
Einfluss auf den Ruf des Produkts. Schlechte Produkte empfiehlt man Freunden und Bekannten nicht. Ein schlechter Ruf färbt auf den Hersteller ab. In einer globalen Welt, in der viele
Unternehmen in erheblichem Umfang exportieren, können die Folgen katastrophal sein.
In letzter Konsequenz kann dies zum Tod des Unternehmens führen.

ES ZAHLT SICH AUS, IN GUTE DOKUMENTATION ZU INVESTIEREN

Die Ausarbeitung von Dokumentation erfolgt in der Regel auf der Basis eines Regelwerks. In
diesem Artikel liegt der Ausgangspunkt in der Ausarbeitung von Dokumentation gemäß der
Maschinenrichtlinie 2006/42.

Die Maschinenrichtlinie stellt eine Reihe von Anforderungen an die sicherheitstechnische
Einrichtung von Maschinen. Um eine Maschine in der EU und dem EWR in Verkehr bringen zu können, müssen diese Anforderungen an die Maschinensicherheit eingehalten werden. Eine
Maschine darf somit nicht in Verkehr gebracht werden, wenn sie sicherheitstechnisch nicht
korrekt eingerichtet ist.

Neben den Anforderungen an die Sicherheit stellt die Maschinenrichtlinie auch Anforderungen an die mitgelieferte Dokumentation. Die Betriebsanleitung ist immer in der Sprache des Landes auszuliefern, in dem die Maschine zum Einsatz kommt – dies gilt für EU- und EWR-Länder. Es ist eine zwingende Anforderung. Nur die Wartungsanleitung kann in einer anderen Sprache
ausgeliefert werden, aber auch nur dort, wo die Wartungsanleitung vom eigenen Personal des Herstellers verwendet wird.

Es werden auch Anforderungen an den Inhalt der Betriebsanleitung gestellt, die in Anhang 1.7.4.2 der Maschinenrichtlinie wiedergegeben werden. Die Anforderungen an den Inhalt gilt für alle Betriebsanleitungen. Je nach Maschinentyp stellt die Maschinenrichtlinie weitere
Anforderungen. Beispielsweise muss eine Maschine für Nahrungsmittel über eine
Reinigungsanleitung verfügen.

 

 

Die Maschinenrichtlinie ist Gesetz, wenn es um die Einrichtung von Maschinen geht. Als
Anleitungen zur Maschinenrichtlinie werden Normen ausgearbeitet. Man kann diese als
Auslegungen der Maschinenrichtlinie betrachten. Eine Norm kann sowohl einen einzelnen
Sicherheitsaspekt abdecken, wie einen Notausschalter oder Reihenabstände, als auch einen
speziellen Maschinentyp, z. B. eine Kotelettschneidemaschine. Man ist nicht gezwungen,
Normen anzuwenden – auch eigene Lösungen können verwendet werden. Das gesamte
Sicherheitsniveau muss jedoch eingehalten werden. Das bedeutet, dass eigene Lösungen
mindestens so sicher wie die in der Norm genannten sein müssen. Dasselbe gilt für die
Anforderungen an den Inhalt der Dokumentation.

Neben Anforderungen an die sicherheitstechnische Einrichtung der Maschine stellen Normen auch ergänzende Anforderungen an Dokumentation und Betriebsanleitung. Man muss somit
sowohl die grundlegenden Anforderungen aus der Maschinenrichtlinie als auch die
ergänzenden Anforderungen aus den angewandten Normen kennen. Wenn eine Maschine mit einem Seilzug-Notschalter ausgestattet ist, muss die Betriebsanleitung den Benutzer darüber
informieren, dass vor dem Neustart der Maschine der Seilzug-Notschalter in seiner gesamten Länge überprüft werden muss.

Die Aufgabe des Dokumentationsmitarbeiters besteht darin, herauszufinden, welche Richtlinie relevant ist sowie welche Normen evtl. angewandt wurden. Informationen zu Richtlinien und Normen werden in der Regel in der Konstruktionsabteilung eingeholt. Wir empfehlen, bereits in der Konstruktionsphase mit dem Abklären von Richtlinien und Normen zu beginnen.
Das Abklären soll sicherstellen, dass die Maschine korrekt eingerichtet und dokumentiert wird. Es ist immer von Vorteil, eine grundlegende Betriebsanleitung zu haben, die die Anforderungen der Maschinenrichtlinie einhält. Danach besteht die Aufgabe darin, Anforderungen aus den
angewandten Normen einzubauen, sodass die Dokumentation sämtliche relevanten
Anforderungen einhält. Eine gute Betriebsanleitung hält nicht nur die formellen Anforderungen aus Richtlinien und Normen ein. Sie schützt Hersteller auch davor, dass an der Maschine Unfälle passieren.
Autor: World Translations Geschäftspartner Thomas Thillemann Petersen, Abteilungsleiter bei Maskinsikkerhed ApS.

Wer mit technischer Dokumentation arbeitet, weiß, wie wichtig es ist, dass die Dokumentation so benutzerfreundlich wie möglich aufgebaut wird. Doch damit ist es nicht getan.

Ein Dokumentenmanagementsystem muss nicht teuer oder kompliziert sein und viele
Ressourcen benötigen. Häufig reicht eine Excel-Datei aus. Das Wichtigste ist, dass es einen
guten Überblick über die Dokumente des Unternehmens bietet und einfach zu pflegen ist.

Mindestens ebenso wichtig ist es, ein System für das Dokumentenmanagement zu haben.
Das System muss die Dokumentation während der gesamten Lebensdauer des Produkts
verwalten: von dem Zeitpunkt, zu dem das Produkt ausgeliefert wird, während der Zeit, in der das Produkt verwendet wird und Feedback von Kunden und anderen Interessenten eingeht,
bis zu dem Tag, an dem das Produkt nicht mehr in Betrieb ist.

Für Verkäufer und Kunden ist es wichtig, dass: ∙ mit dem Produkt die richtige Dokumentation ausgeliefert wird ∙ die Dokumentation nachverfolgbar ist, sodass immer auf denselben Typ und dieselbe Version verwiesen wird ∙ zur Bearbeitung von Kundenanfragen interne Ressourcen zur Verfügung stehen.

In der technischen Dokumentation kann, ganz gleich wie gut sie ist, nicht alles stehen.
In nachstehender Abbildung ist ein typischer Lebenszyklus für technische Dokumentation
zu sehen:

 

WELCHE VORTEILE HAT OUTSOURCING?

 

Ziemlich viele Unternehmen beginnen eher zufällig mit dem Export, und nur einige
Unternehmen denken bei der Produktentwicklung von Anfang an an den Export. Ehe man mit dem Export beginnt, müssen nämlich viele Dinge bedacht werden. Bei der technischen
Dokumentation ist es wichtig, dass sie dem neuen Markt angepasst ist. Die Sprache muss
geändert werden, vielleicht auch das Layout, oder es muss sogar eine ganz neue Art von
Dokumentation erstellt werden.

Beim Export von Maschinen muss die Dokumentation Vorschriften auf den lokalen Märkten in Europa einhalten, z. B. die Maschinenrichtlinie der EU. Darin ist u. a. beschrieben, welche
Dokumente mitgeliefert werden müssen und in welcher Form sie zu liefern sind. Entsprechende Normen gibt es auch für andere Branchen.

Nachstehend folgen ein paar Beispiele, mit denen Sie Fallgruben in Ihrer technischen
Dokumentation vermeiden können:

 

Beispiel 1)

Ein dänischer Produzent von Salzstreumaschinen empfiehlt in Dänemark den Einsatz von Salz in den Maschinen. In Norwegen, wo der Frost auf den Straßen härter und die Frostperiode länger ist, hat Salz keine Wirkung. Ganz im Gegenteil. Das Salz wird häufig nur die oberste Eisschicht auf der Fahrbahnoberfläche auftauen, wodurch sich Wasser auf den Straßen bildet, welches die Straßen noch glatter macht. Das bedeutet, dass der Text im norwegischen Handbuch angepasst werden muss, damit das richtige Streugut in den Salzstreugeräten verwendet wird – passend zu den norwegischen Gegebenheiten.

 

Beispiel 2)

In Dänemark wird die Farbe Blau mit Frieden, Ruhe, Harmonie, Vertrauen und Selbstvertrauen assoziiert. In anderen Ländern ist das anders. In Kolumbien wird diese Farbe mit Seife assoziiert. Im Nahen Osten gilt sie als schützende Farbe. In China verbindet man die Farbe Blau mit
Unsterblichkeit, und für die Juden steht Blau für Heiligkeit. Die verkehrte Farbwahl kann also zu etlichen kulturellen Missverständnissen führen, die letztlich dem Export des Unternehmens schaden können. Man sollte daher die Verwendung von Blau und anderen Farben in der
technischen Dokumentation gründlich überdenken.

 

Beispiel 3)

Falsche Formatierung kann eine Fehlerquelle beim Übersetzen darstellen. Wenn man mit
CAT-Tools übersetzt, wird der Text in kleinere Einheiten aufgeteilt. Die Aufteilung erfolgt auf Basis von Zeichensetzung, Formatierung und Kodes. Wenn ein Satz aufgrund einer falschen
Formatierung, z. B. eines falsch gesetzten festen Zeilenumbruchs, in mehrere Einheiten
aufgeteilt wird, kann es beim Übersetzen zu Fehlern kommen, da die Sätze missverstanden
werden oder eine andere Bedeutung erhalten können. Achten Sie daher auf Ihre
Zeichensetzung und Formatierung, wenn Sie Ihre technische Dokumentation schreiben.

Sie können sich auf dem Exportmarkt viel Ärger ersparen, wenn Sie im Voraus an die möglichen Fallgruben denken und sie beim Ausarbeiten Ihrer technischen Dokumentation aktiv umgehen. Das bedeutet vielleicht, dass Sie zusätzlich etwas tun müssen, indem Sie Farbbedeutungen oder die lokalen Gegebenheiten untersuchen, ehe Sie mit dem Export beginnen können. Dadurch bleiben Ihnen aber schlechte Erfahrungen erspart, beispielsweise dass Ihr Produkt aufgrund von inhaltlichen Fehlern im Handbuch abgewiesen wird, oder dass sich jemand beim Betreiben Ihrer Maschine in einem anderen Land verletzt, weil die Übersetzung wegen falscher Formatierung Fehler enthält.

Szenario 1:

Sie haben eine Ihrer Maschinen ins Ausland verkauft. Endlich geht es mit dem Export los. Doch dann verlangt der Käufer Betriebsanleitungen in der Landessprache und will Ihre Maschine nur annehmen, wenn alle Informationen in seiner Sprache vorliegen. Was tun Sie dann?

 

Szenario 2:

Sie möchten Ihre Produkte gern online verkaufen. Ihre Homepage gibt es auf Deutsch und
Englisch, aber Sie verkaufen einfach nichts ins Ausland. Sollte eine englische Homepage doch nicht für alle Länder ausreichend sein?

Eine professionelle Übersetzung ist die Lösung für diese Probleme.