Benutzerhandbuch-Vorlage, mit einem fertigen Beispielkapitel

Was ein Benutzerhandbuch enthält

Fünf Teile, jeder beantwortet eine Frage, mit der man das Handbuch aufschlägt. Der Aufgabenteil ist der größte; die anderen bleiben kurz.

Um die fünf Teile herum steht die Titelei: ein Titel, die Produktversion und die Handbuchversion mit Datum, das Inhaltsverzeichnis und die Hinweise. Ein Hinweis ist alles, was Daten oder Geld kosten oder jemanden verletzen kann; er steht vorn und noch einmal in der Aufgabe, in der es passiert.

Ordnen Sie die Aufgaben nach dem, was der Nutzer erledigen will, nicht nach Menü oder Modul. Der Microsoft Writing Style Guide verlangt Überschriften, die sagen, wobei die Anleitung hilft, in gleicher Form: „Rechnung stornieren“, „Bericht exportieren“, nicht „Rechnungsaktionen“ neben „Das Exportieren“.

Zwei Normen decken das Feld ab. ISO/IEC/IEEE 26514:2022 beschreibt den Entwicklungsprozess für alle, die Informationen für Nutzer von Software gestalten und erstellen. IEC/IEEE 82079-1:2019 legt Grundsätze und allgemeine Anforderungen an Gebrauchsanleitungen für Produkte aller Art fest.

Benutzerhandbuch-Vorlage

Die Vorlage lässt sich ohne Anmeldung herunterladen. Sie enthält die Titelei mit einem Inhaltsverzeichnis als Feld, die fünf Teile, einen Aufgabenblock, der einmal pro Ziel kopiert wird, und einen optionalen Anhang für ein physisches Produkt.

• Titeltabelle: Produkt und Version, Handbuchversion und Datum, für wen es geschrieben ist, eine verantwortliche Person.
• Wichtige Hinweise: Daten oder Geld in Gefahr; den Teil löschen, wenn es nichts gibt.
• Überblick: drei kurze Überschriften. Zuletzt schreiben.
• Einrichtung: Voraussetzungen, eine Rollentabelle, die erste Anmeldung als nummerierte Schritte.
• Kapitel und Aufgabenblock: ein Zieltitel, wann man es tut, Bevor Sie beginnen, Schritte, Ergebnis, Wenn es nicht klappt. Den Block einmal pro Ziel kopieren.
• Fehlerbehebung, Glossar, Änderungsliste: Tabellen, eine Zeile pro Fehler, Begriff oder Version.
• Anhang A: bestimmungsgemäße Verwendung, Warnhinweise, Modell- und Seriennummer, technische Daten, Wartung, Entsorgung, Kundendienst und Garantie. Optional; bei Software löschen.

In Word haben Teile und Kapitel die Formatvorlage Überschrift 1, Aufgaben Überschrift 2 und die Teile einer Aufgabe Überschrift 3. Das Inhaltsverzeichnis ist schon ein Feld aus diesen Formatvorlagen, wie es Word unter Referenzen > Inhaltsverzeichnis anlegen würde; nach dem Ändern von Überschriften mit Rechtsklick „Felder aktualisieren“ wählen (Microsoft-Support, englische Hilfeseite). Beim Einfügen von Text die Formatvorlagen behalten: nur als Text einfügen, dann die Überschrift zuweisen.

Die englische Seite hat dieselben Dateien auf Englisch.

Beispielkapitel: Rechnungen

Das Beispiel ist Kapitel 4 eines Benutzerhandbuchs für Ledgerly, geschrieben für das Buchhaltungsteam von Northwind, einer erfundenen Firma. Ledgerly ist eine Demo-Buchhaltungs-App für diese Ratgeber; die Screenshots sind echte Aufnahmen davon, eine Markierung pro Screenshot, Kundennamen verpixelt. Die Oberfläche ist englisch, deshalb stehen die Beschriftungen englisch. Das Kapitel hat einen Aufgabenabschnitt, einen Eintrag zur Fehlerbehebung und seine Glossarzeilen. Aufgabe, Aufnahme und Screenshots stammen aus dem Ratgeber Arbeitsanweisungen, der dieselbe Aufgabe als Arbeitsanweisung für das Finanzteam von Northwind schreibt; hier ist sie ein Handbuchabschnitt für die Nutzer des Produkts. Kapitel herunterladen (PDF, 2 Seiten).

