Fünf Mythen über die Veröffentlichung technischer Dokumentation

Hinweis: Dieser Blogartikel wurde aus seiner Originalversion übersetzt und kann geringfügige Abweichungen enthalten. Auch die im Text enthaltenen Zitate wurden übersetzt.

Produktdokumentation kann Unternehmen auf unerwartete Weise Kosten verursachen. Viele Dokumentationsteams sind mit Problemen konfrontiert wie lange Release-Zyklen, die durch Dokumentationsverzögerungen verlangsamt werden, Kunden, die immer wieder die gleichen Fragen stellen, Inhalte, die schwer aktuell zu halten sind, oder Schwierigkeiten bei der Bereitstellung personalisierter Inhalte im großen Maßstab. Diese häufigen Probleme entstehen jedoch aus veralteten Annahmen darüber, wie Dokumentation funktionieren sollte, und nicht aus technischen Einschränkungen.

Unternehmen, die diesen Mythen Glauben schenken, können weder den vollen Wert ihres Produktwissens realisieren noch die geschäftlichen Vorteile ernten. Daher widerlegen wir in diesem Artikel fünf Mythen über die Veröffentlichung technischer Dokumentation, die Teams zurückhalten.

Anhand von Beispielen aus echten Fluid Topics-Implementierungen bei Unternehmen wie Hexagon und Johnson Controls International erläutern wir praktische Strategien, die Teams wochenlang Arbeit ersparen, Engpässe beseitigen und die Art und Weise transformieren, wie Unternehmen Inhalte an Benutzer liefern.

MYTHOS 1: Ein Dokumentationsportal ist im Grunde nur eine Website

Obwohl Teams diese beiden Plattformen bei der Planung von Content-Projekten oft verwechseln, ist ein Dokumentationsportal so viel mehr! Beide digitalen Plattformen erleichtern die Kommunikation zwischen Unternehmen und Benutzern. Das Volumen und die Besonderheiten von Produktwissen machen es jedoch unmöglich, dies über eine Unternehmenswebsite zu verwalten. Eine dokumentationsspezifische Lösung ist angemessen und notwendig.

Was ist also der Unterschied zwischen einer „Website“ und einem „Portal“? Schauen wir uns das genauer an.

	Website	Dokumentationsportal
Definition	Eine webbasierte Lösung, die aus Webseiten mit öffentlich verfügbaren generischen Inhalten besteht	Eine webbasierte Lösung, die spezifische, detaillierte, umfassende Inhalte hostet, die entweder öffentlich oder auf bestimmte Benutzer beschränkt sein können
Zugänglichkeit	Zugänglich über URL	Zugänglich über URL Kann Autorisierung erfordern (Logins)
Benutzer	Allgemeines Publikum, kann nach Land differenziert werden	Generische und spezifische Benutzer und Benutzergruppen (z. B.: Kunden, Mitarbeiter, Wiederverkäufer)
Administration und Veröffentlichung	Verwaltet von Admin (normalerweise Marketing- oder Webteam)	Verwaltet und gespeist von mehreren autorisierten Benutzern (normalerweise Dokumentationsteams oder Entwickler)
Kommunikation und Interaktionen	Einfache Interaktionen (Kontakt-, Abonnement- oder Download-Formulare) oder neue Interaktionen wie Suche über Suchleiste oder Chatbot	Interaktive Benutzererlebnisse über personalisierte Dashboards oder GenAI-Tools. Zweiwege-Kommunikation zwischen Benutzern und den Dokumentationsverantwortlichen über Feedback und Inhaltsbewertungen
Branding und Design	Schwerpunkt auf Branding und Design mit Priorisierung von visueller Attraktivität, hochwertigen Bildern, Animationen, interaktiven Elementen und aufwendigen Design-Layouts	Anpassbar an Markenrichtlinien (z. B. Farbpaletten, Logo-Verwendung usw.) mit Schwerpunkt auf Benutzerfreundlichkeit, Lesbarkeit und Zugänglichkeit

