Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Kolibri
- Technical Writer:
- Daniela V
- Nome del progetto:
- Flussi di lavoro sui contenuti di Kolibri
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
La proposta riportata di seguito è stata creata conducendo ricerche e parlando con i mentor di Kolibri. La mia conversazione con i mentor mi ha aiutato a sviluppare i profili utente che descrivo di seguito. Inoltre, le mie discussioni mi hanno aiutato a trovare l'idea di un repository/una pagina di destinazione dei tutorial, in modo che gli utenti possano scegliere il tutorial da visualizzare per le loro esigenze.
Panoramica
Questa proposta presenta una soluzione per guidare i vari percorsi degli utenti che un privato può intraprendere importando contenuti dal proprio computer in Kolibri Studio e poi da Kolibri Studio in Kolibri. Propongo di creare un repository centrale di tutorial. L'utente accederà a questi tutorial tramite una pagina di destinazione. La pagina di destinazione fornirà una tabella con i link a ciascun tutorial sul flusso di lavoro e indicherà il tipo di utente che può trarre vantaggio dal tutorial. In questo modo, i tutorial saranno più personalizzati in base alle esigenze e alle capacità dell'utente. Più lezioni hanno dimostrato un flusso di lavoro, ad esempio INSTALLA - IMPORTA. Ogni lezione contiene un video. I video mostrano una piccola parte del flusso di lavoro e illustrano singoli concetti su come questi flussi di lavoro collegano le applicazioni Kolibri.
Obiettivi principali
Crea una pagina di destinazione del tutorial che aiuti gli utenti a decidere quale flusso di lavoro è più adatto alle loro esigenze. Questa pagina di destinazione verrà ospitata sulla piattaforma Read the Docs.
Crea lezioni individuali per i componenti di ogni flusso di lavoro e integra le lezioni difficili con esercizi.
Crea video interattivi per ogni flusso di lavoro.
Strumenti di progetto
Il lavoro verrà svolto utilizzando un software di trasmissione dello schermo. Ho esperienza con Camtasia, ma ho anche lavorato con software meno proibitivi e freeware. Il video di esempio a cui si fa riferimento qui (https://youtu.be/DkMP_VdGslU) è stato realizzato con Flashback di Blueberry Software, per il quale ho attualmente una licenza. Creerò i sottotitoli utilizzando YouTube. Le pagine dei tutorial verranno ospitate sul sito Read the Docs di Kolibri. La bozza 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 per i progetti a lungo termine (26 settimane in totale, dal 2/09/2019 al 28/02/2020). Dedicherò circa 10 ore a settimana al completamento degli obiettivi descritti di seguito. Oltre a questi obiettivi, parteciperò alle riunioni con il mentore e alle comunicazioni durante questo periodo, se necessario. Collaborerò con i mentor per stabilire il momento migliore per farlo. La sequenza temporale è generalmente suddivisa in blocchi di quattro settimane in cui creerò più video, pagine di tutorial ed esercizi.
Settimane 1 e 2
Obiettivi:
- Configura il dispositivo personale con tutti i siti web o gli account necessari per accedere alle informazioni.
- Inizia a sviluppare la struttura e un wireframe più dettagliato per la pagina di destinazione.
- Discuti con i mentor dello stile dei video, nonché sviluppa un modello di schermata di apertura del video, eventuali tracce musicali di riempimento per le schermate del titolo e di chiusura e altre informazioni da includere.
- Esamina la documentazione attuale e la relativa struttura per estrarre i link da utilizzare in risorse aggiuntive e riferimenti ai tutorial.
Dalla terza alla sesta settimana (livello 1 - Tutorial per principianti)
Obiettivi:
- Sviluppare contenuti e lezioni iniziali per il flusso di lavoro INSTALL-IMPORT/Livello 1. Crea un video per i processi di download, installazione, configurazione e importazione. Poiché le funzioni INSTALL-IMPORT sono la base di molti altri flussi di lavoro e sono le più utilizzate, una grande parte del tempo sarà dedicata al completamento di questi tutorial e lezioni.
- Concentrati sui tipi di località IMPORT e sviluppa un'immagine che mostri all'utente dove può acquisire i contenuti (canali pubblici esistenti in Kolibri Studio) per la pagina di destinazione.
- Sviluppare video e contenuti aggiuntivi per le espansioni di INSTALL-IMPORT (AGGIORNA il canale). Queste espansioni potrebbero anche essere sotto forma di risorse aggiuntive o link alla documentazione esistente.
- Lavorare ai sottotitoli di qualsiasi video.
- "Testa" i video e chiedi feedback a qualsiasi risorsa disponibile in merito all'usabilità. Ciò includerebbe la revisione del modello per i video e la sua applicazione ai video futuri.
Settimane 7-10 (Livello 2: caricatore di contenuti)
Obiettivi:
- Concentrati sulle lezioni e sui video del flusso di lavoro per l'utente tipo con uploader di Studio.
- Completa la documentazione e le lezioni per CARICA-PUBBLICA-IMPORTA.
- Sviluppare sottotitoli per qualsiasi video.
Settimane dall'11 alla 14 (livello 3: "Remixer" e editor dei contenuti)
Obiettivi:
- Concentrati sui seguenti flussi di lavoro e crea contenuti di tutorial/lezioni: UPLOAD-EDIT-PUBLISH-UPDATE e EDIT-PUBLISH-UPDATE.
- Sviluppare sottotitoli per i video.
Settimane 15-18
Obiettivi:
- Come comunicato durante la mia ricerca per questa proposta, i flussi di lavoro che coinvolgono Ricecooker hanno una priorità inferiore (tipo CHEFDEV). A seconda dei tempi e dei tempi, potrei usare questa volta per creare un tutorial generale che faccia riferimento alla documentazione esistente per Ricecooker.
Settimane 19-22
Obiettivi:
- Valuta eventuali lacune e testa il flusso attuale di tutti i tutorial.
- Finalizza la pagina di destinazione e inizia a collegare i video.
- Trasforma le bozze delle pagine fatte in Documenti Google in Markdown o reStructuredText, come discusso con i mentori.
Settimane dalla 23 alla 25
Obiettivi:
- A seconda del tempo a disposizione, completa eventuali lavori finali su tutorial avanzati di bassa priorità.
- Modifiche dell'ultima ora alla pagina di Read the Docs, test dei file, controllo ortografico/grammaticale.
- Controllo qualità di eventuali link all'interno dei video o su altre pagine.
Settimana 26
Ultima settimana per i progetti di lunga durata. Collaborerò con i mentor per completare i risultati del progetto e la documentazione Google finale richiesta.
Componenti del tutorial
Pagina di destinazione del tutorial
Gli utenti accederanno a una pagina di destinazione del tutorial sul sito Read the Docs di Kolibri, che fornirà una breve panoramica dei vari tutorial offerti per i flussi di lavoro dei contenuti. Lo scopo di questa pagina è fornire una breve panoramica dell'ecosistema Kolibri e una visualizzazione grafica dei vari flussi di lavoro. In questo modo, l'utente può visualizzare il tipo di flusso di lavoro più adatto alle sue esigenze, sia dal punto di vista tecnico che per il curriculum della sua organizzazione. Gli utenti avranno una maggiore comprensione delle opzioni a loro disposizione in Kolibri e Kolibri Studio.
Pagine di tutorial e lezioni
La home page di ogni tutorial fornisce un'introduzione al tutorial (composto da più lezioni), seguita da alcuni obiettivi dell'utente. I tutorial illustrano un intero flusso di lavoro e sono composti da singole lezioni. Ogni lezione sarà accompagnata da un video. I video tratteranno una singola parte di un concetto generale. Ogni lezione verrà conservata in una singola pagina all'interno della pagina principale del flusso di lavoro del tutorial. Le pagine delle lezioni dispongono di pulsanti che consentono all'utente di passare alla lezione precedente o successiva all'interno del tutorial. I concetti molto complessi possono includere attività pratiche.
Video e struttura
I video descrivono un singolo concetto. I video forniranno indicazioni durante l'esecuzione dell'azione sullo schermo. Un video di esempio è disponibile qui: https://youtu.be/DkMP_VdGslU. Questo video di esempio mostra come utilizzare la configurazione guidata della struttura.
Il video utilizza callout e un cursore evidenziato per aiutare l'utente a seguire i passaggi di questo singolo concetto. I video verranno ospitati su YouTube. Se il video è ospitato su YouTube, i sottotitoli codificati verranno generati automaticamente. Poi modifico i sottotitoli per correggere ortografia, grammatica e punteggiatura. che possono essere esportate per le traduzioni in Amara o in un altro strumento di traduzione.
I video avranno una schermata del titolo coerente, di cui ho intenzione di parlare con i mentor nelle prime due settimane. Inoltre, utilizzerò uno stile di callout coerente (frecce, cursore evidenziato, caselle), che verrà deciso insieme ai mentor nelle prime due settimane.
Strutture di esempio
Il flusso di lavoro più semplice, INSTALL-IMPORT, è un intero tutorial. All'interno del tutorial sono presenti due potenziali lezioni con un video:
- Download, installazione e configurazione della struttura Kolibri
- Importazione dei contenuti in Kolibri Studio: tieni presente che questo video verrà richiamato da altri flussi di lavoro
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: caricare contenuti e creare canali in Kolibri Studio
Obiettivi utente: al termine di questa lezione saprai come completare le seguenti azioni:
- Creare canali in Kolibri Studio per utilizzarli in Kolibri. Saprai come utilizzare i token segreti del tuo canale per importare il tuo canale di contenuti in Kolibri.
- Crea un canale importando contenuti da canali pubblici esistenti nella raccolta di Studio.
- Creare un canale caricando contenuti dal computer.
Video delle sottolezioni:
- Sottolezione 1: crea i tuoi canali su Kolibri Studio e importa i contenuti da canali pubblici esistenti (Khan Academy, PHET e così via): Video 1 - Canali di contenuti pubblici (visualizzazione dei canali PUBLIC su Kolibri Studio) Video 2 – Creazione di un canale Video 3 – Importazione dei contenuti da canali esistenti Video 4 – Pubblicazione del canale e ottenimento del token segreto Video 5 – Importazione del canale in Kolibri utilizzando il token segreto
- Sottolezione 2: caricamento di contenuti del canale Documenti personali: Video 1: caricamento di file da Documenti personali Video 2: creazione di esercizi personali
Lezione 2 – Modifica avanzato dei canali in Kolibri Studio
Obiettivi utente: alla fine di questa lezione, saprai come completare le azioni seguenti:
- Modificare i canali di contenuti in Kolibri Studio
- Gestire i canali di contenuti in Kolibri Studio
Video delle sottolezioni:
- Sottolezione 1: Modificare i contenuti aggiungendo esercizi, riorganizzando la struttura delle cartelle e le opzioni di collaborazione (1 video)
- Sottolezione 2: utilizzo di altre funzioni come l'eliminazione/lo spostamento dei contenuti (1 video)
Lezione 3 – Pubblicare canali di Kolibri Studio da utilizzare in Kolibri e aggiornare i canali
Obiettivi utente: al termine 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 della Lezione 1 che illustra 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 contenuti