ドキュメント翻訳の環境構築が簡単にできるMakefileをつくった

はじめに

この記事では、PHP の新しいバージョンがリリースされるタイミングとともに、日本語ドキュメントに英語ドキュメントの内容を翻訳するタスクをいろいろとやっていたので、その内容について書いています。

また、主にPHP勉強会in広島 vol.2にて発表した内容の、余談部分についてがメインです。発表資料はリンクを置いていますので、そちらから見ていただきたいです。

そもそもドキュメントの翻訳に参加した経緯なのですが、スライド内でも言及している通り、PHP 8.4 リリースに伴う日本語ドキュメントの翻訳に関するツイートを拝見し、新機能のキャッチアップ目的にちょうどいい機会だと思い、翻訳に手を出してみました。

PHP 8.4リリースまで残るは2週間ですが、このタイミングでPHP日本語マニュアルのコミット権限を貰えました。やったー！https://t.co/SVK8oNwina

日本語メインの方にPHP 8.4新機能の説明をわかりやすくお届け出来るよう、頑張っていきます！
— 武田憲太郎 (@KentarouTakeda) November 7, 2024

最近はフロントエンドの開発ばかり行っており、PHP 自体から離れていたのもあって、何かできることがないかなと探していた時期と重なっていたという事情もありました。

Makefileを作った

PHP のドキュメントの翻訳に貢献しようと考えた際、日本語ドキュメントの README に書かれているビルド方法ではうまく動かなかったことを要因として、自身でビルドする際に使用するための Makefile を書きました。目的は翻訳に貢献することなので、README 通りのビルド方法でビルドしなくても、翻訳した内容がローカルのマシン上で確認できれば良いと考えていました。

（ただし、今後ドキュメント翻訳に新しく参加する方が、この記事や僕が作った Makefile などの情報が無くても翻訳に参加できるように、何かしら問題がある箇所の特定をして修正をしなければなりませんね…）

なにか別のビルド方法がないか探していた際に、https://doc.php.net/ の Setting up a local development environment を確認してみると、Docker を用いてビルドする方法と、Docker を用いずにビルドするという二通りの方法が記載されていました。

これは個人的な都合ですが、普段から利用しているマシンが限界を迎えそうで、Docker を用いて環境を立ち上げると悲鳴を上げ始めるため、Docker を使わずにできる方法を考える必要がありました。Docker を用いない方法で、なおかつ簡単に、短いコマンドでビルドができると嬉しいので先述のドキュメントから必要なコマンドをまとめ、少しだけ手を加えた上で GitHub 上に公開しておきました。

壁を取り除く

最初は自分の環境でビルドして、ドキュメントの変更点について確認出来ることを目的としていました。しかし、これから新たに翻訳に参加してくださる方が増えたらいいなという思いもあり、ならば最初の環境構築で躓いてしまわないように、PHP ユーザーズ (日本語)にて自身の困っている点とともに共有してみました。

その影響もあって、作成した Makefile を利用して翻訳に参加してくださった方もいらっしゃり、声に出してみるものだなーと実感しました。

PHPマニュアルの誰でも簡単に翻訳の作業環境を整えることができるMakefileが本当に簡単に環境を構築できて俺の中で大感謝祭が始まった

記事内の言葉を引用するのですが、「開発や利用しやすさの改善に貢献する」という点は、自分が生きていく中で一番大事にしている軸であり、何かしらのモノやコトを作り上げるときなどは、縁の下の力持ちとして活躍できるような立ち回りばかりやっています。

その中で以下の点をよく意識しています。

壁のない、ゴールまで一直線に登ることができる山 🏁
- やりたいことを一直線にできるため、作業を始める前から完了までにストレスがかからない
壁があり、ゴールまで一直線に登ることができない山 💥
- やりたいことを一直線にできないため、取り組む作業以外のことに注力しなければならずストレスがかかってしまう
壁を取り除いてあげることでたくさんの人の助けに 🏃‍♂️💨
- スムーズに作業が行えるように環境を整えたりサポートしたりすることは大事なこと

壁のない、ゴールまで一直線に走ることができる山に誰もが登れるよう、立ち塞がる壁を取り除いてストレスのない作業環境や雰囲気を作り上げることこそが自分がやっていきたい人生の軸みたいなところです。今回の件はその軸にピッタリと当てはまったいい例だったなと感じています。

終わりに

Makefile を作ったことによって、簡単にドキュメント翻訳の環境構築ができるようになりました。作った Makefile を利用して、日本語ドキュメントに初めて翻訳のプルリクエストを出したという方もおられました。他にもブログなどでの引用や、GitHub 上のコメントで使用していることを書いてくださっている方など、本当にありがとうございます。

もともと、自身が簡単に翻訳するための環境を整えようとして作っていたものが、こうして役に立つものとして利用されているのは本当に嬉しい限りです。

まだまだ翻訳に貢献できる箇所はたくさんありますので、こちらの issue を見ていただき、協力できそうな部分がありましたら皆さんも是非プルリクエストなどを出してみてください。