Documentazione del prodotto Guida definitiva: tutto ciò che devi sapere per creare ottimi documenti

Documentazione del prodotto... potrebbe non essere la parte più sexy della gestione di un'azienda, ma è un'area chiave da non trascurare se vuoi che la tua attività abbia successo.

La creazione di documentazione di prodotto di alta qualità può aiutarti ad aumentare il successo dei tuoi clienti, a ridurre il carico di supporto e, in generale, a costruire un'attività migliore.

Ma cosa serve per creare la documentazione del prodotto? E come puoi impostare la tua documentazione sul tuo sito web?

Queste sono solo alcune delle domande a cui risponderemo nella nostra guida definitiva alla documentazione del prodotto. Ecco tutto ciò che tratteremo:

• Perché dovresti preoccuparti della tua strategia di documentazione del prodotto
• Alcuni esempi reali di documentazione di prim'ordine
• Il miglior software di documentazione del prodotto
• Otto consigli per creare una migliore documentazione

Sei pronto a migliorare il modo in cui la tua azienda gestisce la documentazione? Scendiamo!

Perché dovresti preoccuparti della tua strategia di documentazione del prodotto

Diamo il via alle cose con uno sguardo al motivo per cui non dovresti lesinare sulla tua strategia di documentazione del prodotto.

Rende i tuoi clienti più di successo

Il più grande vantaggio della creazione della documentazione del prodotto è che aumenta il successo dei tuoi clienti. Avere clienti di maggior successo significa tassi di conversione più elevati, tassi di abbandono più bassi e così via.

Ha senso: se un cliente non riesce a capire come ottenere valore dal tuo prodotto, non rimarrà tale per molto tempo.

La documentazione del prodotto è un modo utile per educare i clienti in modo che possano ottenere il maggior valore possibile. Quando ottengono più valore dal tuo prodotto, sarà più probabile che continuino a pagare, ti consiglieranno ai loro amici/colleghi e così via.

Riduce il tuo carico di supporto

La documentazione del prodotto può anche essere un ottimo modo per ridurre il carico sui canali di supporto umano.

Se la documentazione del tuo prodotto è di bassa qualità o inesistente, significa che i tuoi clienti devono contattare il tuo team di supporto umano ogni volta che si verifica un problema. Ciò significa più tempo dedicato a rispondere alle richieste di supporto.

Dovrai prenderti del tempo dalla crescita della tua attività per gestire queste risposte da solo o dovrai assumere una persona di supporto dedicata ( che costa denaro ).

Con una documentazione di alta qualità, i clienti saranno in grado di risolvere molti dei propri problemi, eliminando la necessità di rivolgersi all'assistenza. Puoi anche strutturare i tuoi processi di supporto per spingere le persone a controllare la tua documentazione prima di fare una richiesta.

Può essere un buon strumento di marketing e vendita

Mentre molte persone pensano alla documentazione del prodotto nel contesto dell'aiuto alle persone che hanno già deciso di effettuare un acquisto, una buona documentazione del prodotto può anche aiutarti ad attirare e convertire più clienti in primo luogo.

Dal punto di vista del marketing, la documentazione del prodotto è una miniera d'oro di parole chiave SEO a coda lunga per le quali puoi classificare la tua documentazione. Potresti essere sorpreso dal numero di persone che arrivano direttamente sulla documentazione del tuo prodotto da Google. Se strutturi bene la tua documentazione, avrai la possibilità di convertire queste persone in clienti.

La tua documentazione può anche essere un utile strumento di vendita per le persone che sono indeciso sull'acquisto del tuo prodotto. La documentazione del prodotto può rispondere a potenziali domande pre-vendita che potrebbero avere, convincerli che il tuo prodotto può fare ciò di cui hanno bisogno e dare loro la certezza che riceveranno aiuto quando ne avranno bisogno.

