Was ist für Software-Anleitungen relevant?

Unterschiede zwischen Anleitungen für Hardware und Software kennen, verstehen und nutzen.

Was ist bei Software-Anleitungen anders?

Für Software-Anleitungen haben Technische Redakteure oft verschiedene Zielgruppen mit schwankendem Wissensstand und unterschiedlichen Erwartungen. Gleichzeitig ist Software deutlich abstrakter als andere Produkte; die richtige Herangehensweise ist daher entscheidend.

Mittlerweile arbeiten wir fast überall mit Software – im Arbeits-Alltag und auch immer stärker Zuhause. Abgesehen von PC / Laptop, Tablet oder Smartphone, umgibt Software uns auch in Form von Maschinensteuerungen, integrierter Software wie in Medizinprodukten (EKG, Diagnose-Assistent usw.) und einzelnen Anwendungen wie Online-Shops, Nachschlagewerken, etc.

Gemeinsam haben sie, dass die Zusammenhänge im Innern für den Anwender nicht sichtbar sind. Bei anderen (Hardware-)Produkten können Funktionen in der physischen Welt mehr oder weniger direkt beobachtet werden: Das Flugzeug wird gestartet; daraufhin höre ich den Antrieb anspringen und sehe die Rotorblätter beginnen sich zu drehen.
Bei Software drücke ich einen Knopf oder eine Schaltfläche und sehe lediglich das Ergebnis – die rechnerische Leistung und Funktionalität im Hintergrund bleibt mir verborgen.

Gleichzeitig bietet Software den Vorteil, dass fast alle Funktionen gefahrlos ausprobiert werden können und reversibel sind. Das ist gut so, denn oft gibt es sehr viele Funktionen und optionale Features.
Jeder kennt es vermutlich: bis man sich wirklich tief in eine Software eingearbeitet hat, vergehen manchmal viele Wochen und Monate, bei sehr komplexen sogar Jahre.

Wichtig ist für das Software-Handbuch, dem Anwender das Software-Konzept so nah zu bringen, dass er die Zusammenhänge erkennt.

Was müssen Technische Redakteure bei Software-Anleitungen beachten?

Zum Einen muss man sich überlegen, was die Anleitung leisten soll. Welche Zielgruppe(n) gibt es? Ist eine Anleitung für alle Zielgruppen sinnvoll oder sollten beispielsweise Administratoren und "einfache" Anwender ein unterschiedliches Handbuch erhalten? Schließlich verwenden Anwender das Handbuch für verschiedene Fragestellungen.

Zum Anderen muss die Anleitung vollständig sein und für alle "denkbaren" Fragestellungen zufriedenstellende Antworten liefern. Die Technische Redaktion muss also Use Cases definieren und die Inhalte für diese aufbereiten.

Diese Überlegungen sollten weitgehend abgeschlossen sein, bevor mit dem Schreiben begonnen wird. Nur so können Struktur und Gliederung passend zu den vorhandenen Use Cases angelegt werden und den Anwender später bei Orientierung und Navigation optimal unterstützen.

Sie möchten von unserer Expertise im Erstellen von Software-Anleitungen profitieren?

Jetzt Unterstützung für Ihre Software-Anleitung anfordern!

Was gibt es außer der Schritt-für-Schritt-Anleitung?

Die bekannteste Art der Handlungsanweisung ist die Schritt-für-Schritt-Anleitung. Sie definiert sich durch Zielangabe, Einzelschritte der Handlung und ein Ergebnis.

Allerdings ist sie für Software-Anleitungen nur teilweise geeignet, da es hier entweder wenige Einzelschritte oder viele verschiedene Handlungsmöglichkeiten gibt, oder alles Erforderliche steht bereits am Display, z. B. beim Ausfüllen von Formularen. In diesen Fällen bläht die Schritt-für-Schritt-Anleitung das gesamte Dokument möglicherweise unnötig auf.

Das Zauberwort lautet: Alternative Handlungsanweisung.
Manchmal genügt es, dem Anwender den Sinn einer Funktion zu erklären oder Bedienelemente oder Parameter genauer zu beschreiben. Für komplexe Sachverhalte kann es sich auch lohnen ein Beispiel durchzuspielen usw.

Dabei ist es oft nicht wichtig, wie genau die Erklärung dargestellt wird. Wichtig ist, dass es vor allem verständlich und der Situation angepasst ist.

Wenn Sie mehr über die Strukturierung von Software-Anleitungen, alternative Handlungsanweisungen und den Einsatz von Screenshots wissen möchten, besuchen Sie unseren Workshop Software-Anleitungen verständlich schreiben - Konzepte, Strukturen, Beispiele.