Come aggiungere documentazione in WordPress (passo dopo passo)

Creare una documentazione approfondita sul vostro sito WordPress è essenziale se volete guidare e supportare efficacemente i vostri utenti. Una documentazione adeguata può aiutare gli utenti a capire come utilizzare i vostri prodotti o servizi, migliorando l’esperienza complessiva.

Negli ultimi 16 anni abbiamo costruito diversi siti web in cui vendiamo plugin e corsi, aggiungendo sempre una documentazione dettagliata per supportare i nostri utenti. Copriamo ogni aspetto, dal processo di installazione alle guide alle funzionalità, fino ai dettagli dei componenti aggiuntivi, con l’obiettivo di semplificare la risoluzione dei problemi.

Abbiamo notato che questo aiuta gli utenti a risolvere i loro problemi e crea fiducia nei nostri prodotti, in quanto si sentono sicuri sapendo che abbiamo cancellato tutte le informazioni chiave.

Per questo motivo consigliamo di aggiungere la documentazione, sia che si gestisca un’attività incentrata sui prodotti, sia che si tratti di un sito associativo o di una piattaforma educativa.

In questo articolo vi mostreremo come aggiungere facilmente la documentazione in WordPress, passo dopo passo. La nostra guida sarà facilissima da seguire e non richiederà alcuna conoscenza di codifica.

Perché aggiungere la documentazione in WordPress?

La documentazione è il contenuto del vostro sito WordPress che fornisce informazioni su come utilizzare i vostri prodotti/servizi, comprese le loro caratteristiche, le nuove versioni, i componenti aggiuntivi e altro ancora.

La documentazione di WordPress può includere tutorial, guide, FAQ, knowledge base e documentazione API.

Ad esempio, se avete un negozio online che vende musica, potete creare una documentazione che spiega come scaricare la musica, rinnovare le licenze o creare una playlist.

L’aggiunta di documentazione in WordPress può migliorare l’esperienza dell’utente, rendendo più facile per i clienti scoprire le diverse caratteristiche del prodotto, trovare le cause dei loro problemi ed eseguirne il debug da soli. Questo può anche ridurre il numero di ticket di assistenza per il vostro sito.

La documentazione può anche migliorare le classifiche SEO fornendo contenuti aggiuntivi che Google e gli altri motori di ricerca possono indicizzare e visualizzare nei risultati di ricerca.

Detto questo, vediamo come aggiungere facilmente la documentazione in WordPress, passo dopo passo.

Come aggiungere documentazione in WordPress

È possibile aggiungere facilmente la documentazione in WordPress utilizzando il plugin Heroic KB.

È il miglior plugin per basi di conoscenza per WordPress sul mercato che aggiunge una base di conoscenza ricercabile al vostro sito esistente. È dotato di una funzione di ricerca AJAX, ordinamento dei contenuti tramite drag & drop, allegati agli articoli e altro ancora.

Inoltre, lo strumento dispone di analisi integrate e di una caratteristica di feedback dell’utente che consente di raccogliere informazioni per migliorare la documentazione esistente.

È anche dotato di una funzione Heroic AI Assistant, che consente di aggiungere facilmente un chatbot personalizzato al vostro sito web. Il chatbot viene addestrato direttamente dalla vostra base di conoscenze, in modo da poter fornire risposte accurate e personalizzate ai vostri clienti.

Passo 1: Configurare le impostazioni generali di Heroic KB

Per prima cosa, è necessario installare e attivare il plugin Heroic KB. Per istruzioni dettagliate, consultare la nostra guida passo-passo su come installare un plugin di WordPress.

Dopo l’attivazione, visitare la pagina Heroic KB ” Impostazioni dalla barra laterale dell’amministrazione di WordPress e passare alla scheda “Licenza e aggiornamenti”.

Qui, inserire la chiave di licenza del plugin e fare clic sul pulsante “Salva modifiche”. È possibile ottenere queste informazioni dal proprio account sul sito web di Heroic KB.

