für verständliche Anleitungen
… verständlich schreiben.
Strukturen, Konzepte, praktische Tipps.
Das Buch „Software-Anleitungen“ ist fertig und bestellbar (bei mir im Shop sofort lieferbar).
Das Buch ist auch im Buchhandel erhältlich (ISBN 9783752815528).
Meine Workshopteilnehmer erhalten das Buch kostenlos.
Auch der Vorabkauf und die Anrechnung im Workshop sind möglich.
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.
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.
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).
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:
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:
Zielgruppe
Erfahrene Technische Redakteure,
Beim Termin in Nürnberg können Sie optional am Folgetag am Seminar „Visualisieren in Software-Anleitungen“ teilnehmen.
Die Inhalte:
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.
Dietrich Juhl
06132 / 972 02 02
dietrich@juhl.de
Tragen Sich sich unverbindlich in die Liste ein, damit ich Sie benachrichtigen kann, wenn ein Workshop in Ihrer Nähe stattfindet.
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 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?
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.:
Bei hardwaregeprägten Geräten hat sich mittlerweile die handlungsorientierte Anleitung durchgesetzt:
Bei Software ist die Situation häufig anders:
Aus meiner Sicht gibt es zwei Ansätze Softwareanwender zu befähigen:
Meine momentanen Strukturentwürfe stelle ich hier vor:
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?
Früher haben wir Anleitungen geschrieben, bei denen der Inhalt für das (lineare) Buch gegliedert war:
Diese Reihenfolge soll es dem Anwender ermöglichen seinen aktuellen Informationsbedarf zu decken, der inter- und intra-individuell durchaus unterschiedlich sein kann:
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).