Prácticas recomendadas sobre la creación

Información general

Esta página describe las reglas que debe seguir cuando creación de la documentación de destino para garantizar que cumple los estándares de calidad de la documentación de Adobe Experience Platform.

Directrices generales

  • Al rellenar el plantilla para la documentación de destino, consulte la guía del colaborador de Adobe para obtener información sobre vinculación, tablas, el sintaxis de markdown admitida, guía de escritura, y más.
  • No incluya observaciones y estimaciones en la documentación del producto.
  • En la documentación de Experience Platform, los autores de Adobes utilizan formato negrita para hacer referencia a los controles de la interfaz de usuario, haga lo siguiente:
    • Vaya a Conexiones > Destinos y seleccione Catálogo pestaña . Ver un ejemplo de cómo se documentan los controles de la interfaz de usuario en un tutorial de destinos.

Estilo de escritura

IMPORTANTE

Lectura Guía de escritura para la documentación de Adobe antes de comenzar a crear la página de documentación de destino.

  • Mantenga sus frases cortas y llegue al punto rápidamente. Si la oración tiene más de 20 palabras o usa varias comas, considere separarla en oraciones separadas. Las frases de más de 20 palabras pueden ser especialmente desafiantes para los lectores.
  • No seas demasiado educado. Evite utilizar "please" (por favor) o "do…" (por favor). en la documentación técnica.

Vinculación

Siga la plantilla de documentación proporcionada y no edite los vínculos existentes en la plantilla. Cuando se incluyan vínculos nuevos, lea uso de vínculos en la documentación en la guía del colaborador.

Directrices de personalización

  • AEP no es un término público aprobado. Utilice Adobe Experience Platform en primer uso, luego Experience Platform y, por último, Platform.
    • No use: Antes de exportar datos de AEP a YourDestination, asegúrese de leer y completar estos requisitos previos.
    • Uso: Antes de exportar datos de Adobe Experience Platform a su destino, asegúrese de leer y completar estos requisitos previos.

Imágenes y capturas de pantalla

  • Para obtener información sobre cómo vincular a imágenes, consulte la guía del colaborador.
  • Cuando utilice capturas de pantalla, asegúrese de que la captura de pantalla captura toda la pantalla de la interfaz de usuario de Platform.
  • Al marcar las imágenes para resaltar un determinado control o etiqueta en la página, intente seguir el estilo de marcado utilizado por el equipo de documentación del Experience Platform. Observe cómo se resalta la función basada en perfiles en esta captura de pantalla.
  • Utilice png formatear imágenes.
  • No utilice capturas de pantalla numeradas como nombres de archivo. Los nombres de archivo de imagen deben ser descriptivos.
    • No use: 1.png, 2.png, 3.png
    • Uso de: yourdestination-authentication-details.png, yourdestination-destination-details.png
  • Utilice texto alternativo para cualquier imagen que agregue a la documentación y utilice la gramática adecuada en el texto alternativo.
    • No use: Detalles de conexión de destino
    • Uso: Imagen de la interfaz de usuario de Platform que muestra los detalles de conexión de destino completados.

Proceso

  • La variable plantilla de documentación se actualiza con poca frecuencia, en función de los comentarios de los socios. Antes de empezar a crear documentación para su destino, asegúrese de haber descargado la variable versión más reciente de la plantilla.
  • Cree la documentación y la solicitud de extracción (PR) de documentación desde una rama de su ramificación distinto de la rama principal. Consulte la sección Enviar destino para revisión al crear en la sección Interfaz de GitHub o su entorno local.

En esta página