Compétence en documentation de projet project-documentation
Découvrez comment les compétences de documentation de l’agent de modernisation d’expérience peuvent vous aider à accélérer les transferts de projet.
Accélération des transferts de projet project-handovers
L’agent de modernisation de l’expérience peut générer automatiquement des guides de documentation de projet pour les projets AEM Edge Delivery Services avec les éléments suivants :
- Présentation du projet - Explication de la configuration, de la structure et des conventions du projet, générées sans effort manuel
- Organisation des modules et des composants - Une documentation claire sur l’organisation des blocs, modules et composants et sur la manière dont ils sont liés les uns aux autres
- Guides basés sur les rôles - Documentation ciblée pour les auteurs, les développeurs et les administrateurs, afin que chaque membre de l’équipe obtienne exactement ce dont il a besoin
Cela simplifie les transferts de projet pour les projets AEM Edge Delivery Services.
Conditions préalables prerequisites
Assurez-vous des points suivants avant d’utiliser cette compétence.
-
Votre projet doit être extrait de l’espace de travail dans la console.
-
Vous devez disposer d’autorisations d’administrateur pour le projet pour lequel vous créez de la documentation.
-
Les autorisations de l’agent doivent être autorisées dans la console.
- Sélectionnez l’option Autoriser LLM à accéder à admin.hlx.page en mon nom dans les paramètres de la console.
- Si cette option n’est pas activée, l’agent génère la documentation en fonction de la base de code qui lui est accessible.
Création de la documentation d'un projet creating-documentation
Une fois les conditions préalables remplies, il vous suffit de demander à l’agent de créer la documentation de votre projet.
-
Dans la conversation, demandez « Créer la documentation de ce projet ».
-
Indiquez le nom de l’organisation du projet si l’agent le demande.
-
L’agent vous demandera quelle documentation vous souhaitez créer. En règle générale, vous devez sélectionner Tous.
-
Une fois créés, les guides sont placés dans votre espace de travail. Sélectionnez-en un pour afficher une description et cliquez sur le lien pour télécharger l’intégralité du PDF.
Vous pouvez enregistrer le PDF directement pour le fournir à vos équipes ou le charger dans le cadre du reste du contenu de la DA.
Résolution des problèmes troubleshooting
Vous trouverez ci-dessous les messages d’erreur courants rencontrés lors de l’utilisation des compétences de documentation de projet et comment les résoudre.
« Accès refusé » ou « Non autorisé » unauthorized
-
Cause : autorisations d’administrateur manquantes ou autorisations d’agent non activées
-
Solution :
- Vérifiez que vous disposez d’un accès administrateur au projet
- Sélectionnez l’option Autoriser LLM à accéder à admin.hlx.page en mon nom dans les paramètres de la console.
« Projet Introuvable » not-found
-
Cause : référentiel non extrait dans l’espace de travail
-
Solution :
- Extraire le référentiel du projet
- Vérifiez que vous vous trouvez dans l’espace de travail approprié.
« Erreur de l’API de configuration » api-error
-
Cause : impossible d’accéder à l’API du service de configuration Edge Delivery Services
-
Solution :
- Sélectionnez l’option Autoriser LLM à accéder à admin.hlx.page en mon nom dans les paramètres de la console.
- Vérifiez votre connexion réseau/VPN
- Confirmer l’accès administrateur au projet