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:

  • Anleitungen für intuitiv bedienbare Software brauchen meist keine Schritt-für-Schritt-Anleitung,
  • vielmehr müssen sie die Handlungsmöglichkeit aufzeigen,
  • bei manchen Funktionen ist die Erklärung der Parameter notwendig,
  • wieder andere lassen sich durch Regeln ausreichend charakterisieren. 
  • Insgesamt steht ein Set von 12 Strukturelementen zur Verfügung, die ein TR beherrschen muss.
  • Die Frage, ob handlungsorientiert oder funktionsorientiert muss neu diskutiert werden.
  • Auch ganz andere Ansätze wie Tutorials (ggf. als Screencast), FAQs oder Tipps müssen als Ergänzung einer systematischen Anleitung in die Überlegungen einbezogen werden.

Im Workshop werden die Strukturen und Definitionsbereiche gemeinsam entwickelt, erläutert und angewendet.
Durch die kleine Gruppengröße können eigene Beispiele und Fragestellungen direkt eingebracht, gelöst und geübt werden.

  • Grundsätzlicher Aufbau einer Software-Anleitung
  • Funktionen von Software-Anleitungen (was soll die Anleitung leisten?)
  • Die Leistungsbeschreibung als wichtige Grundinformation für den 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 (mit welcher Fragestellung nimmt der Anwender die Anleitung zur Hand?)
  • Ganze Anleitungen (unterschiedliche Ansätze, Zusammenwirken der Beschreibungskomponenten)
  • Weitere Fragestellungen (Fragestellungen der Teilnehmer)

Zielgruppe

erfahrene Technische Redakteure,

  • die Software-Anleitungen schreiben, 
  • die leicht und sicher formulieren wollen,
  • die mit mehr Systematik schnell zu guten Anleitungen kommen wollen.

Daten

  • nächste Termine:
    • Mainz: Mo 20.11.2017
    • München: Ende Januar 2018
  • Workshop von 9:00 bis 17:30
  • 490 € inklusive Getränke und Mittagessen (zzgl. MWSt.)
    (Sonderkonditionen für Studenten oder Selbstzahler sind möglich)
  • Bitte eigenen Laptop und Beispiele mitbringen
  • 3 – 10 Teilnehmer

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

Anmeldung, Fragen

Bitte setzen Sie sich zur Anmeldung mit mir in Verbindung.
Auch Ihre Fragen sind willkommen!
Dietrich Juhl
06132 / 972 02 02
dietrich@juhl.de

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

  • Pingback: Die erweiterte Handlungsanweisung – universell und flexibel – Juhl's Blog

  • Pingback: Seminare und Workshops – Juhl's Blog

  • 07.08.2017 um 14:41
    Permalink

    Guten Tag Herr Juhl,
    Ich schreibe Anleitungen für Anlagen und Pumpen die über Displays mit Menüs oder auch über grafische Displays verfügen.
    Ich beschränke mich üblicherweise darauf die einzelnen Menüs und deren Funktionen zu erklären ohne zur Handlung anzuweisen.
    Macht Ihr Workshop auch für mich Sinn, oder geht es hier eher um reine Software-Doku?

    Antwort
    • 08.08.2017 um 12:14
      Permalink

      Hallo Herr Geis,
      in meinem Workshop beziehe ich mich auf jede Art von Software, auch solche die „nur“ über ein Display läuft.
      Bisher war die Lehrmeinung, dass eine Erklärung der Menüs und Funktionen nicht ausreicht. Ich sehe das etwas anders:
      Nach wie vor sind klassische Handlungsanweisungen auch bei Software erforderlich, zumindest für den Einstieg eines neuen Anwenders für grundlegende Handlungen.
      Auch bei anderen Funktionen kann eine Schritt-für-Schritt-Anleitung notwendig sein.
      Bei intuitiv bedienbarer Software oder solche mit einem durchgängigen Bedienprinzip müssen wir andere Beschreibungsstrategien entwickeln, weil die Handlungsschritte für den Anwender meist klar sind. Hierfür habe ich die erweiterte Handlungsanweisung entwickelt, die flexibel die Informationslücken schließt. Welche Informationen benötigt werden, hängt von der Funktion ab. Der Schlüssel ist vielfach das Handlungsziel oder die Handlungsmöglichkeit.
      Aber auch die Beschreibung der Funktionen kann sinnvoll sein, wenn der Anwender bereits grundsätzlich handlungsfähig ist. Dann genügt es wahrscheinlich, ihm die Handlungsmöglichkeiten zu erklären und sogar „schmackhaft“ zu machen.
      Solche und ähnliche Überlegungen und Konzepte behandle und übe ich im Workshop.
      Klingt das für Sie interessant? Gerne können Sie mir auch Beispiele senden oder mich anrufen.

      Antwort
  • 13.10.2017 um 20:45
    Permalink

    Hallo Herr Juhl,
    vielen Dank für den tollen Workshop am heutigen Tag in Paderborn.
    Ich kann nur jedem empfehlen (nicht nur technischen Redakteuren, sondern auch jedem, der mit Bildung zu tun hat!) an diesem Workshop teilzunehmen.

    Ich habe sehr viel Know-How und moderne Ansätze mitnehmen können.

    Danke nochmals dafür und bis zum nächsten Mal.

    Antwort

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.