Guida definitiva per una migliore documentazione WordPress per qualsiasi sviluppatore di plug-in

Se sei uno sviluppatore che crea plug-in per WordPress, quindi imposta un WordPress documentazione o una base di conoscenza dovrebbe essere una parte essenziale della tua strategia di assistenza clienti. Dopotutto, potrebbe essere molto facile per te utilizzare il tuo plugin, ma i tuoi potenziali clienti o utenti finali potrebbero aver bisogno di una guida adeguata per capire veramente come funziona il tuo plugin.

betterdocs wordpress documentation plugin developer

Per questo motivo, dovresti assolutamente prendere in considerazione la possibilità di dedicare del tempo a creare un programma adeguato, informativo e utile documentazione del plugin per gli utenti del tuo prodotto. Senza offrire documentazione del plugin per i tuoi utenti, sarà difficile per te e il tuo team raggiungere il successo poiché continuerai a ricevere tonnellate di ticket di supporto.

Immagina come ti sentiresti se avessi acquistato una lavatrice nuova di zecca, ma non avevo idea di come farlo funzionare perché è arrivato senza istruzioni o un manuale utente. Potresti chiamare il servizio clienti, ma dovresti aspettare a lungo in linea mentre il servizio clienti risponde alle domande di tutti gli altri.

Quindi, se sei un Sviluppatore di plugin WordPress e desideri che i tuoi clienti abbiano una buona esperienza con i tuoi prodotti, quindi valuta la possibilità di creare una documentazione WordPress piena di risorse che sia facile da usare e da capire.

Parlando dell'importanza della documentazione per i plugin WordPress, Vova Feldman, il fondatore di Freemius condivisa: 

"With proper documentation, you & your support team can work more efficiently by referring users to documented topics instead of writing them over and over again. It improves the UX for users that are comfortable finding solutions in a self-serve approach which naturally reduces the support load."

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Sommario

Tutto quello che c'è da sapere sulla documentazione di WordPress

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Il principale scopo della documentazione is to provide your users with detailed information about how they can use your product. 

It is much more comprehensive than a simple FAQ (Domande frequenti) e dovrebbe essere di facile lettura e comprensione anche per le persone che non hanno conoscenze tecniche sul prodotto.

To sum it up in a nutshell, your WordPress documentation acts as the user manual for your product and should make your end-users feel like an expert when they are using your plugins. 

Dall'insegnamento agli utenti su come installare e attivare il plug-in, alla configurazione delle impostazioni e all'ottimizzazione con funzionalità diverse, assicurarsi che la documentazione del plug-in risponda a quante più domande possibile.

Diamo un'occhiata al perché questo è così importante per qualsiasi sviluppatore di plugin. Di seguito, ti forniremo una breve panoramica di tutti i modi in cui una documentazione del plug-in può aiutarti.

👉Assist Non-Technical Users To Understand Your WordPress Plugin: Mentre alcuni dei tuoi utenti finali potrebbero avere conoscenze tecniche, maggior parte gli utenti su WordPress tendono a provenire da un background non tecnico. Ciò significa che è necessario offrire la documentazione per il plug-in WordPress che sia facile da comprendere per gli utenti non tecnici.

👉Enhance User Experience With A Detailed WordPress Documentation: Se i tuoi utenti riescono a capire come usare il tuo plugin WordPress semplicemente esaminando la documentazione del plugin che hai fornito loro, si sentiranno potenziati e soddisfatti del tuo plugin WordPress.

👉Reduce Support Tickets & Workload On Your Team: Una buona documentazione WordPress può fare molto per aiutarti a ridurre i ticket di supporto e il carico di lavoro del tuo team di supporto. Se gli utenti finali possono risolvere la maggior parte dei loro problemi leggendo la documentazione del plug-in, non dovranno contattare il team di supporto.

👉Safeguard Yourself From Negative Reviews: Senza una corretta documentazione WordPress i tuoi utenti potrebbero non capire come funziona il tuo plugin. È molto probabile che ciò faccia sentire i tuoi utenti così frustrati che potrebbero finire per lasciare recensioni negative sui tuoi plugin. Quindi, per proteggerti dalle recensioni negative, offri una documentazione WordPress ricca di contenuti.

