Software-Dokumentation, Teil 5

Das Erstellen einer Benutzerdokumentation

| Autor / Redakteur: Christian Rentrop / Stephan Augsten

Jede Software verdient eine Benutzerdokumentation, doch wie kann und sollte diese aussehen?
Jede Software verdient eine Benutzerdokumentation, doch wie kann und sollte diese aussehen? (Bild gemeinfrei: mohamed_hassan - Pixabay.com)

Egal ob Smartphone-App, Consumer-Software, Game oder komplexe Business-Lösung: Eine umfassende Benutzerdokumentation kann Support-Anfragen reduzieren und Kosten sparen. Doch welche Möglichkeiten gibt es?

Dass selbst einfachste Software Hürden haben kann, dürfte den meisten Entwicklern und Softwareschmieden bekannt sein. Genau deshalb ist es sinnvoll, jede Software – egal, wie einfach sie gestrickt ist – mit einer Benutzer-Dokumentation auszuliefern. Diese muss natürlich auf die Bedürfnisse des jeweiligen Anwenders zugeschnitten sein.

Eine Smartphone-App benötigt natürlich eine andere Ansprache und Komplexität, als Profi-Software für Unternehmen. Trotzdem ist es wichtig, den Nutzer an der Hand zu nehmen, ihn „einzufangen“ und ihm Hilfe zur Selbsthilfe zu geben.

Auf diese Weise lässt sich der individuelle Support-Aufwand pro User nämlich massiv reduzieren. Zumal dieser Support gerade bei Software im Niedrigpreis- oder Gratis-Segment erhebliche Kosten produzieren kann. Eine gute Benutzerdokumentation kann vieles davon abfangen.

Was gehört in eine Benutzerdokumentation?

Zunächst sollte sich natürlich die Frage nach dem Inhalt der Dokumentation stellen. Art, Ansprache, Gestaltung und Umfang der Benutzerdokumentation sind letztlich abhängig von den Präferenzen des Entwicklers und den Bedürfnissen des Users. Trotzdem gibt es Dinge, die in jeder Benutzer-Dokumentation enthalten sein sollten:

  • Hardware- und Software-Anforderungen, um beim User möglicherweise auftretende Probleme bei der Performance oder Kompatibilität direkt abzufangen.
  • Installationsanleitung, sofern nötig.
  • Erste Schritte der Verwendung: Etwa das Spiel starten oder ein Dokument erstellen.
  • Feature-Liste der Software.
  • Gegebenenfalls Erklärung zur Steuerung und zu Bedienelementen.
  • Typische Fehlermeldungen und wie sie sich beheben lassen.
  • Eine Support-Kontaktmöglichkeit für den Fall, dass der User sich nicht selbst helfen kann.

Die einfachste Lösung: Eine Online-Dokumentation, FAQ und Knowledge-Base

Die wohl einfachste Möglichkeit der Benutzerdokumentation ist die Erstellung eines einfachen Benutzerhandbuchs in Form einer Online-Dokumentation, Knowledge-Base oder FAQ. Das Software-Produkt wird höchstwahrscheinlich über eine Website verfügen; dementsprechend einfach ist es, hier manuell oder per CMS einige Textseiten zu produzieren, die typische Fragen zur Bedienung der Software abdecken.

Der Vorteil dieser Lösung: Die Online-Dokumentation kann jederzeit aktualisiert werden. Falls zum Beispiel nach einem Update oder generell immer wieder die gleichen Support-Anfragen auftauchen, kann der Text entsprechend angepasst werden. So sparen sich Entwickler die lästige Beantwortung von E-Mails.

Online-Dokumentation richtig aufbauen

Wie die Online-Dokumentation letztlich aussieht, das bleibt dem Entwickler oder Verfasser der Software überlassen. Zwischen einer einfachen FAQ und einer ausgefeilten Benutzer-Dokumentation ist alles möglich.

Natürlich setzt eine gute Online-Dokumentation voraus, dass typische Anwendungsszenarien abgedeckt sind. Zudem sollte sie verständlich und an die Zielgruppe angepasst formuliert sein. Als gutes und gleichzeitig schlechtes Beispiel dient eine Online-Benutzerdokumentation Apache-Foundation: Hier gibt es eine ausgesprochen umfangreiche Dokumentation, die jedoch sehr technisch ist.

Besser machen es zum Beispiel viele Wordpress-Theme-Anbieter, etwa die Macher des Hueman-Themes, die mit Schritt-für-Schritt-Anleitungen arbeiten, dafür aber nicht jedes Szenario abdecken. Wichtig bei jeder Online-Dokumentation ist, dass es eine gute Suchfunktion gibt.

Hilfe innerhalb der Software

Eine weitere Möglichkeit, eine Benutzerdokumentation anzubieten, ist, diese direkt mit der Software auszuliefern. Hilfe und FAQ finden, sofern sie knappgehalten werden können, durchaus im Programm selbst Platz.

