ST4 and context-sensitive help: The perfect combination

Context-sensitive help – what is it?

Context-sensitive help is therefore now a standard expectation of software users. But what does it actually mean and how is it different from other forms of help? Context-sensitive help is online help that provides information about a user interface element (e.g., a widget, a dialog element, or a menu) or about a task that is performed with this element. It is suitable whenever comprehensive concept knowledge is not important to the target group, and selective, small-scale information is required instead.

Context-sensitive help can either be delivered with the respective software packages or made available online, e.g., in the cloud or in a content delivery portal. Providing the information online is generally better for users since this means, for example, that they can always access up-to-date documentation content. However, it always reaches its limits when software has to be used without internet access or with restricted internet access (e.g., for security reasons).

Context-sensitive help is not only used for software packages. It also assists with the operation of web-based services and with machine displays (known as HMI Human Machine Interfaces).

Context-sensitive help – how does it work?

To ensure that the appropriate help always opens in the software, a number of things must be done in advance. This is because every time the user calls up the Help function, three pieces of information must be taken into account:

1. In which language should the Help function be opened? (Usually decided by the language of the software)

2. Which version of the software is being used? (Development versions and software scope)

3. Which task or user interface description is required at this point?

When the Help function is called on, in order for it to “know” which information is required at this point, unique identification codes (context IDs) must be used to establish the relationship between the software and the Help system. From these codes and the system information, a unique path of directory names and file parameters is then produced, which calls up the appropriate information in each case. In ninety percent of cases, these codes are specified by the software developers and the documentation is adapted to them. The codes can also be specified by the technical writing department. However, editorial reorganizations can lead to complex tasks if, for example, some of the software versions still refer to the old IDs and some already refer to the new ones.

Context-sensitive help – how does ST4 help?

A CCMS like ST4 can make creating context-sensitive help much easier. Every content module (referred to as a node in ST4) can be assigned one or more context IDs as metadata. Several IDs for one content module can be useful if the same information in the software is to be called up from several contexts, for example. Context IDs can be edited in a separate function module of ST4 and displayed both as a sequence of digits and as text. Context IDs as human-readable text can, for example, make quality assurance in software development significantly easier.

Normally, a user interface element will refer to a node. However, it’s also possible to save smaller content modules as fragments and reuse them in different Help files. Conversely, you can also combine several nodes in one Help file and display them for reading bit by bit by means of expandable areas (known as collapsibles). This can be particularly useful for smaller machine displays.

Context-sensitive help has become standard in technical communication for software. With a CCMS, help of this kind can be generated easily and flexibly to produce a variety of use cases. The content management functions of the CCMS allow the relationships between the software and help content to be managed simply and clearly. After all, only the right context makes sense to the user.

[Translate to Englisch:]

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.

[Translate to Englisch:]

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.