Un tutorial per fare un tutorial

In questo tutorial si può imparare a fare un tutorial.

Un tutorial è una lezione che ti porta per mano attraverso una serie di passaggi pratici. Offre un'esperienza di apprendimento facendo qualcosa. È il modo migliore per conoscere un argomento con il quale non hai ancora familiarità.

I tutorial sono fondamentali in qualsiasi documentazione: mostrano i nuovi arrivati in giro, guidano i primi passi, sono la finestra dello shopping, danno un'esperienza piacevole e facile di un argomento. Uno dei "trucchi" per ottenere questo è quello di tralasciare tutto ciò che può distrarre nel processo di apprendimento. Ad esempio:

• Modi alternativi per fare qualcosa o modi per fare qualcosa di molto specifico.
• Riferimenti completi di tutte le opzioni e una descrizione tecnica della sua struttura.
• Spiegazioni dettagliate e sfondi storici.

Tali informazioni supplementari possono essere fornite al meglio separatamente. Evita il più possibile di mescolarlo, poiché annebbierà solo il tutorial. Questo è il principio fondamentale del Diátaxis Framework, un modo sistematico per migliorare la documentazione. Inserire le informazioni aggiuntive di cui sopra rispettivamente in guide pratiche, riferimenti e spiegazioni. Nelle guide pratiche puoi trovare rapidamente come fare qualcosa di specifico. Nei riferimenti puoi cercare come funzionano le cose, quali opzioni hanno e dove trovare ulteriori informazioni. Con le spiegazioni puoi approfondire la tua comprensione dell'argomento.

Sebbene un tutorial offra un'introduzione a un argomento, non è rivolto esclusivamente ai principianti. Può anche essere un'introduzione a un argomento avanzato! Sii chiaro all'inizio del tuo tutorial su quali conoscenze o abilità sono necessarie per essere in grado di fare il tutorial.

Se insegni a qualcuno come cucinare, devi spiegare cose come le tecniche di taglio, come usare un forno e altre cose da cucina di base. Si inizia con qualche ricetta semplice, preferibilmente qualcosa che dà facilmente un bel prodotto finale. Il prodotto finale in sé non è l'obiettivo principale: Vuoi insegnare alcune abilità. Questo è ciò che fa un tutorial. Qualcuno che sa cucinare e vuole fare qualcosa di specifico, non ha bisogno di un tale tutorial, ma di una ricetta. Le ricette sono le guide di come cucinare.

Passo dopo passo

Per creare un tutorial:

1. Raccogliere informazioni sull'argomento. Documentazione esistente, video, ecc Nota le cose che trovi confuse o ti ci è voluto un po 'di tempo per capire. Ci sono domande sull'argomento sul forum?
2. Quali concetti sono coinvolti? Doodling un piccolo diagramma può aiutare. Non cercare di essere completo, ma chiarisci cosa è importante per questo tutorial e cosa no.
3. C'è qualche conoscenza o abilità specifica necessaria per insegnare nel tuo tutorial?
4. Creare un esempio in cui è possibile utilizzare tutti i concetti e le competenze che si desidera trasmettere in questo tutorial. Rendi l'esempio il più semplice possibile.
5. Definisci e scrivi i passaggi per raggiungere un risultato finale. Ogni passo dovrebbe essere riproducibile dal tuo studente.
6. Filtra tutte le spiegazioni, i riferimenti, le alternative e i casi speciali: metterli in articoli separati.
7. Scrivi un'introduzione. Cosa imparerai in questo tutorial? Menzionare tutti i prerequisiti necessari per fare il tutorial.
8. Scrivi il riassunto. Cosa abbiamo imparato? Puoi anche menzionare i prossimi passi da intraprendere per saperne di più.
9. Aggiungi schermate con annotazioni per illustrare le azioni da intraprendere. Suggerimento: utilizzare i numeri nello screenshot e fornire spiegazioni nel testo. Ciò rende più facile riutilizzare lo screenshot nelle traduzioni e riduce al minimo lo sforzo per produrre screenshot specifici per la lingua.
10. Aggiungi diagrammi per spiegare strutture, relazioni e processi.
11. Aggiungere gli articoli di accompagnamento con spiegazioni, riferimenti e guide pratiche.
12. Metti tutti gli articoli di un argomento sotto un articolo di panoramica, spiegando cos'è, come si relazionano e da dove iniziare.

Esempio: Creare e pubblicare un articolo su Joomla

Ad esempio, creiamo un tutorial su come creare e pubblicare un articolo sotto un elemento del menu in Joomla.

Raccolta di informazioni