Ad esempio, Stripe è noto per avere una delle migliori documentazioni sui prodotti. Se vai su Twitter, puoi vedere molte persone che consigliano Stripe per la qualità della documentazione di Stripe:

Rende i tuoi dipendenti più efficaci

La documentazione del prodotto non è solo per i clienti, può anche essere una risorsa importante per i membri del tuo team per conoscere il tuo prodotto e fare riferimento quando necessario. Ciò è particolarmente vero per i nuovi dipendenti, che potrebbero non avere un'ampia base di conoscenze sul tuo prodotto.

Quattro ottimi esempi di documentazione di prodotti reali

Per darti un po' di ispirazione in più, diamo un'occhiata ad alcuni esempi di documentazione del prodotto nel mondo reale di aziende di successo.

1. Rigata

Abbiamo menzionato Stripe in precedenza come uno dei migliori esempi di documentazione di qualità come strumento di marketing/vendita, quindi sai che la documentazione di Stripe doveva essere la numero uno della nostra lista.

2. Adien

Adyen è una piattaforma di pagamento per pagamenti tramite eCommerce, dispositivi mobili e punti vendita. Come Stripe, ciò significa che gli sviluppatori devono integrarlo nelle proprie piattaforme, il che richiede un'eccellente documentazione. Adyen non delude: controlla la documentazione completa di Adyen qui.

3. Twilio

Se non hai familiarità con Twilio, è uno strumento che aiuta le aziende a creare comunicazioni nelle loro piattaforme, tramite messaggi di testo, e-mail, telefonate e altro ancora. Come con Stripe e Adyen, ciò significa che le aziende dovranno integrare Twilio nei loro servizi esistenti, il che richiede una documentazione di prim'ordine. Puoi sfogliare i documenti di Twilio per vedere un ottimo esempio.

4. Lasco

Slack è un altro strumento che ha una documentazione molto ben scritta e utile. Puoi sfogliare la documentazione completa di Slack qui.

Per vedere altri esempi, dai un'occhiata al nostro post completo sui migliori esempi di documentazione per l'utente.

Miglior software di documentazione del prodotto

Ora, diamo un'occhiata a come puoi iniziare a offrire una migliore documentazione del prodotto sul tuo sito.

Parleremo effettivamente di scrivere la tua documentazione nella prossima sezione. Tuttavia, prima di poter scrivere la tua documentazione, hai bisogno di un posto dove archiviare quegli articoli e renderli accessibili ai tuoi utenti.

Sebbene tu possa semplicemente aggiungere questi articoli direttamente al tuo sito, è un'idea molto migliore utilizzare un software di documentazione del prodotto dedicato. Oltre a organizzare i tuoi contenuti e renderli accessibili ai visitatori, un buon software di documentazione del prodotto includerà altre utili funzionalità come...

• Funzioni di ricerca Ajax per aiutare i visitatori a sfogliare la documentazione.
• Cerca analitiche in modo da poter vedere quali argomenti stanno cercando le persone.
• Dati sull'utilità in modo da poter tenere traccia dell'utilità di ogni singolo articolo e migliorarli quando necessario.

Ecco due delle migliori soluzioni...

Base di conoscenza eroica (KB eroica)

Heroic Knowledge Base è un plug-in per il software WordPress open source gratuito che ti consente di creare facilmente il tuo hub di documentazione del prodotto self-hosted.

Se utilizzi già WordPress per il sito web della tua attività, puoi aggiungere Heroic Knowledge Base al tuo sito per creare il tuo hub di documentazione. Oppure, se non lo fai, puoi creare un'installazione WordPress dedicata per la tua documentazione. In quest'ultimo caso, potresti anche essere interessato al tema della documentazione di KnowAll WordPress .

Heroic Knowledge Base ti consente di aggiungere tutta la tua documentazione utilizzando l'editor di contenuti di WordPress, che semplifica l'inclusione di contenuti multimediali se necessario. Avrai anche accesso al sistema di controllo delle versioni dei contenuti integrato di WordPress, che ti consente di monitorare facilmente le modifiche e confrontare le versioni precedenti della tua documentazione.

