Writing a tutorial¶

Testo utilizzato finora nella prima sezione di TYPO3 tutorial:

“Questo documento è un tutorial. Tutorial sono progettati per essere step-by-step instructionsspecifically creato per camminare un principiante attraverso un particolare compito dall’inizio toend. Per facilitare l’apprendimento efficace, tutorial forniscono esempi per illustrathe soggetti che coprono. Inoltre, i tutorial forniscono indicazioni su come evitarecomune insidie ed evidenziare concetti chiave che dovrebbero essere ricordati per riferimento futuro.”

guardando la letteratura di seguito menzionati si dovrebbe prendere in considerazione i seguenti punti chiave:

• un tutorial è una lezione di apprendimento orientati, mostrando i passaggi per completare qualcosa, rendere il lettore più informato
• il lettore dovrebbe ottenere qualcosa di significativo e di successo l’esperienza, la trovo fattibile e divertente, rafforzare le competenze, guadagnare la fiducia, e vuole farlo di nuovo.
• concentrarsi sulla conoscenza pratica, non sulla conoscenza teorica. Imparare un nuovo mestiere o abilità, concentrarsi sull’apprendimento facendo

Linee guida:

• consenti all’utente di imparare facendo,
• passa dal semplice al complesso
• Avvia l’utente
• va bene mostrare i passaggi che il principiante capisce meglio. “best practice” può essere qualcosa di diverso. Come un utente esperto lo farebbe potrebbe essere qualcosa di diverso.
• L’obiettivo è quello di avviare il lettore, non di portarli a una destinazione finale.
• Assicurati che il tuo tutorial funzioni!
• ispirare la fiducia del principiante: nel software, nel tutorial, nel tutor e, naturalmente, nella propria capacità di ottenere ciò che viene loro chiesto.
• Assicurarsi che l’utente veda immediatamente i risultati
• La conclusione di ogni sezione di un tutorial, o il tutorial nel suo complesso, deve essere un risultato significativo.
• Il tuo tutorial deve essere ripetibile in modo affidabile.
• Concentrarsi su passi concreti, non concetti astratti. La tentazione di introdurre l’astrazione è enorme: resistere!
• Fornire il minimo necessario spiegazione
• Concentrarsi solo sui passi che l’utente deve prendere