Ein moderner Publishing-Workflow für Ihre Produktliteratur
Doch – es geht einfacher!
Ihr Workflow für die Veröffentlichung von Produktliteratur hat vielleicht einfach zu viele teure Zwischenstopps. Mal sehen, ob wir helfen können.
| Technisches Publishing, „oldschool“: Der traditionelle, PDF-basierte Publishing-Workflow, der im Folgenden beschrieben wird, wurde vor etwa vierzig Jahren eingeführt und wird immer noch von vielen Marken verwendet: Ein Dokument wird von einem Autor erstellt, dann von einem Designer formatiert, anschließend als PDF „gerendert“ und auf einen Webserver hochgeladen. In diesem Workflow ist jedes Dokument eine „Insel „mit eigenen Ressourcen, und das gilt auch für Übersetzungen. Die Synchronisierung von Dokumenten erfordert komplexe Arbeitsabläufe und spezielle Werkzeuge. |
LOOPS / Specs and Docs: Unser Single-Source-Publishing-Workflow basiert nicht auf PDFs, sondern nutzt das volle Potenzial von Web-Technologien: Die Inhalte werden mit einer sogenannte „Lightweight Markup Language“ formatiert und dann in ansprechende, responsive Webdokumente (HTML) umgewandelt, die von Menschen oder maschinellen Übersetzungsprogrammen leicht übersetzt werden können. Alle webfähigen Inhalte, die Sie haben, können in diesem Arbeitsablauf verwendet werden, und diese Web Manuals können auch referenziert und in Ihre anderen Online-Angebote integriert werden. |
| 1. Erstellung |  |
| Traditioneller Workflow: Software: Normalerweise Microsoft Word. Dokumente sind hier in der Regel ein Sammelsurium von Inhalten: rein visuelle Formatierungen, Strukturinformationen, eingebettete Bilder und Schriftarten. Mit einem Wort: ein Chaos. |
LOOPS / Specs and Docs: Markdown, die lingua franca von GitHub und Tausenden anderen Plattformen. Die strukturellen Tags sind auf ein Minimum reduziert, leicht zu erlernen und zu lesen. Jedes Tool auf jeder Plattform kann verwendet werden; es sind keine Lizenzen erforderlich. Bilder werden als lokale Dateien oder URLs auf externen Servern eingebunden. Und wenn nach der Veröffentlichung Fehler gefunden werden, können diese leicht in den Markdown-Quelldateien behoben werden, ohne dass ein Grafikdesigner herangezogen werden muss. |
 |
2. Textsatz |
| Traditioneller Workflow: Software: normalerweise Adobe InDesign. Die von technischen Autoren gelieferten Microsoft Word-Dokumente werden importiert und oft „angepasst“ (dies ist oft ein Kampf mit verworrenen und widersprüchlichen Auszeichnungsregeln) oder komplett neu formatiert/erstellt. Dies ist ein zeitaufwändiger Prozess, bei dem ein Grafikdesigner – der das Produkt und seine Dokumentation möglicherweise kennt, vielleicht aber auch nicht – aus dem, was ihm gegeben wurde, das Beste machen muss. |
LOOPS / Specs and Docs: Hier gibt es keinen „echten“ Design-Prozess. Das strukturelle Markup (Überschriften, Listen usw.) ist bereits vorhanden. Inhalt werden in einer Standardvorlage platziert und automatisch mit einer Formatvorlage verknüpft. Normalerweise gilt – „It just works“, und die Resultate sehen gut aus. |
| 3. Schriftarten / Typografie | |
| Traditioneller Workflow: Die Schriftarten des Unternehmens (in der Regel lizenziert und in proprietären Formaten) müssen auf dem Rechner verfügbar sein, auf dem die Texte typografiert werden. Für externe Übersetzungs-Workflows sind diese Schriftarten möglicherweise auch erforderlich. |
LOOPS / Specs and Docs: Die Webfonts des Unternehmens werden einmalig mit den HTML-Templates verknüpft. Danach verwendet jedes neu gerenderte Dokument automatisch die richtigen Web-Schriften. Es können freie und quelloffene Schriftarten – zum Beispiel Google Fonts – verwendet werden, darunter die Google Noto Sans-Familie, die Tausenden von Alphabeten unterstützt. |
 |
