LOOPS – Häufig gestellte Fragen und Antworten (FAQs)
Auf dieser Seite finden Sie Informationen über Single-Source-Publishing, (maschinelle) Übersetzung und LOOPS, das Lightweight Object-Oriented Publishing System von 9to5 Media Services.
1. Technologie
„Wie ist der LOOPS-Technologiestack aufgebaut?“
Das grundlegende Prinzip bei unserem Digital-Publishing-Konzept ist es, mit der jeweils einfachsten Technologie die bestmöglichen Ergebnisse zu erzielen. Dies ist der LOOPS-Technologie-Stack:
Inhalte werden mit einer schlanken Auszeichnungssprache namens Markdown formatiert.
Wahrscheinlich haben Sie schon oft Markdown-Dokumente (also mit Markdown formatierte Texte) gelesen, ohne zu wissen, dass es sich dabei um ein Dokumentenformat mit einem eigenen Namen (und einer interessanten Geschichte) handelt. Markdown gibt es seit mehr als zwei Jahrzehnten. Es ist leicht zu erlernen und anzuwenden. Markdown kann von Menschen intuitiv erfasst und mit geeigneter Software in komplexere Formate konvertiert werden.Wir konvertieren Markdown-Inhalte in HTML, die Lingua Franca des Internets.
Wir verwenden HTML-Templates (Seitenvorlagen), um Metadaten und die eigentlichen Inhalte zu platzieren.
Für die Gestaltung kommen Cascading Style Sheets zum Einsatz – dieselbe Technologie wie bei praktisch allen anderen Webseiten. Modernes CSS-Styling sorgt für eine responsive Darstellung von Inhalten auf der Grundlage des Gerätetyps (Smartphone, Tablet, Computer) beziehungsweise der Viewport-Parameter (Bildschirm- oder Fenstergröße, Geräteausrichtung).
Die eingebundenen Bilder können auf einem beliebigen Webserver gehostet werden und werden aus den Markdown-Dokumenten verlinkt. Bei Bedarf werden die Größe und Positionen von Bildern mit CSS-Klassen angepasst. Video- und Audiodatei-Player (sowohl lokale Inhalte als auch Streaming-Inhalte der großen Plattformen) können ebenfalls integriert werden.
Mit unserer eigenen JavaScript-Bibliothek erhalten die veröffentlichten Dokumente anwenderfreundliche Navigationsfunktionen wie zum Beispiel ein Inhaltsverzeichnis; Bilder- und Tabellenlisten; Anker mit Lesezeichen und dokumenteninterne Links beispielsweise zur vorherigen oder nächsten Abschnittüberschrift.
Produktinformationen können in einer Subdomain der Specs and Docs-Website (zum Beispiel „yourbrand.specs-and-docs.online“) gehostet oder zum Download und Hosting auf der Website Ihres Unternehmens eingebunden werden. Da es sich bei allen Dokumenten um statische HTML-Dateien handelt, für die kein Content-Management-System oder Datenbank-Backend erforderlich ist, sind sie äußerst portabel.
Und das war es schon.
Unsere Web Manuals können auch in PDFs umgewandelt werden, sowohl serverseitig als auch von Endanwendern.
„Was sind die grundlegenden Konzepte hinter dem LOOPS-Technologie-Stack?“
Kurz formuliert: Vermeidung von unnötiger Komplexität
Dies sind die Grundsätze, die wir bei der Entwicklung unseres Workflows befolgt haben:
- Keine intransparenten Dateiformate
Wir verwenden für jede Aufgabe das jeweils einfachste / transparenteste Format. - Keine unnötig komplexe Toolchain
Wir reduzieren die Anzahl der notwendigen Komponenten. - Möglichst keine kommerziellen, teuren Softwarekomponenten
Wir vermeiden so weit wie möglich die Nutzung proprietäre Technologien. - Keine unnötigen Abhängigkeiten
Wir verwenden keine komplexen Frameworks, die von Dritten gepflegt (und dann möglicherweise ohne Ankündigung aufgegeben) werden.
„Warum verwenden Sie Markdown?“
Markdown ist die beliebteste schlanke Auszeichnungssprache der Welt.
Markdown ist eines der beliebtesten „Dateiformate“ / Auszeichnungssprachen der Welt. Es würde den Rahmen dieses Dokuments sprengen, die zahlreichen Einsatzmöglichkeiten (aber natürlich auch bestimmte Einschränkungen) von Markdown zu erläutern. Hier nur einige grundlegende Aspekte:
- Markdown ermöglicht das einfache Formatieren von Dokumenten durch die Verwendung einfacher Textelemente
„#“, „-“ und einige andere Zeichen werden verwendet, um strukturelle Auszeichnungen (Überschriften, Listen), Hervorhebungen (fett, stark), Tabellen, Links, Fußnoten usw. zu erzeugen. - Markdown ist für Menschen leicht zu lesen.
Auch ohne zu wissen, worum es sich dabei handelt, können die meisten Menschen einen Markdown-“Quelltext“ lesen und seine Struktur und Semantik verstehen. - Markdown ist für Computer leicht zu verarbeiten.
Es ist für Programmierer (und mittlerweile auch für KI-Systeme) relativ einfach, einen Markdown-Parser/Konverter zu schreiben, der einen Markdown-formatierten Quelltext zum Beispiel in HTML umwandelt. Ein begabter Entwickler wird nicht mehr als ein paar Stunden benötigen, um in einer modernen Programmiersprache einen solchen Konverter zu implementieren. Markdown-Konverter können auf Servern, in speziellen Konvertierungsanwendungen und sogar in Webbrowsern laufen. - Es ist einfach, Markdown zu schreiben.
Die wichtigsten Markdown-Konzepte kann jeder, der schon einmal einen Texteditor oder ein Textverarbeitungsprogramm benutzt hat, in etwa zehn Minuten erlernen und anwenden. - Dabei muss nichts „programmiert“ werden. Es gibt kein binäres Dateiformat wie bei anderen Anwendungen, es sind keine speziellen Tools erforderlich, und es muss nichts lizenziert oder installiert werden.
Ein beliebiger Texteditor, wie es ihn für jedes Betriebssystem gibt, reicht aus. Es gibt viele Online-Tools zum Schreiben und Bearbeiten von Markdown-Dokumenten.
Dabei ist zu beachten, dass es keine einheitliche, „kanonische“ Version von Markdown gibt.
Tatsächlich gibt es einige Markdown-Varianten.
Viele dieser Varianten sind sinnvolle Erweiterungen des Kernkonzepts. Sie sind besser für technische und wissenschaftliche Veröffentlichungen geeignet, da sie Dokumentabschnitte, mathematische Formeln, Zitate usw. unterstützen.
Weitere Informationen finden Sie unter:
Weitere Informationen über Markdown finden Sie unter:
- „Markdown Guide – Getting started“ 🇬🇧
- „Human technology: Text files“ (Boris Marinov) 🇬🇧
- Markdown @ Wikipedia
- „Markdown everywhere!“ 🇬🇧
- Markdown: Die Grundlagen | 9to5 Media Services
„Warum verwenden Sie Pandoc?“
Pandoc ist ein äußerst vielseitiges, stabiles und beliebtes Programm zur Konvertierung von Dokumenten in andere Formate. Pandoc wird von mehr als 35000 Nutzern auf Github unterstützt und ist damit eines der 400 bekanntesten Projekte auf der Plattform.
Markdown selbst ist letzten Endes nur eine Reihe von Konventionen, wie Dokumente formatiert werden können. Aber um diese Auszeichnungssprache -tatsächlich in einem Publishing-Workflow verwenden zu können, ist eine Konvertierungs-Engine erforderlich, die das „unverbindliche“, für Menschen gut lesbare Markup in ein wohlgeformtes, maschinenlesbares XML/HTML-Format umwandelt.
Es gibt Hunderte dieser Konverter – mit und ohne visuelle Frontends und teilweise erweiterbar durch zusätzliche Komponenten.
Bei der Entwicklung von LOOPS haben wir uns schon früh dafür entschieden, das Rad nicht neu zu erfinden, sondern Pandoc zu verwenden, und zwar aus den folgenden Gründen:
- Pandoc ist freie (konkret: quellfreie und kostenlose) Software.
- Pandoc ist quelloffene Software unter der GNU General Public License.
- Pandoc hat ein aktives Entwicklungsteam mit mehr als 400 Mitwirkenden – siehe https://github.com/jgm/pandoc/graphs/contributors.
- Pandoc hat eine aktive, freundliche Support-Community – sie ist unter anderem in der Pandoc User Group „pandoc-discuss“ bei Github zu finden.
- Pandoc ist für viele Betriebssysteme und Plattformen verfügbar – unter anderem für Windows, macOS, Linux und Docker.
Siehe https://pandoc.org/installing.html.
Pandoc kann auch aus dem Quellcode kompiliert werden. - Pandoc kann verwendet werden, um Dokumente von Markdown nach HTML und von HTML nach Markdown zu konvertieren. Pandoc unterstützt auch die Konvertierung von und in viele andere Formate, beispielsweise von und in LaTeX, EPUB und Word. Weitere Informationen finden Sie auf der Entwickler-Website.
- Pandoc bietet viele nützliche Erweiterungen der ursprünglichen Markdown-Syntax. Von der Homepage des Projekts:
- Pandoc unterstützt Vorlagen für HTML und andere Formate.
- Pandoc unterstützt Variablen, die in Dokumentvorlagen verwendet werden können.
- Variablen können in sogenannten Pandoc-Default-Dateien gesetzt werden – siehe https://pandoc.org/MANUAL.html#defaults-files.
Dabei handelt es sich um YAML-Dateien, die mit jedem Texteditor bearbeitet werden können.
Bei der Ausführung eines Projekts können mehrere Default-Dateien zusammengefasst werden, und Optionen aus einer Default-Datei können mit einer weiteren Default-Datei überschrieben werden.
Aus der Pandoc-Dokumentation:
Pandoc unterstützt eine Reihe von nützlichen Markdown-Syntax-Erweiterungen, darunter …
- Metadaten für Dokumente (Titel, Autor, Datum),
- Fußnoten,
- Tabellen,
- Definitionslisten,
- tiefgestellter und hochgestellter Text,
- durchgestrichener Text,
- erweiterte nummerierte Listen (benutzerdefinierte Startnummer und Nummerierungsstile werden berücksichtigt),
- fortlaufende Beispiellisten,
- abgegrenzte Codeblöcke mit Syntaxhervorhebung,
- intelligente Anführungszeichen, Gedankenstriche und Ellipsen,
- Markdown innerhalb von HTML-Blöcken und
- Inline-LaTeX.
Wenn aus irgendeinem Grund strikte Markdown-Kompatibilität erforderlich ist, können alle diese Erweiterungen ausgeschaltet werden.
„Sind wir als Kunde dauerhaft an Ihren Service und Ihre Dokumentenformate gebunden?“
Oder anders ausgedrückt: „Was passiert, wenn 9to5 Media Services / Specs and Docs in Konkurs geht?“
Wir verstehen sehr gut, dass Marken die Bindung an einen bestimmten Anbieter vermeiden wollen – insbesondere in einer sich ständig verändernden Technologielandschaft.
Da wir unseren Technologie-Stack so einfach wie möglich halten und keine komplexe Datenbanktechnologie für die Erstellung oder Veröffentlichung von Inhalten verwenden, können Sie Ihre Inhalte problemlos wieder an sich ziehen, wenn Sie dies wünschen: Es handelt sich lediglich um Textdateien (konkret: Markdown-Dateien) mit Verweisen auf Bilder, die auf einem gewöhnlichen Webserver gehostet werden. Noch einfacher (und portabler) geht es eigentlich nicht.
2. Single-Source-Publishing / semantisches Publizieren
„Was ist Single-Source-Publishing?“
Single-Source-Publishing ist ein Ansatz für die Erstellung, Verwaltung und Veröffentlichung von Inhalten, bei der eine einzige, zentralisierte Quelle mit Inhalten für die Produktion mehrerer Ausgabeformate verwendet wird.
Das Kernkonzept besteht darin, dass die Inhalte nur ein einziges Mal in einem neutralen, flexiblen Format verfasst und dann automatisch oder halbautomatisch in verschiedene Formate wie HTML, PDF, EPUB usw. umgewandelt werden. Durch diesen Ansatz wird die mehrfache Erstellung und Pflege von Inhalten vermieden, und die ausgespielten Inhalte sind in allen Formaten und auf allen Plattformen stets auf demselben Stand.
„Was sind die Vorteile von Single-Source-Publishing?“
Konsistenz: Da alle Ausgabeformate von derselben Quelle abgeleitet werden, ist die Konsistenz aller Zielformate gewährleistet.
Effizienz: Single-Source-Publishing reduziert den Zeit- und Arbeitsaufwand für die Erstellung mehrerer Versionen desselben Inhalts (beispielsweise gedruckte und Webversion einer Anleitung oder von Wissensdatenbanken). Der Inhalt wird einmal erstellt und dann in verschiedene Formate umgewandelt.
Reduzierter Wartungsaufwand: Wenn Fehler gefunden oder Inhalte aktualisiert werden, müssen die Änderungen nur in den Quelldokumenten vorgenommen werden, Sie werden dann für alle Ausgabeformate übernommen, wodurch das Risiko von unerwünschten Abweichungen verringert wird.
Kosteneinsparungen: Single-Source-Publishing vereinfacht und verschlankt den Veröffentlichungsprozess, was zu erheblichen Kostensenkungen bei der Produktion und Pflege von Inhalten führen kann.
Skalierbarkeit: Es ist relativ einfach, einen Single-Source-Publishing-Workflow zu skalieren und zu erweitern. Neue Formate können in der Regel in kurzer Zeit hinzugefügt werden, indem entweder ein spezielles Ausgabemodul entwickelt oder eines der gängigeren Ausgabeformate in ein anderes Format umgewandelt wird (Beispiel: Markdown → HTML → PDF).
„Wie werden Inhalte in einem Single-Source-Publishing-Workflow erstellt, gespeichert, verarbeitet und gestaltet?“
Hier ein Beispiel für einen Arbeitsablauf, der mit einer schlanken Auszeichnungssprache wie Markdown beginnt und von dem andere Formate wie HTML und PDF abgeleitet werden.
Schritt 1: Erstellung von Inhalten
Die Inhalte werden in einer schlanken Auszeichnungssprache erstellt/formatiert. Markdown ist in unserem Arbeitsablauf das bevorzugte Quellformat, da es einfach zu lesen und zu schreiben ist und in viele andere Formate konvertiert werden kann.
Anwendungen: Es können Texteditoren wie VS Code, Atom oder ein spezieller Markdown-Editor wie Typora verwendet werden. Solche Editoren gibt es für alle wichtigen Plattformen (sowohl traditionelle als auch mobile Betriebssysteme).
Schritt 2: Speichern von Inhalten
In einem Single-Source-Publishing-Workflow werden die Quelldokumente entweder als reine Textdateien auf einem Dateiserver gespeichert, auf den über SFTP zugegriffen werden kann, oder in einem Versionskontrollsystem (VCS) wie Git.
Versionskontrollsysteme ermöglichen die Nachverfolgung von Änderungen, bringen aber verschiedene Komplexitäten und „Silos“ mit sich: Die Inhalte werden in einem System gespeichert, das eine sorgfältige Einrichtung und regelmäßige Wartung durch einen qualifizierten Betreiber erfordert, sowie eine Benutzeroberfläche für „Normalsterbliche“, die in der Regel einfach nur Inhalte erstellen wollen.
Wir bieten derzeit eine einfache, unkomplizierte Speicherung in einem dateibasierten System an. Möglicherweise werden wir später eine Versionsverwaltung einführen.
Schritt 3: Rendern von Inhalten
Markdown-Dokumente werden in die entsprechenden Zielformate konvertiert, entweder einzeln (beispielsweise das französische Handbuch für ein neues Produkt) oder in größeren Sets (zum Beispiel alle Dokumente für ein bestimmtes Produkt oder in einer bestimmten Sprache).
In unserem Workflow erfolgt die Konvertierung so schnell, dass es möglich ist, alle Produktanleitungen für eine typische Consumer-Marke in einem Durchgang zu konvertieren – dies dauert selbst bei großen Dokumentenmengen in der Regel nur wenige Minuten.
Schritt 4: Anpassen der Ausgabe durch Vorlagen
In einem modernen Single-Source-Publishing-Workflow wie LOOPS / Specs and Docs ist es möglich, die Ausgabe sowohl für ein bestimmtes Zielformat als auch für bestimmte Verwendungszwecke mit Hilfe von Vorlagen (Templates) anzupassen. Beispiele:
- Eine Markdown-Quelle mit YAML-Metadaten wird für das Zielformat HTML vollständig gerendert.
- Für das Zielformat Microsoft Word wird nur der Abschnitt mit der Bezeichnung „Für Intranet“ gerendert.
- Ein als „print“ gekennzeichneter Teilbereich des Quelldokuments wird durch eine zweite HTML-Zielvorlage gerendert, welche nur für den Druck bestimmte Inhalte anzeigt. Diese HTML-Dokumente können (wenn sie korrekt mit Stilen formatiert sind) von LOOPS, einem im Headless-Modus laufenden Webbrowser oder einer speziellen HTML-zu-PDF-Rendering-Engine als PDF-Dateien gerendert werden.
Schritt 5: Gestaltung der Ausgabe durch Stylesheets
In einem Single-Source-Publishing-Workflow kann der Inhalt mit Hilfe der Präsentationsmechanismen der verschiedenen Zielformate gestaltet werden. Beispiele:
- Eine Markdown-Quelle wird im HTML-Format ausgegeben, und das HTML-Dokument (Vorlage) ist mit einem oder mehreren Cascading Style Sheets verknüpft.
- Dieselbe Markdown-Quelle könnte mit einer andere HTML-Vorlage ausgegeben werden, die mit anderen Stylesheets verknüpft ist.
- Eine Markdown-Quelle wird im Format DOCX (Office Open XML) ausgegeben. Beim Rendern des DOCX-Dokuments werden die Corporate-Design-konformen Absatzformate aus einem als Referenz dienen Microsoft-Word-Dokument übernommen.
Schritt 6: Publizieren
Die in einem Single-Source-Publishing-Workflow erstellten Dokumente können auf verschiedene Weise veröffentlicht werden. Beispiele:
- HTML-Seiten können per SFTP oder Dropbox-Upload auf einem Webserver bereitgestellt werden.
- „Kopflose“ HTML-Seiten (dies sind HTML-Dokumente ohne head-Bereich und ohne
html
- undbody
-Tags) können in ein Content-Management-System importiert werden. - Microsoft Word-Dokumente (.docx) können in einem Intranet verteilt werden.
- PDF-Dateien können per E-Mail verteilt, auf eine Website hochgeladen oder nach Bedarf ausgedruckt werden.
Schritt 7: Aktualisierung
Um Inhalte mit neuen Informationen zu aktualisieren oder Fehler zu korrigieren, müssen nur die ursprünglichen Markdown-Dokumente geändert werden. Alle von der Markdown-Quelle abgeleiteten Formate werden aktualisiert, wenn der Inhalt das nächste Mal gerendert wird.
„Was ist semantisches Publizieren?“
Beim semantischen Publizieren geht es darum, den veröffentlichten Informationen Bedeutung zu verleihen. Dies wird durch die Verwendung von semantischem Markup erreicht. Semantisches Markup wird durch das Hinzufügen von Tags erreicht, die die Inhalte beschreiben und nicht nur, wie diese dargestellt werden sollen.
Stellen Sie sich das folgendermaßen vor (und sehen Sie sich gerne auch den Quellcode dieser Seite an, falls Sie daran interessiert sind):
Fett gedruckter Text mag sich optisch von normalem Text unterscheiden, aber für ein Computerprogramm ist das alles nur Text.
Semantisches Markup geht über die visuelle Aufbereitung hinaus und teilt dies Browsern, Suchmaschinen und anderen Anwendungen mit:
- „Dies ist eine Überschrift“ oder
- „Das hier ist wichtig.“ oder
- „Dies ist der Name einer
Funktion
oder eines Elements der Benutzeroberfläche.“
„Was sind die Vorteile von semantischem Publishing?“
- Suchmaschinen und andere Anwendungen wie große Sprachmodelle, die mit Web-Inhalten trainiert wurden, können die Struktur und sogar die Bedeutung der Informationen verstehen. Dies erleichtert Suche und Datenintegration.
- Suchmaschinen können den Kontext von semantisch getaggten Inhalten besser verstehen, was zu einer besseren Platzierung der entsprechenden Seiten in den Suchergebnissen führen kann. Die „Rich Snippets“ von Google sind ein bekanntes Beispiel dafür, wie semantisches Markup relevante Informationen extrahieren und präsentieren kann.
- Semantisches Markup ermöglicht es Ihnen, reichhaltigere und informativere Inhalte zu erstellen. So können Sie zum Beispiel semantisches Markup verwenden, um Definitionen oder Zahlen hervorzuheben.
- Eindeutiges semantisches Markup ermöglichen Anwendern eine einfachere Navigation und Interaktion mit Informationen.
„Was ist Informationsgranularität im digitalen Publizieren?“
Im digitalen Publishing bezieht sich der Begriff Informationsgranularität auf den Detailgrad oder die Tiefe, mit der Inhalte segmentiert und präsentiert werden.
Aus der Sicht des Autors bedeutet Granularität, dass Informationen in kleinere, besser handhabbare Einheiten oder Komponenten zerlegt werden. Die Granularität ermöglicht es Informationsanbietern, die „Auflösung“ festzulegen, mit der Informationen den Lesern zur Verfügung gestellt werden. Sie erhöht die Flexibilität beim Zugriff auf Informationen und bei der Bearbeitung von Inhalten. Stellen Sie sich ein granulares System wie einen Eimer mit Legosteinen vor, dessen Inhalt Sie zu allem Möglichen zusammensetzen können (anstatt nur ein einziges „monolithisches“ Modell zu besitzen).
Im Kontext des digitalen Publizierens kann sich die Informationsgranularität auf verschiedene Weise manifestieren, unter anderem:
- Informationseinheiten
-
Die Aufteilung von Inhalten in kleinere Einheiten – wie Absätze, Abschnitte oder Kapitel – ermöglicht eine genauere Kontrolle über die Darstellung von Informationen und die Navigationsfunktionen, die den Lesern zur Verfügung gestellt werden können. „Monolithische“ Dokumente (bei denen Darstellung und Inhalt vorgegeben und nicht voneinander zu trennen sind) lassen sich nur schwer wiederverwenden – man denke hier zum Beispiel an Tontafeln und handschriftliche Dokumente. Granulare Inhalte hingegen können leicht aus dem ursprünglichen Kontext herausgelöst, neu formatiert und nach Bedarf wiederverwendet werden.
- Multimedia-Elemente
-
Auch die Einbeziehung multimedialer Elemente wie Bilder, Videos und interaktive Komponenten ist eine Form von Granularität, und diese Elemente können wiederum granulare Merkmale aufweisen. Diese Multimedia-Elemente können unabhängig voneinander bearbeitet und aufgerufen werden, was eine detailliertere und ansprechendere Benutzererfahrung ermöglicht.
- Metadaten
-
Informationen über Inhalte – wie Tags, Kategorien und Schlüsselwörter – tragen zur Granularität bei. Diese Metadaten helfen bei der Organisation und Kategorisierung von Inhalten und erleichtern den Nutzern das Auffinden und Navigieren in digitalen Publikationen.
- Responsives Design
-
Granularität ist bei der Gestaltung von responsiven Layouts für verschiedene Geräte und Bildschirmgrößen unerlässlich. Die Inhalte können angepasst und umstrukturiert werden, um den spezifischen Anforderungen der verschiedenen Zielgeräte gerecht zu werden und ein einheitliches und optimales Nutzererlebnis zu gewährleisten.
- Benutzerseitige Interaktivität
-
Die Granularität ermöglicht interaktive Funktionen wie Hyperlinks, Pop-ups oder Tooltips, die es dem Anwender ermöglichen, zusätzliche Details oder verwandte Inhalte mit einem Klick oder Tippen zu erkunden.
- Adaptiver Inhalt
-
Granulare Inhalte können an unterschiedliche Nutzerpräferenzen angepasst werden, zum Beispiel an die Sprache, das Leseniveau oder das gewünschte Thema. Diese Anpassungsfähigkeit verbessert die Nutzererfahrung und macht digitale Veröffentlichungen leichter zugänglich.
Zusammenfassend lässt sich sagen, dass Informationsgranularität beim digitalen Publizieren es den Informationsanbietern ermöglicht, die Präsentation der Inhalte anzupassen, auf die unterschiedlichen Präferenzen der Anwender einzugehen und das allgemeine Nutzererlebnis zu verbessern. Sie spielt eine entscheidende Rolle bei der effektiven Übermittlung von Informationen in der digitalen Welt.
„Was sind intelligente Dokumente?“
Ein intelligentes Dokument ist mehr als eine Aneinanderreihung von Sätzen (und Bildern). Ein intelligentes Dokument enthält strukturelle Informationen, die es Programmen ermöglichen, auf seine Elemente zuzugreifen, sie zu bearbeiten und zu erweitern.
Zu den intelligenten Dokumentenfunktionen in LOOPS gehören:
- Index-Generatoren
-
Dokumente und Vorlagen können so konfiguriert werden, dass sie mit Hyperlinks versehene Listen beliebiger Elemente wie Überschriften (dies wäre ein klassisches Inhaltsverzeichnis), Bilder, Tabellen und andere Elemente erzeugen und anzeigen.
- Anker
-
Dokumentvorlagen können so konfiguriert werden, dass eindeutige Kennungen IDs für Dokumentenelemente wie Überschriften, Tabellen oder Bildern angezeigt werden. Diese Elemente können dann direkt angesteuert und gespeichert werden. Das ermöglicht es Supportmitarbeitern, Anwender nicht nur auf ein bestimmtes Dokument, sondern auch auf einen konkreten Abschnitt oder ein Element in diesem Dokument zu verweisen, sodass sie die gewünschte Information schneller finden, gleichzeitig aber auch der Kontext erhalten bleibt.
- Navigationswerkzeuge
-
Dokumenteninterne Hyperlinks können verwendet werden, um direkt zum vorherigen oder nächsten Element eines bestimmten Typs (Überschrift, Tabelle oder Abbildung) zu navigieren.
- Style-Umschalter
-
Mit Style-Sheet-Switchern können Anwender die Anzeige eines Dokuments ihren Wünschen entsprechend anpassen, indem sie beispielsweise einen höheren Kontrast oder eine größere Schriftart wählen.
- Filtern
-
Mit Widgets können Nutzer Informationen ausblenden, die sie gerade nicht sehen wollen, so dass nur die relevanten Teile sichtbar sind. Beliebte Anwendungen sind Steuerelemente wie „Nur Abbildungen anzeigen” und „Nur Spezifikationen anzeigen“.
- Transklusion
-
Transklusion ist eine Funktion, die es dem Anwender ermöglicht, innerhalb des aktuellen Dokuments auf eine Informationsquelle (ein sekundäres Dokument wie z. B. einen Glossareintrag) zuzugreifen, wodurch eine „Lost-in-Hyperspace-Situation“ vermieden wird.
3. Übersetzung
„Was ist maschinelle Übersetzung?“
Bei der maschinellen Übersetzung (MT) wird Software verwendet, um Text oder Sprache von einer Sprache in eine andere zu übersetzen. Ziel der maschinellen Übersetzung ist es, die Kommunikation zwischen Menschen, die verschiedene Sprachen sprechen, zu ermöglichen, indem automatisch genaue und kohärente Übersetzungen erstellt werden.
Der neueste und leistungsfähigste Ansatz für die maschinelle Übersetzung ist die Neuronale Maschinelle Übersetzung (NMT). NMT verwendet künstliche neuronale Netze, insbesondere rekurrente neuronale Netze (RNN) oder Transformationsmodelle. Diese Modelle lernen, Eingabesätze in einer Sprache auf Ausgabesätze in einer anderen Sprache abzubilden. Die NMT hat große Erfolge erzielt und ist bekannt dafür, dass sie Kontext erkennen und flüssigere Übersetzungen erstellen kann.
„Wie gut sind die Ergebnisse maschineller Übersetzung im Jahr 2025?“
Obwohl maschinelle Übersetzungssysteme beträchtliche Fortschritte gemacht haben, ist es aufgrund der Komplexität der menschlichen Sprache, kultureller Nuancen und der Mehrdeutigkeit bestimmter Ausdrücke nach wie vor eine große Herausforderung, eine Übersetzungsgenauigkeit auf dem Niveau eines professionellen Übersetzers zu erreichen. Für einige Branchen, Fachgebiete und Sprachpaare ist es jedoch durchaus möglich, mit maschinell übersetzte Inhalte eine Qualität zu erreichen, die die Veröffentlichung ohne Nachbearbeitung durch einen menschlichen Redakteur erlaubt. Gut geschriebene und übersetzungsfreundliche Produktliteratur (insbesondere Anleitungen für Verbraucherprodukte) ist ein guter Kandidat für maschinelle Übersetzungen, die ohne menschliche Nachbearbeitung veröffentlicht werden können.
„Was ist übersetzungsgerechtes Schreiben?“
Unter übersetzungsgerechtem Schreiben versteht man die Erstellung von Inhalten in einer Art und Weise, die die Übersetzung in andere Sprachen erleichtert, ohne dass deren Unmissverständlichkeit leidet. Zu den Grundsätzen und Techniken für das Verfassen übersetzungsfreundlicher Inhalte gehören Klarheit, Einfachheit, Konsistenz und Prägnanz.
Übersetzungsvarianten
Bitte beachten Sie, dass es sich bei der folgenden Klassifizierung nicht um eine allgemein anerkannte und verwendete Systematik handelt, sondern um ein vereinfachtes Modell der Inhaltsübersetzung.
Stufe 1 – menschliche Übersetzung
Übersetzung durch einen menschliche Experten / Stufe 1 bezieht sich auf einen Übersetzungsprozess, bei dem ein Dokument oder ein Dokumentensatz vollständig von einem menschlichen Übersetzer in eine andere Sprache übersetzt wird. Zu den Variationen innerhalb dieser Stufe gehören …
- Fähigkeiten des Übersetzers: Die Inhalte können von professionellen Übersetzern oder Fachexperten oder von weniger qualifizierten Personen übersetzt werden.
- Überprüfung: Übersetzungen können von einem oder mehreren Korrektoren, die die Ausgangs- und die Zielsprache beherrschen, überprüft/korrekturgelesen werden. Im Idealfall sind diese Lektoren auch Fachexperten.
Die Übersetzung durch einen professionellen Übersetzer bietet zwar in der Regel die höchste Qualität, ist aber auch mit den höchsten Kosten verbunden – vor allem, wenn die Übersetzungen auch überprüft werden müssen.
Stufe 2 – nachbearbeitete maschinelle Übersetzung
Stufe 2 - Nachbearbeitete maschinelle Übersetzung ist ein Übersetzungsprozess, bei dem ein Dokument maschinell übersetzt wird und anschließend ein menschlicher Übersetzer oder Reviewer diese maschinelle Übersetzung vor der Veröffentlichung überprüft und gegebenenfalls bearbeitet. Dieser Vorgang wird als Post-Editing (Nachbearbeitung der Übersetzung) bezeichnet.
Stufe-2-Übersetzungen sind kostengünstiger als Stufe-1-Übersetzungen, da die grundlegende Übersetzungsarbeit automatisch erledigt wird und bei Verwendung einer hochwertigen Machine Translation Engine die meisten Übersetzungseinheiten (Segmente) nicht oder nur in geringem Umfang bearbeitet werden müssen.
Stufe 3 – Benutzerseitige maschinelle Übersetzung
Stufe 3 – benutzerseitige maschinelle Übersetzung bezieht sich auf einen Übersetzungsprozess, bei dem ein Endanwender die maschinelle Übersetzung eines Dokuments (in der Regel ein von einem Webbrowser dargestelltes HTML-Dokument) unter Verwendung einer Machine Translation Engine auslöst. Die maschinelle Übersetzung ersetzt dann das Originaldokument durch die unbearbeitete („rohe“) maschinelle Übersetzung.
Übersetzungen der Stufe 3 sind die kostengünstigste Lösung, da die Übersetzungen im Wesentlichen kostenlos sind. Mit anderen Worten: Die Kosten für die maschinelle Übersetzung werden durch eine Vereinbarung zwischen dem Browseranbieter und dem Anbieter der Machine Translation Engine gedeckt. Da jedoch kein menschlicher Fachmann oder Prüfer beteiligt ist, sind Fehler und Unklarheiten im übersetzten Text wahrscheinlicher.
4. Barrierefreiheit

