Visão geral do guia do colaborador para a documentação da Adobe

O que é a Documentação colaborativa

A documentação técnica e o conteúdo de ativação da Adobe Experience Cloud e outros produtos Adobe Enterprise passaram para uma nova plataforma. Essa nova plataforma é baseada em princípios de código aberto que utilizam as soluções Github, Markdown e Adobe Experience Cloud.

Este modelo de código aberto melhora a qualidade do conteúdo e a comunicação entre clientes, equipes de documentação e equipes de produtos. Em todas as páginas, agora você pode classificar a utilidade do conteúdo, registrar problemas e até mesmo contribuir com sugestões de conteúdo como solicitações de Git (PRs). As equipes de documentação da Adobe monitoram as contribuições e os problemas diariamente, além de fazerem atualizações e ajustes, conforme necessário.

Trabalhar com documentação colaborativa

Como usuário desse material, independentemente de se você for um funcionário, parceiro, cliente ou até mesmo um cliente potencial, você tem a opção de contribuir para essa documentação de várias maneiras simples:

  • classificar o nível de ajuda da página
  • registrar um problema em relação a uma página específica
  • enviar uma edição rápida para a criação de artigos inteiros, completa com ativos e amostras de código

Este guia descreve tudo o que você precisa saber para interagir e contribuir com esse conjunto de materiais.

Faça edições rápidas nos documentos existentes

Fazer edições rápidas é uma boa maneira de corrigir pequenos erros e omissões nos documentos. Se um artigo exibir um botão Edit (Editar) como mostrado abaixo, você poderá fazer uma correção rápida. Ao editar o documento, você envia uma solicitação de pull (PR) para enviar a correção/sugestão para nós e poderemos vetar, aprovar e publicar a sugestão.

  1. Assine o Contrato de licença de colaborador (CLA) se for aceitável.

    É necessário enviar somente um CLA da Adobe uma vez.

  2. Clique no ícone Edit this page na coluna à direita para ir para o arquivo de origem do Markdown no GitHub.

    Editar este ícone de página

  3. Clique no ícone de lápis para editar o artigo.

    OBSERVAÇÃO

    Se o ícone de lápis estiver esmaecido, será necessário fazer logon na sua conta GitHub ou criar uma nova conta.

    Localização do ícone de lápis

  4. Faça as alterações no editor da web. Você pode clicar na guia Preview changes (Visualizar alterações) para verificar a formatação da alteração.

  5. Depois de fazer as alterações, navegue até a parte inferior da página. Insira um título e uma descrição para a sua PR e clique em Propose file change (Propor alteração de arquivo), conforme mostrado na figura a seguir:

    como propor sua alteração

    OBSERVAÇÃO

    Se você receber uma mensagem de erro de validação em relação à assinatura de um Contrato de licença de colaborador (CLA), clique em Detalhes para abrir o contrato de licença. Assine o contrato, se for aceitável. Em seguida, feche e abra a solicitação de extração e prossiga.

Isso é tudo. Obrigado! Os membros da equipe de documentação analisarão e mesclarão sua solicitação de pull.

Registrar um problema

Outra maneira fácil de nos informar sobre um problema de conteúdo é usar a opção “Log an Issue” (Registrar um problema).

  1. Se você perceber um problema com um conteúdo, clique no ícone Log an Issue no canto inferior direito na coluna à direita.

    OBSERVAÇÃO

    Você precisará fazer logon na sua conta GitHub ou criar uma nova conta para registrar um problema.

    Clicar neste link permitirá registrar um tíquete rápido conosco, usando a interface do GitHub Issue.

  2. A URL da página com o problema será preenchida automaticamente no campo de descrição. Preencha o título, escreva uma breve descrição do problema e clique em Submit new issue (Enviar novo problema).

O envio de um problema notificará diretamente a equipe de conteúdo da página que poderá tomar uma ação. Quando atualizarmos o conteúdo, você será informado na interface do GitHub Issues e notificado por e-mail quando o problema for atualizado ou encerrado.

Compreender as permissões do GitHub

A interface de edição do GitHub se adapta às suas permissões de repositório. As imagens acima são precisas para os colaboradores que não têm permissões de gravação no repositório de destino. O GitHub cria automaticamente uma bifurcação do repositório de destino na sua conta. Se você tiver acesso de gravação no repositório de destino, o GitHub criará uma nova ramificação nele.

A Adobe usa solicitações de pull para todas as alterações, mesmo para colaboradores com acesso de gravação. A maioria dos repositórios protegem a ramificação master para que as atualizações sejam enviadas como solicitações de pull.

A experiência de edição no navegador é melhor para pequenas alterações ou alterações pouco frequentes. Se você fizer grandes contribuições ou usar recursos avançados do Git, recomendamos bifurcar o repositório e trabalhar localmente.

Fornecer feedback

Com um conjunto de soluções tão grande quanto o da Adobe, a documentação está sempre em progresso. Se você detectar erros, registre um problema. Caso tenha sugestões sobre o material, informe-nos. Diga-nos quais informações você estava procurando. Informe-nos se você não conseguiu encontrar o que precisava. Caso tenha dificuldade para concluir sua tarefa, diga-nos como podemos ajudá-lo a aprender sobre nossas soluções.

A equipe de Documentação Colaborativa agradece a todos os autores e produtores de conteúdo da Adobe Experience Cloud.

Nesta página