News

Software-Dokumentation und Online-Hilfen

Masterarbeit zum Thema Software-Dokumentation und Online-Hilfen
Quelle: Fotolia_48319769: © jd-photodesign / Fotolia.com

In der Vergangenheit wurden Benutzerhandbücher für Software (z. B. Steuerungssoftware für Maschinen) in der Regel als Printdokument ausgeliefert und waren dementsprechend umfangreich und unhandlich. Mittlerweile werden gedruckte Handbücher oft auf das Wesentliche reduziert und sind dementsprechend benutzerfreundlicher gestaltet. Der überwiegende Teil an Informationen wird inzwischen komfortabel in Form von Hypertexten in Online-Hilfen zur Verfügung gestellt. Diese Hilfe-Informationen können auch direkt in die Software eingebettet sein, sodass sie nicht extra vom Nutzer geöffnet werden müssen.

Durch diese Form der Dokumentation ergeben sich viele Vorteile, wie z. B. Kosteneinsparungen bei der Verbreitung sowie schnelle und einfache Aktualisierungsmöglichkeiten. Wegen dieser Vorteile und durch die mittlerweile einfache technische Umsetzbarkeit, ersetzen Online-Hilfen die gedruckten Handbücher fast vollständig. Nur die Informationen, die auch vor der Installation oder beispielsweise bei einem Systemabsturz den Nutzern bereitgestellt werden müssen, werden zusätzlich gedruckt oder für den Druck vorbereitet (beispielsweise als PDF) zur Verfügung gestellt.

MAXKON hat in den vergangenen Monaten eine Masterarbeit zum Thema Softwaredokumentation betreut. Das Ziel der Arbeit war, einen möglichst einheitlichen und universell zu verwendenden Workflow zu schaffen, auf dessen Grundlage MAXKON effiziente Dienstleistungen für das Thema Softwaredokumentation anbieten kann.

Im Rahmen dieser Arbeit wurden:

  • Die möglichen Hilfeformate validiert.
  • Die gängigen Tools zur Erstellung von Softwaredokumentation und Online-Hilfen untersucht.
  • Ein universeller Styleguide zur Erstellung von Online-Hilfen erstellt.

An einer Online-Hilfe für die Firma Projektmotor wurden die Ergebnisse der Masterarbeit konzeptionell umgesetzt.

MAXKON ist damit in der Lage verschiedenste Kundenanforderungen für Softwaredokumentation effizient umzusetzen.

Zurück