Sie suchen auf: {{ keyword }}

Wir unterstützen Unternehmen beim Schreiben ihrer
Dokumentation

Schritt 1: Die Zielgruppe der Technischen Dokumentation definieren
Schritt 2: Alle Informationen erfassen
Schritt 3: Eine logische Struktur und den Aufbau bestimmen
Schritt 4: Schreiben Sie klare und konsistente Texte
Schritt 5: Erstellen Sie klare Illustrationen
Schritt 6: Befolgen Sie die gesetzlichen Anforderungen
Schritt 7: Setzen Sie die Sicherheitshinweise umsichtig um
Schritt 8: Ein ansprechendes Layout erstellen
Schritt 9: Medium und Format festlegen
Schritt 10: Die Technische Dokumentation übersetzen
Schritt 11: Die Inhalte gut verwalten

NEHMEN SIE KONTAKT AUF

Der Begriff Technische Dokumentation bezeichnet alle Informationsprodukte und Dokumente, die ein Produkt (wie Maschine, Gerät, Anlage, Software) beschreiben und in denen technische Sachverhalte, produktspezifische Daten oder Abläufe strukturiert und präzise für eine bestimmte Zielgruppe aufbereitet werden. 

Mit einer klaren und rechtssicheren (externen) Dokumentation gewährleisten Sie, dass Ihr Produkt bestimmungsgemäß und sicher verwendet wird. 

Was gehört zu einer Technischen Dokumentation?

Die Inhalte der Technischen Dokumentation setzen sich unter anderem aus den folgenden Teilbereichen zusammen: Betriebsanleitungen, Installationsanleitungen, Bedienungsanleitungen, Anwenderdokumentationen, Sicherheitshinweise, Wartungsanleitungen, Montageanleitungen, Demontage- und Entsorgungshinweise.

So schreiben wir Ihre Technische Dokumentation

Verkaufen Sie Ihre Produkte sorglos mit einer Technischen Dokumentation, die den gesetzlichen Anforderungen entspricht, benutzerfreundlich mit klaren Texten und Abbildungen entwickelt und zudem gut gestaltet ist.

Die meisten Unternehmen konzentrieren sich nur auf das Schreiben von Texten, mit wenig oder gar keiner Aufmerksamkeit für Design und Compliance.

Möchten Sie wissen, wie wir eine Technische Dokumentation, wie diese Bedienungsanleitung für Bosch, schreiben?

Technische Dokumentation Bosch

Oder diese Anleitung für die Space Gravity GmbH?

Beispiel Technische Dokumentation

Mit Abbildungen wie in dieser Montageanleitung für Electrolux?

Elektrogeraet Technische Dokumentation

Und welche die gesetzlichen Anforderungen erfüllt, wie diese Betriebsanleitung für Ibotech?

Maschine Technische Dokumentation

Oder eine Online-Dokumentation wie die Online-Hilfe von MadCap Software oder für die LIDL Software?

 

Software Technische Dokumentation

Dann lesen Sie weiter.

 

 


Lesen Sie hier die 11 Schritte

mit unseren Tipps und Tricks

 

 

1

Die Zielgruppe der Technischen Dokumentation definieren

Im ersten Schritt legen wir fest, wer der wirkliche Benutzer ist. Wir fragen uns bspw.:

  • Wer ist der Benutzer?
  • Was beschreibt den Benutzer? 
  • Welche Sprache spricht er?
  • Welchen Hintergrund hat er? 
  • Welches Alter, Geschlecht usw.?
  • Welche Aufgaben muss er erledigen?
  • Wie oft geschieht das?
  • In welcher Umgebung kommt das Produkt zum Einsatz?
  • Hat der Benutzer Internet-Zugang? 
  • Ist der Benutzer gestresst?
  • Wird das Produkt beruflich, gewerblich oder privat eingesetzt?  
  • Welche technischen Erfahrungen, Qualifikationen, Ausbildungen, Schulungen, Kenntnisse oder Fähigkeiten hat der Benutzer? 

Wenn Sie mehr über Ihren Benutzer erfahren, können Sie sich besser auf die für ihn wichtigen Punkte konzentrieren. So erklären Sie ihm nichts, was er schon weiß oder irrelevant ist, und verschwenden weder seine, noch Ihre Zeit.  

In der Technischen Dokumentation beschreiben wir den Benutzer immer in der Einleitung. Beispiel:

Diese Anleitung richtet sich an den Endbenutzer der [Name der Maschine]. Der Endbenutzer lässt sich als jede direkt mit der Maschine interagierende Person definieren. Er umfasst typischerweise folgende Personen (Liste nicht erschöpfend): 

  • Installateur
  • Bediener
  • Wartungstechniker
  • Demontagearbeiter

Wie dieses Beispiel zeigt, gibt es ganz unterschiedliche Benutzertypen. Oft bestimmt die Zielgruppe, welche Art von Technischer Dokumentation erforderlich ist. 

Wollen Sie eine Online-Hilfe für die Mitarbeiter des Kundendienstes eines Software-Tools schreiben? Eine Installationsanleitung für einen Installateur? Oder aber eine Technische Dokumentation für den Bediener? 

Unabhängig von der Benutzerart, konsultieren Anwender die Technische Dokumentation zumeist, weil sie etwas erledigen oder ein Problem lösen wollen, bspw. die neueste Version ihrer Textverarbeitung installieren, ihre Läufe in einer App verfolgen oder wissen, warum die Warnleuchte auf dem Display ihres Elektrogerätes blinkt.  

