Jornadas de documentação do AEM aem-documentation-journeys
As jornadas de documentação fornecem uma estrutura narrativa dentro da documentação do AEM, unindo recursos complexos e diferentes para que você possa resolver uma meta empresarial utilizando práticas recomendadas. As jornadas foram desenvolvidas para auxiliar os iniciantes no AEM, apresentando os conceitos e recursos que permitem atingir uma meta de A a Z.
O que é uma jornada de documentação? what-is
Uma jornada de documentação une vários tópicos e recursos diferentes e talvez complicados, fornecendo uma narrativa que ajuda o leitor, que pode ser novo no AEM, a entender e resolver um problema empresarial do começo ao fim, mesmo que ele tenha o mínimo de conhecimento prévio sobre o tópico ou o AEM.
As jornadas de documentação contrastam com os documentos técnicos existentes do AEM, que se concentram principalmente em um único recurso e documentação de tarefas e que são destinados àqueles que já estão familiarizados com o AEM. Ao se concentrar nos conceitos e deixar os detalhes minuciosos para a documentação técnica existente, as jornadas de documentação oferecem aos leitores novos no AEM um lugar para começar a entender como a plataforma pode ser aproveitada utilizando as práticas recomendadas que atendem às necessidades e fluxos de trabalho empresariais comuns. Por esse motivo, as jornadas de documentação servem como um complemento e não como substitutas da documentação técnica existente do AEM.
Aprendizagem por narrativa narrative
O AEM tem um conjunto de recursos avançados que pode sobrecarregar os novos usuários (e, às vezes, até usuários experientes). Cada jornada concentra-se em um objetivo empresarial claro, em vez de requisitos técnicos, fornecendo uma narrativa que conduz o leitor pelos conceitos e recursos do AEM que são necessários para atingir a meta empresarial.
Através de uma história, o leitor entende melhor como diferentes partes do AEM trabalham juntas para resolver o problema atual, mantendo a perspectiva. Assim, o leitor consegue visualizar os objetivos empresariais dos recursos disponíveis.
Foco nos conceitos e não nos recursos concepts
Para manter o foco na narrativa, as jornadas de documentação do AEM enfatizam os conceitos, em vez de se concentrar nos recursos técnicos. Reconhecendo que é mais importante que o leitor esteja familiarizado com a forma como o AEM resolve um problema específico do que se preocupar em preencher todos os requisitos, a jornada permite que o leitor avance com a narrativa, ilustrando como reunir vários conceitos importantes para atingir a meta geral.
As jornadas garantem que o leitor saiba como o AEM pode resolver um problema em vez de se preocupar com cada opção disponível. Se o leitor quiser se aprofundar e conhecer mais detalhes técnicos ou o que as opções adicionais podem fazer, cada parte da jornada é vinculada à documentação técnica completa relacionada àquele assunto.
Orientação de práticas recomendadas best-practices
As jornadas de documentação foram criadas com base em princípios de práticas recomendadas, informadas pelas últimas pesquisas da Adobe, experiências de implementação comprovadas por consultores da Adobe e feedbacks de projetos de clientes.
Se quiser saber como a Adobe recomenda resolver casos empresariais com o AEM, as jornadas de documentação são um ótimo ponto de partida.
Como uma jornada de documentação é estruturada? structure
Uma jornada de documentação serve como uma introdução baseada em práticas recomendadas sobre como o AEM soluciona problemas empresariais comuns. Por isso, cada jornada é projetada para auxiliar leitores que são novos no AEM, apresentando o problema, descrevendo a teoria necessária e fornecendo uma visão passo a passo de como o AEM resolve o problema. Devido à natureza abrangente de uma jornada, ela pode ser útil tanto para leitores novos no AEM como para usuários experientes.
Uma jornada de documentação típica tem as seguintes partes.
- Visão geral das metas da jornada e do público-alvo
- Descrição do problema empresarial
- Descrição de qualquer teoria necessária para resolver o problema
- Pré-requisitos e condições
- Descrição do público-alvo
- Etapas de implementação
Uma jornada de documentação tem como objetivo familiarizar o leitor com as noções básicas de como o AEM usa diferentes recursos e ferramentas para resolver um único problema empresarial. Por isso, as etapas de implementação ilustram os padrões de uso mais comuns e os recursos e opções mais importantes. As opções detalhadas de configuração são vinculadas à documentação técnica para leitura posterior.
Quem deve ler as jornadas de documentação? who
O objetivo principal das jornadas de documentação do AEM é ajudar os leitores novos no AEM a compreender quantos recursos diferentes e avançados do sistema podem ser usados juntos para resolver problemas empresariais comuns por meio de uma narrativa.
Portanto, se você é novo no AEM, tem um caso empresarial específico em mente e deseja ter uma visão geral de como o AEM pode resolvê-lo, as jornadas de documentação são o local ideal para começar.
No entanto, existem vários tipos diferentes de usuários do AEM, todos com necessidades e expectativas diferentes. Por exemplo:
- Administradores
- Desenvolvedores
- Autores de conteúdo
- Especialistas em tradução
- Arquitetos de conteúdo
Cada jornada começa informando claramente sobre o público-alvo da jornada. Como ninguém trabalha sozinho, quando o leitor requer o auxílio de um usuário ou pessoa do sistema, isso é claramente explicado dentro da jornada.
Como as jornadas de documentação se encaixam na documentação do AEM? compare
As jornadas de documentação são um complemento da documentação técnica e dos tutoriais existentes do AEM. Por exemplo, uma jornada apresenta a você um conceito e, em seguida, os documentos técnicos explicam as opções de configuração detalhadas que podem ser necessárias, enquanto um tutorial o guia pelas configurações específicas.
Quais são as jornadas existentes? journeys
Há várias Jornadas de documentação disponíveis para você. Como cada jornada é desenvolvida com uma narrativa, comece com a introdução e leia todo o conteúdo para obter um entendimento completo do tópico no contexto do AEM.
Fique atento para mais conteúdo à medida que novas jornadas se tornam disponíveis.