日本語ドキュメンテーション Codex の移行をお手伝いしてくれる方を募集します

長年親しまれてきた WordPress の日本語ドキュメンテーション (マニュアル) 「Codex」を WordPress.org 内に移行します。

これはオリジナルの英語版の動きに従ったもので、すでに英語版では開発者向けページが DevHub に、一般ユーザー向けページが HelpHub と呼ばれるシステムにそれぞれ移行されています。今回、日本語版ではまず一般ユーザー向けページを移行し、完了後に開発者向けページの移行を検討する予定です (このためすぐに Codex がなくなるわけではありません)。

移行作業のお手伝いを募集します

英語版の移行作業では手動で Codex 内のページを HelpHub に移行しました。Codex には古い記事や誤った記述も含まれていたため、一つずつ確認しながら作業する必要がありました。ちなみに「Codex」は wiki ベースで書かれていましたが、WordPress.org では通常の WordPress の記事と同じようにブロックエディタ (Gutenberg) を使用して記述します。

現在約200ページの原文がありますが、日本語版でも同様にこれらを手作業で移行する予定です。その過程で翻訳のエラーや、英文が更新されている場合は追加の翻訳を行います。スクリーンショットを取り直す必要のある箇所もあります。

こうした作業をお手伝いしてくれる方を募集します。

「手伝ってもいいよ」という方は以下の手順に従って、サイトへのアクセス権を取得し、好きなページを移行してください。ページ全部でも構いませんし、一部でも構いません。

移行のポリシー

日本語 HelpHub は日本語 Codex を元に、英語 HelpHub の最新情報で更新します。英語版は Codex から HelpHub 移行の際に、プログラミング的な要素をすべて削除しました。これは HelpHub が一般ユーザー向けであること、プログラミング的な要素は他のハンドブックでカバーされることからの決定です。

一方日本語版の場合、ハンドブックの翻訳 (例えば Theme Developer Handbook) が後になり、今日の段階で使用法のみをコピーすると日本語のせっかくの情報が消えてしまいます。ですので、いったん関数などのプログラミング的な要素も含めて移行したいと思います。

移行の手順

まずサイトへのアクセス権が必要です。

  1. WordPress.org のアカウントを作成する (https://login.wordpress.org/register)
  2. HelpHub のアクセス権をリクエストする
    • 手順: WordSlack (参加方法はこちら) の #docs チャンネルに行って、WordPress.org アカウント名と一緒に「アクセス権希望」とリクエストしてください。

移行作業は以下のとおりです。

  1. HelpHub サイトにログインする。
  2. 進捗確認用のワークシートを開く。
  3. 移行するページを選択し、「担当」に自分の名前を入力し、「ステータス」を「In Process」にする。
  4. 「元の日本語 Codex ページ」列の URL の上にマウスを移動し、ポップアップしたリンクをクリックする。
  5. 「日本語 HelpHub ページ」列の URL の上にマウスを移動し、ポップアップしたリンクをクリックする。
  6. ツールバーの「編集 記事」をクリックする。
  7. 適宜、Codex からコピー & ペーストするか、必要に応じて翻訳する。
  8. 完了後はドラフト文書のまま保存し、「ステータス」を「Done」にする。

今後の進め方

ある程度量があるので、挫折しないように以下のような試みを考えています。

  • 定期的に (頻度は未定、2週に1度程度 ?)、参加可能な作業者の方が集まって Zoom で質問したり作業したりする会を開催する。
  • 週1回、このブログに進捗報告スレッドを立て、コメントで報告してもらう。

質問があれば、WordSlack の #docs でお尋ねください。
ご協力ありがとうございます!

#codex