ST4 und Kontextsensitive Hilfe: Die perfekte Kombination

Veröffentlicht: 04.10.2023 Aktualisiert: 30.01.2024
Thema: XML Redaktionssystem

„Drückt man auf F1, dann öffnet sich die Hilfe!“ Das ist heute die Standard-Erwartung bei jeglicher Software. Standard ist auch, dass sich dann nicht ein schnödes pdf mit der Gesamtanleitung zu dem Software-Paket öffnen darf. Ein Hilfeaufruf soll immer Informationen zu genau dem aktuellen Bedienfeld und genau der aktuellen Aufgabe liefern. Aufwändiges Suchen in umfänglichen Dokumenten verunsichert hingegen die Softwarenutzer nur unnötig.

Kontextsensitive Hilfe – was ist das?

Kontextsensitive Hilfen sind also heute Standarderwartung der Softwarenutzer. Doch was verbirgt sich hinter dem Begriff und worin liegt der Unterschied zu anderen Hilfeformen? Kontextsensitive Hilfen sind Online-Hilfen, die über ein Oberflächenelement informieren (z. B. ein Widget, ein Dialogelement oder ein Menü) oder über eine Aufgabe, die mit diesem Element ausgeführt wird. Sie eignen sich immer dann, wenn es nicht auf umfassendes Konzeptwissen für die Zielgruppe ankommt, sondern nur punktuelle, kleinteilige Informationen notwendig sind.

Kontextsensitive Hilfen können entweder mit den jeweiligen Softwarepaketen ausgeliefert werden oder online bereitgestellt werden, z. B. in der Cloud oder in einem Content Delivery-Portal. Die Online-Bereitstellung ist im Allgemeinen für die Benutzer angenehmer, da so z. B. immer auf die aktuellen Dokumentationsinhalte zugegriffen werden kann. Sie stößt allerdings immer da an Grenzen, wo Software ohne Internetzugang oder mit eingeschränktem Internetzugang (z. B. aus Sicherheitsgründen) verwendet werden muss.

Kontextsensitive Hilfen werden nicht nur bei Software-Paketen im engeren Sinn eingesetzt. Sie unterstützen ebenfalls bei der Bedienung von webbasierten Diensten und bei Maschinendisplays (sogenannten HMI Human Machine Interfaces).

Kontextsensitive Hilfe – wie geht das?

Damit sich in der Software immer die passende Hilfe öffnet muss einiges vorab getan werden. Denn jeder Hilfeaufruf muss mindestens drei Informationen berücksichtigen:

1. Welche Sprache der Hilfe soll geöffnet werden (entscheidet sich normalerweise durch die Sprache der Software)

2. Welche Version der Software wird verwendet (Entwicklungsversionen und Softwareumfang)

3. Welche Aufgabe bzw. welche Oberflächenbeschreibung wird an dieser Stelle benötigt.

Damit ein Hilfeaufruf „weiß“, welche Information an dieser Stelle gewünscht ist, müssen deshalb eindeutige Identifizierungs-Codes (sog. Kontext-IDs) verwendet werden, die den Zusammenhang zwischen Software und Hilfesystem herstellen. Aus diesen Codes und den Systeminformationen wird dann ein eindeutiger Pfad aus Verzeichnisnamen und Dateiparametern hergestellt, der die jeweils passende Information aufruft. In neunzig Prozent der Fälle werden diese Codes von den Software-Entwicklern vorgegeben und die Dokumentation wird darauf angepasst. Zwar können die Codes auch aus der Technischen Redaktion vorgegeben werden. Es kann dann aber bei redaktionellen Umorganisationen zu komplexen Aufgabenstellungen kommen, wenn z. B. ein Teil der Softwareversionen noch auf die alten IDs verweist und ein Teil bereits auf neue.

Kontextsensitive Hilfe – wie hilft ST4?

Ein CCMS wie ST4 kann die Erstellung von kontextsensitiven Hilfen deutlich erleichtern. Jeder Inhaltsbaustein (in ST4 als Knoten bezeichnet) kann mit einer oder mehreren Kontext-IDs als Metadatum belegt werden. Mehrere IDs für einen Inhaltsbaustein können sinnvoll sein, wenn dieselbe Information in der Software z. B. aus mehreren Kontexten aufgerufen werden soll. Kontext-IDs lassen sich in einem eigenen Funktionsmodul von ST4 bearbeiten und sowohl als Ziffernfolge wie auch als Text darstellen. Kontext-IDs als menschenlesbarer Text können zum Beispiel die Qualitätssicherung bei der Software-Erstellung deutlich vereinfachen.

Im Normalfall wird ein Oberflächenelement auf einen Knoten verweisen. Es ist jedoch auch möglich, kleinere Inhaltsbausteine als Fragmente zu speichern und in unterschiedlichen Hilfedateien wiederzuverwenden. Umgekehrt ist es auch möglich, mehrere Knoten in einer Hilfedatei zusammenzufassen und sie durch Aufklappbereiche (sog. collapsibles) nach und nach zum Lesen anzubieten. Das kann besonders bei kleineren Maschinendisplays sinnvoll sein.

Kontextsensitive Hilfe ist mittlerweile Standard in der Technischen Kommunikation für Software. Mit einem CCMS lassen sich solche Hilfen einfach und flexibel erzeugen, so dass unterschiedlichste Anwendungsfälle abgebildet werden können. Die Contentmanagement-Funktionen erlauben dabei eine einfache und eindeutige Verwaltung der Bezüge zwischen Software und Hilfeinhalten. Denn erst der richtige Kontext ergibt für den Nutzer auch Sinn.

Andere Artikel von Quanos

Das könnte Sie auch interessieren

Augmented Reality mit SCHEMA ST4 - Miele zeigt, wie's geht

Augmented Reality mit SCHEMA ST4 - Miele zeigt, wie's geht

Ein Kunde steht vor seinem Wäschetrockner. Er möchte das Flusensieb reinigen. Anstatt das "Wie" in der gedruckten Anl…

Workflow Designer bei Positive Technologies - Optimale Integration von Menschen, Werkzeug und Prozessen

Workflow Designer bei Positive Technologies - Optimale Integration von Menschen, Werkzeug und Prozessen

Wer hohe Ansprüche an die Content-Qualität hat, braucht einen intelligenten Review-Prozess. Weil bei unserem internat…

Karlsruher Studenten liefern mit SCHEMA Inhalte bis nach Japan

Karlsruher Studenten liefern mit SCHEMA Inhalte bis nach Japan

Studierende der Hochschule Karlsruhe und der University of Aizu, Japan haben in einem gemeinsamen Hochschulprojekt te…