Recorridos de documentación de AEM

Última actualización: 17 de abril de 2024

Creado para:

  • Administrador
  • Desarrollador
  • Usuario
  • Líder

Los Recorrido AEM de documentación proporcionan una estructura narrativa dentro de la documentación de la documentación de al unir funciones complejas y dispares para resolver un objetivo comercial de una manera óptima. Los recorridos, diseñados pensando en los principiantes de AEM, presentan los conceptos y características para lograr las metas de la A a la Z.

¿Qué es un Recorrido de documentación?

Un Recorrido de documentación une muchos temas y características diferentes y complejos. Proporciona una narrativa que ayuda al lector (que puede ser nuevo en AEM) a entender y resolver un problema empresarial de principio a fin, mientras asume un conocimiento previo mínimo de AEM.

Los Recorridos de documentación se contrastan con documentos técnicos existentes de AEM que se centran principalmente en una única función y documentación de tareas, suponiendo que estén familiarizados con AEM. Al centrarse en los conceptos y diferir los detalles en profundidad a la documentación técnica existente, los Recorridos de documentación proporcionan a los lectores nuevos en AEM un punto de partida para comprender cómo se puede utilizar la plataforma mediante las prácticas recomendadas para satisfacer las necesidades y los flujos de trabajo empresariales comunes. Por este motivo, los Recorridos de documentación sirven como complemento y no como sustituto de la documentación técnica existente de AEM.

Aprender Por Narrativa

AEM tiene un potente conjunto de numerosas funciones que puede resultar abrumador para los usuarios nuevos (y a veces, también, para los experimentados). Al comenzar cada recorrido con un objetivo comercial claro en lugar de requerimientos técnicos, un recorrido cuenta una narrativa que guía al lector a través de los conceptos y características de AEM que trabajan juntos para lograr el objetivo comercial.

Al contar una historia, el lector entiende mejor cómo diferentes partes de AEM trabajan juntas para resolver el problema en cuestión y la perspectiva se mantiene. Por lo tanto, el lector puede ver el bosque objetivo del negocio para los árboles de características.

Céntrese en conceptos y no en funciones

Para mantener el enfoque en la narrativa, los Recorridos de la documentación hacen hincapié en los conceptos en AEM en lugar de dedicarse a las características técnicas. Consciente de que es más importante que el lector esté familiarizado con la forma en que AEM resuelve un problema en particular que con la preocupación sobre las casillas en las que hacer clic, el recorrido mantiene al lector avanzando a través de la narrativa, ilustrando cómo vincular varios conceptos importantes para lograr el objetivo general.

Los recorridos garantizan que el lector sepa cómo AEM puede resolver un problema en lugar de preocuparse por cada opción en la que hacer clic. Si el lector desea profundizar y conocer más detalles técnicos o qué opciones adicionales pueden hacer, cada parte del recorrido se vincula a documentación técnica relacionada y exhaustiva.

Orientación sobre prácticas recomendadas

Los recorridos de documentación están diseñados en torno a los principios de las prácticas recomendadas, basados en las últimas investigaciones de Adobe, la experiencia de implementación comprobada de los servicios de Adobe, y los comentarios sobre los proyectos de los clientes.

Si desea saber cómo recomienda Adobe resolver los casos empresariales con AEM, puede comenzar con los Recorridos de documentación.

¿Cómo se estructura un Recorrido de documentación?

Un Recorrido de documentación sirve como una introducción basada en las prácticas recomendadas sobre cómo resuelve AEM los problemas empresariales comunes. Por esta razón, cada recorrido está diseñado con lectores nuevos de AEM en mente, exponiendo el problema de la empresa, describiendo cualquier teoría necesaria y luego dando una visión paso a paso de cómo AEM resuelve el problema. Debido a la naturaleza exhaustiva de un recorrido, puede ser útil para lectores nuevos de AEM y para usuarios experimentados.

Un recorrido de documentación típico consta de las siguientes partes.

  • Descripción general de los objetivos del recorrido y de la audiencia a la que va dirigido
  • Descripción del problema de la empresa
  • Descripción de cualquier teoría necesaria para resolver el problema
  • Requisitos y requisitos previos
  • Descripción de la audiencia objetivo
  • Pasos de la implementación

