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.

Buch Dietrich Juhl, Software-Anleitungen verständlich schreiben, 2018

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?

1. Schätze die Zielgruppe ein

Bevor Du schreibst, solltest du ganz kurz über Deine Anwender nachdenken.

  • Ist es nur eine Anwendergruppe?
  • oder sind es mehrere Anwender, die unterschiedliche Arbeiten ausführen müssen/können? (z.B. Admin, User, Rolle 1, Rolle 2)
  • Welche Kenntnisse und Erfahrungen haben die Anwender? (je Gruppe)
  • Erstelle einen Steckbrief eines typischen Anwenders (Persona) und hänge den auf („für den schreibe ich!“)

2. Betrachte die Use Cases

Wenn Du einschätzen kannst, wie der Anwender die Anleitung benutzen wird, kannst Du die Informationen gezielt dafür schreiben.
Zum Beispiel:

  • Programm installieren:
    Dafür kannst Du eine spezielle Anleitung schreiben, mit der der Anwender die Software installieren kann.
  • sich einarbeiten:
    Was würdest Du jemand zeigen, der die Software das erste Mal sieht und sich einarbeiten will?
  • Mit der Software arbeiten:
    Welche Informationen könnten dem Anwender in den ersten Tagen helfen (z.B. Liste mit Shortcuts)?
  • bei Bedarf nachschlagen:
    Welche Frage könnte der Anwender haben?
  • Weiter lernen:
    Welche Informationen sind interessant, wenn der Anwender die Grundfunktionen schon kennt,
    aber die Software noch effektiver nutzen will?

Stelle eine Liste mit den normalen Use Cases auf.

3. Beschreibe den Nutzen

Noch bevor der Anwender die Software startet oder benutzt, will er wissen, was die Software leistet.
Erst wenn er diesen Nutzen versteht, ist er motiviert sich die Software anzusehen.
Richtig gewonnen hast Du, wenn Du ihn so gut motivierst, dass er sagt: „super, das will ich!“Beschreibe:

  • was ist das für eine Software? (nenne einen Oberbegriff, z.B. Emailverwaltung, Buchhaltungssoftware …)
  • welchen Nutzen hat der Anwender davon? (Du kannst die Emails ordnen und Konversationen ansehen, Du kannst die Ein-/Ausgaben erfassen und eine Steuererklärung machen)
  • vergiss nicht den Normalnutzen zu nennen!
  • Erkläre, was das Besondere an Deiner Software ist.

4. Erkläre die Bedienoberfläche

Erkläre (kurz) was wo angezeigt wird, wie man Funktionen aufruft oder zu anderen Bildschirmen kommt, damit der Anwender sich auf Deinem Screen zurecht findet und die Bedieneinheiten einen Namen haben (damit Du diese Namen später benutzen kannst).

5. Zeige die normale Bedienung in einem Tutorial

Am besten kannst Du die normale Bedienung an einem Beispiel zeigen.

  • Suche ein geeignetes Beispiel aus, an dem du die wesentlichen normalen Arbeiten erklären kannst.
  • Führe den Anwender Schritt für Schritt durch dieses Beispiel.
    Am besten ist es, wenn er das direkt machen kann.
  • Erkläre dabei, warum das so gemacht wird (Hintergrund der Handlung, Software-Konzepte …)
  • Zeige nur die grundsätzliche Bedienung (z.B. neue Datei, Elemente anlegen, editieren, speichern unter, drucken)
  • Du musst nicht die ganze Software zeigen! sondern nur die wesentlichen Schritte.
  • Statt einer schriftlichen Anleitung kannst Du das auch in einem Screencast zeigen
    (gefilmte Screens, vorzugsweise mit gesprochener Beschreibung, als Video)

6. Leite zu den wichtigen Handlungen an

Meistens musst Du zu ein paar wenige Handlungen Schritt-für-Schritt anleiten.

  • Vor allem die normalen, grundlegenden Handlungen erlernt der Anwender am besten, wenn Du die als Handlungsanweisung schreibst.
    (siehe auch Juhl’sche Handlungsanweisung und erweiterte Handlungsanweisung).
  • Häufig ist die Handlungsmöglichkeit die wichtigste Information für den Anwender. Er weiß dann was geht, ist motiviert und findet vielleicht schon selbst den richtigen Bedien-Weg.
  • Wenn die Software weitgehend intuitiv benutzbar ist, kannst Du möglicherweise die Schritt-für-Schritt-Anleitung weglassen.

7. Erkläre alle Funktionen

Wahrscheinlich stecken in Deiner Software Features, die Du dem Anwender erst nahe bringen musst.
Auch wenn Du denkst, dass Deine Software selbsterklärend ist, kennt der Anwender diese Funktionen noch nicht.
Du kannst alle Funktionen systematisch erklären.

  • Benutze die Ordnung Deiner Software (z.B. Hierarchie des Menüs).
  • Erkläre jede Funktion systematisch.
  • Benutze dazu die Struktur der Funktionsbeschreibung.

8. Mach die Anleitung rund (Titel, Inhaltsverzeichnis …)

Wenn Du das getane Werk ansiehst, hast Du möglicherweise schon die benötigte Information für die Software-Anleitung zusammen gestellt
und kannst die Kapitel zu einem Buch zusammen stellen.Wichtige Elemente musst Du noch ergänzen:

  • Titelblatt (mit den wichtigen Informationen)
  • Impressum (Hersteller, Anschrift, Kontaktinformationen, Versionsnummer, Copyright)
  • Versionsgeschichte (Datum, Versionsnummer, was wurde geändert?)
  • Inhaltsverzeichnis
  • und vieles mehr …
  • siehe auch Strukturflyer.

9. Fertig

Betrachte Dein Werk noch mal, denke an die Zielgruppe
und stell Dir vor, wie sie in den Use Cases mit Deiner Anleitung zurecht kommt.

10. Veröffentlichen

Wichtig ist es, dass der Anwender die Anleitung zur Software direkt findet.

  • Du kannst die Anleitung als Datei mit der Software ausliefern (z.B. in der zip-Datei)
  • Du kannst von der Software zur Anleitung verlinken (z.B. im Menü: Hilfe > Anleitung)

Du musst entscheiden, in welchem Format Du die Anleitung liefern willst.

  • PDF ist einfach herzustellen, leicht zu verteilen, alle können damit umgehen und es bei Bedarf auch ausdrucken.
  • CHM ist ein super Format für Windows. Es enthält alles was eine gute Hilfe braucht: Inhaltsverzeichnis, schnelle Volltextsuche, Favoriten, gestalteter Text mit Bildern.
  • HTML im Internet ist gut und kann wie eine CHM-Hilfe aussehen. Standardmäßig gibt es dann aber keine Volltextsuche, die müßte extra programmiert werden.
  • Responsives HTML kann auf auch auf mobilen Devices benutzt werden.
  • siehe auch Dietrich Juhl, go mobile, 2017

Schreibe einen Kommentar

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