Im Topic steckt Großes

Text: Sissi Closs

Wie funktioniert ein Topic? Was bringt es für das Erstellen von Informationen? Das fragte ein Teilnehmer in einer Umfrage zur tekom-Jahrestagung 2018. Hier folgen die Antworten.

Inhaltsübersicht

Lesedauer: 08:40 Minuten

In den 1970ern gehörte Friedrich Schumacher zu den Wegbereitern einer neuen ökologischen Weltsicht. Deren Grundprinzip lautete „small is beautiful“ – das Kleine ist besonders und hat viel Potenzial. Auch in der Technischen Kommunikation hat sich dieses Prinzip bewährt und mit der Topic-orientierten Strukturierung methodisch etabliert. Informationen werden in überschaubaren Einheiten erfasst. Diese Topics können dann passend für die Situation, den Bedarf und die mediale Ausstattung zur Verfügung gestellt werden [1]. Wie das aussehen kann, zeigt Abbildung 01.

Quelle Sissi Closs

Abb. 01 Topic-orientierte Strukturierung. Quelle Sissi Closs

In der Welt der Bücher wird das Topic-Prinzip schon lange angewandt. Das bekannteste Beispiel sind Begriffserklärungen. Ein Begriff wird an einer Stelle so erklärt, dass die Erklärung korrekt, im Umfang überschaubar und ohne weiteren Kontext verständlich ist. Eine einzelne Erklärung kann dann überall verwendet werden, wo der Begriff vorkommt und erklärt werden soll. Zusätzlich können Erklärungen, zum Beispiel fach- oder produktbezogen, als Glossare nach vertrauten Ordnungskriterien (alphabetisch, thematisch) zusammengestellt und als Nachschlagewerk zur Verfügung gestellt werden.

Vorteile für die Nutzung

Je mehr technische Möglichkeiten und Ausgabekanäle das Prinzip der Topic-orientierten Strukturierung unterstützen, desto wirkungsvoller kann es sein.

Direkter Zugang und passgenaue Information – bei Online-Hilfen für Software und der bereitgestellten Technik – insbesondere Hyperlinks mit unterschiedlichem Link-Verhalten (Sprung, Pop-up, expandierend, kontextsensitive Aufrufe von Hilfe-Topics) – sind die Vorteile einer Topic-basierten Modularisierung erstmalig zur Geltung gekommen.

Beispiel Feldhilfe – gemäß einer gängigen, sehr granularen Modularisierungsregel wird häufig pro Oberflächenelement ein separates Topic erstellt. Es kann aus einer Software kontextsensitiv aufgerufen werden – Abbildung 02. Die Nutzerinnen und Nutzer erhalten so in einer konkreten Anwendungssituation einen direkten Zugriff auf die passende Information, falls die Topics richtig gemacht wurden.

Quelle Sissi Closs, Microsoft

Abb. 02 Kontextsensitive Hilfe in MS Word. Quelle Sissi Closs

Dank technischer Weiterentwicklung können heute nicht nur bei Softwareprodukten situations- und kontextbezogen Informationen abgerufen werden. Das funktioniert in einigen Fällen mit einer Augmented-Reality-Anwendung für technische Geräte, Maschinen, Ausstellungsobjekte in Museen oder auch Alltagsgegenstände. Abbildung 03 zeigt eine kontextbezogene Information.

Quelle Sissi Closs

Abb. 03 Eine Information wird direkt an der Gerätedarstellung abgerufen. Quelle Sissi Closs

Attraktiv und zeitgemäß – technische Entwicklungen verändern das menschliche Verhalten und die Erwartungshaltung. Das wusste schon der kanadische Medienwissenschaftler Marshall McLuhan in den 1960er Jahren nach Einführung des Fernsehens: „The medium is the message because it is the medium that shapes and controls the scale and form of human association and action.“ [2]. John Culkin bestätigt dies in seinem Artikel „A Schoolman’s Guide To Marshall McLuhan“: „We shape our tools and thereafter they shape us.“ [3]