Diese zu erledigenden Probleme oder Aufgaben sind überaus spezifisch, bspw.:

  • Wie bringe ich die Füße an meiner Mikrowelle an?
  • Wie tausche ich die Form meiner Maschine aus?
  • Was bedeutet die rote, blinkende LED-Leuchte?
  • Darf ich das Gehäuse meines Gerätes mit Reinigungsmittel säubern?
  • Wie füge ich einen neuen Benutzer hinzu?

Wer den Benutzer kennt, kann konsistenter schreiben. Es hilft, die richtigen Angaben auszuwählen und sich auf die Aufgaben zu konzentrieren, die der Benutzer erledigen möchte.


2

Alle Informationen erfassen

Egal, welche Art Technische Dokumentation wir schreiben; immer muss der jeweilige Verfasser das zu beschreibende Produkt vollständig verstehen.

Dazu analysieren und probieren wir das Produkt, befragen Experten und studieren vorhandene Materialien.

Wir versuchen, es zu installieren, drücken alle Knöpfe, öffnen Deckel, identifizieren Signale, klicken uns durch Assistenten usw. 

Oft liegen bereits etliche Daten vor, wie vorhandene Benutzerhandbücher, eine Risikoanalyse oder Marketing-Informationen. Wir studieren diese Daten, bis wir die Funktionsweise des Produkts über den gesamten Produktlebenszyklus hinweg vollständig verstehen; vom Kauf bis zur Entsorgung.

Zu unserer Aufgabe gehört es, kritisch zu sein. Darum berücksichtigen wir nur Informationen, die wir voll und ganz verstehen und validieren können.

Nur langsam entsteht das vollständige Bild eines Produkts. Alle sich ergebenden verbleibenden Fragen werden notiert, um von Fachleuten geklärt zu werden, damit wir alles vollständig verstehen.

Ausgangspunkt bei der Datenanalyse und der Befragung der KMUs sind die Benutzeraufgaben. In einem nächsten Schritt werden die gesammelten Informationen organisiert.


3

Eine logische Struktur und den Aufbau bestimmen

Aufbau der Technischen Dokumentation schreiben

Eine Technische Dokumentation mit klarer Struktur und Aufbau ist ein Muss.

Die im vorherigen Schritt erfassten und analysierten Informationen, müssen richtig und logisch um diejenigen Themen organisiert werden, die dem Benutzer klare Antworten liefern. 

Dabei wollen wir sämtliche nützlichen Informationen behalten, um Themen zu schreiben, die alle Fragen des Benutzers beantworten. 

Diese sämtlichen Angaben zu organisieren, gehört zu den anspruchsvollsten Aufgaben eines technischen Redakteurs. Die erfassten Informationen müssen analysiert, verstanden, ausgewählt, entfernt, organisiert und strukturiert werden.

Ist das Problem eines Anwenders zu komplex und die Informationen wären beim Lesen nur schwer zu verinnerlichen, untergliedern wir das Thema in kleinere Teile. 

Wir haben bspw. für eine Vorrichtung zur Dachreinigung ein Installations- und Betriebsanleitung geschrieben. Der Benutzer muss als einen der wichtigsten Schritte gewährleisten, dass dieses Gerät betriebsbereit ist.

Das Hauptproblem heißt also: Wie sorge ich dafür, dass der Dachreiniger betriebsbereit ist?

Da dies ein umfangreiches Thema ist, haben wir es in folgende Abschnitte unterteilt:

Da dies ein umfangreiches Thema ist, haben wir es in folgende Abschnitte unterteilt:

  • So prüfe ich den Lieferumfang
  • So bereite ich die mobile Plattform vor
  • So bereite ich den Dachreiniger vor
  • So hebe ich den Top Cleaner auf das Gewächshaus
  • So justiere ich die mobile Plattform
  • So passe ich den Dachreiniger an
    • Die Hauptbürsten einstellen
    • Den optionalen Fensterschutzschalter justieren
    • Die optionale Dachrinnenbürste einstellen
    • Die Vorderrad-Schalthebel einstellen

Meist werden die Themen (nach dem Lebenszyklus Ihres Produktes) im Inhaltsverzeichnis bzw. in der Menüstruktur aufgeführt: klar gegliedert und identifizierbar. Ein Thema kann sich in ein Kapitel oder einen (Unter-) Absatz verwandeln. 

Hat ein Benutzer ein Problem und sucht in der Technischen Dokumentation nach einer Antwort, schlägt er höchstwahrscheinlich im Inhaltsverzeichnis nach, wo diese Antwort stehen könnte. 

Mit einem übersichtlichen Inhaltsverzeichnis kann er also leichter zu den richtigen Anweisungen navigieren, ohne hektisch die gesamte Technische Dokumentation durchsuchen zu müssen. 

Am liebsten organisieren wir die Themen im Inhaltsverzeichnis, dem Lebenszyklus des Produkts folgend, nach den Bedürfnissen der Leser und dem Zweck der Informationen.

Dabei beginnen wir in der Regel mit einem Standard-Inhaltsverzeichnis. Wenn wir, wie in den vorherigen Abschnitten beschrieben, Informationen sammeln und Themen identifizieren, erweitern wir das Inhaltsverzeichnis um diese produktspezifischen Themen.

Inhaltsverzeichnis

Beispiel für ein Standard-Inhaltsverzeichnis.

Wir strukturieren und organisieren Inhalte mit Methoden und Tools wie Mindmapping, Information Mapping und herkömmlichen Post-its. Manchmal schreiben wir das Inhaltsverzeichnis auch einfach nebenher.

