Documentar seu destino no Adobe Experience Platform
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:
- Instruções passo a passo para que você crie uma página de documentação para seu novo destino;
- Um modelo para você preencher para o seu destino;
- Instruções gerais sobre o uso do Markdown;
- Instruções específicas para o tipo de Markdown do Adobe (o tipo de Markdown do Adobe é muito semelhante ao Markdown comum).
- Uma página de práticas recomendadas para ajudá-lo a criar uma página de documentação para sua página de destino, que atenda aos padrões de qualidade da documentação do Experience Platform.
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. Cadastre-se no GitHub se ainda não tiver uma conta.
- GitHub Desktop. Se você optar por criar a documentação em seu ambiente local, deverá usar o 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 para o seu destino, você precisa criar uma bifurcação do repositório da documentação do Adobe Experience Platform e editar 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 sua nova página de destino.
Modelo de documentação documentation-template
Para ajudá-lo a criar sua página de documentação, o Adobe preencheu previamente um 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 arquivo yourdestination.md.
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 as práticas recomendadas de criação antes e enquanto cria a página de documentação de destino. Leia também as orientações de escrita da Documentação do Adobe para obter mais dicas de escrita que a equipe de documentação do Adobe usa ao criar a documentação.