Sein Aufgabenabschnitt, so wie das Handbuch ihn druckt:

Zieltitel

4.1 Unbezahlte Rechnung stornieren

Wann

Eine Rechnung wurde irrtümlich verschickt, und der Kunde hat sie nicht bezahlt.

Bevor Sie beginnen

Die Ledgerly-Rolle Finance und die Rechnungsnummer. Der Status muss Awaiting payment oder Overdue sein; eine bezahlte Rechnung (Paid) lässt sich nicht stornieren.

Schritte

1. Geben Sie auf der Seite Invoices in Search invoices die Rechnungsnummer ein, zum Beispiel 10427. Eine Zeile bleibt.

   

2. Klicken Sie auf die Zeile #10427 und prüfen Sie, dass ihr Status nicht Paid ist.
3. Klicken Sie auf Actions. Ein Menü öffnet sich.
4. Wählen Sie Void invoice.

   

5. Prüfen Sie die Meldung über den Reitern und den Status in der Zeile.

   

Ergebnis

Die Meldung „Invoice #10427 voided“; der Status lautet Void, durchgestrichen. Die Rechnung behält ihre Nummer.

Wenn es nicht klappt

Eine rote Meldung „… is Paid and cannot be voided“: siehe den Eintrag zur Fehlerbehebung unten.

Schritt 2 und 3 haben keinen Screenshot: Die Zeile und der Button Actions sind schon auf dem Bild von Schritt 1.

Der Eintrag zur Fehlerbehebung stammt aus dem echten Fehler, der beim Aufnehmen auftrat, bei Rechnung 10428:

Glossary lines the chapter added:

• Awaiting payment: Zahlung offen. Verschickt, nicht bezahlt, noch nicht fällig. Lässt sich stornieren.
• Overdue: überfällig. Verschickt, nicht bezahlt, nach dem Fälligkeitsdatum. Lässt sich stornieren.
• Paid: bezahlt. Die Zahlung ist eingegangen. Lässt sich nicht stornieren, sondern wird erstattet.
• Void: storniert. Behält ihre Nummer und bleibt durchgestrichen in der Liste.

Aufbau eines Aufgabenabschnitts

Mit dem Ergebnis enden, nicht mit dem letzten Klick. Formulierung und Länge der Schritte stehen in Schritt-für-Schritt-Anleitungen; Zuschneiden, Markieren und Verpixeln in Screenshots für Anleitungen.

Wie man ein Benutzerhandbuch schreibt

1. Nutzer und ihre Ziele auflisten. Die Quelle sind Support-Tickets und Fragen beim Einstieg: Sie stehen in den Worten der Nutzer.
2. Aus jedem Ziel einen Titel für einen Aufgabenabschnitt machen, Verb zuerst, und die Titel nach Arbeitsbereich in Kapitel gruppieren.
3. Jede Aufgabe einmal im echten Produkt ausführen und Schritt für Schritt aufnehmen, mit Testdaten.
4. Die Schritte aus den Aufnahmen schreiben. Personenbezogene Daten verpixeln oder wegschneiden, bevor irgendetwas weitergegeben wird.
5. Die Einrichtung schreiben, nach dem, was ein neues Konto beim Aufnehmen tatsächlich brauchte.
6. Die Fehlerbehebung füllen, mit den echten Fehlern aus den Aufnahmen, dann aus Tickets.
7. Das Glossar sammeln, aus den Beschriftungen der Oberfläche, die die Schritte verwenden.
8. Den Überblick zuletzt schreiben. Erst dann steht fest, was das Handbuch abdeckt und was nicht.
9. Mit jemandem testen, der das Produkt nie benutzt hat. Beobachten, wo die Person hängen bleibt, und diesen Schritt verbessern.

