ソースのドキュメント化

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

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

前提条件

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

  • 有効な GitHub ユーザーアカウント:既存の GitHub アカウントがない場合は、GitHub サインアップ ページから作成する必要があります。
  • GitHub デスクトップへのアクセス:ローカル環境でソースドキュメントを作成するには、GitHub デスクトップアプリを使用する必要があります。
  • Adobeとの統合は、Platform のステージング環境にソースをデプロイして、テスト段階にある必要があります。

Platform でソースのドキュメントを作成するための高度な手順

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

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

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

以下のドキュメントテンプレートもダウンロードできます。

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

GitHub web インターフェイスまたはローカル環境を使用して、Platform の新しいソース用のドキュメントを作成できます。 以下のリンクに、両方のオプションの手順が記載されています。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089