Molte aziende SaaS tecnologiche faticano a sviluppare e distribuire documentazione di prodotto (manuali utente, guide e tutorial) ai propri clienti.
Questo accade spesso per mancanza di conoscenze o processi adeguati sulla gestione e produzione dei manuali, o per incertezza su chi debba esserne responsabile.
Finché esisteranno strumenti e software nel mondo, avremo bisogno di una comunicazione efficace per spiegare agli altri come utilizzare, sviluppare e comprendere l'architettura di questi prodotti. Se ti chiedi perché, la risposta è semplice: le competenze di comunicazione tecnica sono fondamentali per raccogliere informazioni e aiutare il pubblico a comprendere meglio il prodotto o la tecnologia.
Mentre la comunicazione nel mondo reale avviene attraverso parole, linguaggio del corpo ed espressioni emotive, nel mondo virtuale la comunicazione tecnica si realizza attraverso la documentazione tecnica di prodotto!
L'unico scopo della documentazione tecnica è facilitare la comprensione delle dinamiche di funzionamento e dell'architettura di un prodotto o di una tecnologia. È come un manuale "how to use" per i nuovi dipendenti, utenti/clienti e chiunque debba conoscere i metodi di lavoro, una descrizione dettagliata di ogni componente del prodotto!
È responsabilità del product manager creare un team per sviluppare, gestire, pubblicare e mantenere una documentazione di prodotto curata.
Sono certo che ogni product manager ha detto o sentito frasi come: "La documentazione di prodotto fa parte degli obblighi del Product Owner"; "Ogni team di sviluppo dovrebbe documentare le proprie applicazioni"; "La funzionalità è stata distribuita, il manuale è stato aggiornato?" o, peggio ancora, "C'è un errore nella documentazione tecnica."
Chiaramente, la documentazione tecnica di prodotto può risultare confusa nonostante sembri semplice! Mentre le persone cercano di risolvere o discutere sulle affermazioni del paragrafo precedente, i manuali e i tutorial si deteriorano, danneggiando l'immagine del prodotto e dell'azienda.
Per aiutare chi affronta problemi simili, ecco alcune procedure da implementare per ottimizzare la documentazione di prodotto.
Qual è lo scopo della documentazione di prodotto?¶
Quando si parla di documentazione per un prodotto o servizio tecnologico, ci si riferisce alle informazioni che lo descrivono e ai dati ad esso relativi.
La documentazione tecnica, o documentazione di prodotto, serve ad aiutare il pubblico e i clienti a utilizzare, leggere e comprendere il tuo prodotto. La maggior parte della documentazione viene prodotta in diversi settori, tra cui ingegneria, medicina, informatica e marketing.
Una documentazione tecnica eccellente aiuta il pubblico a navigare nel prodotto e a utilizzarlo senza complicazioni.
Un'altra considerazione importante: la documentazione tecnica è fondamentale per l'assistenza clienti e contribuisce significativamente al branding e alla fiducia nella tua azienda. Gli utenti cercano la documentazione tecnica quando ne hanno più bisogno. Il pubblico utilizza il tuo prodotto per conoscere i processi e risolvere i problemi.
Questo significa che avere una documentazione di prodotto completa e dettagliata, con funzionalità di ricerca dinamica, è molto importante.
Quali sono i diversi tipi di documentazione di prodotto¶
Questa sezione ti permette di vedere quale tipo di documentazione di prodotto è necessaria per i tuoi clienti.
Esistono molti tipi diversi di documentazione che soddisfano diverse esigenze e casi d'uso:
Documentazione utente del prodotto: Include manuali utente, guide pratiche, tutorial, FAQ, note di rilascio, manuali di formazione e procedure operative.
Documentazione aziendale: Le ricerche mostrano che oltre 8 aziende su 10, su 1000 aziende intervistate, utilizzano manuali formali di politiche e procedure.
Esistono molti altri tipi di documentazione aziendale che comprende documentazione relativa a politiche e procedure aziendali, manuali di istruzioni, pratiche tecniche, documentazione comportamentale ed etica. Ci sono anche documentazioni legali che potrebbero essere protette da password, strutture aziendali, best practice e procedure, oltre a manuali di manutenzione.
Documentazione per sviluppatori: questo tipo di documentazione fornisce istruzioni per lo sviluppo di prodotti software, specifiche funzionali, specifiche tecniche, documentazione e strumenti per assistere il flusso di lavoro degli sviluppatori.
Ora che comprendiamo meglio i diversi tipi di documentazione tecnica e di prodotto, vediamo quali sono i primi passi di un solido processo di sviluppo della documentazione.
Individuare un responsabile dello sviluppo della documentazione¶
Un problema tipico è determinare chi dovrebbe essere responsabile della documentazione del prodotto, non solo come persona che la aggiorna, ma come responsabile della qualità e del successo del prodotto.
Mentre alcune aziende ritengono che ogni product owner e/o product manager sia responsabile della documentazione, anche altri reparti come sviluppo e supporto possono essere incaricati di mantenere aggiornati ed efficaci i manuali utente, le guide e tutti gli aspetti della documentazione.
Lo sviluppo della documentazione ha molte componenti, ma ne evidenzieremo due:
-
Chi comprende come funziona il prodotto a tutti i livelli (inclusi i team di sviluppo e specifiche).
-
Chi riceve feedback dai clienti che esaminano la documentazione e ascolta le loro difficoltà, feedback e preoccupazioni sulla comprensione della documentazione.
La prima parte ci aiuta a creare la documentazione con le conoscenze disponibili, che viene poi inviata al cliente che a sua volta fornisce feedback e avvia il secondo processo che aiuta a ottimizzare la documentazione.
A volte questi due punti non sono perfettamente allineati, creando situazioni in cui la documentazione non riceve mai l'attenzione necessaria.
Un approccio è designare una persona responsabile delle "prestazioni" della documentazione, dei manuali e delle guide utente. Considera un ordine di acquisto che ha "Documentazione di prodotto" come prodotto. Questa persona è responsabile di esaminare tutti i team dell'azienda, delineare come ogni Prodotto genera le proprie guide e identificare le sfide associate a quel processo.
L'intenzione non è che questo product owner e product manager sia interamente responsabile della generazione e modifica dei manuali, ma di assistere le persone all'interno di ogni team nella gestione dei documenti.
Questa persona dovrebbe studiare come gli utenti interagiscono con i documenti, offrire modi per rendere gli aggiornamenti più fluidi e raccogliere feedback per determinare come migliorare ogni documentazione di prodotto con il suo pubblico di destinazione.
Avere qualcuno responsabile di tutti gli aspetti della documentazione, che gestisca il flusso di lavoro e i diversi reparti necessari per completarla, aumenterà la produttività all'interno dell'azienda, creerà consapevolezza ed educherà i clienti con portali di conoscenza sul prodotto, migliorando complessivamente la comprensione del prodotto.
Considera la tua documentazione come un prodotto¶
I prodotti esistono per offrire un valore che soddisfi o superi le aspettative del cliente. Secondo le statistiche generate da D2WorldWide, il 73,7% delle persone considera la documentazione più utile di video, packaging o venditori quando cercano informazioni sui prodotti che stanno valutando di acquistare.
Considera i fattori che contribuiscono all'attrattiva di un prodotto. Ci sono diversi fattori, ma per questo articolo ci concentreremo su tre: superano le aspettative in termini di valore; il loro utilizzo genera soddisfazione; sono competitivi.
Gli stessi concetti si applicano a una buona documentazione online. I documenti che vanno "oltre il valore atteso" illustrano non solo come utilizzare l'articolo specificato, ma offrono anche soluzioni che il cliente non conosce o non ritiene possibili. È sempre necessario vedere come altre aziende creano la loro documentazione per imparare dai loro successi e errori.
Non ha senso avere un'azienda che sviluppa software unico e di alta qualità, all'avanguardia rispetto alla concorrenza, se gli sviluppatori e i clienti che integrano i tuoi documenti tecnici non riescono a comprenderli.
Considera che la persona che legge la documentazione potrebbe non conoscere la gamma di soluzioni offerte dal prodotto o il mercato (come spesso accade con i prodotti SaaS tecnici), quindi deve essere "educata" su queste soluzioni e sulle varie opzioni relative al prodotto.
I documenti il cui "utilizzo genera soddisfazione" seguono uno schema logico di lettura adatto al pubblico target. Non serve avere il manuale più completo al mondo se è un PDF di 500 pagine o non include esempi di codice e non è creato dinamicamente con capacità di ricerca e altre funzioni. Raccogli feedback dagli utenti del tuo documento e dal personale di supporto. Loro identificheranno le principali aree di stress legate ai dati segnalati.
La documentazione competitiva è quella che viene costantemente aggiornata utilizzando le tecniche più efficaci di scambio di informazioni. Ha funzionalità straordinarie come capacità di ricerca integrate, traduzioni, diverse versioni, immagini incorporate, video e molto altro!
Anche se la tua guida all'integrazione è la migliore scritta tra tutte le aziende tecnologiche, mancherà di attrattiva senza video, immagini e codici che possono essere copiati e incollati per facilitare l'uso ai clienti tecnicamente esperti che acquistano i tuoi prodotti SaaS.
È sempre necessario vedere come altre aziende impostano i loro documenti per imparare dai loro successi e errori.
Non ha senso avere un'azienda che sviluppa software unico e di alta qualità, all'avanguardia rispetto alla concorrenza, se gli sviluppatori e i clienti che integrano i tuoi documenti non riescono a comprenderli completamente.
Feedback sulla documentazione
Una documentazione tecnica efficace migliora l'esperienza dell'utente finale perfezionando il processo di comprensione dei prodotti e diagnosticando eventuali problemi con soluzioni scritte prontamente disponibili. Quando i clienti si fidano e capiscono come usare i tuoi prodotti, potrebbero tornare da te in futuro quando ne avranno bisogno.
Nuove ricerche condotte da SDL dimostrano che il ruolo della documentazione nei mercati globali sta crescendo. La ricerca mostra che circa il 53% degli acquirenti effettua acquisti utilizzando letteratura tecnica prima di provare il prodotto. Inoltre, un'altra statistica compilata da questa ricerca mostra che il 94% degli acquirenti ritiene utile avere le informazioni sul prodotto in un'unica posizione. Per questo motivo, oggi ogni azienda dà uguale importanza alla documentazione del prodotto e allo sviluppo o al test del prodotto.
Anche se la documentazione ha un proprietario designato che gestisce il team di documentazione, ha creato documentazione che è stata rivista e valutata per una migliore usabilità, ed è stata adeguatamente aggiornata, continui a lottare per far comprendere i tuoi prodotti tecnici agli utenti e ai consumatori. Questo potrebbe verificarsi a causa dell'incapacità degli utenti/lettori di comprendere come vengono letti i tuoi documenti o le domande che stanno realmente ponendo. Questo rende uno degli aspetti più difficili della composizione dei documenti mettersi nei panni del lettore. Dopotutto, chiunque produca la documentazione dovrebbe avere una solida comprensione del prodotto.
Questa competenza può far sì che lo scrittore trascuri cose che non sono così ovvie per l'utente medio. In genere, questo accade quando qualcosa di evidente per chi crea il prodotto non è altrettanto chiaro per chi acquista e utilizza il prodotto.
Questo può accadere in vari modi:
Struttura o forma di scrittura: Sebbene possa sembrare un termine soggettivo, anche il modo in cui viene scritto un manuale può creare confusione. È fondamentale identificare il tipo di lettore che legge la documentazione; altrimenti, possono verificarsi frasi come "Gli sviluppatori preferiscono esempi piuttosto che testo descrittivo" o "La nostra documentazione non è chiara nonostante la presenza di esempi e immagini".
Argomenti organizzati nei manuali: Occasionalmente, le aziende che operano nello stesso mercato sviluppano un formato di documentazione standardizzato. Se le guide della tua azienda non vi aderiscono, il lettore potrebbe avere una sensazione di estraneità.
Uso eccessivo di termini impliciti: Quando applicate a un manuale, le abbreviazioni potrebbero avere poco senso, anche se le frasi non sono acronimi. È difficile da percepire, ma alcune parole, come "status", "id", "credenziali", contengono un significato implicito mascherato da esplicito. Utilizza designazioni particolari, come "UserID", piuttosto che "UID".
Traduzione valida: la traduzione è una parte enorme della portata globale. Spesso le aziende creano manuali utente e documentazione di prodotto mal tradotti che non corrispondono alla cultura di determinate nazioni o semplicemente le parole non si traducono allo stesso modo in cui farebbero in inglese in quel particolare paese. Comprendere queste sottili sfumature può trasformare la documentazione del prodotto da informazioni illeggibili a documentazione completamente comprensibile e ben tradotta.
Per evitare tali situazioni, l'obiettivo è sviluppare una soluzione che raccolga e analizzi il feedback degli utenti e i modelli di navigazione.
Strumenti di feedback come Vocally, una funzionalità di Docsie, sono un ottimo modo per ricevere e valutare i modelli di navigazione e indagare su come i clienti visualizzano la documentazione del prodotto. Scopri le 7 regole d'oro per raccogliere feedback qui.
Queste informazioni sono fondamentali per aggiornare e ottimizzare le guide utente, i manuali utente e la documentazione del prodotto per creare un'esperienza più fluida per i clienti che desiderano conoscere i tuoi prodotti. Non c'è niente di più frustrante che introdurre un nuovo prodotto e scoprire un aumento delle richieste di supporto a causa di istruzioni manuali scadenti.
Come scrivere una documentazione di prodotto completa¶
Una documentazione di prodotto di qualità è coinvolgente, utile e potente. Direi che una documentazione competente è un componente necessario di una buona gestione del prodotto. Tanto quanto i product manager partecipano allo sviluppo dei prodotti, una parte significativa del successo è creare una documentazione di prodotto curata che i nostri clienti possano comprendere e utilizzare per approfondire la loro conoscenza dei nostri prodotti.
Qual è il problema con la maggior parte della documentazione di prodotto?¶
Molti product manager sono avversi alla stesura della documentazione di prodotto. La documentazione che conoscono potrebbe non avere successo con i loro clienti a meno che non si presti maggiore attenzione a renderla attraente, facile da leggere e con cui relazionarsi.
Tuttavia, spesso le aziende non prestano la cura necessaria per creare e sviluppare una documentazione di prodotto eccellente. Una documentazione scadente viene scritta solo per essere scritta. Utilizza frasi ampie piene di pensieri vagamente accettabili e un layout scadente per scoraggiare gli spettatori dall'interagire con il materiale. Una documentazione scadente è creata per proteggere l'autore dalle critiche ed è una completa perdita di tempo per tutti. E anche i clienti non amano leggerla per questo motivo.
Come possiamo risolvere questo problema e scrivere una documentazione migliore che i nostri clienti apprezzeranno?¶
Un'eccellente documentazione di prodotto è scritta con l'intenzione di essere letta. È concisa. Una buona documentazione è ben formattata e può essere letta e compresa da tutti in azienda o dai clienti in tre minuti. Evita il gergo e fornisce o fa riferimento a un punto di vista a livello aziendale. Un'eccellente documentazione di prodotto dedica tempo a delineare casi d'uso specifici che i clienti possono comprendere e applicare per un uso migliore del prodotto. Coinvolge il lettore e attira l'attenzione su problemi sottostanti con soluzioni ben elaborate.
La potenza di una documentazione ben scritta¶
Nelle piccole, medie o grandi aziende, documenti tecnici ben formattati possono far risparmiare molto tempo e aiutare i dipendenti a lavorare in modo più produttivo. Questo è generalmente vero per la maggior parte delle aziende basate sui prodotti, che spendono una grande percentuale dei loro budget per assumere scrittori tecnici e scrivere documentazione tecnica.
Se la tua azienda impiega più di due persone per creare documentazione di prodotto, stabilire una cultura di buona documentazione è assolutamente vantaggioso. Ci sono molte ragioni per cui vorresti che il tuo team creasse, gestisse e pubblicasse una documentazione ben curata, ma nella sezione seguente affronteremo come una documentazione efficace sia un approccio a basso costo per migliorare l'esperienza del cliente.
Una documentazione efficace è un approccio a basso costo per migliorare l'esperienza del cliente¶
Un'esperienza cliente solida è il fulcro per mantenere clienti fedeli. La maggior parte dei project manager sono ottimisti: hanno un'idea, si entusiasmano e poi la eseguono. Sebbene la passione sia ammirevole e l'esecuzione sembri produttiva, avere un piano di gioco prima di eseguire una corretta documentazione di prodotto è vitale.
I primi passi dopo aver fatto brainstorming su un piano di gioco sono iniziare un ciclo di progettazione e strutturare il contenuto della documentazione in modo che sia progressivamente facile da leggere per i clienti.
Inoltre, ottenere feedback dai clienti sulla documentazione attuale è un passo vitale per ristrutturare i documenti in base alle esigenze dei clienti. In questo modo i project manager possono creare, gestire, mantenere, pubblicare e ottimizzare la loro documentazione con percezione e automazione. Questo non è un compito semplice e insignificante, e avere strumenti straordinari come Docsie, che automatizza molti dei processi per rendere efficace la documentazione di prodotto, è essenziale per il successo.
Una documentazione tecnica attraente, coinvolgente e navigabile aiuta i consumatori a imparare il prodotto in meno tempo, aumentando la probabilità che configurino il prodotto correttamente e lo utilizzino correttamente.
Tutte queste strategie per creare una documentazione ben curata porteranno essenzialmente a prodotti con valutazioni più alte, recensioni più favorevoli e più vendite sono tutti legati tra loro; quindi, va da sé che le vendite aumentate di conseguenza.
Come creare una documentazione ben curata¶
Come produrre documentazione efficace e promuovere una cultura in cui sia lo standard? Scrivere documentazione efficace è impegnativo, ma ci sono molte buone funzionalità in Docsie che possono aiutare ad accelerare questo processo di creazione di portali di documentazione ben curati e dinamici. Di seguito è riportato un riepilogo di alto livello del nostro approccio al problema.
Iniziamo:¶
I limiti di pagina garantiscono la leggibilità. Scrivere un documento decente non dovrebbe essere difficile da leggere ed elaborare mentalmente. Frasi prolungate e divaganti sono spesso indicative di una mancanza di chiarezza. Se la comunicazione non può essere adeguatamente riassunta in una singola pagina, è un'indicazione che il product manager dovrebbe probabilmente tornare indietro e scomporre ulteriormente la situazione.
La formattazione migliora la qualità. Una documentazione di prodotto mal strutturata aumenta la probabilità che lo scrittore improvvisi. Crea un modello con sezioni, tabelle e intestazioni di documento ben formattate. È un investimento una tantum con un potenziale di dividendi elevato.
I modelli ti fanno risparmiare tempo. È molto più facile eliminare una sezione da un modello che ricordarsi di aggiungerne una. Non è paternalistico; piuttosto, è efficace e fa risparmiare tempo. Semplici sezioni che ricordano allo scrittore di iniziare con lo sfondo generale e di essere specifico su misurazioni o ipotesi pericolose consentono una scrittura più precisa e una gerarchia decisionale.
Commenta e assegna compiti. Non c'è modo più sicuro per demotivare il tuo staff a produrre documentazione di alta qualità che non commentarla. I commenti non devono essere molto intelligenti; piuttosto, dovrebbero indicare coinvolgimento e servire da modello. Mentre è ideale fornire feedback digitalmente in modo che altri nell'azienda possano beneficiare in modo asincrono dalla conversazione, una semplice funzionalità in Docsie che ti permette di commentare e collaborare con il tuo team funziona alla grande per il team di documentazione del prodotto!
Consulta questo blog per saperne di più su come Docsie aiuta con la collaborazione alla documentazione di prodotto:
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
I tipi di documento dovrebbero essere scalabili per soddisfare le esigenze della tua azienda. Man mano che più stakeholder vengono coinvolti nel processo di sviluppo del prodotto, la comunicazione deve essere suddivisa in diversi documenti (soprattutto se deve essere rispettato il criterio di "concisione" di una pagina). Docsie offre una soluzione utile e sostenibile per i team di documentazione di prodotto in crescita.
Usa Docsie per accelerare la creazione di un'ottima documentazione¶
Docsie è una piattaforma molto utile che ti aiuta in ogni aspetto della creazione di documentazione di prodotto e portali di conoscenza. Ha molte funzionalità integrate che rendono la creazione, pubblicazione, manutenzione e gestione dei progetti di documentazione davvero semplice e divertente! Ecco solo alcune delle nostre funzionalità di Docsie che possono aiutarti a raggiungere questi obiettivi:
Possibilità di modificare: Docsie permette a tutti i nostri utenti di modificare la documentazione dopo la pubblicazione creando una versione alternativa che non andrà in diretta finché non sarà attiva. Questo è fantastico perché i team di gestione del prodotto possono lavorare sulla modifica e l'alterazione della documentazione e poi renderla attiva quando sono pronti a farlo, senza dover affrontare difficoltà con HTML e CSS. La documentazione sarà automaticamente visualizzata con un semplice cambio di impostazione quando saranno pronti.
Possibilità di ricerca: se hai molta documentazione o ci sono molte funzionalità, il plugin di ricerca di Docsie aggiunge un bonus utile che permette ai tuoi clienti di cercare rapidamente e facilmente nella tua documentazione per trovare le informazioni di cui hanno bisogno, accelerando il processo di visualizzazione e assorbimento delle informazioni dalla tua documentazione.
Possibilità di collegare: Docsie rende la tua documentazione SEO-friendly. Puoi inserire link a determinate pagine del sito web della tua azienda o semplicemente scrivere parole chiave basate sui tuoi prodotti che saranno cercabili online e attireranno nuovi clienti alla ricerca dello stesso prodotto che hai tu.
Possibilità di avere diverse traduzioni: Il traduttore all'avanguardia di Docsie permette ai nostri utenti di tradurre la loro documentazione in varie lingue. Inoltre, con la funzione di selezione della lingua di Docsie, i tuoi clienti possono scegliere la lingua che preferiscono. Questo è molto utile per la portata globale e per espandere la base clienti dell'azienda, costruendo al contempo fiducia con i clienti appena trovati all'estero.
Possibilità di assegnare compiti e commentare per una collaborazione senza problemi: Docsie ha strumenti straordinari per collaborare con il tuo team di documentazione. Puoi assegnare commenti, impostare attività e assegnare ruoli in modo da gestire meglio quali compiti vengono svolti da quale utente che sta lavorando al tuo progetto di documentazione con Docsie. Per saperne di più, consulta questo blog qui.
Generazione di feedback: Essere in grado di sapere cosa pensano i tuoi clienti della tua documentazione è l'unico modo per sapere come ottimizzare la tua documentazione per soddisfare le esigenze dei clienti, in modo che possano comprendere più piacevolmente la tua documentazione e i portali di conoscenza. Per saperne di più sull'importanza del feedback sulla documentazione, consulta il mio blog qui.
Ci sono anche molte altre funzionalità e capacità che Docsie consente a te e al tuo team di gestione del prodotto di utilizzare per creare una documentazione di prodotto straordinaria. In questo articolo vorrei parlare dei plugin che ogni portale di conoscenza e documentazione di prodotto Docsie può aggiungere alla propria documentazione per migliorarla e migliorarne l'usabilità complessiva.
Plugin Docsie per rendere dinamico il tuo portale di documentazione!¶
Docsie ha un sacco di plugin che puoi usare per rendere la tua documentazione più accattivante. In questo blog lo dividerò in 3 parti.
In questa sezione divideremo la spiegazione di questi plugin per portali di conoscenza in tre parti.
PARTE 1: Nella prima parte mostreremo 'Display Version Picker', 'Display Language Picker', 'Display Section Anchors' e 'Display Footer Navigation'
PARTE 2: In questa parte mostreremo i plugin 'Code Highlighting', 'Search' e 'Share to Social Network'
PARTE 3: Nella terza parte mostreremo i plugin 'Image Preview', 'Document Metadata' e 'Auto-highlight Section'.
Prima di passare ai plugin, parliamo di come accedere a questi plugin all'interno della piattaforma Docsie.
Innanzitutto, all'interno dell'area di lavoro, dobbiamo cliccare sui tre puntini nell'angolo in alto a destra e aprire il nostro account:
Poi all'interno di Deployments possiamo accedere ai Plugin una volta creato un nuovo Deployment tramite 'Configure a new deployment+'
Quindi clicca su 'More options' che ti permetterà di aggiungere questi plugin alla tua documentazione distribuita tramite uno script incorporato o tramite il portale Docsie
L'altra opzione è accedere ai plugin dei portali di conoscenza di Docsie attraverso il pulsante 'Update deployment configuration' sotto la tua documentazione già pubblicata.
Si aprirà questa dashboard e potrai aggiungere o rimuovere plugin come preferisci e poi aggiornare la distribuzione.
PARTE 1:¶
Ora che sappiamo come accedere ai plugin Docsie, passiamo alla PARTE 1.
Per vedere il tutorial video della parte 1, guarda questo video qui:
Iniziamo con 'Display version Picker' e 'Display Language Picker'
Una volta attivati questi due, appariranno in basso a sinistra del tuo portale di conoscenza come schede fluttuanti. Permettono ai tuoi clienti e a coloro che leggono la tua documentazione di visualizzare i tuoi documenti in diverse lingue e versioni.
Quando l'utente preme la lingua nel selettore di lingua, cambierà l'intera documentazione che sta leggendo in quella lingua assegnata.
Il Display Section Anchor, una volta attivato, permette al tuo cliente di avere link accanto a ciascuna intestazione che forniranno link a determinate sezioni della documentazione.
Ogni volta che questi link vengono premuti, una parte dell'intestazione cambierà e quando il tuo cliente copia e incolla questo html, indirizzerà la persona a cui lo sta inviando a questa specifica sezione della documentazione.
Poi c'è 'Display Footer Navigation'
Questo plugin aggiunge un pulsante di navigazione in basso a destra del tuo libro di documentazione. Ha un aspetto simile a questo.
In questo modo i tuoi clienti possono navigare più comodamente attraverso la tua documentazione.
PARTE 2:¶
Per vedere il tutorial video della Parte 2, guarda questo video qui:
In questa parte mostreremo i plugin 'Code Highlighting', 'Search' e 'Share to Social Network'
Iniziamo con il plugin 'Code Highlighting'
Questo plugin è ottimo per prodotti tecnici che devono esprimere vari codici ai loro clienti. Questo plugin permette ai clienti di copiare e incollare il codice assegnato in modo da poterlo utilizzare sul loro editor per facilità d'uso aggiungendo un pulsante "Copia".
Ora vediamo il plugin Search.
Una volta attivato sul tuo portale di conoscenza Docsie, i tuoi clienti possono cercare nella tua documentazione tramite una navigazione di ricerca nell'angolo in alto a destra del portale di conoscenza.
Cliccando su cerca, apparirà un sofisticato cruscotto che permetterà ai tuoi clienti di individuare esattamente dove trovare determinate informazioni all'interno dei tuoi scaffali e libri.
Questo accelera notevolmente il processo con cui i tuoi clienti possono trovare e recuperare le informazioni necessarie sui tuoi prodotti.
Poi c'è il plugin Share To Social Networks
Questo plugin permette ai tuoi clienti di prendere sezioni evidenziate della tua documentazione scritta e condividerle sui loro social media.
Questo è fantastico perché può aumentare il traffico, attirare nuovi potenziali clienti e migliorare la fiducia nel tuo marchio.
PARTE 3:¶
Per vedere il tutorial video della parte 3, guarda questo video qui:
Nella parte tre mostreremo i plugin 'Image Preview', 'Document Metadata' e 'Auto-highlight Section'.
Iniziamo con il plugin Image Preview
Image Preview permette ai tuoi clienti di ingrandire o ridurre un'immagine della tua documentazione di prodotto per vederla meglio.
Poi c'è 'Documentation metadata'
Questo permette ai nostri clienti di vedere un timestamp quando la documentazione del prodotto o aspetti del portale di conoscenza sono stati aggiornati. Sarà situato in cima e in fondo alla documentazione scritta.
Ora vediamo il plugin 'Auto-Highlight Section'
Questo semplice plugin permette ai tuoi clienti di tenere traccia di dove si trovano in una determinata documentazione all'interno del portale di conoscenza.
Evidenzierà ogni posizione in cui si trovano, all'interno del portale di conoscenza, in modo che i tuoi clienti possano tenere meglio traccia della sezione in cui si trovano e navigare più facilmente verso altre sezioni.
Tutti questi strumenti e altri ancora sono forniti dalla piattaforma Docsie. Se non l'hai ancora provata, ti suggeriamo di farlo. Clicca qui
Se hai domande, non esitare a contattarci all'indirizzo hello@docsie.io