Documente seu destino no Adobe Experience Platform

Visão geral

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

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

• Instruções passo a passo para criar uma página de documentação para seu novo destino;
• Um modelo a ser preenchido para o destino;
• Instruções gerais sobre como usar o Markdown;
• Instruções específicas para o aroma de Adobe Markdown (o sabor Adobe Markdown é muito semelhante ao Markdown normal).
• A página práticas recomendadas para ajudar você a criar uma página de documentação para a página de destino, que atende aos padrões de qualidade da documentação do Experience Platform.

Pré-requisitos

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

• Uma conta do GitHub. Inscreva-se para GitHub se você ainda não tiver uma conta.
• Desktop do GitHub. Se você selecionar crie a documentação no ambiente local, você deve usar Desktop do GitHub.
• 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 documentação para seu destino no Adobe Experience Platform

Em um alto nível, para criar documentação para o seu destino, é necessário criar uma bifurcação do repositório da 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, em Etapas para criar a nova página de destino.

Modelo de documentação

Para ajudar você a criar a página de documentação, o Adobe pré-preencheu um modelo de documentação para você. Além disso, 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 verificará e publicará a documentação do novo destino.

Baixe o modelo aqui e descompacte o arquivo para extrair a variável 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 a nova página de destino

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

• Usar a interface da Web do GitHub para criar uma página de documentação de destino
• Usar um editor de texto no ambiente local para criar uma página de documentação de destino

Práticas recomendadas

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 seção orientação 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.