Internet und mobile Endgeräte haben dazu geführt, dass schnelles Auffinden von Informationen auf dem gerade verwendeten Endgerät wichtiger geworden ist als eine umfassende Recherche. Selektives und fragmentiertes Lesen löst gründliches Lesen (Deep Reading) ab, da Details jederzeit wieder abgerufen werden können. Das wiederum hat entscheidende Auswirkungen darauf, welche Informationen angenommen und genutzt werden: kleine Portionen in der jeweils für die Situation passenden Form (Text, Audio, Video oder Signale) mit der Möglichkeit, weitere Informationen bei Bedarf zu erhalten (Progressive Disclosure).

Vorteile für die Redaktion

Betrachtet man Topics aus Sicht der Personen, die Informationen entwickeln, dann werden bei der Topic-orientierten Strukturierung Inhalte nach dem Single-Source-Prinzip erstellt, geprüft, gepflegt und übersetzt.

Steigerung der Effizienz und Qualität – da Topics kleine Einheiten sind, lassen sie sich schneller erstellen, leichter verstehen und gut kommunizieren. Die Technische Redaktion kann Vorlagen für Topics bereitstellen, die die Autoren unterstützen und für Einheitlichkeit sorgen. Das hilft, Konsistenz einzuhalten, Redundanz und Fehler zu vermeiden, Umfänge zu reduzieren, Arbeiten im Team aufzuteilen und Kosten zu verringern.

Schnelle Reaktion auf Nutzerwünsche – mit einem Topic kann auf Nutzerwünsche schnell reagiert werden. Falls es nur eine Stelle für den Inhalt gibt („Point of Truth“), ist ein zu änderndes Topic leicht zu identifizieren. Wegen des überschaubaren Umfangs lässt es sich schnell ändern und prüfen.

Die Erstellungsseite kann im Sinne einer guten „User Assistance“ flexibel und schnell Inhalte modifizieren, aktualisieren, ergänzen und passend zur Verfügung stellen. Wie schon das Glossarbeispiel zeigt, lassen sich aus einem Pool von Topics Zusammenstellungen ganz nach Bedarf erzeugen, natürlich auch Gebrauchs- und Betriebsanleitungen.

Unterstützung für die Verwaltung – Vorgaben für Benennungen und Ablage sorgen bei wachsenden Umfängen dafür, dass die Menge an Topics auch bei großen Stückzahlen kontrollierbar bleibt. Dafür sind passende Klassifizierungen erforderlich. Die Klassenkonzept-Technik ist eine in der Praxis bewährte Methode, ausgehend von etablierten Topic- und Link-Klassen iterativ die für einen Einsatzbereich passenden Klassen zu definieren [1].

Mit einem Klassenkonzept ist die Technische Redaktion gut gerüstet. Anstatt jedes Topic und jeden Link einzeln zu planen, wird für jeden Topic-Typ eine Vorlage erarbeitet. Mit ihr können die Autoren insoweit unterstützt werden, dass nur noch wenige Angaben in einem Formular erforderlich sind. Daraus wird dann das eigentliche Topic generiert. Für die technische Umsetzung gibt es vielfältige Möglichkeiten bis hin zu dedizierten Spezialtools für die Topic-Welt. Sie unterstützen die Aufgaben der Technischen Redaktion.

Aufteilen ja – aber wie?

Neben der Normenreihe 2651x für Software-Dokumentation [4] enthält auch Edition 2 der Horizontalnorm IEC/IEEE 82079-1 [5] eine Topic-Definition: „coherent part of an information product with a heading that deals with a single subject“.

Die Norm nennt explizit Einsatzbereiche, zum Beispiel für die Wartung: „Separate information shall be provided for maintenance that can be performed by non-skilled and skilled persons, preferably as separate information products or topics.“

Ungeeignete traditionelle Strukturierungsansätze – eine passende Inhaltsaufteilung zu finden, ist nicht einfach. Eine Vorgehensweise, die sich an der Informationsentwicklung für Bücher orientiert, erweist sich für eine gute Inhaltsaufteilung als hinderlich. In Installations- und Montageanleitungen, Bedienungsanleitungen, Wartungs- und Reparaturanleitungen haben sich Strukturen etabliert, die Produkte meist monolithisch aus Produkt- und Herstellersicht darstellen. Es werden weder die unterschiedlichen Nutzerkontexte und -bedarfe berücksichtigt, noch die Medien passend bedient.

