ソースをドキュメント化

Adobe Experience Platformで新しいソースをライブに設定する前の最後の手順は、新しいソースをドキュメント化することです。

このドキュメントガイドには、以下が含まれます。

前提条件

新しいソースのドキュメント化を開始する前に、次の項目が必要です。

  • 有効な GitHub ユーザーアカウント:既存の GitHub アカウントを持っていない場合、 GitHub の新規登録ページ;
  • GitHub Desktop へのアクセス:次を使用する必要があります。 GitHub Desktop アプリ ローカル環境でソースドキュメントを作成する場合。
  • Adobeとの統合は、Platform のステージング環境にデプロイされたソースとのテストフェーズにある必要があります。

Platform でソースに関するドキュメントを作成するための概要手順

ソースのドキュメントを作成するには、Platform ドキュメントリポジトリのフォークを作成し、提供されたドキュメントテンプレートを新しいブランチで編集する必要があります。 Adobeが提供するテンプレートを使用して、新しいソースページを作成し、準備が整ったらプルリクエスト (PR) を開きます。 これをおこなう手順は、新しいソースページを作成する手順で詳しく説明します。

ドキュメントテンプレート

事前入力された ドキュメントテンプレート を使用して、ソースのドキュメントを作成できます。 以下では、テンプレートの編集方法とプル要求の開き方について説明します。 新しいソース用に送信されたドキュメントは、Adobeドキュメントチームがレビューおよび公開します。

また、以下のドキュメントテンプレートをダウンロードすることもできます。

新しいソースページを作成します

GitHub Web インターフェイスまたはローカル環境を使用して、Platform での新しいソースに関するドキュメントを作成できます。 両方のオプションの手順については、次のリンクを参照してください。

このページ