Beschleunigung des Produktentwicklungszyklus durch die Einführung von Phrase TMS

Herausforderung

Verbesserter Workflow zur Erstellung von Support-Dokumenten: traditionelle Abwicklung per Content-Management-System

Zu den Aufgaben des Technical-Communications-Teams von Cybozu gehören die Gestaltung der Benutzeroberflächentexte der Unternehmensprodukte, die Erstellung von Dokumentationsangeboten wie Support-Sites und Versionshinweisen sowie deren Übersetzung und Lokalisierung.

Bisher nutzte das Team ein Content-Management-System (CMS) für die Erstellung von Dokumenten und deren Übersetzung ins Englische und Chinesische sowie die Veröffentlichung der Inhalte auf der Website.

Wenn im Rahmen des Übersetzungsprozesses ein Artikel aktualisiert werden musste, wurde dieser als PDF-Datei an die Übersetzer geschickt. In dieser PDF-Datei hatte der Autor des Artikels die geänderten Stellen manuell hervorgehoben. Der Übersetzer öffnete dann alle zu überarbeitenden Dateien nacheinander, überprüfte die markierten Bereiche und übersetzte die aktualisierten Abschnitte dann erneut am Computer. Die Übersetzer fügten diese Änderungen dann manuell wieder in das CMS ein und konvertierten sie in HTML. Anders formuliert: Wenn 20 Seiten zu aktualisieren waren, mussten 20 PDF-Dateien erstellt und mit beträchtlichem manuellen Aufwand abgearbeitet werden. Überdies führte diese Arbeitsweise häufig zu Auslassungen – Änderungen wurden nicht hervorgehoben oder im Rahmen der manuellen Aktualisierung übersehen.

Beschleunigte Dokumentation für den agilen Entwicklungsprozess

Als neues Verfahren für die Softwareentwicklung begann Cybozu mit der Einführung der agilen Entwicklung. Agile Entwicklung ist eine Methode zur Erhöhung der Entwicklungsgeschwindigkeit. Dabei erfolgt die Entwicklung in kurzen Zyklen. So können situationsbedingt und flexibel Änderungen auch unabhängig von den ursprünglichen Projektvorgaben vorgenommen werden.

Dabei wurde deutlich, dass die termingerechte Erstellung und Übersetzung der Dokumentation im Rahmen dieses beschleunigten Entwicklungszyklus mit dem bisherigen manuellen Prozess nicht möglich wären. Daher entschied sich das Team für technische Kommunikation, ihr Konzept für die Erstellung der Dokumentations-Site grundlegend zu überarbeiten. Und so ging das Team vor:

Lösung

Versionsverwaltung mit Git und inkrementelles Änderungsmanagement mit Phrase TMS

Um den Erstellungsprozess effizienter zu gestalten, wollte das Team eine Lösung implementieren, mit der inkrementelle Änderungen verwaltet werden können. Zuerst wurde die Entscheidung getroffen, die Inhalte in Git zu verwalten. Das erlaubt die Versionierung von Inhalten und vereinfacht die Handhabung häufiger Änderungen von Spezifikationen. Parallel dazu wechselte das Team auf Phrase TMS. In Phrase TMS wiederum werden Änderungen am Quelltext automatisch angezeigt.

Wechsel zu Klartextdateien mit Markdown-Notation

Bei der Umstellung auf das oben umrissene System änderte Cybozu auch das Verfahren zur Erstellung von Manuskripten, um inkrementelle Änderungen besser abbilden zu können. Durch Nutzung der Auszeichnungssprache Markdown wurde es möglich, Manuskripte in Form generischer Klartexte (Plain Text) zu erstellen. Markdown erlaubt es, Texte in einem für Menschen leicht lesbaren und auch für Computer interpretierbaren Format auszuzeichnen. Dabei werden Strukturen wie Listen und Überschriften mit einfachen Symbolen vorgegeben. Ein Vorteil der Markdown-Implementierung besteht darin, dass es für Menschen einfacher ist, sich die inkrementellen Änderungen in Git anzeigen zu lassen. Außerdem können die mit Markdown formatierten Texte in Phrase TMS einfacher übersetzt werden, da es – anders als zum Beispiel bei HTML – keine vergleichsweise komplexen Tags gibt.

Allerdings müssen Markdown-Dateien, damit diese im Web veröffentlicht werden können, in das HTML-Format konvertiert werden. Hierfür verwendet das Dokumentationsteam den Site-Generator Hugo.

