Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Kolibri
- Technical writer:
- Daniela V
- Nome progetto:
- Flussi di lavoro per i contenuti di Kolibri
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
La proposta seguente è stata creata conducendo ricerche e parlando con i mentori di Kolibri. La conversazione con i mentori mi ha aiutato a sviluppare gli utenti tipo di cui parlerò di seguito. Inoltre, le mie discussioni mi hanno aiutato a trovare l'idea relativa a un repository di tutorial/una pagina di destinazione, in modo che gli utenti possano scegliere quale tutorial visualizzare per le loro esigenze.
Panoramica
Questa proposta presenta una soluzione per guidare i vari percorsi degli utenti che un individuo può importare importando contenuti dal proprio computer a Kolibri Studio e poi da Kolibri Studio a Kolibri. Propongo di creare un repository centrale di tutorial. L'utente accederà a questi tutorial tramite una pagina di destinazione. La pagina di destinazione fornisce una tabella con i link a ogni tutorial del flusso di lavoro e indica il tipo di utente che il tutorial può trarre vantaggio. In questo modo, i tutorial saranno più personalizzati in base alle esigenze e alle capacità dell'utente. Più lezioni mostrano un flusso di lavoro (ad esempio INSTALLA - IMPORT). Ogni lezione contiene un video. I video mostrano una piccola parte del flusso di lavoro e dimostrano i singoli concetti su come questi flussi di lavoro collegano le applicazioni Kolibri.
Obiettivi principali
Crea una pagina di destinazione tutorial che aiuti gli utenti a decidere quale flusso di lavoro si adatta meglio alle loro esigenze. Questa pagina di destinazione verrà ospitata sulla piattaforma Leggi i documenti.
Crea lezioni individuali per i componenti di ogni flusso di lavoro e integra lezioni difficili con esercizi.
Crea video interattivi per ogni flusso di lavoro.
Strumenti di progetto
Il lavoro verrà svolto usando il software per lo screencast. Ho esperienza con Camtasia, ma ho anche lavorato con software e freeware meno proibitivi. Il video di esempio disponibile al link qui (https://youtu.be/DkMP_VdGslU) è stato realizzato con Flashback di Blueberry Software, per il quale attualmente possiedo una licenza. Creerò i sottotitoli usando YouTube. Le pagine dei tutorial verranno ospitate sul sito Leggi i documenti di Kolibri. La bozza del lavoro verrà completata in Documenti Google e posso aiutarti a convertire i file di testo in Markdown o reStructuredText per il prodotto finale.
Tempistiche
Questo progetto seguirà le linee guida del progetto a lungo termine (26 settimane in totale, dal 2/09/2019 al 28/02/2020). Dedica circa 10 ore alla settimana al raggiungimento degli obiettivi descritti di seguito. Oltre a questi obiettivi, parteciperò a riunioni e comunicazioni con i mentori durante questo periodo, se necessario. Collaborerò con i mentori per stabilire il momento migliore per farlo. Generalmente la sequenza temporale è suddivisa in porzioni di quattro settimane, in cui creerò più video, pagine di tutorial ed esercizi.
Settimane uno e due
Obiettivi:
- Configura il dispositivo personale con i siti web o gli account necessari per accedere alle informazioni.
- Inizia a sviluppare una struttura e un Wireframe più dettagliato per la pagina di destinazione.
- Discuti con i mentori sullo stile dei video e sviluppa un modello della schermata di apertura del video, qualsiasi musica di riempimento per il titolo e le schermate finali e informazioni aggiuntive che dovrebbero essere incluse.
- Esamina la documentazione e la struttura della documentazione attuale per estrarre i link da utilizzare in risorse aggiuntive e riferimenti ai tutorial.
Settimane da 3 a 6 (Livello 1 - Tutorial per principianti)
Obiettivi:
- Sviluppa contenuti e lezioni iniziali per il flusso di lavoro INSTALLAZIONE-IMPORTAZIONE/Livello 1. Crea un video per i processi di download, installazione, configurazione e importazione. Poiché le funzioni INSTALLA-IMPORTA sono la base di molti altri flussi di lavoro e quelli più utilizzati, una gran parte del tempo sarà dedicata alla finalizzazione di questi tutorial e lezioni.
- Concentrati sui tipi di località di importazione e sviluppa un'immagine che sia un esempio per l'utente dove può acquisire i contenuti (canali pubblici presenti in Kolibri Studio) per la pagina di destinazione.
- Sviluppa video e contenuti aggiuntivi per le espansioni di INSTALLA-IMPORTA (canale UPDATE). Queste espansioni possono anche presentarsi sotto forma di risorse aggiuntive o link a documentazione esistente.
- Lavora sui sottotitoli di qualsiasi video.
- "Testare" i video e chiedere un feedback sull'usabilità dalle risorse disponibili. Ciò include la rivisitazione del modello per i video e il consolidamento del modello per i video futuri.
Settimane da 7 a 10 (Livello 2 - Caricamento contenuti)
Obiettivi:
- Concentrati su lezioni e video sul flusso di lavoro per l'utente tipo di caricamento di Studio.
- Completa la documentazione e le lezioni per UPLOAD-PUBLISH-IMPORT.
- Sviluppa i sottotitoli per tutti i video.
Settimane da undici a quattordici (Livello 3 - "Remixer" e Editor di contenuti)
Obiettivi:
- Concentrati sui seguenti flussi di lavoro e crea contenuti di tutorial/lezioni: UPLOAD-EDIT-PUBLISH-UPDATE e EDIT-PUBLISH-UPDATE.
- Sviluppa eventuali sottotitoli per i video.
Settimane da quindici a diciotto
Obiettivi:
- Come indicato durante la mia ricerca per questa proposta, i flussi di lavoro che coinvolgono Ricecooker hanno una priorità più bassa (tipo CHEFDEV). A seconda delle tempistiche e della programmazione, potrei sfruttare questo tempo per creare un tutorial generale che faccia riferimento alla documentazione esistente di Ricecooker.
Settimane da diciannove a ventidue
Obiettivi:
- Valuta le eventuali lacune in questo momento e testa il flusso attuale di tutti i tutorial.
- Preparati a finalizzare la pagina di destinazione e inizia a collegare i video.
- Trasforma le bozze di pagina realizzate in Documenti Google in Markdown o reStructuredText, come discusso con i mentori.
Settimane da 23 a 25
Obiettivi:
- A seconda del tempo, completa gli ultimi lavori dei tutorial avanzati con priorità bassa.
- Ultimo minuto Leggi le modifiche alla pagina Documenti, i test dei file, il controllo grammaticale/ortografia.
- QA per tutti i link all'interno dei video o su altre pagine.
Settimana 26
Ultima settimana per progetti di lunga durata. Collaborerò con i mentori per concludere i risultati finali del progetto e completare l'eventuale documentazione finale richiesta da Google.
Componenti del tutorial
Pagina di destinazione del tutorial
Gli utenti accederanno a una pagina di destinazione del tutorial sul sito Leggi la documentazione di Kolibri, che fornirà una breve descrizione dei vari tutorial offerti per i flussi di lavoro relativi ai contenuti. Lo scopo di questa pagina è fornire una breve panoramica dell'ecosistema Kolibri, nonché una rappresentazione grafica dei vari flussi di lavoro. In questo modo l'utente può visualizzare il tipo di flusso di lavoro adatto alle sue esigenze, sia tecnicamente che per il programma della sua organizzazione. Gli utenti avranno una conoscenza più approfondita delle opzioni disponibili in Kolibri e Kolibri Studio.
Pagine relative a tutorial e lezioni
La home page di ogni tutorial fornisce un'introduzione all'esercitazione (composta da più lezioni), seguita da alcuni obiettivi degli utenti. I tutorial illustrano un intero flusso di lavoro e sono composti da lezioni individuali. Ogni lezione includerà un video. I video tratteranno una singola parte di un concetto generale. Ogni lezione verrà conservata su una singola pagina all'interno della pagina principale del flusso di lavoro del tutorial. Le pagine delle lezioni avranno pulsanti che consentono all'utente di passare alla lezione precedente o successiva all'interno del tutorial. I concetti molto complessi possono includere attività di esercitazione.
Video e struttura
I video delineano un singolo concetto. I video ti indicheranno le indicazioni mentre compi l'azione sullo schermo. Puoi trovare un video di esempio qui: https://youtu.be/DkMP_VdGslU. Questo video di esempio mostra come utilizzare la procedura guidata di configurazione.
Il video utilizza callout e un cursore evidenziato per guidare l'utente attraverso i passaggi di questo singolo concetto. I video saranno ospitati su YouTube. Se ospitati su YouTube, i sottotitoli verranno generati automaticamente. Poi modificherò i sottotitoli codificati per ortografia, grammatica e punteggiatura. I sottotitoli codificati possono quindi essere esportati per la traduzione in Amara o in un altro strumento di traduzione.
I video avranno una schermata del titolo coerente, di cui parlerò con i mentori nelle prime due settimane. Inoltre, utilizzerò uno stile di callout coerente (frecce, evidenziazione del cursore, caselle), che verrà deciso insieme ai mentori nelle prime due settimane.
Strutture di esempio
Il flusso di lavoro più semplice, INSTALLA-IMPORTA, è un intero tutorial. Nel tutorial sono presenti due potenziali lezioni con un video:
- Download, installazione e configurazione della struttura Kolibri
- Importazione di contenuti in Kolibri Studio: tieni presente che altri flussi di lavoro fanno riferimento a questo video
Un tutorial più avanzato richiede più lezioni secondarie con più video. Il flusso di lavoro UPLOAD-EDIT-PUBLISH-UPDATE segue la struttura riportata di seguito.
Lezione 1: caricamento di contenuti e creazione di canali in Kolibri Studio
Obiettivi dell'utente: alla fine di questa lezione, saprai come completare le seguenti azioni:
- Crea canali in Kolibri Studio per utilizzarli in Kolibri. Saprai come utilizzare i token segreti del tuo canale per importare il canale di contenuti in Kolibri.
- Crea un canale importando i contenuti dai canali pubblici esistenti nella Raccolta di Studio.
- Crea un canale caricando i contenuti dal tuo computer.
Video delle sottolezioni:
- Sottolezione 1 – Crea i tuoi canali su Kolibri Studio e importa i contenuti dai canali pubblici esistenti (Khan Academy, PHET ecc.): Video 1 - Canali di contenuti pubblici (visualizzazione di canali PUBBLICI su Kolibri Studio) Video 2 - Creazione di un canale Video 3 - Importazione di contenuti da canali esistenti Video 4 - Pubblicazione del canale e recupero del token segreto Video 5 - Importazione del canale in Kolibri utilizzando il token segreto
- Sottolezione 2 - Caricamento sul canale Contenuti di Documenti: Video 1 - Caricamento di file da Documenti Video 2: Creazione di esercizi personalizzati
Lezione 2 – Editing avanzato dei canali in Kolibri Studio
Obiettivi dell'utente: alla fine di questa lezione, saprai come completare le seguenti azioni:
- Modificare i canali di contenuti in Kolibri Studio
- Gestire i canali di contenuti in Kolibri Studio
Video delle sottolezioni:
- Sotto-lezione 1: modifica dei contenuti con l'aggiunta di esercizi, la riorganizzazione della struttura delle cartelle e le opzioni di collaborazione (1 video)
- Sotto-lezione 2: Utilizzo di altre funzioni come l'eliminazione/lo spostamento di contenuti (1 video)
Lezione 3 – Pubblicare canali di Kolibri Studio per l'utilizzo in Kolibri e aggiornare i canali
Obiettivi dell'utente: alla fine di questa lezione, saprai come completare le seguenti azioni:
- Pubblicare un canale in Kolibri Studio e ripubblicarlo dopo l'aggiunta di nuovi contenuti
- Aggiornare un canale
- Acquisisci il token del canale da importare in Kolibri (tramite un link al video precedente nella Lezione 1 che tratta questa azione)
Video delle sottolezioni:
Sottolezione 1 - Pubblicare aggiornamenti su un canale
Video 1: Ripubblicazione del canale Video 2: aggiornamento del canale su Kolibri dopo l'aggiunta di altri contenuti