Perlドキュメントワーキンググループの立ち上げからの半年の活動報告

こんにちは。id:kfly8 です。

昨年、7月からJPAはPerlを学びやすい環境作りとその支援のために「Perlドキュメントワーキンググループ」という新たな試みを開始しました*1。ここでは立ち上げから約半年の活動報告をします。

1. 翻訳の敷居を下げる

Perlに関する和訳は、長年 argrathktatに支えられている状況です。私も今回のワーキンググループ立ち上げをきっかけに翻訳をしてみましたが、技術文書ゆえ嘘はつきたくないですし、気を遣う作業の連続で、二人の貢献の偉大さを改めて感じました。一方、perldoc.jp に翻訳が反映されるまでの仕組みの理解は正直難しく、知らない方が多いのではないかと思いました。

ちょっとした一文の翻訳だけでも、技術コミュニティへの貢献になるにも関わらず、その貢献の敷居が高いのは課題だと思いました。

翻訳の敷居を下げるため、次を行いました。

  1. 翻訳のチュートリアルの刷新
    • 具体的には、翻訳データ置き場のmodule-pod-jp というGitHubリポジトリのREADMEを更新しました。(Thanks @bayashi)
    • 翻訳をしたい場合、このmodule-pod-jp を fork して PRを送るだけです。詳しくはREADMEを参照ください。
  2. 対訳表の追加
    • 初めて翻訳をするとき、例えば「void context」を何と訳すべきか戸惑うと思います。そういった問題を解決するために、対訳表を作成しました。 (Thanks @kfly8)
  3. 翻訳の作業ログの追加
    • 実際の作業イメージが湧くように作業ログも追加されました。(Thanks @bayashi)

2. Perlの学び方の現状に関するアンケートの実施

ワーキンググループの立ち上げ当初、どういった活動をするかブレストを行い、沢山のアイデアが見えましたが、的が絞り込めていませんでした。そこでアンケートを実施しました。

blog.perlassociation.org

アンケートの結果、次のアクションをすると良さそうだとわかりました。アンケートにご協力いただいた皆様ありがとうございました!

  1. リファレンス、コンテキストなど初学者がつまづきやすいトピックの入門コンテンツをまとめる
  2. 最近のPerl、今のベストプラクティスなどがわかるコンテンツをまとめる

3. 初学者がつまづきやすいトピックの入門コンテンツをまとめ始めた

アンケートの結果を踏まえ、初学者がつまづきやすいトピックの入門コンテンツを、スプレッドシートにまとめてみました。素朴な人力まとめですが、数を厳選できるので逆に良いのかなと思ってますが、どうでしょうか?実際に使っていただいて、ご意見など伺いたいです。もちろん他にもおすすめしたいコンテンツなどありましたら、教えてください*2

docs.google.com

4. 最近のPerlの事情がわかるコンテンツの翻訳を始めた

突然の宣伝「3月にYAPC::Kyoto 2023が開催されます!生き生きとした最近の開発の話ができます!YAPC::Kyotoにぜひご参加を!」

ワーキンググループでは、最近のPerlの事情を掴むために、PerlのRFCで受理されたものの翻訳を始めてみました*3。実際に公開したものは以下の通りです。

RFC以外にも、モジュールの翻訳も実施しました。*4

最後に

まだやったら良いことは山積みですが、少しずつでもこういった活動を継続して貢献できればと思っています。 今回の活動内容のご意見、ご感想などあれば、ぜひいただければと思います。

また、活動にご協力いただける方は、ぜひkfly8にお声かけください!私自身、この活動を通じて、知らなかったことに多く出会えて楽しいのでおすすめです👍

*1:開始の告知ブログはこちら。https://blog.perlassociation.org/entry/2022/07/21/103000

*2:掲載の確約ではございません。ご了承のほどよろしくお願いします。

*3:RFCの翻訳はこちらのissueで進行中です。https://github.com/jpa-perl/wg-perl-document/issues/7

*4:モジュールの翻訳については、こちらのissueで検討中です。https://github.com/jpa-perl/wg-perl-document/issues/17