Generar documentación del proyecto project-documentation
Experience Modernization Agent escribe guías para las personas que trabajan en el sitio: autores, desarrolladores y administradores. Los crea a partir del código del proyecto y, con su permiso, de la configuración del sitio, y los envía como PDF que puede entregar a un equipo que se haga cargo del proyecto.
Qué cubren las guías project-handovers
- Tutorial del proyecto: cómo se configura y estructura el proyecto, y las convenciones que sigue.
- Organización del código: cómo se organizan los bloques, módulos y componentes y cómo se relacionan entre sí.
- Guías basadas en roles: una guía para autores, desarrolladores y administradores.
Las guías describen lo que el agente puede leer: el código del espacio de trabajo de la consola y, con permiso para utilizar las credenciales de Adobe, la configuración del sitio desde la API de administración. Los sistemas que no puede leer, como la integración o la configuración de CDN, no están cubiertos.
Requisitos previos prerequisites
- El proyecto está desprotegido en el espacio de trabajo de la consola.
- La documentación del proyecto es una capacidad opcional. Si no está activado para el proyecto, el agente le ofrece activarlo cuando solicite documentación y le pide que confirme.
- Para incluir la configuración del sitio, necesitas acceso de administrador al sitio y Permitir que LLM use mis credenciales de Adobe para admin.hlx.page, Document Authoring y repositorios alojados fuera de GitHub activados en Configuración. El permiso cubre la API de administración y Experience Workspace, no el repositorio de contenido de Java (JCR) de una instancia de autor. Sin ella, el agente documenta el código solamente. Pídale que enumere la configuración y el contenido que no pudo inspeccionar para que los lectores sepan qué omiten las guías.
Creación de la documentación creating-documentation
-
Pregunte al agente
Create documentation for this project. Diga para quién son las guías, dónde editan el contenido los autores (Experience Workspace o el editor universal) y lo que sabe sobre el proyecto que el código no muestra. -
Proporcione el nombre de organización del proyecto si el agente se lo pide.
-
Cuando el agente pregunte qué documentación crear, seleccione Todos o las guías que necesite.
-
El agente coloca las guías en el espacio de trabajo de la consola. Seleccione uno para ver su descripción y, a continuación, seleccione su vínculo para descargar PDF.
Antes de compartir una guía, compruebe sus pasos de configuración, ubicaciones de contenido, comandos, pasos de creación y limitaciones establecidas para el proyecto. En el caso de los proyectos basados en documentos, también puede cargar los PDF con el resto del contenido en Experience Workspace.
Conservar contexto para personas y agentes portable-handoff
Los archivos PDF describen el proyecto en un momento dado. Para mantener el contexto que necesita la siguiente persona o conversación, mantenga un breve archivo de entrega de Markdown en el repositorio Git del proyecto. La consola no genera este archivo; usted y el agente lo escriben.
Incluir:
Para la creación de Experience Manager, registre también los cambios de modelo y configuración, los destinos de sitio y DAM, los resultados de importación de paquetes y lo que ha comprobado en el editor universal. En el caso del contenido basado en documentos, registre dónde se almacenan los documentos y cualquier decisión sobre cómo transferirlos o sobrescribirlos.
Hacer referencia al archivo desde AGENTS.md, de modo que el agente lo encuentre cuando una tarea lo necesite. Consulte Usar AGENTS.md como punto de entrada. Nunca incluya tokens, contraseñas u otros secretos.
feche el archivo y actualícelo cuando cambien el código, los modelos, el contenido o la implementación. Los PDF generados y las conversaciones anteriores quedan obsoletos; ninguno de los dos muestra lo que está activo ahora.
Resolución de problemas troubleshooting
Cuando falle la generación, corrija la causa a continuación, genere de nuevo la guía afectada y compruébela.
“Acceso denegado”, “No autorizado” o “Error de API de configuración” unauthorized
El agente no puede leer la configuración del sitio a través de la API de administración. Compruebe que tenga acceso de administrador al sitio y que esté activada la configuración de credenciales de requisitos previos. Si no necesita la configuración, pida guías de solo código en su lugar.
“Proyecto no encontrado” not-found
El repositorio del proyecto no está desprotegido en el espacio de trabajo de la consola. Conéctelo como se describe en Conectar su sitio.