La meta de un recorrido de documentación es familiarizar al lector con los conceptos básicos de cómo AEM utiliza diferentes funciones y herramientas para resolver un único problema de empresa. Por este motivo, los pasos de implementación ilustran los patrones de uso más comunes y las características y opciones más importantes. Las opciones de configuración detalladas están vinculadas en la documentación técnica para su posterior lectura.

¿Quién debe leer los recorridos de documentación?

El objetivo principal de los recorridos de documentación de AEM es ayudar a los lectores nuevos en AEM a comprender cuántas características diferentes y poderosas del sistema se pueden usar para resolver problemas comunes de empresas a través de una narrativa.

Por lo tanto, si es nuevo en AEM y tiene en mente un caso empresarial específico y desea una visión general de cómo AEM puede resolverlo, los Recorridos de documentación son el lugar más indicado para comenzar.

Sin embargo, hay muchos tipos diferentes de usuarios de AEM con diferentes necesidades y expectativas. Por ejemplo:

  • Administradores
  • Desarrolladores
  • Autores de contenido
  • Especialistas en traducción
  • Arquitectos de contenido

Cada recorrido comienza con una declaración clara de la audiencia a la que va dirigido el recorrido. Como nadie trabaja en el vacío, cuando el lector necesita la asistencia de un usuario o una persona del sistema, esto se explica claramente en el recorrido.

¿Cómo se ajustan los Recorridos de documentación a la documentación de AEM?

Los Recorridos de documentación están pensados como un complemento de la documentación técnica de AEM y los tutoriales existentes. Por ejemplo, un recorrido puede presentar un concepto y, a continuación, los documentos técnicos explican las opciones de configuración detalladas que puede necesitar y un tutorial le guía a través de configuraciones específicas.

Tipo de documentaciónFunciónAudienciaSupuestosOmisionesTipo de contenidoLength
Recorrido de documentaciónUn recorrido define cómo AEM puede resolver un problema empresarial general a través de una narrativa que guía a los lectores a través de procesos y características complejos e interrelacionados. Ilustra cómo varias funciones trabajan juntas para resolver una necesidad empresarial de manera óptima.Lectores nuevos en AEMFamiliaridad general de CMSOpciones y configuración detalladasTextoCA. 1 hora
Documentos técnicosLos documentos técnicos se centran en características individuales, detallando el funcionamiento técnico de la funcionalidad y cada opción disponible para el usuario.Usuarios de AEM con experienciaExperiencia en AEMContexto y fondoTextoVaría
TutorialUn tutorial es una explicación detallada de un tema que muestra a un desarrollador o administrador cómo lograr una meta técnica (generalmente programación o configuración del sistema) paso a paso, proporcionando ejemplos específicos y código de ejemplo y, generalmente, usando un conjunto limitado de funciones.Desarrolladores o administradores de AEMExperiencia en AEMFondo y teoríaVídeo>1 hora
Guía de introducciónUna guía de introducción es una guía rápida de una nueva funcionalidad de AEM específica. Se trata de una descripción general rápida de una funcionalidad individual que lleva al usuario a través de los pasos importantes (pero no todos) para configurar y utilizar un caso de uso sencillo.Administradores de AEMExperiencia en AEMFondo, teoría y opciones detalladasTexto<1 hora

¿Qué recorridos hay?

Ya tiene a su disposición varios Recorridos de documentación. Dado que cada recorrido AEM está diseñado como una narrativa, empiece con la introducción y siga leyendo hasta el final para comprender el tema en el contexto de la creación de un sitio web. (Filmado en TEDxBoston)

RecorridoDescripción
Recorrido para desarrolladores de HeadlessComience aquí para ver cómo AEM admite modelos de desarrollo sin encabezado y cómo comenzar un proyecto desde la planificación, pasando por la implementación, hasta el lanzamiento.
Recorrido de creación sin encabezadoComience aquí para obtener un recorrido guiado a través de las potentes y flexibles funciones sin encabezado de AEM, sus funcionalidades y cómo diseñar el contenido en su primer proyecto sin encabezado.
Recorrido para arquitectos de HeadlessComience aquí para ver una introducción a las potentes y flexibles funciones sin encabezado de Adobe Experience Manager y cómo diseñar contenido para su proyecto.
Recorrido de traducción sin encabezadoComience aquí para ver cómo configurar y administrar sus proyectos de traducción sin encabezado en AEM.

Experience Manager