宛先をAdobe Experience Platformに文書化します
概要 overview
Adobe Experience Platformへようこそ、ここにあなたがいらっしゃって嬉しいです!
宛先を文書化することは、Adobe Experience Platformでライブ設定する前の最後の手順です。
このドキュメントセクションには、以下が含まれます。
- 新しい宛先のドキュメントページを作成するための手順ごとの手順
- あなたの目的地のために記入するためのテンプレート。
- Markdownの使用に関する一般的な手順
- Adobe Markdown フレーバーに関する具体的な手順 (Adobe Markdown フレーバーは通常のMarkdownとよく似ています)。
- 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 ドキュメントの書き込みガイダンス を参照してください。