Handbuch und Online-Hilfe helfen beim Arbeiten mit der Software und bei der Installation und Konfiguration.

Handbuch und Online-Hilfe enthalten alles, was Anwender über ein Softwareprodukt wissen müssen.

Wir erstellen Handbücher und Online-Hilfen für verschiedenste Softwareprodukte. Auch bestehende Dokumente bringen wir auf den neuesten Stand.

Unser Ziel sind benutzerfreundliche Dokumente: kurz und prägnant, verständlich, anschaulich und inhaltlich aktuell.

Wir analysieren die Zielgruppen Ihrer Software, bestimmen den Informationsbedarf, recherchieren die Inhalte, schreiben die Texte und erstellen Screenshots und weiteres Bildmaterial. Abschließend produzieren wir die Dokumente im gewünschten Zielformat, beispielsweise als druckfähiges PDF-Handbuch und als Online-Hilfe in HTML.

Benutzerhandbuch

Das Benutzerhandbuch erklärt die Bedienung der Software aus Sicht der Endanwender. Es beschreibt die Konzepte der Software in einfacher und verständlicher Form und enthält konkrete Schritt-für-Schritt-Anleitungen.

Im Mittelpunkt stehen weniger die einzelnen Softwarefunktionen als vielmehr die Aufgaben und Ziele der Benutzer. Struktur und Inhalt orientieren sich maßgeblich an der Frage, welche Informationen die Benutzer zur Erledigung der Aufgaben benötigen.

Wir analysieren die Aufgaben der Benutzer, entwickeln daraus den Aufbau des Handbuchs, schreiben die Inhalte und testen die Vorgehensweise mit der Software. So stellen wir gleich sicher, dass die Vorgehensweise funktioniert und die Schritte vollständig beschrieben sind.

Kurzanleitung & Erste Schritte

Eine Kurzanleitung erklärt die am häufigsten verwendeten Funktionen auf ein bis zwei Seiten. Benutzer können sich so schnell einen Überblick über die Software verschaffen und Informationen bei Bedarf schnell nachschlagen.

Für das Erlernen einer Software ist der richtige Einstieg wichtig. Hier bietet sich eine „Getting Started“-Anleitung an. Die Anleitung führt Benutzer durch die ersten Schritte, erklärt die wichtigsten Begriffe und gibt Orientierung für das weitere Vorgehen.

Wir klären, ob eine Kurzanleitung oder ein „Getting Started“ für Ihr Softwareprodukt sinnvoll ist und wählen die passenden Informationen aus.

Tutorials

Für Anwendungen mit großem Funktionsumfang sind Tutorials eine sinnvolle Ergänzung zum Benutzerhandbuch.

Tutorials führen die Benutzer Schritt für Schritt durch größere und anspruchsvollere Aufgaben. Anhand konkreter Beispieldaten und Übungsdateien lassen sich die Schritte direkt in der Software nachvollziehen. So können auch Neueinsteiger optimal beim Erlernen komplexerer Funktionen unterstützt werden.

Installationsanleitung und Customizing-Dokumentation

Installationsanleitungen beschreiben die Systemvoraussetzungen und führen durch die Installation und Erstkonfiguration der Software. Sie sind besonders wichtig für die Installation komplexer Systeme, beispielsweise einer Client-Server-Lösung mit Datenbank, Webserver und Anbindung an die vorhandene Infrastruktur.

Die Customizing-Dokumentation unterstützt bei der Einrichtung und unternehmensspezifischen Anpassung der Software und richtet sich an Consultants und Administratoren.

Administrationshandbuch

Für umfangreiche Softwareprodukte wird meist ein Administrationshandbuch benötigt, das Themen wie Benutzerverwaltung, Konfiguration, Monitoring und Datensicherung beschreibt.

Entwicklerdokumentation

Für Software mit Programmierschnittstellen wird eine Entwicklerdokumentation benötigt. Die Entwicklerdokumentation umfasst die komplette Referenz der API-Funktionen und enthält geeignete Code-Beispiele. Ein Developer’s Guide hilft bei den ersten Schritten und erklärt die Verwendung der API.

APIs werden meist direkt im Sourcecode dokumentiert und die API-Dokumentation mit Tools wie Javadoc oder Doxygen generiert.

Wir unterstützen bei der Dokumentation von APIs durch Reviews und redaktionelle Bearbeitung von Code-Kommentaren. Zusammen mit der Entwicklung planen wir Struktur und Inhalt des Developer’s Guide, schreiben die Texte und integrieren Code-Beispiele.

Online-Hilfe

Eine Online-Hilfe hilft dort weiter, wo eine Frage auftaucht, nämlich direkt am Rechner während der Arbeit mit der Software.

Für Cloud-Anwendungen, Online-Dienste und Webanwendungen ist eine Online-Dokumentation das Medium der Wahl. Aber auch bei Desktop-Anwendungen sind Online-Hilfen Standard.

Je nach Anwendung läuft die Online-Hilfe im Web, auf einem unternehmensinternen Server oder lokal auf dem Desktop-Rechner.

Für Online-Hilfen gibt es verschiedene Formate. Hier eine kleine Auswahl:

  • Responsives HTML5
    HTML5-basierte, plattformunabhängige Online-Hilfe, deren Darstellung sich automatisch an das Endgerät (Monitor, Tablet, Smartphone) anpasst.
  • WebHelp
    HTML-basierte Hilfe mit JavaScript, die ebenfalls plattformunabhängig ist.
  • HTMLHelp
    HTML-basiertes Hilfeformat von Microsoft, bei dem die Hilfe in Form einer einzigen Datei (CHM-Datei) ausgeliefert wird. Die Hilfe läuft auf Windows 32-Bit Plattformen und setzt den Microsoft Internet Explorer voraus.
  • Eclipse Help
    HTML-basiertes Standardformat für Anwendungen, die auf der Eclipse-Plattform basieren.
  • JavaHelp, Oracle Help
    HTML-basiertes Standardformat für Java-Anwendungen.

Wenn Sie den Umstieg auf eine Online-Dokumentation planen, klären wir zusammen mit der Entwicklung, welche Anforderungen und Rahmenbedingungen wichtig sind und welches Format am besten passt.

Je nach Redaktionssystem ist auch ein Single-Source-Ansatz möglich, bei dem Handbuch und Online-Hilfe aus einer Quelle produziert werden.

Kontextsensitive Hilfe

Eine kontextsensitive Hilfe zeigt Informationen an, die genau zum aktuellen Fenster passen. Das passende Hilfethema wird automatisch geöffnet oder beispielsweise mithilfe der F1-Taste angezeigt. Das macht es Benutzern besonders einfach, zu den relevanten Informationen zu gelangen.

Der Aufruf einer kontextsensitiven Hilfe lässt sich in der Software mit verschiedenen Methoden umsetzen.

Wir klären mit den Softwareentwicklern, welche Methode am besten geeignet ist und welche Aufgaben bei Technischer Redaktion und Softwareentwicklung liegen. Auf dieser Basis erstellen wir die Hilfetexte im passenden Format und liefern die Hilfe zur Integration in die Software. Mit Integrationstests stellen wir abschließend sicher, dass der Aufruf aus der Software korrekt funktioniert.