Heroic Knowledge Base aggiunge anche una serie di utili funzioni tra cui:

• Ricerca Ajax istantanea.
• Analisi di ricerca.
• Valutazioni sull'utilità degli articoli.
• Allegati file articolo.

Heroic Knowledge Base costa solo $ 129.

Adobe RoboAiuto

Se pubblichi la tua documentazione solo sul Web, una soluzione come Heroic Knowledge Base è tutto ciò di cui hai bisogno. Tuttavia, per esigenze di documentazione più a livello aziendale, potresti avere situazioni in cui è necessario pubblicare la documentazione su più piattaforme tra cui Web, carta fisica, app mobili, PDF e così via.

In questo caso, potresti preferire uno strumento di creazione di documentazione multipiattaforma come Adobe RoboHelp. A partire da $ 29,99 al mese per uso individuale, è più costoso di Heroic Knowledge Base. Tuttavia, se hai bisogno di un authoring multipiattaforma, quel prezzo extra potrebbe valere i soldi.

Come ottimizzare la struttura e il contenuto della documentazione del prodotto

Ora che hai il software necessario per gestire la tua documentazione, parliamo di come puoi scrivere articoli di alta qualità. Ecco otto suggerimenti chiave per strutturare la documentazione e scrivere articoli di aiuto migliori...

1. Comprendi il tuo pubblico

Per scrivere un'ottima documentazione sui prodotti, devi comprendere il pubblico per cui stai scrivendo (cioè i tuoi clienti).

Per chi stai scrivendo influenzerà le informazioni che includi e il modo in cui strutturi tutto. Ad esempio, se stai scrivendo per gli sviluppatori, la tua documentazione dovrebbe essere radicalmente diversa dalla scrittura per utenti occasionali.

Non vuoi presumere che il tuo pubblico sia esperto e sorvoli sui dettagli chiave, ma potresti presumere alcune conoscenze di base a seconda di chi sono.

2. Comprendere i diversi tipi di documentazione del prodotto

Esistono diversi tipi di documentazione del prodotto e ciascuno richiede un approccio diverso. Alcuni dei tipi comuni sono:

• Panoramica : questi articoli forniscono una panoramica del funzionamento di un'area del prodotto, ad esempio una guida introduttiva.
• Esercitazioni dettagliate : questi articoli mostrano alle persone come eseguire un'attività specifica.
• Riferimento : questi articoli spiegano concetti specifici nel prodotto.
• Risoluzione dei problemi : questi articoli spiegano come eseguire il debug/risoluzione dei problemi comuni che i clienti potrebbero incontrare.

Il tipo di documentazione su cui stai lavorando dovrebbe influenzare il modo in cui scrivi e come strutturi la tua documentazione, quindi è importante sapere qual è l'obiettivo prima di approfondire.

3. Sii coerente nel tuo stile e nelle convenzioni di denominazione

Per semplificare l'utilizzo della documentazione del prodotto per i clienti, è importante mantenere lo stesso stile e le stesse convenzioni di denominazione in tutta la documentazione. Ciò renderà più facile per i clienti seguire la tua documentazione ed evitare qualsiasi potenziale confusione.

Per aiutarti a farlo, potrebbe essere utile elaborare una guida di stile per la formattazione e la terminologia di base.

4. Usa un linguaggio semplice e rimani conciso

Tutto uguale, un linguaggio breve e semplice è sempre meglio dell'insalata di parole. Il tuo obiettivo dovrebbe essere quello di comunicare tutte le informazioni necessarie nel minor numero di parole possibile.

Dovresti anche evitare di usare termini gergali o complessi quando possibile. Non tutti i tuoi clienti avranno la stessa base di conoscenza e alcuni potrebbero non essere nemmeno madrelingua della lingua della tua documentazione, quindi mantenere le cose il più semplici possibile assicura che tutti possano ottenere valore dalla tua documentazione.

