Progetto WordPress

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

Riepilogo progetto

Organizzazione open source:
WordPress
Redattore tecnico:
dmivelli
Nome del progetto:
Migliorare la rilevabilità degli articoli nella documentazione di HelpHub di WordPress
Durata del progetto:
Durata standard (3 mesi)

Project description

Schema riepilogativo

La popolarità di WordPress cresce ogni minuto. All’inizio di luglio 2020, WordPress 5.4 (l’ultima versione rilasciata il 21 marzo 2020) è stato scaricato quasi 51 milioni di volte. La lingua più utilizzata è l'inglese (71%), seguita dallo spagnolo (4,7%) e dall'indonesiano (2,4%).

Una buona documentazione tecnica è la spina dorsale di qualsiasi sistema di assistenza. I redattori tecnici esperti trasformano le conoscenze in contenuti per gli utenti. Gli utenti vogliono eseguire un'azione che sia di valore per loro o richiesta in quel momento. I buoni autori di documentazione tecnica sanno che sono essenziali una documentazione accurata e ben scritta e la capacità di mettersi nei panni dell'utente. Tuttavia, ciò che può essere più importante per un autore tecnico, ad esempio la qualità redazionale e di produzione, potrebbe essere meno importante per gli utenti rispetto all'attualità e alla rilevabilità. A cosa serve un argomento del Centro assistenza scritto benissimo se l'utente non riesce a trovarlo?

Fin dal suo inizio nel 2003, la crescita di WordPress nel campo dell'open source ha attirato sviluppatori, utenti e collaboratori. Le categorie e i tag degli articoli originali devono essere aggiornati e modernizzati per stare al passo con la crescita e le esigenze in evoluzione della community di WordPress.

Quando i percorsi degli utenti alla documentazione richiesta sono confusi o interrotti, la ricerca non va a buon fine, perdono la fiducia nel prodotto e potrebbero abbandonarlo del tutto.

Esiste una soluzione. Di seguito sono riportati alcuni modi per migliorare la visibilità e supportare il percorso dell'utente verso la documentazione prevista:

  1. Scegli e imposta lo stile per i titoli delle categorie
  2. Valuta i titoli delle categorie e assicurati che descrivano correttamente gli argomenti (se necessario, proponi aggiornamenti)
  3. Consulta gli articoli e assicurati che le categorizzazioni siano corrette
  4. Definire le sottocategorie per ogni articolo
  5. Assicurati che nessun risultato di ricerca indirizzi gli utenti ai forum di assistenza
  6. Prendere nota degli argomenti duplicati o obsoleti da eliminare

La community di WordPress ha svolto un lavoro straordinario e ha condiviso i risultati degli ultimi 17 anni. L'aggiornamento della classificazione e la garanzia dell'accuratezza del percorso dell'utente continueranno a favorire la crescita, il successo e la fedeltà degli utenti che creano quasi 70 milioni di nuovi post e 77 milioni di nuovi commenti ogni mese.

Introduzione

L'autore Joseph Campbell ha coniato il termine "viaggio dell'eroe". Nella narrativa, si riferisce al concetto strutturale in cui il protagonista viaggia per il mondo, affronta e supera le sfide e ritorna trasformato.

Anche nel campo della documentazione tecnica, l'utente intraprende un percorso che lo porta agli argomenti della guida con l'obiettivo di imparare, ottenere risposte e risolvere i problemi. Quando l'utente riesce a farlo, tutto va bene. Quando gli utenti non riescono a trovare risposte, se ne vanno frustrati e scoraggiati.

Ma perché succede? Non è perché gli scrittori tagliano gli angoli, non se ne preoccupano o non possiedono le competenze necessarie. Spesso il problema è che il tecnico non ha considerato il percorso dell'utente. Gli autori potrebbero dedicarsi alla creazione di contenuti di qualità, ma non prendono in considerazione le modalità di accesso all'argomento da parte degli utenti. È fondamentale concentrarsi sul percorso dell'utente. Dobbiamo considerare cosa vogliono sapere e come vogliono raggiungere il loro obiettivo.

Ho parlato con Estela Rueda, consulente WordPress e UX designer, che mi ha fornito alcune informazioni storiche. Al momento, alcuni titoli non descrivono correttamente i contenuti dell'articolo. Le categorie vengono utilizzate come tag e poiché sono state create 15 anni fa, alcune sono obsolete. Il tagging non è coerente. Ciò crea ostacoli per gli utenti che cercano risposte.

Stato attuale

L'assistenza WordPress è suddivisa in nove categorie principali (Introduzione, Installazione di WordPress, Utilizzo di base, Amministrazione di base, Personalizzazione, Manutenzione, Sicurezza, Argomenti avanzati, Risoluzione dei problemi). Ogni categoria contiene diverse sottocategorie o sottoargomenti che rimandano ad articoli con la possibilità di visualizzarne altri in ogni pagina di destinazione.