👉SEO Benefits of Documentation: Avere una documentazione adeguata ti aiuta a fornire ai clienti tutte le informazioni di cui hanno bisogno, ma sarà inefficace se i clienti non riescono a scoprire dove accedervi. Qui, la base di conoscenza può essere un modo relativamente semplice di classificarsi in cima alla ricerca di Google se hai ottimizzato correttamente la tua documentazione per il traffico dei motori di ricerca.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Il contenuto è uno dei quattro principali fattori di classificazione dell'algoritmo SEO di Google e la documentazione è una delle fonti di contenuto per il tuo sito Web in quanto è più probabile che venga classificata nelle prime pagine con ottimizzazioni adeguate.

✅ Guida alla configurazione di una documentazione WordPress intraprendente

Per impostare un'utile documentazione WordPress ricca di contenuti, è necessario seguire alcune linee guida di base. Daremo un'occhiata a loro ora.

Usa un linguaggio semplice per la documentazione del plug-in

Ricorda che lo scopo di una documentazione WordPress è di facilitare agli utenti la comprensione di come utilizzare il tuo plugin senza needing technical expertise. 

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Avoid using technical jargons as users who do not have technical knowledge will not be familiar with those terms.

Garantire la massima leggibilità per i tuoi utenti

Una documentazione informativa e piena di risorse WordPress avrà probabilmente molti contenuti. Per consentire agli utenti di leggere rapidamente tutto il contenuto della documentazione del plug-in, utilizzare brevi paragrafi, immagini, elenchi, punti elenco, sommario e molto altro. Tutto ciò contribuirà a semplificare la lettura della documentazione di WordPress.

Seguire una struttura adeguata per la documentazione di WordPress

Una documentazione WordPress efficace e utile avrà una struttura adeguata. Ciò significa che tutto il contenuto della documentazione del plug-in seguirà le istruzioni sequenziali e dettagliate.

Ad esempio, tutti i plugin WordPress devono essere attivati dopo l'installazione. Se salti il passaggio sull'attivazione del plug-in, molti utenti potrebbero non capire perché il plug-in non funziona per loro. Pertanto, quando scrivi la documentazione del plug-in, assicurati di seguire una struttura sequenziale adeguata che abbia senso per gli utenti finali.

Per avere un'idea migliore di come sia la documentazione di un plugin WordPress di alta qualità, dai un'occhiata a queste pagine di documentazione create per alcuni popolari plugin WordPress.

Organizzare La documentazione del plug-in con le categorie e i tag corretti

Questa è una regola molto importante da ricordare quando si scrive la documentazione del plugin. Usa sempre categorie e tag appropriati per organizzare il contenuto della documentazione di WordPress.

Questo è particolarmente importante se il tuo plugin ha tonnellate di funzionalità che offrono vantaggi unici ai tuoi utenti. Aiuta gli utenti a scoprire più facilmente i loro contenuti pertinenti quando si trovano nella home page della documentazione.

Aggiorna e migliora la documentazione WordPress regolarmente

Ogni volta che aggiorni e migliora il tuo plugin, devi anche aggiornare la tua documentazione WordPress per assicurarti che le informazioni siano utilizzabili per i tuoi utenti finali. Altrimenti, i tuoi utenti si sentiranno confusi e frustrati poiché non saranno in grado di comprendere la documentazione del plug-in.

Seguendo queste linee guida, sarai in grado di creare documentazione WordPress di alta qualità, pertinente e ricca di contenuti per i tuoi utenti.  

🚀Create WordPress Documentation With BetterDocs: The Most Powerful Knowledge Base Solution

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Ora che conosci l'importanza di disporre della documentazione di un plug-in e delle linee guida che devi seguire, potresti chiederti Come esattamente puoi creare la tua documentazione WordPress informativa e ricca di contenuti. 

La soluzione più avanzata per la creazione di una documentazione WordPress di alta qualità è BetterDocs.

BetterDocs è il plug-in di documentazione più potente perché ti aiuta notevolmente ridurre i tempi e supportare i ticket creando una documentazione WordPress bella e ricercabile. Ti è stato portato da WPDeveloper, the WordPress product company that serving more than Oltre 700.000 utenti WordPress from 180+ countries. It’s the same team behind Essential Addons per Elementor, NotificationX e altro.

🔝 Key Features Of BetterDocs That Help You Create Better WordPress Documentation