Nel nostro manuale dell'utente Troverai articoli pertinenti sotto "Iniziare", "Articoli" e "Menus". È spesso fonte di confusione quando si inizia con Joomla, che non si vede un articolo dopo averne creato uno, anche se lo si è contrassegnato come "pubblicato". Per vedere l'articolo, ci deve essere un link ad esso. Ci sono diversi modi per creare un tale collegamento (come un elemento del menu o un layout del blog di categoria o inserendolo nel layout del blog della home page contrassegnando l'articolo come descritto o collegando da un altro articolo), ma ora ci concentreremo sul rendere l'articolo disponibile tramite un elemento del menu.

Concetti e competenze

Abbiamo 'contenuto', 'articolo', 'menu' e 'menu-item'. Dobbiamo chiarire questi termini. Mostriamo dove trovare queste cose nel menu di amministrazione. Tralasciamo "categorie" o "in primo piano" in questo tutorial.

Prerequisiti

Devi avere accesso al lato amministratore di un sito web Joomla funzionante e sapere come effettuare il login.

Obiettivo

Il nostro obiettivo è imparare a creare un nuovo articolo su Joomla e un nuovo menu sotto il quale inserire il nostro articolo.

Fasi

Utilizzare i seguenti passaggi per raggiungere il nostro obiettivo:

A. Creare un articolo

1. Accedi al tuo pannello di amministrazione di Joomla.
2. Per prima cosa lo faremo Crea l'articolo. Vai al menu "Contenuto" a sinistra e seleziona "Articoli".
3. Fai clic su "Nuovo" per creare un nuovo articolo.
4. Inserisci un titolo e un contenuto per il tuo articolo.
5. Fai clic su "Salva e chiudi" per salvare il tuo articolo.
   
   

B. Creare un menu-elemento che collega all'articolo

al fine di mostrare l'articolo sul sito ci sarà creare un menu-elemento Collegamento all'articolo. Passare al menu "Menus" a sinistra e selezionare "Menu principale".

1. Proprio come con un articolo, fai clic su "Nuovo" per creare un nuovo elemento del menu.
2. Inserisci un titolo per il tuo elemento del menu. Questo è il titolo come apparirà nel menu. Non deve essere lo stesso titolo dell'articolo. Di solito è più breve del titolo di un articolo per adattarsi meglio al menu.
3. Selezionare un tipo di voce di menu: alla voce "Articoli" selezionare "Articolo unico".
4. Seleziona l'articolo: Seleziona l'articolo che abbiamo appena realizzato.
5. Vai al sito e aggiorna. Congratulazioni: Ora puoi fare clic sulla voce di menu per vedere il tuo articolo.

Introduzione

Scrivi l'introduzione: cosa imparerai in questo tutorial e quali prerequisiti sono necessari.

Filtra le informazioni aggiuntive

Possiamo tralasciare qualcosa in ciò che è stato scritto fino ad ora? Bene, nel passaggio 2 della creazione di un elemento del menu ho menzionato il titolo dell'elemento del menu non deve essere lo stesso del titolo dell'articolo. È un'aggiunta necessaria a questo tutorial? In caso contrario, è meglio lasciarlo fuori per ora. Ma dà un suggerimento per un articolo più specializzato sui titoli degli articoli e sui titoli dei menu e quando vengono visualizzati, coinvolgendo le opzioni generali dell'articolo, le impostazioni dei singoli articoli sotto le opzioni-scheda, le impostazioni menu-voce sotto le opzioni-scheda del menu-voce e altro ancora. Sarebbe inoltre opportuno creare un articolo di riferimento sul modo in cui gli articoli, le categorie e i menu lavorano insieme; in un tale articolo cerca di essere completo, elenca tutte le possibilità. Un articolo specifico potrebbe essere: "Come visualizzare il titolo dell'articolo?", mostrando le impostazioni nelle impostazioni generali dell'articolo e nelle impostazioni dei singoli articoli e menu. Un articolo tipo spiegazioni potrebbe dire qualcosa sullo sfondo perché Joomla usa "articolo" dove per esempio WordPress usa "post" o come l'articolo viene visualizzato nella pagina finale.

Conclusione

Avvolgere tutto in un riassunto. E menzionare alcuni possibili passi successivi per saperne di più (come: un tutorial sull'aggiunta di una categoria o una guida pratica sulla scorciatoia da salvataggio a menu).

Immagini e grafica

Fare schermate mostrando i pulsanti e i campi coinvolti nella creazione di un articolo e di un elemento del menu. Contrassegnare i pulsanti e i campi coinvolti.

Per chiarezza è possibile aggiungere un diagramma che mostra come un articolo viene messo "sotto" un elemento del menu.

Aggiungere riferimenti, guide pratiche e spiegazioni

Inserire tutte le informazioni e le istruzioni aggiuntive in articoli separati.

Panoramica

Se hai più articoli su un argomento, dovresti fare un articolo di panoramica, spiegando come si riferiscono gli articoli e da dove iniziare.

Esercizio

Inizia a fare il tutorial di cui sopra come creare e pubblicare un articolo in Joomla. Il modo migliore per imparare è quello di fare. Pubblicheremo un esempio di come questo può apparire nell'attuale manuale dell'utente (sandbox) sito. Ma saremmo felici di mettere lì la tua versione se riesci a migliorare quella attuale.