Ein weiterer wichtiger Punkt lautet: Überschriften wirklich gut benennen. Nur so finden Benutzerinnen und Benutzer mit dem Inhaltsverzeichnis leichter Lösungen.

Die Beschreibung eines Themas bildet eine Überschrift und fließt in das Inhaltsverzeichnis ein, über das die Leser so schnell wie möglich zum Thema mit den gesuchten Informationen gelangen wollen. 

Die Überschrift im Beispiel umreißt den Inhalt sehr deutlich.

Überschriften in einer Technischen Dokumentation erfüllen mehrere wichtige Funktionen:

  • Sie bieten einen organisatorischen Überblick über die Technische Dokumentation
  • Sie zeigen die logische Struktur der Produktangaben entsprechend dem Lebenszyklus des Produkts
  • Sie reflektieren die hierarchische Beziehung zwischen Themen (Überschriften, Unterüberschriften)
  • Sie ermöglichen es den Lesern, schnell zur richtigen Seite zu navigieren ...
  • ... und alles zu überspringen, was sie nicht interessiert. 

Eine Überschrift markiert die Grenzen zwischen Themen und Unterthemen einer Technischen Dokumentation. Eine gute Überschrift umreißt den gesamten Inhalt des dazugehörenden Themas. 

Damit die Benutzer die gesuchten Angaben finden können, müssen Überschriften unbedingt gut formuliert und konsistent gestaltet und formatiert werden. 

Aufgabe-Überschriften sollten selbsterklärend formuliert sein. Die Überschrift „So zaubern Sie leckere Pfannkuchen“ ist viel benutzerorientierter als „Anwendung des MagicMix2000“.


4

Schreiben klarer und konsistenter Technischer Dokumentationen

Wie schreibe ich eine gute Technische Dokumentation?

Eine Technische Dokumentation für den sicheren, effizienten und effektiven Gebrauch eines Produkts zu schreiben – das ist stets unser Hauptziel. 

Ausgangspunkt hierfür sind möglichst klare Anweisungen, wobei wir einige bestimmte Punkte berücksichtigen:

Fachjargon vermeiden

Zunächst verwenden wir möglichst keine Fachausdrücke außerhalb des üblichen Wortschatzes unserer Leser.

Dazu ein Beispiel:

Sie können problemlos sagen: „Ziehen Sie den unteren Näherungsschalter fest“, Denn mit „unterer Näherungsschalter“ benennen Sie einen nötigen Fachbegriff.  

„Ziehen Sie den unteren Näherungsschalter mit einem ausreichenden Drehmoment an, um zu gewährleisten, dass die Näherungsschalter-Baugruppe sicher an der Rampe befestigt ist und sich unter extremen Wetterbedingungen nicht lösen kann“ ist jedoch zu sehr mit Jargon überfrachtet. 

Übermäßiger Jargon entsteht oft, wenn die Technische Dokumentation von Ingenieuren geschrieben wurde. 

Technische KMUs fühlen sich eher in Zahlen, Prozessen und technischen Prinzipien zu Hause, als in der Welt der Worte. Sie erledigen Dinge und erzielen Ergebnisse, anstatt über das Wie zu sprechen.

Doch um eindeutig zu informieren, sind all diese Zahlen, Fachbegriffe usw. oft gar nicht nötig. Wir sehen unsere Aufgabe darin, zur Bedeutung von Begriffen die richtigen Fragen zu stellen und zu entscheiden, was erwähnenswert ist und wie dies für den jeweiligen Benutzer optimal kommuniziert werden kann (Schritt 1).

Verfügbare Informationsarten gekonnt auswählen

Alle Technischen Dokumentationen bestehen grundsätzlich aus folgenden drei Informationsarten: 

  • Anweisungen
  • Konzepten 
  • Verweise 

Anweisungen sagen den Benutzern meist in mehreren Schritten, was sie tun sollen. Dazu zählen auch Sicherheitsanweisungen.

Um Anweisungen zu befolgen oder zu entscheiden, ob diese relevant sind, benötigen Benutzer manchmal eine kurze Erklärung oder Hintergrundinformationen Die sog. konzeptionellen Informationen.

Um Benutzer auf zusätzliche Informationen hinzuweisen, nutzen wir Verweise.

Jedes Thema kann Konzepte, Anweisungen und Verweise enthalten. 

Dabei besteht ein interessantes Paradoxon:

Am besten lernt man durch Tun. Doch oft müssen Benutzer erst etwas lernen, um selbst handeln zu können.

Die Leser benötigen einerseits Hilfe für unmittelbare Handlungen und andererseits wesentliche Konzepte. Zwischen beiden Aspekten das richtige Gleichgewicht zu finden, zählt zu den wichtigsten Fähigkeiten, die ein technischer Kommunikator entwickeln muss. 

Schreiben Sie eine aufgabenorientierte Technische Dokumentation   

Benutzer wollen Dinge erledigen und nicht darüber lesen.

Deshalb hat jede Technische Dokumentation ein klares Ziel, das stets aufgabenorientiert auf den Punkt zu bringen ist. Dies ist auch ein Prinzip des Minimalismus.

Ein handlungsorientierter Ansatz muss Ausgangspunkt der gesamten Technischen Dokumentation sowie eines jeden Einzelschritts sein. Der Benutzer sollte eine unmittelbare Chance zum Handeln erhalten.

Weniger konzeptionelle Angaben und mehr Konzentration auf Abläufe regen zum Handeln an. 

