Erfahren Sie hier, was eine gute Anwenderdokumentation ausmacht und was sie leisten sollte.
Inhalt
Zweck der Anwenderdokumentation
Die Anwenderdokumentation wird während des Produkteinsatzes benutzt und dient dem Zweck, das Produkt problemlos und sicher einsetzen zu können.
Sie hat somit den einzigen Zweck, die Fragen der Anwender zu beantworten. Diese Fragen ergeben sich aus dem Ziel, das die Anwender mit dem Produkt verfolgen. Die Anwender wollen das Produkt effizient einsetzen und wollen wissen, wie es funktioniert – sonst nichts.
Beispiel einer Anwenderdokumentation für den Maschinebau – jetzt herunterladen!
Wie gehe ich bei der Erstellung einer Anwenderdokumentation vor? Was muss darin enthalten sein?
Mit unserer Musterdokumentation bekommen Sie beispielhaft dargestellt, wie eine vollständige Anwenderdokumentation für ein Produkt aussehen kann. Jetzt kostenlos herunterladen!
Aus welchen Komponenten besteht die Anwenderdokumentation?
Effiziente Anwenderdokumentation besteht aus zwei Kommunikationskomponenten mit unterschiedlichem Fokus:
- Die ergebnisorientierte Kommunikation stellt die zielgerichtete Durchführung der Handlungen der Anwender in den Mittelpunkt.
- Die verständnisorientierte Kommunikation vermittelt den Anwendern die Konzepte des Produkts und ermöglichen ihnen das systematische Übertragen von Handlungsprinzipien.
Gemeinsam ist beiden Komponenten effektiver Anwenderdokumentation, dass sie auf die Fragen der Anwenders direkt antworten. Das heißt, die Anwender können die Antworten auf ihre Fragen schnell und sicher finden.
Die ergebnisorientierte Kommunikation
Ziel effizienter Anwenderdokumentation ist es, die Anwender in die Lage zu versetzen, mit dem Produkt umzugehen.
Daher ist eine Komponente der Anwenderdokumentation die ergebnisorientierte Kommunikation (Befähigungskommunikation nach Klaus C. Hofer oder auch Sofort-Anleitung nach Dietrich Juhl). Die Anwender können die Anweisungen der ergebnisorientierten Kommunikation unmittelbar in Handlungen umsetzen.
Ergebnisorientierte Kommunikation beschränkt sich auf dieses eine Ziel. Sie ist daher vom Umfang her kürzer als herkömmliche Produktdokumentation. Sie besteht im Kern aus Handlungsanleitungen. Weitere Informationen über das Produkt sind nur enthalten, wenn die Anwender sie bei ihren Aktionen mit dem Produkt benötigen.
Die verständnisorientierte Kommunikation
Bei komplexen Produkten genügt es aber meist nicht, den Anwender in die Lage zu versetzen, bestimmte Handlungen unmittelbar durchzuführen. Dies gilt insbesondere deshalb, weil bei komplexen Produkten zu viele unterschiedliche, anwendungsspezifische Handlungen möglich sind.
Bei komplexen Produkten kommt es daher darauf an, den Anwendern das systematische Übertragen von Prinzipien von einer Handlung auf die nächste zu ermöglichen. Daher werden hier Konzepte des Produkts vermittelt.
Verständnisorientierte Kommunikation ermöglicht den Anwendern, an vorhandenes Fachwissen anzuknüpfen und neue Kenntnisse aufzubauen. Die verständnisorientierte Kommunikation baut daher auf bereits erlerntem Wissen auf und rekapituliert dieses auch teilweise, ohne jedoch den Lernschritt (z. B. das Training) ersetzen zu wollen.
Bei einfachen Produkten mit nur wenigen Handlungsmöglichkeiten bzw. sehr einfach eingängigen Handlungen kann die verständnisorientierte Kommunikationskomponente entfallen.
Wie entsteht effiziente Anwenderdokumentation?
Ausgangspunkt für die Erstellung von effizienter Anwenderdokumentation ist die Zweck- und Zielgruppenanalyse.
Bei der Zielgruppenanalyse werden folgende Fragen beantwortet:
- Wer sind meine Anwender?
- Welche Aus-/Vorbildung haben sie?
- Was können/wissen sie schon im Hinblick auf den Umgang mit meinem Produkt?
- Was wollen sie mit meinem Produkt tun und was nicht?
- Welche Probleme haben sie damit und welche nicht?
Bei der Zweckanalyse werden folgende Fragen beantwortet:
- Welchem Zweck dient die Dokumentation und welchem nicht?
- Ist es notwendig, dass die Anwender die Konzepte des Produkts verstehen, oder genügt es, wenn sie einige Handlungen unmittelbar durchführen können?
Als Ergebnis der Zweck- und Zielgruppenanalyse werden die Antworten auf die Fragen so festgehalten, dass die entstehende Dokumentation daran gemessen werden kann.
Erst nach einer Zweck- und Zielgruppenanalyse weiß der Autor genau, was er wirklich dokumentieren muss.
Im Mittelpunkt der ergebnisorientierten Komponente der Dokumentation stehen die Handlungsanweisungen (aber nur die, die für die Zielgruppe nicht selbsterklärend sind). Unterstützend wirken konzeptionelle und produktbeschreibende Teile, die für die Ausführung der Handlungen notwendig sind.
Im Mittelpunkt der verständnisorientierten Komponente der Dokumentation stehen die Konzepte und Prinzipien des Produkts.
Beispiel für ein messbares Kriterium
Beispiel für das messbare Kriterium sind Vorkenntnisse der Zielgruppe:
Diese Formulierung ist wenig hilfreich: “Kann mit dem PC umgehen”.
Besser: “Beherrscht das Betriebssystem Windows 2000 als Anwender”. Wenn diese Aussage zutreffend ist, kann die Erklärung des Umgangs mit Windows-Funktionen innerhalb eines Software-Produktes völlig entfallen.