Vorteile der Implementierung eines Versionskontrollsystems

Bei der agilen Produktentwicklung müssen oft Änderungen der Spezifikationen, der Veröffentlichungsdaten oder auch ausfallende Releases berücksichtigt werden. Ein besonderes Problem, mit dem sich das Cybozu konfrontiert sah, war die Verschiebung von Release-Zeiten für jede Anforderung bei der Änderung der Release-Daten.

Bei der Lösung dieses Problems können Versionsverwaltungssysteme wie Git ihre Stärken ausspielen, da hier Funktionen zur Verwaltung von Entwicklungszweigen (Branching) genutzt werden können. Mit diesem Mechanismus können Änderungen in Entwicklungszweigen auf Anforderungsebene direkt in der Dokumentation nachgebildet werden.

Auf diese Weise können selbst bei Änderungen oder dem Ausfall von Releases die Zeitpunkte für das Zusammenführen oder Absagen von Branches einfach angepasst werden. Damit verringert sich der Arbeitsaufwand im Vergleich zur Verwaltung in einem Content-Management-System drastisch. Ein weiterer Vorteil ist, dass durch die automatische Aufzeichnung der Änderungshistorie und die Möglichkeit, auf Versionen vor dem Zusammenführen von Entwicklungszweigen zurückzugreifen, nachträglich festgestellt werden kann, welche Personen welche Änderungen vorgenommen haben.

Gründe für die Einführung von Phrase TMS als Übersetzungsmanagementsystem

Bei Cybozu verwenden wir Phrase TMS schon seit mehreren Jahren als Übersetzungsmanagementsystem. Wir haben uns zunächst aufgrund der günstigen Tarife für den Dienst selbst für Phrase TMS entschieden, da wir nicht erst Übersetzer zum Kauf von Software oder Lizenzen bewegen mussten. Außerdem spricht für Phrase TMS die Tatsache, dass dies zum Zeitpunkt der Implementierung das einzige System war, das Markdown-Dateien verarbeiten konnte. Es ist auch ein wesentlicher Vorteil für unser Unternehmen, dass Phrase TMS komplett als Cloud-Dienst genutzt werden kann und Workflows unterstützt.

Benefits

Neuausrichtung der Workflows zur Erstellung und Übersetzung von Artikeln

Der Prozess der Erstellung und Übersetzung von Artikeln stellt sich nach der Optimierung des Workflows wie folgt dar:

Erstellung von Artikeln in japanischer Sprache:

1. Die Artikel werden von den Autoren auf ihren Computern verfasst und bei GitHub abgelegt, einem Hosting-Dienst, der die Git-Funktionalität unterstützt. Alle Artikeldateien werden dort gespeichert.
2. Die Artikel werden von menschlichen Korrektoren und automatischen Systemen geprüft.
3. Nach erfolgter Prüfung und Freigabe werden die Artikel im Internet veröffentlicht.

Ablauf der Übersetzung ins Englische und Chinesische:

1. Die zu übersetzenden Artikel werden von GitHub in Phrase TMS übertragen. Die Dateien werden als ZIP-Archiv importiert und dafür kann – unter Beibehaltung der Workflow-Stufe – ein Projekt erstellt werden.
2. Nachdem die Einstellungen für Translation Memorys und andere Ressourcen vorgenommen wurden, werden die konkreten Übersetzungsjobs Auftragnehmern oder internen Übersetzern zugewiesen. Alle Beiträge und Kommentare bleiben in der Phrase TMS-Cloud.
3. Nach der Erstellung und Prüfung der Übersetzungen werden diese exportiert. Der aktuelle Workflow-Schritt kann beibehalten werden, indem die Übersetzungen wiederum als ZIP-Datei exportiert werden.
4. Nachdem die übersetzten Artikel als Markdown-Dateien auf GitHub hochgeladen wurden, werden diese mit Hugo in HTML konvertiert und dann im Internet veröffentlicht.

Tricks zum Importieren von Markdown-Dateien

Wenn das Dokumentations-Team Markdown-Dateien in HTML konvertiert, macht es sich die erweiterte proprietäre Notation von Hugo zunutze. So wird zum Beispiel die Zeichenfolge {{%note%}} nach der Veröffentlichung des Artikels im Browser als „✓ note“ angezeigt. Beim direkten Import in Phrase TMS wird die Zeichenfolge {{% note %}} jedoch dem Übersetzer angezeigt.