Dopo aver aggiunto la chiave di licenza, passare alla scheda “Home & General” dalla colonna di sinistra. È necessario selezionare la pagina iniziale della documentazione dal menu a discesa accanto all’opzione “KB Home Page”.

Se si sceglie l’opzione “Archivio della Knowledge Base”, Heroic KB creerà una nuova pagina per la documentazione all’indirizzo www.example.com/knowledge-base.

Tuttavia, se si desidera aggiungere la documentazione a una pagina già creata, è possibile scegliere questa opzione dal menu a discesa.

Successivamente, è possibile digitare il testo dell’intestazione che verrà visualizzato nella parte superiore della pagina di documentazione.

Una volta fatto, basta selezionare l’opzione “Briciole di pane” per attivarla.

In una base di conoscenza, le briciole di pane sono un tipo di aiuto alla navigazione che consente agli utenti di vedere come sono arrivati alla pagina corrente e di tornare indietro alle pagine precedenti, come in questo caso: Home ” Prodotti ” Installazione.

Dal menu a tendina è possibile scegliere il numero di colonne di categoria da visualizzare nella pagina di documentazione.

Quindi, selezionare l’opzione “Visualizza i conteggi della categoria KB” se si desidera visualizzare il numero di articoli scritti per ogni categoria.

Quindi, scegliere il numero di articoli che devono essere visualizzati sotto ogni categoria nella home page della documentazione dal menu a discesa “KB Category Article”.

Quindi, è possibile selezionare le caselle “Nascondi categorie vuote” e “Nascondi articoli non catalogati”. In questo modo, nella pagina iniziale della documentazione non verranno visualizzate né le categorie vuote né gli articoli non catalogati.

Successivamente, è possibile limitare l’accesso alla documentazione di WordPress solo agli utenti connessi dal menu a discesa “Limita accesso”.

Una volta terminato, è sufficiente fare clic sul pulsante “Salva modifiche” per memorizzare le impostazioni.

Passo 2: Configurare le categorie, i tag e le impostazioni degli articoli

Passate ora alla scheda “Categorie e tag” dalla colonna di sinistra. Qui si può scegliere come ordinare le categorie e i tag e il numero di articoli da visualizzare per ogni tassonomia.

Si può anche selezionare la casella “Estratto di articolo” se si desidera visualizzare un frammento di articolo sotto ogni archivio di tassonomia nella documentazione.

Successivamente, è sufficiente fare clic sul pulsante “Salva modifiche” e passare alla scheda “Articolo”.

Da qui è possibile selezionare diverse caselle per attivare una sezione commenti sotto gli articoli di documentazione, visualizzare le biografie degli autori o mostrare altri articoli correlati sotto ogni esercitazione.

Dopo aver effettuato la scelta, è sufficiente fare clic sul pulsante “Salva modifiche” per memorizzare le impostazioni.

Passo 3: Impostare le impostazioni di ricerca e di slug della Knowledgebase

Ora, passate alla scheda “Ricerca” e spuntate la casella “Focus sulla ricerca” se volete che il mouse dell’utente si posizioni automaticamente sulla casella di ricerca della documentazione al caricamento della pagina.

Inoltre, è possibile aggiungere un testo segnaposto per la casella di ricerca, visualizzare estratti di articoli nei risultati della ricerca e persino abilitare il plugin per evidenziare il termine di ricerca nei risultati.

Una volta fatto ciò, fare clic su “Salva modifiche” e passare alla scheda “Lumache”.

Qui si possono aggiungere gli slug per gli articoli, le categorie e i tag della documentazione.

Una volta effettuata la scelta, fare clic sul pulsante “Salva modifiche” per memorizzare le impostazioni.

Passo 4: Configurare le impostazioni della barra laterale e dello stile della Knowledgebase

Passare quindi alla scheda “Barre laterali” per selezionare un layout per le barre laterali delle pagine di documentazione.