Die Beispiele in Abbildung 04, 05 und 06 zeigen Elemente aus einer Bedienungsanleitung für ein Smartphone.

Quelle Sissi Closs

Abb. 04 Gerätebeschreibung in der Bedienungsanleitung eines Smartphones. Quelle Sissi Closs

Quelle Sissi Closs

Abb. 05 Unvollständige (Sprachsuche fehlt) und unverständliche (Unterschied Textsuche/Suche?) Erklärung der Suchfunktionen. Quelle Sissi Closs.

Quelle Sissi Closs

Abb. 06 Erklärung der Suchfunktion inklusive Sprachsuche. Quelle Sissi Closs

Bereits diese drei Ausschnitte zeigen einige typische Schwachstellen:

  • terminologische Inkonsistenzen, hier „Suche“/„Sprachsuche“/„Voice-Suche“, „Suchtaste“/„Suchen“
  • mehrfache Erklärungen des gleichen Sachverhalts, aber keine identische Information (wie funktioniert Sprachsuche?)
  • keine schnellen Zugangsmöglich­keiten, etwa wenn nur die Information zur Sprachsuche gewünscht ist

Mängelbeseitigung durch Topic-orientierte Strukturierung – die Schwachpunkte kann eine Topic-orientierte Strukturierung beheben, falls die Konzeption der Inhaltsaufteilung folgende Fragestellungen hat, und zwar unabhängig von herkömmlichen Informationsangeboten. Aus Sicht der Nutzung:

  • Welche Informationen werden wann, wie oft, wo und von welcher Nutzergruppe benötigt?
  • Wie kann die benötigte Information am effektivsten erstellt und übermittelt werden?

Aus Sicht der Erstellung:

  • Ergibt sich aus der angedachten Inhaltsaufteilung eine Systematik, die einfach und konsequent eingehalten werden kann?
  • Wie kann die Erstellung der Inhalte verteilt werden, so dass die fachliche Expertise im Team genutzt und Arbeiten parallel durchgeführt werden können?
  • Wie können Informationen durch Automatisierung und Vernetzung von Quellen generiert und kompakt dargestellt werden?

Werden Topic-Klassen basierend auf solchen Fragestellungen konzipiert, entwickelt sich iterativ und sukzessive ein Klassenkonzept. Das Konzept unterstützt die Autoren klar, verständlich und nachvollziehbar bei der Inhaltsaufteilung. Außerdem lässt es sich kontinuierlich weiterentwickeln, um an Veränderungen angepasst zu werden und Verbesserungen einzubringen.

Modularisierungskonzept für Änderungsbeschreibung für Maschinen – in einem Masterprojekt im Sommersemester 2018 an der Hochschule Karlsruhe wurde für einen Maschinenhersteller ein Modularisierungskonzept entwickelt [6]. Das Konzept sollte die Schwachstellen bestehender monolithischer Änderungsbeschreibungen verringern, die sich nicht am Bedarf von Servicetechnikern ausrichten. Ausgangspunkt für die Konzeption der Inhaltsaufteilung waren die folgenden Informationsbedürfnisse der Servicetechniker bei ihren Reparaturarbeiten:

  • Um welches Bauteil handelt es sich?
  • Warum wurde das Bauteil geändert?
  • Ist das alte Bauteil noch lieferbar?
  • Ist das neue Bauteil für die vorliegende Maschine verwendbar?
  • Ist die Verwendung des Bauteils von weiteren Bauteilen abhängig?
  • Hat sich der Reparaturvorgang geändert?

Um diesen Bedarf genau bedienen zu können, haben die Studierenden eine fein-granulare Topic-Struktur konzipiert. Sie stellt das Bauteil in den Mittelpunkt und sieht für eine Bauteilbeschreibung drei Topics mit jeweils eigenem Topic-Typ vor (Abb. 07).

Quelle Stefan Barth, Eva Nauerth, Christiane Wahl

