Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Mautic
- Rédacteur technique:
- Swati Thacker
- Nom du projet:
- Consulter et mettre à jour la documentation destinée aux utilisateurs finaux pour Mautic
- Durée du projet:
- Durée standard (3 mois)
Project description
Premières impressions lors de la consultation de la documentation existante:
Actuellement, la documentation est longue, redondante à de nombreux endroits, incomplète et désordonnée, ce qui peut compliquer la recherche des informations des utilisateurs.
En tant que nouvel utilisateur, je ne comprenais pas comment les différents éléments de Mautic, tels que les campagnes, les composants, les messages, les catégories, etc., s'imbriquaient pour répondre à un besoin commercial. Je propose d'avoir un sujet conceptuel d'ordre général qui décrit chaque élément Mautic en deux ou trois lignes. Cette rubrique peut à son tour contenir un lien vers les différentes rubriques détaillées sur les tâches pour chacun de ces éléments.
Vous pouvez développer ce guide pour y inclure des informations supplémentaires : comment signaler un problème, suggérer de nouveaux contenus ou de nouvelles idées, signaler des bugs, des problèmes ou des failles de sécurité, etc., en fournissant des liens vers des forums, des chaînes Slack et des référentiels Git. Le guide de style doit également être étendu pour inclure des conventions typographiques standards, des consignes concernant les images, les tableaux, etc.
De plus, de nombreuses informations sont incomplètes dans les e-mails et les campagnes, et d'anciennes informations doivent être mises à jour.
Le domaine dans lequel je souhaite contribuer:
En parcourant les discussions sur les canaux Slack où les utilisateurs interagissent directement avec la communauté Mautic, j'ai réalisé que les campagnes et les e-mails sont des éléments cruciaux de Mautic. J'ai testé la documentation sur les campagnes avec Mautibox pour la version 3 et j'ai constaté qu'elle devait être entièrement remaniée. Voici quelques problèmes que j'ai détectés et ma proposition pour chacun d'eux:
- Un utilisateur Mautic peut choisir parmi différentes actions, décisions et conditions lorsqu'il crée une campagne. Il manque de documentation pour de nombreuses actions et décisions, et il n'existe quasiment aucune documentation sur les conditions des campagnes. Nous devons identifier et ajouter les informations manquantes au document destiné à l'utilisateur final.
- Les campagnes peuvent être simples ou très complexes. La documentation actuelle n'apporte pas beaucoup de valeur aux utilisateurs qui créent des campagnes pour la première fois. Je propose d'identifier quelques cas d'utilisation (simples et complexes) et de créer des exemples de flux de travail (sous la forme de tutoriels détaillés, ou de sujets dans le guide de l'utilisateur final ou les vidéos de présentation) auxquels un nouvel utilisateur pourra se référer avant de commencer à créer ses propres campagnes.
- Les informations doivent être présentées de manière plus organisée et ordonnée dans cette section. L'approche basée sur les tâches et les concepts doit être suivie pour accroître la convivialité. Les sujets peuvent utiliser des tableaux pour présenter des informations sur les actions, les décisions et les conditions. Le sujet "Utiliser des déclencheurs de date" semble un peu déplacé. Il peut être imbriqué sous "Conditions".
En plus des campagnes, j'ai également testé la documentation sur les e-mails par rapport à l'interface utilisateur. Voici ce que je propose de travailler:
- Le contenu dynamique pour les e-mails est disponible pour les modèles d'e-mails avec code personnalisé (pour les e-mails de modèles et les e-mails de segments), mais il n'existe actuellement aucune documentation à ce sujet. Détaillez le fonctionnement du contenu dynamique et la façon de le configurer, ainsi que quelques exemples.
- Ajoutez un sujet distinct pour les e-mails Monitoring. Il peut s'agir d'informations sur l'utilisation des widgets de messagerie disponibles dans le tableau de bord et sur la façon dont ils peuvent être utilisés pour suivre les métriques et les activités liées aux e-mails. Déplacez également les informations sur le suivi des e-mails ici.
- La documentation ne précise pas clairement que les réponses des contacts, la gestion des erreurs de retour et le propriétaire du service de messagerie sont des paramètres de configuration globaux qui peuvent être configurés sous "Paramètres de messagerie". Tous les paramètres de messagerie doivent être regroupés dans une rubrique générale. Par ailleurs, de nombreux autres paramètres de messagerie, tels que les règles de fréquence par défaut et les paramètres de désabonnement, ne sont pas du tout documentés. Indiquez les paramètres obligatoires ou facultatifs.
- Sur la page de gestion des rebonds, supprimez toutes les informations sur les webhooks et placez-les dans un sujet distinct. Nous pourrons ensuite vous fournir un lien vers ce sujet.
En outre : - Le thème "Tableau de bord" contient des informations incomplètes sur les widgets disponibles. Ces informations sont importantes et doivent être ajoutées, car elles aident les utilisateurs à analyser et à surveiller leurs ressources Mautic.
L'ensemble de la documentation doit être examiné pour identifier les lacunes. Nous devons revoir le document pour le rendre plus accessible à nos utilisateurs.
En quoi mes connaissances/expérience seront-elles utiles pour ce projet ?
Au cours du mois dernier, j'ai travaillé sur divers problèmes de la documentation Mautic, y compris l'ajout de la prise en charge de la dernière version Mautic 3.0. J'ai ainsi pu me familiariser avec la structure de la documentation destinée aux utilisateurs finaux et identifier les lacunes. J'ai passé du temps à consulter la documentation d'autres outils d'automatisation du marketing et à la comparer à la documentation destinée aux utilisateurs finaux de Mautic pour comprendre comment combler ces lacunes dans notre documentation. Ma connaissance du langage HTML, des outils Open Source et des processus est un avantage supplémentaire. Je suis actuellement un cours de recherche sur l’expérience utilisateur et je peux appliquer les principes pour créer une documentation plus axée sur l’utilisateur. De plus, grâce à mon expérience en architecture de l'information, je pourrai organiser le contenu et proposer des idées pour aligner notre documentation sur les objectifs des utilisateurs. De plus, j'ai le don d'élargir mes connaissances dans de nouveaux domaines techniques. Avec 10 ans d'expérience en rédaction technique et mon expérience précédente de GSOD ayant abouti à la réussite d'un projet pour une organisation dans un domaine technique qui m'était totalement nouveau, je suis sûr de pouvoir contribuer à la documentation Mautic.