Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Matautique
- Rédacteur technique:
- Swati Thacker
- Nom du projet:
- Examiner 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 lorsque je consulte la documentation existante:
Actuellement, la documentation est longue, redondante dans de nombreux endroits, incomplète et désordonnée, ce qui peut empêcher les utilisateurs de trouver les informations qu'ils recherchent.
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'intègrent pour répondre à un besoin commercial. Je propose d'aborder un sujet conceptuel de haut niveau qui décrit chaque élément mautique en 2 ou 3 lignes. Cette rubrique peut à son tour contenir un lien vers les différentes tâches détaillées pour chacun de ces éléments.
Vous pouvez développer le guide pour y inclure des informations supplémentaires, par exemple sur la manière de signaler un problème, de suggérer de nouveaux contenus/idées, de signaler des bugs, des problèmes ou des failles de sécurité, en fournissant des liens vers des forums, des canaux Slack et des dépôts Git. En outre, le guide de style doit être élargi pour y ajouter des conventions typographiques standard, des directives pour les images, les tableaux, etc.
En outre, les e-mails et les campagnes comportent un grand nombre d'informations incomplètes et des informations obsolètes qu'il faut mettre à jour.
Domaine dans lequel je souhaite contribuer:
En parcourant les discussions sur les chaînes Slack où les utilisateurs interagissent directement avec la communauté Mautic, j'ai réalisé que les campagnes et les e-mails étaient des éléments cruciaux de Mautic. En utilisant MautBot pour la version 3, j'ai testé la documentation sur l'onglet "Campagnes" et j'ai découvert qu'elle devait être remaniée en profondeur. Voici quelques problèmes que j'ai détectés, ainsi que ma proposition pour chacun d'eux:
- Lorsqu'il crée une campagne, un utilisateur Mautic peut choisir parmi un large éventail d'actions, de décisions et de conditions. La documentation est manquante pour de nombreuses actions et décisions, alors qu'il n'existe pratiquement aucune documentation sur les conditions de la campagne. Nous devons identifier les informations manquantes et les ajouter au document de l'utilisateur final.
- Les campagnes peuvent être simples ou très complexes. La documentation actuelle n'est pas très utile pour les utilisateurs qui créent des campagnes pour la première fois. Je propose d'identifier certains cas d'utilisation (simples et complexes) et de créer des exemples de flux de travail (soit sous la forme de tutoriels détaillés, soit de sujets dans le guide de l'utilisateur final ou de vidéos de présentation) auxquels un nouvel utilisateur peut 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. Une approche basée sur les tâches et les concepts doit être suivie pour améliorer la convivialité. Les sujets peuvent utiliser des tableaux pour présenter des informations sur les actions, les décisions et les conditions. Le thème "Utiliser des déclencheurs de date" semble un peu déplacé. Elle peut s'imbriquer dans "Conditions".
En plus des campagnes, j'ai également testé la documentation concernant les e-mails par rapport à l'interface utilisateur. Voici ce sur quoi je me propose de travailler:
- Le contenu dynamique pour les e-mails est disponible pour les modèles d'e-mail avec code personnalisé (à la fois pour les modèles d'e-mails et les e-mails de segments), mais il n'existe actuellement aucune documentation à ce sujet. Précisez à quoi sert le contenu dynamique, comment 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 les e-mails de suivi ici.
- La documentation n'indique pas clairement que, dans les paramètres de messagerie, les réponses aux contacts, la gestion des notifications de non-distribution et le destinataire sont des paramètres généraux de configuration. Tous les paramètres de messagerie doivent être regroupés dans un même sujet. De plus, 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 documentés du tout. Indiquez les paramètres obligatoires ou facultatifs.
- Sur la page de gestion des rebonds, supprimez toutes les informations concernant les webhooks et placez-les dans une rubrique distincte pour les webhooks. Nous pourrons ensuite fournir un lien vers ce sujet à partir d'ici.
En outre : - La rubrique "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 accaparé pour identifier les lacunes. Nous devons remanier le document afin de le rendre plus accessible à nos utilisateurs.
Comment m'attendre à ce que mes connaissances/expériences soient utiles à ce projet ?
Après avoir travaillé sur différents problèmes dans la documentation de Mautic, y compris la prise en charge de la dernière version de Mautic 3.0 au cours du mois dernier, j'ai pu me familiariser avec la structure de la documentation de l'utilisateur final et également identifier les lacunes dans la documentation. J'ai passé du temps à rechercher la documentation concernant d'autres outils d'automatisation marketing et à comparer celle-ci à celle de Mautic pour l'utilisateur final afin de comprendre comment nous pouvons combler ces lacunes dans notre documentation. Ma connaissance du langage HTML, des outils et des processus Open Source est un avantage supplémentaire. Je suis actuellement en recherche d’expérience utilisateur et je peux appliquer les principes pour créer une documentation plus orientée utilisateur. Grâce à mon expérience en architecture des informations, je serai en mesure d'organiser des contenus et de proposer des idées pour adapter notre documentation aux objectifs des utilisateurs. De plus, j'ai un don pour élargir mes connaissances sur de nouveaux domaines techniques. Avec 10 ans d'expérience en rédaction technique et mon expérience du GSOD, que j'ai acquise lors de la réalisation réussie d'un projet pour une organisation dans un domaine technique qui était complètement nouveau pour moi, je serai sûr de pouvoir faire justice à ma contribution à la documentation Mautic.