È possibile scegliere diverse posizioni per la barra laterale della home, delle categorie e degli articoli. È anche possibile selezionare l’opzione “Sticky Article Sidebar?” per attivare una barra laterale appiccicosa per le pagine.

Una volta fatto ciò, fare clic su “Salva modifiche” e passare alla scheda “Stili”.

Da qui è possibile selezionare la larghezza della documentazione, il colore dei link, lo stile dell’intestazione e il colore del testo secondo le proprie preferenze.

Quindi, è sufficiente fare clic sul pulsante “Salva modifiche”.

Fase 5: Impostazione delle impostazioni di feedback e di e-mail dell’articolo

Successivamente, si deve passare alla scheda “Feedback articolo” e selezionare l’opzione “Abilita feedback” per consentire agli utenti di valutare i vostri articoli.

È anche possibile aggiungere un sistema di voti alti e bassi per la documentazione di WordPress selezionando queste caselle. Questo permette agli utenti di dirvi se la vostra documentazione aiuta a risolvere i loro problemi on frontend.

A questo punto, fare clic sul pulsante “Salva modifiche” per memorizzare le impostazioni.

Ora, passare alla scheda “Rapporti e-mail” dalla colonna di sinistra e selezionare l’opzione “Abilita rapporti e-mail?” se si desidera che Heroic KB invii rapporti settimanali sulla documentazione.

Questo rapporto include le visualizzazioni totali e la valutazione media degli articoli di documentazione e mostra anche un elenco degli articoli più votati e di quelli che hanno ottenuto il punteggio più alto in quella settimana.

Una volta fatto ciò, aggiungete il vostro indirizzo e-mail di amministrazione al campo “Report Recipients”. Se volete, potete anche aggiungere più indirizzi e-mail.

Quindi, fare clic sul pulsante “Salva modifiche” per memorizzare le impostazioni.

Ora che avete configurato tutte le impostazioni del plugin Heroic KB, è il momento di iniziare a creare la documentazione per il vostro sito web.

Passo 6: Creare la documentazione per il vostro sito WordPress

È possibile creare articoli di approfondimento, knowledge base, guide e FAQ per la documentazione.

Per iniziare a creare un nuovo documento, visitate la pagina Heroic KB ” Aggiungi un articolo dalla Bacheca di WordPress.

Si aprirà l’editor di contenuti di WordPress, dove potrete aggiungere un titolo per il vostro articolo di documentazione e iniziare a scrivere il contenuto. Potete anche fare clic sul pulsante “+” nell’angolo in alto a sinistra per aggiungere diversi blocchi al vostro contenuto.

Una volta scritto l’articolo per la documentazione, è necessario espandere la scheda “Categorie” nel pannello di blocco e fare clic sul collegamento “Aggiungi nuova categoria di articoli”.

Successivamente, è sufficiente creare una categoria per l’articolo che si sta scrivendo.

Successivamente, espandere la sezione ‘Tag’ nel pannello di blocco e aggiungere tutti i tag desiderati per l’articolo di documentazione.

È anche possibile aggiungere un estratto dell’articolo espandendo la scheda “Estratto”.

Quindi, espandete la scheda “Discussione” e deselezionate l’opzione “Consenti commenti” se volete disabilitare i commenti per questo articolo. Se si desidera consentire agli utenti di aggiungere commenti, si può lasciare questa impostazione così com’è.

È inoltre possibile aggiungere allegati agli articoli nella documentazione. Per farlo, scorrere la sezione “Opzioni articolo” nell’editor di blocchi e fare clic sul pulsante “Aggiungi o carica file”.

In questo modo si avvia la libreria multimediale da cui è possibile aggiungere qualsiasi allegato.

Selezionate poi la casella “Allegati in una nuova finestra” se volete che gli allegati dell’articolo si aprano in una nuova finestra al momento del clic.

Se si desidera, è possibile disattivare la funzione “upvote/downvote” per articoli specifici, scorrendo la sezione “Opzioni di voto”.

