Come scrivere una guida pratica
Una guida pratica aiuta i lettori a completare un compito specifico. Parti dal risultato, mostra i passi in un ordine fattibile e spiega come capire se ogni passo è riuscito. Metti il risultato finale nei primi paragrafi, con le parole che userebbe il lettore. Poi mostra il primo passo dal punto in cui si trova davvero, non da una situazione ideale. Una guida pratica conquista fiducia quando un passo iniziale si può verificare con gli occhi, non solo credere.
Inizia il tuo libro, gratisChe cos'è un ebook di guida pratica?
Una guida pratica è un libro didattico organizzato intorno al fare qualcosa: impostare un processo, imparare un'abilità pratica o portare a termine un progetto. Ogni capitolo dovrebbe avvicinare il lettore al risultato promesso. Il contesto va dove aiuta una decisione, e la risoluzione dei problemi va vicino al passo dove il lettore può bloccarsi. Di' al lettore cosa avrà alla fine, cosa gli serve prima di iniziare e come saprà che un passo ha funzionato. Una guida pratica che seppellisce il risultato sotto il contesto costringe a leggere tre pagine prima di poter agire, e molti si fermano lì.
Come deve organizzare i suoi passi una guida pratica?
Una guida pratica deve mettere le azioni nell'ordine in cui il lettore deve compierle. Indica le condizioni di partenza, descrivi l'azione e mostra come verificarne il risultato. Numera una sequenza di più passi, così i lettori non perdono il segno.
“A procedure is a sequence of numbered steps for accomplishing a task.”
Traduzione: Una procedura è una sequenza di passi numerati per portare a termine un compito.
- La guida alle procedure di Google usa una frase e un punto elenco per una procedura di un solo passo, invece di una lista numerata che contiene solo 1.
- In una procedura con due o più azioni, distingui la sequenza da una lista non ordinata di materiali o opzioni.
- In questo esempio di laboratorio Bookeen, usa tre punti di controllo: confermare il pubblico, approvare il piano della sessione e controllare i materiali. Il numero appartiene a questo esempio, non a ogni guida pratica.
Usa Bookeen per sviluppare la sequenza dei capitoli dalle tue note sul processo. Poi esegui tu stesso le istruzioni o chiedi a un lettore adatto di provarle; passi numerati dall'aspetto chiaro non sono prova che la procedura funzioni.
Fonte verificata .
Quando scegliere questo tipo di libro
- Scegli una guida pratica quando il lettore ha bisogno di una sequenza ripetibile. Deve poter dire a che punto della sequenza si trova e com'è il risultato finito. Se il libro è soprattutto riflessione, senza un passo verificabile, si adatta meglio un altro tipo di libro.
- Definisci ciò che il lettore già sa e ciò che gli serve prima di iniziare. Nomina gli strumenti, gli accessi e il vocabolario che già possiede. Una guida scritta per tutti spiega termini che il lettore reale conosce e salta proprio l'errore che era venuto a evitare.
- Usa piuttosto un quaderno di esercizi quando esercizi e risposte scritte portano quasi tutto il valore. Un piccolo esercizio può stare accanto a un passo. Se quasi tutto il valore sta nel fatto che il lettore compili, decida e rilegga ciò che ha scritto, lascia guidare quel libro e tieni questo per la sequenza.
Una scaletta pratica
- Descrivi il risultato e le condizioni di partenza. Metti il risultato finale nelle parole del lettore, poi il punto da cui parte davvero. Una situazione ideale che non corrisponde alla sua scrivania fa sembrare impossibile il primo passo.
- Raccogli materiali, informazioni o prerequisiti. Elenca solo ciò che i passi usano. Un lungo elenco di attrezzatura opzionale nasconde le due cose che il lettore deve avere prima di iniziare.
- Percorri i passi con un esempio continuo. Porta un solo esempio dal primo all'ultimo passo, così il lettore vede come cambia il lavoro. Un esempio nuovo in ogni capitolo lo costringe a reimparare la situazione invece dell'abilità.
- Verifica il risultato, risolvi i problemi e pianifica l'azione successiva. Di' cosa vedrà se un passo è fallito e l'unico cambiamento da provare dopo. Un capitolo di risoluzione dei problemi in fondo è il luogo dove quegli avvisi passano inosservati.
Una guida per pianificare il primo laboratorio di comunità
Segui un organizzatrice da un tema abbozzato a un piano di sessione fattibile. Un capitolo sul pubblico individua chi dovrebbe partecipare. Il capitolo successivo trasforma quel pubblico in un obiettivo di apprendimento, poi in un programma e in un elenco di materiali. I lettori possono confrontare le proprie decisioni con l'esempio continuo invece di partire da zero in ogni capitolo. Tieni un'unica organizzatrice in vista dalla prima scelta all'ultima lista di controllo, e fai riferire i capitoli successivi a decisioni che ha già preso. I lettori imparano la sequenza guardando un caso che cambia, invece di incontrare una nuova ipotesi a ogni cambio di tema.
A chi deve rivolgersi una guida pratica?
Una guida pratica deve rivolgersi a un lettore definito, in un punto di partenza chiaro. Definisci il lettore prima di scrivere. Spiega i termini specialistici nel punto in cui vengono usati ed evita di aggiungere capitoli solo perché conosci bene l'argomento. Nomina ciò che il lettore ha già provato e ciò che teme di sbagliare. Una guida scritta per tutti spiega termini che il lettore reale conosce e salta proprio l'errore che era venuto a evitare.
- Indica presto i prerequisiti. Di' di cosa ha bisogno prima della prima azione, con le stesse parole che useranno i passi successivi. Un sinonimo nella domanda sembra spesso un'idea nuova.
- Separa i passi obbligatori dai miglioramenti opzionali. I passi obbligatori cambiano il risultato. I miglioramenti opzionali si possono etichettare come tali. Se tutto sembra obbligatorio, i lettori si bloccano su un lavoro che non muove il risultato.
- Rendi osservabile il risultato. Un risultato che il lettore può vedere, contare o confrontare è una verifica. Un risultato che dice solo che capirà l'argomento è una speranza, e la guida non si può testare contro di essa.
Metti alla prova le istruzioni
Una guida può sembrare chiara e tralasciare un'azione cruciale. Percorri la sequenza come farebbe un lettore. Controlla le dipendenze, gli esempi e ogni riferimento a strumenti o schermate rispetto al loro comportamento attuale. Esegui tu stesso i passi dalla bozza, solo con i materiali elencati nel capitolo. Ogni volta che ti affidi a un'abitudine che il capitolo non menziona, aggiungila alla pagina, altrimenti il lettore si bloccherà dove tu sei passato senza problemi.
- Usa nomi coerenti per la stessa azione.
- Aggiungi punti di controllo dopo i passi importanti.
- Spiega gli errori comuni e le opzioni di recupero.
Costruisci una bozza in Bookeen
Dai a Bookeen il pubblico, il risultato e le note sul processo. Usa quegli input per sviluppare una scaletta e poi controlla ogni capitolo alla ricerca di passi mancanti. La tua esperienza e la tua verifica rendono utili le istruzioni. Porta un tentativo reale, incluso il punto in cui di solito esiti. Chiedi il passo successivo e la verifica che indica che ha funzionato. Poi prova quella verifica prima di accettare la formulazione.
- Mantieni un esempio continuo lungo tutta la guida.
- Sostituisci i consigli generici con decisioni e azioni.
- Rivedi la sequenza completa prima di preparare i file per il lettore.
Confronta i tipi di libro
eBook di gestione dei lead per un processo condiviso
Un eBook di gestione dei lead trasforma il tuo modo di trattare i potenziali clienti in una guida utilizzabile. Definisci il pubblico, spiega l’azione successiva in ogni fase e offri esempi che i lettori possono adattare. Apri con la decisione che il lettore affronterà questa settimana, non con una storia del mercato. Poi mostra l’azione successiva e il dato che lo farebbe aspettare. Le persone tengono un manuale che possono usare alla prossima richiesta, e scartano quello che si limita a rinominare fasi che già conoscono.
eBook di quaderno di esercizi per fare pratica
Un quaderno di esercizi trasforma la lettura in pratica. Dai a ogni esercizio uno scopo, un’istruzione chiara e spazio sufficiente perché il lettore risponda, rifletta o decida. Apri con il compito, non con una lezione. Di’ al lettore cosa produrre, quanto dovrebbe richiedere e come appare una risposta finita. Un quaderno di esercizi che tiene il punto fino alla seconda pagina perde chi è arrivato pronto a esercitarsi.
eBook complementari per corsi tra una lezione e l’altra
Un eBook complementare per un corso offre agli studenti qualcosa a cui tornare tra una lezione e l’altra. Collega riassunti, esempi ed esercizi al corso, così il libro è facile da consultare quando sorge una domanda. Apri dove si trova lo studente: la lezione che ha appena lasciato e il passaggio che non riesce a ricordare. Un eBook complementare che inizia con la storia della materia lo costringe a cercare la procedura per cui era tornato.
Lettori, file e passi successivi
Esplora una situazione di scrittura correlata, poi scegli un'edizione adatta ai tuoi lettori.
Scopri il creatore di libri di BookeenCome scrivere una guida pratica: domande con risposta
In cosa differisce una guida pratica da un quaderno di esercizi?
Una guida pratica spiega un processo. Un quaderno di esercizi dà al lettore spazio e stimoli per applicarlo. I due si possono combinare, ma uno dovrebbe guidare la struttura, così il lettore sa se seguire istruzioni o completare esercizi. Se il lettore segue soprattutto istruzioni, stai scrivendo una guida pratica. Se soprattutto compila, decide e rilegge ciò che ha scritto, il baricentro è un quaderno di esercizi. Puoi includere un piccolo esercizio in entrambi i casi, ma una di queste funzioni dovrebbe guidare.
Tutti i capitoli devono avere la stessa lunghezza?
No. Dai a ogni passo abbastanza spiegazione da renderlo utilizzabile. Una decisione complessa può richiedere alternative e un esempio; un'azione semplice può richiedere solo una breve istruzione e una verifica. Un passo che richiede un minuto dovrebbe restare breve. Un passo in cui le persone di solito falliscono merita l'esempio e la verifica. La stessa lunghezza dei capitoli è un'abitudine di progettazione, non un servizio al lettore.
Una guida pratica deve includere la risoluzione dei problemi?
Sì, dove riesci a individuare veri punti di fallimento. Spiega il sintomo, la causa probabile e l'azione successiva vicino al passo interessato. Evita di inventare problemi solo per allungare un capitolo. Sì, accanto al passo in cui compare il problema. Di' al lettore cosa vedrà se il passo è fallito e l'unico cambiamento da provare dopo. Un capitolo di risoluzione dei problemi in fondo è il luogo dove quegli avvisi passano inosservati.
Posso trasformare articoli esistenti in una guida?
Sì, ma rivedili per farne un'unica sequenza. Elimina le introduzioni ripetute, riempi i vuoti tra i passi e mantieni la terminologia coerente. Una guida utile ha bisogno di un percorso continuo del lettore, non solo di una raccolta di articoli. Solo dopo aver tagliato le parti che non aiutano questo lettore a raggiungere questo risultato. Articoli scritti per occasioni diverse lasciano vuoti e ripetizioni. Dai alla bozza combinata un punto di partenza e un modo per verificare la fine.
Quale formato di file dovrei scegliere?
EPUB funziona bene per un testo che i lettori ridimensionano su schermi diversi. PDF conserva un layout specifico. Tieni un manoscritto modificabile durante la revisione e controlla l'edizione esportata prima di condividerla. Scegli il file che corrisponde a come il lettore userà i passi. Il testo fluido si adatta a una guida letta sul telefono. Una pagina che deve tenere un diagramma accanto a una lista di controllo vuole un layout fisso. Fai questa scelta dopo che i passi sono chiari e controlla il file reale.