Unternehmen möchten möglicherweise ausgewählte Dokumentation auf ihrer Unternehmenswebsite veröffentlichen – denken Sie an Produktdatenblätter oder die neueste Release-Note. Sie können eine Website jedoch nicht wie ein Dokumentationsportal verwalten, daher sind die richtigen Tools für das Hosting von Produktwissen unerlässlich.

Product Knowledge Platforms (PKPs) wie Fluid Topics sind fertig vorbereitet, um technische Dokumentation in einem dedizierten Portal zu veröffentlichen. Unsere Lösung bietet die folgenden Hauptfunktionen und Vorteile:

• Nahtlose Integration mit Inhaltsquellen: Unternehmen veröffentlichen ihre gesamte Produktdokumentation aus verschiedenen Autoren, Quellen und Formaten in ihrem zentralisierten Wissens-Hub mit höchsten Sicherheitsstandards.
• Autorisierungskontrolle: Administratoren verwalten Identitäten, Berechtigungen und Sprachen, um sicherzustellen, dass der richtige Inhalt an den richtigen Benutzer geliefert wird. Die Sichtbarkeit wird nach Benutzergruppe, Inhalts-Metadaten und mehr angepasst, ohne die Benutzererfahrung zu beeinträchtigen.
• Erweiterte Suche: Durch die Kombination von Schlüsselwort- und semantischer Suche liefert unsere adaptive Suchmaschine relevante, personalisierte Informationen an Benutzer basierend auf ihren Profilen. KI-gestützte Suchfunktionen ermöglichen auch neue Benutzererlebnisse wie KI-Chatbots.
• Interaktivitätsfunktionen: Benutzer können ihre bevorzugten Inhalte speichern, mit generativen KI-Widgets interagieren und sich mit Informationen auseinandersetzen, indem sie Inhalte kommentieren, bewerten und teilen. Diese Interaktionen schaffen ein dynamisches Erlebnis.
• Leistungsstarke Analysen: Portal-Administratoren haben Zugriff auf erweiterte Dashboards mit vollständigen Benutzer-Session-Journeys, detaillierten Such-Analysen und Metriken wie Dokumenten-Traffic, Inhaltsbewertungen und mehr.

Darüber hinaus ist unsere Plattform so konzipiert, dass sie die anspruchsvollsten Industriestandards übertrifft. Die IT-Abteilungen unserer Kunden lieben unsere cloudbasierte Architektur, die eine umfassende Suite von Diensten umfasst, um Verfügbarkeit, Skalierbarkeit und Sicherheit zu garantieren.

MYTHOS 2: Der Aufbau eines Dokumentationsportals ist zeitaufwändig und teuer

Dokumentationsportale sind zweifellos ein wichtiger Kanal für Unternehmen. Im Zeitalter der Digitalisierung benötigt jedes Unternehmen, das Software oder Hardware verkauft, ein Dokumentationsportal, um die aktuellsten und personalisiertesten Inhalte bereitzustellen. Das Problem ist, dass viele Unternehmen glauben, die Erstellung eines Dokumentationsportals sei ein langer und kostspieliger Prozess.

Fluid Topics hat eine nachgewiesene Erfolgsbilanz dabei, Unternehmen schnell beim Aufbau reichhaltiger Content-Erlebnisse über ihr Dokumentationscenter zu unterstützen. In vollständiger Autonomie können unsere Kunden ein Out-of-the-Box-Portal mit allen Hauptfunktionen und Modulen implementieren, die in einer umfassenden Plattform zusammengefasst sind. Der Fluid Topics Portal Designer ist ein No-Code-, Drag-and-Drop-WYSIWYG-Editor, mit dem Unternehmen ein Portal erstellen, vorgefertigte Vorlagen auswählen oder Seiten anpassen und Komponenten kombinieren können, um ein maßgeschneidertes Benutzererlebnis zu schaffen.

