Vaardigheid voor projectdocumentatie project-documentation
Leer hoe de de documentatiemogelijkheden van de Agent van de Modernisering van de Ervaring u kunnen helpen projectoverhandigers versnellen.
Projectoverhandigers versnellen project-handovers
de Agent van de Modernisering van de Ervaring kan projectdocumentatiegidsen voor de projecten van AEM Edge Delivery Services die automatisch produceren:
- Analyse van het Project - Verklaring van de projectopstelling, de structuur, en de overeenkomsten, die zonder handinspanning worden geproduceerd
- Module & componentenorganisatie - Duidelijke documentatie van hoe blokken, modules, en componenten worden georganiseerd en hoe zij op elkaar betrekking hebben
- Op rol-gebaseerde gidsen - gerichte documentatie voor auteurs, ontwikkelaars, en beheerders, zodat krijgt elk teamlid precies wat zij nodig hebben
Dit vereenvoudigt projectoverdracht voor AEM Edge Delivery Services-projecten.
Vereisten prerequisites
Verzeker het volgende alvorens deze vaardigheid te gebruiken.
-
Uw project moet uit aan de werkruimte in de console worden gecontroleerd.
-
U moet beheerdersmachtigingen hebben voor het project waarvoor u documentatie maakt.
-
De toestemmingen van de agent moeten in de console worden toegestaan.
- Selecteer de optie staat LLM toe om tot admin.hlx.page op mijn naam in de montages van de console toegang te hebben.
- Als deze optie niet wordt toegelaten, zal de agent de documentatie produceren die op de codebasis wordt gebaseerd die voor het toegankelijk is.
Projectdocumentatie maken creating-documentation
Zodra de eerste vereisten worden vervuld, moet u eenvoudig de agent vragen om documentatie voor uw project tot stand te brengen.
-
In de chat vraag "creeer documentatie van dit project."
-
Verstrek de organisatienaam van het project als de agent om het vraagt.
-
De agent zal vragen welke documentatie u zou willen tot stand brengen. Normaal, zou u allen selecteren.
-
Nadat u de hulplijnen hebt gemaakt, worden deze in de werkruimte geplaatst. Selecteer een object om een beschrijving weer te geven en klik op de koppeling om de volledige PDF te downloaden.
U kunt de PDF rechtstreeks opslaan om aan uw teams te leveren of uploaden als onderdeel van de rest van de DA-inhoud.
Problemen oplossen troubleshooting
Het volgende is gemeenschappelijke foutenmeldingen die worden ontmoet wanneer het gebruiken van de vaardigheid van de projectdocumentatie en hoe te om hen op te lossen.
"Toegang geweigerd" of "Niet-geautoriseerd" unauthorized
-
Oorzaak: Ontbrekende admin toestemmingen of agententoestemmingen niet toegelaten
-
Oplossing:
- Controleren of u beheerdersrechten hebt voor het project
- Selecteer de optie staat LLM toe om tot admin.hlx.page op mijn naam in de montages van de console toegang te hebben.
"Project niet gevonden" not-found
-
Oorzaak: Repository niet uitgecheckt in werkruimte
-
Oplossing:
- Ontdek de opslagplaats van het project
- Zorg ervoor dat u zich in de juiste werkruimte bevindt
"Config API-fout" api-error
-
Oorzaak: Onbekwaam om tot de dienst API van Edge Delivery Services config toegang te hebben
-
Oplossing:
- Selecteer de optie staat LLM toe om tot admin.hlx.page op mijn naam in de montages van de console toegang te hebben.
- Controleer uw netwerk-/VPN-verbinding
- Beheerdertoegang tot project bevestigen