ソースのドキュメント化
新しいソースをAdobe Experience Platformで公開する前の最後の手順は、新しいソースを文書化することです。
このドキュメントガイドには、次の内容が含まれます。
- 新しいソースのドキュメントページを作成するためのチュートリアル。
- 新しいソースに入力するためのドキュメントテンプレート。
- テクニカルドキュメントの作成にMarkdownを使用する方法に関する説明;
- Adobe Markdownのフレーバーを理解するための手順。
前提条件
新しいソースの文書化を開始するには、次の項目が必要です。
- 有効なGitHub ユーザーアカウント:既存のGitHub アカウントがない場合は、GitHubのサインアップページ からアカウントを作成する必要があります。
- GitHub Desktopへのアクセス:ローカル環境でソースドキュメントを作成するには、GitHub Desktop アプリ を使用する必要があります。
- Adobeとの統合は、Experience Platformのステージング環境にソースをデプロイしてテスト段階にある必要があります。
Experience Platformでソースのドキュメントを作成する手順
大まかに言えば、ソースのドキュメントを作成するには、Experience Platform ドキュメントリポジトリの分岐を作成し、提供されたドキュメントテンプレートを新しいブランチで編集する必要があります。 Adobeが提供するテンプレートを使用して新しいソースページを作成し、準備ができたらプルリクエスト(PR)を開きます。 新しいソースページを作成する手順については、次の手順を参照してください。
ドキュメントテンプレート
事前入力された ドキュメントテンプレート を使用して、ソースのドキュメント作成を支援できます。 以下では、テンプレートを編集してプルリクエストを開く方法に関する手順を説明します。 新しいソース用に送信されたドキュメントは、Adobe ドキュメントチームによってレビューされ、公開されます。
以下のドキュメントテンプレートをダウンロードすることもできます。
新しいソースページを作成します
GitHub web インターフェイスまたはローカル環境を使用して、Experience Platformで新しいソースのドキュメントを作成できます。 両方のオプションの手順については、以下のリンクを参照してください。
recommendation-more-help
experience-platform-help-sources