Adobe Experience Platform の宛先のドキュメント化
概要 overview
Adobe Experience Platformへようこそ、ここにあなたがいることを嬉しく思います!
宛先のドキュメント化は、Adobe Experience Platformでライブに設定する前の最後の手順です。
このドキュメントの節では、次の内容について説明します。
- 新しい宛先のドキュメントページを作成するためのステップバイステップの手順。
- 宛先に入力するためのテンプレート。
- Markdown の使用に関する一般的な説明
- Adobeマークダウンフレーバーの具体的な手順(Adobeマークダウンフレーバーは、通常のマークダウンと非常によく似ています)。
- Experience Platformドキュメント品質基準を満たす宛先ページのドキュメントページを作成するのに役立つ ベストプラクティスページ。
前提条件 prerequisites
この記事の手順に従って宛先のドキュメントを作成するには、次の項目が必要です。
- GitHub アカウント。 まだアカウントをお持ちでない場合は、GitHub に新規登録してください。
- GitHub デスクトップ。 ローカル環境でドキュメントを作成するを選択した場合は、GitHub デスクトップを使用する必要があります。
- 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ドキュメントのライティングガイダンスも必ずお読みください。