Software Anleitungen

icons02

Immer mehr Technik ist Software oder software-gesteuert. Dabei wird die Leistung immer umfangreicher und die Bedienung häufig immer leichter. Herkömmliche Anleitungskonzepte stoßen an ihre Grenzen, vor allem wirkt die beliebte Schritt-für-Schritt-Anleitung langatmig und unterfordernd.

In dieser Kategorie stelle ich Konzepte vor, wie Handlungen oder Funktionen flexibel strukturiert werden können. Grundlage ist immer noch die Juhl’sche Handlungsanweisung, die sich für Software aber ganz anders und stark erweitert darstellt. Sie läßt sich sowohl für handlungsorientierte als auch funktionsorientierte Anleitungen heranziehen und kann durch Weglassen, Betonen oder „nur erwähnen“ an den jeweiligen Bedarf angepasst werden.

Hier im Blog stelle ich meine Überlegungen zur Diskussion und hoffe auf fachlichen Austausch zu diesem wichtigen Thema.

Workshop

In einem eintägigen Workshop haben Sie Gelegenheit, die angebotenen Konzepte im Team weiter zu entwickeln und auf Ihre eigenen Fälle anzuwenden. Dieser arbeitsintensive Workshop richtet sich an TRs, die bereits Software-Anleitungen geschrieben haben.

Buch dazu

Nebenbei entsteht ein neues Buch zu Software-Anleitungen, mit Konzepten und Beispielen ähnlich meinem ersten Buch (Technische Dokumentation, praktische Anleitungen und Beispiele, 3. Auflage 2015, Springer-Verlag).

Workshop „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“

Workshop Software-Anleitungen verständlich erstellen, Dietrich Juhl, Systematik, skalierbare Strukturen

Nächste Termine: 20.11. Mainz, München Ende Jan. 2018

Anleitungen für Software sind anders, weil häufig sehr viele Features vermittelt werden müssen und „viel Anleitung“ durch intuitive Bedienkonzepte überflüssig wird. Um dem gerecht zu werden, müssen mit neuen Überlegungen und Konzepten, Strukturen gefunden werden, die sich flexibel an die Eigenart der Software und der Funktionen anpassen lassen. Das vom Autor entwickelte Modell bietet mehr als 10 systematische Beschreibungsansätze, die richtig kombiniert zur Handlung anleiten oder mit Funktionswissen Kompetenz beim Anwender aufbauen.

„Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“ wendet sich an alle Technischen Redakteure, die ihren Schreibstil mit systematischen Überlegungen unterfüllen wollen, um leichter und schneller zu guten Software-Anleitungen zu kommen.

In diesem arbeitsintensiven Workshop erlernen und üben Sie neue Beschreibungsmodelle an Ihren eigenen Beispielen. So können Sie die systematischen Modelle sofort erproben und durch unmittelbares Feedback optimieren.

Inhalt

Das zielorientierte Schreiben, wie es Dietrich Juhl in seinem Buch entwickelt, hat sich als der Schlüssel für strukturiertes, verständliches Schreiben von Anleitungen bewährt.
Speziell für Software-Anleitungen hat der Autor neue Strukturen entwickelt, die sich flexibel an den sehr unterschiedlichen Bedarf moderner Software anpassen lassen:

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

Die erweiterte Handlungsanweisung – universell und flexibel

erstelle eine Handlungsanleitung für Software, leite zur Handlung an. Struktur für Software-Anleitung, Template, Übrschrift, Ziel der Handlung, Anzeigen und Bedienelemente, Software-Konzept, Voraussetzungen, Aufruf der Funktion, Überblick über die Handlung, Step by Step, Parameter, Regeln, Handlungsergebnis, Ausblick

Um in Software zum Handeln anzuleiten wurde die altbewährte Handlungsanweisung um viele Punkte erweitert.
Diese Struktur ist Grundlage für alle Handlungsanweisungen bei SW und kann individuell durch Weglassen und Betonen einzelner Punkte flexibel für sehr unterschiedliche Funktionen und Handlungen eingesetzt werden. (Das obige Bild gibt es als Postkarte, zu bestellen bei juhl.de/buecher.)

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

Handlungs- oder funktionsorientiert?

handlungsorientiert funktionsorientiert

Bei hardwaregeprägten Geräten hat sich mittlerweile die handlungsorientierte Anleitung durchgesetzt:

  • Die Beschreibung der Bedienelemente oder von „Aufbau und Funktion“ genügt dem Anwender nicht, um die notwendigen Handlungen auszuführen.
  • Vielmehr beschreiben wir heute einzelne Handlungen als eigene Kapitel, die einzeln vom Anwender gehandelt (Schritt für Schritt) und dabei erlernt werden können. Die Handlungsanweisung (Schritt für Schritt, gerne als Juhl’sche Handlungsanleitung 😉 ) hat sich dabei in vielen Fällen bewährt.

Bei Software ist die Situation häufig anders:

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?

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