Esta página contiene 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:
- Máuticos
- Escritor técnico:
- Swati Thacker
- Nombre del proyecto:
- Revisa y actualiza la documentación para usuarios finales de Mautic
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Mis primeras impresiones al revisar la documentación existente:
Actualmente, la documentación es larga, redundante en muchos lugares, está incompleta y desordenada, lo que puede dificultar que los usuarios encuentren la información que buscan.
Como usuario nuevo, no entendía cómo se combinan diferentes elementos de Mautic, como las campañas, los recursos, los mensajes, las categorías, etc., para resolver una necesidad empresarial. Propongo tener un tema conceptual de alto nivel que describa cada elemento Mautic en 2 o 3 líneas. Este tema puede, a su vez, vincular a los diversos temas de tareas detallados para cada uno de estos elementos.
La guía de contribución se puede expandir para incluir más información, como cómo abrir un problema, cómo sugerir contenido o ideas nuevos, informar errores, problemas o vulnerabilidades de seguridad, etc. mediante vínculos a foros, canales de slack y repositorios de Git. Además, la guía de estilo debe ampliarse para agregar convenciones tipográficas estándar, pautas para imágenes, tablas, etc.
Además, hay bastante información incompleta en los correos electrónicos, las campañas y la información antigua o desactualizada que se debe actualizar.
Me gustaría contribuir:
Mientras revisaba los debates 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. Con Mautibox para la versión 3, probé la documentación sobre Campañas y descubrí que necesita una renovación intensa. Estos son algunos de los 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 sobre las condiciones de la campaña. Debemos identificar y agregar la información que falta en el documento para usuarios finales.
- Las campañas pueden ser simples o muy complejas. La documentación actual no agrega mucho valor para los usuarios que crean campañas por primera vez. 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 o temas dentro de la guía del usuario final o de videos explicativos) que los usuarios nuevos puedan 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. Se debe seguir un enfoque basado en tareas y conceptos para aumentar la facilidad de uso. Los temas pueden usar tablas para presentar información sobre acciones, decisiones y condiciones. El tema "Usar activadores de fecha" parece estar un poco fuera de lugar. Puede anidarse en Condiciones.
Además de las campañas, también probé la documentación de los correos electrónicos en la IU. Esto es en lo que te propongo trabajar:
- El contenido dinámico para correos electrónicos está disponible para las plantillas de correo electrónico con código personalizado (tanto para correos electrónicos de Plantillas como para correos electrónicos de segmentos), pero, por el momento, no hay documentación al respecto. Agrega detalles sobre lo que hace el contenido dinámico y cómo configurarlo, junto con algunos ejemplos.
- Agrega un tema aparte para los correos electrónicos de Monitoring. Esto puede incluir información sobre el uso de los widgets de correo electrónico disponibles en el panel y cómo se pueden utilizar para realizar un seguimiento de las métricas y actividades relacionadas con el correo electrónico. Además, mueve aquí la información sobre los correos electrónicos de seguimiento.
- En la documentación, no se aclara que las respuestas de contactos, la administración de rebote y el correo electrónico son propietarios, sino que son parámetros de configuración globales que se pueden establecer en Configuración de correo electrónico. Todos los parámetros de configuración del correo electrónico deben incluirse en un tema general. Además, no se documentan 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 suscripciones. Menciona qué configuración es obligatoria u opcional.
- En la página Administración de rebote, quita toda la información sobre webhooks y colócala en un tema independiente. A continuación, 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 se debe agregar, ya que ayuda a los usuarios a analizar y supervisar sus recursos de Mautic.
Es necesario almacenar toda la documentación para identificar las brechas. Debemos renovarlas para hacer que el documento sea más accesible para los usuarios.
¿Cómo creo que mi conocimiento o experiencia serán beneficiosos para este proyecto?
Después de trabajar en varios problemas en la documentación de Mautic, incluida la compatibilidad de agregar compatibilidad con la última versión de Mautic 3.0 durante el mes pasado, pude familiarizarme con la estructura de la documentación para usuarios finales e identificar los vacíos en la documentación. Me dediqué a investigar y comparar la documentación de otras herramientas de automatización de marketing con la documentación para usuarios finales de Mautic, a fin de comprender cómo podíamos llenar esos vacíos en nuestra documentación. Mi conocimiento del lenguaje HTML, las herramientas de código abierto y los procesos es una ventaja adicional. Actualmente estoy realizando un curso en investigación de la experiencia del usuario y puedo aplicar los principios para crear documentación que esté más orientada al usuario. Además, con mi experiencia en la arquitectura de la información, podré organizar contenido y proponer ideas para alinear nuestra documentación con los objetivos de los usuarios. Además, tengo la habilidad de ampliar mis conocimientos sobre los nuevos dominios técnicos. Con 10 años de experiencia en escritura 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 por mi contribución a la documentación de Mautic.