Unverzichtbare Portal Designer-Funktionen

• Page Builder: Unternehmen können jeden Aspekt ihrer Portale von der Startseite bis zu Such- und Leserseiten mit einem robusten Interface Builder gestalten und personalisieren, der vorgefertigte Komponenten und vollständige Kontrolle über Layout, Inhalt und Benutzererlebnis bietet.
• Theme Studio: Das Theme Studio vereinfacht die Verwaltung von Themes und Markenfarben durch Administratoren, integriert sich nahtlos in bestehende Design-Systeme und ermöglicht es Unternehmen, visuelle Stile konsistent anzuwenden, um sie an ihre Markenidentität anzupassen.
• CSS- und JavaScript-Editoren: Diese integrierten Editoren ermöglichen es Unternehmen, das Aussehen und Verhalten ihrer Inhalte anzupassen. Sie können ihren eigenen Code hinzufügen und feinabstimmen, wie ihre Inhalte aussehen und funktionieren.
• GenAI-Komponenten: Unternehmen können die erweiterten Funktionen von GenAI nutzen, um Content-Erlebnisse durch vorgefertigte KI-Komponenten neu zu definieren, die Schlüsselaufgaben wie Zusammenfassung, Echtzeit-Übersetzung, Hervorhebung von Teilen und Werkzeugen und mehr automatisieren.
• Chatbot: Unser schlüsselfertiges KI-gestütztes Chat-Fenster ermöglicht es Endbenutzern, zu interagieren und zuverlässige Antworten zu erhalten, die direkt aus den Inhalten eines Unternehmens stammen und durch semantische Suche, RAG und generative KI-Technologien unterstützt werden.
• Lokalisierung: Ohne zusätzlichen Aufwand oder Kosten bietet unsere PKP Portal-Interfaces nativ in 23 Sprachen an. Die vollständige Liste der unterstützten Sprachen finden Sie hier.

Mit integrierten Funktionen können Unternehmen maßgeschneiderte, einsatzbereite Dokumentationsportale für Mobilgeräte und Desktop in nur wenigen Stunden starten. Es werden nur ein Bruchteil der Ressourcen benötigt, die für den Aufbau eines Portals von Grund auf erforderlich wären, was dies zu einem kosteneffizienten, skalierbaren Projekt macht.

MYTHOS 3: Ich muss meine Inhalte für KI umschreiben

Traditionelles Publishing reicht nicht mehr aus. Bald wird KI, nicht nur Menschen, der größte Leser Ihrer Produktinhalte sein.

Viele Unternehmen verlassen sich immer noch auf PDF-basierte Dokumentation. Dieser unstrukturierte Inhalt ist notorisch schwierig für KI zu verarbeiten, was technische Redakteure fragen lässt, ob sie Inhalte umschreiben oder in ein CCMS migrieren müssen, bevor sie KI-Projekte starten.

Fluid Topics löst diese Herausforderung, indem es bestehende Produktinhalte in saubere, strukturierte und semantisch angereicherte Daten umwandelt, die KI leicht verstehen kann. Durch die zunächst erfolgende Vereinheitlichung und Organisation von Inhalten können Unternehmen nahtlos ihr volles Potenzial für KI-Projekte nutzen. Das Ergebnis sind KI-fähige Daten, die den Endbenutzern die relevantesten, genauesten und vertrauenswürdigsten Informationen in natürlicher Sprache liefern.

MYTHOS 4: Die Veröffentlichung technischer Dokumentation verzögert den Produkt-Release-Prozess