Dazu folgendes Beispiel.

Die Seite dieser „Technischen Dokumentation für Drohnen“ umfasst zwei Schritte. Dies sind zwei von sechs Schritten innerhalb der Anleitung/des Unterthemas „So installiere ich die Drohne“. Jeder Schritt ist aufgabenorientiert

Die Anweisungen sind in der richtigen Reihenfolge zu verfassen

Nötig sind schrittweise Anweisungen in der richtigen Reihenfolge – mit dem Timing und der Abfolge der tatsächlichen Handlungen.

Auch innerhalb eines Satzes muss die Reihenfolge stimmen. Ein Beispiel:

„Um als Standardsprache Deutsch zu wählen, wählen Sie „Deutsch“, wenn Sie im Menü Datei auf Sprache klicken“  

...ist bei weitem nicht so benutzerfreundlich wie ...

So wählen Sie Deutsch als Standardsprache:

  1. Gehen Sie auf Datei>Sprache.
  2. Wählen Sie Deutsch.

Schreiben Sie klare Anweisungen

Vermeiden Sie langatmige Formulierungen. Am besten funktionieren kurze, einfache Sätze mit nur einer Anweisung oder höchstens wenigen zusammenhängenden Anweisungen pro Satz. 

Die Angaben sollten so einfach und kurz wie möglich sein. Anweisungen erfolgen möglichst im Präsens, im Aktiv und mit starken Verben.

Anweisungen im Aktiv heben den Benutzer hervor, sind einfacher zu lesen und zu verstehen 

Und haben stets ein klares Subjekt und Verb. Beispiel: 

„Verbinden Sie eine Tastatur mit einem USB-Port am Remote-Gerät.“

Hier ist „verbinden“ das aktive Verb und „Tastatur“, „USB-Port“ und „Remote-Gerät“ sind die Subjekte.

Zum Vergleich derselbe Satz im Passiv:

„An einen USB-Port des Remote-Geräts muss eine Tastatur angeschlossen werden.“

Der Aktiv-Satz verdeutlicht viel klarer, dass die handelnde Person der Leser ist.

Durch die Aktiv-Form werden Anweisungen klarer, prägnanter und direkt.

Konsistenz fördert das Benutzererlebnis

Zu den wichtigsten Merkmalen einer übersichtlichen Technischen Dokumentation zählt die Konsistenz:  Wenn Sie bspw. Produktelemente stets gleich bezeichnen, vermeiden Sie Verwechslungen.

Entscheidend ist auch, Informationsarten (Warnungen, Einzelschritte, Fehlererkennung, Tipps usw.) stets konsistent zu formatieren und dazustellen.  

Damit die Benutzer die gesuchten Informationen leichter identifizieren können. So erregen die klare Formatierung eines Sicherheitshinweises und konsistent eingesetzte Signalwörter, wie GEFAHR, WARNUNG und VORSICHT, mehr Aufmerksamkeit, denn die Benutzer nehmen sie visuell als Sicherheitsmeldung wahr.

Einheitlich formatierte Informationsarten erkennen Leser – bewusst oder unbewusst – als solche und assoziieren sie mit der Funktion der entsprechenden Informationsart.

Betrachten Sie dieses Beispiel aus einer Technischen Dokumentation, das wir für Gazelle geschriebenhaben. Die Überschriften der Ebenen 1 und 2, Warnung/Hinweis, Kontextinformationen, Anweisungstitel, Anweisungen, Produktelemente und Abbildungen sind alle einheitlich formatierte Informationsarten.

Im Englischen hilft „Simplified Technical English“, um unmissverständlich zu schreiben

Wir bevorzugen außerdem die Regeln des „Simplified Technical English“.

Simplified Technical English fördert auch das konsistente und unmissverständliche Schreiben. 

Auch hier sollten Sie sich bewusst sein, dass die gewählten Wörter Bedeutung oder Verständlichkeit Ihrer Texte stark beeinflussen können.

Schauen wir uns einmal genauer das Wort „SET“ an:

Dieses simple Wort heißt u. a. „einstellen“, „abstimmen“, „fixieren“ oder „positionieren“. Darum ist es unbedingt so zu verwenden, dass die Bedeutung stets klar ist. 

Noch nicht überzeugt? Werfen wir einen Blick auf folgendes Beispiel:

„Turn off the engines not required“

Dieser Satz kann bedeuten:

  • „Schalten Sie diejenigen Motoren aus, die nicht benötigt werden.“ oder
  • „Es ist nicht nötig, die Motoren abzuschalten.“

Mit dem Wörterbuch des „ASD-STE100 Simplified Technical English Standard“ lassen sich Mehrdeutigkeiten vermeiden. 

Es umfasst nur 850 zulässige Wörter.

Und führt außerdem verbotene Wörter auf. Die erlaubten Wörter sind zudem nur in ihrer festgelegten Bedeutung zulässig, Das Wort „close“ etwa nur in einer der folgenden zwei Bedeutungen:

  1. Einen Schutzschalter betätigen, um einen Stromkreis zu schließen.
  2. Zusammenschieben oder positionieren, um den Ein- oder Austritt von Materialien aufzuhalten oder zu verhindern.

„Close“ darf also nur als Verb, nicht als Adverb verwendet werden. „Do not go close to the test rig during the test“ ist folglich eine unzulässige Verwendung von „close“.

Wir haben unser eigenes Online-Wörterbuch erstellt, mit dem Sie prüfen können, ob ein Wort zulässig ist: Online Technical English Dictionary.

