Neue Blog-Kategorie: Software Anleitungen

icons02

Viele Leser meines Buches (Juhl, Technische Dokumentation – Praktische Anleitungen und Beispiele) vermissen spezielle Konzepte und Strukturen für Software Anleitungen.

Bisher habe ich immer gefunden, dass meine Strukturen gut auf Software Anleitungen angewendet werden können.
Meine jüngeren Überlegungen führen zu neuen Lösungen. Grundlage ist immer noch die Juhl’sche Handlungsanweisung, die sich für Software aber viel anders und 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 einzelne Handlungen oder Funktionen angepasst werden.

Buch dazu

„Software Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“ soll ein neues Buch heißen, in dem ich die oben genannten Überlegungen weiter ausführe.
Hier im Blog möchte ich einige Grundlagen schon zur Diskussion stellen.

Seminar dazu

Ich biete jetzt schon Seminare zu diesem Thema an, in dem ich mit den Teilnehmern die Strukturen erarbeite und auf ihre Beispielen anwende und übe.

  • Termine: ab 1.2.2017 in Stuttgart

 

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

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 oder der Funktion 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 diese 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

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

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