Adobe Experience Manager Guides

Technische Dokumente DITA-konform erstellen und ausliefern

Technische Dokumentation mit Adobe Experience Manager

Am 04.11.2022 lud Adobe auserwählte Partner, Interessenten und Kunden zum ersten AEM Guides Meet-Up in Deutschland ein. Michael Deiß und ich ließen uns die Chance nicht entgegen, die Roadmap der Lösung sowie das Management-, Marketing- und Engineering-Team der AEM Guides Business Unit näher kennenzulernen.

 

Hinter AEM Guides verbirgt sich ein sogenanntes CCMS (Component Content Management System). Es ermöglicht Unternehmen, technische Inhalte auf einfache Weise zu erstellen und als zentral gemanagte Inhalte wiederzuverwenden – etwa für weitere Anleitungen oder andere Sprachversionen. Von zentraler Bedeutung bei diesen Systemen ist, dass die Richtigkeit und Konsistenz der Inhalte sichergestellt sind. AEM Guides ist in Unternehmen die digitale Plattform für das „WIE“, also wie installiere ich ABC, wie repariere ich XY oder wie setzt sich „Dies und Das“ zusammen. Andere Digitalplattformen wie bspw. das CMS sind für das „WAS“ und „WANN“ zuständig

AEM Modules

Seit wenigen Wochen ist AEM Guides in der Version 4.1.2 in der on Premise Variante verfügbar. AEM Guides als Cloud Service erhält monatliche Updates. AEM Guides ist also nicht neu, der Name hingegen schon: Bis vor kurzem trug die Lösung noch den sperrigen Namen  "XML Documentation add-on for Adobe Experience Manager“.

AEM Guides - wo bist Du?

AEM Guides ist in Adobe Experience Manager Assets integriert - technische Illustrationen und Marketing-Assets werden demnach in AEM Assets verwaltet. XML und DITA haben sich als internationale Standards bei technischen Dokumentationen durchgesetzt. AEM Guides bringt daher eine Reihe an visuellen XML-Bearbeitungstools mit. Mit diesen Tools lassen sich sogenannte DITA-Topics und DITA-Maps erzeugen. DITA steht für „Darwin Information Typing Architecture“.

 

  • Darwin – DITA verwendet Spezialisierung und Vererbung, analog zu Charles Darwins Ideen zur Entstehung der Arten.
  • Information Typing – Informationseinheiten werden in DITA ihrem Inhalt nach typisiert.
  • Architecture – DITA ist eine Architektur. Sie ist nicht nur einfach eine DTD, sondern beinhaltet auch Regeln für die Ableitung von neuen Informationseinheiten.

 

DITA wiederum ist ein OASIS Standard (Organization for the Advancement of Structured Information Standards), der eine XML-basierte Informationsarchitektur bietet, die speziell für die Pflege komplexer Dokumente und Information geschaffen wurde. DITA wurde entwickelt, um umfangreiche Dokumente und ganze Gruppen von Dokumenten mit Hilfe einheitlicher Konzepte zur Wiederverwendung von Inhalten zu managen.

AEM Modules

Viele Unternehmen sehen inzwischen die Notwendigkeit, technische Dokumentationen neu zu denken.

Wenn wir von technischen Dokumentationen sprechen, verstehen wir darunter auch Bedienungsanleitungen, Schulungsunterlagen, Produktkataloge, Datenblätter, Aufbauanleitungen etc. Bei der Erstellung dieser Unterlagen gab es in der Vergangenheit vor allem diese beiden "Lager":

 

  • Unternehmen und technische Redakteure, die „in Handbüchern denken": Bei diesem Ansatz läßt man allerdings die Möglichkeiten anderer Ausgabeformate, wie Website und App, außen vor: Darunter leiden die visuelle Ausgestaltung, die Customer Experience durch fehlende Personalisierung, Multi Device Delivery (PDF vs Handy) und Vermarktungspotentiale durch Cross-Sell / Up-Sell / Lead Generation über digitale Kanäle.

 

  • Unternehmen und technische Redakteure, die vor allem „in Marketing- und Vertriebsprozessen“ denken und dabei Normen und Standards vernachlässigen.

 

Der Charme von AEM Guides ist, dass die Lösung beide "Lager" bedient. Bevor wir jedoch in die Technologie einsteigen, möchte ich vorneweg noch ein paar Sätze zu den beiden grundlegenden, technologischen Ansätze schreiben:

Desktop Tools