5. Organizzare la documentazione in articoli logici e di dimensioni "problematiche".

Per rendere più facile per le persone sfogliare la documentazione e trovare articoli per problemi specifici, è necessario suddividere la documentazione in segmenti logici. In generale, ogni articolo dovrebbe essere incentrato sulla risoluzione di un problema specifico.

Naturalmente, potrebbero esserci più sottoproblemi all'interno di quel problema principale, ma l'idea è che non vuoi raggruppare due problemi completamente separati nello stesso articolo perché renderà difficile per le persone cercare quegli argomenti e loro potrebbero essere confusi quando atterrano sull'articolo.

I tuoi clienti non leggeranno la tua documentazione in modo lineare come se stessero leggendo un libro. Invece, salteranno in giro in base al problema che stanno incontrando in questo momento. Suddividere i tuoi articoli in segmenti logici ti aiuta a tenere conto di questo comportamento.

6. Incorpora elementi multimediali

Anche se il testo scritto dovrebbe costituire il fulcro della documentazione del prodotto, non dovrebbe essere l'unica cosa. Può anche essere utile includere immagini e contenuti video dove ha senso.

Se includi screenshot, puoi anche aggiungere annotazioni alle immagini per chiarire i dettagli chiave.

7. Usa le intestazioni e aggiungi un sommario

All'interno dei singoli articoli della documentazione del prodotto, assicurati di utilizzare le intestazioni per dividere i tuoi articoli in segmenti logici invece di scrivere solo un lungo muro di testo.

Per aiutare le persone a navigare nell'articolo, puoi anche aggiungere un sommario che consente ai lettori di passare rapidamente a una sezione specifica.

Alcuni software di documentazione del prodotto possono aiutarti ad aggiungere automaticamente un sommario. Ad esempio, il plug-in Heroic Knowledge Base viene fornito con una funzione integrata per generare automaticamente un sommario basato sui titoli di ciascun articolo.

8. Migliora e aggiorna sempre la tua documentazione

Infine, è importante ricordare che la creazione della documentazione del prodotto non è un evento occasionale; è un processo continuo.

A livello di base, il tuo prodotto probabilmente subirà delle modifiche, quindi è importante aggiornare la documentazione per tenere conto di tali modifiche e di eventuali nuove funzionalità che hai aggiunto.

Ma oltre a ciò, se scegli un software di documentazione del prodotto come Heroic Knowledge Base, avrai accesso all'analisi per aiutarti a capire come le persone utilizzano la tua documentazione. Puoi utilizzare queste analisi per:

1. Tieni traccia di ciò che le persone stanno cercando, il che può essere un segno che devi creare documentazione su questi argomenti se non l'hai già fatto.
2. Scopri quali articoli non stanno aiutando gli utenti quanto vorresti, il che potrebbe essere un segno della necessità di apportare miglioramenti a tali articoli per migliorarne l'utilità.

Inizia oggi stesso a creare una fantastica documentazione sui prodotti!

La creazione di documentazione di prodotto di alta qualità è un investimento per il successo a lungo termine della tua attività. Ti aiuta...

• Fai più successo ai tuoi clienti.
• Riduci l'onere per il tuo team di supporto.
• Attira e converti più clienti in primo luogo.
• Migliora la conoscenza dei tuoi dipendenti sul tuo prodotto.

In questo post, abbiamo condiviso alcuni ottimi esempi di documentazione sui prodotti di aziende di successo insieme ad alcuni suggerimenti su come scrivere e strutturare la documentazione.

Se sei pronto per creare il tuo hub di documentazione del prodotto, puoi utilizzare il plug-in Heroic Knowledge Base per creare la tua soluzione self-hosted basata su WordPress. Clicca per saperne di più sulla Base di Conoscenza Eroica.