Know-how zur Technischen Dokumentation

Viele Verantwortliche glauben, das Erstellen Technischer Dokumentation erfordere keine spezielle Qualifikation.

Von technischer Seite trifft dies zu. Leistungsfähige Autorensoftware erzeugt auf Knopfdruck hübsch anzusehende Handbücher und Online-Hilfen.

Von didaktischer Seite ist die Herausforderung allerdings ungleich größer. Nicht ohne Grund lesen so viele Menschen Handbücher nur ungern und scheitern sogar bei der Bedienung einfacher Produkte. Dies passiert immer dann, wenn die Dokumentation nicht die Denkweise der Benutzer widerspiegelt und Vorwissen voraussetzt, über das die Benutzer noch nicht verfügen.

Das Know-how zum Schreiben verständlicher Benutzerhandbücher und Online-Hilfen besteht darin, gekonnt die Lücke zwischen dem Vorwissen der Benutzer einerseits und dem für die Bedienung des Produkts benötigten Wissen andererseits zu überbrücken. Die Dokumentation darf den Leser nicht überfordern. Vielmehr sollte sie Sicherheit vermitteln, motivieren und auf kürzestem Weg zum Ziel führen.

Im Vorfeld zur Neuerstellung oder Bewertung Ihrer bereits bestehenden Benutzerhandbücher und Online-Hilfen können Ihnen folgende Checklisten helfen:

▪Checkliste zur Qualitätssicherung Technischer Dokumentation
Zeigt, woran Sie Schwachstellen bereits bestehender Technischer Dokumentation erkennen, und wie Sie die Qualität Ihrer eigenen Arbeit einschätzen können.

▪Auswahl eines Autorensystems
Zeigt, worauf Sie bei der Auswahl eines geeigneten Erstellungswerkzeugs für Technische Dokumentation achten sollten, und woran Sie effiziente und zukunftssichere Systeme erkennen.

▪Auswahl eines Screen Capture Tools
Zeigt, was Sie bedenken sollten, wenn Sie nach einer speziellen Software zum Erstellen und Nachbearbeiten von Bildschirmfotos („Screenshots“ oder „Screen Captures“) suchen.

▪Auswahl eines Screencasting Tools
Zeigt, welche Kriterien bei der Auswahl einer Software zur Erstellung interaktiver Software Demos („Screencasts“) wichtig sind.

Um Ihnen die Suche nach geeigneten Erstellungswerkzeugen zu erleichtern, haben wir darüber hinaus Marktübersichten nützlicher Software zusammengestellt. Die Übersichten beinhalten sowohl Programme zum unmittelbaren Erstellen Technischer Dokumentation (Benutzerhandbücher, Online-Hilfen, Screencasts) als auch Tools, die sich im Arbeitsalltag Technischer Redakteure und Übersetzer allgemein bewährt haben.

Zur weiteren Unterstützung finden Sie ein umfangreiches Verzeichnis nützlicher Webseiten und empfehlenswerter Bücher. Dies sind Quellen, die wir als Technische Redakteure selbst bei der täglichen Arbeit nutzen.

Links zu den Listen finden Sie im Navigationsbereich auf der linken Seite.

Gerne beraten wir Sie auch persönlich und erstellen oder optimieren Ihre Dokumentation für Sie.