アドビドキュメントのコントリビューターガイド
このガイドでは、Experience League に関するアドビの法人向けヘルプに投稿する方法を説明します。
コラボレーティブドキュメントとは?
Adobe Experience Cloud やその他のアドビエンタープライズ製品の技術ドキュメントや実施可能性コンテンツは、GitHub、Markdown、Adobe Experience Cloud の各ソリューションを利用するオープンソースの原則に基づいています。
このオープンソースモデルにより、コンテンツの品質、および顧客やドキュメントチーム、製品チーム間のコミュニケーションが向上します。すべてのページで、コンテンツの有用性、問題のログ、および Git プルリクエスト(PR)としてコンテンツの提案事項をコントリビューションできるようになりました。アドビのドキュメントチームは、毎日のコントリビューションと問題を監視し、必要に応じて更新および調整をおこないます。
共同作業ドキュメントの操作
従業員、パートナー、顧客、または潜在顧客にかかわらず、この資料の利用者には、このドキュメントに投稿できる簡単な方法がいくつかあります。
- ページの有用性を評価し❶、オプションのコメントを書きます❷
- 特定のページに関する問題を報告します (Git ログインが必要です) ❸
- アセットやコードのサンプルを使用し、クイック編集を送信して記事全体をオーサリングできます(Git ログインが必要です)❹
これらのオプションは、ページを開いて数秒後にページの下部に表示されます。 フィードバック領域を閉じても、ページをリロードして元に戻すことができます。
このガイドでは、操作や、この資料セットにコントリビューションする際に必要なすべての事柄について説明します。
ページの有用性を評価し、コメントを書きます
ページを開いて数秒後に、フィードバック領域がページの下部に表示されます。 上または下をクリックして、ページが役に立ったかどうかを示します。
遠慮なくコメントを残して、追加のフィードバックを提供してください。
既存ドキュメントのクイック編集
より詳細なフィードバックを提供したい場合は、クイック編集を使用するとドキュメント内の小さなエラーや欠落を修正できます。 編集を提案するときには、修正または提案をアドビに提出するためのプルリクエスト(PR)を送信します。その提案をアドビが検証して承認し、公開します。
-
同意できる場合はコントリビューター使用許諾契約(CLA)に署名します。
アドビの CLA は 1 回提出すれば済みます。
-
記事の下部に表示されるフィードバック領域で、詳細なフィードバックオプション をクリックしてから、編集を提案 をクリックして、GitHub の Markdown ソースファイルに移動します。
-
鉛筆アイコンをクリックして記事を編集します。
note note NOTE 鉛筆アイコンがグレー表示になっている場合は、GitHub アカウントにログインするか、新しいアカウントを作成する必要があります。 -
Web エディターで変更を加えます。
「Preview changes」タブをクリックすると、変更部分の書式を確認できます。
-
変更を加えたら、ページの下部までスクロールします。
PR のタイトルと説明を入力し、「ファイルの変更を提案」をクリックします(下図を参照)。
note note NOTE コントリビューター使用許諾契約(CLA)への署名に関する検証エラーメッセージが表示されたら、「詳細」をクリックしてライセンス契約書を開きます。同意できる場合は、契約に署名します。次に、プルリクエストを閉じてから開いて続行します。
必要な操作は以上です。いただいたプルリクエストは、ドキュメントチームメンバーがレビューして結合します。ご協力ありがとうございます。
問題を報告
コンテンツの一部に関する問題を容易に指摘するもう一つの方法は、問題を報告 を使用することです。
-
記事の下部に表示されるフィードバック領域で、詳細なフィードバックオプション をクリックしてから、問題を報告 をクリックして、GitHub の Markdown ソースファイルに移動します。
note note NOTE 問題を報告するには、GitHub アカウントにログインするか、アカウントを作成する必要があります。 このリンクをクリックすると、GitHub Issue インターフェイスを使用して、Experience League でクイックチケットを登録できます。
問題を含むページの URL が説明フィールドに自動的に挿入されます。
-
タイトルを入力し、イシューの簡単な説明を書いてから、「新しいイシューを送信」をクリックします。
イシューを送信すると、このページのコンテンツチームに通知が送られます。このチームはイシューを解決できます。担当チームがコンテンツを更新すると、GitHub Issues インターフェイス上で登録者に通知されます。問題に進展があるか、問題がクローズされると、電子メールで通知されます。
GitHub の権限について
GitHub の編集 UI は、利用者のリポジトリ権限に応じて変化します。前掲の画像は、ターゲットリポジトリへの書き込み権限を持たないコントリビューターに表示されるものです。GitHub は自動的に利用者のアカウント内にターゲットリポジトリのフォークを作成します。利用者がターゲットリポジトリへの書き込み権限を持っている場合は、GitHub はターゲットリポジトリ内に新しいブランチを作成します。
アドビはすべての変更でプルリクエストを使用します。書き込み権限を持つコントリビューターによる変更でも同様です。ほとんどのリポジトリには保護されたmain
ブランチがあり、アップデートはプルリクエストとして送信される必要があります。
ブラウザー内編集の機能は、小さな変更や頻繁でない変更に適しています。大きな変更を加える場合や、高度な Git 機能を使用する場合は、リポジトリをフォークしてローカルで作業することをお勧めします。
フィードバックの提供
アドビのソリューションセットのように大規模なものになると、ドキュメントは常に作業中になります。エラーを見つけた場合はログに記録し、提案がある場合はアドビまでお知らせください。どのような情報を探しているか、ご意見をお聞かせください。必要な情報が見つからない場合は、その旨をお知らせください。タスクをうまく完了できない場合は、どこがわからないかをご指摘ください。
共同作業ドキュメントの担当チームと Experience League のすべてのライターおよびコンテンツ製作者を代表して、皆様のご協力に感謝を申し上げます。