Was ist Benutzerdokumentation?

Benutzerdokumentation ist die veröffentlichte Sammlung von Anleitungen, die jedem, der ein Produkt bedient, zeigt, wie er eine Aufgabe darin erledigt, ohne den Support zu kontaktieren.

Teams nennen sie auch Endbenutzerdokumentation, Endnutzerdokumentation, Bedienungsanleitung, Benutzerhandbuch oder Anwenderhandbuch, und die Definition von Benutzerdokumentation gilt für alle fünf Bezeichnungen gleichermaßen. Die Bedeutung von Benutzerdokumentation hängt vom Leser ab: jemand, der das Produkt nutzt, statt jemand, der es baut. Sie erscheint als Webartikel, als Hilfe direkt in der Oberfläche oder als PDF.

So funktioniert Benutzerdokumentation

Was Benutzerdokumentation ausmacht

• Mit Bildern gepaart, ein Bild pro Schritt: Jeder Schritt trägt einen Screenshot des Bedienelements, das er benennt, beschriftet, damit sich die Seite mit dem Bildschirm vor Ihnen abgleichen lässt.
• In einfacher Sprache geschrieben: Alltagswörter, mit ausgeschriebenen Abkürzungen bei erster Nennung; TechSmith formuliert die Regel so, dass alle Leser als Laien zu behandeln sind.
• Aktuell zu Produktversionen gehalten: Ein Release, das einen im Artikel gezeigten Bildschirm verändert, erzwingt die Überarbeitung.
• An die Person gerichtet, die das Produkt bedient: Aufgaben werden über die Oberfläche erledigt, ohne wissen zu müssen, was dahinter läuft.
• Nach Aufgaben gegliedert, die der Leser erledigen will: Titel benennen eine Handlung, sodass „Ein Teammitglied zu einem Board hinzufügen" eine Seite namens „Kontakte" ersetzt.
• Auffindbar: Suche, ein Inhaltsverzeichnis und eine eigene URL pro Artikel, damit Sie genau auf der einen Seite landen, die Ihre Frage beantwortet.

Warum Benutzerdokumentation wichtig ist

Eine Frage, die Ihre Support-Dokumentation beantwortet, erreicht selten die Warteschlange. Der Leser, der den fehlenden Schritt findet, bricht dort ab, stellt kein Ticket und erspart Ihrem Support-Team die Kosten, es zu beantworten. Autoren von Referenzseiten nennen diesen Nutzen konsistenter als jeden anderen.

Onboarding ist die zweite Folge. Ein neuer Nutzer, der einer veröffentlichten Aufgabe folgen kann, erreicht sein erstes Erfolgserlebnis ohne geplante Schulung, und der Kollege, der diese Schulung sonst gehalten hätte, behält die Stunde. Dieselbe Rechnung gilt für einen Mitarbeiter, der sich in ein internes Tool einarbeitet.

Kundenbindung ist die dritte Folge. Der Kunde, der die Aufgabe zu Ende bringt, bleibt, und wer auf halbem Weg aufgibt, geht. Bei manchen Produkten entscheidet die Qualität Ihrer Anleitungen darüber, ob Menschen die Software überhaupt annehmen, weshalb die Autoren einer Referenzseite Dokumentation als Freigabebedingung behandeln statt als Nacharbeit danach.

Arten von Benutzerdokumentation

Die Spalte, die entscheidet, welche Sie schreiben, ist die letzte.

Benutzerdokumentation vs. technische Dokumentation vs. SOP vs. Wissensdatenbank

Ihr Leser entscheidet über den Begriff: Ein Kunde, der etwas im Produkt erledigt, bedeutet Benutzerdokumentation, ein Ingenieur bedeutet technische Dokumentation, ein Mitarbeiter, der einer Unternehmensvorgabe folgt, bedeutet eine SOP. Wissensdatenbank versus Benutzerdokumentation ist eine Ebenenunterscheidung: Die eine kaufen Sie, die andere schreiben Sie.

So erstellen Sie Benutzerdokumentation

