Un manuale utente, o guida per l’utente, è un documento di comunicazione tecnica che è stato progettato per educare gli utenti su un particolare prodotto. Prodotti in stampa o in digitale, possono essere scritti su quasi tutti i prodotti, ma sono più comuni con software e hardware per computer, dispositivi elettronici e videogiochi.
Di solito scritto da scrittori tecnici o designer di prodotto, il suo scopo è quello di informare gli utenti e aiutarli a risolvere eventuali problemi relativi al prodotto. Come componente vitale della distribuzione del prodotto, la qualità del manuale può influire pesantemente sull’esperienza complessiva del cliente, motivo per cui vuoi farlo bene!
In questo articolo, condividerò suggerimenti su come scrivere un manuale utente che trasmette informazioni ai vostri clienti in modo chiaro, e vi mostrerà come è possibile organizzare il processo di scrittura in Zenkit.
Suggerimenti per la scrittura di un manuale utente
C’è molto che va nella scrittura di un manuale utente. Dalle descrizioni delle caratteristiche, alle istruzioni di riparazione, a tutti i dettagli legali e le avvertenze di sicurezza. Ecco alcuni suggerimenti da tenere a mente quando si tratta di scriverlo:
- Conosci il tuo obiettivo
Ogni manuale utente dovrebbe avere uno scopo. Comunemente, è per aiutare gli utenti a risolvere i problemi relativi al tuo prodotto, ma con questo dovresti anche decidere come vuoi aiutarli. Una volta che hai deciso l’angolo che si desidera prendere, abbattere le informazioni in sezioni e istruzioni passo-passo che sono abbastanza semplici da seguire.
- Determina l’utente
È indispensabile conoscere il tipo di pubblico che leggerà il tuo manuale utente in quanto influenzerà il modo in cui lo scrivi. Conoscere il tuo utente medio può darti un’idea della lingua che dovresti usare quando scrivi il manuale utente, il formato e lo stile generale. Ad esempio, scrivere per specialisti IT esperti di tecnologia sarà molto diverso dalla scrittura per genitori con famiglie giovani.
- Usa la lingua accessibile
Indipendentemente da chi è il tuo pubblico, la lingua del testo del manuale utente dovrebbe essere accessibile anche alla persona più non tecnica. Devi assumere che il lettore abbia zero conoscenze sul tuo prodotto, quindi dovrebbe essere comprensibile, chiaro e conciso. Dovrebbe rivolgersi al lettore e l’uso del gergo dovrebbe essere limitato.
- Rendilo visivo
Gli esseri umani sono noti per elaborare i dati visivi 60.000 volte più velocemente del testo, motivo per cui si desidera che il manuale utente includa immagini. I manuali d’uso includono quasi sempre immagini pertinenti con il testo. Alcuni prodotti condividono anche immagini screenshot di istruzioni passo – passo o sono solo puramente immagini (manuali IKEA sono notoriamente senza testo). Le immagini possono davvero aiutare a trasmettere il messaggio che si desidera comunicare al lettore.
- Enhance findability
Affrontalo, nessuno leggerà l’intero manuale utente, quindi per i lettori di trovare valore in esso, devi renderlo abbastanza semplice per le persone a sfogliare e trovare quello che stanno cercando. Dargli un formato pulito avendo un layout coerente da una pagina all’altra e assicurarsi che ci sia molto spazio tra blocchi di testo. Usa parole chiave familiari relative al prodotto e assicurati che il carattere sia semplice e leggibile.
Come pianificare il manuale utente
Zenkit è un ottimo strumento per la pianificazione di un manuale utente. Lo strumento di gestione del progetto è ricco di funzionalità che consentono di raccogliere dati e quindi strutturarli per creare un flusso di lavoro ottimizzato. Ecco i passaggi per organizzare il processo di scrittura manuale utente.
Fase 1:
Registrati per un account Zenkit gratuito e accedi.
Passo 2:
Una volta personalizzato il tuo profilo, fai clic su “nuova collezione”, dai un nome alla tua collezione e premi invio o “crea”. Verrai indirizzato alla vista Kanban predefinita.
Puoi dare alla tua collezione un po ‘ di carattere personalizzando un’icona per essa. Per fare questo, fare clic sul titolo della collezione, la selezione “personalizzazione”, e scegliere i colori e l’icona logo che si desidera.
Personalmente sono un fan dell’utilizzo di una scheda Kanban per mappare visivamente un piano di progetto. Il sistema di pianificazione visiva è ottimo per identificare colli di bottiglia e problemi che possono sorgere durante il processo di pianificazione. Può anche darti una panoramica cristallina di come procede il tuo progetto.
La vista Kanban presenta tre colonne predefinite etichettate come “To-Do, In Progress e Done”. È possibile rinominare le colonne semplicemente facendo clic su uno dei nomi delle etichette e andando alla sezione nome nella casella di menu che appare. Per aggiungere più fasi al tuo flusso di lavoro, tutto ciò che devi fare è fare clic su “+ Aggiungi fase”, dare alla colonna un’etichetta e fare clic su “crea” o premere invio.
Ovviamente puoi selezionare tutte le fasi che desideri per il tuo flusso di lavoro e etichettarle come meglio credi. Le tappe sono andato per sono i seguenti:
- Info & Risorse
- Feedback & Istruzioni
- Sezioni
- Bozze
Step 3:
una Volta che la struttura del flusso di lavoro, è stato determinato, è possibile iniziare ad aggiungere altri elementi come elementi sotto ogni colonna.
Come ho detto all’inizio di questo articolo, un progetto come scrivere un manuale utente comporta un sacco di contenuti; contenuto che deve essere suddiviso in vari capitoli e sezioni e sezioni di sezioni.
Subitems di Zenkit è la caratteristica perfetta per abbattere le attività più grandi in quelli più piccoli. Uno dei 12 campi personalizzati del nostro strumento di gestione del progetto, presenta tutti i tuoi articoli in modo strutturato in modo da poter lavorare con una timeline gestibile.
Per aggiungere un elemento secondario a uno dei tuoi articoli, fai semplicemente clic sull’elemento per aprirlo. Quindi fare clic sul segno ” + “che si trova sopra la sezione commenti, quindi selezionare”campo personalizzato”. Nella sezione” Tipo”, scorrere verso il basso e selezionare il campo “elementi secondari”. Non dimenticare di dare un nome al campo!
Passaggio 4:
Per aggiungere ulteriore struttura al flusso di lavoro, è possibile utilizzare la vista gerarchia di Zenkit. Per attivare questa vista nella tua collezione, fai clic su” Kanban “(o il nome della vista in cui ti trovi) che troverai nell’angolo in alto a destra e seleziona”Nuova vista”. Un’estensione del menu dovrebbe apparire e selezionare semplicemente “Gerarchia”.
Passo 5:
Quando usi per la prima volta la vista gerarchia, scoprirai che i tuoi elementi non sono collegati. È possibile collegarli trascinando e rilasciando ogni elemento sul pannello gerarchia principale. Se trascini un elemento padre, scoprirai che i subitemi verranno con esso.
La gerarchia allocata a un elemento dipende da dove lo si posiziona. Ad esempio, gli elementi trascinati verso l’alto avranno una gerarchia di livello uno e gli elementi trascinati sotto un altro si trasformeranno in un elemento secondario di tale elemento.
La vista Gerarchia mostra ogni singolo elemento aggiunto alla gerarchia degli elementi utilizzando le rientranze per indicare quando un elemento diventa un elemento secondario. È possibile ottenere una panoramica delle attività principali solo o vedere tutto nel progetto in una sola volta comprimendo o aprendo gli elementi.
Pianificazione di altri tipi di documenti e materiali di testo
Proprio come la pianificazione di un manuale utente, Zenkit può essere utilizzato per pianificare altri documenti o materiali pesanti. La vista gerarchia e la funzione subitem sono perfetti per la pianificazione di qualsiasi progetto che richiede l’organizzazione di una grande quantità di contenuti che deve essere suddiviso in diverse sezioni, come un romanzo o una tesi di laurea.
Novel writing plan
Scrivere un romanzo può richiedere anni per essere completato, motivo per cui è una buona idea avere un posto dove annotare tutto. Utilizzando un modello simile alla guida manuale utente, puoi strutturare il tuo romanzo capitolo per capitolo e tenere traccia di tutti i dettagli del personaggio, della trama e del tema in un’unica piattaforma.
Piano di tesi/dissertazione
Dalle idee tematiche alla ricerca alla raccolta di dati, scrivere una tesi o una tesi richiede molta pianificazione. Utilizzando Zenkit per gestire tutto, può aiutare a ottenere la vostra tesi fatto in tempo e garantire che non trascurare qualcosa di importante!
Clicca qui per utilizzare il nostro modello di pianificazione tesi/Tesi.
Un ottimo manuale utente comunica chiaramente le informazioni al lettore in modo che siano in grado di superare eventuali problemi che possono sorgere con il prodotto. Utilizzando Zenkit per pianificare il processo di scrittura, e sfruttando la vista gerarchia e la funzione subitem, può aiutare a produrre un manuale utente di qualità che può dare ai vostri clienti la migliore esperienza possibile.
Qual è stato l’ultimo manuale utente che hai trovato utile?
Saluti,
Dinnie e il team Zenkit