Parcours de documentation AEM

Dernière mise à jour : 18 avril 2024

Créé pour :

  • Administration
  • Développeur
  • Utilisateur ou utilisatrice
  • Leader

Les parcours de documentation fournissent une structure narrative à la documentation AEM en synthétisant des fonctionnalités complexes et disparates pour atteindre un objectif commercial en respectant les bonnes pratiques. Conçu pour les débutants dans AEM, les parcours présentent les concepts et les fonctionnalités permettant d’atteindre un objectif, étape par étape.

Qu’est-ce qu’un parcours de documentation ?

Un parcours de documentation relie de nombreux sujets et fonctionnalités différents et complexes en aidant le lecteur, parfois débutant dans AEM, à comprendre et à résoudre un problème d’activité du début à la fin, tout en présupposant un minimum de connaissances préalables concernant le sujet ou AEM.

Les parcours de documentation sont différents des documents techniques existants pour AEM, qui se concentrent principalement sur une seule fonctionnalité et sur la documentation des tâches et en partant du principe que le lecteur est familier avec AEM. En se concentrant sur les concepts généraux et en réorientant le lecteur ou la lectrice vers la documentation technique existante pour plus de détails, les parcours de documentation permettent aux personnes débutantes dans AEM de commencer à comprendre comment la plateforme peut être exploitée en utilisant les bonnes pratiques pour répondre aux besoins et aux workflows courants de l’entreprise. C’est pourquoi les parcours de documentation servent de complément et non de remplacement à la documentation technique existante pour AEM.

Le fil rouge de l’apprentissage

AEM dispose d’un ensemble de fonctionnalités riches et puissants mais qui peuvent effrayer les nouveaux utilisateurs comme parfois les plus expérimentés. En commençant par présenter un objectif opérationnel clair plutôt que des exigences techniques, chaque parcours présente au lecteur les concepts et les caractéristiques d’AEM qui forment un ensemble permettant d’atteindre l’objectif opérationnel.

Cette forme de présentation permet au lecteur de mieux comprendre comment fonctionnent les différentes parties d’AEM pour résoudre ensemble les problématiques en cours et de garder une vision d’ensemble. Le lecteur peut ainsi considérer l’ensemble des objectifs commerciaux en prenant en compte toutes les fonctionnalités.

Concentrez-vous sur les concepts, et non sur les fonctionnalités

Les parcours de documentation mettent l’accent sur les concepts d’AEM plutôt que sur les caractéristiques techniques, ce qui aide le lecteur à suivre le fil de la narration. Il est plus important que le lecteur sache comment AEM est capable de résoudre un problème plutôt que de se soucier des cases à cocher, c’est pourquoi ce parcours guide le lecteur en illustrant le lien entre plusieurs concepts importants afin d’atteindre un objectif global.

Les parcours s’assurent que le lecteur sait comment AEM peut résoudre un problème sans avoir à perdre du temps à se demander si toutes les cases ont bien été cochées. Si le lecteur souhaite approfondir ses connaissances et en apprendre davantage sur les détails techniques ou sur ce que les options supplémentaires permettent de faire, chaque partie du parcours renvoie à une documentation technique plus exhaustive.

Orientation sur les bonnes pratiques

Les parcours de documentation sont conçus autour de principes de bonnes pratiques qui reposent sur les dernières recherches d’Adobe, sur l’expérience de mise en œuvre éprouvée par les services Adobe et sur les commentaires provenant de projets clients.

Si vous souhaitez savoir comment Adobe recommande de résoudre un cas d’activité avec AEM, les parcours de documentation représentent un parfait point de départ.

Comment est structuré un parcours de documentation ?

Un parcours de documentation sert d’introduction basée sur les bonnes pratiques sur la manière dont AEM résout les problèmes courants de l’entreprise. C’est pourquoi chaque parcours a été conçu pour s’adresser à des lecteurs peu familiers avec AEM, en exposant les cas d’activité, en décrivant toute la théorie nécessaire, puis en donnant un aperçu détaillé de la façon dont AEM résout ces problèmes. Les parcours, de par leur nature exhaustive, peuvent s’avérer utiles pour les lecteurs ou les lectrices qui découvrent AEM comme pour les utilisateurs expérimentés.

Un parcours de documentation standard est composé des parties suivantes.

  • Présentation des objectifs du parcours et de l’audience ciblée
  • Description du problème d’activité
  • Description de toute la théorie nécessaire pour résoudre le problème
  • Conditions préalables et configuration requise
  • Description de l’audience ciblée
  • Étapes de mise en œuvre

L’objectif d’un parcours de documentation est de familiariser le lecteur avec les principes de base de la manière dont AEM utilise différentes fonctionnalités et outils pour résoudre un seul problème d’entreprise. Pour cette raison, les étapes de mise en œuvre illustrent les schémas d’utilisation les plus courants ainsi que les fonctionnalités et options les plus importantes. Des options de paramétrage détaillées sont présentées dans la documentation technique, si le lecteur souhaite approfondir ses connaissances.