„Warum ist Barrierefreiheit wichtig?“
Barrierefreiheit ist bei Produktliteratur aus mehreren wichtigen Gründen wichtig:
Inklusivität
Barrierefreiheit stellt sicher, dass jeder – auch Menschen mit Behinderungen – auf Websites zugreifen und diese nutzen können, indem sie Hindernisse beseitigt, die andernfalls die volle Nutzung digitaler Inhalte verhindern könnten.
Einhaltung von Rechtsvorschriften
In vielen Ländern gibt es Gesetze und Vorschriften, die vorschreiben, dass Informationsquellen für Endanwender (wie beispielsweise Websites, Support-Datenbanken und andere veröffentlichte Produktinformationen) für Menschen mit Behinderungen zugänglich sein müssen. Die Nichteinhaltung solcher Gesetze und Vorschriften zur Barrierefreiheit kann rechtliche Konsequenzen und Strafen nach sich ziehen.
Verbesserte Benutzerfreundlichkeit
Barrierefreie Funktionen verbessern oft die allgemeine Benutzererfahrung für alle Anwender, nicht nur für Menschen mit Behinderungen. Die Untertitelung von Videos kommt beispielsweise nicht nur Hörgeschädigten zugute, sondern auch Nutzern in lauten Umgebungen, die möglicherweise den Ton nicht oder nur schlecht hören können.
Suchmaschinen-Optimierung (SEO)
Suchmaschinenbetreiber berücksichtigen zunehmend die Zugänglichkeit als Faktor bei der Priorisierung (dem Ranking) der Suchergebnisse. Barrierefreie Websites werden mit größerer Wahrscheinlichkeit indiziert und rangieren in den Suchergebnissen weiter oben, was zu mehr Sichtbarkeit und höheren Besucherzahlen führt.
Technologische Fortschritte
Mit der Weiterentwicklung der Technologie entstehen neue Geräte und Plattformen. Wenn Ihr Unternehmen von Anfang an für Barrierefreiheit sorgt, kann es langfristig den Erfolg und die Relevanz seine Website sichern. Gleichzeitig erhöht sich die Wahrscheinlichkeit, dass deren Inhalte sowohl mit möglichst vielen aktuellen wie auch zukünftigen Endgeräten und Technologien nutzbar sind.
Markenreputation
Ein Engagement für Barrierefreiheit kann den Ruf Ihrer Marke verbessern. Menschen schätzen Unternehmen und Organisationen, die das Thema „Inklusion“ ernst nehmen und Maßnahmen ergreifen, um ihre Produkte und Dienstleistungen für alle Anwender zugänglich zu machen.
Finanzielle Vorteile
Wenn Anleitungen und Support-Inhalte für ein breites Publikum barrierefrei nutzbar sind, kann dies die Zahl der zufriedenen Kunden erhöhen und sie motivieren, auch in Zukunft die Produkte und Dienstleistungen des Anbieters zu nutzen.
„Welche Behinderungen und Einschränkungen sollten bei der Erstellung barrierefreier Produktliteratur berücksichtigt werden?“
Kognitive Behinderungen
Kognitive Behinderungen sind Störungen, die kognitive Funktionen wie Gedächtnis, Aufmerksamkeit, Problemlösung und Verständnis beeinträchtigen. Beispiele hierfür sind Legasthenie, Aufmerksamkeitsdefizit-Hyperaktivitätsstörung (ADHS) und geistige Behinderungen.
Nach Angaben der Weltgesundheitsorganisation (WHO) sind etwa 15 % der Weltbevölkerung mit irgendeiner Form kognitiver Einschränkung betroffen.
Sinnesbehinderungen
Sinnesbehinderungen sind Beeinträchtigungen eines oder mehrerer Sinne, wie Sehen, Hören, Tasten, Schmecken und Riechen. Häufige Beispiele sind Blindheit, Taubheit und Empfindlichkeit gegenüber Berührungen.
Nach Angaben der Weltgesundheitsorganisation sind schätzungsweise 2,2 Milliarden Menschen weltweit sehbehindert oder blind, und mehr als 5 % der Weltbevölkerung (466 Millionen Menschen) leiden an einer Hörbehinderung.
Motorische Behinderungen
Motorische Behinderungen beeinträchtigen die körperliche Mobilität oder Koordinationsfähigkeit der betroffenen Personen. Erkrankungen wie Lähmungen, Muskeldystrophie und Zerebralparese fallen unter diese Kategorie.
Die Prävalenz motorischer Behinderungen ist unterschiedlich, aber nach Angaben der Weltgesundheitsorganisation sind etwa 15 % der Weltbevölkerung in irgendeiner Form behindert, und ein erheblicher Teil davon ist in seinen motorischen Fähigkeiten eingeschränkt.
„Wie viele potenzielle Nutzer unserer Produkte und Produktinformationen sind von Behinderungen betroffen?“
Die Weltgesundheitsorganisation schätzt, dass etwa 15 % der Weltbevölkerung (circa 1,3 Milliarden Menschen) in irgendeiner Form behindert sind.
In den Vereinigten Staaten sind nach Angaben der Centers for Disease Control and Prevention (CDC) etwa 26 % der Erwachsenen in irgendeiner Form behindert.
Nach Angaben der Weltbank sind Menschen mit Behinderungen häufig stärker von Armut betroffen und sehen sich mit Hindernissen beim Bildungserwerb und der Arbeitssuche konfrontiert.
Faktenblatt zu Behinderungen der Weltgesundheitsorganisation
„Wie können wir mit Ihren semantischen Publishing-Lösungen Geld sparen?“
Kurz gesagt: Der Einsatz eines modernen Workflows für die Veröffentlichung von Produktliteratur spart Markenunternehmen Geld, da verschiedene zeitaufwändige Transformationsprozesse reduziert oder eliminiert werden:
- Durch die Verwendung eines offenen Formats (HTML) können Inhalte (Prosa) leicht von einer Sprache (in der Regel Englisch) in eine andere übersetzt werden kann, entweder durch serverseitige maschinelle Übersetzung (mit oder ohne Nachbearbeitung) oder durch benutzerseitige maschinelle Übersetzung in einem Webbrowser.
- Die Verwendung von korrektem, semantischem HTML verbessert auch die Zugänglichkeit (Barrierefreiheit) veröffentlichter Dokumente, was das Leben aller Nutzer einfacher macht und vor allem Menschen mit motorischen, kognitiven oder sensorischen Beeinträchtigungen zugute kommt.
- Unser Workflow unterstützt die Speicherung von Produktinformationen in Form von Schlüssel-Wert-Paaren im YAML-Format. Dies ermöglicht es technischen Autoren oder Produktmanagern, Produktdaten einzugeben und sie sowohl in menschen- als auch in maschinenlesbare Ausgabeformate umwandeln zu lassen. Bessere Produktinformationsdaten erhöhen deren Sichtbarkeit und dienen der Suchmaschinenoptimierung.
5. Künstliche Intelligenz
„Wie und wo kommt beim Publishing Künstliche Intelligenz ins Spiel?“
Die bekannten Large Language Models (LLMs) können entweder über eine öffentliche Weboberflächen oder deren APIs eingebunden werden. Wenn Sie Künstliche Intelligenz einsetzen wollen, um Produktliteratur zu erstellen, zu ändern, zu erweitern oder zu übersetzen, können Sie beide Ansätze nutzen. Markdown-formatierte Inhalte können einfach in die Frontends beliebter LLMs eingefügt werden, um Inhalte dort zu erweitern und zu verfeinern. Weitere Informationen finden Sie in unserem Artikel „Markdown und große Sprachmodelle: eine perfekte Kombination“.
Anhang: Allgemeine Terminologie
- Produktliteratur
-
Der Begriff Produktliteratur bezieht sich in der Regel auf gedruckte oder digitale Unterlagen, die Informationen über ein bestimmtes Produkt enthalten. Dazu gehören Broschüren, Bedienungsanleitungen, Datenblätter, Produktkataloge und andere Dokumente, in denen die Merkmale, Spezifikationen, Gebrauchsanweisungen und Vorteile des Produkts ausführlich beschrieben werden. Produktliteratur wird zu Marketing- und Informationszwecken verwendet, um Kunden bei fundierten Kaufentscheidungen und bei der effektiven Nutzung gekaufter Produkte zu unterstützen. Sie kann auch technische Informationen für Mitarbeiter in den Bereichen Produktentwicklung, Vertrieb und Wartung bereitstellen. Produktliteratur ist in der Regel auf den Produkt- oder Support-Webseiten von Herstellern oder Vertrieben verfügbar oder von diesen Seiten aus abrufbar.
- Semantisches HTML
-
Der Begriff Semantisches HTML bezieht sich auf die Verwendung von HTML-Elementen, um die Bedeutung oder Struktur der Inhalte, die sie umschließen, zu vermitteln (im Gegensatz zu Formatierungsanweisungen, die nur das Aussehen von Elementen beschreiben). Mit anderen Worten: Richtig verwendete semantische HTML-Tags beschreiben den Zweck oder die Rolle des Inhalts, dem sie zugeordnet sind. Semantisches HTML verbessert die Lesbarkeit und Wartbarkeit des Codes und bietet zahlreiche Vorteile, insbesondere für die Barrierefreiheit, die Suchmaschinenoptimierung (SEO) und die Interoperabilität mit anderen Webtechnologien. Wenn semantisches HTML verwendet wird, können Screenreader, Suchmaschinen-Crawler und andere Tools die Struktur und Bedeutung der Inhalte besser „verstehen“, was zu einer verbesserten Benutzererfahrung und besseren Platzierungen bei Suchmaschinenergebnissen führt.
↻ 2025-05-28