Die meisten herstellenden Unternehmen vetrauen aktuell (noch) auf Desktop-Tools, die - entsprechend angepasst und erweitert - durchaus zu monolithischen Systemen werden können. Das am weitesten verbreitete Desktop Tool für technische Dokumentationen ist - wenig überraschend -  Microsoft Word. Durch Customizing, Makros, Textbausteine und Formatierungen kann man Word an viele Anforderungen anpassen, jedoch stößt man aufgrund der unstrukturierten Daten schnell an dessen Grenzen. Spezialisierte Tools wie beispielsweise Adobe Framemaker bieten hingegen die Möglichkeit, strukturiert, d.h. regelbasiert und modular mit Hilfe von Templates, arbeiten zu können. Dabei legen technische Redakteure einmalig fest, wie Überschriften, Fließtexte, Listen, Bilder etc. dargestellt werden. Framemaker verfügt über eine Art Buchstruktur, d.h. es gibt ein Hauptdokument mit vielen Unterdokumenten (Kapitel etc.) und Framemaker kann sich aus unterschiedlichen Quellen bedienen.

Inhalte können direkt in Framemaker eingegeben werden, oder über entsprechende Schnittstellen importiert werden. Das Ergebnis ist ein strukturierter Text: Das System berücksichtigt in der Ausgabe die Textlängen unterschiedlicher Sprachversionen und diese können, je nach Sprachversion, unterschiedlich lang sein. Bei unstrukturierten Texten würde das Ergebnis der übersetzen Sprachversion anders aussehen, da beispielsweise Umbrüche nicht mehr passen oder Tabellen nicht sauber angezeigt werden etc.

 

Irgendwann wird solch eine Struktur aus Regeln, Abhängigkeiten und Verbindungen zu einem komplexen monolithischen System. Viele Unternehmen befinden sich daher im Prozess, diese komplexen Systeme aufzulösen. Tools wie Framemaker werden dann nur noch als Autorenwerkzeug verwendet. Bausteine, Varianten und Bedingungen werden dafür in einem dedizierten Content Management System vorgehalten. Als internationales Format für technische Dokumentationen hat sich der auf XML basierende DITA Standard durchgesetzt.

Component Content Management System

Viele Unternehmen setzen heute bereits ein CCMS für die technische Dokumentation ein. Auf den Zug der CMS-basierten Dokumentationstools sind inzwischen diverse Anbieter aufgesprungen. AEM Guides hat jedoch den entscheidenden Vorteil, dass die Lösung auf dem weltweit führenden CMS (AEM) basiert und Kunden von vielen out-of-the-box AEM Features profitieren, die weit über den Standard hinausgehen. Dazu gehören Workflows, automatische Übersetzungen, Asset Management, Automatisierungen durch Künstliche Intelligenz, Omni-Channel-Output und die Integration mit anderen Tools der Adobe Experience Cloud wie Analytics und Target.

AEM Guides bringt auch einen eigenen, webbasierten XML Editor mit. Technische Redakteure müssen also nicht den „Umweg“ über einen externen XML Editor gehen. An dieser Stelle mag man sich fragen, was die perspektivische Daseinsberechtigung eines Desktop Editors: es ist wohl vor allem die Offline-Arbeit an Dokumenten.

AEM Guides UI

Adobe Experience Manager Guides

AEM Guides UI

Mit AEM Guides lässt sich der komplette Lebenszyklus technischer Dokumente umsetzen, von der Erstellung oder dem Import des Contents, über Verwaltungs- und Review-Prozesse, hin zur personalisierten „omni-channel“ Auslieferung des Contents.

Über den benutzerfreundlichen Webeditor lassen sich darstellungsunabhängige Inhalte erstellen. Zusätzlich lassen sich Inhalte aus Word, HTML, InDesign usw. über ein eigenes Framework in das DITA-Format überführen.

AEM Guides bietet die derzeit besten Content-Management-Funktionen, wie eine erweiterte Wiederverwendung von Content, eine Versions- und Verweisverwaltung, ein Tag-Management für Suche und Metadaten oder Übersetzungs-Workflows.

AEM Guides UI

Künstliche Intelligenz und maschinelles Lernen auf Basis von Adobe Sensei ermöglichen eine schnelle Bereitstellung und ein einfacheres Auffindung von Inhalten.

Die webbasierte Abstimmung spart Zeit und ermöglicht die Zusammenarbeit mehrerer Autoren und Prüfer in Echtzeit. Administratoren können Nutzern unterschiedliche Rollen zuweisen und den Fortschritt über Admin-Dashboards verfolgen.