I vantaggi di avere collaboratori di WordPress entusiasti e collaborativi sono che sono disponibili molti argomenti. Tuttavia, con così tante voci e punti di vista, i tag e le categorie non sono coerenti.

Questi argomenti devono essere modernizzati per garantire che le categorie soddisfino le esigenze attuali degli utenti di WordPress. Con più di 200 articoli, i problemi relativi a tag e classificazioni sono diventati pertinenti.

Analisi del piano

L'obiettivo principale è rivedere e riclassificare gli articoli per migliorarne la ricercabilità. Ti propongo i seguenti passaggi:

  1. Collabora con la mentore Estela Rueda per consolidare la procedura

    • Si tratta di un passaggio importante per garantire che i dettagli siano confermati e concordati
    • Come indicato da Estela, monitoreremo tutti gli aggiornamenti proposti in un foglio di lavoro (l'esperienza di Estela ha dimostrato che è meglio raccogliere e poi proporre consigli)

  2. Scegli e imposta lo stile per i titoli delle categorie

    • Suggerisco una struttura uniforme e coerente per le categorie al presente anziché al gerundio (Installazione e Installazione), in quanto la forma del gerundio (-ing) può creare difficoltà per gli utenti di inglese come seconda lingua (ESL) e il suffisso -ing non aggiunge valore all'utente
    • Alcune categorie sono costituite da soggetti di una o due parole (ad esempio Manutenzione, Sicurezza, Amministrazione di base) e altre da frasi con il gerundio (Introduzione a WordPress, Personalizzazione). È opportuno discutere di come rendere la struttura coerente
    • Sto cercando di capire in che modo altre organizzazioni configurano la guida in linea e ne parlerò con il mio mentore per capire cosa potrebbe essere utile

  3. Valutare i titoli delle categorie (e proporre aggiornamenti)

    • Dovrebbero essere riconoscibili dal punto di vista del pubblico di destinazione di WordPress e soddisfare le sue esigenze attuali
    • Verifica che siano coerenti e rispettino gli standard della guida di stile di WordPress
    • Assicurati che i titoli comunichino/spieghino l'intenzione
    • I titoli devono chiarire eventuali azioni di prerequisito richieste o stati dell'utente/del dispositivo

  4. Esamina articoli/argomenti

    • Gli argomenti soddisfano con precisione le esigenze degli utenti del pubblico di destinazione di WordPress?
    • Gli argomenti definiscono il contesto corretto o fanno parte di una sequenza più ampia?
    • I passaggi distinguono i vari attori dell'attività (utente, sistema/dispositivo, chi fa cosa)?
    • Gli attori sono chiaramente distinti?
    • I passaggi suddividono i processi complessi in blocchi utili?

  5. Definire e taggare le sottocategorie

    • Fai riferimento alle storie degli utenti e continua ad aggiungere elementi al foglio di lavoro come riferimento futuro.
    • Continua ad aggiungere articoli all'elenco di sottocategorie e fornisci dettagli sul loro percorso

  6. Assicurati che nessun risultato di ricerca indirizzi gli utenti ai forum di assistenza

  7. Prendi nota degli argomenti duplicati o obsoleti da eliminare; questo lavoro di analisi forense contribuirà a informare e semplificare i percorsi degli utenti

Cronologia

Fino al 16 agosto 2020

  • Continua a esaminare la documentazione di WordPress
  • Acquisire familiarità con lo stile della documentazione di WordPress
  • Cerca le best practice per i percorsi dei clienti negli argomenti della guida

17 agosto - 13 settembre

  • Conoscere ed interagire con Estela e la community di WordPress
  • Collabora con Estela per perfezionare i passaggi del progetto e suggerire i traguardi per il completamento
  • Crea una pianificazione che includa traguardi e attività settimanali
  • Stabilisci una cadenza per un controllo dello stato con Estela (per affrontare eventuali ostacoli in modo tempestivo)

14 settembre - 30 novembre

  • Lavoro di avvio e sviluppo del progetto con gli Estela/mentor

2-5 dicembre

  • Invia il report finale sul prodotto di lavoro

3-10 dicembre

  • Inviare una valutazione del successo del progetto e dell'esperienza di lavoro con i mentor e il team di WordPress

Conclusione

WordPress è il sistema di gestione dei contenuti (CMS) più utilizzato. Secondo W3techs, WordPress è il CMS preferito per il 37,7% di tutti i siti web, dando a WordPress una quota di mercato del 63,6%.

Con questo livello di popolarità, una documentazione accurata e facile da seguire è un must per conquistare il cuore dell'utente di WordPress.

Prendendo in considerazione il percorso dell'utente e le domande che forniscono informazioni sui possibili percorsi dell'utente, WordPress può modernizzare le categorie di assistenza e il tagging per rispondere efficacemente alle domande e risolvere i problemi. In questo modo, WordPress continuerà ad attirare clienti soddisfatti per gli anni a venire.