Schnelle Produkt-Release-Zyklen sind in SaaS-Unternehmen und Industrie 4.0 Realität, und sie werden immer schneller, was technische Redakteure unter Druck setzt, die neueste Dokumentation so schnell wie möglich zu liefern. Bei neuen Versionen, die jeden Monat, jede Woche oder sogar jeden Tag eintreffen, ist das häufigste Missverständnis, dass es nahezu unmöglich ist, neue Dokumentation synchron mit dem Produkt-Update zu veröffentlichen. Die Leute neigen dazu zu denken, dass das Schreiben und Veröffentlichen von Dokumentation für brandneue Funktionen Tage oder sogar Wochen zum Prozess hinzufügt. Ein weiteres daraus resultierendes Missverständnis ist, dass es nicht möglich ist, Updates, Verbesserungen und Dokumentationskorrekturen zwischen den Versionslieferungen kontinuierlich zu veröffentlichen.

Der Wechsel zu Dynamic Content Delivery ermöglicht es Unternehmen, mit Produkten Schritt zu halten, während sie sich ändern, ohne dass die Dokumentation zu einem Engpass wird.

Hexagon, ein globaler Marktführer für Sensor-, Software- und autonome Lösungen, implementierte Fluid Topics, als das Unternehmen zu SaaS wechselte und mit einer starken Beschleunigung des Release-Tempos konfrontiert war. Zu diesem Zweck mussten sie technische Dokumentation schnell bereitstellen. Sie hörten auf, statische PDFs zu veröffentlichen, die eine langwierige Formatierung erforderten, und begannen, dynamisch in ihrem Fluid Topics-Dokumentationsportal zu veröffentlichen. Sie entkoppelten die Dokumentation vom Produkt-Release-Prozess, um mehr Flexibilität und Reaktionsfähigkeit zu ermöglichen.

Heute aktualisiert Hexagon seine technische Dokumentation, sobald es notwendig ist, und veröffentlicht sie gleichzeitig auf jedem Kanal, ohne das Release zu beeinträchtigen. Unsere gemeinsame Webinar-Wiederholung mit Lonnye beschreibt Hexagons Entscheidung, Prozess und Ergebnisse im Detail.

Eine weitere Möglichkeit, um sicherzustellen, dass die Dokumentation mit Produkt-Releases Schritt hält, besteht darin, sie in eine Continuous Integration/Continuous Delivery (CI/CD)-Pipeline einzubinden.

Bei Fluid Topics haben wir eine Null-Bug-Politik. Daher veröffentlichen wir Bugfixes und neue Funktionen jede Woche oder öfter, wenn nötig. Das bedeutet, dass unsere Dokumentation jederzeit bereit sein muss. Unsere Lösung? Die Einbettung des Release-Note-Schreib- und Veröffentlichungsprozesses in JIRA und GIT. Die Dokumentation wird mit der Release-Version verknüpft. Die Product Owner und Entwickler füllen spezifische Felder aus, die den Inhalt und Angaben zum Dokumentationsbedarf enthalten. Technische Redakteure überprüfen, vervollständigen und validieren den Inhalt. Schließlich veröffentlicht ein Bot ihn automatisch synchron mit dem Software-Rollout.

Kurz gesagt:

• Entwickler und Product Owner arbeiten mit ihren Lieblings-Tools
• Es ist alles automatisiert und wird von einem Bot verwaltet
• Niemand hat das Gefühl, dass es einen Dokumentations-Rush gibt

MYTHOS 5: Ich muss personalisierte Inhalte schreiben, um ein personalisiertes Erlebnis zu bieten

Das Web hat sich in Richtung zunehmender personalisierter Inhalte entwickelt und tut dies weiterhin. Ein Zendesk Customer Experience Trends-Bericht von 2023 ergab, dass 76 % der Kunden Personalisierung erwarten und 60 % der Benutzer glauben, dass Unternehmen die Daten, die sie über sie sammeln, nutzen sollten, um ihre Erlebnisse zu personalisieren. Diese Erwartung an Personalisierung hat sich über mehrere Jahre aufgebaut, und jetzt, mit verfügbaren KI-Tools, entwickelt sie sich erneut. Kürzlich berichtete Document 360, dass 52 % der Unternehmen erwarten, dass KI die Inhalts-Personalisierung für Endbenutzer basierend auf persönlichen Präferenzen verbessert.

