Software-Dokumentation, Teil 6

Software für die Online-Benutzerdokumentation

| Autor / Redakteur: Christian Rentrop / Stephan Augsten

Welches Format eine Online-Benutzerdokumentation auch hat, es dient in der Regel doch immer der Selbsthilfe.
Welches Format eine Online-Benutzerdokumentation auch hat, es dient in der Regel doch immer der Selbsthilfe. (Bild gemeinfrei: TeroVesalainen - Pixabay.com / Pixabay)

Eine Online-Benutzerdokumentation ist pflegeleicht und schnell aktualisiert. Um so wichtiger ist es, von Anfang an auf das richtige System zu setzen. Wir zeigen einige Lösungen, um Usern online Anleitung und Hilfe bereitzustellen.

Das Erstellen einer Benutzerdokumentation zählt zu den eher lästigen Aspekten der Softwareentwicklung. Klassische Handbücher – egal ob als PDF oder in gedruckter Form – sind zwar eine hübsche Angelegenheit, sind aber auch entsprechend aufwändig teuer in der Produktion. Vor allem für kleinere oder häufig aktualisierte Software-Lösungen bietet es sich deshalb an, eine Online-Benutzerdokumentation in Form einer Website zu erstellen.

Technisch gesehen bedeutet das nicht viel Aufwand: Ein für den anzunehmenden Besucheransturm passender Webserver mit Apache und MySQL – und ein passendes System für die Erstellung einer Anleitung. Wichtig dabei: Steigt die Komplexität, sollte bei allen Varianten ein technischer Autor zurate gezogen werden.

Die einfachste Variante: HTML-Benutzerdokumentation

Wer Ressourcen sparen und seinen Usern trotzdem jederzeit eine aktuelle Anleitung zur Hand geben möchte, kann eine simple HTML-Seite als Benutzerdokumentation oder FAQ anlegen. Dazu reicht es, auf der Produktwebsite einen Link anzulegen, der auf diese Seite verlinkt. Intern lässt sich die Seite mit Überschriften und einem Inhaltsverzeichnis sowie Sprungzielen versehen.

Der Vorteil dieser Lösung ist, dass sich die Seite schnell öffnen und bearbeiten lässt und wirklich sparsam ist. Der Nachteil besteht darin, dass Links und Bilder manuell gesetzt werden müssen, was bei zunehmender Komplexität immer schwieriger zu verwalten ist. Von daher ist es sinnvoll, statt auf reinen HTML-Code auf ein dediziertes System zu setzen.

Effizient und einfach: Dokumentation auf Wordpress-Basis

Deutlich effizienter und einfacher ist es, Bedienungsanleitungen und FAQs mit Hilfe eines Wordpress-Systems zu pflegen: Wordpress ist inzwischen mehr oder weniger Standard für Online-Content-Management-Systeme und hochgradig flexibel. Plug-ins wie weDocs verwandeln Wordpress in ein leistungsfähiges Online-Dokumentationssystem.

Anders als bei der manuellen Verwaltung einer Website wird der Content hier vom System verwaltet. Inhalte sind daher schnell erstellt oder geändert. Zusätzlich können Plug-ins wie BBPress oder das an Stackoverflow angelehnte Frage-Antwort-Plug-in DWQA Support-Anfragen in ein Forum umleiten, das seinerseits ebenfalls im Wordpress-System läuft, also nur wenig zusätzliche Administration benötigt. Online beantwortete Fragen sind natürlich sinnvoll, schon weil sie dem per Suchmaschine ankommenden User Hilfe zur Selbsthilfe geben.

Wiki-System für schnelle Dokumentation

Alternativ zum Wordpress-System, das mit seinen Plugins und häufigen Updates einen gewissen Wartungsaufwand verursacht, bietet es sich mitunter an, auf ein Wiki-System zu setzen. Welches das im Kern ist, ist relativ unwichtig: Neben dem recht umfangreichen Wikipedia-System Mediawiki gibt es auch kleinere, weniger aufwändige Lösungen wie etwa DokuWiki.