Abb. 07 Die Inhaltsaufteilung,entwickelt im Masterprojekt. Quelle Stefan Barth, Eva Nauerth, Christine Wahl

So wird der Erstellungsprozess effizienter und die verschiedenen Informationsbedürfnisse können erfüllt werden. Die Inhaltsaufteilung auf Basis dieses Klassenkonzepts in Kombination mit passenden Tools auf Erstellungs- und Nutzungsseite hat das Potenzial, alle genannten Informationsbedarfe effizient zu erfüllen. Inhalte werden deutlich kürzer und trotzdem prägnanter und aussagekräftiger als in der klassischen Änderungsbeschreibung, Teile der Inhalte können automatisch durch die Verknüpfung mit Produktdatenbanken generiert werden und Servicetechniker können gezielt nur die Informationen für das Bauteil abrufen, das gerade für einen Reparaturvorgang relevant ist.

Geeignete Umsetzung mit DITA

Für die technische Umsetzung von Topics und Informationsstrukturen bietet sich der DITA-Standard an. DITA steht für Topic-orientierte Strukturierung auf Basis von XML. Im Mai 2005 hat OASIS, Organization for the Advancement of Structured Information Standards, Version 1.0 verabschiedet. Heute steht DITA als Open-Source-Architektur in Version 1.3 zur Verfügung. DITA unterstützt die Klassifizierung und bietet vorbereitete Strukturen für die gängigen Topic-Typen:

  • Beschreibung (<concept>)
  • Anleitung (<task>)
  • Begriffserklärung (<glossentry>)
  • Fehlerbehandlung (<troubleshooting>)
  • Faktenbeschreibung (<reference>)

Mit diesen Topic-Typen kann ein Konzept für die Inhaltsaufteilung gestartet, ausgebaut und mit der Zeit verfeinert werden. Topic-Strukturen lassen sich auch ohne DITA umsetzen. Allerdings sorgen XML und die Standardisierung von DITA für Kosteneinsparung und Investitionssicherheit. DITA gibt einen Rahmen vor, in dem Technische Redakteure direkt mit der Arbeit beginnen können – ohne dass sie eine Struktur erst entwickeln müssen. Die wachsende Verbreitung von DITA und eine breite Unterstützung mit Werkzeugen führen dazu, dass die Fachkreise mehr und mehr DITA-Know-how für den fachlichen Austausch und über gelungene Umsetzungen haben. Eine große DITA-Gemeinde steht für den offenen Austausch zur Verfügung.

Die Topic-orientierte Strukturierung für die Informationsentwicklung eignet sich für die heutigen Anforderungen der Nutzungs- und Erstellungsseite. Sie bietet die benötigten Möglichkeiten für einen direkten, zielgerichteten Zugang zu Informationen, die für einen konkreten Nutzungskontext passen. Für die Seite der Technischen Redaktion ergeben sich Vorteile, falls geeignete technische Unterstützung zur Verfügung steht. Der offene DITA-Standard zusammen mit der kostenfreien Referenzimplementierung durch das DITA Open Toolkit bieten dazu einfache und kostengünstige Möglichkeiten. 

links und literatur zum beitrag

[1] Closs, Sissi (2011): Single Source Publishing – Modularer Content für EPUB & Co. Frankfurt, Verlag entwickler.press.

[2] McLuhan, Marshall (1964): Understanding Media: The extensions of man. New York: Gingko.

[3] Culkin, John (1967): A Schoolsman`s Guide to Marshall McLuhan“ In: The Saturday Review (1967), S. 51–53, S. 70–72.

[4] Closs, Sissi (2018): Immer der Reihe nach. In: technische kommunikation, H. 3, S. 44–47.

[5] Klumpp, Claudia (2019): Neue IEC/IEEE 82079-1 Ed. 2 ab sofort online erhältlich; https://www.tekom.de [letzter Zugriff: 10. August 2019].

[6] https://www.hs-karlsruhe.de/kmm-b/aktuelles/aktuelles-detail/news/masterprojekt-fuer-die-firma-stihl/ [letzter Zugriff: 10. August 2019].

Im Topic steckt Großes