Documentar seu destino no Adobe Experience Platform

IMPORTANT
O processo documentado aqui só é necessário para parceiros que enviam destinos (públicos) produzidos. Se você estiver criando um destino privado para uso próprio, não será necessário criar e publicar a documentação do para seu destino.

Visão geral overview

Bem-vindo ao Adobe Experience Platform, é ótimo ter você aqui!
A documentação do destino é a etapa final antes de poder ser definido online no Adobe Experience Platform.

Esta seção de documentação inclui:

Pré-requisitos prerequisites

Para criar a documentação do seu destino de acordo com as instruções neste artigo, os seguintes itens são necessários:

  • Uma conta do GitHub. Inscrever-se para GitHub se você ainda não tiver uma conta.
  • GitHub Desktop. Se você optar por criar a documentação no seu ambiente local, você deve usar GitHub Desktop.
  • Sua integração com o Adobe deve estar em uma fase de teste, com seu destino implantado em um ambiente de preparo no Adobe Experience Platform.

Instruções de alto nível para criar a documentação para seu destino no Adobe Experience Platform high-level-instructions

Em um alto nível, para criar a documentação do para seu destino, é necessário criar um fork do repositório de documentação do Adobe Experience Platform e edite o modelo de documentação fornecido em uma nova ramificação. Use o modelo fornecido pelo Adobe para criar uma nova página de destino. Abra uma solicitação de pull (PR) quando estiver pronto. As instruções para fazer isso estão mais abaixo, na Etapas para criar sua nova página de destino.

Modelo de documentação documentation-template

Para ajudá-lo a criar a página de documentação, o Adobe preencheu previamente uma modelo de documentação para você. Mais abaixo, você pode encontrar instruções sobre como editar o modelo e abrir uma solicitação de pull. A equipe de documentação do Adobe revisará e publicará a documentação para o novo destino.

Baixe o modelo aqui e descompacte o arquivo para extrair o yourdestination.md arquivo.

As instruções sobre como usar o modelo para criar sua página de documentação estão mais abaixo.

Etapas para criar sua nova página de destino steps-to-create-docs-page

Você pode usar a interface da Web do GitHub ou seu ambiente local para criar a documentação para seu novo destino no Adobe Experience Platform. Encontre instruções para ambas as opções nos links abaixo:

Práticas recomendadas best-practices

Revise o práticas recomendadas de criação antes e enquanto você cria a página de documentação de destino. Leia também a orientações de escrita para a documentação do Adobe para obter mais dicas de escrita que a equipe de documentação do Adobe usa ao criar a documentação.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6