Papermark meistert die MDX-Einrichtung und übersetzt 80 Dokumentationsseiten
Lingo.dev half Papermark, die Konfiguration von Next.js, next-intl und MDX abzustimmen, damit die Open-Source-Dokumentation mehr Menschen erreicht und ihre Übersetzungen auch bei Änderungen aktuell bleiben.
80 Seiten am ersten Tag übersetzt
- Teilen von Dokumenten
- 2 Min.
- papermark.io
Papermark entwickelt eine Open-Source-Plattform zum Teilen von Dokumenten. Als das Unternehmen seine Dokumentation in weiteren Sprachen anbieten wollte, musste es zunächst eine Hürde nehmen: Die Internationalisierung musste in der Anwendung funktionieren, über die die Dokumentation bereitgestellt wurde.
Damit Lokalisierung wirklich nützt, braucht es diese Vorarbeit. Ein Übersetzungsdienst muss sich an den Dateien und der Anwendungsstruktur orientieren, die seine Kunden tatsächlich nutzen. Bei Papermark setzte Lingo.dev zunächst beim Next.js-Projekt und seiner MDX-Dokumentation an. Darauf folgte ein Workflow, der neue und aktualisierte Seiten übersetzte.
"Der erste Eindruck war der beste – es hat einfach funktioniert. Für ein Open-Source-Projekt wie unseres war eine so persönliche Unterstützung bei der Automatisierung unseres gesamten Lokalisierungsprozesses genau das, was wir brauchten."
– Iuliia Shnai, Gründerin, Papermark
Die erste Hürde kam noch vor der Übersetzung #
Die Dokumentation basierte auf MDX, das Markdown mit eingebetteten React-Komponenten verbindet. Es ging also um mehr als darum, Zeichenfolgen in einer einfachen Sprachdatei zu finden: Die Lokalisierung musste zur Anwendungsstruktur passen und mit den Komponenten in den Dokumenten funktionieren.
"Ich habe jedes verfügbare Automatisierungspaket und selbst entwickelte Tool ausprobiert", erinnert sich Iuliia Shnai, Gründerin von Papermark. "Die größte Schwierigkeit war nicht einmal die Übersetzung selbst – sondern i18n mit unserer App-Struktur richtig zum Laufen zu bringen."
Iuliias Problem zeigte deutlich, welche Unterstützung sie brauchte. Ein weiteres Tool zur Textübersetzung hätte am Einrichtungsaufwand für das Team nichts geändert.
Lingo.dev setzte bei der Projektstruktur an #
Max, der Gründer von Lingo.dev, nahm direkt Kontakt mit Papermark auf und half bei der Konfiguration des Next.js-Projekts. Die Umsetzung umfasste drei miteinander verbundene Aufgaben:
- Die für die Dokumentation verwendeten MDX-Dateien verarbeiten.
- next-intl mit der Dateistruktur der Anwendung zum Laufen bringen.
- Übersetzbare Zeichenfolgen aus Dokumenten mit zahlreichen Komponenten extrahieren.
Von diesen Details hing ab, ob Papermark seine bestehende Dokumentation lokalisieren konnte. Shnai beschrieb, was die Umsetzung löste:
"Die Umsetzung berücksichtigte so viele Sonderfälle, an die wir gar nicht gedacht hatten", sagt Shnai. "Es war deutlich, dass sie die gesamte Komplexität der Lokalisierung durchdacht hatten – besonders bei MDX-Dateien, die uns große Schwierigkeiten bereitet hatten."
Aus 80 Seiten wurde ein dauerhafter Dokumentations-Workflow #
Papermark übersetzte am ersten Tag 80 Dokumentationsseiten. Die Lokalisierungs-Engine berücksichtigte die Produktterminologie des Projekts und war mit dessen Repository verbunden. Nach der ersten Übersetzung lösten Code-Pushes die Übersetzung neuer und aktualisierter Dokumentationsseiten aus. So konnte das Entwicklungsteam weiterhin auf Englisch schreiben, während der Workflow lokalisierte Versionen erstellte.
Der Nutzen dieser Einrichtung reichte über die ersten 80 Seiten hinaus. Papermark konnte damit die Dokumentation in weiteren Sprachen aktuell halten, auch wenn sich die Ausgangstexte änderten. Wie der veröffentlichte Bericht festhielt, weitete das Team die Lokalisierung zudem auf die SEO-Optimierung für die verschiedenen Sprachen aus.
Mit den geklärten MDX- und Anwendungsdetails konnte Papermark seine bestehende Dokumentation lokalisieren. Die ersten 80 Seiten bildeten die Grundlage für eine funktionierende Lösung. Dank der Repository-Anbindung konnte das Team weiter schreiben, ohne aus jedem aktualisierten Dokument eine neue Integrationsaufgabe zu machen.