Progetto Mautic

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.

Riepilogo del progetto

Organizzazione open source:

Mauca

Technical writer:

Swati Thacker

Nome progetto:

Esamina e aggiorna la documentazione per l'utente finale relativa a Mautic

Durata del progetto:

Durata standard (3 mesi)

Project description

Le mie prime impressioni dopo aver esaminato la documentazione esistente:

Attualmente, la documentazione è lunga, ridondante in molti punti, incompleta e disordinata, il che potrebbe rendere difficile per gli utenti trovare le informazioni che cercano.

Come nuovo utente, non riuscivo a capire in che modo diversi elementi di Mautic, come campagne, asset, messaggi, categorie e così via, si integrano tra loro per soddisfare un'esigenza aziendale. Propongo di avere un argomento concettuale di alto livello che descriva ogni elemento Mautic in 2-3 righe. Questo argomento può a sua volta collegare ai vari argomenti dettagliati delle attività per ciascuno di questi elementi.

La guida può essere ampliata per includere maggiori informazioni, ad esempio come aprire un problema, come suggerire nuovi contenuti/idee, segnalare bug/problemi/vulnerabilità di sicurezza e così via, fornendo link a forum, canali slack e repository Git. Inoltre, la guida di stile deve espandersi per aggiungere convenzioni tipografiche standard, linee guida per immagini, tabelle e così via.

Inoltre, ci sono un po' di informazioni incomplete in Email, Campagne e informazioni vecchie/obsolete che devono essere aggiornate.

Area in cui vorrei contribuire:

Esaminando le discussioni sui canali Slack in cui gli utenti interagiscono direttamente con la community di Mautic, ho capito che le campagne e le email sono elementi fondamentali di Mautic. Utilizzando Mautibox per la versione 3, ho testato la documentazione su Campagne e ho scoperto che necessitava di un rinnovamento intensivo. Ecco alcuni problemi che ho riscontrato e la mia proposta per ciascuno:

• Un utente Mautic può scegliere tra una serie di azioni, decisioni e condizioni durante la creazione di una campagna. Per molte azioni e decisioni manca la documentazione, mentre non esiste quasi alcuna documentazione per le condizioni delle campagne. Dobbiamo identificare e aggiungere le informazioni mancanti al documento dell'utente finale.
• Le campagne possono essere semplici o molto complesse. La documentazione attuale non è molto utile per gli utenti che creano campagne per la prima volta. Propongo di identificare alcuni casi d'uso (semplici e complessi) e di creare flussi di lavoro di esempio (sotto forma di tutorial passo-passo o argomenti all'interno della guida per l'utente finale o di video tutorial) a cui un nuovo utente può consultare prima di iniziare a creare le proprie campagne.
• In questa sezione le informazioni devono essere presentate in modo più organizzato e ordinato. È necessario seguire un approccio basato sulle attività e sui concetti per aumentare l’usabilità. Gli argomenti possono utilizzare le tabelle per presentare informazioni su azioni, decisioni e condizioni. L'argomento "Utilizzo degli attivatori per le date" sembra un po' fuori luogo. Può nidificare in Condizioni.

Oltre alle campagne, ho anche testato la documentazione relativa alle email rispetto all'interfaccia utente. Ecco su cosa propongo di lavorare:

• Dynamic Content for Emails è disponibile per i modelli di email con codice personalizzato (sia per le email Modelli sia per le email Segmenti), ma al momento non è disponibile documentazione in merito. Aggiungi informazioni dettagliate sulla funzionalità dei contenuti dinamici e su come impostarli, oltre ad alcuni esempi.
• Aggiungi un argomento separato per le email di Monitoring. Queste informazioni possono includere informazioni sull'utilizzo dei widget email disponibili nella dashboard e su come possono essere utilizzati per tenere traccia di metriche e attività relative all'email. Inoltre, sposta qui le informazioni sul monitoraggio delle email.
• La documentazione non chiarisce che le risposte ai contatti, la gestione del rimbalzo, il mailer sono il proprietario: sono impostazioni di configurazione globali che possono essere configurate in Impostazioni email. Tutte le impostazioni email devono rientrare in un argomento generale. Inoltre, molte altre impostazioni email, come le regole di frequenza predefinite e le impostazioni di annullamento dell'iscrizione, non sono documentate. Indica quali impostazioni sono obbligatorie o facoltative.
• Dalla pagina Gestione rimbalzo, rimuovi tutte le informazioni sui webhook e inseriscile in un argomento separato per i webhook. Possiamo quindi fornire un link all'argomento da qui.

Inoltre: - L'argomento Dashboard contiene informazioni incomplete sui widget disponibili. Queste informazioni sono importanti e devono essere aggiunte perché aiutano gli utenti ad analizzare e monitorare le risorse Mautic.

È necessario raccogliere l'intera documentazione per individuare eventuali lacune. Dobbiamo rinnovarci per rendere il documento più accessibile da parte dei nostri utenti.

In che modo mi aspetto che le mie conoscenze/esperienza siano utili per questo progetto?

Dopo aver lavorato a vari problemi nella documentazione di Mautic, tra cui l'aggiunta del supporto per l'ultima release di Mautic 3.0 nell'ultimo mese, ho potuto acquisire familiarità con la struttura della documentazione per l'utente finale e identificare le lacune nella documentazione. Ho dedicato del tempo a fare ricerche sulla documentazione relativa ad altri strumenti di marketing automation e a confrontarla con quella di Mautic per gli utenti finali, per capire come possiamo colmare queste lacune nella nostra documentazione. La mia familiarità con il linguaggio HTML, gli strumenti e i processi open source è un ulteriore vantaggio. Al momento sto seguendo un corso di ricerca sull'esperienza utente e posso applicare i principi per creare una documentazione più orientata agli utenti. Inoltre, grazie alla mia esperienza nell'architettura delle informazioni, sarò in grado di organizzare contenuti e proporre idee per allineare la nostra documentazione agli obiettivi degli utenti. Inoltre, ho un talento per ampliare le mie conoscenze su nuovi domini tecnici. Con 10 anni di esperienza nella scrittura tecnica e la mia precedente esperienza con il GSOD nel completamento di un progetto per un'organizzazione in un settore tecnico per me completamente nuovo, sono sicura di poter rendere giustizia al mio contributo alla documentazione di Mautic.