Fünf veröffentlichte Vorgehensweisen laufen auf eine einzige Abfolge zusammen. Egal ob Sie fragen, wie man Benutzerdokumentation schreibt, wie man eine Bedienungsanleitung erstellt oder wie man ein Benutzerhandbuch verfasst: Diese Schritte decken alle drei ab.

1. Zielgruppe und die eine Aufgabe benennen. Legen Sie fest, wer liest und welche einzelne Aufgabe er erledigen will. Der Umfang des Artikels ist diese Aufgabe, nicht die Funktion dahinter.
2. Den Ablauf kartieren, bevor Sie schreiben. Durchlaufen Sie die Aufgabe im Produkt und halten Sie fest, was passiert, einschließlich der Stellen, an denen sich die Oberfläche merkwürdig verhält.
3. Den Artikel nach der Handlung benennen. „Das Passwort eines Teammitglieds zurücksetzen" erreicht einen Leser, der eintippt, was er tun will; eine Seite namens „Passwörter" nicht.
4. Jeden Schritt auf eine einzelne Handlung begrenzen. Jeder mit „und" verbundene Schritt ist eigentlich zwei. Setzen Sie Voraussetzungen und Warnungen über den Schritt, auf den sie sich beziehen, denn eine darunter gedruckte Warnung erreicht den Leser erst, nachdem er schon gehandelt hat.
5. Ein Bild pro Schritt festhalten. Beschriften Sie das beschriebene Bedienelement, und schließen Sie mit einem Bild des fertigen Ergebnisses, damit der Leser seinen eigenen Bildschirm damit abgleichen kann.
6. Den Entwurf einem Kollegen geben, der diese Aufgabe noch nie erledigt hat. Überarbeiten Sie jeden Schritt, zu dem er nachfragen musste. Ihr Entwurf setzt Wissen voraus, das dem Leser fehlt, und nur ein unvoreingenommener Testlauf zeigt Ihnen, welches.
7. Einen Verantwortlichen und einen Auslöser für die Pflege benennen. Ordnen Sie dem Dokument eine Person zu, und legen Sie fest, welches Ereignis eine Überarbeitung erzwingt: ein Release, das einen im Artikel gezeigten Bildschirm verändert. Neun der zehn Referenzseiten hinter diesem Artikel lassen beides unbenannt.

Best Practices für Benutzerdokumentation

Die folgenden Best Practices für Benutzerdokumentation koppeln jeweils eine Regel mit dem Fehler, den sie verhindert.

• Tun: eine Handlung pro Schritt schreiben und alles mit „und" Verbundene aufteilen.

Nicht tun: eine Wand aus dichtem Fließtext veröffentlichen, durch die sich ein Leser mitten in der Aufgabe an seinem Arbeitsplatz nicht durcharbeiten wird.

• Tun: Artikel nach der Handlung benennen, die der Leser ausführen will.

Nicht tun: Anleitungen unter Themenbegriffen in einer flachen Hierarchie ohne eigene Artikel-URL ablegen, wodurch sie über die Suche unauffindbar bleiben.

• Tun: aktive Sprache und kurze Sätze verwenden, mit einem Lesbarkeitswert, um das Ergebnis in eine Zahl zu fassen.

Nicht tun: auf dem Niveau der Person schreiben, die die Funktion gebaut hat, denn das setzt Wissen voraus, das dem Einsteiger fehlt.

• Tun: Terminologie und Formatierung im gesamten Set an einen Styleguide oder eine Vorlage binden.

Nicht tun: jeden Autor denselben Button auf drei verschiedene Arten benennen lassen, was die Suche ins Leere laufen lässt und Leser zweifeln lässt, ob sie auf der richtigen Seite sind.

• Tun: den Entwurf jemandem geben, der mit der Aufgabe nicht vertraut ist, und beheben, wozu er nachfragt.

Nicht tun: Schritte veröffentlichen, die nur der Autor je ausgeführt hat.

Häufige Fehler bei Benutzerdokumentation