Mittels Style-Guide einen einheitlichen Tonfall beibehalten

Mittels Style-Guides schreiben und formatieren Sie die Technische Dokumentation klarer und halten Tonfall und Stil konsistenter.

Begriffe, Produktelemente und Einheiten müssen unbedingt konsistent bleiben. 

Vereinheitlichen Sie Ihre Begriffe in der Technischen Dokumentation , auf der Verpackung, in anderen Begleitmaterialien und auf dem Produkt selbst (Kennzeichnung und Etikettierung).

Natürlich sollten die Sätze grammatikalisch korrekt sein, dem Zielpublikum entsprechen und nur minimalen Jargon enthalten.

Vermeiden Sie Abkürzungen und Akronyme, sofern nicht davon ausgegangen werden kann, dass sie Ihrem Zielpublikum vertraut sind. Nutzen Sie sie dennoch, erläutern Sie sie beim ersten Auftreten im Style-Guide und/oder in einem Glossar. 

Alle oben genannten Richtlinien können in einen Style-Guide einfließen. Ein Style-Guide sorgt für Konsistenz und regt dazu an, alle Details sorgfältig zu berücksichtigen: Ein Style-Guide zwingt Sie dazu, jeden einzelnen Satz genauestens zu analysieren. 

Ein Style-Guide erhöht die Verständlichkeit. 

Sobald Sie einen eigenen Style-Guide geschrieben haben, der beispielsweise Ihren Schreibstil, Ihre Formulierungen, die konsistente Verwendung von Begriffen, die Art der Leseransprache und die Gestaltung von Text und Seitenlayout (siehe unten) umfasst, müssen Sie ihn auf ALLE Anweisungen anwenden. 

Schreiben Sie mittels ANSI Z535.6 klarere Sicherheitshinweise 


Den korrekten Gebrauch von Wörtern für Anforderungen und Empfehlungen standardisiert ANSI Z535.5, eine amerikanische Norm, die wir dennoch auch auf die Technische Dokumentation für andere Märkte anwenden. 

Laut ANSI ist die korrekte Verbform für Anforderungen im Englischen „shall“,  Was im Sinne von „obligatorisch“ verstanden wird. Das allgemein übliche „must“ anstelle von „shall“ erkennt die Norm dagegen nicht an. 

Beispiel: The product shall only be used by persons who have fully read and understood the contents of the user manual. 

Die korrekte Verbform für Empfehlungen nach ANSI lautet „should“. Oder – in ANSI-Terminologie: „should“ ist als Empfehlung zu verstehen. 

After each use, the device should be disconnected from the mains. 

Gibt es viele Wahlmöglichkeiten oder keine Garantie, dass etwas passiert, ist „may“ möglich. „may“ wird als zulassend verstanden. „might“ statt „may“ ist hingegen nicht erlaubt. 

Some individuals may experience a mild tingling sensation when first using the device. 

Wir haben einmal erlebt, dass der amerikanische Zoll ein Gerät nicht zur Einfuhr zuließ, weil diese Wörter falsch in der Technischen Dokumentation standen.

ANSI 535.5 Signalwörter


5

Erstellen Sie klare Illustrationen

Visuelle Elemente in einer Technischen Dokumentation sind weit mehr als nur Screenshots oder Illustrationen,

sondern alle Arten von grafischen Darstellungen, wie Strichzeichnungen, Fotos, Screenshots, Videos, Symbole, Tabellen, Diagramme, Grafiken und Infografiken.

Sie dienen alle einem anderen Zweck.

Illustrationen im IKEA-Stil nutzen

Wir sind für unsere Strichillustrationen im IKEA-Stil berüchtigt. Mit ihnen unterstützen, ersetzen oder ergänzen wir Texte und präsentieren eine chronologische Abfolge eines Prozesses oder zu befolgender Schritte. 

Dank Illustrationen verstehen wir besser, was zu tun ist.

Illustrationen in einer Technischen Dokumentation sind logisch und nachvollziehbar anzuordnen.

Anders als Fotos schaffen Illustrationen eher die Freiheit, sich auf wichtige Details zu konzentrieren. So können Sie weniger relevante Informationen einfach weglassen oder bestimmte Teile vergrößern.

Illustrationen müssen nicht übersetzt werden. Auch deshalb ist es vorteilhaft, mit ihnen durchgängig Texte zu ersetzen. Denken Sie daran: Verständliche Illustrationen zu erstellen, erfordert besondere Kenntnisse. 

Obwohl es zur Unterstützung viele Tools gibt, ist es eventuell sinnvoll, mit der Illustrierung einen kompetenten Grafiker oder technischen Illustrator zu beauftragen.

Wenn wir Illustrationen erstellen, lassen wir Irrelevantes aus und betonen das Wichtige. Bei Fotos ist das komplizierter, weshalb wir auf diese lieber verzichten.

Illustrationen

Verwenden Sie für GUI-Darstellungen Screenshots

Screenshots symbolisieren visuell die Benutzeroberfläche eines Bedienfelds, einer Software auf einem Desktop-Computer oder einer App. 

Sie geben einen Überblick über Funktionalitäten, demonstrieren, was zu tun ist, oder stellen das Ergebnis einer bestimmten Aktion dar.

Tabellen zum Organisieren von Daten

Mittels Tabellen organisieren wir numerische oder verbale Daten. Tabellen präsentieren technische Daten lesbarer Und können den Text oft vollständig ersetzen.

Sie müssen übersichtlich, informativ und in einem einheitlichen Design dargestellt sein. Meistens stehen Tabellen neben dem entsprechenden Text Referenztabellen (wie etwa Ersatzteillisten) sind dagegen im Anhang möglich.

