Erfahren Sie, wie Sie eine „Live“-Version Ihres Authoring-Handbuchs direkt in AEM erstellen, indem Sie die Komponenten verwenden, die Sie dokumentieren. So schaffen Sie eine stets aktuelle, zentrale Datenquelle für Autoren-, Strategen- und Designer-Teams sowie sonstige Stakeholder und ermöglichen zuverlässige Regressionstests, während Ihre Komponentenbibliothek wächst.

Was ist ein Live-Authoring-Handbuch/eine Markenbibliothek?

Es ist entscheidend, dass Autorinnen und Autoren eigenständig digitale Erlebnisse gestalten können – mithilfe vorhandener Funktionen, die die Abhängigkeit vom Entwicklungs-Team verringern und gleichzeitig Wildwuchs in der Komponentenbibliothek verhindern. Das Strategen-Team muss die verfügbaren Erlebnisse kennen, um Content bereitstellen zu können. Das Designer-Team benötigt schnellen Zugriff auf vorhandene Muster, wenn unternehmensinterne Stakeholder neue Varianten anfordern. Wenn neue Komponentenvarianten erstellt werden, müssen Testerinnen und Tester sicherstellen, dass dies keine negativen Auswirkungen auf vorhandene Inhalte hat.

Eine offensichtliche Lösung für diese Herausforderungen ist eine gute Dokumentation. Doch wir alle kennen das Problem: Eine Dokumentation ist fast schon wieder veraltet, sobald sie erstellt wurde. Angesichts der raschen Veränderungen bei digitalen Erlebnissen fallen auch die Komponentenhandbücher für das AEM-Authoring unter diese Kategorie.

Wie wichtig ist ein Live-Authoring-Handbuch?

Ein Live-Authoring-Handbuch bietet Vorteile für zahlreiche Stakeholder und steigert die Effizienz, vereinfacht die Wiederverwendung von Content und ermöglicht Kosteneinsparungen.  Im Folgenden finden Sie einige Möglichkeiten, wie verschiedene Team-Mitglieder von einem Live-Authoring-Handbuch profitieren können.

Die Vorteile eines Live Authoring-Handbuchs für Autorinnen und Autoren.

• Übersicht über die für das Erstellen von Erlebnissen verfügbaren Komponenten und Stile

• Anleitung zur Erstellung der dargestellten Inhaltserlebnisse

  • Anweisungen im Authoring-Handbuch zum Nachlesen
  • Prüfen der Systemkonfigurationen für Dialoge und Stile

• Experimentieren mit Inhaltsänderungen in einer sicheren Sandbox

Die Vorteile eines Live Authoring-Handbuchs für Inhaltsstrateginnen und -strategen.

• Übersicht über verfügbare Erlebnisse zur Bereitstellung und Personalisierung von Inhalten
• Planen entsprechend der Komponentenfunktionen und Einschränkungen (z. B. die Länge von Content)
• Komposition vollständiger Erlebnisse, nicht nur von Text und Bildern

Die Vorteile eines Live Authoring-Handbuchs für Designerinnen und Designer sowie Produktverantwortliche.

• Übersicht über aktuelle Komponenten und Varianten und die Möglichkeit zur Iteration, um sie zu verbessern
• Wiederverwendung vorhandener Komponenten und Varianten beim Aufbau einer neuen Marke
• Sicherstellen, dass das Team den aktuellen Style Guide verwendet, anstatt eines veralteten.

Die Vorteile eines Live Authoring-Handbuchs für Qualitäts-/Benutzerakzeptanz-Testerinnen und -Tester.

• Deutlich weniger Aufwand beim Erstellen von Testinhalten
• Regressionstest-Änderungen bei modifizierten Komponenten in allen Varianten
• Regressionstest-Änderungen bei wiederverwendbaren Komponenten auf allen Sites/für alle Marken

Vorteile eines Live-Authoring-Handbuchs für Entwicklerinnen und Entwickler.

• Weniger doppelt erstellte Inhalte durch unterschiedliche Mitglieder des Entwickler- und Test-Teams
• Verbesserte Möglichkeit, unbeabsichtigte Auswirkungen nach Änderungen durch Entwicklerinnen und Entwickler zu erkennen
• Live-Darstellung der grundlegenden Design-Elemente (Farben, Typografie usw.)

Tipps für die Erstellung eines Live Authoring-Handbuchs.

Ein Live-Authoring-Handbuch ist nur so gut wie sein Inhalt.

Inkonsistente Inhalte können zur Folge haben, dass das Handbuch verwirrend ist und womöglich sogar für Ärger sorgt und schließlich nicht verwendet wird. Irrelevante Inhalte können das Verständnis beeinträchtigen. Unvollständige Inhalte können dazu führen, dass die Vorteile eines Handbuchs geschmälert werden. Im Folgenden finden Sie einige Tipps, mit denen Sie sicherstellen können, dass der Inhalt Ihres Live-Authoring-Handbuchs optimal genutzt werden kann:

• Sorgen Sie für eine konsistente, verständliche Seitenstruktur. Beispiel: Titel, Beschreibung, Beispiel für Standard-Content, Beispiel für alternativen Content
• Verwenden Sie echte, geschäftlich relevante Inhalte anstelle von „Lorem Ipsum“-Text und Platzhalter-Bildern.
• Beginnen Sie immer mit dem mit einer Komponente am häufigsten erstellten Erlebnis.
• Achten Sie darauf, dass die Anweisungen im Handbuch für alle Komponenten denselben Grad an Details enthalten.
• Zeigen Sie für jede Komponente alle Stilvarianten.
• Achten Sie darauf, dass die Seitenlänge moderat ist, und zeigen Sie neben Stilvarianten auch Inhaltsvarianten.

Technische Überlegungen für ein Live-Authoring-Handbuch.

Ein Live-Authoring-Handbuch kann zum Großteil mit standardmäßigen, nicht-technischen Authoring-Funktionen von AEM erstellt und gepflegt werden. Das technische Team muss jedoch zumindest Ansichtsrechte für das Live-Authoring-Handbuch definieren.

• Wenn das Live-Authoring-Handbuch über die URL für alle (innerhalb oder außerhalb des Unternehmens) zugänglich ist, konfigurieren Sie das Crawling der Suchmaschine so, dass die Seiten ignoriert werden (z. B. robots.txt).
• Wenn es nur für interne Benutzende zugänglich ist, beschränken Sie den Zugriff mithilfe von Dispatcher- und/oder CDN-Steuerelementen und AEM-Zugriffsberechtigungen.

Es wird dringend empfohlen, das technische Team heranzuziehen, um das Live-Authoring-Handbuch in allen AEM-Umgebungen zu synchronisieren. Dies ist insbesondere dann wichtig, wenn das Handbuch für Regressionstests oder von Autorinnen und Autoren als Sandbox zum Experimentieren mit Handbuch-Inhalten verwendet wird. Das Speichern von Bibliotheksinhalten in der Code-Basis wird im Allgemeinen empfohlen, da dies die folgenden Vorteile bietet:

• Automatische Synchronisierung des Authoring-Handbuchs zwischen AEM-Umgebungen
• Regelmäßiges „Zurücksetzen“ von Handbuch-Inhalten, mit denen experimentiert wurde
• Optimierter Entwicklungs- und Testprozess

Wenn das technische Team spezielle Komponenten und Seitenvorlagen für das Authoring-Handbuch erstellt und unterstützt, was normalerweise ein einmaliger Aufwand ist, profitieren Sie außerdem von folgenden Vorteilen:

• Einfache Erstellung des Handbuchinhalts
• Konsistente Seitenstruktur
• Unterschiedlicher Seitenstil und Navigation gegenüber der Haupt-Website

Häufig gestellte Fragen

1. Ersetzt ein Live-Authoring-Handbuch in AEM den vom Design-Team erstellten Live Style Guide?
   1. Nein. Der Live Style Guide des Design-Teams wird erstellt, bevor Ihre AEM-Komponenten erstellt werden. Er enthält technische Spezifikationen, die bei der Entwicklung helfen. Das Live-Authoring-Handbuch in AEM stellt jedoch immer den aktuellen Status der tatsächlichen Implementierung dar und kann auch verwendet werden, um einen veralteten Design Style Guide auf den neuesten Stand zu bringen.
2. Wie verwaltet das technische Team das als Content in AEM vorhandene Live-Authoring-Handbuch?
   1. Content in AEM kann als XML-Datei exportiert, in der Code-Basis gespeichert und dann über diese XML-Datei auf anderen Servern bereitgestellt werden. Hierzu gibt es zwei Möglichkeiten. Das technische Team kann entweder den Content des Handbuchs mit Tools, die die Content-Pfade zwischen der Code-Basis und einem lokalen AEM-Server synchronisieren, sowohl erstellen als auch verwalten. Alternativ können Business-Anwenderinnen und -Anwender den Content auch in einer gemeinsam genutzten AEM-Umgebung erstellen, und das technische Team kann den Content dann mit AEM Package Manager exportieren und in die Code-Basis einfügen.
3. Kann ein Live-Authoring-Handbuch mit Edge Delivery Services erstellt werden?
   1. Ja. Da das Live-Authoring-Handbuch mit Ihren standardmäßigen AEM-Komponenten (traditionell oder EDS) und Authoring-Verfahren erstellt wurde, kann ein Live-Authoring-Handbuch mit Edge Delivery Services erstellt werden, wenn Ihre Site und Ihre Komponenten ebenfalls damit erstellt wurden.