Schritt 3 und 4 kosten die meiste Zeit. Ein Rekorder, der jeden Klick zu einem nummerierten Schritt mit Screenshot macht, verkürzt sie; mit den eingebauten Screenshot-Tasten (Win+Umschalt+S, Cmd+Umschalt+4) ist es pro Schritt eine Aufnahme und ein Zuschnitt. Für eine lange Einstellungsseite kann ein ganzseitiger Screenshot mehrere ersetzen.

Software-Handbuch oder Produkthandbuch

Das Gerüst ist dasselbe. Anders sind der Anfang und das Ende.

• Software: Systemvoraussetzungen, Konten, Rollen und Berechtigungen und die beschriebene Version. Screenshots veralten, wenn sich die Oberfläche ändert; deshalb zählt die Versionsangabe.
• Physisches Produkt: Lieferumfang und Installation in der Einrichtung, Warnhinweise bei den Hinweisen und in der Aufgabe, in der die Gefahr auftritt, und ein Anhang mit Produktangaben am Ende.

Für ein physisches Produkt legt IEC/IEEE 82079-1:2019 in Abschnitt 7, Inhalt der Gebrauchsinformation, fest, was eine Gebrauchsanleitung enthält. Zu seinen Unterabschnitten gehören die Identifikation des Produkts und des Lieferanten (7.2), die Produktbeschreibung mit technischen Daten (7.8), die Wartung (7.10.10), Demontage, Recycling und Entsorgung (7.10.14) sowie sicherheitsbezogene Informationen mit Sicherheitshinweisen und Warnhinweisen (7.11). Der optionale Anhang A der Vorlage fasst das in einer Tabelle zusammen:

• Bestimmungsgemäße Verwendung: wofür das Produkt gedacht ist und wofür nicht.
• Warnhinweise: die Gefahr, was passieren kann, wie man sie vermeidet.
• Modell- und Seriennummer: wo sie auf dem Produkt stehen.
• Technische Daten: Stromversorgung, Maße, Gewicht, Betriebsbedingungen.
• Wartung: was der Nutzer reinigt, prüft oder tauscht, und wie oft.
• Entsorgung: wie Produkt und Batterien entsorgt oder recycelt werden.
• Kundendienst und Garantie: Name, Anschrift und Kontakt des Herstellers und die Garantiebedingungen.

Die Abschnittsnummern und -titel stammen aus dem Inhaltsverzeichnis der Norm; was jeder Abschnitt im Einzelnen verlangt, steht in der Norm selbst.

Ein „persönliches Benutzerhandbuch“ (eine Seite „So arbeitet man mit mir“ über eine Kollegin oder einen Kollegen) ist ein anderes Dokument und hier nicht Thema.

Benutzerhandbuch, SOP, Arbeitsanweisung, Schulungshandbuch oder Job Aid

Die Aufgabenabschnitte eines Benutzerhandbuchs stehen auf der Ebene der Arbeitsanweisung: eine Aufgabe, Schritt für Schritt am Bildschirm. Dieselbe Aufnahme kann eine Arbeitsanweisung und einen Handbuchabschnitt tragen; anders sind der Leser und der Rahmen. Eine SOP liegt eine Ebene darüber: das schriftliche Verfahren, also wer was wann in welcher Reihenfolge tut. Wo jedes Dokument hingehört, steht unter Prozessdokumentation; ein Handbuch für Mitarbeitende in der Einarbeitung ist ein Schulungshandbuch, und die Ein-Seiten-Fassung einer Aufgabe ist ein Job Aid.

Das Handbuch aktuell halten

• Versionen auf der Titelseite: die Handbuchversion und die Produktversion mit Datum, und am Ende eine datierte Änderungsliste.
• Neu aufnehmen, nicht flicken: Wenn sich die Oberfläche ändert, die betroffenen Aufgabenabschnitte aus einer neuen Aufnahme neu machen, statt alte Screenshots zu bearbeiten.
• Eine verantwortliche Person pro Kapitel: wer für diesen Bereich des Produkts zuständig ist, im Kopf des Kapitels genannt.

Quellen