Erwägen Sie die Verwendung von Videos anstelle von Illustrationen

Videos oder Animationen können vielen Zwecken dienen.

Wir können Videos nutzen, wenn Dinge deutlich dargestellt werden müssen, wie bspw. eine Bewegung, ein Zustand oder eine Kraft. Da Videos immer beliebter werden, sind sie auch sinnvoll, wenn der Kunde möglichst viele Menschen erreichen will.

Videos können realistisch sein (Kameraaufnahme), eine 3D-Animation oder eine illustrierte Animation beinhalten, solange sie kurz und relevant sind.


6

Befolgen Sie die gesetzlichen Anforderungen

Leitlinien für das Schreiben Technischer Dokumentationen

Je nach dem zu beschreibenden Produkt bestehen wahrscheinlich rechtliche Anforderungen an Inhalt, Präsentation und Format der Technischen Dokumentation,

Z. B. durch Bundesgesetze in den USA, Richtlinien oder Verordnungen in der EU oder ähnliche Gesetze in anderen Ländern oder Staaten.

Mit Standards lassen sich, sofern sie nicht sowieso Vorschrift sind, die (CE-) Anforderungen erfüllen.

So sind Maschinen und medizinische Geräte die am stärksten regulierten Produkte überhaupt. In der EU befinden sich die Anforderungen an die Technische Dokumentation n der Maschinenrichtlinie bzw. in der Verordnung für medizinische Geräte.

Um die Maschinenrichtlinie zu erfüllen, empfiehlt sich in der Technischen Dokumentation für Maschinen der harmonisierte Standard EN ISO 20607.

Ein weiterer wichtiger Standard lautet EN IEC/IEC 82079 über Gebrauchsinformationen.

Indem wir gesetzliche Vorgaben einhalten und Standards anwenden, schreiben wir eine rechtssichere Technische Dokumentation. 

So vermeiden wir leichter rechtliche Fallstricke, Ihr Produkt besteht problemlos Tests und passiert den Zoll, Ihr Haftungsrisiko sinkt, Sie genießen einen Wettbewerbsvorteil und Ihre Benutzer können Ihr Produkt sicherer verwenden. 

Allgemein erstellen wir eine konforme Technische Dokumentation nach folgendem Prozess:

  • Gesetzgebung (Gesetze/Richtlinien) identifizieren
  • Standards identifizieren
  • Anforderungen der für Ihr Produkt gültigen Gesetzgebung und Standards identifizieren
  • Der Technischen Dokumentation rechtliche Inhalte hinzufügen

Oft schreiben wir die Technische Dokumentation für Ihre Maschinen, elektronischen Geräte oder medizinischen Anlagen anhand einer unserer Vorlagen.

Bestimmungsgemäße Verwendung: Das Herzstück der Technischen Dokumentation 

Eine übersichtliche Technische Dokumentation  muss beschreiben, wie ein Produkt entsprechend seiner Funktion und in der erwarteten Produktlebensdauer zu verwenden ist. 

Die Funktion von Produkten, Maschinen oder Geräten bezeichnet man auch als bestimmungsgemäße Verwendung.

Dessen eindeutige Beschreibung stellt das Herzstück einer Technischen Dokumentation  dar und bestimmt (neben anderen, wie technischen oder umweltbedingten Nutzungseinschränkungen) den sicheren Gebrauchsrahmen: Sie ist die Grundlage für eine sichere, effiziente und effektive Nutzung.

Die beschriebene bestimmungsgemäße Verwendung umreißt Ihre Haftung und ist Ausgangspunkt für den weiteren Inhalt Ihrer Technischen Dokumentation .

Sobald wir die bestimmungsgemäße Verwendungfestgelegt haben, konzentrieren wir uns darauf, die Sicherheits- und Benutzerinformationen zur ausschließlichen Verwendung des Produkts für seinen Verwendungszweck bereitzustellen.

Gesetze zur Produktsicherheit, wie Richtlinien und Normen, verlangen für die meisten Produkte die Definition der bestimmungsgemäße Verwendung.

Die internationale Norm für Nutzungsinformationen IEC/IEEE 82079-1:2019) definiert die bestimmungsgemäße Verwendungwie folgt: 

Eine erschöpfende Reihe von durch den Lieferanten des Produkts definierten und entworfenen Funktionen oder vorgesehenen Anwendungen

Hierzu ein Beispiel:

Eine Vorlage verwenden fürs Schreiben der Technischen Dokumentation

Oft verwenden wir eine Vorlage oder ein Muster für das Schreiben der Technischen Dokumentation. Wir haben Vorlagen für Maschinen, Medizinprodukte und Elektrogeräte entwickelt. Die Vorlagen enthalten alle obligatorischen Elemente, die gemäß CE-Kennzeichnung und anderen relevanten europäischen Produktsicherheitsrichtlinien erforderlich sind.

HIER KAUFEN


 

7

Setzen Sie die Sicherheits- hinweise umsichtig um

Sicherheit zählt zu unseren Lieblingsthemen, denn sie hat mit Compliance zu tun, einem von den meisten technischen Redakteuren sowie von den Agenturen weitgehend übersehenen Aspekt. 

Uns gefällt der Widerspruch, gleichzeitig eine konforme und benutzerfreundliche Technische Dokumentation  zu schreiben. 

Einige technische Redakteure warnen zu viel. Oft sehen wir eine Technische Dokumentation voller Warnungen und ohne eine einzige Anweisung.

