Uno dei migliori approcci al lancio di un nuovo prodotto: la preparazione della documentazione¶

Quando si lancia un nuovo prodotto, una best practice fondamentale è la preparazione della documentazione. In particolare, è cruciale creare una documentazione completa per supportare il lancio. Senza di essa, i potenziali utenti non avranno riferimenti adeguati dopo l'acquisto della vostra soluzione.

Come parte di una strategia di marketing più ampia, i product manager e i membri del team di prodotto dovrebbero continuare a leggere per scoprire 15 best practice da seguire durante il prossimo lancio. Alla fine, saprete come rendere questi documenti il più efficaci possibile!

Quali tipi di documentazione di prodotto dovrei conoscere?¶

Prima di approfondire le best practice, chiariamo quali tipi di documentazione esistono e gli obiettivi di ciascuno:

• Documentazione dei requisiti di prodotto – Un documento dei requisiti di prodotto o PRD è una documentazione interna che aiuta le aziende a soddisfare i criteri di rilascio. Descrive cosa il prodotto finale dovrebbe offrire all'utente, senza specificare il come o il dove. I team di sviluppo e testing utilizzano il PRD per allineare il prodotto ai requisiti aziendali in vista del rilascio. I PRD sono comuni per i prodotti software, ma possono essere utilizzati per qualsiasi roadmap di prodotto.

• Guide utente e self-service – I team di prodotto devono creare guide utente come prerequisito per un lancio di successo. Come suggerisce il nome, questa documentazione aiuta gli utenti finali a massimizzare la produttività con il nuovo prodotto. Tutte le funzionalità principali devono essere spiegate in dettaglio, per permettere ai clienti di ottenere il massimo valore. Meglio ancora, condividere queste guide in una knowledge base esterna self-service!

• Guide di configurazione, installazione e setup – Se un prodotto richiede setup, installazione e configurazione, dovrete creare anche questa documentazione tecnica. L'obiettivo è illustrare chiaramente questi processi sia dalla prospettiva dell'utente che dello sviluppatore, se applicabile. Potrebbe essere necessario coprire più dispositivi e sistemi operativi nel caso di documentazione software.

• Asset di marketing – Forse non li considerate documentazione di prodotto, ma lo sono! Lo stile e il formato degli asset di marketing influenzano la percezione del prodotto prima dell'utilizzo. Fare una buona impressione è vitale. Come state descrivendo le nuove funzionalità? A quale pubblico è destinato? Come migliorerà la vita lavorativa o personale degli utenti? È questo che voi e l'azienda volete che i clienti pensino?

15 Best Practice per la documentazione al rilascio di nuovi prodotti¶

Dopo questa introduzione, ecco le best practice:

1: Iniziare!¶

State iniziando con la documentazione di prodotto? Ottimo! Non esitate a fare il primo passo. Molti vogliono una documentazione PERFETTA e, nel perseguire la perfezione, si paralizzano. Mettete su carta i concetti base dei vostri servizi, poi concentratevi sul perfezionamento. Le note di rilascio sono ottime per definire le basi, poi potrete espandere da questo documento.

2: Keep it Simple, Stupid...¶

Abbreviato come KISS, è un principio di design nato nella marina statunitense negli anni '60. La stessa regola si applica alla documentazione di prodotto. Chiedetevi: "Come posso trasmettere le informazioni necessarie in modo comprensibile a tutti?"

Per applicare questo alla vostra visione di prodotto, consigliamo il test di leggibilità Flesch-Kincaid. Strumenti come Grammarly usano questo sistema. Puntate a un livello equivalente alla terza media per massimizzare la comprensibilità dei contenuti – avremmo potuto dire... per rendere i vostri testi più facili da capire.

3: Comprendere il pubblico target¶

Avete iniziato e mantenuto la semplicità. Ora dovete sapere per chi state scrivendo... Ad esempio, il pubblico target per le aziende software sarà molto diverso da quello di un produttore automobilistico.

Immaginiamo un'azienda di software educativo che si concentra su strumenti semplici per aiutare i giovani studenti. Potreste pensare: "quindi il pubblico target sono i bambini, giusto?". Non necessariamente... Il pubblico principale è rappresentato dai responsabili delle decisioni nelle scuole – come il dipartimento IT e gli stakeholder interni incaricati degli acquisti. Un pubblico secondario sarebbero gli studenti, che potrebbero vedere il software e promuoverne l'uso nella loro scuola.