Dieser Trend macht auch vor Konsumgütern nicht halt. Wenn Benutzer mit Produktdokumentation interagieren, möchten sie kontextuell relevante, personalisierte, konsistente Content-Erlebnisse.

Was genau ist also ein personalisiertes Erlebnis? Val Swisher, CEO von Content Rules Inc., fasst es treffend zusammen: „Ein personalisiertes Erlebnis ist, wenn wir den richtigen Inhalt an die richtige Person zur richtigen Zeit auf dem richtigen Gerät in der Sprache ihrer Wahl liefern können.“ Unternehmen haben versucht, personalisierte Inhalte bereitzustellen, normalerweise manuell, indem sie unterschiedliche Inhalte für jeden Kundentyp erstellt haben. In den meisten Fällen hat es einfach nicht funktioniert. Der Grund liegt in dem, was Val Swisher das Personalisierungs-Paradoxon nennt: „Um personalisierte Erlebnisse im großen Maßstab bereitzustellen, muss der Inhalt standardisiert sein. Personalisierung sollte nur am Punkt der Bereitstellung und nicht am Punkt der Inhaltserstellung erfolgen.“ Konkret müssen Ihre Inhalte als granulare, kleine Komponenten verfügbar sein, die mit reichhaltigen Metadaten getaggt sind, damit Publishing-Plattformen sie auf personalisierte, kontextuelle Weise zusammenstellen und bereitstellen können.

Neue Technologien sind dieser Aufgabe gewachsen. KI-gestützte PKPs wie Fluid Topics verbinden sich sowohl mit strukturierten als auch mit unstrukturierten Inhaltsquellen. Dann verarbeiten, chunken und reichern sie die unstrukturierten Inhalte an, sodass es aussieht, als wären sie von Anfang an strukturiert gewesen. Sobald der Inhalt bereit ist, nutzt Fluid Topics granulare, standardisierte Inhalte und reichhaltige Taxonomien. Durch die Verknüpfung dieser Informationen mit dem Profil, den Präferenzen und dem Verhalten eines Benutzers sowie mit Informationen, die von unserer KI-gestützten Suchmaschine entdeckt wurden, stellt Fluid Topics die relevantesten, personalisiertesten Inhalte für jeden Benutzer zusammen und liefert sie.

Unternehmen, die eine höhere Kundenzufriedenheit anstreben und die Abwanderung reduzieren möchten, müssen ihre Content-Strategie am Bereitstellungspunkt überdenken, um effektiv personalisierte Erlebnisse bereitzustellen.

Was nun?

In der Welt der technischen Dokumentation haben einige immer noch Zweifel daran, sich einer Product Knowledge Platform zuzuwenden, insbesondere weil sie das Gefühl haben, dass zu viel Arbeit zu erledigen ist, bevor sie dort ankommen. Fluid Topics rationalisiert die Dokumentationsveröffentlichung und ermöglicht es Unternehmen, mit ihren Inhalten so zu kommen, wie sie sind, in vielen Formen und an vielen Orten, und macht die Veröffentlichung auf verschiedenen Endpunkten, einschließlich Dokumentationsportalen und KI-Tools, einfacher als je zuvor.

Wir hoffen, dass Sie durch die Widerlegung dieser 5 Mythen ein besseres Verständnis von Dynamic Content Delivery erhalten, wie es Ihre Dokumentationsveröffentlichung transformieren kann und wie es Ihre Inhalte KI-fähig machen kann.

Anmerkung der Redaktion: Dieser Artikel wurde ursprünglich im Januar 2022 veröffentlicht. Er wurde vollständig überarbeitet und aktualisiert, um Genauigkeit und Vollständigkeit zu gewährleisten.