Exzessive Warnungen widersprechen dem handlungsorientierten Ansatz (siehe Schritt 4). Wie sähe Ihre Benutzererfahrung aus, wenn in einer 40-seitigen Technischen Dokumentation die erste echte Anweisung erst auf Seite 32 erfolgte – nach über 30 Seiten Warnungen und Prozessbeschreibungen? 

Hierfür gibt es eine Lösung, einen Kompromiss in der Mitte! 

Betrachten wir jedoch zunächst, warum wir Warnhinweise in einer Technischen Dokumentation aufnehmen. 

Egal, wie gut und sicher ein Produkt auch konstruiert ist, sein Einsatz unterliegt oft gewissen Risiken, welche sich mit einer Risikoanalyse identifizieren lassen.  

Es besteht (nach internationalen Standards) ein allgemeiner Konsens, dass sich diese Risiken auf dreierlei Arten senken lassen: 

Man kann ein Produkt vom Design her anpassen, es bzw. den Benutzer mit Sicherheitsmaßnahmen ausstatten (Schutzvorrichtungen, persönliche Schutzausrüstung usw.) oder aber Sicherheitsanweisungen bereitstellen.

Diese drei risikomindernden Maßnahmen sollten in der angegebenen Reihenfolge berücksichtigt werden: Solange sich das Design noch verbessern lässt, sollte eine Technische Dokumentation also nie vor Risiken warnen. 

Als Faustregel gilt: Dort warnen, wo das Risiko am wahrscheinlichsten auftritt.

Für die Technische Dokumentation  heißt das: Wir unterscheiden vier Arten von Sicherheitsanweisungen: ergänzende Vorschriften, gruppierte Sicherheitshinweise, Abschnittssicherheitshinweise und eingebettete Sicherheitshinweise (siehe diesen Beitrag für weitere Informationen dazu).

Der Abschnitt zu den gruppierten Sicherheitshinweisen (meist das Kapitel SICHERHEIT) wirkt weniger abschreckend, wenn er nur Sicherheitshinweise enthält, die für den gesamten Lebenszyklus des Produkts (von der Installation bis zur Entsorgung) gelten. 

Abschnittssicherheitshinweise gelten nur für einen bestimmten Abschnitt (z. B. die Installation) und stehen meist an dessen Anfang. 

Für eine bessere Benutzerfreundlichkeit bieten sich zwei Methoden an: Erstens kann man sämtliche Sicherheitswarnungen, die sich auf diesen bestimmten Abschnitt beziehen, zusammenfassen. 

Betrachtet man die vielen Warnhinweise, so erscheint die Handhabung dieser elektrischen Zahnbürste so gefährlich wie die Arbeit in einem Atomkraftwerk.

Benutzerfreundlicher wäre folgender Ansatz:

Warnhinweise gänzlich wegzulassen, empfehlen wir nicht, aber oft lässt sich die Anzahl durchaus drastisch senken.

Eingebettete Sicherheitshinweise sind in den Anweisungen selbst eingebettet.

Entscheiden wir uns für einen Warnhinweis anstelle einer Anweisung, strukturieren wir auch die Warnung selbst. 

Eine effektiver Warnhinweis besteht aus drei Teilen: 

  • Art und Quelle der Gefahr
  • Folgen bei Nichtbeachtung
  • Maßnahmen zur Vermeidung der Gefahr.

Vor einer Warnung steht das Signalwort „Gefahr“, „Warnung“, „Vorsicht“ oder „Hinweis“.

Heute haben Signalwörter in mehreren verfügbaren Normen, die die Risikostufen beschreiben, eine ähnliche Bedeutung.


 

8

Ein ansprechendes Layout erstellen

Eine simple Technische Dokumentation in MS-Word war gestern.  

Oft wollen Benutzer auf Informationen sowohl online als auch gedruckt zugreifen. Und ein wichtiger Teil der Kundenerfahrung ist, wie diese Daten aussehen.

Für ein besseres Benutzererlebnis förderlich sind, neben einem schönen Design, auch Formatierungsprinzipien: die richtige Schriftart und -größe, der gezielte und effektive Einsatz von Farben, Leerräume, Schriftbild, Kontrast und vieles mehr. 

Für Online-Informationen befolgen wir – für Präsentation und Navigation gleichermaßen – die ISO/IEC 40500:2012 als Richtlinien zur Zugänglichkeit von Inhalten.


 

9

Medium und Format festlegen

Viele Produkte erfordern nach wie vor eine Technische Dokumentation  (oder zumindest die Sicherheitsanweisungen) in Druckform. Trotzdem bemerken wir eine langsame Verschiebung. Einige Produkte lassen eine vollständig elektronische Anleitung zu, andere erfordern u. U. ein Hybridformat. Das spart Druckkosten und schont die Umwelt. 

Dies schafft viele Möglichkeiten für ein besseres Benutzererlebnis, indem Medien, wie Video, Erweiterte Realität, Online-Hilfe oder interaktive Anleitungen, zum Einsatz kommen. 

Mit verfügbaren CCMS- oder CMS-Lösungen (technische Autorentools) können wir eine Technische Dokumentation  in verschiedenen Formaten erstellen.

Wie ein Produkt zu gebrauchen ist, kann man dem Benutzer ganz unterschiedlich verdeutlichen: Darum sollte man unbedingt festlegen, welches Informationsmedium für die Bedürfnisse der Zielgruppen notwendig ist. 

