Das Schreiben von Software-Dokumentationen für Endbenutzer: So gelingt es Ihnen

Writing Software Documentations For End Users: How To Get It Right

Eine effektive Software-Dokumentation hilft den Endbenutzern, die mit der Software arbeiten, die Funktionen der Software und die Durchführung bestimmter Aufgaben zu verstehen. Technischen Redakteuren stellt sich die Frage, wie man dieses Ziel erreichen kann, wenn man für Endbenutzer mit nur geringem oder nicht vorhandenem technischen Wissen schreibt. Hier finden Sie es heraus!

Was Sie beim Schreiben von Software-Dokumentationen für Endbenutzer beachten sollten

Die folgenden 5 Richtlinien können Ihnen helfen, Ihre Software-Dokumentation auf Ihre Endbenutzer abzustimmen und so für sie attraktiver zu machen:

1. Verstehen Sie die geschäftlichen Gründe für Ihre Dokumentationen

Obgleich der Hauptgrund für die Dokumentation einer Software darin besteht, den Benutzern die Anwendung der Software verständlich zu machen, gibt es daneben einige weitere wichtige Gründe. Diese Gründe sind eine bessere Vermarktung der Software, die Förderung des Unternehmensimage und insbesondere geringere Kosten für den Kunden-Support.
In einigen Fällen ist eine Dokumentation zudem zur Einhaltung gesetzlicher Vorschriften oder anderer Regelungen erforderlich. Machen Sie jedoch nicht den Fehler, eine Software-Dokumentation als Ersatz für eine schlechte Benutzeroberfläche zu nutzen. Wenn die Benutzeroberfläche Ihrer Software nur durch eine detaillierte Dokumentation zu erklären ist, sollten Sie das Bildschirmdesign ändern und benutzerfreundlicher machen.

2. Stellen Sie sicher, dass Sie Ihr Publikum verstehen

In vielen Fällen haben die Anwender einer Software von den Aufgaben, die die Software ihnen ermöglicht, abgesehen nur geringe oder gar keine Computerkenntnisse. Sie können jedoch auf verschiedene Weise herausfinden, wie Sie Ihre Dokumentation auf die Bedürfnisse Ihrer Endbenutzer am besten zuschneiden.

Achten Sie auf die Berufsbezeichnungen der zukünftigen Benutzer Ihrer Software. Ein potentieller Benutzer, der ein Systemadministrator ist, ist möglicherweise ein Experte und kann mit mehreren verschiedenen Anwendungen arbeiten. Ein Datentypist beherrscht jedoch mitunter nur die Software, die er oder sie für die Dateneingabe anwendet. Erfahren Sie mehr über die Publikumsanalyse im technischen Schreiben.
Erwägen Sie, mehrere potenzielle Benutzer zu befragen, um herauszufinden, inwiefern ihre Berufsbezeichnungen tatsächlich ihre beruflichen Tätigkeiten angeben. Die Kunst der Befragung eines potentiellen Publikums ist eine der Fähigkeiten, die ein hervorragender technischer Redakteur beherrschen sollte.
Prüfen Sie vorhandene Dokumentationen, insbesondere die früherer Versionen Ihrer Software. Achten Sie auf die Funktionsbeschreibungen, sodass Sie Angaben dazu machen können, was die Benutzer für die Anwendung der Software wissen sollten.

Vergessen Sie dabei jedoch nicht, dass die Endbenutzer nicht hauptsächlich an der Funktionsweise der Software interessiert sind. Sie wollen vielmehr wissen, was die Software für sie tun kann. Identifizieren Sie die Vorgänge, die zum erfolgreichen Durchführen einer Aufgabe erforderlich sind, sowie die Vorgänge, die vor dem Abschluss anderer durchgeführt werden müssen.

3. Wählen Sie die richtigen Formate zum Veröffentlichen Ihrer Dokumentation

Viele Dokumentationen sind in 1 von 2 Formaten aufgebaut: das Benutzerhandbuch und das Referenzhandbuch. In einigen Fällen ist eine Kombination beider Formate die beste Wahl.

Ein Referenzhandbuch soll alle Funktionen einer Softwareanwendung (Tasten, Tabs, Felder und Dialogfenster) erklären. Viele Hilfedateien werden in diesem Format geschrieben. Die meisten dieser Hilfedateien sind kontextsensitiv und zeigen ein passendes Thema an, wenn ein Benutzer auf die Hilfe-Schaltfläche auf einem bestimmten Bildschirm klickt.

Das andere Format, das Benutzerhandbuch, dient dem Ziel, zu erklären, wie die Software zur Durchführung einer bestimmten Aufgabe benutzt werden kann. Benutzerhandbücher werden in der Regel als PDF-Dateien oder als gedruckte Handbücher veröffentlicht. Einige Hilfedateien beinhalten jedoch auch Themenabschnitte, die die Durchführung einiger präziser Aufgaben erklären. Benutzerhandbücher sind in der Regel in der Form von Anleitungen geschrieben. Sie bieten in der Einleitung eine Zusammenfassung der durchzuführenden Aufgaben sowie detaillierte Anweisungen in nummerierten Schritten.

Ein Hilfe-Entwicklungstool wie HelpNDoc kann aus einer Quelle mehrere verschiedene Dateiformate einschließlich Word, PDF, CHM-Hilfedateien, ePubs, Kindle E-Books, plattformübergreifende Qt-Hilfedateien, iPhone-spezifische Websites, HTML-basierte Dokumentationen etc. erstellen.

4. Entscheiden Sie sich für eine oder mehrere Formen Ihrer Dokumentation

Eine Software-Dokumentation für Endbenutzer kann in mehreren verschiedenen Formen oder nur in einer Form veröffentlicht werden. Die Dokumentation kann als gedrucktes Handbuch, als PDF-Dokument, als Hilfedatei oder als Online-Hilfe angeboten werden. Erfahren Sie mehr über die sieben besten Formate zum Veröffentlichen Ihrer Dokumentationen.
Jede Form dient dem Ziel, den Endbenutzern die Anwendung der verschiedenen Software-Funktionen zu zeigen. Dies kann mittels Anleitungen erfolgen. Hilfedateien und Online-Hilfen können Demo-Videos, -Texte und -Grafiken enthalten.
Sie sollten Hilfedateien und Online-Hilfen mit einem Index versehen, der nach Schlüsselwörtern durchsuchbare Begriffe umfasst, um Ihren Benutzern das Auffinden gesuchter Informationen zu erleichtern. Ein Hilfe-Entwicklungstool kann einen solchen Index automatisch generieren.

5. Verwenden Sie ein passendes Dokumentationstool

Für viele liegt der Schluss nahe, dass ein Textverarbeitungsprogramm wie Microsoft Word das richtige Tool für das Schreiben jeder gewünschten Dokumentation ist. Und so fragen sich viele Software-Entwickler häufig: Soll ich Word für das Schreiben meiner Produktdokumentation anwenden?
Textverarbeitungssoftwares sind nicht für das Schreiben von technischen Dokumentationen ausgelegt. Das Schreiben eines qualitativ hochwertigen Handbuchs kann die beste Investition für Ihr Unternehmen sein, machen Sie es also richtig und verwenden Sie ein Hilfe-Entwicklungstool.

Das Schreiben einer Software-Dokumentation für Endbenutzer sollte keine Tortur sein und das Ergebnis kein langweiliges Dokument, das von Ihren Benutzern ignoriert wird. Wir hoffen, dass diese Richtlinien Ihnen helfen werden, einfach zu einem guten Ergebnis zu kommen. Viel Freude am Dokumentieren!