Der Vorteil eines Wiki-Systems gegenüber einer Lösung wie Wordpress ist die Konzentration auf das Wesentliche. Statt mit Plugins und verschiedenen Seiten- und Artikeltypen zu arbeiten, werden bei Wikis einfach Seiten erstellt und ins System eingehängt. Die Querverlinkung erfolgt üblicherweise per Shortcode oder Stichwort, was die Wartung erleichtert.

Benutzerdoku-Software nutzen

Natürlich gibt es auch Möglichkeiten, bei der Erstellung eines Benutzerhandbuchs auf einen dedizierte Handbuch-Software zu setzen: So gibt es Dienste wie Clickhelp oder HelpNDoc, die sich dediziert der Erstellung von Hilfedateien, FAQ-Dokumenten und Benutzerdokumentationen widmen.

Üblicherweise sind diese Dienste kostenpflichtig, bieten dafür aber ein rundes Gesamtpaket, das die erstellten Hilfe-Texte und Benutzerdokumentationen gleich in mehreren Formaten erstellen können: So bietet HelpNDoc zum Beispiel die Erstellung von HTML-Hilfeseiten, Microsoft CHM-Dateien, ePubs oder PDF-Dateien an, wodurch sich die Benutzerdokumentation gleich in mehreren Varianten anlegen und auf verschiedenen Wegen veröffentlichen lässt. Diese Art von Tool gibt es auch als klassische Software-Lösungen ohne Online-Dienst, etwa in Form von HelpSmith.

All diese Programme und Dienste sind jedoch vor allem für die Organisation der Benutzerdokumentation und Hilfetexte sowie dem Export etwa als PDF-Handbuch sinnvoll, können aber natürlich das eigentliche Texten nicht übernehmen – hier wird nach wie vor ein erfahrener Autor benötigt.

Hilfe zur Selbsthilfe per Webforum

Gerade kleinere Entwickler schätzen eine weitere Form der Online-Dokumentation: Das Web-Forum. Dieses vereint Dokumentation und User-Support in einem System. Foren-Systeme gibt es wie Sand am Meer, das wohl Bekannteste ist dabei das Open-Source-Forum PHPBB.

Mit Hilfe eines Forums können einerseits mit wenig Aufwand wie bei einem Wiki Hilfetexte, FAQs und natürlich Anleitungen veröffentlicht werden. Gleichzeitig sind Foren aber auf Interaktivität und Hilfe zur Selbsthilfe ausgelegt, wodurch sich die Anwender-Basis gegebenenfalls selber hilft, was wiederum Support-Aufwand spart. Allerdings haben Foren den Nachteil, dass sie einen recht hohen Administrationsaufwand erfordern, um umtriebige Anwender im Zaum zu halten.

Dafür bietet ein Forum eine angenehme Möglichkeit, auch abseitige Fragen einzusammeln und gegebenenfalls in die Standard-Dokumentation aufzunehmen. Schließlich haben Entwickler nicht immer im Blick, welche Probleme ihre Software verursachen kann.

Für die Großen: Knowledge-Based-System

Microsoft hat es vorgemacht, viele andere größere Software-Anbieter haben es nachgemacht: Mit einem Knowledge-Base-System können komplexe Fragestellungen abgearbeitet und aufwändigere Probleme gelöst werden. Gleichzeitig dienen Knowledge-Based-Systeme (KBS) der Umleitung von Support- Anfragen und dem Einsparen entsprechener Ressourcen.

Moderne Systeme wie Zendesk besitzen inzwischen sogar KI-Funktionen, um dem Anwender bei der Problemlösung und Bedienung zu helfen. Gleichzeitig decken solche Systeme auch Online-Community, Kundenportal und Wissensdatenbank ab. Je nach System gibt es Überschneidungen zu den anderen Möglichkeiten der Benutzerdokumentation und Hilfe.

Der Fokus von KBS wie etwa FreshDesk oder Happyfox liegt aber eher auf der Lösung bestehender Probleme in Form eines Helpdesks samt Ticketing denn der grundsätzlichen Einarbeitung in die Software. Trotzdem kann ein entsprechendes System natürlich auch zur Bereitstellung von Online-Hilfetexten und -Anleitungen verwendet werden.

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: 45865536 / Software-Erstellung)