4: Concentrarsi sul valore, non sulla storia¶

Sebbene tutti amino una bella storia, i clienti vogliono sapere quale valore offrirà il vostro prodotto. Semplificherà un'attività? È disponibile offline, a differenza dei concorrenti solo online? Il vostro prodotto è più veloce di altri prodotti concorrenti?

Questi esempi costituiscono unique selling points (USP) per un'offerta particolare. Evidenziare gli USP attirerà i potenziali clienti e li aiuterà a capire cosa avete che gli altri non hanno. Potete definire gli USP attraverso un'analisi competitiva dei concorrenti nel vostro settore.

5: Utilizzare la formattazione per categorizzare le informazioni¶

La documentazione non dovrebbe essere un blocco di testo. Questo è difficile da scorrere e navigare per gli utenti finali. Usate invece titoli e altre opzioni di formattazione per suddividere il testo.

I titoli H1 sono la prima cosa che le persone vedono quando cliccano su una pagina. H2 e H3 fungono da sottotitoli per gli argomenti trattati. Potete usare elenchi puntati o numerati per raggruppare i contenuti e migliorare la leggibilità, oltre a qualificarvi per i Rich Snippet per migliorare SEO e visibilità nei risultati di ricerca. Se conoscete Markdown, un editor online come Docsie offre numerose opzioni di formattazione!

6: Mantenere la documentazione in una posizione centrale¶

Non c'è niente di peggio che rilasciare documentazione tecnica e poi rendersi conto di quanto sarà complicato monitorarla e gestirla a lungo termine. E se la documentazione necessita di un aggiornamento? Dov'è il documento originale e come possiamo rilasciare nuove versioni? E la traduzione in altre lingue?

Per questa best practice, dobbiamo menzionare Docsie! Un software di knowledge base online consente di archiviare i documenti in un'unica posizione centralizzata nel cloud. Da qui, dipendenti e collaboratori possono lavorare insieme sui contenuti per accelerare il completamento in vista del lancio. Docsie offre gestione del controllo delle versioni quando è necessario aggiornare la knowledge base e gestione linguistica per la localizzazione dei contenuti globali. Se desiderate automatizzare la creazione di contenuti globali, abbiamo anche un bot di traduzione AI che traduce accuratamente in background!

7: Un'immagine vale mille parole¶

Sebbene scrivere una lunga spiegazione su come fare qualcosa funzionerà, non è un modo efficace per insegnare agli utenti finali. Mostrate loro con immagini o anche con immagini in movimento!

Provate a creare un tutorial video per ogni documento di prodotto. In questo modo, chi preferisce leggere può scorrere il testo, mentre chi apprende visivamente può optare per il video. Allo stesso modo, GIF e immagini possono aiutare gli utenti a vedere a cosa vi riferite, specialmente all'interno di un'interfaccia utente software (UI). Adattarsi a diversi stili di apprendimento vi aiuterà a supportare una gamma più ampia di utenti.

8: Apprendimento vs Obiettivi vs Comprensione vs Informazione¶

Qual è l'intento del documento? L'intento dell'utente è fondamentale con la documentazione di prodotto online e vi aiuta ad allineare i contenuti alle sezioni del percorso utente.

• Apprendimento – Se una persona non ha mai visto qualcosa prima, i contenuti di apprendimento la aiutano a comprendere i principi di base.

• Obiettivi – Questo tipo di contenuto dovrebbe aiutare gli utenti a raggiungere un obiettivo, come "Come esportare un file PDF da Docsie". Alla fine, l'utente avrà raggiunto l'obiettivo: esportare un PDF.

• Comprensione – Anche definita ricerca, è per i clienti che hanno già conoscenze su un argomento, ma vogliono approfondire.

• Informazione – L'utente ha una domanda e vuole una risposta specifica. Potrebbe essere semplice come il meteo in tempo reale in una posizione specifica o un video su "come costruire una casa sull'albero".

9: Renderla ricercabile¶

Prima di rendere pubblica questa documentazione, gli utenti possono cercare parole chiave all'interno del testo?

In caso contrario, consigliamo di trovare una piattaforma di documentazione che supporti questa funzione. Il principale deterrente per gli utenti è non poter trovare rapidamente le informazioni. Questo porta a frustrazione, aumento del carico di lavoro per il team di supporto clienti e un'esperienza cliente complessivamente negativa. Ah, Docsie supporta la ricerca globale, se ve lo stavate chiedendo!