4. Metadaten |
| Traditioneller Workflow: Wenn Metadaten (strukturierte Informationen über das Produkt oder das Dokument, die möglicherweise für das endgültige Dokument benötigt werden) vorliegen, müssen diese Metadaten gespeichert und außerhalb des eigentlichen Dokuments (oder Dokumentensatzes) in Form von E-Mails oder begleitenden Textdateien weitergeleitet werden. Diese „Meta“-Dateien können natürlich auch verloren gehen, was zu Verzögerungen und möglicherweise zu Fehlern führt. |
LOOPS / Specs and Docs: Metadaten wie Datum, Autor und Dokumenttyp können im Kopfteil jedes Dokuments in einem einfachen, standardisierten Format namens YAML hinzugefügt werden. Die Metadaten können von jedem Prozessbeteiligten eingesehen und aktualisiert werden und mittels der Templates in das eigentliche Dokument übernommen werden. Neue Metadatenfelder können leicht hinzugefügt und in der Vorlage verwendet werden. |
| 5. Übersetzung |  |
| Traditioneller Workflow: Bei herkömmlichen Arbeitsabläufen benötigen die Übersetzer die Software (in der Regel InDesign) und die Assets (Schriften, Illustrationen), die zur Erstellung der Übersetzungsquelle verwendet wurden. Sie überschreiben dann den Originalinhalt mit ihren Übersetzungen und geben die Dateien an die Grafikabteilung zurück, die sie überprüft, anpasst, zusammenfügt und veröffentlicht. In modernen Workflows werden Zwischendateien (zum Beispiel IDML für Adobe InDesign) erstellt, die dann von einer Übersetzungssoftware geparst werden, die die übersetzbaren Inhalte isoliert. Die IDML-Dateien werden dann vom Grafikdesigner wieder importiert und gespeichert. Das alles funktioniert in der Regel, aber es ist ein relativ komplexer und zeitaufwändiger Prozess. |
LOOPS / Specs and Docs: Markdown-Dateien sind Textdateien und können direkt in jedem Texteditor übersetzt werden. Sie können sogar als solche in maschinellen Übersetzungsprogrammen mit einer Weboberfläche (wie zum Beispiel Google Translate oder DeepL) verarbeitet werden, die in der Regel die Marken (Tags) für Überschriften, Listen, Hyperlinks usw. beibehalten und nur geringfügige Anpassungen erfordern. Alternativ dazu können professionelle Übersetzungsmanagementsysteme wie Phrase Markdown-Dateien verarbeiten und dabei übersetzbare Inhalte, Tags und Metadaten separieren. Marken können wählen, ob sie maschinelle Übersetzungen, nachbearbeitete maschinelle Übersetzungen oder menschliche Übersetzungen veröffentlichen möchten. |
 |
6. Publizieren |
| Traditioneller Workflow: Typografierte Dokumente werden aus der Design-Anwendung heraus gerendert, in der Regel als PDF-Dateien. Diese PDFs werden dann an das Webdesign-Team zum Hochladen auf den Server weitergeleitet, wo sie in einen Dateimanager eingefügt oder von einer Webseite aus verlinkt werden müssen. Wenn in einem veröffentlichten Dokument Fehler gefunden werden, müssen diese vom Autor oder Designer „upstream“ behoben werden, und die Dokumente müssen als PDF exportiert und erneut auf den Server hochgeladen werden – ein mehrstufiger Prozess, der oft zu Verzögerungen führt. |
LOOPS / Specs and Docs: Die Dokumente sind gültiges HTML und können als solche mit jedem Webbrowser aufgerufen werden. Sie sind sofort für menschliche Leser und als gültiges, gut strukturiertes „Suchmaschinenfutter“ verfügbar. Für Inhalte, die auf der Website Specs and Docs gehostet werden, kann eine Markdown-Datei in Sekundenschnelle in HTML umgewandelt werden, da unsere Konvertierungs-Engine LOOPS dort installiert ist und als Generator für statische Websites fungiert. Wenn eine Marke oder ihr Zielpublikum PDFs benötigt, können diese leicht aus den gerenderten HTML-Dateien erstellt werden; sowohl serverseitig mit einem kommerziellen PDF-Renderer als auch von den Endanwendern (mit der Funktion „Als PDF speichern“, die in jedem modernen Browser verfügbar ist). |
| 7. Updates |  |
| Traditioneller Workflow: Wenn eine Marke Corporate-Design-Elemente überarbeitet oder Inhalte (zum Beispiel Standard-Textblöcke) ändert, erfordert die Aktualisierung der bestehenden Dokumentation in der Regel einen erheblichen Aufwand. Es kann sogar sein, dass die Geschäftsleitung beschließt, dass sich die Kosten und der Aufwand hierfür nicht lohnen und veraltete Versionen von Dokumenten online bleiben, was dem Markenimage abträglich ist. |
LOOPS / Specs and Docs: Im Arbeitsablauf von Specs und Docs sind Inhalt und Design vollständig voneinander getrennt, ähnlich wie in einem Content-Management-System. Designänderungen können durch Modifizierung der Formatvorlage oder durch einfaches Ersetzen eines Logos oder einer Illustration vorgenommen werden. Strukturelle Änderungen (beispielsweise das Hinzufügen einer neuen Kopf-, Fuß- oder Seitenleiste) können durch Aktualisieren der HTML-Vorlage und erneutes Rendern aller HTML-Dateien vorgenommen werden. Selbst bei großen (Hunderte oder Tausende) Dokumentensätzen dauert die Aktualisierung in der Regel weniger als eine Minute. |
Die Investition in ein modernes Dokumentenformat und einen modernen Publishing-Workflow schafft belastbare Grundlagen für kommende Jahre. Gerne unterstützten wir Sie dabei, die Produktliteratur Ihrer Marke für das 21. Jahrhundert zu optimieren.
↻ 2025-08-21