Fertige Dokumentationen können in unterschiedlichen Kanälen zur Verfügung gestellt werden, wie Web, App, Portal, Print oder PDF.

Maschinenrichtlinie als Spielverderber der Digitalisierung

Über AEM Guides lassen sich technische Dokumentationen nativ in Adobe Experience Manager Sites veröffentlichen. Durch die Verwendung von Publishing-Engines und REST-APIs lassen sich die Inhalte aber auch an vielen weiteren Berührungspunkten wie HTML-Websites, CRM-Plattformen, IoT-Apps, Chatbots, KINDLE, etc. bereitstellen. Die Vorteile einer digitalen Bereitstellung liegen auf der Hand:

AEM Guides UI
  • Der Abruf digitaler Dokumentationen kann analysiert werden (wie häufig werden welche Dokus abgerufen, wie werden sie benutzt)
  • Dokumentationen können in einem größeren Marketing-Kontext gesehen werden (personalisierte Inhalte und Angebote)
  • Dokumentationen sind responsiv und werden auf allen Endgeräten optimiert angezeigt

 

Die Maschinenrichtlinie 2006/42/EG erfordert allerdings nach wie vor, dass einer ausgelieferten Maschine eine Gebrauchsanweisung in gedruckter Form beigelegt wird und diese innerhalb der Europäischen Union auch in die Amtssprache des Export-Landes übersetzt ist.

Aber auch das ist kein Problem, denn die Bereitstellung kann auch durch native Veröffentlichungen in Adobe PDF und als Druckerzeugnis erfolgen.

Je komplexer das Gerät – desto schwieriger ist die Dokumentation.

Wir alle kennen den Spruch „Ein Bild sagt mehr als 1000 Worte“. Im Bereich der technischen Dokumentationen lässt er sich wie folgt erweitern:

 

Ein Bild sagt mehr als 1000 Worte, ein 3D-Modell sagt mehr als 1000 Bilder.“

 

Die Gesetzgebung verlangt zwar nach wie vor gedruckte Anleitungen, aber der Trend geht sehr stark in die interaktive Darstellung von Inhalten. 3D-Modelle von Geräten lassen sich bereits seit vielen Jahren als Adobe PDFs im Adobe Reader anzeigen. (CAD-Konstruktionszeichnungen, die bspw. mit Auto-CAD erstellt wurden, lassen sich über ein Acrobat Plug-in in ein PDF einbetten. Dieses kann wiederum von Endanwendern im kostenlosen Adobe Reader geöffnet werden.)

Aber auch für die Webwelt bietet Adobe durch AEM Assets Dynamic Media die Möglichkeit zur Darstellung von 3D Assets.

Warum entschieden sich Kunden für AEM Guides, was sind die großen Treiber?

Jedes Unternehmen, das etwas herstellt, braucht eine Lösung für die technische Dokumentation.

 

Bilder, Videos, Animationen und 3D Modelle sind international. Sie müssen nicht übersetzt werden und beschreiben mehr als Worte. Diese Assets werden immer stärker in den Fokus interaktiver Dokumente rücken.

 

Kunden wünschen sich einen fließenden Übergang von der Marketing- in die technische Dokumentation. Aktuell gibt es noch eine große Diskrepanz zwischen den beiden in der Aufmachung, Qualität und Modernität. Zukünftig soll es keinen spürbaren Unterschied mehr geben, da beides gleichermaßen zur Customer Experience gehört.

 

Unternehmen lechzen sprichwörtlich nach einer Lösung. In vielen Unternehmen gibt es Tech Doc Abteilungen, die in der Konstruktionsabteilung förmlich nach Unterstützung "betteln" müssen. In der täglichen (abteilungsübergreifenden) Arbeit gibt es ein großes Potential für Effizienzsteigerungen und Kosteneinsparungen, etwa durch automatisierte Übersetzungen, Content Reuse oder Abstimmungsworkflows.

Und nun?

Wir haben jetzt ausgiebig über die „WIE“-Plattform von Unternehmen gesprochen. Wenn alles perfekt dokumentiert und visualisiert ist, stellt sich nur die Frage, wie die Mitarbeiter geschult werden, die entsprechenden Maßnahmen durchzuführen. Auch dafür hat Adobe eine entsprechende AEM Erweiterung  und zwar AEM Learning Management (ehemals Captivate Prime). Aber dieses Thema vertiefen wir ein anderes Mal.