There are several special features that make BetterDocs stand out among all other similar plugins. From a collection of beautiful, modelli premade, per un facile da usare personalizzatore incorporato, BetterDocs has everything you could need to create an attractive, organized documentation page in a matter of minutes. These features include:

✔️ A collection of premade, ready-to-use template designs 
✔️ A built-in personalizzazione per lo stile le tue pagine di documentazione
✔️ Automatically create sticky Tabella dei contenuti per una navigazione più semplice

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

✔️ Advanced Ricerca diretta per trovare rapidamente contenuti pertinenti
✔️ Keep track of performance with Analytics e report 
✔️ Risposte istantanee ChatBot per una migliore esperienza utente 
✔️ SEO friendly documentazione utilizzando Markup schema appropriato

🔥How To Use BetterDocs To Quickly Create Your WordPress Documentation

In questa sezione, ti insegneremo come utilizzare BetterDocs per creare rapidamente la tua documentazione WordPress. Inizieremo con le basi, come come installare il plugin BetterDocs per WordPress, e poi ti mostreremo come puoi usare tutte le fantastiche funzionalità che abbiamo menzionato in precedenza per creare la documentazione del plugin.

Installa e attiva il plugin BetterDocs per WordPress

La prima cosa che devi fare è trovare il plugin BetterDocs per WordPress navigando verso wp-admin -> Plugin -> Aggiungi nuovo dalla tua dashboard WordPress. Quindi devi scrivere 'BetterDocs' nella casella di ricerca.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Una volta trovato il plug-in, semplicemente installa e attiva esso.

Configurare la home page della documentazione e la pagina singola con BetterDocs

Il passo successivo dopo l'installazione e l'attivazione di BetterDocs è configura la tua home page della documentazione.

Questo è molto facile da fare. Per impostazione predefinita, BetterDocs viene fornito con la propria home page della documentazione che è possibile personalizzare come si desidera. Se si desidera assegnare il proprio layout di pagina, tuttavia, è possibile farlo disabilitando la home page predefinita e utilizzando codici brevi o widget per la creazione di pagine.

Per configurare e personalizzare la home page predefinita fornita con BetterDocs, accedere a BetterDocs -> Impostazioni -> Layout. Scegli il numero di colonne, abilita o disabilita la ricerca dal vivo e il layout in muratura, il conteggio dei post e molto altro.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Se si desidera configurare le singole pagine della documentazione, è sufficiente selezionare il "Doc unico" scheda mentre sei in 'Disposizione' scheda fino a quando non trovi l'opzione "Documento singolo". Modifica le opzioni per personalizzare la tua pagina di documentazione.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Se lo desideri, puoi anche impostare la pagina degli archivi della documentazione WordPress esattamente nello stesso modo. Basta fare clic su 'Pagina degli archivi' scheda mentre ci si trova in 'Disposizione' scheda.

Assegna e gestisci i ruoli utente per ottimizzare il carico di lavoro

Questo passaggio è completamente facoltativo. Se sei uno sviluppatore di plug-in e desideri assegnare persone diverse per creare e gestire la documentazione del plug-in, puoi farlo gestire i ruoli utente in BetterDocs andando a BetterDocs -> Impostazioni -> Impostazioni avanzate dalla tua dashboard WordPress.

BetterDocs

Crea e pubblica la tua documentazione WordPress

Questa è la parte divertente. Questo è il passaggio in cui ti mostriamo come creare e pubblicare una nuova documentazione in BetterDocs.

Devi andare a BetterDocs -> Aggiungi nuovo dalla tua dashboard WordPress. Questo aprirà l'editor per te, dove puoi scrivere il contenuto della tua documentazione e anche scegliere categorie e tag.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Ordina e organizza la tua documentazione WordPress con categorie ed etichette

Abbiamo menzionato quanto sia importante utilizzare categorie e tag nella nostra guida per impostare una documentazione WordPress piena di risorse. Qui in questa sezione, ti mostreremo come ordinare e organizzare la documentazione in BetterDocs. Per impostare le tue categorie, devi andare a BetterDocs -> Categorie dalla tua dashboard WordPress dove puoi creare tutte le categorie di cui hai bisogno.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Successivamente, quando scrivi la documentazione del plug-in, puoi assegnare queste categorie e vedere come possono aiutarti a organizzare la documentazione dopo averla pubblicata.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Includi ricerca avanzata dal vivo per la tua documentazione WordPress

