Wem folgen wir: Mainstream oder Anspruch?

Der tödlich verunglückte Fahrer des Tesla hätte die Anleitung lesen müssen … (Link zum heise-online-Artikel)
führt mich zu einer grundsätzlichen Betrachtung.

Als Gesellschaft stehen wir immer wieder vor der Frage, ob der Mainstream oder ein auf höherer Ebene formulierter Anspruch das Geschehen bestimmen soll. Am Beispiel Fernsehprogramm:

  • Die öffentlich Rechtlichen versuchen einen gewissen qualitativen Anspruch zu erhalten.
  • Die Privaten folgen dem Mainstream: Gut ist, was gefällt, es zählt nur die Einschaltquote.

Beide Seiten haben ihre Vor- und Nachteile, die ich hier nicht diskutieren möchte.
Meines Erachtens geht es um eine Diskussion, die wir allgemein führen müssen.
Auch in der Technik sind wir betroffen:

  • Müssen wir Technik so konstruieren, dass jeder damit klar kommt, ohne die Anleitung zu lesen und ohne etwas zu lernen.  Mehr lesen

Etwas mehr Selbstbewustsein bitte

Wenn TD-Kollegen unser Metier als „notwendiges Übel“ darstellen oder den Zweck von Technischer Dokumentation auf die „Abwendung juristischer Ansprüche“ reduzieren, geht das m.E. völlig an der Sache vorbei und verkennt, was wir heute leisten und vielleicht noch mehr leisten können.

Gute TD ist die zentrale Festschreibung des aktuellen Entwicklungsstandes und das Zur-Verfügung-stellen der Informationen für alle Beteiligten in allen Produktlebensphasen. Gut gemacht erspart TD viele Stunden der Verwirrungen, Rückfragen,  Mehr lesen

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

Strukturen für Handlungs- und Funktionsbeschreibung

Aus meiner Sicht gibt es zwei Ansätze Softwareanwender zu befähigen:

  • Handlungsanweisung
  • Funktionsbeschreibung

Meine momentanen Strukturentwürfe stelle ich hier vor:

Handlungsanweisung / Funktionsbeschreibung

Aus meiner Sicht muss man als TR alle Strukturelemente beherrschen
und kann sie flexibel je nach Bedarf zu einer Handlungsanweisung oder Funktionsbeschreibung zusammen setzen.

Wie  Sie sehen sind beide Strukturen sehr ähnlich.

Was meinen Sie dazu?

Seminare und Workshops

Ab sofort biete ich  Seminare und Workshops zum verständlichen Schreiben an.

  • Personal Training „verständlich schreiben“
    Intensivtraining in kleinen Gruppen. Preiswert.
    … mehr
  • Workshop „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“
    Neue Strukturen und systematische Ansätze zur Vermittlung von Wissen und Handlungswissen bei Software.
    Ein-Tagesseminar in Stuttgart.
    … mehr

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

Personal Training „verständlich schreiben“

Personal Training "verständlich schreiben" Anleitungen

„Verständlich schreiben“ ist sicher die wesentliche Aufgabe eines Technischen Redakteurs.
Das zielorientierte Schreiben, wie ich es in meinem Buch (Erstauflage 2002, 3. Auflage 2015) beschrieben habe, hat sich dabei als hervorragende Methode erwiesen, sich auf die Aufgaben einer Anleitung zu konzentrieren und den Text darauf zu strukturieren und zu optimieren.

In diesem Workshop haben Sie die Möglichkeit diese Methode, mit allem was dazu gehört, zu erlernen, zu festigen, zu hinterfragen und auf Ihr Fachgebiet anzuwenden. Durch die geringe Teilnehmerzahl und den tragbaren Preis können Sie intensiv genau Ihre Fragen beantworten, Methoden diskutieren und das Schreiben mit sofortigem Feedback üben. Mehr lesen

Die erweiterte Handlungsanweisung – universell und flexibel

Um in Software zum Handeln anzuleiten habe ich die altbewährte Handlungsanweisung um viele Punkte erweitert.
Diese Struktur soll Grundlage für alle Handlungsanweiungen bei SW sein
und kann individuell durch Weglassen und Betonen einzelner Punkte flexibel für sehr unterschiedliche Funktionen und Handlungen eingesetzt werden.

Die erweiterte Handlungsanweisung für Software sieht folgendermaßen aus:

Je nach Anforderung können die einzelnen Elemente skaliert werden
(was ich im Bild durch den Equalizer andeuten will), z.B.:

Mehr lesen