Zum Hauptinhalt springen
Logo text-itLogo text-it

Python goes Doku – wie Scripting den Technischen Redakteur unterstützen kann

Know-how | Technische Redaktion

Python wie die Schlange? Nein, Python wie Monty Python. Die Komikergruppe diente als Namensinspiration für die Programmiersprache. Python ist zwar weder ein Trojanischer Hase noch ein Killer Rabbit, kann aber mit etwas Geschick auch in Dokulandschaften große Wirkkraft entfachen und einzelne Arbeitsschritte enorm beschleunigen.

Neue Felder wie KI, Machine Learning, Big Data oder Computerlinguistik greifen gerne auf Scripting mit Python zurück. Nicht zuletzt deshalb ist Python laut aktuellem PYPL-Index (PopularitY of Programming Language) die mit Abstand bekannteste Sprache – gemessen an Suchanfragen im Web. Den größten Vorteil der Programmiersprache bieten hierbei die vielen Bibliotheken, Quelltexte, Beispielprogramme und Analysetools, die frei zur Verfügung stehen. Dateien und Textelemente können schnell ausgewertet, repariert oder nach eigens erstellten Regeln in andere Formate umgewandelt werden.

Python im Redaktionsalltag von S1000D

Was kann die Scripting-Sprache nun in der Technischen Dokumentation konkret bewirken, wo vermag Sie den Technischen Redakteur zu unterstützen? Ein Beispiel aus einem unserer Redaktionsprojekte:

Für ein umfangreiches Projekt war es notwendig, tausende Seiten aus unzähligen Word-Dateien von verschiedenen Autoren in ein S1000D-kompatibles XML-Format zu bringen und daraus eine HTML-Ausgabe (IETP) mit ca. 3.000 Datenmodulen zu publizieren. Also gleich mehrere besondere Herausforderungen für sich, die nach sehr viel Arbeit klingen. Und das war es auch, bis Python ins Team aufgenommen wurde! Damit entfielen hunderte Stunden für die manuelle Dateierstellung im strukturierten FrameMaker als Editor. Für „Mußestunden“ sorgte eine individuell angepasste Engine zur automatischen Konvertierung. Zwar schwitzte dafür der text-it Programmierer, aber das Ergebnis sprach letztlich für sich: Das Projekt hat bislang alle Milestones erfolgreich absolviert.

Grundstein für solch ein Vorhaben ist eine sorgfältig aufgebaute Dokumentationsstruktur mit klar definierten Gliederungen, Formaten, Schreibregeln und Workflows. Neben Python als mächtiges Scriptingtool wird für die konsistente Textzusammenführung der unterschiedlichen Fachredakteure zusätzlich Verifika für die Terminologiekontrolle (mit Stoppwörtern) und ein Translation Memory System (Trados) für die Organisation der Textbausteine eingesetzt.

Python als praxistauglicher Workaround

Das Scriptingtool eignet sich für Projekte und Dokumentationslandschaften, die folgende Troublemaker in den Griff bekommen müssen:

  • Umsetzung spezieller Projektanforderungen (z.B. S1000D)
  • Textuelle Anpassung und Vereinheitlichung mehrerer Autoren
  • Automatische Konvertierung unterschiedlicher Dateiformate
  • Publikationen für mehrere Ausgabekanäle (HTML, PDF, usw.)

Die Scripting-Lösung von text-it

Unsere Plug-in-Lösungen  unterstützen Technische Redakteure auf dem langen Weg der Dateiformate, errichten Brücken zwischen unterschiedlichen Abteilungen im Unternehmen und öffnen das Tor zur Digitalisierung.

Kontaktieren Sie uns, wenn Sie wissen möchten, wie Python Ihre Redaktionsumgebung vereinfachen kann.

Stand: 2021

Zurück