Selezionare l’opzione “Disabilita voto” per disattivare il sistema di voti alti e bassi per questo articolo specifico.

Infine, fare clic sul pulsante “Pubblica” in alto per pubblicare l’articolo come documentazione.

Ripetere la procedura per aggiungere più voci alla documentazione in diverse categorie.

Una volta fatto ciò, si può facilmente visualizzare la documentazione visitando la pagina www.example.com/knowledge-base, oppure si può visitare la pagina personalizzata scelta per la documentazione.

Passo 7: modificare l’ordine degli articoli e delle categorie della documentazione

Con Heroic KB, potete anche modificare l’ordine degli articoli visualizzati nella vostra documentazione di WordPress. Per farlo, visitate la pagina Heroic KB Article Ordering dalla Bacheca di WordPress.

Qui si sceglie la categoria per la quale si desidera modificare l’ordine degli articoli. Quindi, è sufficiente trascina e rilascia gli articoli per riorganizzarli secondo le proprie preferenze.

Una volta terminato, ricordarsi di fare clic sul pulsante “Salva ordine” per memorizzare le impostazioni.

Per modificare l’ordine delle categorie visualizzate nella pagina di documentazione, visitare la pagina Heroic KB ” Category Ordering dalla barra laterale dell’amministrazione di WordPress.

Una volta qui, è possibile riorganizzare l’ordine delle categorie trascinandole e rilasciandole. Dopo aver apportato le modifiche, fare clic sul pulsante “Salva ordine” per memorizzare le impostazioni.

Ora avete creato con successo la documentazione per il vostro sito web e modificato l’ordine delle categorie e degli articoli.

Bonus: aggiungere una sezione FAQ al vostro sito WordPress

Aggiungere la documentazione di WordPress è un ottimo modo per aiutare i vostri utenti a trovare le informazioni di cui hanno bisogno. Potete anche aggiungere le FAQ (domande frequenti) ai vostri post per rispondere alle domande più frequenti relative ai vostri contenuti.

Questo può aumentare l’engagement degli utenti sul vostro blog WordPress e costruire fiducia e credibilità con i vostri utenti, facendo loro capire che comprendete le loro domande e preoccupazioni.

Inoltre, le FAQ possono migliorare le classifiche SEO, consentendo di utilizzare parole chiave a coda lunga che gli utenti cercano comunemente nei motori di ricerca.

Potete aggiungere facilmente le FAQ al vostro sito web utilizzando All in One SEO (AIOSEO). È il miglior plugin SEO per WordPress presente sul mercato che permette di ottimizzare facilmente il sito web per migliorare il posizionamento nei motori di ricerca.

AIOSEO dispone anche di un blocco FAQ di facile utilizzo che può essere aggiunto direttamente all’editor a blocchi, dove è possibile inserire domande e risposte per la sezione FAQ.

Il plugin consente inoltre di personalizzare la sezione FAQ dal pannello di blocco, compresi il colore del testo, il colore dello sfondo, la tipografia e il wrapper del titolo, rendendo AIOSEO il miglior plugin per le FAQ di WordPress sul mercato.

Inoltre, il plugin è dotato di uno schema di marcatura delle FAQ che può aumentare il posizionamento del sito web e il tasso di clic organico, facendo apparire le domande frequenti direttamente nei risultati di ricerca di Google.

Per istruzioni più dettagliate, consultate il nostro tutorial su come aggiungere una sezione Domande frequenti in WordPress.

Speriamo che questo articolo vi abbia aiutato a imparare come aggiungere documentazione in WordPress. Potreste anche voler consultare la nostra guida per principianti su come assumere assistenti virtuali per il vostro sito WordPress e le nostre scelte di esperti sul miglior software di documentazione tecnica per WordPress.

Se questo articolo vi è piaciuto, iscrivetevi al nostro canale YouTube per le esercitazioni video su WordPress. Potete trovarci anche su Twitter e Facebook.