Progetto Mautic

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo del progetto

Organizzazione open source:

Mautic

Redattore tecnico:

Swati Thacker

Nome del progetto:

Rivedi e aggiorna la documentazione dell'utente finale relativa a Mautic

Durata del progetto:

Durata standard (3 mesi)

Project description

Le mie prime impressioni esaminando 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 utente alle prime armi, non riuscivo a capire in che modo i diversi elementi di Mautic, come campagne, asset, messaggi, categorie e così via, si combinano per risolvere le esigenze di un'attività. Propongo di avere un argomento concettuale di alto livello che descriva ogni elemento matematico in 2-3 righe. Questo argomento può a sua volta fare riferimento ai vari argomenti delle attività dettagliate per ciascuno di questi elementi.

La guida per i collaboratori può essere ampliata per includere ulteriori 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 essere espansa per aggiungere convenzioni tipografiche standard, linee guida per immagini, tabelle e così via.

Inoltre, ci sono molte informazioni incomplete nelle email, nelle campagne e informazioni vecchie/obsolete che devono essere aggiornate.

L'area a cui vorrei dare il mio contributo:

Durante 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 cruciali di Mautic. Utilizzando Mautibox per la versione 3, ho testato la documentazione sulle campagne e ho scoperto che richiede un notevole aggiornamento. Ecco alcuni problemi che ho riscontrato e la mia proposta per ciascuno:

• Un utente di Mautic può scegliere tra una serie di azioni, decisioni e condizioni durante la creazione di una campagna. La documentazione non è disponibile per molte azioni e decisioni, mentre non esiste quasi nessuna documentazione per le condizioni della campagna. Dobbiamo identificare e aggiungere le informazioni mancanti al documento per l'utente finale.
• Le campagne possono essere semplici o molto complesse. La documentazione attuale non aggiunge molto valore agli 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, argomenti all'interno della guida per l'utente finale o video di procedura dettagliata) a cui un utente alle prime armi 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. Per aumentare l'usabilità, è necessario seguire un approccio basato su attività e concetti. Gli argomenti possono utilizzare tabelle per presentare informazioni su azioni, decisioni e condizioni. L'argomento "Utilizzo degli attivatori di date" sembra un po' fuori luogo. Può nidificarsi in Condizioni.

Oltre alle campagne, ho anche testato la documentazione per le email rispetto all'interfaccia utente. Ecco cosa propongo di fare:

• I contenuti dinamici per le email sono disponibili per i modelli email con codice personalizzato (sia per le email Modelli che per le email Segmenti), ma al momento non esiste alcuna documentazione relativa. Aggiungi dettagli su cosa fanno i contenuti dinamici e su come configurarli, oltre ad alcuni esempi.
• Aggiungi un argomento separato per il monitoraggio delle email. Sono incluse informazioni sull'utilizzo dei widget email disponibili nella dashboard e su come possono essere utilizzati per tenere traccia delle metriche e delle attività relative all'email. Inoltre, sposta qui le informazioni sul monitoraggio delle email.
• La documentazione non chiarisce che le risposte ai contatti, la gestione dei rimbalzi e il mittente 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 affatto documentate. Indica quali impostazioni sono obbligatorie o facoltative.
• Nella pagina di gestione dei rimbalzi, rimuovi tutte le informazioni sugli webhook e inseriscile in un argomento separato per gli webhook. Da qui possiamo fornire un link all'argomento.

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 acquisire l'intera documentazione per identificare le lacune. Dobbiamo rinnovarlo per rendere il documento più accessibile ai nostri utenti.

In che modo mi aspetto che le mie conoscenze/esperienze siano utili a 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 gli utenti finali e identificare anche le lacune nella documentazione. Ho dedicato del tempo alla ricerca della documentazione di altri strumenti di automazione del marketing e al confronto con la documentazione per gli utenti finali di Mautic per capire come colmare queste lacune nella nostra documentazione. La mia familiarità con il linguaggio HTML, gli strumenti e i processi open source è un vantaggio aggiuntivo. Attualmente sto seguendo un corso di ricerca sull'esperienza utente e posso applicare i principi per creare una documentazione più orientata all'utente. Inoltre, grazie alla mia esperienza in architettura dell'informazione, sarò in grado di organizzare i contenuti e proporre idee per allineare la nostra documentazione agli obiettivi degli utenti. Inoltre, ho un talento per espandere le mie conoscenze in nuovi domini tecnici. Con 10 anni di esperienza nella scrittura tecnica e la mia precedente esperienza GSOD di completamento di un progetto per un'organizzazione in un dominio tecnico completamente nuovo per me, sono sicuro di poter dare il mio contributo alla documentazione di Mautic.