10: Prepararsi a raccogliere feedback utili¶

I redattori di documentazione sanno che la versione iniziale del contenuto è destinata a cambiare. Fino a quando il pubblico non vede la documentazione, i vostri redattori possono solo scambiarsi idee e feedback.

Una volta pubblicata la documentazione, è essenziale predisporre un sistema di raccolta feedback. In questo modo, i redattori possono trasformare eventuali aspetti negativi in positivi ascoltando clienti reali e utenti finali. Non c'è bisogno di cercare altrove, potete sfruttare la raccolta di feedback in Docsie!

11: Linkare a una pagina quando si menziona un argomento¶

Questa best practice si basa su SEO e strutture di navigazione delle pagine web.

Quando menzionate una parola chiave, create un link? Quando fate riferimento ad altri argomenti, gli utenti potrebbero non comprendere ancora l'altro argomento nel contesto della pagina corrente. Dovreste linkare a qualsiasi argomento menzionato che ha documentazione, per permettere ai lettori di consultare rapidamente i sotto-argomenti mentre imparano un argomento principale.

12: Chiarezza, non ambiguità¶

La chiarezza batte l'ambiguità quando si scrive documentazione di prodotto. Potete usare un linguaggio semplice per evitare ambiguità, il che significa evitare gergo e linguaggio tecnico a meno che non sia assolutamente necessario. Se usate termini tecnici, assicuratevi di scrivere subito dopo una definizione semplificata per i lettori non esperti.

"Se state riscontrando problemi nella comprensione delle informazioni in questa documentazione, vi preghiamo di richiedere dettagli aggiuntivi su come superare questa difficoltà di comprensione al nostro rappresentante del supporto clienti."

"Se il contenuto visualizzato è difficile da capire, potete chiedere aiuto al supporto clienti."

Quale preferite?

13: Creare template per realizzare documenti più velocemente¶

Con un nuovo prodotto in fase di lancio, accelerare il processo di creazione della documentazione è una priorità. Potete farlo usando i template.

I template definiscono una struttura riutilizzabile per le pagine, aiutando i redattori a creare contenuti più rapidamente e con maggiore coerenza. Potete anche creare più template per diversi stili di contenuto. Docsie offre una gamma di template precostruiti, oltre al supporto per template personalizzati.

14: Stabilire un tono di voce e una guida di stile per i redattori¶

Quanta libertà hanno i vostri redattori?

Limitare i redattori è importante, poiché la libertà eccessiva può portare a incoerenze nelle bozze finali della documentazione. Potete farlo con linee guida sul tono di voce (ToV) e guide di stile per la scrittura dei contenuti.

• Tono di voce – Non è cosa dici... ma come lo dici. Volete che i redattori siano formali e rigorosi, o più casual? È consentito l'umorismo, o gli argomenti sono più seri? Il vostro contenuto è più conversazionale e appassionato, o volete solo fatti freddi e concreti?

• Linee guida di stile – Questo documento può spiegare la mission aziendale e come i redattori possono seguire uno stile definito quando scrivono e formattano le pagine. Potrebbero essere incluse le personas degli utenti da target, principi SEO come le meta descriptions e requisiti di citazione o riferimento (Chicago, AP Style, ecc).

15: Pubblicare la documentazione utilizzando una potente piattaforma di knowledge base¶

Se i vostri contenuti scritti sono il carburante, quale veicolo state usando per trasmettere il messaggio?

Una potente piattaforma di knowledge base è essenziale per distribuire documentazione di prodotto di qualità. Se i documenti diventano non disponibili, o le pagine sono lente a caricarsi, tutto lo sforzo speso nella creazione andrà sprecato.

Avete bisogno della capacità di importare documenti esistenti, collaborare con team interni, creare e modificare nuovi documenti, incorporare contenuti dinamici e pubblicare su un sito di knowledge base. Il controllo delle versioni è fondamentale per gli aggiornamenti a lungo termine, insieme alla gestione linguistica e alla traduzione automatica per la localizzazione dei contenuti globali.

Avete indovinato! Tutte queste funzionalità sono disponibili in Docsie. Provatele con il nostro piano Free Forever per iniziare!