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.

Buch: Software-Anleitungen verständlich schreiben, 5/2018

Workshop: Software-Anleitungen verständlich schreiben

Workshop „Software-Anleitungen“

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

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. Mehr lesen

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?