Progetto WordPress

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

Riepilogo del progetto

Organizzazione open source:
WordPress
Technical writer:
dmivelli
Nome progetto:
Migliorare la rilevabilità degli articoli nella documentazione dell'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ù comunemente usata è l'inglese (71%), seguito dallo spagnolo (4,7) e dall'indonesiano (2,4).

Un'ottima documentazione tecnica è alla base di qualsiasi sistema di assistenza. Tech writer esperti realizzano le conoscenze dei contenuti per gli utenti. In quel momento, gli utenti vogliono compiere azioni che ritieni importanti o richieste. I bravi Technical Writer comprendono che una documentazione ben scritta e accurata e la capacità di "imparare" all'utente sono essenziali. Tuttavia, ciò che può essere più importante per un Technical Writer, come la qualità editoriale e di produzione, può essere meno importante per gli utenti rispetto alla tempestività e alla visibilità. A cosa serve un argomento della guida ben scritto se l'utente non riesce a trovarlo?

Sin dalla sua nascita nel 2003, la crescita di WordPress nell'ambito 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 mutevoli esigenze della community di WordPress.

Quando i percorsi degli utenti verso la documentazione richiesta sono poco chiari o interrotti, la ricerca non riesce, perde la fiducia nel prodotto e potrebbe abbandonare del tutto il prodotto.

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

  1. Decidi e imposta lo stile per i titoli delle categorie
  2. Valuta i titoli delle categorie e assicurati che affrontino correttamente gli argomenti (proponi aggiornamenti, se necessario)
  3. Esamina gli articoli e assicurati che le classificazioni siano corrette
  4. Definisci le sottocategorie per ogni articolo
  5. Assicurati che nessun risultato di ricerca guidi gli utenti verso i forum di assistenza
  6. Prendi nota di argomenti duplicati o obsoleti da eliminare

La community di WordPress ha portato a termine un lavoro eccezionale e condivide i traguardi raggiunti negli ultimi 17 anni. Aggiornare la classificazione e assicurare che il percorso dell'utente sia accurato continuerà a far crescere 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 "The Hero's Journey". Nella fiction si riferisce al concetto strutturale in cui il protagonista viaggia nel mondo, affronta e supera sfide e i resi si trasformano.

Nell'ambito della documentazione tecnica, l'utente intraprende inoltre un percorso che lo porta agli argomenti della guida con l'obiettivo di apprendere, ottenere risposte e risolvere i problemi. Quando l'utente è in grado di farlo, tutto va bene. Quando gli utenti non riescono a trovare le risposte, restano frustrati e scoraggiati.

Ma perché succede? Non è perché gli sceneggiatori tagliano le spalle, non siano interessati o non abbiano conoscenze specifiche. Spesso, il fatto che il Technical Writer non abbia preso in considerazione il percorso dell'utente Gli autori potrebbero immergersi nella creazione di buoni contenuti, ma non considerare il modo in cui l'utente accederà all'argomento. Concentrarsi sul percorso dell'utente è fondamentale. Dobbiamo considerare ciò che vogliono sapere e come vogliono raggiungerlo.

Ho parlato con la consulente WordPress e la designer UX Estela Rueda, che ha fornito un po' di storia. Al momento, alcuni titoli non descrivono correttamente i contenuti dell'articolo. Le categorie vengono utilizzate come tag e alcune sono obsolete poiché sono state create 15 anni fa. Il tagging non è coerente. Questo crea ostacoli per gli utenti in cerca di risposte.

Stato attuale

L'assistenza di WordPress è suddivisa in nove categorie principali (Guida introduttiva, Installazione di WordPress, Utilizzo di base, Amministrazione di base, Personalizzazione, Manutenzione, Sicurezza, Argomenti avanzati, Risoluzione dei problemi). Ogni categoria contiene varie sottocategorie o argomenti secondari che portano ad articoli con la possibilità di aggiungerne altri in ogni pagina di destinazione.

Avere collaboratori entusiasti e collaborativi di WordPress offre molti vantaggi. Tuttavia, con molte voci e punti di vista, i tag e le categorie sono incoerenti.

È necessario modernizzare questi argomenti per garantire che le categorie soddisfino le attuali esigenze degli utenti di WordPress. Con oltre 200 articoli, i problemi relativi a tag e classificazioni sono diventati rilevanti.

Analisi del piano

L'obiettivo principale è esaminare e riclassificare gli articoli per migliorare la ricercabilità. Ti propongo di procedere nel seguente modo:

  1. Collabora con la mentore Estela Rueda per consolidare il processo

    • Si tratta di un passaggio importante per garantire che i dettagli vengano confermati e concordati
    • Per 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. Decidi e imposta lo stile per i titoli delle categorie

    • Suggerisco una struttura uniforme e coerente per le categorie al presente, anziché la forma gerundio (installazione o installazione), poiché la forma gerundio (-ing) può creare difficoltà per gli utenti che usano l'inglese come seconda lingua (ESL) e -ing non aggiunge valore per l'utente.
    • Alcune categorie sono argomenti composti da una o due parole (come Manutenzione, Sicurezza, Amministrazione di base) e altre sono frasi gerundli (Introduzione a WordPress, Personalizzazione). È sensato discutere della coerenza della struttura
    • Ho cercato in che modo altre organizzazioni configurano la propria guida online 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 WordPress e soddisfare le sue esigenze attuali
    • Verifica che siano coerenti e che rispettino gli standard della guida di stile di WordPress
    • Assicurati che i titoli trasmettano/spiegano l'intenzione
    • I titoli devono chiarire eventuali azioni prerequisiti obbligatorie o stati dell'utente/del dispositivo

  4. Consulta articoli/argomenti

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

  5. Definire e taggare le sottocategorie

    • Fai riferimento alle storie utente e continua ad aggiungerle al foglio di lavoro come riferimento futuro
    • Continua ad aggiungere elementi all'elenco delle sottocategorie e fornisci dettagli sul percorso

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

  7. Annota argomenti duplicati o obsoleti da eliminare; queste attività forensi ti aiuteranno a prendere decisioni più consapevoli e a semplificare i percorsi degli utenti.

Sequenza

Fino al 16 agosto 2020

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

17 agosto - 13 settembre

  • Scopri e lavora con Estela e la community di WordPress
  • Collabora con Estela per perfezionare i passaggi del progetto e suggerire gli obiettivi da completare
  • Crea un programma per includere traguardi e attività settimanali
  • Imposta una cadenza per un controllo dello stato con Estela (per affrontare tempestivamente eventuali blocchi)

14 settembre - 30 novembre

  • Lancio del progetto e lavoro di sviluppo con Estela/mentors

2-5 dicembre

  • Invio del report finale sul prodotto di lavoro

3-10 dicembre

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

Conclusione

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

Con questo grado di popolarità, una documentazione accurata e facile da seguire è un must per conquistare l'utente di WordPress.

Prendendo in considerazione il percorso dell'utente e le domande alla base dei possibili percorsi degli utenti, WordPress può modernizzare le categorie di assistenza e il tagging per rispondere in modo efficace alle domande e risolvere i problemi. In questo modo, WordPress continuerà ad attirare clienti soddisfatti per gli anni a venire.