Die Hilfe-Funktionen der Betriebssysteme, etwa WinHelp, sind längst in den Hintergrund gerückt oder ganz verschwunden, weshalb es sich nicht lohnt, hier anzusetzen. Sinnvoller ist es, eine „Hilfe“ oder „Dokumentation“-Option innerhalb der Software anzubieten, die letztlich wie eine Website hypertextbasiert bei der Bedienung der Software und der Lösung typischer Probleme hilft.

Der Vorteil dieser Lösung ist, dass der Anwender die Software nicht verlassen muss, um sich selbst zu helfen. Der Nachteil ist, dass diese Art der Dokumentation natürlich nur per Update aktualisiert werden kann. Allerdings gibt es hierfür ein Workaround: Der Benutzerdokumentations-Link im Programm kann auch einfach auf eine Online-Dokumentation verweisen, die deutlich zielgerichteter aktualisiert und erweitert werden kann.

Handbuch als PDF oder gedrucktes Dokument

Wenn die Software eine gewisse Komplexität erreicht, kann es natürlich sinnvoll sein, ein „echtes“ Handbuch aus Papier zu erstellen. Gerade Anwender, die viel Geld für Profi-Software ausgeben, schätzen die Möglichkeit, das Handbuch neben den PC zu legen und bei Bedarf darin nachzuschauen. Diese Form der Benutzerdokumentation stirbt allerdings langsam aus.

Dies liegt einerseits daran, dass Software immer seltener im Boxed-Format verkauft wird, andererseits, weil ein gedrucktes Handbuch natürlich auch ein nicht unerheblicher Kostenfaktor ist. Daher kann es sinnvoll sein, das Handbuch als PDF in der Software selbst oder als separaten Download anzubieten. Der Anwender kann sich das Dokument dann bei Bedarf selbst ausdrucken, gleichzeitig kann er aber auch direkt am Rechner im PDF suchen.

Gegenüber Online- und In-App-Dokumentationen haben „echte“ Handbücher, egal ob als PDF oder Print, allerdings den Nachteil, dass ihre Erstellung relativ aufwändig ist. Neben redaktionellen Aspekten muss ein solches Dokument auch gelayoutet werden, von der möglicherweise aufwändigen Planung abgesehen.

Video-Tutorials

Eine sehr moderne Möglichkeit, Software für Benutzer zu dokumentieren, ist das Anbieten von Video-Anleitungen. In Zeiten von Youtube und Co. sind Anwender gewohnt, Anleitungen in Form von Videos zu konsumieren. Diese haben zudem den Vorteil, dass sie in Ton und Bild zeigen, wie zum Beispiel die Einrichtung, erste Schritte oder spezielle Funktionen ablaufen.

Video-Anleitungen sind modern und können dank Diensten wie Youtube mehrfach eingebunden werden, wodurch auch User, die nicht direkt auf die Website schauen, an die nötigen Informationen gelangen können. Zudem sind sie sehr einsteigerfreundlich.

Ein großer Nachteil von Video-Tutorials: sie verursachen erheblichen Produktionsaufwand. Neben der komplexen Planung von Video-Serien verursachen Videoschnitt und mitunter ein professioneller Sprecher einen gewissen Aufwand, was mit erheblichen Kosten verbunden sein kann.

Einfacher ist es, zum Beispiel Screenvideos zu erstellen und mit Text zu hinterlegen, allerdings setzt auch das gewisse Kenntnisse der Technik voraus und ist recht zeitaufwändig. Video-Anleitungen lohnen sich daher nur für „grobe“ Anleitungen und sind bestenfalls als Ergänzung zu Text-Anleitungen, FAQs oder Benutzerhandbüchern zu sehen.

Kommentare werden geladen....

Kommentar zu diesem Artikel

Der Kommentar wird durch einen Redakteur geprüft und in Kürze freigeschaltet.

Anonym mitdiskutieren oder einloggen Anmelden

Avatar
Zur Wahrung unserer Interessen speichern wir zusätzlich zu den o.g. Informationen die IP-Adresse. Dies dient ausschließlich dem Zweck, dass Sie als Urheber des Kommentars identifiziert werden können. Rechtliche Grundlage ist die Wahrung berechtigter Interessen gem. Art 6 Abs 1 lit. f) DSGVO.
  1. Avatar
    Avatar
    Bearbeitet von am
    Bearbeitet von am
    1. Avatar
      Avatar
      Bearbeitet von am
      Bearbeitet von am

Kommentare werden geladen....

Kommentar melden

Melden Sie diesen Kommentar, wenn dieser nicht den Richtlinien entspricht.

Kommentar Freigeben

Der untenstehende Text wird an den Kommentator gesendet, falls dieser eine Email-hinterlegt hat.

Freigabe entfernen

Der untenstehende Text wird an den Kommentator gesendet, falls dieser eine Email-hinterlegt hat.

copyright

Dieser Beitrag ist urheberrechtlich geschützt. Sie wollen ihn für Ihre Zwecke verwenden? Infos finden Sie unter www.mycontentfactory.de (ID: 45838279 / Software-Erstellung)