source-git-commit | workflow-type | source-wordcount | ht-degree |
---|---|---|---|
abe5f8a4b19473c3dddfb79674fb5f5ab7e52fbf |
tm+mt |
739 |
51% |
Los usuarios de Adobe Experience Manager trabajan en entornos altamente competitivos y se esfuerzan por crear experiencias digitales que los diferencien de su competencia. Por lo tanto, es vital que, cuando Adobe AEM AEM ofrece nuevas herramientas avanzadas en el sector de la, estas herramientas se complementen con una documentación precisa y clara que permita al cliente utilizar de inmediato su inversión en el mercado y maximizar el retorno de la inversión.
El objetivo de la documentación de AEM es poner la información en manos de los usuarios de AEM lo antes posible. AEM Por lo tanto, el equipo de documentación de la da prioridad a la documentación precisa y utilizable, 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 el equipo de documentación del Experience Manager recibe con agrado las aportaciones a la documentación del Adobe AEM, cualquier aportación a la documentación del, ya sea en forma de solicitud de extracción o de incidencia, debe ajustarse a las normas de aportación y documentación del equipo.
Las contribuciones que no cumplan estas normas se rechazarán.
La documentación de AEM abarca estos 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.
El equipo de documentación de Experience Manager no suele documentar los errores ni sus soluciones alternativas.
La documentación de AEM abarca estos casos de uso estándar. Por este motivo, los errores, los efectos causados por errores y las soluciones alternativas para los errores no están documentados,
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 de AEM.
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 destinados únicamente a contribuciones. No están pensados para utilizarse para responder a sus preguntas sobre cómo utilizar AEM, implementar su proyecto de AEM o resolver problemas técnicos.
Cualquier pregunta sobre el uso de AEM o errores técnicos que pueda tener debe notificarse a través del proceso de asistencia normal mediante el Portal de asistencia de Experience Manager o analizarse en la comunidad de Experience Manager.
AEM Las contribuciones a la documentación de la no sustituyen a la Asistencia al cliente de Adobe y se rechazará 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 creará automáticamente con un vínculo a la página.
Esto no se aplica a las solicitudes de extracción, ya que las solicitudes de extracción, por su naturaleza, hacen referencia a las páginas afectadas.
AEM Cualquier contribución a la documentación de la debe seguir determinadas directrices de estilo.
AEM Seguir estas directrices facilita la revisión de su contribución y, por lo tanto, la integración en la documentación de la 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.
AEM Recuerde, los lectores de la documentación de la son de todo el mundo y no se puede esperar que hablen inglés de forma nativa o fluida. Evite los coloquialismos y utilice un lenguaje tan claro y simple como sea posible.
Manual de estilo de Microsoft® AEM es una guía de estilo de documentación disponible de forma gratuita que se centra en documentación de software y la documentación de la documentación de la sigue 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 utilice 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. Esto hace que la documentación sea más flexible y extensible para futuras versiones.
El producto siempre se debe llamar por su nombre completo Adobe Experience Manager por primera vez en un artículo y, posteriormente, puede denominarse AEM.
AEM No utilice Day, Day Software, CQ y CRX excepto cuando sea inevitable, como en nombres de clase o en referencia al historial de las.