Con BetterDocs hai la possibilità di aggiungere e personalizzare la documentazione ricerca dal vivo. Navigare verso wp-admin -> BetterDocs -> Impostazioni. Successivamente, apri il 'Design' scheda. Ora, premi il tasto "Personalizza BetterDocs" pulsante e verrai reindirizzato alla pagina Personalizza.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Ora da questo personalizzatore, puoi impostare la ricerca dal vivo per la tua documentazione. Divertiti con le opzioni di stile e guarda le tue modifiche in tempo reale. Quando sei soddisfatto del tuo stile, assicurati di salvare le modifiche.

BetterDoc

Aggiungi risposte immediate ChatBot per una migliore esperienza utente

Se vuoi ridurre ulteriormente i tuoi ticket di supporto e migliorare l'esperienza utente, devi sapere come fornire una risposta immediata in WordPress e migliora l'esperienza utente con BetterDocs. Puoi aggiungere questo ChatBot con risposta immediata in qualsiasi pagina ti piaccia. Per abilitarlo, devi accedere a wp-admin -> BetterDocs -> Impostazioni e quindi fare clic sulla scheda "Risposta immediata".

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Successivamente devi impostare il ChatBot di risposte immediate alle tue preferenze. Puoi modificare le opzioni nella sezione "Impostazioni chat", nella sezione "Impostazioni dell'aspetto" e molto altro.

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Risposte istantanee ChatBot può essere ampiamente personalizzato per creare un ChatBot di conversazione interattivo che si occuperà immediatamente dei problemi dei tuoi utenti. 

Per una migliore idea di come Instant Chat Answers di BetterDocs possa far risaltare davvero la tua pagina di documentazione, guarda come Easy.Jobs utilizza ChatBot Instant Answers sul proprio sito.

WordPress Documentation

Come puoi vedere, ogni volta che un utente fa clic sul ChatBot di Instant Answers, risponde immediatamente alle domande dell'utente. In questo modo, BetterDocs ti aiuta a migliorare l'esperienza dell'utente riducendo i ticket di supporto con il suo ChatBot con risposte immediate.

Valuta le prestazioni della tua documentazione WordPress con analisi e rapporti

Abbiamo affermato che il miglioramento della documentazione di WordPress è una parte essenziale della creazione di una documentazione migliore. Il modo migliore per farlo è valutare le prestazioni della documentazione del plug-in con analisi e report. 

Puoi configurare analisi per valutare le prestazioni della tua base di conoscenza navigando verso wp-admin-> BetterDocs -> Impostazioni. Dalla scheda "Generale" è possibile impostare la modalità di applicazione di Analytics e anche scegliere di abilitare o disabilitare Bot Analytics.

BetterDocs

Puoi controllare le informazioni dal tuo Analytics da BetterDocs -> Analytics. Ciò fornirà una valutazione chiara e approfondita delle prestazioni della documentazione di WordPress.

BetterDocs

Esegui facilmente la migrazione dal plug-in di documentazione esistente a BetterDocs

Anche se stai già utilizzando un plug-in di documentazione diverso, non ti preoccupare! Puoi migrare facilmente su BetterDocs con pochi clic. Per maggiori dettagli, dai un'occhiata a questi dettagli guida e imparare a migrare a BetterDocs. 

🎁 Grab An Exclusive for only WordPress Plugin Developer: BetterDocs Pro​ for FREE

Ciò conclude la nostra guida per una migliore documentazione WordPress per qualsiasi sviluppatore di plug-in.

Se sei uno sviluppatore di plug-in e vuoi dare un'occhiata esclusiva a tutto ciò che BetterDocs ha da offrire, allora sei fortunato oggi! Stiamo dando via una licenza gratuita per BetterDocs Pro solo per gli sviluppatori di plug-in WordPress che dispongono di un plug-in WordPress freemium e desiderano creare una pagina di documentazione, quindi compila questo modulo qui sotto e ti contatteremo.

Ottieni l'accesso alla licenza BetterDocs PRO
Picture of Afshana Diya

Afshana Diya

Afshana is CMO at WPDeveloper where she is helping to accelerate business growth & the company is currently reached 800,000+ users from 190+ countries. She is also co-organizer of WordCamp Dhaka & Product Hunt Meetup, Global Community Deputy for WordPress.

Condividi questa storia