Adobe Experience Platform の宛先のドキュメント化
概要 overview
Adobe Experience Platformへようこそ、ここに来てくれて嬉しい！
宛先のドキュメント化は、Adobe Experience Platformでライブに設定する前の最後の手順です。
このドキュメントの節には、以下が含まれます。
- 新しい宛先のドキュメントページを作成する手順を説明します。
- 宛先に入力するためのテンプレート。
- Markdown の使用に関する一般的な手順;
- Markdown のフレーバーAdobeに関する具体的な説明 (Adobeの Markdown の風味は、通常の Markdown と非常に似ています )。
- A ベストプラクティスページ を使用すると、宛先ページのドキュメントページを作成し、Experience Platformドキュメントの品質基準を満たすのに役立ちます。
前提条件 prerequisites
この記事の手順に従って宛先のドキュメントを作成するには、次の項目が必要です。
- GitHub アカウント. 新規登録 GitHub まだアカウントをお持ちでない場合は、をクリックします。
- GitHub Desktop. 次を選択した場合： ローカル環境でドキュメントを作成します。を使用する場合、 GitHub Desktop.
- Adobeとの統合は、Adobe Experience Platformのステージング環境にデプロイされた宛先とのテストフェーズにある必要があります。
Adobe Experience Platformで宛先のドキュメントを作成する手順の概要 high-level-instructions
宛先のドキュメントを作成するには、概要レベルで、次の手順を実行する必要があります。 分岐を作成する Adobe Experience Platformドキュメントリポジトリの 提供されたドキュメントテンプレート 新しい分岐に Adobeが提供するテンプレートを使用して、新しい宛先ページを作成します。 準備が整ったら、プルリクエスト (PR) を開きます。 これをおこなう手順は、以下で説明します。 新しい宛先ページを作成する手順.
ドキュメントテンプレート documentation-template
ドキュメントページの作成を支援するために、Adobeは、 ドキュメントテンプレート あなたのために。 以下では、テンプレートを編集し、プル要求を開く方法について説明します。 Adobeドキュメントチームが、新しい宛先のドキュメントを確認して公開します。
ここでテンプレートをダウンロード を展開し、抽出するファイルを解凍します。 yourdestination.md ファイル。
テンプレートを使用してドキュメントページを作成する手順は、以下のとおりです。
新しい宛先ページを作成する手順 steps-to-create-docs-page
GitHub Web インターフェイスまたはローカル環境を使用して、Adobe Experience Platformでの新しい宛先に関するドキュメントを作成できます。 両方のオプションの手順については、次のリンクを参照してください。
ベストプラクティス best-practices
以下を確認します。 オーサリングのベストプラクティス 宛先ドキュメントページを作成する前と間に 必ず Adobe・ドキュメントの記述ガイダンス ドキュメントのオーサリング時にAdobeドキュメントチームが使用する、その他の記述に関するヒント