Jetzt buchen: „Software-Anleitungen verständlich schreiben“
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
- der nächste Termin:
- im Februar 2020 in Nürnberg
- 490 € Workshop „Software-Anleitungen“ von 9:00 bis 17:00
- 250 € „Visualisieren“ von 9:30 bis 14:00 (optional, auch einzeln buchbar)
- Bitte eigenen Laptop und Beispiele mitbringen
- 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
Pingback: Die erweiterte Handlungsanweisung – universell und flexibel – Juhl's Blog
Pingback: Seminare und Workshops – Juhl's Blog
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?
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.
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.
Interesse an einem Erfahrungsbericht?
Im Maschinenbau tätig, übernehmen wir im Lauf des Jahres die Dokumentation der Maschinensteuerung und zusätzlicher Verwaltungssoftware.
Vor 8 Jahren das letzte Mal im Bereich der Software-Dokumentation tätig, wollte ich mich zuerst einmal auf einen aktuellen Stand bringen.
Mich interessierte vor allem, ob es eine Methodik gibt, mit der ich die anstehenden Aufgabe möglich konsistent lösen kann. Ende April 2019 habe ich deshalb diese Schulung besucht.
Herr Juhl bietet in seiner Schulung eine Methodik zur Software-Dokumentation an.
Diese Methodik scheint mir sehr gut geeignet alle unsere Aufgaben bewältigen zu können.
Denn innerhalb der Methodik bleibt genügend Flexibilität, um
– die Dokumentation genau auf den spezifischen Fall abzustimmen,
– möglichst minimalistisch beschreiben zu können und
– trotzdem die gesamte Software nach der gleichen Methodik zu beschreiben.
Damit haben wir einen sehr guten Leitfaden für die gesamte Abteilung und für den Kunden erhöht sich die Konsistenz.
Sieht zwar monoton aus, ist für den Kunden aber bei allen Softwareprodukten sehr einfach zu verstehen.
Der Kunde weiss bei der 3. Funktion bereits nach welche Methodik die Dokumentation aufgebaut ist.
Einzig bei der Verwendung von Screenshots und Bilder müssen wir sicher zurückstecken.
Da kein Programm eine Bearbeitung eines Bildes via Makro schnell und automatisch auf ein jede beliebige Sprache anwenden kann, müssen wir die Verwendung der Screenshots eingeschränkt anwenden.
Fazit:
Wer eine Methodik sucht, um konsistent eine Menge Software-Dokumentation zu erstellen (Programmbeschreibung, Funktionsbeschreibung, Handlungsabläufe) wird bei der Schulung eine Methodik kennenlernen, die sehr viele Möglichkeiten bietet.
Hervorheben möchte ich hier die bunte Zusammensetzung der Teilnehmer. Dadurch erfährt man von weit entfernten Problemstellungen, die mich heute noch nicht treffen, aber später auch aufkommen können. Dies bietet interessante Ansätze, um die eigene Software-Dokumentation bereits während der Erstellung für die Zukunt zu optimieren.
Vielen Dank nochmals an Herrn Juhl. Sehr interessante Veranstaltung, sehr gute Fachgespräche und ein hervoragendes Rüstzeug für spätere Aufgaben.
Hallo Herr Juhl,
vielen Dank für den Workshop „Software-Anleitungen verständlich schreiben“ in Ingelheim!
Ich werde das Erlernte in meine Anleitungen einfließen lassen.
Auf das Seminar „Technik visualisieren“ freue ich mich schon jetzt.