In der Softwaredokumentation sind digitale Informationsmedien schon lange gelebte Praxis. Doch auch in anderen Technikbereichen, wie z. B. dem Maschinenbau, kommen digitale Medien immer mehr zum Einsatz. Ziel ist es hier, die Informationen auf demselben Medium auszugeben, auf dem auch die eigentliche Bedienung der Software oder des Produkts stattfindet. Die Information wird so quasi zum Produktbestandteil. Das bedingt eine intensivere Abstimmung von Informationserstellung und Anwendungsentwicklung, denn meistens werden hier die Nutzerinformationen zusammen mit der Software ausgeliefert.
Klassische Online-Hilfen
Die Online-Hilfe ist ein Klassiker bei der Anwenderinformation im Rahmen von Softwareprojekten. Hier gibt es mittlerweile eine Menge unterschiedlicher Formate, die sich an den verschiedenen Entwicklungsplattformen orientieren.
Gängige Online-Hilfe-Formate sind z. B.
-
Windows-Hilfe (hlp)
-
HTML Help (chm)
-
Java Help
-
Eclipse Help
Die Erstellung von Online-Hilfen erfolgt durch unsere Technischen Redakteure im medienneutralen XML-Format, aus dem sich problemlos die verschiedenen Hilfe-Formate generieren lassen. Hierzu setzen wir Redaktionssysteme oder spezielle Applikationen für Online-Hilfen ein.
Kontextsensitivität macht die Hilfe erst nützlich
Besonders wertvoll wird eine Online-Hilfe, wenn sie kontextsensitiv ist. Das bedeutet, dass beim Aufruf der Hilfe eine Information über das geöffnete Fenster der Software mitgegeben und die dazu passende Hilfeseite angezeigt wird. So bekommt der Nutzer genau die Informationen, die er in der aktuellen Situation benötigt.
Die Verknüpfung von Software und Information erfolgt klassisch über Einsprungmarken. Die dafür erforderlichen IDs werden im Softwareentwicklungsprozess festgelegt und dann in die Redaktion übernommen. Dies erfordert eine intensive Abstimmung zwischen Entwickler und Redakteur.
Alternativ lässt sich eine solche Verknüpfung auch über die PI-Klassifizierung nach Ziegler erreichen. Diese bietet im Gegensatz zu den statischen Einsprungmarken eine größere Transparenz und Flexibilität im Erstellprozess.
Die Kontextsensitivität lässt sich übrigens auch für die Anzeige von Informationen zur Behebung von Störungen und Fehlerzuständen nutzen. So ist es beispielsweise möglich, auf dem Display einer Maschine die Schritte zur Behebung einer Störung oder im Automobil Detailinformationen beim Aufleuchten von Warnleuchten einzublenden.
Embedded Help
Eine weitere Ausbaustufe der kontextsensitiven Hilfe ist die Embedded Help. Hierbei werden die Inhalte in die Softwareoberfläche integriert, so dass für den Nutzer der Übergang zwischen Software und Informationsprodukt gar nicht wahrnehmbar ist.
Der in der Embedded Help angezeigte Inhalt wechselt, abhängig von den Aktionen, die der Benutzer in der Software ausführt, ganz automatisch. So wird permanent darüber informiert, welche Schritte als Nächstes durchzuführen sind oder wie Arbeiten effizienter gestaltet werden können.
Da der Platz für die Embedded Help häufig limitiert ist, bietet es sich an, hier nur Kurzfassungen anzuzeigen und dem Nutzer die Möglichkeit anzubieten, per Klick die Langfassung der Information aufzurufen.
Aufruf von Software oder Hardware-Funktionen aus der Hilfe heraus
Eine besonders hilfreiche Form der Benutzerunterstützung lässt sich entwickeln, wenn nicht nur die Hilfe aus der Software heraus aufgerufen werden kann, sondern wenn auch Softwarefunktionen aus der Hilfe heraus gestartet werden können. So lassen sich z. B. für komplexe Handlungsabläufe wie Umrüstarbeiten Wizards erstellen, in denen die Nutzer Schritt für Schritt geführt werden oder aber auch eigenständig Funktionen aus der Hilfe heraus starten können. So werden die Nutzer ideal geleitet und Fehler im Ablauf vermieden.
HTML- und HTML5-Ausgaben
Neben der Integration von Informationen in Software besteht manchmal auch der Bedarf, Inhalte in anderen Systemen, wie z. B. Web-Portalen oder Unternehmensanwendungen, bereitzustellen. In diesen Fällen werden oft spezielle XML- oder HTML-Formate gefordert, die sich in die führenden Anwendungen importieren lassen.
Auch die Erstellung von Stand-Alone-HTML5-Anwendungen zur Verbreitung von Informationsprodukten kann eine Anforderung sein.
Solche Aufgabenstellungen sind dank der medienneutralen Erstellung im XML-Format schnell gelöst. Hier können wir auf standardisierte Ausgabestrecken zurückgreifen, die wir bei Bedarf kundenspezifisch anpassen, so dass die Anforderungen der Zielsysteme mit geringem Aufwand vollständig erfüllt werden können.
In-App-Dokumentation
Eine besondere Form der Embedded Help ist die In-App-Dokumentation. Hier werden die Inhalte nicht in eine PC-Software, sondern in eine mobile App eingebettet. Die Herausforderung hier ist – insbesondere bei Apps für Mobiltelefone – der geringe Raum, der auf dem Display zur Verfügung steht. Die technische Umsetzung ist dabei für unsere Anwendungsentwickler Routine; hier kommt es vor allem auf gute redaktionelle Konzepte an.