En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Mauta
- Escritor técnico:
- Swati Thacker
- Nombre del proyecto:
- Revisa y actualiza la documentación para el usuario final de Mautic
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Estas son mis primeras impresiones cuando revisé la documentación existente:
En la actualidad, la documentación es extensa, redundante en muchos lugares, incompleta y desordenada, lo que puede dificultar que los usuarios encuentren la información que buscan.
Como usuario nuevo, no pude entender cómo los diferentes elementos de Mautic, como las campañas, los recursos, los mensajes, las categorías, etc., se complementan para resolver una necesidad empresarial. Te propongo tener un tema conceptual de alto nivel que describa cada elemento de Mautic en 2 o 3 líneas. A su vez, este tema puede vincularse a los diversos temas de tareas detalladas de cada uno de estos elementos.
La guía para colaboradores se puede ampliar para incluir más información, como cómo abrir un problema, sugerir contenido o ideas nuevas, informar errores, problemas o vulnerabilidades de seguridad, etc., proporcionando vínculos a foros, canales de Slack y repositorios de git. Además, la guía de estilo debe expandirse para agregar convenciones tipográficas estándar, lineamientos para imágenes, tablas, etcétera.
Además, hay bastante información incompleta en los correos electrónicos y las campañas, y hay información antigua o desactualizada que se debe actualizar.
Área en la que me gustaría contribuir:
Mientras revisaba las conversaciones en los canales de Slack en los que los usuarios interactúan directamente con la comunidad de Mautic, me di cuenta de que las campañas y los correos electrónicos son elementos fundamentales de Mautic. Usando Mautibox para la versión 3, probé la documentación sobre las campañas y descubrí que necesita una gran renovación. Estos son algunos problemas que encontré y mi propuesta para cada uno:
- Un usuario de Mautic puede elegir entre una variedad de acciones, decisiones y condiciones mientras crea una campaña. Falta la documentación de muchas acciones y decisiones, y casi no hay documentación para las condiciones de la campaña. Necesitamos identificar y agregar la información faltante al documento del usuario final.
- Las campañas pueden ser simples o muy complejas. La documentación actual no agrega mucho valor a los usuarios que crean campañas por primera vez. Te propongo identificar algunos casos de uso (tanto simples como complejos) y crear flujos de trabajo de muestra (ya sea en forma de instructivos paso a paso, temas dentro de la guía para el usuario final o videos de explicación) a los que un usuario que usa la plataforma por primera vez pueda consultar antes de comenzar a crear sus propias campañas.
- La información debe presentarse de forma más organizada y ordenada en esta sección. Para aumentar la usabilidad, se debe seguir un enfoque basado en tareas y conceptos. Los temas pueden usar tablas para presentar información sobre acciones, decisiones y condiciones. El tema "Cómo usar activadores de fecha" parece estar un poco fuera de lugar. Se puede anidar en Condiciones.
Además de Campañas, también probé la documentación de los correos electrónicos en la IU. Esto es en lo que propongo trabajar:
- El contenido dinámico para correos electrónicos está disponible para las plantillas de correo electrónico de código personalizado (tanto para los correos electrónicos de plantillas como para los de segmentos), pero actualmente no hay documentación al respecto. Agrega detalles sobre el contenido dinámico y cómo configurarlo, junto con algunos ejemplos.
- Agrega un tema independiente para la supervisión de correos electrónicos. Esto puede incluir información sobre el uso de los widgets de correo electrónico disponibles en el panel y cómo se pueden usar para hacer un seguimiento de las métricas y actividades relacionadas con el correo electrónico. Además, mueve la información sobre los correos electrónicos de seguimiento aquí.
- En la documentación, no se especifica claramente que las respuestas de los contactos, la administración de rebotes y el propietario del correo electrónico son parámetros de configuración globales que se pueden configurar en la Configuración de correo electrónico. Toda la configuración de correo electrónico debe estar incluida en un tema general. Además, muchos otros parámetros de configuración de correo electrónico, como las reglas de frecuencia predeterminadas y la configuración de anulación de la suscripción, no están documentados en absoluto. Menciona qué parámetros de configuración son obligatorios o opcionales.
- En la página de administración de rebotes, quita toda la información sobre los webhooks y colócala en un tema independiente para ellos. Luego, podemos proporcionar un vínculo a ese tema desde aquí.
Además: - El tema Panel tiene información incompleta sobre los widgets disponibles. Esta información es importante y debe agregarse, ya que ayuda a los usuarios a analizar y supervisar sus recursos de Mautic.
Se debe revisar toda la documentación para identificar las brechas. Necesitamos renovar el documento para que sea más accesible para los usuarios.
¿Cómo espero que mis conocimientos o experiencia sean beneficiosos para este proyecto?
Después de trabajar en varios problemas de la documentación de Mautic, incluida la adición de compatibilidad con la versión más reciente de Mautic 3.0 durante el último mes, pude familiarizarme con la estructura de la documentación para el usuario final y también identificar las carencias en la documentación. Pasé tiempo investigando la documentación de otras herramientas de automatización de marketing y comparándola con la documentación para usuarios finales de Mautic para comprender cómo podemos llenar esas brechas en nuestra documentación. Mi familiaridad con el lenguaje HTML, las herramientas y los procesos de código abierto es una ventaja adicional. Actualmente, estoy realizando un curso sobre investigación de experiencia del usuario y puedo aplicar los principios para crear documentación más orientada al usuario. Además, con mi experiencia en arquitectura de la información, podré organizar el contenido y proponer ideas para alinear nuestra documentación con los objetivos de los usuarios. Además, tengo la capacidad de expandir mis conocimientos sobre nuevos dominios técnicos. Con 10 años de experiencia en redacción técnica y mi experiencia previa en GSOD de completar con éxito un proyecto para una organización en un dominio técnico que era completamente nuevo para mí, estoy seguro de que podré hacer justicia con mi contribución a la documentación de Mautic.