Show More
Menu
Image
Hi there! I am Federico Trotta

Technical WriterFreelance

Come Si Misura La Qualità Della Documentazione?

Febbraio 19, 2024
By Federico
0 Comments
Post Image

Nel campo dell’ingegneria, misurare è l’unico modo per poter migliorare. Ma quando si parla di documentazione una domanda sorge spontanea: come si misura la qualità della documentazione?

Quando si parla di qualità, a me piace mantenere un approccio “manifatturiero”, nel senso che intendo la qualità come quel qualcosa che rende felice il cliente.

Ma come facciamo a sapere quel che rende felice il cliente a livello di documentazione?

Prima di tutto, è opportuno specificare che la qualità della documentazione (ma in realtà, questo vale per qualsiasi cosa) può essere verificata solo a posteriori. In altre parole, possiamo verificarla solo quando è stata messa in produzione e fruita dai clienti per un certo tempo.

Nella mia esperienza di Technical Writer ho trovato e provato 3 tipologie di approccio alla qualità della documentazione, e questo articolo le tratta tutte e tre.

Misurare la qualità della documentazione tramite analytics

Un primo approccio alla misurazione della qualità della documentazione è tramite analytics.

L’idea è quella di collegare il tuo sito documentale a strumenti tipo Google Analytics e misurare il traffico. Si possono prendere in considerazione tutte le metriche che si vuole, come si farebbe proprio per un sito. Per esempio:

  • Bounce rate.
  • Tempo medio e minimo di permanenza su una pagina.
  • Provenienze geografica degli utenti.

E molte altre.

Il punto di riferimento da tenere presente è che stiamo studiando la qualità della documentazione attraverso il traffico, il che è un po’ diverso dallo studiare il traffico su “un sito Internet qualunque”.

Quello che voglio dire è che dobbiamo farci delle domande specifiche, del tipo:

  • Gli utenti spendono “X” minuti giornalieri su questa pagina. Questo valore è molto più alto del tempo medio speso sulle altre pagine. Questo è un segno positivo o negativo? Ovvero: gli utenti ci spendono molto tempo perché questa pagina è molto lunga o perché il testo non è chiaro sul processo da seguire?
  • Gli utenti atterrano su questa pagina e ci spendono molto poco tempo. Significa che questa pagina della documentazione è molto chiara o che è inutile?

Misurare la qualità della documentazione tramite ticket di supporto o contatti al customer care

La documentazione è sempre importante, ma uno dei segnali chiari che dimostrano che la tua azienda ha bisogno della documentazione tecnica sono le innumerevoli richieste che i clienti fanno al supporto, al customer care, ai sales, o a chiunque si interfacci con loro.

Un ottimo modo per verificare la qualità della documentazione, quindi, è valutare la differenza tra i ticket di supporto (o le mail ricevuto dal customer care o dai sales) da quando hai iniziato ad implementare la documentazione.

In generale, una buona documentazione farà sì che il numero di ticket o di email decresca nel tempo.

Bisogna però fare attenzione ad una cosa:

E’ naturalmente impossibile che i ticket o le mail si azzerino. Prendi in considerazione il fatto che le persone non leggono e vogliono soluzioni immediate. Non c’è nulla che non vada nella tua documentazione, quindi, se le richieste non si azzerano. Però pensa che, da quando la documentazione sarà in produzione, molte richieste potranno ottenere in risposta qualcosa del tipo “Caro cliente, per sapere come utilizzare questa feature al meglio, ti invitiamo a leggere la documentazione del nostro prodotto a questo link”.
Zero sforzi, ticket chiuso in un solo tocco.

Misurare la qualità della documentazione tramite survey a risposta diretta

Il modo migliore per avere risposte è…fare domande!

Nel caso specifico, la qualità della documentazione può essere verificata inviando delle survey ai clienti.

In questo caso, è opportuno tenere presente che i tuoi clienti sono molto impegnati, esattamente come lo sei tu. Quindi, chi utilizza il tuo software avrà sicuramente voglia di aiutarti a capire come migliorare il sevizio nei loro confronti, ma non creare una surve da mezz’ora.

L’idea di base, almeno per una primissima survey, è quella di fare domande sulle parti della documentazione che credi possano essere un pochino dubbie e lasciare lo spazio per chiedere direttamente ai clienti possibili aree da migliorare che non siano state menzionate.

Naturalmente, questo tipo di approccio alla qualità della documentazione funziona quando hai abbastanza clienti tali per cui le risposte alla survey abbiano senso statisticamente. Per dare un’idea, ha senso farlo quando hai qualche decina di clienti (perché qualcuno, ovviamente, non risponderà!)

Conclusioni

Benissimo, quindi quale metodo utilizzare per verificare la qualità della documentazione?

La risposta è…dipende!

In generale, una combinazione di tutti e tre può essere risolutiva. Esempio, se vuoi rispondere in modo diretto alle domande che ti sono sorte nello studio degli analytics, un buon modo per rispondere è tramite una survey a risposta diretta.


Ciao, io sono Federico e sono un Technical Writer freelance:

Federico Trotta

Vuoi collaborare con me? Contattami!

Vuoi saperne di più su come lavoro? Puoi partire dai miei case studies e dal mio portfolio.

Federico Trotta

Technical Writer: I document digital products and write articles about AI & Python programming.

Leave a reply