Wie KI die technische Redaktion verändert: Struktur
Gedruckte Dokumentation hat modularen, themenorientierten digitalen Ressourcen Platz gemacht. Dieser Wandel zu strukturierter Produktdokumentation ist entscheidend für Unternehmen, die neue KI-Technologien integrieren. Erfahren Sie, warum Struktur digitaler technischer Dokumentation in einer zunehmend KI-geprägten Welt Mehrwert schafft.
Hinweis: Dieser Blogartikel wurde aus seiner Originalversion übersetzt und kann geringfügige Abweichungen enthalten. Einige der Links in diesem Artikel führen zu Inhalten, die nur auf Englisch verfügbar sind.
Die Optimierung Ihrer technischen Dokumentation ist zentral für eine positive Produkterfahrung. Historisch gesehen haben technische Dokumentationsteams Nutzern gebundene Bücher und Handbücher zur Verfügung gestellt, doch der Wandel zur digitalen Dokumentation hat die Art und Weise, wie Informationen bereitgestellt werden, grundlegend verändert. Gedruckte Materialien haben modulareren, themenorientierten Ressourcen wie Artikeln, Wissensdatenbanken, interaktiver Dokumentation und sogar KI-generierten Antworten auf Fragen Platz gemacht, sodass Nutzer nicht einmal das Quellmaterial lesen müssen. Während diese Entwicklung Informationen zugänglicher gemacht hat, hat sie auch neue Herausforderungen bei der Strukturierung und Pflege konsistenter Inhalte mit sich gebracht, die an sich entwickelnde Technologien wie KI-Anwendungen anpassbar sind.
Um Teams durch diese Herausforderungen zu führen, habe ich eine Serie von drei Artikeln vorbereitet, in denen jeder Artikel sich mit einer Schlüsselkomponente für moderne Dokumentation befasst. In diesem ersten Artikel untersuchen wir, wie Struktur digitaler technischer Dokumentation in einer KI-Welt Mehrwert schafft.
Wie sich die Veröffentlichung von Dokumentation verändert
Da die digitale Bereitstellung von Inhalten zur Norm wird, bewegen sich Unternehmen weg von statischer, dokumentenbasierter Veröffentlichung. Gleichzeitig gestalten aufkommende Technologien Benutzeroberflächen neu und definieren neu, wie Menschen mit Informationen interagieren – aufgrund der Erwartungen an moderne Zugänglichkeit, Aktualität von Inhalten und Auffindbarkeit von Informationen.
Unternehmen, die noch nicht umgestellt haben, werden dies in den kommenden Jahren tun müssen, insbesondere angesichts der Kundennachfrage und Vorschriften wie der Maschinenrichtlinie 2023/1230/EU, die den Übergang vorantreiben.
EU-Vorschriften drängen papierintensive Branchen zu digitalen Dokumenten
Papierbasierte Unternehmen mit Produkten auf dem EU-Markt müssen bis 2027 endlich auf digitale Inhalte umstellen, um der Maschinenrichtlinie 2023/1230/EU zu entsprechen. Um sicherzustellen, dass digitale Dokumentation verfügbar und einfach zu nutzen ist, müssen sie Folgendes tun:
- Digitale Anleitungen über QR-Code oder andere Mittel an Maschinen zugänglich machen
- Anleitungen in einem Format bereitstellen, das heruntergeladen und gedruckt werden kann
- Anleitungen mindestens 10 Jahre nach der Markteinführung einer Maschine online verfügbar halten
Es ist an der Zeit, über traditionelle dokumentenbasierte Inhalte hinauszublicken und zu verstehen, wie neue Technologien die Informationsbereitstellung beeinflussen:
- KI-gestützte Assistenten: Plattformen und Geräte wie ChatGPT, Google Assistant und Amazon Alexa generieren sofortige, kontextbezogene Antworten.
- Voice-First- und multimodale Schnittstellen: Diese Anwendungen integrieren Text, Sprache und visuelle Elemente für nahtlosere Interaktionen.
- Augmented Reality (AR) und Virtual Reality (VR): Diese Technologien überlagern Wissen oder tauchen Nutzer in kontextualisiertes Wissen ein.
- Wearable-Geräte: Smartglasses und andere Wearables bieten Echtzeitanleitung ohne Hände für sicherere, effektivere Arbeitsabläufe.
Um mit diesen Entwicklungen Schritt zu halten, setzen Unternehmen auf dynamische Inhaltsbereitstellung und stellen sicher, dass Informationen über diese verschiedenen Endpunkte hinweg personalisiert, präzise und zugänglich bleiben.
Was ist dynamische Inhaltsbereitstellung?
Dynamische Inhaltsbereitstellung, oder -veröffentlichung, liefert Nutzern personalisierte, maßgeschneiderte, spontane Inhalte basierend auf ihrem Profil, Verhalten oder ihrer Situation. Anders als bei statischen Inhalten stellt die dynamische Bereitstellung sicher, dass jede Person die relevantesten, aktuellsten Informationen in Echtzeit erhält. Content-Delivery-Plattformen wie Fluid Topics sind darauf ausgelegt, alle Produktwissensinhalte zu sammeln und sie dynamisch an die Nutzer-Touchpoints zu liefern, wo sie angefordert werden.
Die Herausforderung des modernen digitalen Publishings
Informationsprofis müssen berücksichtigen, wie diese Technologien Inhalte aufnehmen und bereitstellen. Schließlich möchte niemand, der einem KI-Chatbot eine einfache Frage stellt, den Text eines dreiseitigen PDFs als Antwort ausgetippt bekommen.
Unsere Antwort auf diese Herausforderung besteht darin, bekannte, bewährte Praktiken zu implementieren, die einen hochwertigen Content Value Path schaffen:
- Struktur
- Metadaten
- Semantik
Beginnen wir mit der Struktur – was sie ist, warum Sie sie benötigen und wie Sie sie gut umsetzen.
Was sind strukturierte Inhalte?
Strukturierte Inhalte beziehen sich auf Inhalte, die in einzelne Komponenten aufgeteilt sind, auch Themen genannt, die einige Zeilen oder einige Absätze umfassen können. Dokumentationsautoren erstellen strukturierte Dokumente, indem sie die Komponenten mit einer Map, wie einem Inhaltsverzeichnis, zusammenfügen. Darüber hinaus ermöglichen strukturierte Inhalte Teams durch die Klassifizierung dieser Themen mithilfe von Metadaten, Komponenten einfach für bestimmte Nutzer und Plattformen wiederzuverwenden und zu personalisieren.
Wie man strukturierte Inhalte umsetzt
Dokumentationsteams erstellen strukturierte Inhalte mithilfe bekannter Schreibstandards wie DITA und S1000D. Diese Standards ermöglichen es Autoren, die Inhaltsproduktion zu optimieren und lange, monolithische Word-Dokumente zu vermeiden. Konkret bieten strukturierte Autorentools mehrere Vorteile für technische Dokumentationsteams:
- Verbesserung der Inhaltsproduktion und -wartung für große Dokumentationsmengen durch paralleles Schreiben und Echtzeit-Zusammenarbeit,
- Reduzierung doppelter Inhalte dank Funktionen zur Wiederverwendung von Inhalten,
- Erleichterung von Textänderungen durch Aktualisierung des Themas über alle Instanzen hinweg, in denen es vorhanden ist,
- Rationalisierung des Übersetzungsworkflows und Kostensenkung durch Automatisierung von Prozessen und Wiederverwendung genehmigter Übersetzungssegmente.
Beim strukturierten Schreiben ist es unglaublich wichtig, wie Autoren Inhalte in Themen aufteilen. Es ist ein wichtiger Wegbereiter für die Wiederverwendung von Inhalten. Aber wenn man die Nutzung durch KI berücksichtigt, sollte jedes Thema auch mit dem übergeordneten Gegenstand übereinstimmen, um Klarheit, Konsistenz und Vollständigkeit zu gewährleisten.
Dieser Schritt ermöglicht es Suchalgorithmen und neuen Technologien, die Inhalte aufnehmen, mit konsistent vollständigen Informationsfragmenten zu arbeiten, sodass diese Technologien bestimmen können, welche Fragmente benötigt werden, um effektive und eindeutige Antworten auf Nutzerfragen und Suchanfragen zu liefern. Daher kann es notwendig sein, die Granularität der Themen anzupassen:
- Für übermäßig lange Themen, die mehrere Gegenstände gleichzeitig abdecken, müssen Autoren sie in granularere Themen aufteilen.
- Für übermäßig kurze Themen, die aus einem einzelnen Satz oder Fragment bestehen, sollten Autoren sie mit Zwischen-Maps zusammenfügen. Selbst wenn diese Maps nicht zur Veröffentlichung bestimmt sind, hilft dieser Schritt Autoren, ein konsistenteres Informationsniveau zu definieren.
Weiter auf dem Content Value Path
Strukturierte Inhalte sind das erste Grundprinzip der Gestaltung eines Content Value Path – entscheidend für die Veröffentlichung von Dokumentation auf modernen Technologien und Geräten. Strukturierte Inhalte sind jedoch nicht das einzige erforderliche Element.
Dokumentationsteams müssen auch Metadaten hinzufügen und den Text semantisch aktivieren, um ihren Nutzern eine wirklich optimierte digitale Inhaltserfahrung zu bieten. Diese Elemente verbessern die Auffindbarkeit von Inhalten, Personalisierung und mehr – alles Voraussetzungen für jedes KI-Projekt.
Lesen Sie Teil zwei dieser Serie, „Wie KI die technische Redaktion verändert: Metadaten„, um das zweite wichtige Element dieser dreiteiligen Gleichung zu erkunden. Schließen Sie dann den Content Value Path mit Teil drei ab, „Wie KI die technische Redaktion verändert: Semantische Aktivierung„. Dort tauchen wir ein in die Frage, wie man Text-Tags hinzufügt, die Algorithmen helfen, Informationen aus Inhalten klar zu identifizieren und zu extrahieren.
Vereinbaren Sie eine kostenlose Demo von Fluid Topics mit einem Produktexperten
Structure FAQs
Es gibt viele Tools, die Teams beim Erstellen, Aktualisieren und Verwalten strukturierter Dokumentation helfen. Einige der Top-Optionen sind oXygen XML Editor, Paligo, Madcap IXIA CCMS, RWS Tridion Docs, Author-it, Componize, Intuillion (DITAToo), Bluestream’s XDocs DITA, Heretto und Adobe Experience Manager. Entdecken Sie den Unterschied zwischen jedem dieser Autorentools hier.
Agentische KI vs. Generative KI: Ein Leitfaden für technische Redakteure