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

Jetzt buchen: „Software-Anleitungen verständlich schreiben – Konzepte, Strukturen, Beispiele“

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

Nächste Termine:
Freitag, 07. Juni 2019, in Ingelheim
Montag, 24. Juni 2019 in Nürnberg
Dienstag, 25. Juni 2019 (Visualisieren) in Nürnberg

Anleitungen für Software stellen besondere Anforderungen an Technische Redakteure. Denn oft machen hier intuitive Bedienkonzepte „viel Anleitung“ überflüssig. Stattdessen gilt es, Features und Funktionen zu erklären. Mit den herkömmlichen Schritt-für-Schritt-Anleitungen kommen Sie nicht weit. Sie brauchen neue Konzepte und Strukturen, die sich flexibel an die Eigenarten der jeweiligen Software anpassen lassen. Im Workshop stelle ich Ihnen mehr als 10 systematische Beschreibungsansätze vor. Richtig kombiniert, leiten Sie den Anwender zur Handlung an oder vermitteln ihm Funktionswissen. Bedarfsgerecht, nachvollziehbar und auf den Punkt.

Der intensive Workshop richtet sich an Technische Redakteure, die Software-Anleitungen schneller, leichter und systematischer erstellen wollen. Dabei bleibt es nicht bei der Theorie. Sie üben die neuen Beschreibungsmodelle an eigenen Beispielen, können das Erlernte sofort erproben und erhalten direktes Feedback.

Die Inhalte

Das von mir entwickelte zielorientierte Schreiben hat sich als der Schlüssel für strukturiertes, verständliches Schreiben von Anleitungen bewährt. Ein großer Vorteil: Das strukturierte Vorgehen lässt sich flexibel an den unterschiedlichen Bedarf moderner Software anpassen.

Die Kernthesen aus Buch und Workshop:

  • Intuitiv bedienbare Software braucht meist keine Schritt-für-Schritt-Anleitung.
  • Stattdessen gilt es, Handlungsmöglichkeit aufzuzeigen, Funktions-Parameter zu erklären und Funktionen durch ihre Regeln zu charakterisieren.
  • Insgesamt steht ein Set von 12 Strukturelementen zur Verfügung, die ein Technischer Redakteur beherrschen muss.
  • Auch die funktionsorientierte Beschreibung ist bei gut geordneter Software möglich.
  • Ansätze wie Tutorials (ggf. als Screencast), FAQs oder Tipps können als Ergänzung einer systematischen Anleitung in die Überlegungen einbezogen werden.

Im Workshop werden die Strukturen und Definitionsbereiche gemeinsam entwickelt, erläutert und angewendet. In der kleinen Gruppe können eigene Beispiele und Fragen eingebracht, gelöst und geübt werden. Im Einzelnen geht es um diese Punkte:

  • Aufbau und Zielstellung der Software-Anleitung
  • Leistungsbeschreibung: wichtige Grundinformation für Anwender
  • Vermittlung von Softwarekonzepten
  • EPPO-Ansatz (“Every Page is Page One” von Mark Baker)
  • Anleiten zum Handeln (flexible Skalierung einer erweiterten Handlungsanweisung)
  • Funktionsbeschreibungen (systematische Erklärung von Funktionen, bedarfsweise mit Handlungsanweisungen)
  • Zusammenspiel von Anleitung und Referenzteil, zwischen Handlungsanleitungen und Funktionsbeschreibungen
  • Andere Ansätze (Tutorials, Vermittlung von Systematik, FAQs, Tipps)
  • Use Cases einer Anleitung (Welche Erwartung hat der Anwender?)
  • Ganze Anleitungen (Verschiedene Ansätze, Zusammenwirken der Beschreibungskomponenten)
  • Weitere Fragestellungen (Fragen der Teilnehmer)

Zielgruppe

Erfahrene Technische Redakteure,

    • die Software-Anleitungen schreiben,
    • die leicht und sicher formulieren wollen,
    • die mit mehr Systematik schneller gute Anleitungen erstellen möchten.

Visualisieren in Software-Anleitungen

Beim Termin in Nürnberg können Sie optional am Folgetag am Seminar „Visualisieren in Software-Anleitungen“ teilnehmen.

Die Inhalte:

  • Von der didaktischen Absicht zur Bildfunktion.
    Neue Erkenntnisse zum zielorientierten Visualisieren.
  • Darstellungsarten
    Die Palette an möglichen Bildern, vom Screenshot zum Blockdiagramm
  • Inhalte visualisieren
    Praktische Ansätze und Beispiele Inhalte durch Bilder verständlich zu machen.

Fachbuch inklusive

Alle Teilnehmer des Workshops erhalten ein Gratis-Exemplar des Fachbuchs „Software-Anleitungen verständlich schreiben. Konzepte, Strukturen, Beispiele“ vom Autor und Workshop-Leiter Dietrich Juhl. Wurde das Buch vorher erworben, wird dies bei der Workshop-Buchung angerechnet.

Daten

  • nächste Termine:
  • Freitag, 07. Juni 2019 in Ingelheim
  • Montag, 24. Juni 2019 in Nürnberg
  • Dienstag, 25. Juni 2019 in Nürnberg (Visualisieren)
  • 490 € Workshop „Software-Anleitungen“ von 9:00 bis 17:00
  • 250 € „Visualisieren“ von 9:00 bis 14:00 (optional, auch einzeln buchbar)
  • Bitte eigenen Laptop und Beispiele mitbringen
  • 3 – 10 Teilnehmer
  • Alle Preise inklusive Getränke und Mittagessen (zzgl. MWSt.)
  • (Sonderkonditionen für Studenten oder Selbstzahler sind möglich)

Anmeldung und Fragen

  • Bitte schreiben Sie mir oder rufen Sie mich an.
  • Auch Ihre Fragen sind willkommen!

Dietrich Juhl
06132 / 972 02 02
dietrich@juhl.de

Interesse am Workshop

Tragen Sich sich unverbindlich in die Liste ein, damit ich Sie benachrichtigen kann, wenn ein Workshop in Ihrer Nähe stattfindet.

Interesse an:
Vorname Name:
Email:
Bevorzugter Veranstaltungsort:
Nachricht an Juhl (falls gewünscht):

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 Buch von Dietrich Juhl wendet sich an erfahrene Technische Redakteure, die Anleitungen für moderne Software kurz und verständlich schreiben wollen. Es entwickelt neue Konzepte und zeigt Strukturen und Beispiele.

Hardcover, 270 Seiten, 1. Auflage 04/2018. ISBN: 978-3752815528
Erhältlich im Buchhandel und im Juhlshop.


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