ドキュメント翻訳から始めるOSS推し活

ドキュメント翻訳から始める OSS推し活 @unsoluble_sugar 2024/07/30 エンジニア達の「完全に理解した」Talk #55

自己紹介 @unsoluble_sugar Illustration by @ssm_a_u ➢ Unleashed Inc. / CTO ➢ Easy Easy / Organizer - PR ➢ Tech Hunter / Blogger, Engineer ➢ Tech Team Journal / Writer

Developer eXperience Day 2024 講演レポート Tech Team Journal をチェック！ https://ttj.paiza.jp

• https://ttj.paiza.jp/

OSS推し活、 してますか？ 「OSS推し活」とは OSSで推し活をすることです

この勉強会で推しソフトを紹介している者だ https://speakerdeck.com/unsoluble_sugar/vmagicmirror-completely-understood https://speakerdeck.com/unsoluble_sugar/rvc-with-vcclient-completely-understood

• https://speakerdeck.com/unsoluble_sugar/rvc-with-vcclient-completely-understood
• https://speakerdeck.com/unsoluble_sugar/vmagicmirror-completely-understood

2020年…おめシスのOSSホームページ企画に参加 https://qiita.com/unsoluble_sugar/items/120f0856d497ef96010e

• https://qiita.com/unsoluble_sugar/items/120f0856d497ef96010e

反省点 https://qiita.com/unsoluble_sugar/items/120f0856d497ef96010e

• https://qiita.com/unsoluble_sugar/items/120f0856d497ef96010e

最近の推し「Warudo」 https://warudo.app

• https://warudo.app

ソフトは日本語化済み ドキュメントの 日本語翻訳がない状態

リポジトリ公開されていたので現状確認 https://github.com/HakuyaLabs/warudo-docs/issues/13

• https://github.com/HakuyaLabs/warudo-docs/issues/13

リポジトリオーナー、Warudo開発者から返信 https://github.com/HakuyaLabs/warudo-docs/issues/13

• https://github.com/HakuyaLabs/warudo-docs/issues/13

やるぞ ドキュメント 翻訳

まずは コントリビューター 向けページの対応 機械翻訳の内容を修正

Metaの静的サイトジェネレーター「Docusaurus」 https://docusaurus.io/

• https://docusaurus.io/

環境構築 ➢ Node.js（LTS） yarnコマンドを使うよ ➢ GitHub Desktop もちろんコマンドや他GUIソフトでも良いよ ➢ VS Code 宗教戦争反対

作業の流れ ➢ リポジトリの fork & clone https://github.com/HakuyaLabs/warudo-docs/ ➢ 作業 branch 切る ➢ local 環境で起動&翻訳作業 yarn start:all ➢ commit 内容を push ➢ pull request 投げる ➢ 問題なければ merge & 反映 ページ下部に名前が載るよ

• https://github.com/HakuyaLabs/warudo-docs/

英語、中国語テキスト見ながら実際に画面操作して翻訳

日本語UIスクショ撮るよ！

連携アプリの日本語UIスクショも撮るよ！！

約100ページ あります ✌(’ω’✌ )三✌(’ω’)✌三( ✌’ω’)✌ 情報量の多いページは１万字超え

３割くらい対応完了。Zennに経過記録 https://zenn.dev/unsoluble_sugar/scraps/94ef02ee3bc0d7

• https://zenn.dev/unsoluble_sugar/scraps/94ef02ee3bc0d7

ドキュメントから完全に理解していくぞ

～issue例～ 日本語検索の問題 カタカナ検索ができない！？ （絶望） https://github.com/HakuyaLabs/warudo-docs/issues/26

• https://github.com/HakuyaLabs/warudo-docs/issues/26

当初採用されていた検索プラグインの仕様 ●

Algolia DocSearchへ移行して解決

～issue例～ プロトコル名称について 混乱を招く表記の修正 https://x.com/ElvCatDev/status/1665261111338471424 https://github.com/HakuyaLabs/warudo-docs/pull/53

• https://x.com/ElvCatDev/status/1665261111338471424
• https://github.com/HakuyaLabs/warudo-docs/pull/53

～issue例～ リンク切れ修正 誤字脱字 typo 小さなcommitも貢献のうち https://github.com/HakuyaLabs/warudo-docs/pull/58

• https://github.com/HakuyaLabs/warudo-docs/pull/58

OSSによる貢献 【開発者】 助かる 【VTuber】 輝く 【リスナー】 輝く推しが見られる 【ワイ】 知見を得られる 開発者に喜んでもらえる 推しソフトのユーザーが増えていく様子を楽しめる VTuber&リスナーの楽しげな姿が見られる 色んなクリエイターに出会える 全人類 Happy!