für verständliche Anleitungen
Wer eine Anleitung schreibt, MUSS über die Zielgruppe nachdenken, um sich in Sprache und Stil auf die potentiellen Anwender einzustellen.
Dabei gibt es mehrere Möglichkeiten die Zielgruppe einzuschätzen. Meistens sprechen wir von einer „Zielgruppenanalyse“, was aber nicht so ganz stimmt, wie der folgende Beitrag zeigt.
„Habe ich alles?“, „was fehlt noch?“, „wo habe ich etwas vergessen?“.
Stellen Sie sich diese Fragen kurz vor Veröffentlichung?
Wußten Sie schon, dass man PDFs so ausstatten kann, dass in mehreren Dateien gesucht wird? Genauer gesagt heißt das „Indizieren“, bei Acrobat heißt die Funktion „Catalog“ (was nicht sehr sprechend ist).
Ich habe bisher wenig Kollegen getroffen, die diese Möglichkeit kennen, meistens noch nicht mal vom Hören-Sagen.
Dabei wäre es gerade für Anleitungen, die über viele PDFs verteilt sind oder viele Zulieferer-PDFs mitliefern, sicher sinnvoll so eine Volltextsuche anzubieten. Dadurch dass der Index eingebettet ist, läuft die Suche auch sehr schnell.
Wenn ein Anwender eine Anleitung zur Hand nimmt, erwartet er schnelle Hilfe zu genau seiner Frage oder seinem Problem.
Die Betrachtung dieser Use Cases ist der Schlüssel für die Entwicklung effizienter Technischer Dokumentation auf Papier, Online oder als App.
Um es noch mal deutlich zu sagen: Ich spreche hier über die Use Cases der Anleitung, also die Situationen, in denen der Anwender Hilfe benötigt. Zunächst auch unabhängig davon, ob er die Anleitung zur Hand nimmt oder nicht.
Der Punkt „Voraussetzungen“ in Handlungsanweisungen führt immer wieder zu Fragen. Deswegen möchte ich ein paar Gedanken hier näher ausführen.
Dabei beziehe ich mich auf die Struktur der Handlungsanweisung (Juhl’sche Handlungsanweisung).
Unter Voraussetzungen verstehe ich Zustände, die bereits vorhanden sein müssen, damit die Handlung (sinnvoll) durchgeführt werden kann, z.B.:
Fachwissen gehört eigentlich nicht in eine Anleitung!
Eine Anleitung vermittelt das notwendige Geräte- und Handlungswissen zu einem Gerät / zu einer Maschine / zu einer Software.
Als Anleitungsschreiber kann und muss man davon ausgehen, dass der Anwender das notwendige Fachwissen bereits mitbringt, oder falls er es nicht hat, sich anderweitig besorgt.
Grundsätzlich steht es Ihnen als TR aber frei, Fachwissen in die Anleitung aufzunehmen.
*** Dieser Beitrag ist noch nicht ganz fertig, ***
*** ich stelle ihn trotzdem schon mal zur Diskussion ***
In letzter Zeit betrachte ich häufiger, wie wir als Technische Redakteure Informationen für unsere Anwender aufbereiten. Dabei differenziere ich momentan gerne „spezifische“ und „unspezifische“ Information. Wahrscheinlich kommt Ihnen das zunächst etwas akademisch vor, ich meine aber, es lohnt sich, sich mit dieser Unterscheidung zu befassen.
Spezifische Information
Spezifische Information nenne ich solche, die eine konkrete Antwort auf eine Frage gibt. Z.B. „Wie kann ich das Gerät einschalten?“ wird durch ein Kapitel „Einschalten“ beantwortet. Weitere Beispiele:
Wenn sich eine Anleitung an eine breite Zielgruppe wendet, bei der man wenig Bildung, Wissen und Lesekompetenz erwarten kann, muss man als TR alle Register ziehen, um die Anleitung klar und verständlich für alle zu machen.
M.E. ist es möglich, eine Anleitung so zu schreiben, dass sie für viele Anwender benutzbar ist.
Die Kriterien sind:
Der folgende kurze Abriss soll nur einen Überblick über die Terminologiearbeit geben.
Jede fertige Technische Dokumentation muss nach unterschiedlichen Kriterien qualitätsgesichert werden.
Üblich sind: