Información general sobre la Guía de colaborador para la documentación de Adobe

¿Qué es la documentación colaborativa?

La documentación técnica y el contenido de habilitación de Adobe Experience Cloud y otros productos de Adobe Enterprise se han trasladado a una nueva plataforma. Esta nueva plataforma se basa en principios de código abierto que utilizan las soluciones Github, Markdown y Adobe Experience Cloud.

Este modelo de código abierto mejora la calidad del contenido y la comunicación entre clientes, equipos de documentación y equipos de producto. Ahora, en cada una de las páginas es posible valorar la utilidad del contenido, registrar problemas e incluso contribuir con sugerencias de contenido mediante solicitudes de extracción (PR) Git. Los equipos de documentación de Adobe supervisan diariamente las contribuciones y los problemas, y realizan las actualizaciones, las modificaciones y los ajustes necesarios.

Uso de la documentación colaborativa

Como usuario de este material, e independientemente de si es empleado, socio, cliente o incluso cliente potencial, tiene la opción de contribuir a la documentación de varias formas sencillas:

  • Valorar la utilidad de la página
  • Registrar un problema en una página específica
  • Enviar desde pequeñas modificaciones hasta artículos completos con recursos y ejemplos de código

En esta guía se describe todo lo que necesita saber para interactuar con este conjunto de materiales y contribuir a su creación.

Realice ediciones rápidas en documentos existentes

Realizar ediciones rápidas es una buena manera de solucionar pequeños errores y omisiones en los documentos. Si un artículo incluye un botón de edición como se muestra a continuación, puede realizar una corrección rápida. Cuando edita el documento, envía una solicitud de extracción (PR) para enviarnos la solución/sugerencia y nosotros podremos vetarla, aprobarla y publicarla.

  1. Si le parece aceptable, firme el Acuerdo de licencia para colaboradores (CLA).

    Solo es necesario que envíe el CLA de Adobe una vez.

  2. Haga clic en el icono Edit this page en la columna derecha para ir al archivo Markdown de origen en GitHub.

    Editar el icono de esta página

  3. Haga clic en el icono de lápiz para editar el artículo.

    NOTA

    Si el icono de lápiz está deshabilitado, debe iniciar sesión en su cuenta de GitHub o crear una nueva.

    Ubicación del icono de lápiz

  4. Realice los cambios en el editor web. Puede hacer clic en la pestaña Preview changes para comprobar el formato del cambio.

  5. Una vez que haya realizado los cambios, desplácese hasta la parte inferior de la página. Introduzca un título y una descripción para su PR y haga clic en Propose file change, como se muestra en la siguiente ilustración:

    Propuesta de cambio

    NOTA

    Si recibe un mensaje de error de validación relativo a la firma del Acuerdo de licencia para colaboradores (CLA), haga clic en Detalles para abrir el acuerdo de licencia. Si acepta las condiciones, firme el acuerdo. A continuación, cierre y abra la solicitud de extracción, y continúe.

Es así de sencillo. ¡Gracias! Los integrantes del equipo de documentación revisarán y fusionarán la solicitud de extracción.

Registrar un problema

Otra manera de comunicarnos fácilmente un problema en algún contenido es "Registrar un problema".

  1. Si encuentra algún problema en un fragmento de contenido, haga clic en el icono Log an Issue en la columna derecha.

    NOTA

    Para registrar un problema, debe acceder a su cuenta de GitHub o crear una nueva cuenta.

    Si hace clic en este vínculo, podrá registrar una solicitud rápida mediante la interfaz de problemas de GitHub.

  2. La dirección URL de la página con el problema se rellenará automáticamente en el campo de descripción. Añada el título, escriba una breve descripción del problema y haga clic en Submit new issue.

Al enviar un problema, el equipo de contenido de esta página recibe una notificación para que se ponga manos a la obra. Cuando actualicemos el contenido, le avisaremos en la interfaz de problemas de GitHub y le notificaremos por correo electrónico cualquier actualización o cierre.

Explicación de los permisos de GitHub

La edición de la interfaz de usuario de GitHub se adapta a sus permisos de repositorio. Las imágenes anteriores son las adecuadas para los colaboradores que no tienen permisos de escritura en el repositorio de destino. GitHub crea automáticamente una ramificación del repositorio de destino en su cuenta. Si tiene acceso de escritura al repositorio de destino, GitHub crea una rama nueva en dicho repositorio.

Adobe usa solicitudes de extracción para todos los cambios, incluso para los colaboradores que tienen acceso de escritura. La mayoría de los repositorios tienen la ramificación master protegida para que las actualizaciones deban enviarse como solicitudes de extracción.

La edición en el navegador es mejor para cambios menores o poco frecuentes. Si realiza grandes contribuciones o utiliza características de Git avanzadas, le recomendamos que ramifique el repositorio y trabaje de forma local.

Proporcionar comentarios

Con un conjunto de soluciones tan grande como el de Adobe, la documentación siempre está en constante evolución. Si encuentra errores, registre un problema; si tiene sugerencias sobre el material, háganoslo saber. Díganos qué información estaba buscando. Si no encontró lo que necesitaba, háganoslo saber. Si tiene dificultades para completar su tarea, indíquenos cómo podemos ayudarle a conocer nuestras soluciones.

Gracias de parte del equipo de documentación colaborativa y de todos los redactores y productores de contenido de Adobe Experience Cloud.

En esta página