Experience League のドキュメント修正依頼方法

はじめまして、アドビ株式会社で Software Quality Engineer をやっています@RyutaTakeuchiです。主に Adobe Experience Cloud 製品の機能テストや翻訳改善等を担当しております。
今回は是非活用して頂きたい機能があり、記事を書くこととしました。

はじめに

アドビ製品をご利用頂いている方の中には、オンラインドキュメントをご覧になる方も多いかと思います。膨大なドキュメントに目を通していて、以下のように感じたことはないでしょうか。

• エラーがあるので修正して欲しい
• ドキュメントとして追加して欲しい内容がある
• 探している情報が見つからない
• 翻訳ページのフィードバックをして、翻訳品質の向上に貢献したい

あまり知られていないのですが、実は Experience Cloud 及びその他エンタープライズ製品のドキュメントには、このような問題報告や提案を簡単にできる機能が実装されています。

また、機能は知っているという方の中にも「実際に使うとどうなるのか分からず不安・・・」という方や「英語で書くのは面倒！」という方もいらっしゃるかと思いますので、実際にチケットを作成しながら解説していきたいと思います。

リクエストは 日本語 であげることができます。
日本語のページ以外のリクエストに関しても 日本語 で OK です。
また、返信や質問も日本語ですのでご安心ください。

Log an issue 機能

上述した問題を解消してくれるのが　「Log an issue / 問題を記録」　機能です。ドキュメントエラーの報告やコンテンツの追加依頼等を行うことができます。
ドキュメント右側にあるアイコン (下図参照) からご利用いただくことができ、アドビのオーサリングチームに通知が届く仕組みになっています。

現状ではシステム上、ロケールに特化したコンテンツを作成することはできないので、例えば「日本語のページにだけ独自で何かを追加する」といったことはできません。

こちらは記事執筆時点の機能であり、今後仕様が変わっていく可能性もありますのでご注意ください。

実際の流れ

それでは、実際に試してみましょう。
今回は自動翻訳のページで翻訳エラーを見つけたので、こちらの修正リクエストを日本語であげてみます。

「Commerce 用のクラウドガイド」 が正しいと思われますが、「用のクラウドガイド Commerce」 となってしまっています。念のため、自動翻訳をオフにしてオリジナル (英語) のページを見ると 「Cloud guide for Commerce」 と書かれていますので、やはり翻訳エラーであることが確認できました。

1. ページ右の「問題を記録」ボタンをクリック
   

2. Github にサインイン or アカウントの作成
   サインインしていない場合は以下の画面が表示されるので、アカウントがある場合はサインインをします。 (Github の UI は現状日本語化に対応していないようですが、数ステップでチケット作成まで完了するので、是非このまま手順を進めてみてください。)
   
   無い場合は作成する必要がありますので、「Create an account」 をクリックして、指示に従いメール・パスワード・ユーザー名と製品アップデートやアナウンスを受け取るかどうか ("y" or "n") を入力します。
   
   「Continue」をクリックすると認証用コードが送信されるので、以下の画面にて入力して作成完了です。
   

3. チケットの作成
   サインインした状態で 「問題を記録」 をクリックすると以下のような画面が表示されます。
   
   先頭行の Issue in ./help/videos/cloud/1-overview.md はどこのページに問題があるかを意味しています。こちらは自動的に入力されているのでこのままにしておきましょう。
   タイトルには簡単に「翻訳エラー」とだけ入力し、問題のあった文字列と修正案を記載しました。
   もし複数のチケットを作成する場合は、「翻訳エラー Cloud guide for Commerce」などとしておいた方が、通知や質問が来た場合に分かりやすくなるかと思います。
   「Submit new issue」 をクリックすると、以下のようにチケットが作成されます。
   
   画面右上の Assignees に担当者が既に割り当てられている事がわかります。
   後は対応を待つのみです。

4. 担当者の対応とチケットクローズ
   今回は起票してから数時間ほどで、調査を開始した旨の通知が届きました。
   
   もし質問が来た場合は、なるべく 1 週間以内に返信するようお願いしております。問題なく対応が完了した場合は、以下のようにクローズされた旨の通知が届きます。
   
   実際に修正されたページを確認してみると、以下のように修正が反映されていました。
   正しい翻訳として 「Commerce 用のクラウドガイド」 を提案していましたが、レビューの結果より良い翻訳があったようで、「Commerce 向けのクラウドガイド」 となっています。
   

今回は「正しい翻訳」と「原文」も記載しましたが、不明な場合や面倒な場合は問題点を記載していただくだけで大丈夫です。チーム内でレビューを行い、適切にハンドリングされます。

Github 上ではすべてのチケットは公開されています。
個人情報や内部情報は記載しないようにご注意ください。

最後に

いかがでしたでしょうか。想像以上に簡単にリクエストをあげられたことと思います。
今回のようなエラーのほか、ドキュメントに関するあらゆるフィードバックを是非アドビまでお知らせください。

最後までご覧いただきありがとうございました。