Nicht lineare Dokumentation – was wird anders?

Früher haben wir Anleitungen geschrieben, bei denen der Inhalt für das (lineare) Buch gegliedert ist:

  • alles steht hintereinander, vom Titelblatt bis zur letzten Seite
  • die Inhalte sind kapitelweise hierarchisch gegliedert

Diese Reihenfolge soll es dem Anwender ermöglichen seinen aktuellen Informationsbedarf zu befriedigen, der inter- und intraindividuell durchaus unterschiedlich sein kann:

  • Einarbeiten: Bedienelemente kennen lernen, Grundbedienung erlernen, ausprobieren, anwenden …
  • Nachschlagen: Sehr unterschiedlicher Informationsbedarf in allen Phasen der Anwendung (vom „wie kann ich XY tun?“ bis „welches Drehmoment brauche ich bei …?“)
  • Weiter lernen: Ich gehe davon aus, dass ein Anwender zuerst die Grundfunktionen kennen lernen will und sich danach, vielleicht auch viel später, weitere Funktionen erschließt (bei Bedarf oder auch als „was gibt es sonst noch?“).

Heute nennen wir das gerne Use Cases. Die Anleitung muss geeignet sein, Antworten bei allen Use Cases zu geben (gemeint sind die Use Cases der Anleitung).

Mehr lesen

Gehört Fachwissen in eine Anleitung?

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.

Mehr lesen

Spezifische, unspezifische Information

***  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:

Mehr lesen

Terminologiearbeit (Überblick)

Der folgende kurze Abriss soll nur einen Überblick über die Terminologiearbeit geben.
Zu jedem Punkt könnte man noch viel schreiben.

  • Sensibilisierung, dass bei der Benennung von Teilen nicht immer die gleichen Termini benutzt werden.
  • Beispiele aus der aktuellen Praxis
  • Entschluss Terminologiearbeit einzuführen
  • Extraktion aller Benennungen
    (z.B. aus allen Dokumenten im Unternehmen)
  • Erkennung von Dubletten (welche Benennungen meinen das Gleiche?)
  • Gründung eines Terminologie-Arbeitskreises
  • Festlegen auf eine Benennung (im Arbeitskreis)
  • Festhalten der gewünschten und der nicht gewünschten Benennungen
    (in einer Datenbank, Excelliste … ggf. mit Definition und Übersetzungen)
  • Publizieren (die Datenbank muss für alle zugänglich sein)
  • Verpflichtend! (Die Einhaltung muss von der Geschäftsleitung gefordert werden).