• Den Inhalt nach einem Release veralten lassen. Der Screenshot zeigt einen Button, der verschoben wurde, der Leser folgt einem Schritt, den es nicht mehr gibt, und das Ticket, das der Artikel eigentlich verhindern sollte, wird trotzdem eingereicht. manual.to berichtet, dass statische PDFs schon innerhalb von Monaten veralten.
• Für den Experten schreiben. Sie setzen Wissen voraus, das der Einsteiger nicht hat, und genau der Einsteiger ist der Leser, für den das Dokument existiert, also wendet er sich stattdessen an den Support.
• Textwände veröffentlichen. Jemand mitten in einer Aufgabe am Arbeitsplatz hört nach einem Stück auf zu lesen, sodass der Artikel genau in dem Moment ungenutzt bleibt, in dem er helfen sollte.
• Dokumentation veröffentlichen, die Leser nicht finden. Schwache Suche, eine flache Hierarchie und keine URL pro Artikel bedeuten, dass Sie die vollen Kosten für das Schreiben des Sets tragen und keine der eingesparten Ticketkosten einfahren.

Beispiel für Benutzerdokumentation

Die Seiten, die für Beispiele für Benutzerdokumentation ranken, sind Galerien fremder Help-Center. Übernehmen Sie das ausgefüllte Exemplar unten als Vorlage für Benutzerdokumentation; es enthält die zwei Felder, die Beispiele für Endbenutzerdokumentation sonst auslassen: einen Verantwortlichen und einen Prüfauslöser.

• Titel: Ein Teammitglied zu einem geteilten Board hinzufügen
• Für wen: Ein Workspace-Admin mit einem bereits erstellten Board und einem freien Platz im Plan.
• Bevor Sie beginnen: Halten Sie die dienstliche E-Mail-Adresse des Teammitglieds bereit. Einladungen an eine private Adresse scheitern an der Domainprüfung.
• Schritt 1. Öffnen Sie das Board und klicken Sie oben rechts auf Teilen. Screenshot: die Board-Kopfzeile mit hervorgehobenem „Teilen". Mitglieder sehen diesen Button ausgegraut, also einen Admin bitten, diesen Schritt auszuführen.
• Schritt 2. Geben Sie die dienstliche E-Mail-Adresse des Teammitglieds in das Einladungsfeld ein.
• Schritt 3. Wählen Sie Bearbeiter oder Betrachter aus dem Rollen-Dropdown neben dem Feld. Screenshot: das geöffnete Dropdown.
• Schritt 4. Klicken Sie auf Einladung senden. Screenshot: die Bestätigung mit dem Text „Einladung gesendet".
• Endergebnis: Das Teammitglied wird in der Mitgliederliste als Ausstehend angezeigt, bis es annimmt, und wechselt dann mit der gewählten Rolle zu Mitglieder.
• Troubleshooting: Keine E-Mail nach zehn Minuten, bitten Sie ihn, den Spam-Ordner zu prüfen und aus der Mitgliederliste erneut zu senden. „Platzlimit erreicht", entfernen Sie ein deaktiviertes Mitglied oder fügen Sie in der Abrechnung einen Platz hinzu.
• Verwandt: Die Rolle eines Teammitglieds ändern. Jemanden von einem Board entfernen.
• URL: /help/boards/add-a-teammate-to-a-shared-board
• Verantwortlich: Support-Lead. Zuletzt geprüft: August 2026. Prüfauslöser: jedes Release, das den Teilen-Dialog verändert.

Echte Benutzerdokumentation ansehen

Hintos eigene Wissensdatenbank ist eine Instanz des Begriffs, und der Artikel unten deckt das Zuschneiden eines Videoclips in acht nummerierten Schritten ab, jeder mit dem Bedienelement, das er benennt.

Von der Aufnahme zur Benutzerdokumentation in einem Durchgang