Um dies zu verhindern, wird beim Import die Phrase TMS-Funktion zum Konvertieren von Zeichenfolgen in Phrase TMS-Tags mittels regulärer Ausdrücke verwendet. Damit ist sichergestellt, dass eine solche Zeichenfolge als blauer Tag-Platzhalter mit ausgeblendetem Inhalt angezeigt wird. Es besteht also kein Risiko, dass Übersetzer die „note“ versehentlich übersetzen.

Implementierung maschineller Übersetzung

Derzeit werden die meisten Dokumentations-Inhalte bei Cybozu von Menschen übersetzt. Aber für das Produkt Garoon – eine Groupware für Mittelständler und Großunternehmen – wurde maschinelle Übersetzung eingeführt.

Im Oktober 2019 veröffentlichte Cybozu Version 5 von Garoon. Dabei wurden als Bestandteil von Produkt-Upgrades neue Funktionen ergänzt, was mit erheblichen Änderungen an der japanischen Version der integrierten Hilfe einherging. Da die japanische Hilfe etwa 2 Millionen Zeichen umfasst, war es faktisch unmöglich, nur mit der Unterstützung menschlicher Übersetzer die japanische, englische und chinesische Version gleichzeitig zu veröffentlichen. Aus diesem Grund wurde die Entscheidung getroffen, auf Post-Editing zu setzen. Dabei werden die maschinell erstellten Übersetzungen von professionellen Übersetzern geprüft und gegebenenfalls überarbeitet.

Für die maschinelle Übersetzung wird eine kostenpflichtige MT-Engine herangezogen. Da Phrase TMS viele MT-Engines unterstützt, konnten wir angeben, welche Engines verwendet werden sollen und diese dann für die Übersetzung innerhalb der Phrase TMS-Plattform nutzen.

Um Kosten zu reduzieren und Arbeitszeiten zu verkürzen, haben wir einen entsprechenden Auftrag an ein Übersetzungsunternehmen vergeben, bei dem die tatsächlichen Mannstunden und nicht der übliche Einheitspreis pro Zeichen zugrunde gelegt wurde.

Um die aus der vorherigen Version der Dokumentation vorliegenden Ressourcen optimal zu nutzen, wurden zuerst die 100%-Matches aus dem Translation Memory ermittelt und übernommen. Für die verbleibenden Segmente wurde dann eine MT-Engine herangezogen.

Die resultierende Qualität der Übersetzungen hängt von der Leistungsstärke der verwendeten MT-Engine ab. Cybozu arbeitet nun daran, die Qualität durch den Einsatz einer trainierbaren Engine weiter zu steigern.

„Durch den neuen Workflow auf Grundlage von Phrase TMS und anderen Tools konnte der Prozess der Dokumentationserstellung deutlich effizienter gestaltet werden. Ich denke, dass auch andere Unternehmen, deren Dokumentation regelmäßig aktualisiert werden muss, aus unserem Prozess lernen können.“

– Mayuko Sawai, Technical Communications Team, Development Division, Cybozu, Inc., Technische Redakteurin

Weitere Verbesserungen für Cybozu

Wir bei Cybozu möchten den manuellen Arbeitsaufwand weiter reduzieren, indem wir den Git-Konnektor von Phrase TMS verwenden, um automatisch Projekte zu bestimmten Zeiten zu erstellen. So können wir auch die Funktionalität für kontinuierliche Jobs nutzen, wenn Aktualisierungen erforderlich sind.

Darüber hinaus ziehen wir auch in Erwägung, die vor Kurzem in Phrase TMS implementierte Funktion zu verwenden, mit der wir Übersetzungsagenturen und Übersetzern regelmäßig Feedback zu ihrer Arbeit geben können.

Außerdem besteht aufgrund der zunehmenden Anzahl mehrsprachiger Projekte ein wachsender Bedarf für das Outsourcing von Übersetzungen der Benutzeroberflächentexte, die derzeit intern durchgeführt werden. Eine Herausforderung hierbei ist ein praxistaugliches Verfahren, um externen Übersetzern die Benutzeroberfläche von Produktkomponenten zu zeigen, die sich noch im Entwicklungsprozess befinden. Andererseits bietet Phrase TMS die Möglichkeit, bei jedem einzelnen Segment eines Übersetzungsauftrags auf Screenshots zu verweisen. So können Übersetzer den jeweiligen Kontext besser verstehen und hochwertigere Übersetzungen erstellen.