Artikel

Topic-Orientierung in der Technischen Kommunikation

Die Technische Kommunikation steht vor der Herausforderung, komplexe Informationen klar und verständlich zu vermitteln. Traditionell werden Informationen in umfangreichen, zusammenhängenden Dokumenten organisiert. Jedes Dokument behandelt eine Vielzahl von Themen, die oft in einer linearen Struktur präsentiert werden. Änderungen und Aktualisierungen erfordern häufig das Durchsuchen und Überarbeiten des gesamten Dokuments, was zeitaufwendig und fehleranfällig sein kann. Zudem stellt sich die Frage, ob Anwenderinnen und Anwender wirklich immer ein ganzes Dokument oder doch nur Teile aus dem Dokument benötigen.

Die Umstellung von einer Dokumenten-basierten auf eine Topic-orientierte Herangehensweise in der Technischen Kommunikation bringt tiefgreifende Veränderungen mit sich, die zahlreiche Vorteile bieten.

Doch was genau verbirgt sich hinter diesem Begriff der Topic-Orientierung, und warum ist er für die technische Kommunikation so sinnvoll?

Was sind Topics?

Topics sind die kleinen, in sich geschlossenen Informationseinheiten in der Technischen Kommunikation. Sie behandeln ein spezifisches Thema oder beantworten eine konkrete Frage. Ein Topic kann beispielsweise eine Anweisung zur Bedienung eines Geräts, eine Erklärung eines Konzepts oder technische Daten sein. Topics können unabhängig voneinander erstellt, aktualisiert und wiederverwendet werden.

Es gibt einige Kriterien für Topics, die bei der Erstellung beachtet werden sollten.

  • Kohärent: Ist das Topic inhaltlich geschlossen?
  • Kohäsiv: Verweisen sprachliche Mittel in einem Topic nicht über das Topic hinaus?
  • Informativ: Liefert das Topic wertvolle Informationen?
  • Situativ: Ist das Topic im Handlungskontext relevant?
  • Intertextuell: Ist das Topic zu anderen Topics anschlussfähig?

Vom Dokument zum Topic

Topic-Orientierung ist der methodische Ansatz, bei dem die gesamte Dokumentation in einzelne Topics aufgeteilt wird. Anstatt lange, zusammenhängende Texte zu erstellen, wird der Inhalt in kleine, spezialisierte Einheiten zerlegt. Diese Einheiten können dann je nach Bedarf zusammengestellt, neu geordnet und in verschiedenen Formaten veröffentlicht werden.

Die Topic-Orientierung bietet folgende Vorteile für die Technische Redaktion:

  • Wiederverwendbarkeit: Einmal erstellte Topics können in unterschiedlichen Dokumentationen und Kontexten wiederverwendet werden.
  • Konsistenz: Für jeden Topictyp gibt es eindeutige Regeln, wie dieser strukturiert und formuliert werden muss.
  • Flexibilität: Topics können leicht reorganisiert und angepasst werden, um den spezifischen Anforderungen unterschiedlicher Zielgruppen und Publikationskanäle (Web, Print, Mobile) gerecht zu werden.
  • Aktualisierung: Änderungen müssen nur einmal in einem Topic vorgenommen werden und sind sofort in allen Dokumenten wirksam, die dieses Topic verwenden.
  • Zielgerichtete Information: Inhalte können zielgerichtet auf die Bedürfnisse der jeweiligen Zielgruppe zugeschnitten werden.
  • Skalierbarkeit: Mit wachsendem Informationsumfang bleibt die Dokumentation übersichtlich und gut strukturiert.

Die Rolle von Metadaten

Metadaten sind ein zentraler Bestandteil der Topic-Orientierung. Sie sorgen für eine systematische und effiziente Organisation und zielgerichtete Bereitstellung der Inhalte. So werden Topics beispielsweise über Informations-spezifische Metadaten in unterschiedliches Topic typen eingeteilt. So genannte Produkt-spezifische Metadaten wiederum verorten ein Topic an der Stelle am Produkt (z. B. einer Komponente), zu der dieses Topic gehört.

Mit Topics bereit für die Zukunft

Die Topic-Orientierung bereitet die Technische Kommunikation auf die Anforderungen der Industrie 4.0 vor, indem sie eine flexible, effiziente und konsistente Erstellung von technischen Inhalten ermöglicht. Durch die Aufteilung der Inhalte in kleine, wiederverwendbare Einheiten können Redakteure ihre Produktivität steigern und gleichzeitig die Qualität ihrer Arbeit verbessern. Die Modularisierung erleichtert die Arbeit im Team, da einzelne Topics von verschiedenen Autoren erstellt und bearbeitet werden können.

Der Umstieg von Dokumenten zu Topics bedeutet für die Redaktion konkret die Entwicklung einer geeigneten Content-Strategie, die Auswahl und die Einführung geeigneter Tools und Technologien, die Erstellung von Taxonomien und das Umwandeln der Inhalte in Topics. Dieser Prozess erfordert zwar initialen Aufwand und sorgfältige Planung, führt aber langfristig zu signifikanten Vorteilen für die technische Redaktion und die Benutzer der Dokumentation. Langfristig ermöglicht die Topic-Orientierung also eine effizientere und produktivere Arbeitsweise, die den Anforderungen moderner Technischer Kommunikation gerecht wird.

Abonnieren Sie den kostenfreien Newsletter von PANTOPIX.
Wir informieren Sie gerne regelmäßig über neue Artikel.

Artikel

PIM-Systeme auf Basis von Wissensgraphen

Industrien verlassen sich auf Product Information Management (PIM)-Systeme, um Produktinformationen zu erstellen, zu verwalten und über verschiedene Kanäle zu verteilen. 

Die Herausforderungen, die dabei auftreten, können wir mit der Entwicklung von PIM-Systemen auf der Basis von Wissensgraphen entgegnen. 

weiterlesen >
Artikel

Knowledge Graph Embeddings

Unterschiedliche Datenquellen in einer Wissensdatenbank zusammenzuführen und die semantische Repräsentation der dort enthaltenen Informationen können die Technische Kommunikation erheblich erleichtern. Der Aufbau einer Wissensdatenbank mithilfe semantischer Wissensgraphen bietet zahlreiche Vorteile, darunter die wichtige Möglichkeit, den Wissensgraphen kontinuierlich zu erweitern. Eine Methode zur Erweiterung des Wissens besteht in der Anwendung von Einbettungen für Wissensgraphen (Knowledge Graph Embeddings).

weiterlesen >
Artikel

Docs-as-Code: Automatisierte Software Dokumentation

Die Welt der Softwareentwicklung verändert sich ständig, und mit ihr auch die Art und Weise, wie wir Software dokumentieren. Eine innovative Methode, die in den letzten Jahren an Popularität gewonnen hat, ist “Docs-as-Code” oder Dokumentation als Code. In diesem Artikel werden wir uns mit dieser spannenden Entwicklung auseinandersetzen und den Anwendungsbereich in der Technischen Dokumentation genauer beleuchten.

weiterlesen >

Ihr Ansprechpartner

Prof. Dr. Martin Ley
Partner und Senior Consultant