WordPressドキュメントがサポート内に移動中

2018年12月2日、WordPress.org のサポートページが更新されました。

まだ更新が反映されていない日本語版ページを見ると分かるようにカテゴリー別フォーラムへの入り口だったものが、対応するドキュメントの入り口へと変更され、クリックしたジャンプ先も Codex 内のページではなく、サイト内のデザインに準じたページとなりました。

大々的な宣伝はまだですが、WordCamp US の State of the Word で Matt が触れる事になっています(*1)。

HelpHub とその狙い

これは現在も進行中の Codex 移行プロジェクト「HelpHub」の一環です。すでに Codex 内の開発者向けコンテンツは「DevHub」として移行済みですが、今回の「HelpHub」で、ユーザー向けコンテンツが移行されます。

2015年のプロジェクト開始以来、何度も頓挫しリーダーも3回変わった末、現在のリーダー Jon Ang がチームごと立て直し、docs team、support team、そしてサイト制作、運営担当の meta team と協業し、ようやっと日の目を見ました。私はコンテンツ移行のリーダーを務めましたが、日本からは他に wp-cli をプロジェクト用に拡張してくれた宮内さんや、meta team と交渉してくれた西川さん、清野さんが参加しました。

ユーザー向けドキュメントがこの位置にある事を不思議に思うかもしれません。これには単体で通して読むことを意識した「ユーザーガイド」としての性格よりも、「何か困ったことが起きた場合、フォーラムで尋ねる前に、まず自己解決する手段を提供する」という、サポートの一環としての目的があります(*2)。

これまでのサポートページにも Codex へのリンクはありましたが、有機的なつながりはなく、使用もユーザーの自己努力に委ねられていました。今回これを変更し、フォーラムで尋ねる前に回答がすぐに見つけられるよう配置や見出しも含め変更されました(なおページの末尾には従来のフォーラムへのリンクも残っています)。

コンテンツはアクセス数の多い上位 115 文書を「Phase 1」として移行しました。移行にあたっては、古いバージョンへの言及や誤った文章は修正し、リンクを再作成、画像を置換したため、多少は読みやすくなったのではないかと思います(*3)。

また内部は Gutenberg でブロック化しました。ベータユーザも兼ねてのツール選択でしたが、Codex から Cut & Paste 一発でブロック化して貼り付ける機能は強力で時間短縮に大きく寄与しました。将来的にはこのブロック単位でユーザーコメントの反映が行われる予定です(*4)。

ドキュメントの翻訳サイトについて

こちらも議論はすでに始まっています。

まだ計画の詳細までは見えず、スケジュールも不明ですが、コア内の文字列だけでなく、ユーザーが作ったテーマやプラグインに含まれるすべての文字列を 180 ロケール分翻訳できるシステムを作り上げた力と熱量のある meta team です。あっという間になんとかなるのかもしれません(*5)。

Codex 日本語版はもうしばらく現役です。オリジナルがガタついていて、なかなか翻訳しづらい状況ですし、私も正直手薄なのですが、少しずつでも進めていければと思います。

今後の課題

認識している課題を挙げます。早めに解決したいところです。

1. 各ページの最終変更日の出力

これは HelpHub だけでなく、他のハンドブックも同様ですが、現状ではいつ更新されたのかが分かりません。

2. ページの差分出力

これも 1. と同様です。実際には、編集権限がある人は管理画面でリビジョンの比較ができますが、ここは Codex 同様、誰でも比較が見られるべきと考えます。

3. インラインドキュメント

開発者向けの話ですが、現在 Code Reference 等は、関数やクラスの先頭部にコメントとして書かれた説明から自動生成されています(*6)。まだ多くのクラス類の説明が不足しています。

以上、いろいろと述べてきましたが、docs team ではまだまだ作業があり、協力者は常に募集しています。幸いにしてチーム内は協力的でよいムードですので是非、#docs の Slack チャネルを覗きに来て、気に入れば仲間に加わってください。お待ちしています。

以下、有料会員向けの、少しだけ闇を含んだ脚注です。