すべての導入事例
Papermark

Papermark、MDX設定の壁を乗り越え、ドキュメント80ページを翻訳

Lingo.devが、PapermarkのNext.js、next-intl、MDXの設定にまつわる課題を解決。オープンソースのドキュメントをより多くの読者に届け、更新に合わせて翻訳も維持できるよう支援しました。

80ページ 初日に翻訳

業界
ドキュメント共有
読む
1分
サイト
papermark.io

Papermarkは、オープンソースのドキュメント共有プラットフォームを開発しています。ドキュメントの多言語化に取り組むにあたり、最初の壁となったのは、ドキュメントを配信するアプリケーションで国際化を正しく機能させることでした。

ローカライゼーションを実際に役立てるには、こうした下準備も欠かせません。翻訳サービスには、顧客が実際に使っているファイルやアプリケーションの構造に対応することが求められます。PapermarkへのLingo.devの支援は、Next.jsプロジェクトとMDXドキュメントへの対応から始まり、新規ページや更新されたページを翻訳するワークフローの構築へと続きました。

「第一印象は最高でした。何の問題もなく動いたんです。私たちのようなオープンソースプロジェクトにとって、ローカライズの全工程を自動化しながら、これほど親身なサポートを受けられるのは、まさに求めていたことでした。」

— ユリア・シュナイ、Papermark 創業者

翻訳の前に立ちはだかった壁 #

ドキュメントには、マークダウンにReactコンポーネントを埋め込めるMDXが使われていました。そのため、単純な言語ファイルから文字列を探し出すだけでは不十分でした。アプリケーションの構造と、ドキュメント内のコンポーネントに対応したローカライゼーションが必要だったのです。

「手に入る自動化パッケージも独自開発のツールも、片っ端から試しました」と、Papermarkの創業者ユリア・シュナイ氏は振り返ります。「一番苦労したのは、翻訳そのものではありませんでした。私たちのアプリの構造に合わせて、国際化をきちんと機能させることだったのです」

ユリア氏の課題から、必要な支援は明らかでした。テキストを翻訳する手段を別のものに変えるだけでは、チームには同じ設定作業が残ってしまいます。

プロジェクトの構造に踏み込んだLingo.devの支援 #

Lingo.devの創業者マックス氏は、Papermarkに直接連絡し、Next.jsプロジェクトの設定を支援しました。実装では、互いに関連する次の三つの設定上の課題に対応しました。

  • ドキュメントに使われているMDXファイルの処理。
  • アプリケーションのファイル構造に合わせてnext-intlを動作させるための設定。
  • 多数のコンポーネントを含むドキュメントからの翻訳対象文字列の抽出。

こうした細部への対応が、Papermarkの既存ドキュメントにローカライゼーションを導入できるかどうかを左右していました。シュナイ氏は、実装によって解決できたことを次のように語っています。

「私たちが想定していなかった数多くの例外的なケースにも対応してくれました」とシュナイ氏は話します。「ローカライゼーションに伴う複雑さを、隅々まで考え抜いていることが伝わってきました。特に、私たちが大きな課題と感じていたMDXファイルへの対応で、それを実感しました」

80ページの翻訳から、継続的なドキュメント翻訳のワークフローへ #

Papermarkは初日にドキュメント80ページを翻訳しました。ローカライゼーションエンジンにはプロジェクトの製品用語を組み込み、リポジトリにも接続しました。初回の翻訳後は、コードのプッシュをきっかけに、新規・更新ドキュメントの翻訳が実行されるようになりました。エンジニアは英語での執筆を続け、その内容からワークフローが各言語版を生成する仕組みです。

この仕組みの価値は、最初の80ページの翻訳にとどまりません。Papermarkは、原文の変更に合わせて他言語のドキュメントも維持できるようになりました。公開された導入事例によると、チームはさらに、ロケールごとの検索エンジン最適化にもローカライゼーションの取り組みを広げていました。

MDXとアプリケーションの細かな課題を解決したことで、Papermarkは実際に使っているドキュメントをローカライズできるようになりました。最初の80ページで運用の基盤を確立し、リポジトリとの接続によって、ドキュメントを更新するたびに新たな連携作業として対応することなく、執筆を続けられるようになったのです。