Mit den gewählten Medien muss der Benutzer während der gesamten vorgesehenen Lebensdauer des Produkts bequem auf die Informationen zugreifen können.


 

10

Die Technische Dokumentation übersetzen

Nachdem Inhalt (Textteile und visuelle Elemente) und Form (Vorlagen) stehen, ist der Entwurf der Technischen Dokumentation  zu kontrollieren. 

Wir bitten unseren Kunden stets, alle Personen mit fundierten technischen Produktkenntnissen, die Informationen beigesteuert haben, die bisherige Arbeit mit überprüfen zu lassen. 

Das geht per Überarbeitungsfunktion eines technischen Autorentools oder ganz einfach in Google Doc. Liegt das Feedback dann vor, kann die Technische Dokumentation fertiggestellt werden. 

Nach der technischen Überprüfung wird das Dokument Korrektur gelesen. Hierbei wird die schriftliche Technische Dokumentation auf Fehler durchsucht. 

Da man die eigene Arbeit nur schwer selbst Korrektur lesen kann (Stichwort „Betriebsblindheit“), lektoriert stattdessen ein professionelles Übersetzungsbüro. 

Danach kann man mit den Übersetzungen beginnen. Der beste Ausgangspunkt für Übersetzungen ist, so der allgemeine Konsens, eine Technische Dokumentation auf Englisch. 

Darum schreiben wir das Original der Technischen Dokumentation  vorzugsweise auch in dieser Sprache, Denn in ihr lassen sich klare Anweisungen leichter formulieren (Beispiel: „Push the On/Off button“). Auf Deutsch hieße der Satz: „Drücken Sie den Ein-/Aus-Schalter“.  

Wäre Deutsch also die Originalsprache, könnte man leicht „You can now push the on/off button“ übersetzen. Der Übersetzer sieht „Sie“ und möchte es vielleicht intuitiv verwenden, da er nicht gänzlich versteht, wie wichtig es ist, den Satz mit einem Aktivverb zu beginnen.  

Englisch ist außerdem global die häufigste Zweitsprache. Darum sind Übersetzungen aus dem Englischen auch günstiger: So findet man Übersetzer AUS dem Englischen INS Deutsche leichter als umgekehrt. 

Wir gewährleisten immer, dass Ihre Technische Dokumentation  von Übersetzern mit ähnlicher Übersetzungserfahrung übersetzt wird. Dies umfasst Erfahrung mit technischen Inhalten, der Übersetzung ähnlicher Produkte oder Technischer Dokumentationen . 

Oft geben wir den Übersetzern bzw. der Agentur ein Glossar oder eine Terminologie-Liste mit, um die Übersetzung weiter zu verbessern.

Auch wenn die Technische Dokumentation  in mehrere Sprachen übersetzt werden soll, kann ein CMS oder CCMS sehr vorteilhaft sein. Die meisten dieser Tools basieren auf Industriestandards, wie XLIFF und TMX. 

Die Übersetzungen werden im „Translation Memory“ verwaltet, und nur die noch nicht übersetzten Teile gehen zum Übersetzungsbüro.


11

Die Inhalte gut verwalten

Überaus vorteilhaft für eine Technische Dokumentation ähnlicher Produkte und/oder in mehreren Sprachen sind mitunter CCMS. Diese Tools und Software beruhen meist auf Industriestandards, wie XML, CSS und XLIFF

Beispiele für CCMS sind Paligo, MadCap Flare, Author-it, Framemaker, Oxygen XML und SCHEMA ST4.  

Sie nutzen als Ausgangspunkt bestehende Inhalte. Durch die klare Trennung zwischen Inhalt und Form wird der Produktionsprozess automatisiert. Das DTP in InDesign dauert hingegen mehrere Stunden.  

Außerdem erstellen die meisten CMS- oder CCMS-Tools zum Erzeugen einer Technischen Dokumentation  gleichlautende Online- und Druckinhalte. 

Wir wählen das für Ihre Bedürfnisse optimale CMS/CCMS aus.

Wir helfen Ihnen beim Erstellen Ihrer Technischen Dokumentation 

Informationen für Benutzer werden oft als etwas angesehen, das nach der Entwicklung des Produkts noch zu erledigen ist. Für hochwertige Informationen ist die Entwicklung einer Technischen Dokumentation  jedoch als integraler Teil des Produkts selbst zu betrachten. Die Erstellung hochwertiger Informationen erfordert spezifische Planung.

Wir haben unseren eigenen INSTRKTIV-Prozess aus 5 Schritten entwickelt, mit dem wir eine Technische Dokumentation schreiben. Er basiert auf dem Produktentwicklungsprozess, da das Erfassen und Strukturieren von Daten dem Modell für Innovationsprozesse recht ähnlich ist.

Er besteht aus folgenden Phasen:

  1. Festlegung des rechtlichen Rahmens
  2. Analyse des Produkts und Verfassen der Texte
  3. Erstellung der Illustrationen
  4. Entwicklung von Vorlagen
  5. Erzeugung des Outputs

Unser Team umfasst verschiedenste Fachleute mit jeweils eigenem Fachwissen. Zu unseren internen Spezialisten gehören Rechtsexperten, technische Redakteure, Illustratoren, Designer, CMS-Experten und DTP-Mitarbeiter.

Sind Sie von den Möglichkeiten, Ihre Technische Dokumentation  schreiben zu lassen, begeistert? Dann kontaktieren Sie uns!

FORDERN SIE DIREKT EIN ANGEBOT AN


Fordern Sie direkt ein Angebot an!

Fordern Sie ein Angebot an