Genau dieses Exemplar aus einer leeren Seite zu erstellen, ist der Punkt, an dem die meisten Teams stocken, weshalb Tools für Benutzerdokumentation heute von einer Aufnahme statt von einem Dokument ausgehen. Nehmen Sie die Aufgabe einmal auf, oder bringen Sie ein vorhandenes Video mit: Hinto AI akzeptiert Loom, Zoom, YouTube sowie lokale MP4-, MOV- oder WebM-Dateien und nimmt Bildschirm, Kamera und Mikrofon aus dem Browser oder über seine Chrome-Erweiterung auf.

Seine Aktionserkennung identifiziert Änderungen des UI-Zustands und Klicks auf Buttons, extrahiert daraus Screenshots und geschriebene Schritte und verwandelt dann eine Aufnahme in ein Inhaltsverzeichnis mit mehreren organisierten Artikeln: ein Help-Center für Endbenutzerdokumentation oder Release Notes, generiert aus einer Produktdemo. Kommt ein Abschnitt falsch heraus, markieren Sie ihn und fordern eine Neufassung oder neue Bilder nur für diesen Block an, dann schneiden, rahmen, fokussieren oder verwischen Sie alles Sensible. Sie veröffentlichen das Ergebnis unter einer öffentlichen URL auf Ihrer eigenen Domain, und der Dienst rechnet Generierungen als monatliches Kreditkontingent ab, statt wie die meiste Software für Benutzerhandbücher pro Sitzplatz zu berechnen.

FAQ zu Benutzerdokumentation

Wer schreibt Benutzerdokumentation?

Wer auch immer den Fragen der Leser am nächsten sitzt: Support, ein Product Owner oder ein technischer Redakteur, der technische Redaktion für Benutzerdokumentation hauptberuflich betreibt. Die Seite aktuell zu halten zählt mehr als wer die Feder führt, und neun der zehn Referenzseiten hinter diesem Artikel benennen nach der ersten Veröffentlichung nie einen Verantwortlichen für das Dokument.

Was sollte ein Benutzerhandbuch enthalten?

Wikipedias Standardinhalte umfassen Sicherheit, Montage, Installation, Betrieb, Wartung, Fehlerbehebung, technische Daten und Garantie. Software-Handbücher lassen die physischen Abschnitte weg, behalten den Rest, und ergänzen einen Einstiegspfad plus einen Artikel pro Aufgabe. Setzen Sie einen Verantwortlichen und ein Datum der letzten Prüfung in die Randangaben, damit Leser beurteilen können, ob es noch zum Produkt passt.

Was ist der Unterschied zwischen einem Benutzerhandbuch und einer Bedienungsanleitung?

Beide Bezeichnungen meinen dasselbe. Ein Benutzerhandbuch, Anwenderhandbuch, Betriebshandbuch oder eine Bedienungsanleitung ist Material, das jemandem hilft, ein bestimmtes Produkt, eine Dienstleistung oder eine Anwendung zu nutzen. Teams, die die Begriffe doch trennen, verwenden Handbuch für den kurzen, aufgabenförmigen Artikel und Anleitung für die vollständige Referenz.

Was macht ein gutes Benutzerhandbuch aus?

Die Referenzquellen sind sich in drei Punkten einig: ein beschriftetes Bild pro Schritt, das das im Schritt beschriebene Bedienelement zeigt, einfache Sprache ohne unerklärten Fachjargon, und eine Gliederung, die sich an den Aufgaben orientiert, die ein Leser erledigen will, statt an den Funktionen, die das Produkt bietet. Eine Seite, die einen der drei Punkte verfehlt, schickt Leser zum Support.

Was sind Benutzerdokumentationstests im Softwaretest?

Sie gehen die geschriebenen Schritte mit einem Erstanwender im laufenden Produkt durch und beheben dann jeden Schritt, zu dem er nachfragen musste. TechSmith nennt sie naive Nutzer, manual.to nennt sie Nutzer, die es noch nie getan haben. Die Übung deckt vorausgesetztes Wissen und Schritte auf, die ein aktuelles Release still verändert hat.

Verwandte Begriffe

Standardarbeitsanweisung, Wissensdatenbank, Prozessdokumentation