RG Westfalen – Vortrag: „Die Schritt-für-Schritt-Anleitung ist tot …“

Termin: 25.07.2017, 15:00 – 18:00 Uhr
Ort: 
e-port-dortmund, Mallinckrodtstraße 320, 44147 Dortmund
auch für Nicht-Mitglieder
Referent: Dietrich Juhl

Die Schritt-für-Schritt-Anleitung ist tot,
es lebe die Schritt-für-Schritt-Anleitung und Alternative!

Technische Redakteure lieben Schritt-für-Schritt-Anleitungen. Sie sind leicht zu schreiben und häufig die beste Möglichkeit konkret zur Handlung anzuleiten. Manchmal sind solche Anleitungen aber zu lang, gängeln den versierten Anwender oder funktionieren gar nicht. Dietrich Juhl zeigt, welche alternativen Anleitungsmöglichkeiten es gibt, wann sie ebenbürtig oder gar besser sind und wie man sie optimiert. Auch der Schritt-für-Schritt-Anleitung haucht der Referent neues Leben ein, denn sie läßt sich in vielen Beziehungen optimieren oder auch variieren. Ein spannender Vortrag mit viel Systematik und praktischen Aspekten für alle, die „überlegt“ anleiten wollen.

Siehe auch: tekom Termine

Siehe auch hier im Blog:

 

Buchempfehlung: Every Page is Page One von Mark Baker

EPPO-Topics

 

Das Web hat unsere Art zu lesen stark verändert. Besonders die stete Verfügbarkeit und per Suche zugängliche Information verleitet uns punktuell nach einer Lösung unseres Problems zu suchen. Auch Leser von Bedienungsanleitungen lesen die Anleitung nicht von vorne nach hinten und verschaffen sich nicht einen Zugang über das Inhaltsverzeichnis, sondern suchen mit Google oder einer Volltextsuche gezielt nach einer Lösung zu genau einem Problem.

„Jede Seite, die diese Anwender betreten ist die erste Seite“, bringt es Mark Baker auf den Punkt. Und diese Seite muss funktionieren!

Mehr lesen

Zielgruppenanalyse und wie wir uns auf die Zielgruppe einstellen können

Zielgruppenanalyse, Zielgruppe, Technische Dokumentation

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.
Das obige Bild soll deutlich machen, wie umfangreich und unterschiedlich Fachwissen sein kann und wie wichtig es folglich ist, dieses Fachwissen zu kennen und zu berücksichtigen.

Welche Eigenschaften der Zielgruppe interessieren uns?

Wir schreiben Anleitungen für Anwender, die schon etwas wissen und können.
Um uns beim Schreiben auf diese Anwender einzustellen, interessiert uns besonders:

  • Welche Fachkenntnisse hat der Anwender? (Grundwissen, Fachtermini, Handlungswissen, Sicherheitsbewusstsein).
  • Welche Erfahrung hat er mit ähnlicher Technik bereits gemacht?

Mehr lesen

Voraussetzungen in Handlungsanweisungen

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

  • Es müssen mindestens zwei Benutzer angelegt sein (bei Windows, um einen Benutzer ohne Adminrechte zu definieren)
  • Das Bild muss im Format RGB vorliegen (bei Photoshop, um die Filter zu benutzen)
  • Der Pfad muss geschlossen sein (bei Photoshop, um die Pfadfläche zu füllen)
  • Sie müssen über ein Bankkonto verfügen und VR-Net-Key und Passwort vorliegen haben.

Mehr lesen

Schritt-für-Schritt – oder geht es auch anders?

Step by Step, Karikatur von Tiki Küstenmacher
Zeichnung: Tiki Küstenmacher

Die Schritt-für-Schritt-Anleitung ist die konkreteste Form, einen Anwender zu einer Handlung anzuleiten. Das passt in vielen Fällen. In anderen häufigen Fällen passt es aber nicht und wir fragen uns, welche Alternativen es gibt.

Die Schritt-für-Schritt-Anleitung ist bei TRs beliebt und wird heute in den meisten Anleitungen konsequent angewendet, weil sie eine klare Strukturvorgabe hat, sie leicht zu schreiben ist und aus Anwendersicht leicht nach zu handeln ist. Bei manchen Handlungen scheint die Schritt-für-Schritt-Anleitung aber übertrieben zu sein, ist umständlich oder scheint gar nicht zu funktionieren. Anhand von ein paar Beispielen möchte ich zeigen, welche Alternative denkbar sind.

Mehr lesen

Zehn Schritte zur Software-Anleitung

Software-Anleitung schreiben - Software Anleitung erstellen - Muster

Anleitungen für Software sollen den Anwender in die Lage versetzen, sich selbstständig einzuarbeiten und bei Bedarf schnell die notwendigen Informationen zu finden.
Das obige Bild visualisiert die 10 Erstellungsschritte. Das Bild gibt es als Postkarte, zu bestellen bei juhl.de/buecher.)
Die folgende Darstellung soll einen Überblick über die wesentlichen Prozessschritte geben.

Software Anleitungen strukturiert erstellen, schreiben

Software-Anleitungen können handlungsorientiert oder funktionsorientiert geschrieben werden. Eine Auszeichnung mit XML ist optional. Wichtig ist vor allem die Verständlichkeit. Wie kann die Software-Anleitung gegliedert werden? Wie lassen sich Handlungsanweisungen strukturiert schreiben? Sind Schritt-für-Schritt-Anleitungen sinnvoll?

Mehr lesen

Etwas mehr Selbstbewusstsein 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

Blogs in Richtung TD (Links)

Hier ein paar Blogs zum Thema „Technische Dokumentation“ und ähnlich.

Blog der Firma itl: Blog

Blog der Firma Doctima mit Prof. Dr. Markus Nickl: Blog

Blog der Hochschule Luzern zum Thema „Verständlich kommunizieren“: Blog

Blog der Firma Handbuch Experten: Blog

Blog der Firma tecteam: Blog

Blog von Schmeling+Consultants: Blog

Blog der Firma Parson: Blog

Blog der Firma Fritz-Communikation mit Beiträgen zur Terminologie: Blog

… wird noch ergänzt …

Nicht lineare Dokumentation – was wird anders?

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

  • 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 decken, der inter- und intra-individuell 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?