| source-git-commit | workflow-type | source-wordcount | ht-degree |
|---|---|---|---|
2a25b0482800d4c5428a5595c9699dceed327043 |
ht |
714 |
100% |
Los usuarios de Adobe Experience Manager están trabajando en entornos altamente competitivos, esforzándose por crear experiencias digitales que los diferencien de su competencia. Por lo tanto, cuando Adobe ofrece herramientas avanzadas en AEM, estas herramientas se complementan con una documentación precisa y clara. Permite a los clientes utilizar de inmediato su inversión en AEM y maximizar el retorno de la inversión.
La meta de la documentación de AEM es poner la información en manos de los usuarios de AEM lo antes posible. Por lo tanto, Adobe concede prioridad a una documentación precisa y útil, y se esfuerza por actualizarla y mejorarla continuamente.
Para mejorar continuamente la documentación de AEM, contamos con la ayuda de toda la comunidad de usuarios de AEM. Ya sea a través de solicitudes de extracción o incidencias, las mejoras en la documentación pueden ser correcciones, aclaraciones, expansiones y ejemplos adicionales.
Aunque Adobe agradece las contribuciones a su documentación, toda contribución que se haga a la documentación de AEM, ya sea en forma de solicitud de extracción o de problema, debe ajustarse a las normas de contribución y documentación de Adobe.
Las contribuciones que no cumplan estas normas se rechazarán.
La documentación de AEM abarca casos de uso estándar. Los casos de uso que exceden el ámbito de la instalación estándar y el uso del producto no forman parte de la documentación de AEM.
La documentación de AEM abarca casos de uso estándar. Por este motivo, los errores, los efectos causados por estos y las soluciones alternativas no suelen registrarse.
Las excepciones a esta regla se aplican a las notas de la versión, donde los problemas conocidos pueden enumerarse con posibles soluciones aprobadas por el equipo de administración del producto.
Cualquier idea que tenga para mejorar la documentación de AEM es bienvenida como contribución. Sin embargo, los comentarios, las incidencias y las solicitudes de extracción están destinadas únicamente a las contribuciones. No están pensados para responder a sus preguntas sobre cómo utilizar AEM, implementar su proyecto de AEM o resolver problemas técnicos.
Puede informar de cualquier pregunta acerca de errores técnicos o de uso de AEM. Utilice el proceso de soporte normal mediante el Portal de soporte Enterprise de Experience Cloud o discutido en la comunidad de Experience Manager.
Las contribuciones a la documentación de AEM no sustituyen al equipo de asistencia de Adobe y se rechaza cualquier contribución de este tipo que busque respuestas a preguntas relacionadas con la asistencia.
Si crea un problema para sugerir mejoras en la documentación, debe incluir vínculos a las páginas afectadas. Si crea un problema utilizando el vínculo Editar esta página en una página de documentación, el problema se crea automáticamente con un vínculo a la página.
Este proceso no se aplica a las solicitudes de extracción, ya que por su naturaleza hacen referencia a las páginas afectadas.
Adobe pide que cualquier contribución a su documentación siga ciertas pautas de estilo.
Seguir estas directrices facilita la revisión de su contribución y, por lo tanto, la integración en la documentación de Adobe es más rápida.
- La documentación de AEM se redacta y se actualiza en inglés estadounidense (originalmente).
- Escriba frases lo más simples posibles.
- Utilice un lenguaje claro y conciso.
Recuerde que los lectores de la documentación de AEM están establecidos en todo el mundo, no se puede esperar que sean hablantes nativos o fluidos del inglés. Evite los coloquialismos, utilice un lenguaje claro y simple como sea posible.
©El Manual de estilo de Microsoft® es una guía de estilo de documentación disponible libremente que se centra en documentación de software. La documentación AEM debe seguir esta guía siempre que sea posible.
| Elemento | Estilo |
|---|---|
| Elemento u opción de la interfaz de usuario | negrita |
| Nombre de archivo, ruta, entrada de usuario, valores de parámetro | monospaced |
| Código, línea de comandos | Code Block |
Las capturas de pantalla deben utilizarse con prudencia y solo cuando la descripción textual no sea suficiente.
No se deben utilizar marcadores u otras anotaciones en las capturas de pantalla (como marcos rojos, flechas o texto). De este modo, las capturas de pantalla son más fáciles de reutilizar o replicar en versiones localizadas de la documentación.
Intente evitar cualquier referencia directa a una versión específica en todo el contenido de la documentación, siempre que sea posible. Esta recomendación hace que la documentación sea más flexible y extensible para futuras versiones.
En un artículo, haga siempre referencia al producto por su nombre completo Adobe Experience Manager la primera vez que se utiliza. A partir de entonces, se denomina AEM.
No se deben utilizar las palabras Día, Software de día, CQ y CRX, excepto cuando sea inevitable, como en nombres de clase o en referencia al historial de AEM.