Progetto Mautic

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:

Mautic

Technical writer:

Spettatore swati

Nome progetto:

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

Durata del progetto:

Durata standard (3 mesi)

Project description

Le prime impressioni quando analizzo 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 stanno cercando.

Come nuovo utente, non riuscivo a capire in che modo diversi elementi di Mautic, come campagne, asset, messaggi, categorie e così via, si integrino 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 come risolvere un problema, 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 bel po' di informazioni incomplete nelle email, nelle campagne e nei dati obsoleti/obsoleti che devono essere aggiornati.

L'area in cui desidero contribuire:

Analizzando 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 necessita di un forte rinnovamento. 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 (sia semplici che 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 dei video di guida) a cui un nuovo utente può fare riferimento 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 sull'attività e sul concetto per aumentare l'usabilità. Gli argomenti possono utilizzare le tabelle per presentare informazioni su azioni, decisioni e condizioni. L'argomento "Utilizzo degli attivatori di data" sembra un po' fuori luogo. Può essere nidificata in Condizioni.

Oltre a "Campagne", ho testato anche la documentazione relativa alle email con l'interfaccia utente. Ecco su cosa propongo di lavorare:

• Dynamic Content for Emails è disponibile per i modelli di email di codice personalizzati (sia per le email Modelli che per le email Segmenti), ma al momento non è disponibile documentazione in merito. Aggiungi dettagli sulle funzionalità dei contenuti dinamici e su come impostarli, oltre ad alcuni esempi.
• Aggiungi un argomento separato per le email di Monitoring. Queste possono includere informazioni sull'utilizzo dei widget email disponibili sulla dashboard e su come possono essere utilizzati per tenere traccia di metriche e attività relative all'email. Sposta anche qui le informazioni sul monitoraggio delle email.
• La documentazione non chiarisce che le risposte dei contatti, la gestione dei messaggi rispediti al mittente, la busta sono il proprietario: si tratta di 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 loro risorse Mautic.

L'intera documentazione deve essere bloccata per identificare eventuali lacune. Dobbiamo rinnovarci per rendere il documento più accessibile ai nostri utenti.

In che modo mi aspetto che le mie conoscenze/esperienza possano essere vantaggiose per questo progetto?

Dopo aver lavorato a vari problemi nella documentazione di Mautic, tra cui l'aggiunta del supporto per l'ultima versione di Mautic 3.0 nell'ultimo mese, sono riuscito a familiarizzare con la struttura della documentazione per l'utente finale e a identificare le lacune nella documentazione. Ho dedicato del tempo alla ricerca della documentazione relativa ad altri strumenti di marketing automation e al confronto con la documentazione per l'utente finale di Mautic per capire come colmare queste lacune nella nostra documentazione. La mia familiarità con il linguaggio HTML, gli strumenti open source e i processi è un ulteriore vantaggio. Attualmente 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 i contenuti e proporre idee per allineare la nostra documentazione agli obiettivi degli utenti. Inoltre, ho un talento per ampliare la mia conoscenza di nuovi domini tecnici. Con 10 anni di esperienza di scrittura tecnica e la mia precedente esperienza nel GSOD nel completare con successo un progetto per un'organizzazione in un dominio tecnico per me completamente nuovo, sono sicura di poter rendere giustizia al mio contributo alla documentazione di Mautic.